blacklight 6.5.0 → 6.6.0

data/.yardopts

@@ -1,4 +1,6 @@
 --protected
+--exclude lib/generators/blacklight/templates/
 -
-app/**/*.rb
+README.md
+LICENSE
 

data/Gemfile

@@ -3,9 +3,6 @@ source 'https://rubygems.org'
 # Please see blacklight.gemspec for dependency information.
 gemspec path: File.expand_path('..', __FILE__)
 
-gem 'simplecov', '~> 0.10', require: false
-gem 'coveralls', require: false
-
 group :test do
   gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 end

data/Rakefile

@@ -12,4 +12,4 @@ Bundler::GemHelper.install_tasks
 load "tasks/blacklight.rake"
 load "lib/railties/blacklight.rake"
 
-task :default => [:ci]
+task :default => [:rubocop, :ci]

data/VERSION

@@ -1 +1 @@
-6.5.0
+6.6.0

data/Vagrantfile

@@ -6,7 +6,6 @@
 # backwards compatibility). Please don't change it unless you know what
 # you're doing.
 Vagrant.configure(2) do |config|
-
   # The most common configuration options are documented and commented below.
   # For a complete reference, please see the online documentation at
   # https://docs.vagrantup.com.
@@ -17,7 +16,6 @@ Vagrant.configure(2) do |config|
   config.vm.hostname = "blacklight"
   config.vm.synced_folder ".", "/home/vagrant/sync", type: 'virtualbox'
 
-
   # Disable automatic box update checking. If you disable this, then
   # boxes will only be checked for updates when the user runs
   # `vagrant box outdated`. This is not recommended.

data/app/controllers/bookmarks_controller.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
 class BookmarksController < CatalogController  
-
   include Blacklight::Bookmarks
-
 end 

data/app/controllers/catalog_controller.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
 class CatalogController < ApplicationController  
-
   include Blacklight::Catalog
-
 end 

data/app/controllers/concerns/blacklight/base.rb

@@ -18,7 +18,6 @@ module Blacklight::Base
 
   # when The index throws an error (Blacklight::Exceptions::InvalidRequest), this method is executed.
   def handle_request_error(exception)
-
     if Rails.env.development? || Rails.env.test?
       raise exception # Rails own code will catch and give usual Rails error page with stack trace
     else

data/app/controllers/concerns/blacklight/bookmarks.rb

@@ -57,7 +57,6 @@ module Blacklight::Bookmarks
     end
   end
 
-
   def update
     create
   end
@@ -135,6 +134,7 @@ module Blacklight::Bookmarks
   end
 
   protected
+
   def verify_user
     unless current_or_guest_user or (action == "index" and token_or_current_or_guest_user)
       flash[:notice] = I18n.t('blacklight.bookmarks.need_login') and raise Blacklight::Exceptions::AccessDenied

data/app/controllers/concerns/blacklight/catalog.rb

@@ -103,6 +103,7 @@ module Blacklight::Catalog
     end
 
     protected
+
     #
     # non-routable methods ->
     #
@@ -178,9 +179,6 @@ module Blacklight::Catalog
     # By default, any search action from a Blacklight::Catalog controller
     # should use the current controller when constructing the route.
     def search_action_url options = {}
-      raise ArgumentError, "Options was not a hash (#{options.class}" unless options.is_a? Hash
-      # We don't want to permit here because one of the options could be :only_path, which is an option, but not a parameter
-      # options.permit!
       url_for(options.merge(action: 'index'))
     end
 
@@ -206,14 +204,13 @@ module Blacklight::Catalog
      end
 
     def validate_sms_params
-      case
-      when params[:to].blank?
+      if params[:to].blank?
         flash[:error] = I18n.t('blacklight.sms.errors.to.blank')
-      when params[:carrier].blank?
+      elsif params[:carrier].blank?
         flash[:error] = I18n.t('blacklight.sms.errors.carrier.blank')
-      when params[:to].gsub(/[^\d]/, '').length != 10
+      elsif params[:to].gsub(/[^\d]/, '').length != 10
         flash[:error] = I18n.t('blacklight.sms.errors.to.invalid', :to => params[:to])
