blacklight 6.5.0 → 6.6.0

data/app/presenters/blacklight/rendering/abstract_step.rb

@@ -21,4 +21,3 @@ module Blacklight
     end
   end
 end
-

data/app/presenters/blacklight/rendering/helper_method.rb

@@ -2,8 +2,11 @@ module Blacklight
   module Rendering
     class HelperMethod < AbstractStep
       def render
-        return next_step(values) unless config.helper_method
-        return render_helper # short circut the rest of the steps
+        if config.helper_method
+          render_helper # short circut the rest of the steps
+        else  
+          next_step(values)
+        end
       end
 
       private
@@ -18,6 +21,3 @@ module Blacklight
     end
   end
 end
-
-
-

data/app/presenters/blacklight/rendering/link_to_facet.rb

@@ -15,7 +15,7 @@ module Blacklight
         end
 
         def link_field
-          return config.key if config.link_to_search === true
+          return config.key if config.link_to_search == true
           config.link_to_search
         end
 

data/app/presenters/blacklight/show_presenter.rb

@@ -7,7 +7,7 @@ module Blacklight
     attr_reader :document, :configuration, :view_context
 
     # @param [SolrDocument] document
-    # @param [ActionView::Base] view context scope for linking and generating urls
+    # @param [ActionView::Base] view_context scope for linking and generating urls
     # @param [Blacklight::Configuration] configuration
     def initialize(document, view_context, configuration = view_context.blacklight_config)
       @document = document
@@ -19,7 +19,7 @@ module Blacklight
     # Create <link rel="alternate"> links from a documents dynamically
     # provided export formats. Returns empty string if no links available.
     #
-    # @params [Hash] options
+    # @param [Hash] options
     # @option options [Boolean] :unique ensures only one link is output for every
     #     content type, e.g. as required by atom
     # @option options [Array<String>] :exclude array of format shortnames to not include in the output
@@ -55,7 +55,6 @@ module Blacklight
     # Get the value of the document's "title" field, or a placeholder
     # value (if empty)
     #
-    # @param [SolrDocument] document
     # @return [String]
     def heading
       fields = Array.wrap(view_config.title_field)
@@ -77,7 +76,7 @@ module Blacklight
     # may drive the value of the field
     # @param [String] field
     # @param [Hash] options
-    # @options opts [String] :value
+    # @option options [String] :value
     def field_value field, options={}
       field_values(field_config(field), options)
     end
@@ -117,7 +116,7 @@ module Blacklight
       # Rendering:
       #   - helper_method
       #   - link_to_search
-      # @param [Blacklight::Configuration::Field] solr field configuration
+      # @param [Blacklight::Configuration::Field] field_config solr field configuration
       # @param [Hash] options additional options to pass to the rendering helpers
       def field_values(field_config, options={})
         FieldPresenter.new(view_context, document, field_config, options).render

data/app/services/blacklight/field_retriever.rb

@@ -13,13 +13,12 @@ module Blacklight
     # @return [Array]
     def fetch
       Array.wrap(
-        case    
-          when field_config.highlight
-            retrieve_highlight
-          when field_config.accessor
-            retieve_using_accessor
-          when field_config
-            retrieve_simple
+        if field_config.highlight
+          retrieve_highlight
+        elsif field_config.accessor
+          retieve_using_accessor
+        elsif field_config
+          retrieve_simple
         end
       )
     end
@@ -37,10 +36,10 @@ module Blacklight
 
       def retieve_using_accessor
         # implicit method call
-        if field_config.accessor === true
+        if field_config.accessor == true
           document.send(field)
         # arity-1 method call (include the field name in the call)
-        elsif !field_config.accessor.is_a?(Array) && document.method(field_config.accessor).arity != 0
+        elsif !field_config.accessor.is_a?(Array) && document.method(field_config.accessor).arity.nonzero?
           document.send(field_config.accessor, field)
         # chained method calls
         else

data/app/views/catalog/_facet_limit.html.erb

@@ -5,7 +5,7 @@
   <% unless paginator.last_page? || params[:action] == "facet" %>
     <li class="more_facets_link">
       <%= link_to t("more_#{field_name}_html", scope: 'blacklight.search.facets', default: :more_html, field_name: facet_field.label), 
