blacklight 6.5.0 → 6.6.0

data/lib/blacklight/solr/repository.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 module Blacklight::Solr
   class Repository < Blacklight::AbstractRepository
-
     ##
     # Find a single solr document result (by id) using the document configuration
-    # @param [String] document's unique key value
-    # @param [Hash] additional solr query parameters
+    # @param [String] id document's unique key value
+    # @param [Hash] params additional solr query parameters
     def find id, params = {}
       doc_params = params.reverse_merge(blacklight_config.default_document_solr_params)
                          .reverse_merge(qt: blacklight_config.document_solr_request_handler)
@@ -18,7 +17,7 @@ module Blacklight::Solr
 
     ##
     # Execute a search query against solr
-    # @param [Hash] solr query parameters
+    # @param [Hash] params solr query parameters
     def search params = {}
       send_and_receive blacklight_config.solr_path, params.reverse_merge(qt: blacklight_config.qt)
     end

data/lib/blacklight/solr/request.rb

@@ -2,7 +2,6 @@
 class Blacklight::Solr::InvalidParameter < ArgumentError; end
 
 class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess
-
   SINGULAR_KEYS = %w(facet fl q qt rows start spellcheck spellcheck.q sort per_page wt hl group defType)
   ARRAY_KEYS = %w(facet.field facet.query facet.pivot fq hl.fl)
 
@@ -41,5 +40,4 @@ class Blacklight::Solr::Request < ActiveSupport::HashWithIndifferentAccess
   def to_hash
     reject {|key, value| ARRAY_KEYS.include?(key) && value.blank?}
   end
-
 end

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

@@ -60,6 +60,7 @@ module Blacklight::Solr::Response::Facets
     end
     
     private
+
     # Per https://wiki.apache.org/solr/SimpleFacetParameters#facet.limit
     def solr_default_limit
       100
@@ -95,7 +96,7 @@ module Blacklight::Solr::Response::Facets
     @facet_counts ||= self['facet_counts'] || {}
   end
 
-  # Returns the hash of all the facet_fields (ie: {'instock_b' => ['true', 123, 'false', 20]}
+  # Returns the hash of all the facet_fields (ie: { 'instock_b' => ['true', 123, 'false', 20] }
   def facet_fields
     @facet_fields ||= begin
       val = facet_counts['facet_fields'] || {}
@@ -120,6 +121,7 @@ module Blacklight::Solr::Response::Facets
   end
 
   private
+
   ##
   # Convert Solr responses of various json.nl flavors to 
   def list_as_hash solr_list
@@ -144,8 +146,7 @@ module Blacklight::Solr::Response::Facets
   # a hash of Blacklight::Solr::Response::Facet::FacetField objects
   def facet_field_aggregations
     list_as_hash(facet_fields).each_with_object({}) do |(facet_field_name, values), hash|
-      items = []
-      values.each do |value, hits|
+      items = values.map do |value, hits|
         i = FacetItem.new(value: value, hits: hits)
 
         # solr facet.missing serialization
@@ -154,7 +155,7 @@ module Blacklight::Solr::Response::Facets
           i.fq = "-#{facet_field_name}:[* TO *]"
         end
 
-        items << i
+        i
       end
 
       options = facet_field_aggregation_options(facet_field_name)
@@ -162,12 +163,10 @@ module Blacklight::Solr::Response::Facets
                                               items,
                                               options)
 
-      if blacklight_config and !blacklight_config.facet_fields[facet_field_name]
-        # alias all the possible blacklight config names..
-        blacklight_config.facet_fields.select { |k,v| v.field == facet_field_name }.each do |key,_|
-          hash[key] = hash[facet_field_name]
-        end
-      end
+      # alias all the possible blacklight config names..
+      blacklight_config.facet_fields.select { |k,v| v.field == facet_field_name }.each do |key,_|
+        hash[key] = hash[facet_field_name]
+      end if blacklight_config and !blacklight_config.facet_fields[facet_field_name]
     end
   end
 
