blacklight 6.25.0 → 7.0.0.rc1

data/lib/generators/blacklight/assets_generator.rb

@@ -1,20 +1,20 @@
+# frozen_string_literal: true
 module Blacklight
   class Assets < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
 
-    # This could be skipped if you want to use webpacker
-    def add_javascript_dependencies
-      gem 'bootstrap-sass', '~> 3.0'
-      gem 'twitter-typeahead-rails', '0.11.1.pre.corejavascript'
-    end
-
     def assets
       copy_file "blacklight.scss", "app/assets/stylesheets/blacklight.scss"
 
+      # Ensure this method is idempotent
       return if has_blacklight_assets?
 
       contents = "\n//\n// Required by Blacklight\n"
       contents += "//= require jquery\n" if needs_jquery?
+      contents += "//= require popper\n"
+      contents += "// Twitter Typeahead for autocomplete\n"
+      contents += "//= require twitter/typeahead\n"
+      contents += "//= require bootstrap\n"
       contents += "//= require blacklight/blacklight\n"
 
       marker = if turbolinks?
@@ -25,12 +25,12 @@ module Blacklight
                  '//= require jquery_ujs'
                end
 
-      insert_into_file "app/assets/javascripts/application.js", :after => marker do
+      insert_into_file "app/assets/javascripts/application.js", after: marker do
         contents
       end
     end
 
-    # This is not a default in Rails 5.1
+    # This is not a default in Rails 5.1+
     def add_jquery
       gem 'jquery-rails' if needs_jquery?
     end

data/lib/generators/blacklight/controller_generator.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 module Blacklight
   class ControllerGenerator < Rails::Generators::Base
-    
     source_root File.expand_path('../templates', __FILE__)
-    
-    argument     :controller_name  , type: :string , default: "catalog"
+
+    argument :controller_name, type: :string, default: "catalog"
 
     desc <<-EOS
       This generator makes the following changes to your application:
@@ -18,10 +17,10 @@ module Blacklight
       inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
         "  # Adds a few additional behaviors into the application controller\n" \
         "  include Blacklight::Controller\n" \
-        "  layout 'blacklight'\n\n"
+        "  layout :determine_layout\n\n"
       end
     end
-    
+
     # Generate blacklight catalog controller
     def create_blacklight_catalog
       template "catalog_controller.rb", "app/controllers/#{controller_name}_controller.rb"

data/lib/generators/blacklight/document_generator.rb

@@ -7,7 +7,7 @@ module Blacklight
 
     source_root File.expand_path('../templates', __FILE__)
 
-    argument     :model_name, :type => :string , :default => "solr_document"
+    argument :model_name, type: :string, default: "solr_document"
 
     desc <<-EOS
       This generator makes the following changes to your application:

data/lib/generators/blacklight/install_generator.rb

@@ -3,16 +3,15 @@ module Blacklight
   class Install < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
 
-    argument     :model_name  , type: :string , default: "user"
-    argument     :controller_name, type: :string , default: "catalog"
-    argument     :document_name, type: :string , default: "solr_document"
-    argument     :search_builder_name, type: :string , default: "search_builder"
-    argument     :solr_version, type: :string , default: "latest"
-
-    class_option :devise      , type: :boolean, default: false, aliases: "-d", desc: "Use Devise as authentication logic."
-    class_option :jettywrapper, type: :boolean, default: false, desc: "Use jettywrapper to download and control Jetty"
-    class_option :marc        , type: :boolean, default: false, aliases: "-m", desc: "Generate MARC-based demo ."
-    class_option :'skip-assets', type: :boolean, default: !defined?(Sprockets), desc: "Skip generating javascript and css assets into the application"
+    argument     :model_name, type: :string, default: "user"
+    argument     :controller_name, type: :string, default: "catalog"
+    argument     :document_name, type: :string, default: "solr_document"
+    argument     :search_builder_name, type: :string, default: "search_builder"
+    argument     :solr_version, type: :string, default: "latest"
+
+    class_option :devise, type: :boolean, default: false, aliases: "-d", desc: "Use Devise as authentication logic."
+    class_option :marc, type: :boolean, default: false, aliases: "-m", desc: "Generate MARC-based demo."
+    class_option :'skip-assets', type: :boolean, default: false, desc: "Skip generating javascript and css assets into the application"
     class_option :'skip-solr', type: :boolean, default: false, desc: "Skip generating solr configurations."
 
     desc <<-EOS
