blacklight 7.5.1 → 7.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b85d437eb826605fb701c8c18e4263528b67f4c881a43288e46b8f46ad48881b
-  data.tar.gz: daa54afe4a032f8ab13348850decaa8340dca486f993b3b508943e00103225c4
+  metadata.gz: '087bb21bf2c345072d1fade572f09741ab819c5f44e8b563c6818530c1da6da8'
+  data.tar.gz: eebaefbf5c6ec5b3f245ef17ce59c006ac09ffefb047f336aa185cace7bd293e
 SHA512:
-  metadata.gz: caab714113f5900e604ee045cbea1c28410d4c099ef340a4bc2c97f1f36806861eea82ab5d5b85cbe4f686dc796282fe678d1886f2d090d44825797a1da759be
-  data.tar.gz: 7446370ad47268865a69220be2b5c43120781666500c9bd97dff7e368718faad227a02ac542a6441a53c99f6f9f72242cc142918431af9e1b6e480eaa5f6e943
+  metadata.gz: edce2eb3d01ea8ea635515c70db1b9e584ea96d4a360378897bc8340a94919f9ffa6f7be6824aa644c07929b3623f0f90f14280eef71b180f0d2022da8f0f677
+  data.tar.gz: ac8cc8d0432746cc80b01d330cc6bad45fc54ac4a2386a11c7c54285a1202ced0cd5b0f51f603e0281c4e33520565514ffadc8f549fa66ca0fb45533afe8c774

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-09-11 10:59:32 -0500 using RuboCop version 0.63.1.
+# on 2020-02-03 11:07:48 -0800 using RuboCop version 0.63.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
@@ -36,17 +36,16 @@ Layout/ClosingParenthesisIndentation:
   Exclude:
     - 'app/views/catalog/index.atom.builder'
 
-# Offense count: 108
+# Offense count: 109
 # Cop supports --auto-correct.
 Layout/EmptyLineAfterMagicComment:
   Enabled: false
 
-# Offense count: 8
+# Offense count: 7
 # Cop supports --auto-correct.
 # Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
 Layout/ExtraSpacing:
   Exclude:
-    - 'app/helpers/blacklight/catalog_helper_behavior.rb'
     - 'app/models/concerns/blacklight/document/dublin_core.rb'
     - 'app/models/record_mailer.rb'
     - 'app/views/catalog/index.atom.builder'
@@ -126,13 +125,6 @@ Layout/SpaceInsideParens:
     - 'app/views/catalog/_document.rss.builder'
     - 'app/views/catalog/index.atom.builder'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowInHeredoc.
-Layout/TrailingWhitespace:
-  Exclude:
-    - 'app/views/catalog/_document.rss.builder'
-
 # Offense count: 1
 Lint/AmbiguousBlockAssociation:
   Exclude:
@@ -185,7 +177,7 @@ Lint/UselessComparison:
   Exclude:
     - 'spec/models/blacklight/document/active_model_shim_spec.rb'
 
-# Offense count: 58
+# Offense count: 59
 Metrics/AbcSize:
   Max: 49
 
@@ -207,26 +199,26 @@ Metrics/ClassLength:
 
 # Offense count: 19
 Metrics/CyclomaticComplexity:
-  Max: 12
+  Max: 11
 
-# Offense count: 48
+# Offense count: 54
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
-  Max: 35
+  Max: 31
 
 # Offense count: 8
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
   Max: 212
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
   Max: 6
 
 # Offense count: 16
 Metrics/PerceivedComplexity:
-  Max: 14
+  Max: 13
 
 # Offense count: 4
 # Configuration parameters: EnforcedStyleForLeadingUnderscores.
@@ -253,12 +245,11 @@ Naming/UncommunicativeMethodParamName:
     - 'spec/features/search_context_spec.rb'
     - 'spec/features/search_results_spec.rb'
 
-# Offense count: 16
+# Offense count: 14
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: snake_case, normalcase, non_integer
 Naming/VariableNumber:
   Exclude:
-    - 'spec/views/catalog/_facets.html.erb_spec.rb'
     - 'spec/views/catalog/_index.html.erb_spec.rb'
     - 'spec/views/catalog/_show.html.erb_spec.rb'
 
@@ -290,13 +281,13 @@ RSpec/BeforeAfterAll:
     - 'spec/models/blacklight/document/sms_spec.rb'
     - 'spec/models/blacklight/solr/document_spec.rb'
 
-# Offense count: 71
+# Offense count: 77
 # Configuration parameters: Prefixes.
 # Prefixes: when, with, without
 RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 54