@@ -196,11 +195,10 @@ module Blacklight::Solr::Response::Facets
 
     blacklight_config.facet_fields.select { |k,v| v.query }.each_with_object({}) do |(field_name, facet_field), hash|
         salient_facet_queries = facet_field.query.map { |k, x| x[:fq] }
-        items = []
-        facet_queries.select { |k,v| salient_facet_queries.include?(k) }.reject { |value, hits| hits == 0 }.map do |value,hits|
+        items = facet_queries.select { |k,v| salient_facet_queries.include?(k) }.reject { |value, hits| hits.zero? }.map do |value,hits|
           salient_fields = facet_field.query.select { |key, val| val[:fq] == value }
           key = ((salient_fields.keys if salient_fields.respond_to? :keys) || salient_fields.first).first
-          items << Blacklight::Solr::Response::Facets::FacetItem.new(value: key, hits: hits, label: facet_field.query[key][:label])
+          Blacklight::Solr::Response::Facets::FacetItem.new(value: key, hits: hits, label: facet_field.query[key][:label])
         end
 
         hash[field_name] = Blacklight::Solr::Response::Facets::FacetField.new field_name, items
@@ -212,28 +210,25 @@ module Blacklight::Solr::Response::Facets
   # a hash of Blacklight::Solr::Response::Facet::FacetField objects
   def facet_pivot_aggregations
     facet_pivot.each_with_object({}) do |(field_name, values), hash|
-        items = []
-        values.map do |lst|
-          items << construct_pivot_field(lst)
-        end
+      next unless blacklight_config and !blacklight_config.facet_fields[field_name]
 
-        if blacklight_config and !blacklight_config.facet_fields[field_name]
-          # alias all the possible blacklight config names..
-          blacklight_config.facet_fields.select { |k,v| v.pivot and v.pivot.join(",") == field_name }.each do |key, _|
-            hash[key] = Blacklight::Solr::Response::Facets::FacetField.new key, items
-          end
-        end
+      items = values.map do |lst|
+        construct_pivot_field(lst)
+      end
+
+      # alias all the possible blacklight config names..
+      blacklight_config.facet_fields.select { |k,v| v.pivot and v.pivot.join(",") == field_name }.each do |key, _|
+        hash[key] = Blacklight::Solr::Response::Facets::FacetField.new key, items
+      end
     end
   end
   
   ##
   # Recursively parse the pivot facet response to build up the full pivot tree
   def construct_pivot_field lst, parent_fq = {}
-    items = []
-
-    lst[:pivot].each do |i|
-      items << construct_pivot_field(i, parent_fq.merge({ lst[:field] => lst[:value] }))
-    end if lst[:pivot]
+    items = Array(lst[:pivot]).map do |i|
+      construct_pivot_field(i, parent_fq.merge({ lst[:field] => lst[:value] }))
+    end
 
     Blacklight::Solr::Response::Facets::FacetItem.new(value: lst[:value], hits: lst[:count], field: lst[:field], items: items, fq: parent_fq)
   end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 class Blacklight::Solr::Response::Group
-
   include Blacklight::Solr::Response::PaginationMethods
 
   attr_reader :key, :group, :response

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 class Blacklight::Solr::Response::GroupResponse
-
   include Blacklight::Solr::Response::PaginationMethods
 
   attr_reader :key, :group, :response
@@ -34,17 +33,14 @@ class Blacklight::Solr::Response::GroupResponse
   end
 
   def method_missing meth, *args, &block
-
     if response.respond_to? meth
       response.send(meth, *args, &block)
     else
       super
     end
-
   end
 
-  def respond_to? meth
+  def respond_to_missing? meth, include_private = false
     response.respond_to?(meth) || super
   end
-
 end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 module Blacklight::Solr::Response::PaginationMethods
-
   include Kaminari::PageScopeMethods
   include Kaminari::ConfigurationMethods::ClassMethods
 

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

@@ -14,6 +14,6 @@ module Blacklight::Solr::Response::Response
   end
 
   def empty?
-    total == 0
+    total.zero?
   end
 end

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

