blacklight 6.20.0 → 7.3.0

data/lib/blacklight/solr/response/group.rb

@@ -3,7 +3,7 @@ class Blacklight::Solr::Response::Group
   include Blacklight::Solr::Response::PaginationMethods
 
   attr_reader :key, :group, :response
-  
+
   def initialize key, group, response
     @key = key
     @group = group
@@ -18,13 +18,13 @@ class Blacklight::Solr::Response::Group
   def total
     doclist[:numFound].to_s.to_i
   end
-    
+
   def start
     doclist[:start].to_s.to_i
   end
 
   def docs
-    doclist[:docs].map {|doc| SolrDocument.new(doc, response)}
+    doclist[:docs].map { |doc| SolrDocument.new(doc, response) }
   end
 
   def field

data/lib/blacklight/solr/response/group_response.rb

@@ -27,7 +27,7 @@ class Blacklight::Solr::Response::GroupResponse
     # fall back on the number of facet items for that field?
     (group["ngroups"] || (response.aggregations[key] || []).length).to_s.to_i
   end
-    
+
   def start
     params[:start].to_s.to_i
   end
@@ -39,6 +39,16 @@ class Blacklight::Solr::Response::GroupResponse
     total.zero?
   end
 
+  ##
+  # Overridden from Blacklight::Solr::Response::PaginationMethods to support
+  # grouped key specific i18n keys. `key` is the field being grouped
+  def entry_name(options)
+    I18n.t(
+      "blacklight.entry_name.grouped.#{key}",
+      default: :'blacklight.entry_name.grouped.default'
+    ).pluralize(options[:count])
+  end
+
   def method_missing meth, *args, &block
     if response.respond_to? meth
       response.send(meth, *args, &block)

data/lib/blacklight/solr/response/more_like_this.rb

@@ -2,14 +2,14 @@
 module Blacklight::Solr::Response::MoreLikeThis
   def more_like document
     mlt = more_like_this[document.id]
-    return [] unless mlt and mlt['docs']
+    return [] unless mlt && mlt['docs']
 
     mlt['docs']
   end
 
   def more_like_this
     return {} unless self[:moreLikeThis]
-        
+
     self[:moreLikeThis]
   end
 end

data/lib/blacklight/solr/response/pagination_methods.rb

@@ -14,4 +14,16 @@ module Blacklight::Solr::Response::PaginationMethods
   def total_count #:nodoc:
     total
   end
+
+  ##
+  # Should return response documents size, not hash size
+  def size
+    total_count
+  end
+
+  ##
+  # Meant to have the same signature as Kaminari::PaginatableArray#entry_name
+  def entry_name(options)
+    I18n.t('blacklight.entry_name.default').pluralize(options[:count])
+  end
 end

data/lib/blacklight/solr/response/response.rb

@@ -3,12 +3,12 @@ module Blacklight::Solr::Response::Response
   def response
     self[:response] || {}
   end
-  
+
   # short cut to response['numFound']
   def total
     response[:numFound].to_s.to_i
   end
-  
+
   def start
     response[:start].to_s.to_i
   end

data/lib/blacklight/solr/response/spelling.rb

@@ -24,7 +24,7 @@ module Blacklight::Solr::Response::Spelling
     def words
       @words ||= begin
         word_suggestions = []
-        spellcheck = self.response[:spellcheck]
+        spellcheck = response[:spellcheck]
         if spellcheck && spellcheck[:suggestions]
           suggestions = spellcheck[:suggestions]
           unless suggestions.nil?
@@ -43,7 +43,7 @@ module Blacklight::Solr::Response::Spelling
               suggestions = Hash[*suggestions].except('correctlySpelled', 'collation')
             end
 
-            suggestions.each do |_, term_info|
+            suggestions.each_value do |term_info|
               # term_info is a hash:
               #   numFound =>
               #   startOffset =>
@@ -69,8 +69,9 @@ module Blacklight::Solr::Response::Spelling
 
     def collation
       # FIXME: DRY up with words
-      spellcheck = self.response[:spellcheck]
+      spellcheck = response[:spellcheck]
       return unless spellcheck && spellcheck[:suggestions]
+
       suggestions = spellcheck[:suggestions]
 
       if suggestions.is_a?(Array) && suggestions.index("collation")

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -18,12 +18,12 @@ module Blacklight::Solr
     def default_solr_parameters(solr_parameters)
       blacklight_config.default_solr_params.each do |key, value|
         solr_parameters[key] = if value.respond_to? :deep_dup
-          value.deep_dup
-        elsif value.respond_to? :dup and value.duplicable?
-          value.dup
-        else
-          value
-        end
+                                 value.deep_dup
+                               elsif value.respond_to?(:dup) && value.duplicable?
+                                 value.dup
+                               else
+                                 value
+                               end
       end
     end
 