+# Offense count: 55
 RSpec/DescribeClass:
   Enabled: false
 
@@ -306,7 +297,7 @@ RSpec/EmptyExampleGroup:
   Exclude:
     - 'spec/models/blacklight/solr/search_builder_spec.rb'
 
-# Offense count: 127
+# Offense count: 129
 # Configuration parameters: Max.
 RSpec/ExampleLength:
   Enabled: false
@@ -330,7 +321,7 @@ RSpec/FilePath:
     - 'spec/presenters/pipeline_spec.rb'
     - 'spec/presenters/thumbnail_presenter_spec.rb'
 
-# Offense count: 196
+# Offense count: 192
 # Configuration parameters: AssignmentOnly.
 RSpec/InstanceVariable:
   Enabled: false
@@ -358,10 +349,10 @@ RSpec/LeakyConstantDeclaration:
 RSpec/MessageChain:
   Exclude:
     - 'spec/controllers/bookmarks_controller_spec.rb'
-    - 'spec/presenters/blacklight/show_presenter_spec.rb'
+    - 'spec/presenters/blacklight/field_presenter_spec.rb'
     - 'spec/views/shared/_user_util_links.html.erb_spec.rb'
 
-# Offense count: 67
+# Offense count: 61
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
@@ -377,16 +368,15 @@ RSpec/MessageSpies:
     - 'spec/lib/blacklight/configuration/facet_field_spec.rb'
     - 'spec/models/blacklight/search_builder_spec.rb'
     - 'spec/models/blacklight/suggest_search_spec.rb'
-    - 'spec/presenters/blacklight/index_presenter_spec.rb'
-    - 'spec/presenters/blacklight/show_presenter_spec.rb'
+    - 'spec/presenters/blacklight/field_presenter_spec.rb'
     - 'spec/presenters/thumbnail_presenter_spec.rb'
 
-# Offense count: 346
+# Offense count: 340
 # Configuration parameters: AggregateFailuresByDefault.
 RSpec/MultipleExpectations:
   Max: 16
 
-# Offense count: 332
+# Offense count: 337
 # Configuration parameters: IgnoreSharedExamples.
 RSpec/NamedSubject:
   Enabled: false
@@ -403,10 +393,9 @@ RSpec/RepeatedDescription:
     - 'spec/helpers/catalog_helper_spec.rb'
     - 'spec/models/blacklight/solr/search_builder_spec.rb'
 
-# Offense count: 4
+# Offense count: 2
 RSpec/RepeatedExample:
   Exclude:
-    - 'spec/features/search_filters_spec.rb'
     - 'spec/models/blacklight/solr/document_spec.rb'
 
 # Offense count: 4
@@ -423,7 +412,7 @@ RSpec/SubjectStub:
     - 'spec/models/blacklight/search_builder_spec.rb'
     - 'spec/services/blacklight/search_service_spec.rb'
 
-# Offense count: 119
+# Offense count: 120
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:
   Enabled: false
@@ -548,12 +537,12 @@ Style/GuardClause:
     - 'app/helpers/blacklight/catalog_helper_behavior.rb'
     - 'lib/blacklight/solr/search_builder_behavior.rb'
 
-# Offense count: 40
+# Offense count: 39
 # Cop supports --auto-correct.
 Style/IfUnlessModifier:
   Enabled: false
 
-# Offense count: 124
+# Offense count: 122
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: require_parentheses, require_no_parentheses, require_no_parentheses_except_multiline

data/.travis.yml

@@ -11,11 +11,11 @@ matrix:
     - rvm: 2.7.0
       env: "RAILS_VERSION=6.0.2.1"
     - rvm: 2.6.5
-      env: "RAILS_VERSION=6.0.0 ENGINE_CART_RAILS_OPTIONS=\"--skip-webpack-install\""
+      env: "RAILS_VERSION=6.0.2.1 ENGINE_CART_RAILS_OPTIONS=\"--skip-webpack-install\""
     - rvm: 2.6.5
-      env: "RAILS_VERSION=5.2.3"
+      env: "RAILS_VERSION=5.2.4.1"
     - rvm: 2.5.7
-      env: "RAILS_VERSION=5.2.3 BLACKLIGHT_API_TEST=true ENGINE_CART_RAILS_OPTIONS=\"--api --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-test\""
+      env: "RAILS_VERSION=5.2.4.1 BLACKLIGHT_API_TEST=true ENGINE_CART_RAILS_OPTIONS=\"--api --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-action-cable --skip-coffee --skip-test\""
     - rvm: 2.4.9
       env: "RAILS_VERSION=5.2.4.1"
     - rvm: jruby-9.2.8.0