-        search_facet_url(id: field_name), class: "more_facets_link" %>
+        search_facet_path(id: field_name), class: "more_facets_link" %>
     </li>
   <% end %>
 </ul>

data/blacklight.gemspec

@@ -42,4 +42,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "poltergeist"
   s.add_development_dependency 'engine_cart', '~> 0.10'
   s.add_development_dependency "equivalent-xml"
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "rubocop-rspec"
 end

data/lib/blacklight.rb

@@ -36,7 +36,7 @@ module Blacklight
 
   ##
   # The configured repository class. By convention, this is
-  # the class Blacklight::{name of the adapter}::Repository, e.g.
+  # the class Blacklight::(name of the adapter)::Repository, e.g.
   #   elastic_search => Blacklight::ElasticSearch::Repository
   def self.repository_class
     case connection_config[:adapter]
@@ -92,7 +92,7 @@ module Blacklight
       raise("#{blacklight_config_file} was found, but was blank or malformed.\n")
     end
 
-    return @blacklight_yml
+    @blacklight_yml
   end
 
   def self.logger

data/lib/blacklight/abstract_repository.rb

@@ -19,20 +19,21 @@ module Blacklight
 
     ##
     # Find a single document result by a known id
-    # @param [String] document's unique key value
-    # @param [Hash] additional query parameters
+    # @param [String] id document's unique key value
+    # @param [Hash] params additional query parameters
     def find(id, params = {})
       raise NotImplementedError
     end
 
     ##
     # Execute a search query against a search index
-    # @param [Hash] query parameters
+    # @param [Hash] params query parameters
     def search(params = {})
       raise NotImplementedError
     end
 
     protected
+
       def connection_config
         blacklight_config.connection_config
       end

data/lib/blacklight/configuration.rb

@@ -4,12 +4,10 @@ module Blacklight
   # Blacklight::Configuration holds the configuration for a Blacklight::Controller, including
   # fields to display, facets to show, sort options, and search fields.
   class Configuration < OpenStructWithHashAccess
-
-    
     # Using required_dependency to work around Rails autoloading
     # problems when developing blacklight. Without this, any change
     # to this class breaks other classes in this namespace
-    
+
     require_dependency 'blacklight/configuration/context'
     require_dependency 'blacklight/configuration/view_config'
     require_dependency 'blacklight/configuration/tool_config'
@@ -26,7 +24,6 @@ module Blacklight
     # the basic, required Blacklight fields
     class << self
       def default_values
-
         @default_values ||= begin
           {
           ##
@@ -42,7 +39,7 @@ module Blacklight
           ##
           # === Single document request configuration
           ##
-          # The solr rqeuest handler to use when requesting only a single document 
+          # The solr rqeuest handler to use when requesting only a single document
           document_solr_request_handler: 'document',
           # THe path to send single document requests to solr
           document_solr_path: nil,
@@ -50,7 +47,7 @@ module Blacklight
           # Default values of parameters to send when requesting a single document
           default_document_solr_params: {
             ## Blacklight provides these settings in the /document request handler
-            ## by default, we just ask for all fields. 
+            ## by default, we just ask for all fields.
             #fl: '*',
             ## this is a fancy way to say "find the document by id using
             ## the value in the id query parameter"
@@ -95,17 +92,17 @@ module Blacklight
             group: false,
             # additional response formats for search results
             respond_to: OpenStructWithHashAccess.new
-            ),
+          ),
           # Additional configuration when displaying a single document
           show: ViewConfig::Show.new(
             # document presenter class used by helpers and views
             document_presenter_class: nil,
             # default route parameters for 'show' requests
-            # set this to a hash with additional arguments to merge into 
-            # the route, or set `controller: :current` to route to the 
+            # set this to a hash with additional arguments to merge into
+            # the route, or set `controller: :current` to route to the
             # current controller.
             route: nil,
-            # partials to render for each document(see #render_document_partials) 
+            # partials to render for each document(see #render_document_partials)
             partials: [:show_header, :show],
             document_actions: NestedOpenStructWithHashAccess.new(ToolConfig)
           ),
@@ -135,7 +132,7 @@ module Blacklight
           # Maximum number of results to show per page
           max_per_page: 100,
           # Options for the user for number of results to show per page
