blacklight 7.15.2 → 7.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab13b2ca3b5250f0ef85bb4f3b64f949a4c646b4f39e83ce5002bb26f40df1da
-  data.tar.gz: ceeb2e13d5dd1fa7459c6c743087043728ba680c7cf935365912198af3de736b
+  metadata.gz: 6ceacfa202c3acda3cb375ea3f76dd2e854f786aaba9e5a83a40cce15a1a77f5
+  data.tar.gz: b09a2d694145f7b8da82ecb99314632c1e521d63748ea0854a8d7dd131710633
 SHA512:
-  metadata.gz: 89889eeb5499865e09a8b9b4887fadf3784ff449b92de38a2619f29371ddce31015b39a45e5feb78a0193195751d1e7982e4b776995e49f17839979126eb4177
-  data.tar.gz: d7913a9cd2a87b01b8e657bc0cf7427fd1e7cae7d6c82a4ceb3d9e1842bfdfefdbf2689ff637593728d6176f032e3e8737405d04aac713f1ae3e0f926d51f719
+  metadata.gz: 9fd109f991c7cf33507b73fa8e40bd67c90601751abca9374da323d0e907f8117ab676406f2edba878e1aba39f2bfd477fe4892e1dd015b11a30ef9311d95d6f
+  data.tar.gz: a10adadf6affff113b5ee41dd10c469ace59eda64afb560052fb8cdd94a1188ee11b1dc7c7cafe92ff229a43504a8590c8508c407f64c6fdfadb9dfbc70a7ccd

data/VERSION

@@ -1 +1 @@
-7.15.2
+7.16.0

data/app/components/blacklight/document/action_component.html.erb

@@ -2,7 +2,7 @@
   <%= link_to label,
               url,
               id: @id,
-              class: 'nav-link',
+              class: @link_classes,
               data: {}.merge(({ blacklight_modal: "trigger" } if @action.modal != false) || {}) %>
 <% else %>
   <%= @view_context.render(partial: @action.partial || @action.name.to_s, locals: { document: @document, document_action_config: @action }.merge(@options)) %>

data/app/components/blacklight/document/action_component.rb

@@ -7,12 +7,13 @@ module Blacklight
       with_collection_parameter :action
 
       # @param [Blacklight::Document] document
-      def initialize(document:, action:, options: {}, url_opts: {}, id: nil)
+      def initialize(document:, action:, options: {}, url_opts: {}, id: nil, link_classes: 'nav-link')
         @document = document
         @action = action
         @options = options
         @url_opts = url_opts
         @id = id || @action.fetch(:id, "#{@action.name}Link")
+        @link_classes = link_classes
       end
 
       def using_default_document_action?

data/app/components/blacklight/document/actions_component.html.erb

@@ -1,6 +1,6 @@
 <%= content_tag @tag, class: @classes do %>
   <% @actions.each do |action| %>
-    <% result = capture { @view_context.render((action.component || Blacklight::Document::ActionComponent).new(action: action, document: @document, options: @options, url_opts: @url_opts)) } %>
+    <% result = capture { @view_context.render((action.component || Blacklight::Document::ActionComponent).new(action: action, document: @document, options: @options, url_opts: @url_opts, link_classes: @link_classes)) } %>
 
     <% if @wrapping_tag %>
       <%= content_tag(@wrapping_tag, class: Array(@wrapping_classes) + [action.key]) do %>

data/app/components/blacklight/document/actions_component.rb

@@ -6,7 +6,7 @@ module Blacklight
     class ActionsComponent < ::ViewComponent::Base
       # @param [Blacklight::Document] document
       # rubocop:disable Metrics/ParameterLists
-      def initialize(document: nil, actions: [], options: {}, url_opts: nil, tag: :div, classes: 'index-document-functions', wrapping_tag: nil, wrapping_classes: nil)
+      def initialize(document: nil, actions: [], options: {}, url_opts: nil, tag: :div, classes: 'index-document-functions', wrapping_tag: nil, wrapping_classes: nil, link_classes: 'nav-link')
         @document = document
         @actions = actions
         @tag = tag