@@ -4,13 +4,11 @@
 # response.spelling.words
 #
 module Blacklight::Solr::Response::Spelling
-
   def spelling
     @spelling ||= Base.new(self)
   end
 
   class Base
-
     attr_reader :response
 
     def initialize(response)
@@ -88,7 +86,5 @@ module Blacklight::Solr::Response::Spelling
           end
         end
     end
-
   end
-
 end

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -70,7 +70,7 @@ module Blacklight::Solr
           "{!lucene}NOT *:*"
         else
           "{!lucene}" + q.map do |field, values|
-            "#{field}:(#{Array(values).map { |x| solr_param_quote(x) }.join(" OR ")})"
+            "#{field}:(#{Array(values).map { |x| solr_param_quote(x) }.join(' OR ')})"
           end.join(" AND ")
         end
 
@@ -84,7 +84,6 @@ module Blacklight::Solr
     # Add any existing facet limits, stored in app-level HTTP query
     # as :f, to solr as appropriate :fq query.
     def add_facet_fq_to_solr(solr_parameters)
-
       # convert a String value into an Array
       if solr_parameters[:fq].is_a? String
         solr_parameters[:fq] = [solr_parameters[:fq]]
@@ -95,8 +94,7 @@ module Blacklight::Solr
         f_request_params = blacklight_params[:f]
 
         f_request_params.each_pair do |facet_field, value_list|
-          Array(value_list).each do |value|
-            next if value.blank? # skip empty strings
+          Array(value_list).reject(&:blank?).each do |value|
             solr_parameters.append_filter_query facet_value_to_fq_string(facet_field, value)
           end
         end
@@ -111,13 +109,12 @@ module Blacklight::Solr
       facet_fields_to_include_in_request.each do |field_name, facet|
         solr_parameters[:facet] ||= true
 
-        case
-          when facet.pivot
-            solr_parameters.append_facet_pivot with_ex_local_param(facet.ex, facet.pivot.join(","))
-          when facet.query
-            solr_parameters.append_facet_query facet.query.map { |k, x| with_ex_local_param(facet.ex, x[:fq]) }
-          else
-            solr_parameters.append_facet_fields with_ex_local_param(facet.ex, facet.field)
+        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]) }
+        else
+          solr_parameters.append_facet_fields with_ex_local_param(facet.ex, facet.field)
         end
 
         if facet.sort
@@ -137,11 +134,9 @@ module Blacklight::Solr
 
     def add_solr_fields_to_query solr_parameters
       blacklight_config.show_fields.select(&method(:should_add_field_to_request?)).each do |field_name, field|
-        if field.solr_params
-          field.solr_params.each do |k, v|
-            solr_parameters[:"f.#{field.field}.#{k}"] = v
-          end
-        end
+        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|
@@ -150,11 +145,9 @@ module Blacklight::Solr
           solr_parameters.append_highlight_field field.field
         end
 
-        if field.solr_params
-          field.solr_params.each do |k, v|
-            solr_parameters[:"f.#{field.field}.#{k}"] = v
-          end
-        end
+        field.solr_params.each do |k, v|
+          solr_parameters[:"f.#{field.field}.#{k}"] = v
+        end if field.solr_params
       end
     end
 
@@ -166,9 +159,7 @@ module Blacklight::Solr
 
       solr_params[:rows] = rows
 
-      if start != 0
-        solr_params[:start] = start
-      end
+      solr_params[:start] = start if start.nonzero?
     end
 
     ###
@@ -258,7 +249,6 @@ module Blacklight::Solr
       end
     end
 
-
     ##
     # A helper method used for generating solr LocalParams, put quotes
     # around the term unless it's a bare-word. Escape internal quotes
@@ -271,7 +261,7 @@ module Blacklight::Solr
           val.gsub("'", "\\\\\'").gsub('"', "\\\\\"") +
           options[:quote]
       end
-      return val
+      val
     end
 
     private
@@ -287,28 +277,26 @@ module Blacklight::Solr
       local_params = []
       local_params << "tag=#{facet_config.tag}" if facet_config and facet_config.tag
 
