blacklight 6.0.2 → 6.1.0

data/.travis.yml

@@ -17,7 +17,7 @@ matrix:
     - rvm: 2.2.4
       env: "RAILS_VERSION=4.2.5"
     - rvm: 2.3.0
-      env: "RAILS_VERSION=5.0.0.beta2"
+      env: "RAILS_VERSION=5.0.0.beta3"
     - rvm: jruby-9.0.4.0
       env: "RAILS_VERSION=4.2.5 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
   allow_failures:

data/VERSION

@@ -1 +1 @@
-6.0.2
+6.1.0

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

@@ -34,7 +34,7 @@ module Blacklight::Bookmarks
   # Blacklight uses #search_action_url to figure out the right URL for
   # the global search box
   def search_action_url *args
-    search_catalog_url *args
+    search_catalog_url(*args)
   end
 
   def index
@@ -70,11 +70,11 @@ module Blacklight::Bookmarks
   # bookmark[title] and bookmark[document_id], but in that case #update
   # is simpler.
   def create
-    if params[:bookmarks]
-      @bookmarks = params[:bookmarks]
-    else
-      @bookmarks = [{ document_id: params[:id], document_type: blacklight_config.document_model.to_s }]
-    end
+    @bookmarks = if params[:bookmarks]
+                   params[:bookmarks]
+                 else
+                   [{ document_id: params[:id], document_type: blacklight_config.document_model.to_s }]
+                 end
 
     current_or_guest_user.save! unless current_or_guest_user.persisted?
 
@@ -85,9 +85,9 @@ module Blacklight::Bookmarks
     if request.xhr?
       success ? render(json: { bookmarks: { count: current_or_guest_user.bookmarks.count }}) : render(:text => "", :status => "500")
     else
-      if @bookmarks.length > 0 && success
+      if @bookmarks.any? && success
         flash[:notice] = I18n.t('blacklight.bookmarks.add.success', :count => @bookmarks.length)
-      elsif @bookmarks.length > 0
+      elsif @bookmarks.any?
         flash[:error] = I18n.t('blacklight.bookmarks.add.failure', :count => @bookmarks.length)
       end
 

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

@@ -58,7 +58,7 @@ module Blacklight::Catalog
       search_session['id'] = params[:search_id]
       search_session['per_page'] = params[:per_page]
 
-      if params[:redirect] and (params[:redirect].starts_with?('/') or params[:redirect] =~ URI::regexp)
+      if params[:redirect] and (params[:redirect].starts_with?('/') or params[:redirect] =~ URI.regexp)
         path = URI.parse(params[:redirect]).path
         redirect_to path, status: 303
       else
@@ -141,11 +141,11 @@ module Blacklight::Catalog
         format.send key do
           case config
           when false
-            raise ActionController::RoutingError.new('Not Found')
+            raise ActionController::RoutingError, 'Not Found'
           when Hash
             render config
           when Proc
-            instance_exec &config
+            instance_exec(&config)
           when Symbol, String
             send config
           else
@@ -173,7 +173,7 @@ module Blacklight::Catalog
         if @response.export_formats.include? format_name
           render_document_export_format format_name
         else
-          raise ActionController::UnknownFormat.new
+          raise ActionController::UnknownFormat
         end
       end
     end
@@ -192,7 +192,7 @@ 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 "Options was not a hash (#{options.class}" unless options.is_a? Hash
+      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'))

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

@@ -81,7 +81,7 @@ module Blacklight::Controller
         args.first[:only_path] = true
       end
 
-      search_action_url *args
+      search_action_url(*args)
     end
 
     def search_facet_url options = {}
@@ -104,11 +104,11 @@ module Blacklight::Controller
     def current_or_guest_user
       if defined? super
         super
-      else
-        current_user if has_user_authentication_provider?
+      elsif has_user_authentication_provider?
+        current_user
       end
     end
-    alias_method :blacklight_current_or_guest_user, :current_or_guest_user
+    alias blacklight_current_or_guest_user current_or_guest_user
 
     ##
     # We discard flash messages generated by the xhr requests to avoid
@@ -125,7 +125,7 @@ module Blacklight::Controller
     end           
 
     def require_user_authentication_provider
-      raise ActionController::RoutingError.new('Not Found') unless has_user_authentication_provider?
+      raise ActionController::RoutingError, 'Not Found' unless has_user_authentication_provider?
     end
 
     ##

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

@@ -32,11 +32,13 @@ module Blacklight
     # Only dereferences the user rather than removing the item in case it
     # is in the session[:history]
     def forget