@@ -15,6 +15,7 @@ module Blacklight
         @url_opts = url_opts
         @wrapping_tag = wrapping_tag
         @wrapping_classes = wrapping_classes
+        @link_classes = link_classes
       end
       # rubocop:enable Metrics/ParameterLists
 

data/app/components/blacklight/search_bar_component.rb

@@ -46,7 +46,11 @@ module Blacklight
     private
 
     def presenter
-      @presenter ||= blacklight_config.index.search_bar_presenter_class.new(controller, blacklight_config)
+      @presenter ||= presenter_class.new(controller, blacklight_config)
+    end
+
+    def presenter_class
+      blacklight_config.view_config(action_name: :index).search_bar_presenter_class
     end
 
     def blacklight_config

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

@@ -198,7 +198,7 @@ module Blacklight::Catalog
   # @example
   #   config.index.respond_to.txt = Proc.new { render plain: "A list of docs." }
   def additional_response_formats(format)
-    blacklight_config.index.respond_to.each do |key, config|
+    blacklight_config.view_config(action_name: :index).respond_to.each do |key, config|
       format.send key do
         case config
         when false

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -380,7 +380,7 @@ module Blacklight::BlacklightHelperBehavior
   def show_presenter_class(_document)
     Deprecation.warn(Blacklight::BlacklightHelperBehavior, '#show_presenter_class is deprecated; use #document_presenter_class instead')
 
-    blacklight_config.show.document_presenter_class
+    blacklight_config.view_config(:show, action_name: action_name).document_presenter_class
   end
 
   # @deprecated
@@ -388,13 +388,12 @@ module Blacklight::BlacklightHelperBehavior
   def index_presenter_class(_document)
     Deprecation.warn(Blacklight::BlacklightHelperBehavior, '#index_presenter_class is deprecated; use #document_presenter_class instead')
 
-    (blacklight_config.view.key?(document_index_view_type) && blacklight_config.dig(:view, document_index_view_type, :document_presenter_class)) ||
-      blacklight_config.index.document_presenter_class
+    blacklight_config.view_config(document_index_view_type, action_name: action_name).document_presenter_class
   end
 
   # @return [Class]
   def search_bar_presenter_class
-    blacklight_config.index.search_bar_presenter_class
+    blacklight_config.view_config(action_name: :index).search_bar_presenter_class
   end
 
   # @!group Layout helpers

data/app/helpers/blacklight/component_helper_behavior.rb

@@ -94,11 +94,11 @@ module Blacklight
     end
 
     def show_doc_actions?(document = @document, options = {})
-      filter_partials(blacklight_config.show.document_actions, { document: document }.merge(options)).any?
+      filter_partials(blacklight_config.view_config(:show).document_actions, { document: document }.merge(options)).any?
     end
 
     def document_actions(document, options: {})
-      filter_partials(blacklight_config.show.document_actions, { document: document }.merge(options)).map { |_k, v| v }
+      filter_partials(blacklight_config.view_config(:show).document_actions, { document: document }.merge(options)).map { |_k, v| v }
     end
 
     private

data/app/helpers/blacklight/configuration_helper_behavior.rb

@@ -101,9 +101,9 @@ module Blacklight::ConfigurationHelperBehavior
 
   # Return the label for a search view
   # @return [String]
-  def view_label view
+  def view_label(view)
     view_config = blacklight_config.view[view]
-    view_config.display_label(view)
+    view_config.display_label
   end
   deprecation_deprecate view_label: 'Moving to ViewConfig#display_label and Blacklight::Response::ViewTypeComponent'
 

data/app/presenters/blacklight/document_presenter.rb

@@ -72,9 +72,9 @@ 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)
 