-      when !sms_mappings.values.include?(params[:carrier])
+      elsif !sms_mappings.values.include?(params[:carrier])
         flash[:error] = I18n.t('blacklight.sms.errors.carrier.invalid')
       end
 
@@ -225,10 +222,9 @@ module Blacklight::Catalog
     end
 
     def validate_email_params
-      case
-      when params[:to].blank?
+      if params[:to].blank?
         flash[:error] = I18n.t('blacklight.email.errors.to.blank')
-      when !params[:to].match(defined?(Devise) ? Devise.email_regexp : /^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}$/)
+      elsif !params[:to].match(defined?(Devise) ? Devise.email_regexp : /^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}$/)
         flash[:error] = I18n.t('blacklight.email.errors.to.invalid', :to => params[:to])
       end
 

data/app/controllers/concerns/blacklight/controller.rb

@@ -2,8 +2,9 @@
 # Filters added to this controller apply to all controllers in the hosting application
 # as this module is mixed-in to the application controller in the hosting app on installation.
 module Blacklight::Controller
-
   extend ActiveSupport::Concern
+  extend Deprecation
+  self.deprecation_horizon = 'blacklight 7.x'
 
   included do
     include Blacklight::SearchFields
@@ -22,24 +23,20 @@ module Blacklight::Controller
     # extra head content
     helper_method :has_user_authentication_provider?
     helper_method :blacklight_config, :blacklight_configuration_context
-    helper_method :search_action_url, :search_action_path, :search_facet_url
+    helper_method :search_action_url, :search_action_path, :search_facet_url, :search_facet_path
     helper_method :search_state
 
-
     # This callback runs when a user first logs in
 
     define_callbacks :logging_in_user
     set_callback :logging_in_user, :before, :transfer_guest_user_actions_to_current_user
-
   end
 
   def default_catalog_controller
     CatalogController
   end
 
-  def blacklight_config
-    default_catalog_controller.blacklight_config
-  end
+  delegate :blacklight_config, to: :default_catalog_controller
 
     protected
 
@@ -88,6 +85,13 @@ module Blacklight::Controller
       opts = search_state.to_h.merge(action: "facet").merge(options).except(:page)
       url_for opts
     end
+    deprecation_deprecate search_facet_url: 'Use search_facet_path instead.'
+
+    def search_facet_path(options = {})
+      Deprecation.silence(Blacklight::Controller) do
+        search_facet_url(options.merge(only_path: true))
+      end
+    end
 
     # Returns a list of Searches from the ids in the user's history.
     def searches_from_history

data/app/controllers/concerns/blacklight/default_component_configuration.rb

@@ -20,21 +20,26 @@ module Blacklight
       add_nav_action(:search_history, partial: 'blacklight/nav/search_history')
     end
 
-    def render_sms_action? config, options = {}
+    def render_sms_action?(_config, _options)
       sms_mappings.present?
     end
 
     module ClassMethods
+      # YARD will include inline disabling as docs, cannot do multiline inside @!macro.  AND this must be separate from doc block.
+      # rubocop:disable Metrics/LineLength
+
+      # @!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.
 
-      ##
       # Add a partial to the tools for 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.
-      def add_show_tools_partial name, opts = {}
+      # @!macro partial_if_unless
+      # @option opts [Boolean] :define_method define a controller method as named, default: true
+      # @option opts [Symbol]  :validator method for toggling between success and failure, should return Boolean (true if valid)
+      # @option opts [Symbol]  :callback method for further processing of documents, receives Array of documents
+      def add_show_tools_partial(name, opts = {})
         blacklight_config.add_show_tools_partial(name, opts)
 
         return if method_defined?(name) || opts[:define_method] == false
@@ -43,9 +48,8 @@ module Blacklight
         define_method name do
           @response, @documents = action_documents
 
-          if request.post? and
-              opts[:callback] and
-              (opts[:validator].blank? || self.send(opts[:validator]))
+          if request.post? && opts[:callback] &&
+            (opts[:validator].blank? || self.send(opts[:validator]))
 
             self.send(opts[:callback], @documents)
 
