blacklight 6.7.3 → 6.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b010c38e55760896be7d71da9b207fd9683fd635
-  data.tar.gz: fcafe80dfca427f26122f7a05e2e18c9825ba24b
+  metadata.gz: 7659ba5e00f78c03a1a4f10c0b3aa010290f3101
+  data.tar.gz: eff65628374ba2a260ce76c62a8e6fbcc7eea314
 SHA512:
-  metadata.gz: ccd2af1a8f740736a05dccc542e1277de04e363dc1e50a02f9d0936592837ad62ebbad88108479d92a8807c12a81c202189d1009e801cc1000247d101bab90f9
-  data.tar.gz: e29b7a34a42498627f67ee4575c0981e7d8b6e697f6b9a925d829bf84c1b8f57f7aa7b24d93895e0d196c6a7885b1b8dd12fc81b15abc04114644029a8556288
+  metadata.gz: e6fc2330aa0cd95b868358e8d4761a88a0eca3bbcc7bf3513b843983ff894f87539f289d453c55fa95122f4a0943860d8c8522969f85ea0ccd50cbeda82513cf
+  data.tar.gz: c176bbe0a6cbaf3c5eea74a13d644a113e7daf87750be9782303ab36081d15da334d23dff1ca6dc2a8e3885c58efd0dac1ddc419f73db63d3b7fbbec6a443ce2

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-10-31 11:13:16 -0700 using RuboCop version 0.45.0.
+# on 2017-03-03 12:59:32 -0800 using RuboCop version 0.47.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -8,8 +8,8 @@
 
 # Offense count: 19
 # Cop supports --auto-correct.
-# Configuration parameters: AlignWith, SupportedStyles, AutoCorrect.
-# SupportedStyles: keyword, variable, start_of_line
+# Configuration parameters: EnforcedStyleAlignWith, SupportedStylesAlignWith, AutoCorrect.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
 Lint/EndAlignment:
   Exclude:
     - 'app/controllers/concerns/blacklight/token_based_user.rb'
@@ -25,7 +25,7 @@ Lint/EndAlignment:
     - 'lib/blacklight/solr/response/facets.rb'
     - 'lib/blacklight/solr/search_builder_behavior.rb'
 
-# Offense count: 30
+# Offense count: 26
 # Cop supports --auto-correct.
 # Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
 Lint/UnusedBlockArgument:
@@ -33,7 +33,6 @@ Lint/UnusedBlockArgument:
     - 'app/controllers/concerns/blacklight/search_context.rb'
     - 'app/helpers/blacklight/configuration_helper_behavior.rb'
     - 'app/models/concerns/blacklight/document/dublin_core.rb'
-    - 'lib/blacklight/configuration.rb'
     - 'lib/blacklight/configuration/fields.rb'
     - 'lib/blacklight/engine.rb'
     - 'lib/blacklight/parameters.rb'
@@ -42,12 +41,11 @@ Lint/UnusedBlockArgument:
     - 'lib/railties/blacklight.rake'
     - 'tasks/blacklight.rake'
 
-# Offense count: 21
+# Offense count: 19
 # Cop supports --auto-correct.
 # Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
 Lint/UnusedMethodArgument:
   Exclude:
-    - 'app/controllers/concerns/blacklight/default_component_configuration.rb'
     - 'app/helpers/blacklight/blacklight_helper_behavior.rb'
     - 'app/helpers/blacklight/catalog_helper_behavior.rb'
     - 'app/helpers/blacklight/component_helper_behavior.rb'
@@ -74,24 +72,30 @@ Lint/UselessAssignment:
     - 'lib/blacklight/solr/response/spelling.rb'
     - 'lib/railties/blacklight.rake'
 
-# Offense count: 60
+# Offense count: 62
 Metrics/AbcSize:
   Max: 53
 
+# Offense count: 4
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 94
+
 # Offense count: 1
+# Configuration parameters: CountBlocks.
 Metrics/BlockNesting:
   Max: 4
 
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 193
+  Max: 186
 
 # Offense count: 20
 Metrics/CyclomaticComplexity:
   Max: 12
 
-# Offense count: 50
+# Offense count: 53
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 52
@@ -99,7 +103,7 @@ Metrics/MethodLength:
 # Offense count: 9
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 213
+  Max: 208
 
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs.
@@ -110,6 +114,25 @@ Metrics/ParameterLists:
 Metrics/PerceivedComplexity:
   Max: 14
 