-      if fields.empty?
-        fields += Array.wrap(configuration.show[:"#{base_name}_display_type_field"]) if base_name && configuration.show.key?(:"#{base_name}_display_type_field")
-        fields += Array.wrap(configuration.show.display_type_field)
+      if fields.empty? && show_view_config != view_config
+        fields += Array.wrap(show_view_config[:"#{base_name}_display_type_field"]) if base_name && show_view_config.key?(:"#{base_name}_display_type_field")
+        fields += Array.wrap(show_view_config.display_type_field)
       end
 
       fields += ['format'] if fields.empty? # backwards compatibility with the old default value for display_type_field
@@ -118,7 +118,11 @@ module Blacklight
     end
 
     def view_config
-      @view_config ||= configuration.view_config(:show)
+      @view_config ||= show_view_config
+    end
+
+    def show_view_config
+      configuration.view_config(:show)
     end
 
     private

data/app/services/blacklight/search_service.rb

@@ -95,7 +95,7 @@ module Blacklight
     ##
     # The key to use to retrieve the grouped field to display
     def grouped_key_for_results
-      blacklight_config.index.group
+      blacklight_config.view_config(action_name: :index).group
     end
 
     ##

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

@@ -1,5 +1,5 @@
 <% if render_show_doc_actions_method_from_blacklight? %>
-  <%= render(Blacklight::Document::ActionsComponent.new(document: nil, tag: 'ul', classes: "#{controller_name}Tools nav nav-pills", wrapping_tag: 'li', wrapping_classes: 'nav-item', actions: document_actions(document_list, options: { document: nil }), options: { document_list: @response.documents }, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h))) %>
+  <%= render(Blacklight::Document::ActionsComponent.new(document: nil, tag: 'div', classes: "#{controller_name}Tools", wrapping_tag: 'span', wrapping_classes: 'btn btn-outline-primary', link_classes: '', actions: document_actions(document_list, options: { document: nil }), options: { document_list: @response.documents }, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h))) %>
 <% else %>
   <% Deprecation.warn(self, '#render_show_doc_actions is deprecated; use ActionComponents instead') %>
   <ul class="<%= controller_name %>Tools nav nav-pills">

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

@@ -3,7 +3,7 @@
 <% @page_title = t('blacklight.search.show.title', document_title: Deprecation.silence(Blacklight::BlacklightHelperBehavior) { document_show_html_title }, application_name: application_name).html_safe %>
 <% content_for(:head) { render_link_rel_alternates } %>
 
-<%= render (blacklight_config.show.document_component || Blacklight::DocumentComponent).new(document: @document, component: :div, title_component: :h1, show: true) do |component| %>
+<%= render (blacklight_config.view_config(:show).document_component || Blacklight::DocumentComponent).new(document: @document, component: :div, title_component: :h1, show: true) do |component| %>
   <% component.with(:footer) do %>
     <% if @document.respond_to?(:export_as_openurl_ctx_kev) %>
       <!--
@@ -17,7 +17,7 @@
 
   <%# Use :body for complete backwards compatibility (overriding the component body markup),
         but if the app explicitly  opted-in to components, make the partials data available as :partials to ease migrations pain %>
-  <% component.with(blacklight_config.show.document_component.blank? && blacklight_config.view_config(:show).partials.any? ? :body : :partials) do %>
+  <% component.with(blacklight_config.view_config(:show).document_component.blank? && blacklight_config.view_config(:show).partials.any? ? :body : :partials) do %>
     <div id="doc_<%= @document.id.to_s.parameterize %>">
       <%= render_document_partials @document, blacklight_config.view_config(:show).partials, component: component %>
     </div>

data/lib/blacklight/configuration.rb

@@ -95,6 +95,12 @@ module Blacklight
             partials: [:show_header, :show],
             document_actions: NestedOpenStructWithHashAccess.new(ToolConfig)
           ),