@@ -44,7 +44,7 @@ module Blacklight::Solr
 
       if search_field
         solr_parameters[:qt] = search_field.qt
-        solr_parameters.merge!( search_field.solr_parameters) if search_field.solr_parameters
+        solr_parameters.merge!(search_field.solr_parameters) if search_field.solr_parameters
       end
 
       ##
@@ -54,7 +54,7 @@ module Blacklight::Solr
       ##
       if search_field && search_field.solr_local_parameters.present?
         local_params = search_field.solr_local_parameters.map do |key, val|
-          key.to_s + "=" + solr_param_quote(val, :quote => "'")
+          key.to_s + "=" + solr_param_quote(val, quote: "'")
         end.join(" ")
         solr_parameters[:q] = "{!#{local_params}}#{blacklight_params[:q]}"
 
@@ -66,13 +66,13 @@ module Blacklight::Solr
       elsif blacklight_params[:q].is_a? Hash
         q = blacklight_params[:q]
         solr_parameters[:q] = if q.values.any?(&:blank?)
-          # if any field parameters are empty, exclude _all_ results
-          "{!lucene}NOT *:*"
-        else
-          "{!lucene}" + q.map do |field, values|
-            "#{field}:(#{Array(values).map { |x| solr_param_quote(x) }.join(' OR ')})"
-          end.join(" AND ")
-        end
+                                # if any field parameters are empty, exclude _all_ results
+                                "{!lucene}NOT *:*"
+                              else
+                                "{!lucene}" + q.map do |field, values|
+                                  "#{field}:(#{Array(values).map { |x| solr_param_quote(x) }.join(' OR ')})"
+                                end.join(" AND ")
+                              end
 
         solr_parameters[:defType] = 'lucene'
         solr_parameters[:spellcheck] = 'false'
@@ -113,7 +113,7 @@ module Blacklight::Solr
         if facet.pivot
           solr_parameters.append_facet_pivot with_ex_local_param(facet.ex, facet.pivot.join(","))
         elsif facet.query
-          solr_parameters.append_facet_query facet.query.map { |k, x| with_ex_local_param(facet.ex, x[:fq]) }
+          solr_parameters.append_facet_query facet.query.values.map { |x| with_ex_local_param(facet.ex, x[:fq]) }
         else
           solr_parameters.append_facet_fields with_ex_local_param(facet.ex, facet.field)
         end
@@ -134,13 +134,13 @@ module Blacklight::Solr
     end
 
     def add_solr_fields_to_query solr_parameters
-      blacklight_config.show_fields.select(&method(:should_add_field_to_request?)).each do |field_name, field|
+      blacklight_config.show_fields.select(&method(:should_add_field_to_request?)).each_value do |field|
         field.solr_params.each do |k, v|
           solr_parameters[:"f.#{field.field}.#{k}"] = v
         end if field.solr_params
       end
 
-      blacklight_config.index_fields.select(&method(:should_add_field_to_request?)).each do |field_name, field|
+      blacklight_config.index_fields.select(&method(:should_add_field_to_request?)).each_value do |field|
         if field.highlight
           solr_parameters[:hl] = true
           solr_parameters.append_highlight_field field.field
@@ -166,18 +166,18 @@ module Blacklight::Solr
     ###
     # copy sorting params from BL app over to solr
     def add_sorting_to_solr(solr_parameters)
-      solr_parameters[:sort] = sort unless sort.blank?
+      solr_parameters[:sort] = sort if sort.present?
     end
 
     # Remove the group parameter if we've faceted on the group field (e.g. for the full results for a group)
     def add_group_config_to_solr solr_parameters
-      if blacklight_params[:f] and blacklight_params[:f][grouped_key_for_results]
+      if blacklight_params[:f] && blacklight_params[:f][grouped_key_for_results]
         solr_parameters[:group] = false
       end
     end
 
     def add_facet_paging_to_solr(solr_params)
-      return unless facet.present?
+      return if facet.blank?
 
       facet_config = blacklight_config.facet_fields[facet]
 
@@ -185,11 +185,7 @@ module Blacklight::Solr
       facet_ex = facet_config.respond_to?(:ex) ? facet_config.ex : nil
       solr_params[:"facet.field"] = with_ex_local_param(facet_ex, facet_config.field)
 
-      limit = if scope.respond_to?(:facet_list_limit)
-                Deprecation.warn(self, "The use of facet_list_limit is deprecated and will be removed in 7.0. " \
-                  "Consider using the 'more_limit' option in the field configuration or 'default_more_limit' instead.")
-                scope.facet_list_limit.to_s.to_i
-              elsif solr_params["facet.limit"]
+      limit = if solr_params["facet.limit"]
                 solr_params["facet.limit"].to_i
               else
                 facet_config.fetch(:more_limit, blacklight_config.default_more_limit)