+# Offense count: 2
+Rails/FilePath:
+  Exclude:
+    - 'app/controllers/concerns/blacklight/catalog.rb'
+
+# Offense count: 1
+# Configuration parameters: Blacklist.
+# Blacklist: decrement!, decrement_counter, increment!, increment_counter, toggle!, touch, update_all, update_attribute, update_column, update_columns, update_counters
+Rails/SkipsModelValidations:
+  Exclude:
+    - 'app/controllers/concerns/blacklight/saved_searches.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Security/YAMLLoad:
+  Exclude:
+    - 'lib/blacklight.rb'
+    - 'lib/railties/blacklight.rake'
+
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
@@ -132,7 +155,7 @@ Style/Alias:
     - 'lib/blacklight/solr/response.rb'
     - 'lib/blacklight/solr/response/group_response.rb'
 
-# Offense count: 7
+# Offense count: 6
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
 # SupportedStyles: with_first_parameter, with_fixed_indentation
@@ -143,7 +166,7 @@ Style/AlignParameters:
     - 'lib/blacklight/configuration.rb'
     - 'lib/generators/blacklight/solr4_generator.rb'
 
-# Offense count: 66
+# Offense count: 64
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: always, conditionals
@@ -162,7 +185,7 @@ Style/BracesAroundHashParameters:
 
 # Offense count: 13
 # Cop supports --auto-correct.
-# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep, IndentationWidth.
+# Configuration parameters: EnforcedStyle, SupportedStyles, IndentOneStep, IndentationWidth.
 # SupportedStyles: case, end
 Style/CaseIndentation:
   Exclude:
@@ -172,7 +195,7 @@ Style/CaseIndentation:
     - 'lib/blacklight/configuration/fields.rb'
     - 'lib/blacklight/search_builder.rb'
 
-# Offense count: 50
+# Offense count: 51
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: nested, compact
 Style/ClassAndModuleChildren:
@@ -180,13 +203,13 @@ Style/ClassAndModuleChildren:
 
 # Offense count: 2
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, SingleLineConditionsOnly.
+# Configuration parameters: EnforcedStyle, SupportedStyles, SingleLineConditionsOnly, IncludeTernaryExpressions.
 # SupportedStyles: assign_to_condition, assign_inside_condition
 Style/ConditionalAssignment:
   Exclude:
     - 'lib/blacklight/solr/response/spelling.rb'
 
-# Offense count: 91
+# Offense count: 104
 Style/Documentation:
   Enabled: false
 
@@ -224,10 +247,8 @@ Style/ExtraSpacing:
     - 'app/helpers/blacklight/catalog_helper_behavior.rb'
     - 'app/helpers/blacklight/configuration_helper_behavior.rb'
     - 'app/models/concerns/blacklight/document/dublin_core.rb'
-    - 'app/models/concerns/blacklight/document/export.rb'
     - 'app/models/record_mailer.rb'
     - 'config/routes.rb'
-    - 'lib/blacklight/configuration.rb'
     - 'lib/generators/blacklight/controller_generator.rb'
     - 'lib/generators/blacklight/document_generator.rb'
     - 'lib/generators/blacklight/install_generator.rb'
@@ -235,7 +256,14 @@ Style/ExtraSpacing:
     - 'lib/railties/blacklight.rake'
     - 'tasks/blacklight.rake'
 
-# Offense count: 9
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: format, sprintf, percent
+Style/FormatString:
+  Exclude:
+    - 'app/helpers/blacklight/render_partials_helper.rb'
+
+# Offense count: 10
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
@@ -246,14 +274,14 @@ Style/GuardClause:
     - 'app/helpers/blacklight/catalog_helper_behavior.rb'
     - 'lib/blacklight/solr/search_builder_behavior.rb'
 
-# Offense count: 103
+# Offense count: 111
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
 # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
 Style/HashSyntax:
   Enabled: false
 
-# Offense count: 16
+# Offense count: 15
 # Cop supports --auto-correct.
 # Configuration parameters: MaxLineLength.
 Style/IfUnlessModifier:
@@ -264,7 +292,6 @@ Style/IfUnlessModifier:
     - 'app/helpers/blacklight/catalog_helper_behavior.rb'
     - 'app/helpers/blacklight/url_helper_behavior.rb'
     - 'app/models/blacklight/facet_paginator.rb'
-    - 'lib/blacklight/configuration.rb'
     - 'lib/blacklight/configuration/fields.rb'
     - 'lib/blacklight/search_state.rb'
     - 'lib/generators/blacklight/install_generator.rb'
@@ -278,7 +305,7 @@ Style/IndentHash:
   Exclude:
     - 'lib/blacklight/configuration.rb'
 