data/VERSION

@@ -1 +1 @@
-7.5.1
+7.6.0

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -148,7 +148,8 @@ module Blacklight::BlacklightHelperBehavior
     document = args.first
 
     field = options[:field]
-    html_escape t(:"blacklight.search.index.#{document_index_view_type}.label", default: :'blacklight.search.index.label', label: index_field_label(document, field))
+    label = options[:label] || index_field_label(document, field)
+    html_escape t(:"blacklight.search.index.#{document_index_view_type}.label", default: :'blacklight.search.index.label', label: label)
   end
 
   ##
@@ -169,8 +170,9 @@ module Blacklight::BlacklightHelperBehavior
     document = args.first
 
     field = options[:field]
+    label = options[:label] || document_show_field_label(document, field)
 
-    t(:'blacklight.search.show.label', label: document_show_field_label(document, field))
+    t(:'blacklight.search.show.label', label: label)
   end
 
   ##

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -40,8 +40,6 @@ module Blacklight::CatalogHelperBehavior
   # @param [RSolr::Resource] collection (or other Kaminari-compatible objects)
   # @return [String]
   def page_entries_info(collection, entry_name: nil)
-    return unless show_pagination? collection
-
     entry_name = if entry_name
                    entry_name.pluralize(collection.size, I18n.locale)
                  else

data/app/presenters/blacklight/document_presenter.rb

@@ -19,10 +19,14 @@ module Blacklight
 
     # @return [Hash<String,Configuration::Field>]  all the fields for this index view that should be rendered
     def fields_to_render
-      fields.select do |_name, field_config|
-        # rubocop:disable Style/PreferredHashMethods
-        render_field?(field_config) && has_value?(field_config)
-        # rubocop:enable Style/PreferredHashMethods
+      return to_enum(:fields_to_render) unless block_given?
+
+      fields.each do |name, field_config|
+        field_presenter = field_presenter(field_config)
+
+        next unless field_presenter.render_field? && field_presenter.any?
+
+        yield name, field_config, field_presenter
       end
     end
 
@@ -32,11 +36,11 @@ module Blacklight
     #
     # @return [String]
     def heading
-      return field_values(view_config.title_field) if view_config.title_field.is_a? Blacklight::Configuration::Field
+      return field_value(view_config.title_field) if view_config.title_field.is_a? Blacklight::Configuration::Field
 
       fields = Array.wrap(view_config.title_field) + [configuration.document_model.unique_key]
-      f = fields.lazy.map { |field| field_config(field) }.detect { |field_config| retrieve_values(field_config).any? }
-      field_values(f, except_operations: [Rendering::HelperMethod])
+      f = fields.lazy.map { |field| field_config(field) }.detect { |field_config| field_presenter(field_config).any? }
+      field_value(f, except_operations: [Rendering::HelperMethod])
     end
 
     def display_type(base_name = nil, default: nil)
@@ -44,7 +48,7 @@ module Blacklight
       fields += Array.wrap(view_config[:"#{base_name}_display_type_field"]) if base_name && view_config.key?(:"#{base_name}_display_type_field")
       fields += Array.wrap(view_config.display_type_field)
 
-      display_type = fields.lazy.map { |field| retrieve_values(field_config(field)) }.detect(&:any?)
+      display_type = fields.lazy.map { |field| field_presenter(field_config(field)) }.detect(&:any?)&.values
       display_type ||= Array(default) if default
 
       display_type || []
@@ -55,11 +59,11 @@ module Blacklight
     #
     # Allow an extention point where information in the document
     # may drive the value of the field
-    # @param [Configuration::Field] field
+    # @param [Configuration::Field] field_config
     # @param [Hash] options
     # @option options [String] :value
-    def field_value field, options = {}
-      field_values(field, options)
+    def field_value field_config, options = {}
+      field_presenter(field_config, options).render
     end
 
     def thumbnail
@@ -68,41 +72,28 @@ module Blacklight
 
     private
 
-    ##
-    # Check to see if the given field should be rendered in this context
-    # @param [Blacklight::Configuration::Field] field_config
-    # @return [Boolean]
     def render_field?(field_config)
-      view_context.should_render_field?(field_config, document)
+      field_presenter(field_config).render_field?
     end
+    deprecation_deprecate render_field?: 'Use FieldPresenter#render_field?'
 