-      if search = current_user.searches.find(params[:id])
+      search = current_user.searches.find(params[:id])
+
+      if search.present?
         search.user_id = nil
         search.save
 
-        flash[:notice] =I18n.t('blacklight.saved_searches.remove.success')
+        flash[:notice] = I18n.t('blacklight.saved_searches.remove.success')
       else
         flash[:error] = I18n.t('blacklight.saved_searches.remove.failure')
       end

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

@@ -21,6 +21,9 @@ module Blacklight::SearchContext
   # sets up the session[:search] hash if it doesn't already exist
   def search_session
     session[:search] ||= {}
+    # Need to call the getter again. The value is mutated
+    # https://github.com/rails/rails/issues/23884
+    session[:search]
   end
 
   # The current search session

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

@@ -29,7 +29,7 @@ module Blacklight::TokenBasedUser
     user_id, timestamp = message_encryptor.decrypt_and_verify(encrypted_user_id)
 
     if timestamp < 1.hour.ago
-      raise Blacklight::Exceptions::ExpiredSessionToken.new
+      raise Blacklight::Exceptions::ExpiredSessionToken
     end
 
     user_id

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -111,7 +111,7 @@ module Blacklight::BlacklightHelperBehavior
   # @param [Blacklight::Solr::Response] response
   # @return [Boolean]
   def should_show_spellcheck_suggestions? response
-    response.total <= spell_check_max and response.spelling.words.size > 0
+    response.total <= spell_check_max and response.spelling.words.any?
   end
 
   ##
@@ -256,7 +256,7 @@ module Blacklight::BlacklightHelperBehavior
     options = args.extract_options!
     document = args.first
     tag = options.fetch(:tag, :h4)
-    document = document || @document
+    document ||= @document
 
     content_tag(tag, presenter(document).document_heading, itemprop: "name")
   end
@@ -307,7 +307,7 @@ module Blacklight::BlacklightHelperBehavior
   def with_format(format, &block)
     old_formats = formats
     self.formats = [format]
-    block.call
+    yield
     self.formats = old_formats
     nil
   end

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -45,9 +45,18 @@ module Blacklight::CatalogHelperBehavior
     end
       
     case collection.total_count
-      when 0; t('blacklight.search.pagination_info.no_items_found', :entry_name => entry_name ).html_safe
-      when 1; t('blacklight.search.pagination_info.single_item_found', :entry_name => entry_name).html_safe
-      else; t('blacklight.search.pagination_info.pages', :entry_name => entry_name, :current_page => collection.current_page, :num_pages => collection.total_pages, :start_num => number_with_delimiter(collection.offset_value + 1) , :end_num => number_with_delimiter(end_num), :total_num => number_with_delimiter(collection.total_count), :count => collection.total_pages).html_safe
+      when 0
+        t('blacklight.search.pagination_info.no_items_found', :entry_name => entry_name ).html_safe
+      when 1
+        t('blacklight.search.pagination_info.single_item_found', :entry_name => entry_name).html_safe
+      else
+        t('blacklight.search.pagination_info.pages', :entry_name => entry_name,
+                                                     :current_page => collection.current_page,
+                                                     :num_pages => collection.total_pages,
+                                                     :start_num => number_with_delimiter(collection.offset_value + 1),
+                                                     :end_num => number_with_delimiter(end_num),
+                                                     :total_num => number_with_delimiter(collection.total_count),
+                                                     :count => collection.total_pages).html_safe
     end
   end
 
@@ -72,7 +81,9 @@ module Blacklight::CatalogHelperBehavior
   # @see #page_entries_info
   # @return [String]
   def item_page_entry_info
-    t('blacklight.search.entry_pagination_info.other', :current => number_with_delimiter(search_session['counter']), :total => number_with_delimiter(search_session['total']), :count => search_session['total'].to_i).html_safe
+    t('blacklight.search.entry_pagination_info.other', :current => number_with_delimiter(search_session['counter']),
+                                                       :total => number_with_delimiter(search_session['total']),
+                                                       :count => search_session['total'].to_i).html_safe
   end
 
   ##
@@ -258,11 +269,11 @@ module Blacklight::CatalogHelperBehavior
     if params['q'].present?
       q_label = label_for_search_field(params[:search_field]) unless default_search_field && params[:search_field] == default_search_field[:key]
 