-# Offense count: 20
+# Offense count: 23
 # Cop supports --auto-correct.
 # Configuration parameters: Width.
 Style/IndentationWidth:
@@ -297,7 +324,7 @@ Style/IndentationWidth:
     - 'lib/blacklight/solr/search_builder_behavior.rb'
     - 'lib/generators/blacklight/assets_generator.rb'
 
-# Offense count: 5
+# Offense count: 9
 # Cop supports --auto-correct.
 Style/LeadingCommentSpace:
   Exclude:
@@ -307,7 +334,7 @@ Style/LeadingCommentSpace:
     - 'lib/blacklight/configuration.rb'
     - 'lib/blacklight/solr/response/spelling.rb'
 
-# Offense count: 116
+# Offense count: 125
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: require_parentheses, require_no_parentheses, require_no_parentheses_except_multiline
@@ -337,7 +364,7 @@ Style/MultilineMethodCallIndentation:
     - 'app/controllers/concerns/blacklight/search_helper.rb'
     - 'lib/blacklight/search_builder.rb'
 
-# Offense count: 13
+# Offense count: 12
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
 # SupportedStyles: aligned, indented
@@ -378,7 +405,7 @@ Style/PredicateName:
 Style/RedundantSelf:
   Enabled: false
 
-# Offense count: 16
+# Offense count: 17
 # Cop supports --auto-correct.
 Style/SpaceAfterComma:
   Exclude:
@@ -387,7 +414,6 @@ Style/SpaceAfterComma:
     - 'app/helpers/blacklight/facets_helper_behavior.rb'
     - 'app/helpers/blacklight/render_constraints_helper_behavior.rb'
     - 'app/models/concerns/blacklight/document/dublin_core.rb'
-    - 'lib/blacklight/configuration.rb'
     - 'lib/blacklight/configuration/fields.rb'
     - 'lib/blacklight/parameters.rb'
     - 'lib/blacklight/solr/response/facets.rb'
@@ -396,14 +422,14 @@ Style/SpaceAfterComma:
 
 # Offense count: 3
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleInsidePipes, SupportedStyles.
-# SupportedStyles: space, no_space
+# Configuration parameters: EnforcedStyleInsidePipes, SupportedStylesInsidePipes.
+# SupportedStylesInsidePipes: space, no_space
 Style/SpaceAroundBlockParameters:
   Exclude:
     - 'app/controllers/concerns/blacklight/catalog.rb'
     - 'app/models/concerns/blacklight/document/extensions.rb'
 
-# Offense count: 27
+# Offense count: 26
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: space, no_space
@@ -414,7 +440,6 @@ Style/SpaceAroundEqualsInParameterDefault:
     - 'app/helpers/blacklight/component_helper_behavior.rb'
     - 'app/helpers/blacklight/configuration_helper_behavior.rb'
     - 'app/helpers/blacklight/facets_helper_behavior.rb'
-    - 'app/helpers/blacklight/render_partials_helper.rb'
     - 'app/helpers/blacklight/url_helper_behavior.rb'
     - 'app/models/concerns/blacklight/document.rb'
     - 'app/presenters/blacklight/document_presenter.rb'
@@ -422,7 +447,7 @@ Style/SpaceAroundEqualsInParameterDefault:
     - 'app/presenters/blacklight/show_presenter.rb'
     - 'lib/blacklight/search_state.rb'
 
-# Offense count: 10
+# Offense count: 11
 # Cop supports --auto-correct.
 # Configuration parameters: AllowForAlignment.
 Style/SpaceAroundOperators:
@@ -432,8 +457,6 @@ Style/SpaceAroundOperators:
     - 'app/helpers/blacklight/facets_helper_behavior.rb'
     - 'app/helpers/blacklight/search_history_constraints_helper_behavior.rb'
     - 'app/helpers/blacklight/url_helper_behavior.rb'
-    - 'app/models/concerns/blacklight/document/export.rb'
-    - 'lib/blacklight/configuration.rb'
     - 'lib/blacklight/solr/repository.rb'
     - 'lib/blacklight/solr/response/spelling.rb'
     - 'tasks/blacklight.rake'
@@ -468,8 +491,9 @@ Style/SpaceBeforeFirstArg:
 
 # Offense count: 15
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SupportedStylesForEmptyBraces, SpaceBeforeBlockParameters.
 # SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
 Style/SpaceInsideBlockBraces:
   Exclude:
     - 'app/controllers/concerns/blacklight/bookmarks.rb'
@@ -488,10 +512,11 @@ Style/SpaceInsideBrackets:
   Exclude:
     - 'lib/blacklight/configuration/fields.rb'
 