-      prefix = "{!#{local_params.join(" ")}}" unless local_params.empty?
+      prefix = "{!#{local_params.join(' ')}}" unless local_params.empty?
 
-      case
-        when (facet_config and facet_config.query)
-          if facet_config.query[value]
-            facet_config.query[value][:fq]
-          else
-            # exclude all documents if the custom facet key specified was not found
-            '-*:*'
-          end
-        when value.is_a?(Range)
-          "#{prefix}#{solr_field}:[#{value.first} TO #{value.last}]"
+      if facet_config and facet_config.query
+        if facet_config.query[value]
+          facet_config.query[value][:fq]
         else
-          "{!term f=#{solr_field}#{(" " + local_params.join(" ")) unless local_params.empty?}}#{convert_to_term_value(value)}"
+          # exclude all documents if the custom facet key specified was not found
+          '-*:*'
+        end
+      elsif value.is_a?(Range)
+        "#{prefix}#{solr_field}:[#{value.first} TO #{value.last}]"
+      else
+        "{!term f=#{solr_field}#{(' ' + local_params.join(' ')) unless local_params.empty?}}#{convert_to_term_value(value)}"
       end
     end
 
     def convert_to_term_value(value)
-      case
-      when (value.is_a?(DateTime) or value.is_a?(Time))
+      if value.is_a?(DateTime) or value.is_a?(Time)
         value.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
-      when value.is_a?(Date)
+      elsif value.is_a?(Date)
         value.to_time(:local).strftime("%Y-%m-%dT%H:%M:%SZ")
       else
         value.to_s

data/lib/blacklight/utils.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require 'ostruct'
 module Blacklight
-
   module Utils
     def self.needs_attr_accessible?
       protected_attributes_enabled?
@@ -39,7 +38,7 @@ module Blacklight
 
     ##
     # Merge the values of this OpenStruct with another OpenStruct or Hash
-    # @param [Hash,#to_h]
+    # @param [Hash,#to_h] other_hash
     # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
     def merge other_hash
       self.class.new to_h.merge((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
@@ -47,7 +46,7 @@ module Blacklight
 
     ##
     # Merge the values of another OpenStruct or Hash into this object
-    # @param [Hash,#to_h]
+    # @param [Hash,#to_h] other_hash
     # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
     def merge! other_hash
       @table.merge!((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
@@ -58,7 +57,6 @@ module Blacklight
     end
   end
 
-
   ##
   # An OpenStruct refinement that converts any hash-keys into  
   # additional instances of NestedOpenStructWithHashAccess
@@ -142,7 +140,7 @@ module Blacklight
 
     ##
     # Merge the values of this OpenStruct with another OpenStruct or Hash
-    # @param [Hash,#to_h]
+    # @param [Hash,#to_h] other_hash
     # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
     def merge other_hash
       self.class.new nested_class, to_h.merge((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
@@ -150,7 +148,7 @@ module Blacklight
 
     ##
     # Merge the values of another OpenStruct or Hash into this object
-    # @param [Hash,#to_h]
+    # @param [Hash,#to_h] other_hash
     # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
     def merge! other_hash
       @table.merge!(nested_class, (other_hash if other_hash.is_a? Hash) || other_hash.to_h)
@@ -162,15 +160,20 @@ module Blacklight
     def method_missing(mid, *args)
       len = args.length
 
-      if len == 0
+      if len.zero?
         new_ostruct_member(mid)
         @table[mid]
       else
         super
       end
     end
+    
+    def respond_to_missing?(*_)
+      true
+    end
 
     private
+
     def set_default_proc!
       self.default_proc = lambda do |hash, key|
         hash[key] = self.nested_class.new

data/lib/generators/blacklight/assets_generator.rb

@@ -21,7 +21,6 @@ module Blacklight
 //= require blacklight/blacklight
 EOF
       end
-
     end
 
     private

data/lib/generators/blacklight/document_generator.rb

@@ -17,6 +17,5 @@ module Blacklight
     def create_solr_document
       template "solr_document.rb", "app/models/#{model_name}.rb"
     end
-
   end
 end