-      if q_label.present?
-        constraints += [t('blacklight.search.page_title.constraint', label: q_label, value: params['q'])]
-      else
-        constraints += [params['q']]
-      end
+      constraints += if q_label.present?
+                       [t('blacklight.search.page_title.constraint', label: q_label, value: params['q'])]
+                     else
+                       [params['q']]
+                     end
     end
 
     if params['f'].present?

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -90,7 +90,7 @@ module Blacklight::ConfigurationHelperBehavior
     defaults << field_config.label if field_config
     defaults << field.to_s.humanize
 
-    field_label *defaults
+    field_label(*defaults)
   end
 
   def view_label view

data/app/helpers/blacklight/deprecated_url_helper_behavior.rb

@@ -14,7 +14,7 @@ module Blacklight
         Deprecation.warn(Blacklight::DeprecatedUrlHelperBehavior, 'Use Blacklight::SearchState.new(source_params).params_for_search instead')
         Blacklight::SearchState.new(args.first, blacklight_config).params_for_search(args.last)
       else
-        raise ArgumentError.new "wrong number of arguments (#{args.length} for 0..2)"
+        raise ArgumentError, "wrong number of arguments (#{args.length} for 0..2)"
       end
     end
     deprecation_deprecate :params_for_search

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -38,10 +38,10 @@ module Blacklight::FacetsHelperBehavior
   # @option options [Hash] :locals locals to pass to the partial
   # @return [String] 
   def render_facet_limit(display_facet, options = {})
-    return if not should_render_facet?(display_facet)
+    return unless should_render_facet?(display_facet)
     options = options.dup
     options[:partial] ||= facet_partial_name(display_facet)
-    options[:layout] ||= "facet_layout" unless options.has_key?(:layout)
+    options[:layout] ||= "facet_layout" unless options.key?(:layout)
     options[:locals] ||= {}
     options[:locals][:field_name] ||= display_facet.name
     options[:locals][:solr_field] ||= display_facet.name # deprecated

data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb

@@ -21,7 +21,7 @@ module Blacklight::HashAsHiddenFieldsHelperBehavior
     
     hidden_fields = []
     flatten_hash(hash).each do |name, value|
-      value = [value] if !value.is_a?(Array)
+      value = Array.wrap(value)
       value.each do |v|
         hidden_fields << hidden_field_tag(name, v.to_s, :id => nil)          
       end

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -9,7 +9,7 @@ module Blacklight::RenderConstraintsHelperBehavior
 
   ##
   # Check if the query has any constraints defined (a query, facet, etc)
-  # 
+  #
   # @param [Hash] query parameters
   # @return [Boolean]
   def query_has_constraints?(localized_params = params)
@@ -29,19 +29,30 @@ module Blacklight::RenderConstraintsHelperBehavior
   ##
   # Render the query constraints
   #
-  # @param [Hash] query parameters
+  # @param [ActionController::Parameters] query parameters
   # @return [String]
   def render_constraints_query(localized_params = params)
     # So simple don't need a view template, we can just do it here.
-    scope = localized_params.delete(:route_set) || self
     return "".html_safe if localized_params[:q].blank?
 
-    options = localized_params.merge(:q=>nil, :action=>'index')
-    options.permit!
     render_constraint_element(constraint_query_label(localized_params),
           localized_params[:q],
           classes: ["query"],
-          remove: scope.url_for(options))
+          remove: remove_constraint_url(localized_params))
+  end
+
+  ##
+  # Provide a url for removing a particular constraint. This can be overriden
+  # in the case that you want parameters other than the defaults to be removed
+  # (e.g. :search_field)
+  #
+  # @param [ActionController::Parameters] localized_params query parameters
+  # @return [String]
+  def remove_constraint_url(localized_params)
+    scope = localized_params.delete(:route_set) || self
+    options = localized_params.merge(q: nil, action: 'index')
+    options.permit!
+    scope.url_for(options)
   end
 
   ##
@@ -92,7 +103,6 @@ module Blacklight::RenderConstraintsHelperBehavior
   # @option options [Array<String>] :classes an array of classes to add to container span for constraint.
   # @return [String]
   def render_constraint_element(label, value, options = {})
-    render(:partial => "catalog/constraints_element", :locals => {:label => label, :value => value, :options => options})    
+    render(:partial => "catalog/constraints_element", :locals => {:label => label, :value => value, :options => options})
   end
-
 end

data/app/helpers/blacklight/render_partials_helper.rb

@@ -87,7 +87,11 @@ module Blacklight::RenderPartialsHelper
     # first, the legacy template names for backwards compatbility
     # followed by the new, inheritable style
     # finally, a controller-specific path for non-catalog subclasses