-# Offense count: 19
+# Offense count: 18
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
+# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SupportedStylesForEmptyBraces.
 # SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
 Style/SpaceInsideHashLiteralBraces:
   Exclude:
     - 'app/controllers/concerns/blacklight/bookmarks.rb'
@@ -503,14 +528,13 @@ Style/SpaceInsideHashLiteralBraces:
     - 'lib/blacklight/configuration.rb'
     - 'lib/blacklight/solr/repository.rb'
 
-# Offense count: 19
+# Offense count: 18
 # Cop supports --auto-correct.
 Style/SpaceInsideParens:
   Exclude:
     - 'app/controllers/concerns/blacklight/search_context.rb'
     - 'app/helpers/blacklight/catalog_helper_behavior.rb'
     - 'app/helpers/blacklight/facets_helper_behavior.rb'
-    - 'app/helpers/blacklight/render_constraints_helper_behavior.rb'
     - 'app/helpers/blacklight/search_history_constraints_helper_behavior.rb'
     - 'app/helpers/blacklight/url_helper_behavior.rb'
     - 'app/models/concerns/blacklight/document/dublin_core.rb'
@@ -519,8 +543,7 @@ Style/SpaceInsideParens:
     - 'lib/blacklight/search_state.rb'
     - 'lib/blacklight/solr/search_builder_behavior.rb'
 
-# Offense count: 190
+# Offense count: 199
 # Cop supports --auto-correct.
 Style/TrailingWhitespace:
   Enabled: false
-

data/.travis.yml

@@ -9,21 +9,22 @@ rvm:
 
 matrix:
   include:
-    - rvm: 2.3.1
-      env: "RAILS_VERSION=4.2.6"
-    - rvm: 2.2.5
-      env: "RAILS_VERSION=5.0.0"
-    - rvm: jruby-9.0.5.0
-      env: "RAILS_VERSION=4.2.6 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
+    - rvm: 2.3.3
+      env: "RAILS_VERSION=4.2.8"
+    - rvm: 2.2.6
+      env: "RAILS_VERSION=5.0.2"
+    - rvm: jruby-9.1.7.0
+      env: "RAILS_VERSION=5.0.2 JRUBY_OPTS=\"-J-Xms512m -J-Xmx1024m\""
   allow_failures:
-    - rvm: jruby-9.0.5.0
+    - rvm: jruby-9.1.7.0
   fast_finish: true
 
 before_install:
+  - gem update --system
   - gem install bundler
 
 env:
- - "RAILS_VERSION=5.0.0"
+ - "RAILS_VERSION=5.0.2"
 
 notifications:
   irc: "irc.freenode.org#blacklight"

data/Gemfile

@@ -36,6 +36,7 @@ else
     gem 'responders', '~> 2.0'
     gem 'sass-rails', '>= 5.0'
     gem 'coffee-rails', '~> 4.1.0'
+    gem 'json', '~> 1.8'
   when /^4.[01]/
     gem 'sass-rails', '< 5.0'
   end

data/VERSION

@@ -1 +1 @@
-6.7.3
+6.8.0

data/app/assets/stylesheets/blacklight/_header.scss

