Class: Spotlight::Install

Inherits:
Rails::Generators::Base
  • Object
show all
Defined in:
lib/generators/spotlight/install_generator.rb

Instance Method Summary collapse

Instance Method Details

#add_controller_mixinObject



37
38
39
40
41
# File 'lib/generators/spotlight/install_generator.rb', line 37

def add_controller_mixin
  inject_into_file 'app/controllers/application_controller.rb', after: "include Blacklight::Controller" do
    "\n  include Spotlight::Controller\n"
  end
end

#add_example_catalog_controllerObject



68
69
70
# File 'lib/generators/spotlight/install_generator.rb', line 68

def add_example_catalog_controller
  copy_file "catalog_controller.rb", "app/controllers/catalog_controller.rb"
end

#add_helperObject



43
44
45
46
# File 'lib/generators/spotlight/install_generator.rb', line 43

def add_helper
  copy_file "spotlight_helper.rb", "app/helpers/spotlight_helper.rb"
  inject_into_class 'app/helpers/application_helper.rb', ApplicationHelper, "  include SpotlightHelper"
end

#add_mailer_defaultsObject



82
83
84
85
86
87
88
89
90
91
92
# File 'lib/generators/spotlight/install_generator.rb', line 82

def add_mailer_defaults
  if options[:mailer_default_url_host].present?
    say "Injecting a placeholder config.action_mailer.default_url_options; be sure to update it for your environment", :yellow
    insert_into_file 'config/application.rb', after: "< Rails::Application\n" do <<-EOF
      config.action_mailer.default_url_options = { host: "#{options[:mailer_default_url_host]}", from: "[email protected]" }
    EOF
    end
  else
    say "Please add a default configuration config.action_mailer.default_url_options for your environment", :red
  end
end

#add_model_mixinObject



48
49
50
51
52
53
54
55
56
# File 'lib/generators/spotlight/install_generator.rb', line 48

def add_model_mixin
  if File.exists? 'app/models/solr_document.rb'
    inject_into_file 'app/models/solr_document.rb', after: "include Blacklight::Solr::Document" do
     "\n  include Spotlight::SolrDocument\n"
    end
  else
    say "Unable to find SolrDocument class; add `include Spotlight::SolrDocument` to the class manually"
  end
end

#add_oembedObject



77
78
79
80
# File 'lib/generators/spotlight/install_generator.rb', line 77

def add_oembed
  gem 'blacklight-oembed'
  generate 'blacklight_oembed:install'
end

#add_osd_viewerObject



72
73
74
75
# File 'lib/generators/spotlight/install_generator.rb', line 72

def add_osd_viewer
  gem 'blacklight-gallery', ">= 0.3.0"
  generate 'blacklight_gallery:install'
end

#add_roles_to_userObject



33
34
35
# File 'lib/generators/spotlight/install_generator.rb', line 33

def add_roles_to_user
  inject_into_class 'app/models/user.rb', User, "  include Spotlight::User"
end

#add_solr_config_resourcesObject



99
100
101
102
# File 'lib/generators/spotlight/install_generator.rb', line 99

def add_solr_config_resources
  copy_file "jetty.rake", "lib/tasks/jetty.rake"
  directory "solr_conf"
end

#add_solr_indexing_mixinObject



58
59
60
61
62
63
64
65
66
# File 'lib/generators/spotlight/install_generator.rb', line 58

def add_solr_indexing_mixin
  if File.exists? 'app/models/solr_document.rb'
    inject_into_file 'app/models/solr_document.rb', after: "include Spotlight::SolrDocument\n" do
     "\n  include #{options[:solr_update_class]}\n"
    end
  else
    say "Unable to find SolrDocument class; add `include #{options[:solr_update_class]}` to the class manually"
  end
end

#assetsObject



28
29
30
31
# File 'lib/generators/spotlight/install_generator.rb', line 28

def assets
  copy_file "spotlight.scss", "app/assets/stylesheets/spotlight.scss"
  copy_file "spotlight.js", "app/assets/javascripts/spotlight.js"
end

#friendly_idObject



19
20
21
22
# File 'lib/generators/spotlight/install_generator.rb', line 19

def friendly_id
  gem "friendly_id"
  generate "friendly_id"
end

#generate_social_share_button_initializerObject



94
95
96
97
# File 'lib/generators/spotlight/install_generator.rb', line 94

def generate_social_share_button_initializer
  gem 'social-share-button'
  directory 'config'
end

#inject_spotlight_routesObject



10
11
12
13
14
15
16
17
# File 'lib/generators/spotlight/install_generator.rb', line 10

def inject_spotlight_routes
  route "mount Spotlight::Engine, at: 'spotlight'"
  gsub_file 'config/routes.rb', /^\s*root.*/ do |match|
    "#" + match + " # replaced by spotlight_root"
  end

  route "spotlight_root"
end

#paper_trailObject



24
25
26
# File 'lib/generators/spotlight/install_generator.rb', line 24

def paper_trail
  generate 'paper_trail:install'
end