@@ -28,16 +27,14 @@ module Blacklight
     EOS
 
     def add_solr_wrapper
-      return if options[:'skip-solr']
-      generator_options = '--jettywrapper' if options[:jettywrapper]
-      solr_generator = if options[:jettywrapper]
-                         'blacklight:solr4'
-                       elsif solr_version == 'latest'
-                         'blacklight:solr5'
-                       else
-                         "blacklight:solr#{solr_version}"
-                       end
-      generate solr_generator, generator_options
+      generate 'blacklight:solr' unless options[:'skip-solr']
+    end
+
+    # This could be skipped if you want to use webpacker
+    def add_javascript_dependencies
+      gem 'bootstrap', '~> 4.0'
+      gem 'popper_js'
+      gem 'twitter-typeahead-rails', '0.11.1.pre.corejavascript'
     end
 
     def bundle_install
@@ -83,7 +80,7 @@ module Blacklight
     end
 
     def add_sass_configuration
-      insert_into_file "config/application.rb", :after => "config.assets.enabled = true" do <<EOF
+      insert_into_file "config/application.rb", after: "config.assets.enabled = true" do <<EOF
       # Default SASS Configuration, check out https://github.com/rails/sass-rails for details
       config.assets.compress = !Rails.env.development?
 EOF

data/lib/generators/blacklight/search_builder_generator.rb

@@ -7,7 +7,7 @@ module Blacklight
 
     source_root File.expand_path('../templates', __FILE__)
 
-    argument     :model_name, :type => :string , :default => "search_builder"
+    argument :model_name, type: :string, default: "search_builder"
 
     desc <<-EOS
     This generator makes the following changes to your application:

data/lib/generators/blacklight/{solr5_generator.rb → solr_generator.rb}

@@ -1,10 +1,8 @@
 require 'rails/generators'
 
 module Blacklight
-  class Solr5Generator < Rails::Generators::Base
-    # Set source_root to grab .solr_wrapper and solr config dir
-    # from the root of the blacklight gem
-    source_root Blacklight.root
+  class SolrGenerator < Rails::Generators::Base
+    source_root ::File.expand_path('../templates', __FILE__)
 
     desc <<-EOF
       This generator makes the following changes to your application:
@@ -23,11 +21,11 @@ module Blacklight
     end
 
     def copy_solr_conf
-      directory 'solr', 'solr'
+      directory 'solr'
     end
 
     def solr_wrapper_config
-      copy_file '.solr_wrapper.yml', '.solr_wrapper.yml'
+      copy_file '.solr_wrapper.yml'
     end
 
     def add_rsolr_gem

data/lib/generators/blacklight/templates/.solr_wrapper.yml

@@ -0,0 +1,5 @@
+# Place any default configuration for solr_wrapper here
+# port: 8983
+collection:
+  dir: solr/conf/
+  name: blacklight-core

data/lib/generators/blacklight/templates/blacklight.scss

@@ -1,5 +1,3 @@
-@import 'bootstrap-sprockets';
-
 @import 'bootstrap';
 
 @import 'blacklight/blacklight';

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -20,28 +20,32 @@ class <%= controller_name.classify %>Controller < ApplicationController
 
     # solr path which will be added to solr base url before the other solr params.
     #config.solr_path = 'select'
+    #config.document_solr_path = 'get'
 
     # items to show per page, each number in the array represent another option to choose from.
     #config.per_page = [10,20,50,100]
 
-    ## Default parameters to send on single-document requests to Solr. These settings are the Blackligt defaults (see SearchHelper#solr_doc_params) or
-    ## parameters included in the Blacklight-jetty document requestHandler.
-    #
-    #config.default_document_solr_params = {
-    #  qt: 'document',
-    #  ## These are hard-coded in the blacklight 'document' requestHandler
-    #  # fl: '*',
-    #  # rows: 1,
-    #  # q: '{!term f=id v=$id}'
-    #}
-
     # solr field configuration for search results/index views