@@ -6,7 +6,15 @@
   .navbar-brand {  /* The main logo image for the Blacklight instance */
   	width: 150px;
     height: 50px;
-	  background:transparent image_url($logo_image) no-repeat top left;
+    @if $logo-image {
+      background: transparent $logo-image no-repeat top left;
+    }
+
+    @if $logo_image {
+      // deprecated
+      background: transparent image_url($logo_image) no-repeat top left;
+    }
+
 	  display: inline-block;
 	  text-indent: 100%;
 	  white-space: nowrap;

data/app/assets/stylesheets/blacklight/blacklight_defaults.scss

@@ -1,6 +1,7 @@
 /* Warning! If you want to change these, just copy them into your own theme css. But you want to remove the !default, which only will set them if not already set. */
 
-$logo_image: 'blacklight/logo.png' !default;
+$logo-image: image_url('blacklight/logo.png') !default;
+$logo_image: false !default; // deprecated
 
 /* label (field names) */
 $field_name_color: $text-muted !default;

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

@@ -68,7 +68,7 @@ module Blacklight::Catalog
     def facet
       @facet = blacklight_config.facet_fields[params[:id]]
       @response = get_facet_field_response(@facet.key, params)
-      @display_facet = @response.aggregations[@facet.key]
+      @display_facet = @response.aggregations[@facet.field]
       @pagination = facet_paginator(@facet, @display_facet)
       respond_to do |format|
         # Draw the facet selector for users who have javascript disabled:

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

@@ -26,6 +26,11 @@ module Blacklight::Controller
     helper_method :search_action_url, :search_action_path, :search_facet_url, :search_facet_path
     helper_method :search_state
 
+    # Specify which class to use for the search state. You can subclass SearchState if you
+    # want to override any of the methods (e.g. SearchState#url_for_document)
+    class_attribute :search_state_class
+    self.search_state_class = Blacklight::SearchState
+
     # This callback runs when a user first logs in
 
     define_callbacks :logging_in_user
@@ -62,7 +67,7 @@ module Blacklight::Controller
 
     # @return [Blacklight::SearchState] a memoized instance of the parameter state.
     def search_state
-      @search_state ||= Blacklight::SearchState.new(params, blacklight_config)
+      @search_state ||= search_state_class.new(params, blacklight_config)
     end
 
     # Default route to the search action (used e.g. in global partials). Override this method

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

@@ -6,12 +6,12 @@ module Blacklight
   module Facet
     delegate :facet_configuration_for_field, to: :blacklight_config
 
-    def facet_paginator(field_config, display_facet)
+    def facet_paginator(field_config, response_data)
       blacklight_config.facet_paginator_class.new(
-        display_facet.items,
-        sort: display_facet.sort,
-        offset: display_facet.offset,
-        prefix: display_facet.prefix,
+        response_data.items,
+        sort: response_data.sort,
+        offset: response_data.offset,
+        prefix: response_data.prefix,
         limit: facet_limit_for(field_config.key)
       )
     end

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

@@ -56,8 +56,8 @@ module Blacklight
       facet = blacklight_config.facet_fields[facet_field]
       return if facet.blank?
 
-      if facet.limit and @response and @response.aggregations[facet_field]
-        limit = @response.aggregations[facet_field].limit
+      if facet.limit and @response and @response.aggregations[facet.field]
+        limit = @response.aggregations[facet.field].limit
 
         if limit.nil? # we didn't get or a set a limit, so infer one.
           facet.limit if facet.limit != true

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

@@ -42,10 +42,21 @@ module Blacklight::TokenBasedUser
   end
 
   def export_secret_token
-    ActiveSupport::KeyGenerator.new(Rails.application.secrets.secret_key_base).generate_key('encrypted user session key')
+    ActiveSupport::KeyGenerator.new(Rails.application.secrets.secret_key_base).generate_key('encrypted user session key')[0..(key_len - 1)]
   end
 
   def message_encryptor
     ActiveSupport::MessageEncryptor.new(export_secret_token)
   end
+
+  private
+
+  # Ruby 2.4 requires keys of very particular lengths
+  def key_len
+    if ActiveSupport::MessageEncryptor.respond_to? :key_len
+      ActiveSupport::MessageEncryptor.key_len
+    else
+     0
+    end
+  end
 end

data/app/helpers/blacklight/deprecated_url_helper_behavior.rb

@@ -11,8 +11,8 @@ module Blacklight
       when 1
         search_state.params_for_search(args.first)
       when 2
-        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)
+        Deprecation.warn(Blacklight::DeprecatedUrlHelperBehavior, 'Use controller.search_state_class.new(source_params).params_for_search instead')
+        controller.search_state_class.new(args.first, blacklight_config).params_for_search(args.last)
       else
         raise ArgumentError, "wrong number of arguments (#{args.length} for 0..2)"
       end
@@ -25,15 +25,15 @@ module Blacklight
     deprecation_deprecate :sanitize_search_params
 
     def reset_search_params(source_params)
-      Blacklight::SearchState.new(source_params, blacklight_config).send(:reset_search_params)
+      controller.search_state_class.new(source_params, blacklight_config).send(:reset_search_params)
     end
     deprecation_deprecate :reset_search_params
 
     def add_facet_params(field, item, source_params = nil)
       if source_params
-        Deprecation.warn(Blacklight::DeprecatedUrlHelperBehavior, 'Use Blacklight::SearchState.new(source_params).add_facet_params instead')
+        Deprecation.warn(Blacklight::DeprecatedUrlHelperBehavior, 'Use controller.search_state_class.new(source_params).add_facet_params instead')
 
-        Blacklight::SearchState.new(source_params, blacklight_config).add_facet_params(field, item)
+        controller.search_state_class.new(source_params, blacklight_config).add_facet_params(field, item)
       else
         search_state.add_facet_params(field, item)
       end
