blacklight 6.0.0.pre5 → 6.0.0

data/app/controllers/search_history_controller.rb

@@ -1,20 +1,4 @@
+# frozen_string_literal: true
 class SearchHistoryController < ApplicationController
-  include Blacklight::Configurable
-
-  copy_blacklight_config_from(CatalogController)
-
-  def index
-    @searches = searches_from_history
-  end
-  
-  
-  #TODO we may want to remove unsaved (those without user_id) items from the database when removed from history
-  def clear
-    if session[:history].clear
-      flash[:notice] = I18n.t('blacklight.search_history.clear.success')
-    else
-      flash[:error] = I18n.t('blacklight.search_history.clear.failure') 
-    end
-    redirect_to :back
-  end
+  include Blacklight::SearchHistory
 end

data/app/controllers/suggest_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class SuggestController < ApplicationController
   include Blacklight::Suggest
 end

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Methods added to this helper will be available to all templates in the hosting application
 module Blacklight::BlacklightHelperBehavior
   include BlacklightUrlHelper

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -1,5 +1,14 @@
+# frozen_string_literal: true
 module Blacklight::CatalogHelperBehavior
 
+  def rss_feed_link_tag
+    auto_discovery_link_tag(:rss, feed_link_url('rss'), title: t('blacklight.search.rss_feed'))
+  end
+
+  def atom_feed_link_tag
+    auto_discovery_link_tag(:atom, feed_link_url('atom'), title: t('blacklight.search.atom_feed'))
+  end
+
   ##
   # Override the Kaminari page_entries_info helper with our own, blacklight-aware
   # implementation.
@@ -257,10 +266,15 @@ module Blacklight::CatalogHelperBehavior
     end
 
     if params['f'].present?
-      constraints += params['f'].collect{ |key, value| render_search_to_page_title_filter(key, value) } unless params['f'].blank?
+      constraints += params['f'].to_unsafe_h.collect { |key, value| render_search_to_page_title_filter(key, value) }
     end
 
     constraints.join(' / ')
   end
 
+  private
+
+    def feed_link_url(format)
+      url_for search_state.to_h.merge(format: format)
+    end
 end

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   module ComponentHelperBehavior
 

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::ConfigurationHelperBehavior
 
   ##

data/app/helpers/blacklight/deprecated_url_helper_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   module DeprecatedUrlHelperBehavior
     extend Deprecation

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::FacetsHelperBehavior
   include Blacklight::Facet
 

data/app/helpers/blacklight/hash_as_hidden_fields_helper_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Rails Helper methods to take a hash and turn it to form <input type="hidden">
 # fields, works with hash nested with other hashes and arrays, standard rails
 # serialization style.  Oddly while Hash#to_query will do this for a URL

data/app/helpers/blacklight/layout_helper_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Methods added to this helper will be available to all templates in the hosting
 # application
 module Blacklight

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # All methods in here are 'api' that may be over-ridden by plugins and local
 # code, so method signatures and semantics should not be changed casually.
 # implementations can be of course.
@@ -17,17 +18,17 @@ module Blacklight::RenderConstraintsHelperBehavior
 
   ##
   # Render the actual constraints, not including header or footer
-  # info. 
-  # 
+  # info.
+  #
   # @param [Hash] query parameters
   # @return [String]
   def render_constraints(localized_params = params)
     render_constraints_query(localized_params) + render_constraints_filters(localized_params)
   end
-  
+
   ##
   # Render the query constraints
-  # 
+  #
   # @param [Hash] query parameters
   # @return [String]
   def render_constraints_query(localized_params = params)
@@ -35,10 +36,12 @@ module Blacklight::RenderConstraintsHelperBehavior
     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(localized_params.merge(:q=>nil, :action=>'index')))
+          classes: ["query"],
+          remove: scope.url_for(options))
   end
 
   ##

data/app/helpers/blacklight/render_partials_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::RenderPartialsHelper
   ##
   # Render the document index view
@@ -102,10 +103,20 @@ module Blacklight::RenderPartialsHelper
     # @example
     #  type_field_to_partial_name(['a book-article'])
     #  => 'a_book_article'
-    def type_field_to_partial_name(document, display_type)
-      # using "_" as sep. to more closely follow the views file naming conventions
-      # parameterize uses "-" as the default sep. which throws errors
-      Array(display_type).join(" ").tr("-", "_").parameterize("_")
+    if Rails.version >= '5.0.0'
+      def type_field_to_partial_name(document, display_type)
+        # using "_" as sep. to more closely follow the views file naming conventions
+        # parameterize uses "-" as the default sep. which throws errors
+        underscore = '_'.freeze
+        Array(display_type).join(' '.freeze).tr('-'.freeze, underscore).parameterize(separator: underscore)
+      end
+    else
+      def type_field_to_partial_name(document, display_type)
+        # using "_" as sep. to more closely follow the views file naming conventions
+        # parameterize uses "-" as the default sep. which throws errors
+        underscore = '_'.freeze
+        Array(display_type).join(' '.freeze).tr('-'.freeze, underscore).parameterize(underscore)
+      end
     end
 
     ##

data/app/helpers/blacklight/search_history_constraints_helper_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # All methods in here are 'api' that may be over-ridden by plugins and local
 # code, so method signatures and semantics should not be changed casually.
 # implementations can be of course.

data/app/helpers/blacklight/suggest_helper_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   module SuggestHelperBehavior
     ##

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ##
 # URL helper methods
 module Blacklight::UrlHelperBehavior
@@ -90,10 +91,9 @@ module Blacklight::UrlHelperBehavior
 
   # create link to query (e.g. spelling suggestion)
   def link_to_query(query)
-    p = params.except(:page, :action)
-    p[:q]=query
-    link_url = search_action_path(p)
-    link_to(query, link_url)
+    p = search_state.to_h.except(:page, :action)
+    p[:q] = query
+    link_to(query, search_action_path(p))
   end
 
   ##
@@ -113,8 +113,8 @@ module Blacklight::UrlHelperBehavior
   #   link_back_to_catalog(label: 'Back to Search', route_set: my_engine)
   def link_back_to_catalog(opts={:label=>nil})
     scope = opts.delete(:route_set) || self
-    query_params = current_search_session.try(:query_params) || {}
-    
+    query_params = current_search_session.try(:query_params) || ActionController::Parameters.new
+
     if search_session['counter']
       per_page = (search_session['per_page'] || default_per_page).to_i
       counter = search_session['counter'].to_i

data/app/helpers/blacklight_configuration_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module BlacklightConfigurationHelper
   include Blacklight::ConfigurationHelperBehavior
 end

data/app/helpers/blacklight_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module BlacklightHelper
   include Blacklight::BlacklightHelperBehavior
 end

data/app/helpers/blacklight_url_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module BlacklightUrlHelper
   include Blacklight::UrlHelperBehavior
 end

data/app/helpers/catalog_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module CatalogHelper
   include Blacklight::CatalogHelperBehavior
 end

data/app/helpers/component_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ComponentHelper
   include Blacklight::ComponentHelperBehavior
 end

data/app/helpers/facets_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module FacetsHelper
   include Blacklight::FacetsHelperBehavior
 end

data/app/helpers/hash_as_hidden_fields_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module HashAsHiddenFieldsHelper
   include Blacklight::HashAsHiddenFieldsHelperBehavior
 end

data/app/helpers/layout_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module LayoutHelper
   include Blacklight::LayoutHelperBehavior
 end

data/app/helpers/render_constraints_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module RenderConstraintsHelper
   include Blacklight::RenderConstraintsHelperBehavior
 end

data/app/helpers/search_history_constraints_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SearchHistoryConstraintsHelper
   include Blacklight::SearchHistoryConstraintsHelperBehavior
 end

data/app/helpers/suggest_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SuggestHelper
   include Blacklight::SuggestHelperBehavior
 end

data/app/models/blacklight/facet_paginator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   # Pagination for facet values -- works by setting the limit to max
   # displayable. You have to ask Solr for limit+1, to get enough
@@ -28,7 +29,7 @@ module Blacklight
     # :sort => 'count' or 'index', solr tokens for facet value sorting, default 'count'. 
     def initialize(all_facet_values, arguments = {})
       # to_s.to_i will conveniently default to 0 if nil
-      @offset = arguments[:offset].to_s.to_i 
+      @offset = arguments[:offset].to_s.to_i
       @limit = arguments[:limit]
       @sort = arguments[:sort]
       @prefix = arguments[:prefix]
@@ -50,7 +51,8 @@ module Blacklight
     end
 
     def current_page
-      if limit == 0 #check for divide by zero
+      # A nil limit is unlimited, thus only one page.
+      if limit.nil? || limit == 0 #check for divide by zero
         1
       else
         @offset / limit + 1
@@ -81,6 +83,8 @@ module Blacklight
     # under facet.sort ), and your current request params.
     # Get back params suitable to passing to an ActionHelper method for
     # creating a url, to resort by that method.
+    # @param [String] sort_method
+    # @param [HashWithIndifferentAccess] params
     def params_for_resort_url(sort_method, params = {})
       # When resorting, we've got to reset the offset to start at beginning,
       # no way to make it make sense otherwise.

data/app/models/blacklight/solr/facet_paginator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::Solr
   # Pagination for facet values -- works by setting the limit to max
   # displayable. You have to ask Solr for limit+1, to get enough

data/app/models/bookmark.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Bookmark < ActiveRecord::Base
   
   belongs_to :user, polymorphic: true

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::Configurable
   extend ActiveSupport::Concern
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ##
 ##
 # = Introduction

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_model/conversion'
 
 module Blacklight::Document

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This module provides the cache key which can be used by rails
 # caching to determine when to expire a particular object's cache
 # See http://apidock.com/rails/ActiveRecord/Integration/cache_key

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'builder'
 
 # This module provide Dublin Core export based on the document's semantic values

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This module provides the body of an email export based on the document's semantic values
 module Blacklight::Document::Email
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # == Transformation conventions
 # The main use case for extensions is for transforming a Document to another
 # format. Either to another type of Ruby object, or to an exportable string in

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # = Document Extensions
 # An Blacklight::Document extension is simply a ruby module which is mixed
 # in to individual Document instances.  The intended use case is for documents

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::Document::SchemaOrg
 
   def itemtype

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::Document
   module SemanticFields
     extend ActiveSupport::Concern

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This module provides the body of an email export based on the document's semantic values
 module Blacklight::Document::Sms
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rsolr'
 ##
 ##

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::Solr::Document::MoreLikeThis
   def more_like_this
     response.more_like(self).map { |doc| self.class.new(doc, response) }

data/app/models/concerns/blacklight/suggest/response.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   module Suggest
     class Response

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::User
   # This gives us an is_blacklight_user method that can be included in
   # the containing applications models. 

data/app/models/record_mailer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Only works for documents with a #to_marc right now. 
 class RecordMailer < ActionMailer::Base
   def email_record(documents, details, url_gen_params)

data/app/models/search.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
 class Search < ActiveRecord::Base
 
-  belongs_to :user
+  belongs_to_arguments = { optional: true } if Rails.version >= '5.0.0'
+
+  belongs_to :user, belongs_to_arguments
 
   serialize :query_params