-    config.index.title_field = 'title_display'
+    config.index.title_field = 'title_tsim'
     config.index.display_type_field = 'format'
     #config.index.thumbnail_field = 'thumbnail_path_ss'
 
+    config.add_results_document_tool(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
+
+    config.add_results_collection_tool(:sort_widget)
+    config.add_results_collection_tool(:per_page_widget)
+    config.add_results_collection_tool(:view_type_group)
+
+    config.add_show_tools_partial(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
+    config.add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
+    config.add_show_tools_partial(:sms, if: :render_sms_action?, callback: :sms_action, validator: :validate_sms_params)
+    config.add_show_tools_partial(:citation)
+
+    config.add_nav_action(:bookmark, partial: 'blacklight/nav/bookmark', if: :render_bookmarks_control?)
+    config.add_nav_action(:search_history, partial: 'blacklight/nav/search_history')
+
     # solr field configuration for document/show views
-    #config.show.title_field = 'title_display'
+    #config.show.title_field = 'title_tsim'
     #config.show.display_type_field = 'format'
     #config.show.thumbnail_field = 'thumbnail_path_ss'
 
@@ -70,19 +74,19 @@ class <%= controller_name.classify %>Controller < ApplicationController
     # :index_range can be an array or range of prefixes that will be used to create the navigation (note: It is case sensitive when searching values)
 
     config.add_facet_field 'format', label: 'Format'
-    config.add_facet_field 'pub_date', label: 'Publication Year', single: true
-    config.add_facet_field 'subject_topic_facet', label: 'Topic', limit: 20, index_range: 'A'..'Z'
-    config.add_facet_field 'language_facet', label: 'Language', limit: true
-    config.add_facet_field 'lc_1letter_facet', label: 'Call Number'
-    config.add_facet_field 'subject_geo_facet', label: 'Region'
-    config.add_facet_field 'subject_era_facet', label: 'Era'
+    config.add_facet_field 'pub_date_ssim', label: 'Publication Year', single: true
+    config.add_facet_field 'subject_ssim', label: 'Topic', limit: 20, index_range: 'A'..'Z'
+    config.add_facet_field 'language_ssim', label: 'Language', limit: true
+    config.add_facet_field 'lc_1letter_ssim', label: 'Call Number'
+    config.add_facet_field 'subject_geo_ssim', label: 'Region'
+    config.add_facet_field 'subject_era_ssim', label: 'Era'
 
-    config.add_facet_field 'example_pivot_field', label: 'Pivot Field', :pivot => ['format', 'language_facet']
+    config.add_facet_field 'example_pivot_field', label: 'Pivot Field', :pivot => ['format', 'language_ssim']
 
     config.add_facet_field 'example_query_facet_field', label: 'Publish Date', :query => {
-       :years_5 => { label: 'within 5 Years', fq: "pub_date:[#{Time.zone.now.year - 5 } TO *]" },
-       :years_10 => { label: 'within 10 Years', fq: "pub_date:[#{Time.zone.now.year - 10 } TO *]" },
-       :years_25 => { label: 'within 25 Years', fq: "pub_date:[#{Time.zone.now.year - 25 } TO *]" }
+       :years_5 => { label: 'within 5 Years', fq: "pub_date_ssim:[#{Time.zone.now.year - 5 } TO *]" },
+       :years_10 => { label: 'within 10 Years', fq: "pub_date_ssim:[#{Time.zone.now.year - 10 } TO *]" },
+       :years_25 => { label: 'within 25 Years', fq: "pub_date_ssim:[#{Time.zone.now.year - 25 } TO *]" }
     }
 
 
@@ -93,32 +97,32 @@ class <%= controller_name.classify %>Controller < ApplicationController
 
     # solr fields to be displayed in the index (search results) view
     #   The ordering of the field names is the order of the display
-    config.add_index_field 'title_display', label: 'Title'
-    config.add_index_field 'title_vern_display', label: 'Title'
-    config.add_index_field 'author_display', label: 'Author'
-    config.add_index_field 'author_vern_display', label: 'Author'
+    config.add_index_field 'title_tsim', label: 'Title'
+    config.add_index_field 'title_vern_ssim', label: 'Title'
+    config.add_index_field 'author_tsim', label: 'Author'
+    config.add_index_field 'author_vern_ssim', label: 'Author'
     config.add_index_field 'format', label: 'Format'
-    config.add_index_field 'language_facet', label: 'Language'
-    config.add_index_field 'published_display', label: 'Published'
-    config.add_index_field 'published_vern_display', label: 'Published'
-    config.add_index_field 'lc_callnum_display', label: 'Call number'
+    config.add_index_field 'language_ssim', label: 'Language'
+    config.add_index_field 'published_ssim', label: 'Published'
+    config.add_index_field 'published_vern_ssim', label: 'Published'
+    config.add_index_field 'lc_callnum_ssim', label: 'Call number'
 
     # solr fields to be displayed in the show (single result) view
     #   The ordering of the field names is the order of the display
-    config.add_show_field 'title_display', label: 'Title'
-    config.add_show_field 'title_vern_display', label: 'Title'
-    config.add_show_field 'subtitle_display', label: 'Subtitle'
-    config.add_show_field 'subtitle_vern_display', label: 'Subtitle'
-    config.add_show_field 'author_display', label: 'Author'
-    config.add_show_field 'author_vern_display', label: 'Author'
+    config.add_show_field 'title_tsim', label: 'Title'
+    config.add_show_field 'title_vern_ssim', label: 'Title'
+    config.add_show_field 'subtitle_tsim', label: 'Subtitle'
+    config.add_show_field 'subtitle_vern_ssim', label: 'Subtitle'
+    config.add_show_field 'author_tsim', label: 'Author'
+    config.add_show_field 'author_vern_ssim', label: 'Author'
     config.add_show_field 'format', label: 'Format'
-    config.add_show_field 'url_fulltext_display', label: 'URL'
-    config.add_show_field 'url_suppl_display', label: 'More Information'
-    config.add_show_field 'language_facet', label: 'Language'
-    config.add_show_field 'published_display', label: 'Published'
-    config.add_show_field 'published_vern_display', label: 'Published'
-    config.add_show_field 'lc_callnum_display', label: 'Call number'
-    config.add_show_field 'isbn_t', label: 'ISBN'
+    config.add_show_field 'url_fulltext_ssim', label: 'URL'
+    config.add_show_field 'url_suppl_ssim', label: 'More Information'
+    config.add_show_field 'language_ssim', label: 'Language'
+    config.add_show_field 'published_ssim', label: 'Published'
+    config.add_show_field 'published_vern_ssim', label: 'Published'
+    config.add_show_field 'lc_callnum_ssim', label: 'Call number'
+    config.add_show_field 'isbn_ssim', label: 'ISBN'
 
     # "fielded" search configuration. Used by pulldown among other places.
     # For supported keys in hash, see rdoc for Blacklight::SearchFields
@@ -178,10 +182,10 @@ class <%= controller_name.classify %>Controller < ApplicationController
     # label in pulldown is followed by the name of the SOLR field to sort by and
     # whether the sort is ascending or descending (it must be asc or desc
     # except in the relevancy case).
-    config.add_sort_field 'score desc, pub_date_sort desc, title_sort asc', label: 'relevance'
-    config.add_sort_field 'pub_date_sort desc, title_sort asc', label: 'year'
-    config.add_sort_field 'author_sort asc, title_sort asc', label: 'author'
-    config.add_sort_field 'title_sort asc, pub_date_sort desc', label: 'title'
+    config.add_sort_field 'score desc, pub_date_si desc, title_si asc', label: 'relevance'
+    config.add_sort_field 'pub_date_si desc, title_si asc', label: 'year'
+    config.add_sort_field 'author_si asc, title_si asc', label: 'author'
+    config.add_sort_field 'title_si asc, pub_date_si desc', label: 'title'
 
     # If there are more than this many search results, no spelling ("did you
     # mean") suggestion is offered.
@@ -190,8 +194,5 @@ class <%= controller_name.classify %>Controller < ApplicationController
     # Configuration for autocomplete suggestor
     config.autocomplete_enabled = true
     config.autocomplete_path = 'suggest'
-    # if the name of the solr.SuggestComponent provided in your solrcongig.xml is not the 
-    # default 'mySuggester', uncomment and provide it below
-    # config.autocomplete_suggester = 'mySuggester'
   end
 end