@@ -42,9 +42,9 @@ module Blacklight
 
     def remove_facet_params(field, item, source_params = nil)
       if source_params
-        Deprecation.warn(Blacklight::DeprecatedUrlHelperBehavior, 'Use Blacklight::SearchState.new(source_params).remove_facet_params instead')
+        Deprecation.warn(Blacklight::DeprecatedUrlHelperBehavior, 'Use controller.search_state_class.new(source_params).remove_facet_params instead')
 
-        Blacklight::SearchState.new(source_params, blacklight_config).remove_facet_params(field, item)
+        controller.search_state_class.new(source_params, blacklight_config).remove_facet_params(field, item)
       else
         search_state.remove_facet_params(field, item)
       end

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -91,7 +91,7 @@ module Blacklight::FacetsHelperBehavior
   # @param [Blacklight::Configuration::FacetField] facet_field
   # @return [Boolean]
   def should_collapse_facet? facet_field
-    !facet_field_in_params?(facet_field.field) && facet_field.collapse
+    !facet_field_in_params?(facet_field.key) && facet_field.collapse
   end
 
   ##

data/app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -65,7 +65,7 @@ module Blacklight::RenderConstraintsHelperBehavior
   # @return [String]
   def render_constraints_filters(localized_params = params)
      return "".html_safe unless localized_params[:f]
-     path = Blacklight::SearchState.new(localized_params, blacklight_config)
+     path = controller.search_state_class.new(localized_params, blacklight_config)
      content = []
      localized_params[:f].each_pair do |facet,values|
        content << render_filter_element(facet, values, path)

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

@@ -2,6 +2,11 @@ module Blacklight
   module Rendering
     # The field rendering pipeline
     class Pipeline
+      class_attribute :operations
+
+      # The ordered list of pipeline operations
+      self.operations = [HelperMethod, LinkToFacet, Microdata, Join]
+
       def initialize(values, config, document, context, options)
         @values = values
         @config = config
@@ -25,7 +30,7 @@ module Blacklight
 
         # Ordered list of operations, Terminator must be at the end.
         def stack
-          [HelperMethod, LinkToFacet, Microdata, Join, Terminator]
+          operations + [Terminator]
         end
     end
   end

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

@@ -1,11 +1,11 @@
 <ul class="facet-values list-unstyled">
   <% paginator = facet_paginator(facet_field, display_facet) %>
-  <%= render_facet_limit_list paginator, field_name %>
+  <%= render_facet_limit_list paginator, facet_field.key %>
 
   <% 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_path(id: field_name), class: "more_facets_link" %>
+        search_facet_path(id: facet_field.key), class: "more_facets_link" %>
     </li>
   <% end %>
 </ul>

data/lib/blacklight/configuration.rb

@@ -163,18 +163,9 @@ module Blacklight
     # solr fields to use for sorting results
     define_field_access :sort_field
 
-    def initialize(*args)
-      super(*args)
-      initialize_default_values!
+    def initialize(hash = {})
+      super(self.class.default_values.deep_dup.merge(hash))
       yield(self) if block_given?
-      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|
-        self[k] ||=  v
-      end
     end
 
     def document_model
@@ -295,8 +286,7 @@ module Blacklight
       end
     end
 
-    ##
-    # Provide a 'deep copy' of Blacklight::Configuration that can be modifyed without affecting
+    # Provide a 'deep copy' of Blacklight::Configuration that can be modified without effecting
     # the original Blacklight::Configuration instance.
     #
     # Rails 4.x provides `#deep_dup`, but it aggressively `#dup`'s class names

data/lib/blacklight/search_state.rb

@@ -32,9 +32,13 @@ module Blacklight
     alias to_h to_hash
 
     def reset
-      Blacklight::SearchState.new(ActionController::Parameters.new, blacklight_config)
+      self.class.new(ActionController::Parameters.new, blacklight_config)
     end
 
+    ##
+    # Extension point for downstream applications
+    # to provide more interesting routing to
+    # documents
     def url_for_document(doc, options = {})
       if respond_to?(:blacklight_config) and
           blacklight_config.show.route and
@@ -116,7 +120,7 @@ module Blacklight
     # @yield [params] The merged parameters hash before being sanitized
     def params_for_search(params_to_merge={}, &block)
       # params hash we'll return
-      my_params = params.dup.merge(Blacklight::SearchState.new(params_to_merge, blacklight_config))
+      my_params = params.dup.merge(self.class.new(params_to_merge, blacklight_config))
 
       if block_given?
         yield my_params

data/lib/blacklight/solr/response.rb