-    @document_index_path_templates ||= ["document_%{index_view_type}", "catalog/document_%{index_view_type}", "catalog/document_list"]
+    @document_index_path_templates ||= [
+      "document_%{index_view_type}",
+      "catalog/document_%{index_view_type}",
+      "catalog/document_list"
+    ]
   end
 
 
@@ -128,7 +132,7 @@ module Blacklight::RenderPartialsHelper
     def document_partial_name(document, base_name = nil)
       view_config = blacklight_config.view_config(:show)
 
-      display_type = if base_name and view_config.has_key? :"#{base_name}_display_type_field"
+      display_type = if base_name and view_config.key? :"#{base_name}_display_type_field"
         document[view_config[:"#{base_name}_display_type_field"]]
       end
 
@@ -152,7 +156,15 @@ module Blacklight::RenderPartialsHelper
       # first, the legacy template names for backwards compatbility
       # followed by the new, inheritable style
       # finally, a controller-specific path for non-catalog subclasses
-      @partial_path_templates ||= ["%{action_name}_%{index_view_type}_%{format}", "%{action_name}_%{index_view_type}_default", "%{action_name}_%{format}", "%{action_name}_default", "catalog/%{action_name}_%{format}", "catalog/_%{action_name}_partials/%{format}", "catalog/_%{action_name}_partials/default"]
+      @partial_path_templates ||= [
+        "%{action_name}_%{index_view_type}_%{format}",
+        "%{action_name}_%{index_view_type}_default",
+        "%{action_name}_%{format}",
+        "%{action_name}_default",
+        "catalog/%{action_name}_%{format}",
+        "catalog/_%{action_name}_partials/%{format}",
+        "catalog/_%{action_name}_partials/default"
+      ]
     end
 
   private

data/app/models/concerns/blacklight/configurable.rb

@@ -23,15 +23,11 @@ module Blacklight::Configurable
     # object' that won't be automatically available to subclasses, that's why
     # we lazy load to 'inherit' how we want. 
     def blacklight_config
-      unless (defined? @blacklight_config)
-        if superclass.respond_to?(:blacklight_config)
-          @blacklight_config = superclass.blacklight_config.deep_copy
-        else
-          @blacklight_config = default_configuration
-        end
+      @blacklight_config ||= if superclass.respond_to?(:blacklight_config)
+        superclass.blacklight_config.deep_copy
+      else
+        default_configuration
       end
-      
-      return @blacklight_config
     end
     attr_writer :blacklight_config
     

data/app/models/concerns/blacklight/document.rb

@@ -86,18 +86,18 @@ module Blacklight::Document
       end
     end
   end
-  alias_method :has_field?, :has?
+  alias has_field? has?
 
   def key? k
     _source.key? k
   end
-  alias_method :has_key?, :key?
+  alias has_key? key?
 
   def fetch key, *default
     if key? key
       self[key]
     elsif default.empty? and !block_given?
-      raise KeyError.new("key not found \"#{key}\"")
+      raise KeyError, "key not found \"#{key}\""
     else
       (yield(self) if block_given?) || default.first
     end

data/app/models/concerns/blacklight/document/dublin_core.rb

@@ -26,7 +26,7 @@ module Blacklight::Document::DublinCore
              'xmlns:oai_dc' => "http://www.openarchives.org/OAI/2.0/oai_dc/",
              'xmlns:dc' => "http://purl.org/dc/elements/1.1/",
              'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
-             'xsi:schemaLocation' => %{http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd}) do
+             'xsi:schemaLocation' => %(http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd)) do
       self.to_semantic_values.select { |field, values| dublin_core_field_name? field  }.each do |field,values|
         Array.wrap(values).each do |v|
           xml.tag! "dc:#{field}", v

data/app/models/concerns/blacklight/document/extensions.rb

@@ -6,7 +6,7 @@
 # extension can be registered with your document class, along with a block
 # containing custom logic for which documents to apply the extension to.
 #
-# SolrDocument.use_extension(MyExtension) {|document| my_logic_on_document(document}
+# SolrDocument.use_extension(MyExtension) { |document| my_logic_on_document(document) }
 #
 # MyExtension will be mixed-in (using ruby 'extend') only to those documents
 # where the block results in true.

data/app/models/concerns/blacklight/user.rb

@@ -12,7 +12,7 @@ module Blacklight::User
   end
 
   def bookmarks_for_documents documents = []
-    if documents.length > 0
+    if documents.any?
       bookmarks.where(document_type: documents.first.class.base_class.to_s, document_id: documents.map(&:id))
     else
       []