+          action_mapping: NestedOpenStructWithHashAccess.new(
+            ViewConfig,
+            default: { top_level_config: :index },
+            show: { top_level_config: :show },
+            citation: { parent_config: :show }
+          ),
           # Configurations for specific types of index views
           view: NestedOpenStructWithHashAccess.new(ViewConfig,
                                                    list: {},
@@ -307,13 +313,35 @@ module Blacklight
     end
     alias_method :inheritable_copy, :build
 
-    # Get a view configuration for the given view type
-    # including default values from the index configuration
+    # Get a view configuration for the given view type + action. The effective
+    # view configuration is inherited from:
+    # - the configuration from blacklight_config.view with the key `view_type`
+    # - the configuration from blacklight_config.action_mapping with the key `action_name`
+    # - any parent config for the action map result above
+    # - the action_mapping default configuration
+    # - the top-level index/show view configuration
+    #
     # @param [Symbol,#to_sym] view_type
     # @return [Blacklight::Configuration::ViewConfig]
-    def view_config(view_type)
-      view_type = view_type.to_sym unless view_type.is_a? Symbol
-      index.merge(view_type == :show ? show : view.fetch(view_type, {}))
+    def view_config(view_type = nil, action_name: :index)
+      view_type &&= view_type.to_sym
+      action_name &&= action_name.to_sym
+      action_name ||= :index
+
+      if view_type == :show
+        action_name = view_type
+        view_type = nil
+      end
+
+      @view_config ||= {}
+      @view_config[[view_type, action_name]] ||= begin
+        if view_type.nil?
+          action_config(action_name)
+        else
+          base_config = action_config(action_name)
+          base_config.merge(view.fetch(view_type, {}))
+        end
+      end
     end
 
     # YARD will include inline disabling as docs, cannot do multiline inside @!macro.  AND this must be separate from doc block.
@@ -441,5 +469,22 @@ module Blacklight
         yield(object)
       end
     end
+
+    def action_config(action, default: :index)
+      action_config = action_mapping[action]
+      action_config ||= action_mapping[:default]
+
+      if action_config.parent_config && action_config.parent_config != :default
+        parent_config = action_mapping[action_config.parent_config]
+        raise "View configuration error: the parent configuration of #{action_config.key}, #{parent_config.key}, must not specific its own parent configuration" if parent_config.parent_config
+
+        action_config = action_config.reverse_merge(parent_config)
+      end
+      action_config = action_config.reverse_merge(action_mapping[:default]) if action_config != action_mapping[:default]
+
+      action_config = action_config.reverse_merge(self[action_config.top_level_config]) if action_config.top_level_config
+      action_config = action_config.reverse_merge(show) if default == :show && action_config.top_level_config != :show
+      action_config.reverse_merge(index)
+    end
   end
 end

data/lib/blacklight/configuration/view_config.rb

@@ -17,15 +17,18 @@ class Blacklight::Configuration
       super || Blacklight::SearchBarPresenter
     end
 
-    def display_label(key)
+    def display_label(deprecated_key = nil, **options)
+      Deprecation.warn('Passing the key argument to ViewConfig#display_label is deprecated') if deprecated_key.present?
+
       I18n.t(
-        :"blacklight.search.view_title.#{key}",
+        :"blacklight.search.view_title.#{deprecated_key || key}",
         default: [
-          :"blacklight.search.view.#{key}",
+          :"blacklight.search.view.#{deprecated_key || key}",
           label,
           title,
-          key.to_s.humanize
-        ]
+          (deprecated_key || key).to_s.humanize
+        ],
+        **options
       )
     end
 
@@ -38,6 +41,10 @@ class Blacklight::Configuration
       def document_presenter_class
         super || Blacklight::ShowPresenter
       end
+
+      def to_h
+        super.merge(document_presenter_class: document_presenter_class)
+      end
     end
 
     class Index < ViewConfig
@@ -52,6 +59,10 @@ class Blacklight::Configuration
       def document_presenter_class
         super || Blacklight::IndexPresenter
       end