@@ -93,7 +93,7 @@ class Blacklight::Solr::Response < ActiveSupport::HashWithIndifferentAccess
         value.each { |v| force_to_utf8(v) }
       when String
         if value.encoding != Encoding::UTF_8
-          Rails.logger.warn "Found a non utf-8 value in Blacklight::Solr::Response. \"#{value}\" Encoding is #{value.encoding}"
+          Blacklight.logger.warn "Found a non utf-8 value in Blacklight::Solr::Response. \"#{value}\" Encoding is #{value.encoding}"
           value.dup.force_encoding('UTF-8')
         else
           value

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -182,14 +182,14 @@ module Blacklight::Solr
 
       # Now override with our specific things for fetching facet values
       facet_ex = facet_config.respond_to?(:ex) ? facet_config.ex : nil
-      solr_params[:"facet.field"] = with_ex_local_param(facet_ex, facet)
+      solr_params[:"facet.field"] = with_ex_local_param(facet_ex, facet_config.field)
 
       limit = if scope.respond_to?(:facet_list_limit)
                 scope.facet_list_limit.to_s.to_i
               elsif solr_params["facet.limit"]
                 solr_params["facet.limit"].to_i
               else
-                20
+                facet_config.fetch(:more_limit, 20)
               end
 
       page = blacklight_params.fetch(request_keys[:page], 1).to_i
@@ -200,13 +200,13 @@ module Blacklight::Solr
 
       # Need to set as f.facet_field.facet.* to make sure we
       # override any field-specific default in the solr request handler.
-      solr_params[:"f.#{facet}.facet.limit"] = limit + 1
-      solr_params[:"f.#{facet}.facet.offset"] = offset
+      solr_params[:"f.#{facet_config.field}.facet.limit"] = limit + 1
+      solr_params[:"f.#{facet_config.field}.facet.offset"] = offset
       if blacklight_params[request_keys[:sort]]
-        solr_params[:"f.#{facet}.facet.sort"] = sort
+        solr_params[:"f.#{facet_config.field}.facet.sort"] = sort
       end
       if blacklight_params[request_keys[:prefix]]
-        solr_params[:"f.#{facet}.facet.prefix"] = prefix
+        solr_params[:"f.#{facet_config.field}.facet.prefix"] = prefix
       end
       solr_params[:rows] = 0
     end

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -38,10 +38,12 @@ class <%= controller_name.classify %>Controller < ApplicationController
     # solr field configuration for search results/index views
     config.index.title_field = 'title_display'
     config.index.display_type_field = 'format'
+    #config.index.thumbnail_field = 'thumbnail_path_ss'
 
     # solr field configuration for document/show views
     #config.show.title_field = 'title_display'
     #config.show.display_type_field = 'format'
+    #config.show.thumbnail_field = 'thumbnail_path_ss'
 
     # solr fields that will be treated as facets by the blacklight application
     #   The ordering of the field names is the order of the display

data/spec/controllers/blacklight/search_helper_spec.rb

@@ -392,6 +392,20 @@ describe Blacklight::SearchHelper do
         expect(subject.facet_limit_for("language_facet")).to eq 10
       end
     end
+    
+    context 'for facet fields with a key that is different from the field name' do
+      let(:blacklight_config) do
+        Blacklight::Configuration.new do |config|
+          config.add_facet_field 'some_key', field: 'x', limit: true
+        end
+      end
+
+      it 'gets the limit from the facet field in the @response' do
+        response = instance_double(Blacklight::Solr::Response, aggregations: { 'x' => double(limit: 16) })
+        subject.instance_variable_set(:@response, response)
+        expect(subject.facet_limit_for('some_key')).to eq 15
+      end
+    end
   end
 
 # TODO:  more complex queries!  phrases, offset into search results, non-latin, boosting(?)

data/spec/controllers/catalog_controller_spec.rb

@@ -523,6 +523,24 @@ describe CatalogController do
         expect(json["response"]["facets"]["items"].first["value"]).to eq 'Book'
       end
     end
+
+    context 'for a facet field with a key different from the underlying field name' do
+      before do
+        controller.blacklight_config.add_facet_field 'params_key', field: 'format'
+      end
+
+      it 'is successful' do
+        get :facet, params: { id: 'params_key' }
+
+        expect(response).to be_successful
+
+        expect(assigns[:facet]).to be_kind_of Blacklight::Configuration::FacetField
+        expect(assigns[:facet].key).to eq 'params_key'
+        expect(assigns[:facet].field).to eq 'format'
+
+        expect(assigns[:pagination].items.first['value']).to eq 'Book'
+      end
+    end
   end
 
   describe "#add_to_search_history" do