@@ -274,15 +270,15 @@ module Blacklight::Solr
     def facet_value_to_fq_string(facet_field, value)
       facet_config = blacklight_config.facet_fields[facet_field]
 
-      solr_field = facet_config.field if facet_config and !facet_config.query
+      solr_field = facet_config.field if facet_config && !facet_config.query
       solr_field ||= facet_field
 
       local_params = []
-      local_params << "tag=#{facet_config.tag}" if facet_config and facet_config.tag
+      local_params << "tag=#{facet_config.tag}" if facet_config && facet_config.tag
 
       prefix = "{!#{local_params.join(' ')}}" unless local_params.empty?
 
-      if facet_config and facet_config.query
+      if facet_config && facet_config.query
         if facet_config.query[value]
           facet_config.query[value][:fq]
         else
@@ -297,7 +293,7 @@ module Blacklight::Solr
     end
 
     def convert_to_term_value(value)
-      if value.is_a?(DateTime) or value.is_a?(Time)
+      if value.is_a?(DateTime) || value.is_a?(Time)
         value.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
       elsif value.is_a?(Date)
         value.to_time(:local).strftime("%Y-%m-%dT%H:%M:%SZ")
@@ -313,7 +309,7 @@ module Blacklight::Solr
     end
 
     def facet_fields_to_include_in_request
-      blacklight_config.facet_fields.select do |field_name,facet|
+      blacklight_config.facet_fields.select do |_field_name, facet|
         facet.include_in_request || (facet.include_in_request.nil? && blacklight_config.add_facet_fields_to_solr_request)
       end
     end

data/lib/blacklight/version.rb

@@ -5,6 +5,6 @@ module Blacklight
       @version ||= File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).chomp
     end
 
-    VERSION = self.version
+    VERSION = version
   end
 end

data/lib/generators/blacklight/assets_generator.rb

@@ -1,46 +1,62 @@
+# 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 'bootstrap', '~> 4.0'
       gem 'twitter-typeahead-rails', '0.11.1.pre.corejavascript'
     end
 
+    # Add sprockets javascript to Rails 6.
+    def create_sprockets_javascript
+      return if Rails.version < '6.0.0'
+
+      create_file 'app/assets/javascripts/application.js' do
+        <<~CONTENT
+          //= require jquery
+          //= require rails-ujs
+          //= require turbolinks
+        CONTENT
+      end
+    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?
                  '//= require turbolinks'
-               elsif needs_jquery?
-                 '//= require rails-ujs'
                else
-                 '//= require jquery_ujs'
+                 '//= require rails-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
+
+      insert_into_file "app/assets/javascripts/application.js", before: '//= require rails-ujs' do
+        "//= require jquery3\n"
+      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?
+      gem 'jquery-rails'
     end
 
     private
 
-    def needs_jquery?
-      Rails.version >= '5.1'
-    end
-
     def turbolinks?
       @turbolinks ||= IO.read("app/assets/javascripts/application.js").include?('turbolinks')
     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 if respond_to? :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,15 +3,13 @@ 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 ."
+    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"
+
+    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: !defined?(Sprockets), desc: "Skip generating javascript and css assets into the application"
     class_option :'skip-solr', type: :boolean, default: false, desc: "Skip generating solr configurations."
 
@@ -28,22 +26,7 @@ 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
-    end
-
-    def bundle_install
-      Bundler.with_clean_env do
-        run "bundle install"
-      end
+      generate 'blacklight:solr' unless options[:'skip-solr']
     end
 
     # Copy all files in templates/public/ directory to public/
@@ -53,6 +36,12 @@ module Blacklight
       generate "blacklight:assets" unless options[:'skip-assets']
     end
 
+    def bundle_install
+      Bundler.with_clean_env do
+        run "bundle install"
+      end
+    end
+
     def generate_blacklight_document
       generate 'blacklight:document', document_name
     end
@@ -82,14 +71,6 @@ module Blacklight
       route("root to: \"#{controller_name}#index\"")
     end
 
-    def add_sass_configuration
-      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
-      end
-    end
-
     def inject_blacklight_i18n_strings
       copy_file "blacklight.en.yml", "config/locales/blacklight.en.yml"
     end
@@ -98,7 +79,7 @@ EOF
       return unless options[:marc]
 
       blacklight_marc = String.new('blacklight-marc')
-      gem blacklight_marc, '~> 6.1'
+      gem blacklight_marc, '>= 7.0.0.rc1', '< 8'
 
       Bundler.with_clean_env do
         run "bundle install"