+
+      def to_h
+        super.merge(document_presenter_class: document_presenter_class)
+      end
     end
   end
 end

data/lib/blacklight/open_struct_with_hash_access.rb

@@ -44,6 +44,10 @@ module Blacklight
       @table.merge!((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
     end
 
+    def reverse_merge(other_hash)
+      self.class.new to_h.reverse_merge((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
+    end
+
     def deep_dup
       self.class.new @table.deep_dup
     end

data/lib/blacklight/search_state.rb

@@ -115,9 +115,9 @@ module Blacklight
     # documents
     def url_for_document(doc, options = {})
       if respond_to?(:blacklight_config) &&
-          blacklight_config.show.route &&
+          blacklight_config.view_config(:show).route &&
           (!doc.respond_to?(:to_model) || doc.to_model.is_a?(SolrDocument))
-        route = blacklight_config.show.route.merge(action: :show, id: doc).merge(options)
+        route = blacklight_config.view_config(:show).route.merge(action: :show, id: doc).merge(options)
         route[:controller] = params[:controller] if route[:controller] == :current
         route
       else

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -59,6 +59,8 @@ module Blacklight::Solr
       ##
       if search_field&.query_builder.present?
         add_search_field_query_builder_params(solr_parameters)
+      elsif search_field&.clause_params.present?
+        add_search_field_with_json_query_parameters(solr_parameters)
       elsif search_field&.solr_local_parameters.present?
         add_search_field_with_local_parameters(solr_parameters)
       elsif search_state.query_param.is_a? Hash
@@ -86,6 +88,14 @@ module Blacklight::Solr
       solr_parameters[:spellcheck] = 'false'
     end
 
+    def add_search_field_with_json_query_parameters(solr_parameters)
+      bool_query = search_field.clause_params.transform_values { |v| v.merge(query: search_state.query_param) }
+
+      solr_parameters[:json] ||= { query: { bool: { must: [] } } }
+      solr_parameters[:json][:query] ||= { bool: { must: [] } }
+      solr_parameters[:json][:query][:bool][:must] << bool_query
+    end
+
     # Transform "clause" parameters into the Solr JSON Query DSL
     def add_adv_search_clauses(solr_parameters)
       return if search_state.clause_params.blank?
@@ -367,7 +377,7 @@ module Blacklight::Solr
     ##
     # The key to use to retrieve the grouped field to display
     def grouped_key_for_results
-      blacklight_config.index.group
+      blacklight_config.view_config(action_name: :index).group
     end
 
     def facet_fields_to_include_in_request

data/spec/lib/blacklight/configuration/view_config_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Blacklight::Configuration::ViewConfig do
   describe '#display_label' do
     it "looks up the label to display for the given document and field" do
       allow(I18n).to receive(:t).with(:"blacklight.search.view_title.my_view", default: [:"blacklight.search.view.my_view", label, nil, "My view"]).and_return('x')
-      expect(subject.display_label(key)).to eq 'x'
+      expect(subject.display_label).to eq 'x'
     end
   end
 end

data/spec/lib/blacklight/open_struct_with_hash_access_spec.rb

@@ -123,6 +123,18 @@ RSpec.describe Blacklight::OpenStructWithHashAccess do
     end
   end
 
+  describe '#reverse_merge' do
+    before do
+      @h = described_class.new
+      @h[:a] = 1
+      @h[:b] = 2
+    end
+
+    it 'reverse merges the object with the hash, preserving the object class' do
+      expect(@h.reverse_merge(b: 3, c: 4)).to have_attributes a: 1, b: 2, c: 4
+    end
+  end
+
   describe "#to_json" do
     subject { described_class.new a: 1, b: 2 }
 

data/spec/models/blacklight/configuration_spec.rb

@@ -557,4 +557,68 @@ RSpec.describe "Blacklight::Configuration", api: true do
       expect(config.facet_paginator_class).to eq Blacklight::Solr::FacetPaginator
     end
   end
+
+  describe '#view_config' do
+    before do
+      config.index.title_field = 'title_tsim'
+    end
+
+    context 'with a view that does not exist' do
+      it 'defaults to the index config' do
+        expect(config.view_config('this-doesnt-exist')).to have_attributes config.index.to_h
+      end
+    end
+
+    context 'with the :show view' do
+      it 'includes the show config' do
+        expect(config.view_config(:show)).to have_attributes config.show.to_h
+      end
+
+      it 'uses the show document presenter' do
+        expect(config.view_config(:show)).to have_attributes document_presenter_class: Blacklight::ShowPresenter
+      end
+
+      it 'includes index config defaults' do
+        expect(config.view_config(:show)).to have_attributes title_field: 'title_tsim'
+      end
+    end
+
+    context 'with just an action name' do
+      it 'includes the action config' do
+        expect(config.view_config(action_name: :show)).to have_attributes config.show.to_h
+      end
+
+      it 'includes the default action mapping configuration' do
+        config.action_mapping.default.whatever = :some_value
+
+        expect(config.view_config(action_name: :show)).to have_attributes whatever: :some_value
+      end
+
+      it 'includes the action-specific mappings' do
+        config.action_mapping.foo.document_presenter_class = Blacklight::DocumentPresenter
+
+        expect(config.view_config(action_name: :foo)).to have_attributes config.action_mapping.foo.to_h
+      end
+
+      it 'allows the action mapping to specific a parent configuration with some more defaults' do
+        config.action_mapping.foo.parent_config = :bar
+        config.action_mapping.bar.whatever = :bar_value
+
+        expect(config.view_config(action_name: :foo)).to have_attributes whatever: :bar_value
+      end
+
+      context 'with the :citation action' do
+        it 'also includes the show config' do
+          expect(config.view_config(action_name: :citation)).to have_attributes config.show.to_h
+        end
+      end
+    end
+
+    context 'with a view' do
+      it 'includes the configuration-level view parameters' do
+        expect(config.view_config(:atom)).to have_attributes config.index.to_h.except(:partials)
+        expect(config.view_config(:atom)).to have_attributes partials: [:document]
+      end
+    end
+  end
 end

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

@@ -321,6 +321,38 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, api: true do
       end
     end
 
+    describe "solr json query parameters from the fielded search" do
+      let(:user_params) { subject_search_params }
+
+      before do
+        blacklight_config.search_fields['subject'].solr_parameters = {
+          some: :parameter
+        }
+
+        blacklight_config.search_fields['subject'].clause_params = {
+          edismax: {
+            another: :parameter
+          }
+        }
+      end
+
+      it 'sets solr parameters from the field' do
+        expect(subject[:some]).to eq :parameter
+      end
+
+      it 'does not set a q parameter' do
+        expect(subject).not_to have_key :q
+      end
+
+      it 'includes the user query in the JSON query DSL request' do
+        expect(subject.dig(:json, :query, :bool, :must, 0, :edismax)).to include query: 'wome'
+      end
+
+      it 'includes addtional clause parameters for the field' do
+        expect(subject.dig(:json, :query, :bool, :must, 0, :edismax)).to include another: :parameter
+      end
+    end
+
     describe "overriding of qt parameter" do
       let(:user_params) do
         { qt: 'overridden' }

data/spec/views/catalog/index.atom.builder_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe "catalog/index" do
     end
   end
 
-  let(:blacklight_config) { CatalogController.blacklight_config }
+  let(:blacklight_config) { CatalogController.blacklight_config.deep_copy }
 
   before do
     @response = Blacklight::Solr::Response.new({ response: { numFound: 30 } }, start: 10, rows: 10)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.15.2
+  version: 7.16.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -14,10 +14,10 @@ authors:
 - Dan Funk
 - Naomi Dushay
 - Justin Coyne
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -881,7 +881,7 @@ homepage: http://projectblacklight.org/
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -896,8 +896,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
   index.