-    ##
-    # Check if a document has (or, might have, in the case of accessor methods) a value for
-    # the given solr field
-    # @param [Blacklight::Configuration::Field] field_config
-    # @return [Boolean]
     def has_value?(field_config)
-      retrieve_values(field_config).present?
+      field_presenter(field_config).any?
     end
+    deprecation_deprecate has_value?: 'Use FieldPresenter#any?'
 
-    ##
-    # Get the value for a document's field, and prepare to render it.
-    # - highlight_field
-    # - accessor
-    # - solr field
-    #
-    # Rendering:
-    #   - helper_method
-    #   - link_to_facet
-    # @param [Blacklight::Configuration::Field] field_config solr field configuration
-    # @param [Hash] options additional options to pass to the rendering helpers
     def field_values(field_config, options = {})
-      options[:values] ||= retrieve_values(field_config) unless options.key? :value
-      FieldPresenter.new(view_context, document, field_config, options).render
+      field_value(field_config, options)
     end
+    deprecation_deprecate field_values: 'Use #field_value'
 
     def retrieve_values(field_config)
-      FieldRetriever.new(document, field_config).fetch
+      field_presenter(field_config).values
+    end
+    deprecation_deprecate retrieve_values: 'Use FieldPresenter#values'
+
+    def field_presenter(field_config, options = {})
+      FieldPresenter.new(view_context, document, field_config, options)
     end
   end
 end

data/app/presenters/blacklight/field_presenter.rb

@@ -3,7 +3,7 @@
 module Blacklight
   # Renders a field and handles link_to_facet or helper_method if supplied
   class FieldPresenter
-    # @param controller [Object] the context in which to execute helper methods
+    # @param view_context [Object] the context in which to execute helper methods
     # @param document [SolrDocument] the document
     # @param field_config [Blacklight::Configuration::Field] the field's configuration
     # @param options [Hash]
@@ -11,8 +11,8 @@ module Blacklight
     # @option options [Array] :except_operations
     # @option options [Object] :value
     # @option options [Array] :steps
-    def initialize(controller, document, field_config, options = {})
-      @controller = controller
+    def initialize(view_context, document, field_config, options = {})
+      @view_context = view_context
       @document = document
       @field_config = field_config
       @options = options
@@ -28,10 +28,35 @@ module Blacklight
       @except_operations += [Rendering::HelperMethod] if options.key? :value
     end
 
-    attr_reader :controller, :document, :field_config, :values, :except_operations, :options
+    attr_reader :view_context, :document, :field_config, :except_operations, :options
 
     def render
-      Rendering::Pipeline.new(values || retrieve_values, field_config, document, controller, pipeline_steps, options).render
+      Rendering::Pipeline.new(values, field_config, document, view_context, pipeline_steps, options).render
+    end
+
+    def values
+      @values ||= retrieve_values
+    end
+
+    def label(context = 'index', **options)
+      field_config.display_label(context, count: retrieve_values.count, **options)
+    end
+
+    ##
+    # Check to see if the given field should be rendered in this context
+    # @param [Blacklight::Configuration::Field] field_config
+    # @return [Boolean]
+    def render_field?
+      view_context.should_render_field?(field_config, document)
+    end
+
+    ##
+    # Check if a document has (or, might have, in the case of accessor methods) a value for
+    # the given solr field
+    # @param [Blacklight::Configuration::Field] field_config
+    # @return [Boolean]
+    def any?
+      values.present?
     end
 
     private
@@ -40,7 +65,7 @@ module Blacklight
       (options[:steps] || Rendering::Pipeline.operations) - except_operations
     end
 
-    def retrieve_values(field_config)
+    def retrieve_values
       FieldRetriever.new(document, field_config).fetch
     end
   end

data/app/presenters/blacklight/index_presenter.rb

@@ -12,7 +12,7 @@ module Blacklight
       value = case field_or_string_or_proc
                 when Symbol
                   config = field_config(field_or_string_or_proc)
-                  retrieve_values(config)
+                  field_presenter(config).values
                 when Proc
                   Deprecation.warn(self, "calling IndexPresenter.label with a Proc is deprecated. " \
                                          "First argument must be a symbol. This will be removed in Blacklight 8")
@@ -24,7 +24,7 @@ module Blacklight
               end
 
       value = document.id if value.blank?
-      field_values(config, values: Array.wrap(value), except_operations: [Rendering::HelperMethod])
+      field_value(config, values: Array.wrap(value), except_operations: [Rendering::HelperMethod])
     end
 
     deprecation_deprecate label: 'Use #heading'