-          per_page: [10,20,50,100],
+          per_page: [10, 20, 50, 100],
           default_per_page: nil,
           # how many searches to save in session history
           search_history_window: 100,
@@ -148,22 +145,21 @@ module Blacklight
     ##
     # Create collections of solr field configurations.
     # This will create array-like accessor methods for
-    # the given field, and an #add_x_field convenience 
+    # the given field, and an #add_x_field convenience
     # method for adding new fields to the configuration
-    
+
     # facet fields
     define_field_access :facet_field
-    
+
     # solr fields to display on search results
     define_field_access :index_field
-    
+
     # solr fields to display when showing single documents
     define_field_access :show_field
-    
-    # solr "fields" to use for scoping user search queries
-    # to particular fields
+
+    # solr "fields" to use for scoping user search queries to particular fields
     define_field_access :search_field
-    
+
     # solr fields to use for sorting results
     define_field_access :sort_field
 
@@ -174,7 +170,6 @@ module Blacklight
       self
     end
 
-    ##
     # Initialize default values from the class attribute
     def initialize_default_values!
       Marshal.load(Marshal.dump(self.class.default_values)).each do |k, v|
@@ -187,7 +182,7 @@ module Blacklight
     end
 
     # only here to support alias_method
-    def document_model= *args
+    def document_model=(*args)
       super
     end
 
@@ -206,7 +201,7 @@ module Blacklight
     end
     deprecation_deprecate :document_presenter_class= => "replaced by show.presenter_class and index.presenter_class"
 
-    def response_model= *args
+    def response_model=(*args)
       super
     end
 
@@ -234,54 +229,53 @@ module Blacklight
       super || per_page.first
     end
 
-    ##
     # DSL helper
     def configure
       yield self if block_given?
       self
     end
 
-    ##
     # Returns default search field, used for simpler display in history, etc.
     # if not set, defaults to first defined search field
     def default_search_field
       field = super
       field ||= search_fields.values.find { |f| f.default == true }
-      field ||= search_fields.values.first
-
-      field
+      field || search_fields.values.first
     end
 
-    ##
     # Returns default sort field, used for simpler display in history, etc.
     # if not set, defaults to first defined sort field
     def default_sort_field
       field = super
       field ||= sort_fields.values.find { |f| f.default == true }
-      field ||= sort_fields.values.first
-
-      field
+      field || sort_fields.values.first
     end
-    
+
     def default_title_field
       document_model.unique_key || 'id'
     end
 
-    ##
+    # @param [String] field Solr facet name
+    # @return [Blacklight::Configuration::FacetField] Blacklight facet configuration for the solr field
+    def facet_configuration_for_field(field)
+      # short-circuit on the common case, where the solr field name and the blacklight field name are the same.
+      return facet_fields[field] if facet_fields[field] && facet_fields[field].field == field
+
+      # Find the facet field configuration for the solr field, or provide a default.
+      facet_fields.values.find { |v| v.field.to_s == field.to_s } ||
+        FacetField.new(field: field).normalize!
+    end
+
     # Add any configured facet fields to the default solr parameters hash
     # @overload add_facet_fields_to_solr_request!
     #    add all facet fields to the solr request
-    # @overload add_facet_fields_to_solr_request! field, field, field
-    #   @param [Symbol] Field names to add to the solr request
-    #   @param [Symbol] 
-    #   @param [Symbol] 
-    def add_facet_fields_to_solr_request! *fields
+    # @overload add_facet_fields_to_solr_request! field, field, etc
+    #   @param [Symbol] field Field names to add to the solr request
+    def add_facet_fields_to_solr_request!(*fields)
       if fields.empty?
         self.add_facet_fields_to_solr_request = true
       else
-        facet_fields.slice(*fields).each do |k,v|
-          v.include_in_request = true
-        end
+        facet_fields.slice(*fields).each { |_k, v| v.include_in_request = true }
       end
     end
 
@@ -289,24 +283,15 @@ module Blacklight
     # Add any configured facet fields to the default solr parameters hash
     # @overload add_field_configuration_to_solr_request!
     #    add all index, show, and facet fields to the solr request