data/spec/helpers/deprecated_url_helper_behavior_spec.rb

@@ -16,6 +16,7 @@ describe Blacklight::DeprecatedUrlHelperBehavior do
     allow(helper).to receive(:search_state).and_return(search_state)
     allow(helper).to receive(:params).and_return(params)
     allow(helper).to receive(:blacklight_config).and_return(blacklight_config)
+    allow(controller).to receive(:search_state_class).and_return(Blacklight::SearchState)
   end
 
   describe '#params_for_search' do

data/spec/helpers/render_constraints_helper_spec.rb

@@ -70,6 +70,7 @@ describe RenderConstraintsHelper do
     let(:params) { ActionController::Parameters.new f: { 'type' => [''] } }
     before do
       allow(helper).to receive(:blacklight_config).and_return(config)
+      allow(controller).to receive(:search_state_class).and_return(Blacklight::SearchState)
     end
     subject { helper.render_constraints_filters(params) }
 

data/spec/models/blacklight/solr/search_builder_spec.rb

@@ -146,6 +146,21 @@ describe Blacklight::Solr::SearchBuilderBehavior do
       end
     end
 
+    context "facet parameters" do
+      let(:blacklight_config) do
+        Blacklight::Configuration.new.tap do |config|
+          config.add_facet_field key: 'param_key', field: 'solr_field', limit: 50, ex: 'other'
+
+          config.add_facet_fields_to_solr_request!
+        end
+      end
+
+      it "should use the configured solr field name in queries" do
+        expect(subject).to include 'f.solr_field.facet.limit': 51,
+                                   'facet.field': ['{!ex=other}solr_field']
+      end
+    end
+
     describe 'for an entirely empty search' do
 
       it 'should not have a q param' do
@@ -564,6 +579,7 @@ describe Blacklight::Solr::SearchBuilderBehavior do
         config.add_facet_field 'format'
         config.add_facet_field 'format_ordered', sort: :count
         config.add_facet_field 'format_limited', limit: 5
+        config.add_facet_field 'format_more_limited', limit: 5, more_limit: 50
       end
     end
 
@@ -588,6 +604,36 @@ describe Blacklight::Solr::SearchBuilderBehavior do
         expect(solr_parameters[:"f.#{facet_field}.facet.offset"]).to eq 20
       end
     end
+
+    context 'for a field with a configured more_limit' do
+      let(:facet_field) { 'format_more_limited' }
+
+      it 'uses the more_limit configuration' do
+        expect(solr_parameters[:"f.#{facet_field}.facet.limit"]).to eq 51
+      end
+    end
+
+    context 'for a field with a param key different from the field name' do
+      let(:user_params) { { page_key => 2, 'facet.sort': 'index', 'facet.prefix': 'x' } }
+      let(:facet_field) { 'param_key' }
+
+      let(:blacklight_config) do
+        Blacklight::Configuration.new.tap do |config|
+          config.add_facet_field key: 'param_key', field: 'solr_field', more_limit: 50, ex: 'other'
+
+          config.add_facet_fields_to_solr_request!
+        end
+      end
+
+      it "should use the configured solr field name in queries" do
+        expect(solr_parameters).to include 'f.solr_field.facet.limit': 51,
+                                           'f.solr_field.facet.offset': 50,
+                                           'f.solr_field.facet.sort': 'index',
+                                           'f.solr_field.facet.prefix': 'x',
+                                           'facet.field': '{!ex=other}solr_field'
+      end
+    end
+
     it 'defaults limit to 20' do
       expect(solr_parameters[:"f.#{facet_field}.facet.limit"]).to eq 21
     end

data/spec/presenters/pipeline_spec.rb

@@ -6,6 +6,7 @@ describe Blacklight::Rendering::Pipeline do
   let(:context) { double }
   let(:options) { double }
   let(:presenter) { described_class.new(values, field_config, document, context, options) }
+
   describe "render" do
     subject { presenter.render }
     let(:values) { ['a', 'b'] }
@@ -24,4 +25,12 @@ describe Blacklight::Rendering::Pipeline do
       it { is_expected.to have_selector("span[@itemprop='some-prop']", :text => "a") }
     end
   end
+
+  describe "#operations" do
+    subject { described_class.operations }
+    it { is_expected.to eq [Blacklight::Rendering::HelperMethod,
+                            Blacklight::Rendering::LinkToFacet,
+                            Blacklight::Rendering::Microdata,
+                            Blacklight::Rendering::Join] }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 6.7.3
+  version: 6.8.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails