blacklight 6.0.0.pre5 → 6.0.0

data/app/models/solr_document.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class SolrDocument
 
   include Blacklight::Solr::Document

data/app/presenters/blacklight/document_presenter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class DocumentPresenter
     include ActionView::Helpers::OutputSafetyHelper
@@ -81,7 +82,7 @@ module Blacklight
     # @param [Blacklight::Solr::Configuration::Field] solr field configuration
     # @return [String]
     def render_field_value value=nil, field_config=nil
-      safe_values = Array(value).collect { |x| x.respond_to?(:force_encoding) ? x.force_encoding("UTF-8") : x }
+      safe_values = recode_values(Array(value))
 
       if field_config and field_config.itemprop
         safe_values = safe_values.map { |x| content_tag :span, x, :itemprop => field_config.itemprop }
@@ -216,5 +217,20 @@ module Blacklight
     def html_escape(*args)
       ERB::Util.html_escape(*args)
     end
+
+    private
+
+      # @param [Array<String,Fixnum>] values
+      # @return [Array] an array with all strings converted to UTF-8
+      def recode_values(values)
+        values.collect do |value|
+          if value.respond_to?(:encoding) && value.encoding != Encoding::UTF_8
+            Rails.logger.warn "Found a non utf-8 value in Blacklight::DocumentPresenter. \"#{value}\" Encoding is #{value.encoding}"
+            value.dup.force_encoding('UTF-8')
+          else
+            value
+          end
+        end
+      end
   end
 end

data/app/presenters/blacklight/json_presenter.rb

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

data/app/views/bookmarks/_tools.html.erb

@@ -1,5 +1,5 @@
 <ul class="<%= controller_name %>Tools nav nav-pills">
-  <%= render_show_doc_actions document_list, document: nil, document_list: @document_list, url_opts: Blacklight::Parameters.sanitize(params) do |config, inner| %>
+  <%= render_show_doc_actions document_list, document: nil, document_list: @document_list, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h) do |config, inner| %>
     <li>
       <%= inner %>
     </li>

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

@@ -1,9 +1,9 @@
 <nav class="alpha-filter">
-  <%= link_to t('blacklight.search.facets.clear'), @pagination.params_for_resort_url('index', params.except(@pagination.request_keys[:prefix])), data: { ajax_modal: "preserve" }, class: ['btn btn-default btn-xs', ('disabled' unless @pagination.prefix.present?)].join(' ') %>
+  <%= link_to t('blacklight.search.facets.clear'), @pagination.params_for_resort_url('index', search_state.to_h.except(@pagination.request_keys[:prefix])), data: { ajax_modal: "preserve" }, class: ['btn btn-default btn-xs', ('disabled' unless @pagination.prefix.present?)].join(' ') %>
 
   <ol class="pagination pagination-xs">
     <% @facet.index_range.each do |letter| %>
-      <li class="<%= 'active' if @pagination.prefix == letter %>"><%= link_to(letter, @pagination.params_for_resort_url('index', params.merge(@pagination.request_keys[:prefix] => letter)), data: { ajax_modal: "preserve" }) %></li>
+      <li class="<%= 'active' if @pagination.prefix == letter %>"><%= link_to(letter, @pagination.params_for_resort_url('index', search_state.to_h.merge(@pagination.request_keys[:prefix] => letter)), data: { ajax_modal: "preserve" }) %></li>
     <% end %>
   </ol>
 </nav>

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

@@ -1,9 +1,9 @@
 <div class="prev_next_links btn-group pull-left">
-  <%= link_to_previous_page @pagination, raw(t('views.pagination.previous')), params: params, param_name: blacklight_config.facet_paginator_class.request_keys[:page], class: 'btn btn-link', data: { ajax_modal: "preserve" } do %>
+  <%= link_to_previous_page @pagination, raw(t('views.pagination.previous')), params: search_state.to_h, param_name: blacklight_config.facet_paginator_class.request_keys[:page], class: 'btn btn-link', data: { ajax_modal: "preserve" } do %>
     <span class="disabled btn btn-disabled"><%= raw(t('views.pagination.previous')) %></span>
   <% end %>
 
-  <%= link_to_next_page @pagination, raw(t('views.pagination.next')), params: params, param_name: blacklight_config.facet_paginator_class.request_keys[:page], class: 'btn btn-link',  data: { ajax_modal: "preserve" } do %>
+  <%= link_to_next_page @pagination, raw(t('views.pagination.next')), params: search_state.to_h, param_name: blacklight_config.facet_paginator_class.request_keys[:page], class: 'btn btn-link',  data: { ajax_modal: "preserve" } do %>
     <span class="disabled btn  btn-disabled"><%= raw(t('views.pagination.next')) %></span>
   <% end %>
 </div>
@@ -11,9 +11,9 @@
 <div class="sort_options btn-group pull-right">
   <% if @pagination.sort == 'index' -%>
     <span class="active az btn btn-default"><%= t('blacklight.search.facets.sort.index') %></span>
-    <%= link_to_unless(@pagination.sort == 'count', t('blacklight.search.facets.sort.count'), @pagination.params_for_resort_url('count', params), class: "sort_change numeric btn btn-default", data: {ajax_modal: "preserve"}) %>
+    <%= link_to(t('blacklight.search.facets.sort.count'), @pagination.params_for_resort_url('count', search_state.to_h), class: "sort_change numeric btn btn-default", data: { ajax_modal: "preserve" }) %>
   <% elsif @pagination.sort == 'count' -%>
-    <%=  link_to(t('blacklight.search.facets.sort.index'), @pagination.params_for_resort_url('index', params), class: "sort_change az btn btn-default",  data: { ajax_modal: "preserve" }) %>
+    <%=  link_to(t('blacklight.search.facets.sort.index'), @pagination.params_for_resort_url('index', search_state.to_h), class: "sort_change az btn btn-default",  data: { ajax_modal: "preserve" }) %>
     <span class="active numeric btn btn-default"><%= t('blacklight.search.facets.sort.count') %></span>
   <% end -%>
 </div>

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

@@ -2,13 +2,11 @@
 
 <% @page_title = t('blacklight.search.page_title.title', :constraints => render_search_to_page_title(params), :application_name => application_name) %>
 
-
 <% content_for(:head) do -%>
   <%= render_opensearch_response_metadata %>
-  <%= auto_discovery_link_tag(:rss, url_for(params.merge(:format => 'rss')), :title => t('blacklight.search.rss_feed') ) %>
-  <%= auto_discovery_link_tag(:atom, url_for(params.merge(:format => 'atom')), :title => t('blacklight.search.atom_feed') ) %>
-<% end -%>
-
+  <%= rss_feed_link_tag %>
+  <%= atom_feed_link_tag %>
+<% end %>
 
 <%= render 'search_header' %>
 

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

@@ -3,7 +3,7 @@
   <span class="sr-only"><%= t('blacklight.search.view_title') %></span>
   <div class="view-type-group btn-group">
     <%  document_index_views.each do |view, config| %>
-      <%= link_to url_for(params.merge(view: view)), title: view_label(view), class: "btn btn-default view-type-#{ view.to_s.parameterize } #{"active" if document_index_view_type == view}" do %>
+      <%= link_to url_for(search_state.to_h.merge(view: view)), title: view_label(view), class: "btn btn-default view-type-#{ view.to_s.parameterize } #{"active" if document_index_view_type == view}" do %>
         <%= render_view_type_group_icon view %>
         <span class="caption"><%= view_label(view) %></span>
       <% end %>

data/app/views/catalog/index.atom.builder

@@ -9,25 +9,25 @@ xml.feed("xmlns" => "http://www.w3.org/2005/Atom",
   # an author is required, so we'll just use the app name
   xml.author { xml.name application_name }
   
-  xml.link    "rel" => "self", "href" => url_for(params.merge(:only_path => false))
-  xml.link    "rel" => "alternate", "href" => url_for(params.merge(:only_path => false, :format => "html")), "type" => "text/html"
-  xml.id      url_for(params.merge(:only_path => false, :format => "html", :content_format => nil, "type" => "text/html"))
+  xml.link    "rel" => "self", "href" => url_for(search_state.to_h.merge(only_path: false))
+  xml.link    "rel" => "alternate", "href" => url_for(search_state.to_h.merge(:only_path => false, :format => "html")), "type" => "text/html"
+  xml.id      url_for(search_state.to_h.merge(:only_path => false, :format => "html", :content_format => nil, "type" => "text/html"))
 
   # Navigational and context links
   
   xml.link( "rel" => "next", 
-            "href" => url_for(params.merge(:only_path => false, :page => @response.next_page.to_s))
+            "href" => url_for(search_state.to_h.merge(:only_path => false, :page => @response.next_page.to_s))
            ) if @response.next_page
   
   xml.link( "rel" => "previous", 
-            "href" => url_for(params.merge(:only_path => false, :page => @response.prev_page.to_s))
+            "href" => url_for(search_state.to_h.merge(:only_path => false, :page => @response.prev_page.to_s))
            ) if @response.prev_page
            
   xml.link( "rel" => "first", 
-            "href" => url_for(params.merge(:only_path => false, :page => "1")))
+            "href" => url_for(search_state.to_h.merge(:only_path => false, :page => "1")))
   
   xml.link( "rel" => "last",
-            "href" => url_for(params.merge(:only_path => false, :page => @response.total_pages.to_s)))
+            "href" => url_for(search_state.to_h.merge(:only_path => false, :page => @response.total_pages.to_s)))
   
   # "search" doesn't seem to actually be legal, but is very common, and
   # used as an example in opensearch docs

data/app/views/catalog/index.json.jbuilder

@@ -3,4 +3,3 @@ json.response do
   json.facets @presenter.search_facets_as_json
   json.pages @presenter.pagination_info
 end
-

data/app/views/catalog/index.rss.builder

@@ -1,15 +1,12 @@
 xml.instruct! :xml, :version=>"1.0"
 xml.rss(:version=>"2.0") {
-        
   xml.channel {
-          
     xml.title(t('blacklight.search.title', :application_name => application_name))
-    xml.link(search_action_url(params))
+    xml.link(search_action_url(params.to_unsafe_h))
     xml.description(t('blacklight.search.title', :application_name => application_name))
     xml.language('en-us')
     @document_list.each_with_index do |document, document_counter|
       xml << Nokogiri::XML.fragment(render_document_partials(document, blacklight_config.view_config(:rss).partials, document_counter: document_counter))
     end
-          
   }
 }

data/config/locales/blacklight.de.yml

@@ -84,8 +84,6 @@ de:
     tools:
       title: 'Werkzeuge'
       cite: 'Zitieren'
-      endnote: 'Export nach EndNote'
-      refworks: 'Export nach Refworks'
       email: 'Email'
       sms: 'SMS dieses'
       clear: 'Löschen'

data/config/locales/blacklight.es.yml

@@ -84,8 +84,6 @@ es:
     tools:
       title: 'Herramientas'
       citation: 'Cité'
-      endnote: 'Exportar a EndNote'
-      refworks: 'Exportar a Refworks'
       email: 'Correo electrónico'
       sms: 'Enviar SMS'
       clear: 'Borrar'

data/config/locales/blacklight.it.yml

@@ -84,8 +84,6 @@ it:
     tools:
       title: 'Strumenti'
       citation: 'Cita'
-      endnote: 'Esporta in EndNote'
-      refworks: 'Esporta in Refworks'
       email: 'Invia per e-mail'
       sms: 'Invia per SMS'
       clear: 'Cancella'

data/config/locales/blacklight.pt-BR.yml

@@ -83,11 +83,8 @@ pt-BR:
     tools:
       title: 'Ferramentas'
       citation: 'Citar'
-      endnote: 'Exportar para EndNote'
-      refworks: 'Exportar para Refworks'
       email: 'Email'
       sms: 'SMS'
-      librarian_view: 'Librarian View'
       clear: 'Limpar'
 
     citation:
@@ -197,9 +194,6 @@ pt-BR:
         remove:
           value: 'Remover filtro %{value}'
           label_value: 'Remover %{label}: %{value}'
-      librarian_view:
-        title: 'Librarian View'
-        leader: 'LEADER %{leader}'
       start_over: 'refazer busca'
       show:
         title: '%{document_title} - %{application_name}'

data/config/routes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 Blacklight::Engine.routes.draw do
   get "search_history",             :to => "search_history#index",   :as => "search_history"
   delete "search_history/clear",       :to => "search_history#clear",   :as => "clear_search_history"

data/db/migrate/20140202020201_create_searches.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class CreateSearches < ActiveRecord::Migration
   def self.up
     create_table :searches do |t|

data/db/migrate/20140202020202_create_bookmarks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class CreateBookmarks < ActiveRecord::Migration
   def self.up
     create_table :bookmarks do |t|

data/db/migrate/20140320000000_add_polymorphic_type_to_bookmarks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class AddPolymorphicTypeToBookmarks < ActiveRecord::Migration
   def change
     add_column(:bookmarks, :document_type, :string)

data/lib/blacklight.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'kaminari'
 require 'deprecation'
 require 'blacklight/utils'
@@ -39,7 +40,8 @@ module Blacklight
     when /::/
       connection_config[:adapter].constantize
     else
-      Blacklight.const_get("#{connection_config[:adapter]}/Repository".classify)
+      raise "The value for :adapter was not found in the blacklight.yml config" unless connection_config.key? :adapter
+      Blacklight.const_get("#{connection_config.fetch(:adapter)}/Repository".classify)
     end
   end
 

data/lib/blacklight/abstract_repository.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class AbstractRepository
     attr_accessor :blacklight_config

data/lib/blacklight/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   ##
   # Blacklight::Configuration holds the configuration for a Blacklight::Controller, including

data/lib/blacklight/configuration/context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class Configuration
     class Context

data/lib/blacklight/configuration/facet_field.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class Configuration::FacetField < Blacklight::Configuration::Field
     def normalize! blacklight_config = nil

data/lib/blacklight/configuration/field.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class Configuration::Field < OpenStructWithHashAccess
     def normalize! blacklight_config = nil

data/lib/blacklight/configuration/fields.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class Configuration
     # This mixin provides Blacklight::Configuration with generic

data/lib/blacklight/configuration/search_field.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class Configuration::SearchField < Blacklight::Configuration::Field
     def normalize! blacklight_config = nil

data/lib/blacklight/configuration/sort_field.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class Configuration::SortField < Blacklight::Configuration::Field
     def normalize! blacklight_config = nil

data/lib/blacklight/configuration/tool_config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class Configuration::ToolConfig < OpenStructWithHashAccess
   end

data/lib/blacklight/configuration/view_config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Blacklight::Configuration
   class ViewConfig < Blacklight::OpenStructWithHashAccess
     class Show < ViewConfig

data/lib/blacklight/engine.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class Engine < Rails::Engine
     engine_name "blacklight"

data/lib/blacklight/exceptions.rb

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

data/lib/blacklight/parameters.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
 module Blacklight
   module Parameters
     ##
     # Sanitize the search parameters by removing unnecessary parameters
-    # from the provided parameters
+    # from the provided parameters.
     # @param [Hash] source_params parameters
     def self.sanitize params
-      params
-        .reject { |k,v| v.nil? }
-        .except(:action, :controller, :id, :commit, :utf8)
+      params.reject { |k,v| v.nil? }
+            .except(:action, :controller, :id, :commit, :utf8)
     end
   end
 end

data/lib/blacklight/routes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   module Routes
     require 'blacklight/routes/exportable'

data/lib/blacklight/routes/exportable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   module Routes
     class Exportable

data/lib/blacklight/routes/searchable.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   module Routes
     class Searchable

data/lib/blacklight/search_builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   ##
   # Blacklight's SearchBuilder converts blacklight request parameters into

data/lib/blacklight/search_state.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   # This class encapsulates the search state as represented by the query
   # parameters namely: :f, :q, :page, :per_page and, :sort
@@ -6,13 +7,28 @@ module Blacklight
     attr_reader :blacklight_config # Must be called blacklight_config, because Blacklight::Facet calls blacklight_config.
     attr_reader :params
 
+    # @param [ActionController::Parameters] params
+    # @param [Blacklight::Config] blacklight_config
     def initialize(params, blacklight_config)
-      @params = params
+      if params.instance_of? Hash
+        # This is an ActionView::TestCase workaround. Will be resolved by
+        # https://github.com/rails/rails/pull/22913 (Rails > 4.2.5)
+        @params = params.with_indifferent_access
+      else
+        # This is the typical (not-ActionView::TestCase) code path.
+        @params = params.to_unsafe_h
+        # In Rails 5 to_unsafe_h returns a HashWithIndifferentAccess, in Rails 4 it returns Hash
+        @params = @params.with_indifferent_access if @params.instance_of? Hash
+      end
       @blacklight_config = blacklight_config
     end
 
+    def to_h
+      @params
+    end
+
     def reset
-      Blacklight::SearchState.new({}, blacklight_config)
+      Blacklight::SearchState.new(ActionController::Parameters.new, blacklight_config)
     end
 
     def url_for_document(doc, options = {})
@@ -58,7 +74,7 @@ module Blacklight
       # Delete any request params from facet-specific action, needed
       # to redir to index action properly.
       request_keys = blacklight_config.facet_paginator_class.request_keys
-      new_params.except! *request_keys.values
+      new_params.extract! *request_keys.values
 
       new_params
     end
@@ -92,7 +108,7 @@ module Blacklight
 
     # Merge the source params with the params_to_merge hash
     # @param [Hash] params_to_merge to merge into above
-    # @return the current search parameters after being sanitized by Blacklight::Parameters.sanitize
+    # @return [ActionController::Parameters] the current search parameters after being sanitized by Blacklight::Parameters.sanitize
     # @yield [params] The merged parameters hash before being sanitized
     def params_for_search(params_to_merge={}, &block)
       # params hash we'll return
@@ -114,8 +130,9 @@ module Blacklight
     ##
     # Reset any search parameters that store search context
     # and need to be reset when e.g. constraints change
+    # @return [ActionController::Parameters]
     def reset_search_params
-      ActiveSupport::HashWithIndifferentAccess.new(Parameters.sanitize(params).except(:page, :counter))
+      Parameters.sanitize(params).except(:page, :counter)
     end
 
     # TODO: this code is duplicated in Blacklight::FacetsHelperBehavior