@@ -63,40 +67,23 @@ module Blacklight
           end
         end
       end
+      # rubocop:enable Metrics/LineLength
 
-      ##
       # Add a tool to be displayed 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.
-      def add_results_document_tool name, opts = {}
+      # @!macro partial_if_unless
+      def add_results_document_tool(name, opts = {})
         blacklight_config.add_results_document_tool(name, opts)
       end
 
-      ##
       # Add a tool to be displayed for the list of search results themselves.
-      # @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_results_collection_tool name, opts = {}
+      # @!macro partial_if_unless
+      def add_results_collection_tool(name, opts = {})
         blacklight_config.add_results_collection_tool(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 = {}
+      # Add a partial to the header navbar.
+      # @!macro partial_if_unless
+      def add_nav_action(name, opts = {})
         blacklight_config.add_nav_action(name, opts)
       end
     end

data/app/controllers/concerns/blacklight/facet.rb

@@ -4,6 +4,8 @@ module Blacklight
   # They are only dependent on `blacklight_config` and `@response`
   #
   module Facet
+    delegate :facet_configuration_for_field, to: :blacklight_config
+
     def facet_paginator(field_config, display_facet)
       blacklight_config.facet_paginator_class.new(
         display_facet.items,
@@ -22,17 +24,6 @@ module Blacklight
       blacklight_config.facet_fields.values.map(&:field)
     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 blacklight_config.facet_fields[field] if blacklight_config.facet_fields[field] && blacklight_config.facet_fields[field].field == field
-
-      # Find the facet field configuration for the solr field, or provide a default.
-      blacklight_config.facet_fields.values.find { |v| v.field.to_s == field.to_s } ||
-        Blacklight::Configuration::FacetField.new(field: field).normalize!
-    end
-
     # Get a FacetField object from the @response
     def facet_by_field_name(field_or_field_name)
       case field_or_field_name

data/app/controllers/concerns/blacklight/request_builders.rb

@@ -10,9 +10,7 @@ module Blacklight
     end
 
     # Override this method to use a search builder other than the one in the config
-    def search_builder_class
-      blacklight_config.search_builder_class
-    end
+    delegate :search_builder_class, to: :blacklight_config
 
     def search_builder
       search_builder_class.new(self)

data/app/controllers/concerns/blacklight/search_context.rb

@@ -6,7 +6,6 @@ module Blacklight::SearchContext
   # own controller.
   included do  
     helper_method :current_search_session, :search_session
-
   end
 
   module ClassMethods

data/app/controllers/concerns/blacklight/search_fields.rb

@@ -13,9 +13,9 @@
 # [:qt]
 #   "search", # Solr qt param, request handler, usually can be left blank; defaults to nil if not explicitly specified
 # [:solr_parameters]
-#   {:qf => "something"} # optional hash of additional parameters to pass to solr for searches on this field.
+#   { :qf => "something" } # optional hash of additional parameters to pass to solr for searches on this field.
 # [:solr_local_parameters]
-#   {:qf => "$something"} # optional hash of additional parameters that will be passed using Solr LocalParams syntax, that can use dollar sign to reference other solr variables.
+#   { :qf => "$something" } # optional hash of additional parameters that will be passed using Solr LocalParams syntax, that can use dollar sign to reference other solr variables.
 # [:include_in_simple_select]
 #   false.  Defaults to true, but you can set to false to have a search field defined for deep-links or BL extensions, but not actually included in the HTML select for simple search choice.
 # 

data/app/controllers/concerns/blacklight/search_helper.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 # SearchHelper is a controller layer mixin. It is in the controller scope: request params, session etc.
-# 
+#
 # NOTE: Be careful when creating variables here as they may be overriding something that already exists.
 # The ActionController docs: http://api.rubyonrails.org/classes/ActionController/Base.html
 #
 # Override these methods in your own controller for customizations:
-# 
+#
 #   class CatalogController < ActionController::Base
-#   
 #     include Blacklight::Catalog
 #
 #     def repository_class
@@ -21,7 +20,6 @@
 #   end
 #
 #   class CatalogController < ActionController::Base
-#
 #     include Blacklight::Catalog
 #     include LocalSearchHelperExtension
 #
@@ -50,23 +48,19 @@ module Blacklight::SearchHelper
 
   # a solr query method
   # @param [Hash] user_params ({}) the user provided parameters (e.g. query, facets, sort, etc)
-  # @yield [search_builder] optional block yields configured SearchBuilder, caller can modify or create new SearchBuilder to be used. Block should return SearchBuilder to be used. 
+  # @yield [search_builder] optional block yields configured SearchBuilder, caller can modify or create new SearchBuilder to be used. Block should return SearchBuilder to be used.
   # @return [Blacklight::Solr::Response] the solr response object
   def search_results(user_params)
     builder = search_builder.with(user_params)
-    builder.page(user_params[:page]) if user_params[:page]
-    builder.rows(user_params[:per_page] || user_params[:rows]) if user_params[:per_page] or user_params[:rows]
-
-    if block_given? 
-      builder = yield(builder)
-    end
+    builder.page = user_params[:page] if user_params[:page]
+    builder.rows = (user_params[:per_page] || user_params[:rows]) if user_params[:per_page] || user_params[:rows]
 
+    builder = yield(builder) if block_given?
     response = repository.search(builder)
 
-    case
-    when (response.grouped? && grouped_key_for_results)
+    if response.grouped? && grouped_key_for_results
       [response.group(grouped_key_for_results), []]
-    when (response.grouped? && response.grouped.length == 1)
+    elsif response.grouped? && response.grouped.length == 1
       [response.grouped.first, []]
     else
       [response, response.documents]
@@ -74,8 +68,9 @@ module Blacklight::SearchHelper
   end
 
   # retrieve a document, given the doc id
+  # @param [Array{#to_s},#to_s] id
   # @return [Blacklight::Solr::Response, Blacklight::SolrDocument] the solr response object and the first document
-  def fetch(id=nil, extra_controller_params={})
+  def fetch(id = nil, extra_controller_params = {})
     if id.is_a? Array
       fetch_many(id, search_state.to_h, extra_controller_params)
     else
@@ -95,26 +90,23 @@ module Blacklight::SearchHelper
   # @return [Blacklight::Solr::Response, Array<Blacklight::SolrDocument>] the solr response and a list of the first and last document
   def get_previous_and_next_documents_for_search(index, request_params, extra_controller_params={})
     p = previous_and_next_document_params(index)
-
     query = search_builder.with(request_params).start(p.delete(:start)).rows(p.delete(:rows)).merge(extra_controller_params).merge(p)
     response = repository.search(query)
-
     document_list = response.documents
 
     # only get the previous doc if there is one
     prev_doc = document_list.first if index > 0
     next_doc = document_list.last if (index + 1) < response.total
-
     [response, [prev_doc, next_doc]]
   end
-  
+
   # a solr query method
   # does a standard search but returns a simplified object.
   # an array is returned, the first item is the query string,
   # the second item is an other array. This second array contains
   # all of the field values for each of the documents...
   # where the field is the "field" argument passed in.
-  def get_opensearch_response(field=nil, request_params = params || {}, extra_controller_params={})
+  def get_opensearch_response(field = nil, request_params = params || {}, extra_controller_params = {})
     field ||= blacklight_config.view_config('opensearch').title_field
 
     query = search_builder.with(request_params).merge(solr_opensearch_params(field)).merge(extra_controller_params)
@@ -124,14 +116,12 @@ module Blacklight::SearchHelper
   end
 
   ##
-  # The key to use to retrieve the grouped field to display 
+  # The key to use to retrieve the grouped field to display
   def grouped_key_for_results
     blacklight_config.index.group
   end
 
-  def repository_class
-    blacklight_config.repository_class
-  end
+  delegate :repository_class, to: :blacklight_config
 
   def repository
     repository_class.new(blacklight_config)