-    # @overload add_field_configuration_to_solr_request! field, field, field
-    #   @param [Symbol] Field names to add to the solr request
-    #   @param [Symbol] 
-    #   @param [Symbol] 
-    def add_field_configuration_to_solr_request! *fields
+    # @overload add_field_configuration_to_solr_request! field, field, etc
+    #   @param [Symbol] field Field names to add to the solr request
+    def add_field_configuration_to_solr_request!(*fields)
       if fields.empty?
         self.add_field_configuration_to_solr_request = true
       else
-        index_fields.slice(*fields).each do |k,v|
-          v.include_in_request = true
-        end
-
-        show_fields.slice(*fields).each do |k,v|
-          v.include_in_request = true
-        end
-        facet_fields.slice(*fields).each do |k,v|
-          v.include_in_request = true
-        end
+        index_fields.slice(*fields).each { |_k, v| v.include_in_request = true }
+        show_fields.slice(*fields).each { |_k, v| v.include_in_request = true }
+        facet_fields.slice(*fields).each { |_k, v| v.include_in_request = true }
       end
     end
 
@@ -329,7 +314,7 @@ module Blacklight
     ##
     # Get a view configuration for the given view type
     # including default values from the index configuration
-    def view_config view_type
+    def view_config(view_type)
       if view_type == :show
         self.index.merge self.show
       else
@@ -337,65 +322,45 @@ module Blacklight
       end
     end
 
-    ##
+    # YARD will include inline disabling as docs, cannot do multiline inside @!macro.  AND this must be separate from doc block.
+    # rubocop:disable Metrics/LineLength
+
     # Add a partial to the tools when rendering a document.
-    # @param partial [String] the name of the document partial
-    # @param opts [Hash]
-    # @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true.
-    #                             The proc will receive the action configuration and the document or documents for the action.
-    # @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true
-    #                             The proc will receive the action configuration and the document or documents for the action.
+    # @!macro partial_if_unless
+    #   @param name [String] the name of the document partial
+    #   @param opts [Hash]
+    #   @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true. The proc will receive the action configuration and the document or documents for the action.
+    #   @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true. The proc will receive the action configuration and the document or documents for the action.
     def add_show_tools_partial(name, opts = {})
       opts[:partial] ||= 'document_action'
       add_action(show.document_actions, name, opts)
     end
+    # rubocop:enable Metrics/LineLength
 
-    ##
     # Add a tool for the search result list itself
-    # @param partial [String] the name of the document partial
-    # @param opts [Hash]
-    # @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true.
-    #                             The proc will receive the action configuration and the document or documents for the action.
-    # @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true
-    #                             The proc will receive the action configuration and the document or documents for the action.
+    # @!macro partial_if_unless
     def add_results_collection_tool(name, opts = {})
       add_action(index.collection_actions, name, opts)
     end
 
-    ##
     # Add a partial to the tools for each document in the search results.
-    # @param partial [String] the name of the document partial
-    # @param opts [Hash]
-    # @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true.
-    #                             The proc will receive the action configuration and the document or documents for the action.
-    # @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true
-    #                             The proc will receive the action configuration and the document or documents for the action.
+    # @!macro partial_if_unless
     def add_results_document_tool(name, opts = {})
       add_action(index.document_actions, name, opts)
     end
 
-    ##
     # Add a partial to the header navbar
-    # @param partial [String] the name of the document partial
-    # @param opts [Hash]
-    # @option opts [Symbol,Proc] :if render this action if the method identified by the symbol or the proc evaluates to true.
-    #                             The proc will receive the action configuration and the document or documents for the action.
-    # @option opts [Symbol,Proc] :unless render this action unless the method identified by the symbol or the proc evaluates to true
-    #                             The proc will receive the action configuration and the document or documents for the action.
-    def add_nav_action name, opts = {}
+    # @!macro partial_if_unless
+    def add_nav_action(name, opts = {})
       add_action(navbar.partials, name, opts)
     end
 
     private
 
-      def add_action config_hash, name, opts
+      def add_action(config_hash, name, opts)
         config = Blacklight::Configuration::ToolConfig.new opts
         config.name = name
-
-        if block_given?
-          yield config
-        end
-
+        yield(config) if block_given?
         config_hash[name] = config
       end
   end