blacklight 7.14.0 → 7.16.0

data/app/presenters/blacklight/field_presenter.rb

@@ -30,7 +30,7 @@ module Blacklight
     end
 
     attr_reader :view_context, :document, :field_config, :except_operations, :options
-    delegate :key, to: :field_config
+    delegate :key, :component, to: :field_config
 
     # @return [String]
     def render

data/app/presenters/blacklight/inclusive_facet_item_presenter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class InclusiveFacetItemPresenter < Blacklight::FacetItemPresenter
+    ##
+    # Get the displayable version of a facet's value
+    #
+    # @return [String]
+    def label
+      view_context.safe_join(
+        Array(facet_item).map { |value| Blacklight::FacetGroupedItemPresenter.new(facet_item, value, facet_config, view_context, facet_field, search_state).label },
+        view_context.t('blacklight.advanced_search.or_html')
+      )
+    end
+  end
+end

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

@@ -15,10 +15,10 @@ module Blacklight
 
       def render_helper
         context.send(config.helper_method,
-                     options.merge(document: document,
-                                   field: config.field,
-                                   config: config,
-                                   value: values))
+                     **options.merge(document: document,
+                                     field: config.field,
+                                     config: config,
+                                     value: values))
       end
     end
   end

data/app/presenters/blacklight/search_bar_presenter.rb

@@ -37,5 +37,9 @@ module Blacklight
         controller.action_name == "index" &&
         !controller.has_search_parameters?
     end
+
+    def advanced_search_enabled?
+      configuration.advanced_search.enabled
+    end
   end
 end

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/_advanced_search_form.html.erb

@@ -0,0 +1,7 @@
+<%= render(Blacklight::AdvancedSearchFormComponent.new(
+      url: search_action_url,
+      classes: ['advanced', 'form-horizontal'],
+      params: search_state.params_for_search.except(:qt),
+      search_fields: Deprecation.silence(Blacklight::ConfigurationHelperBehavior) { search_fields },
+      response: @response
+    )) %>

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

@@ -0,0 +1,24 @@
+<div class='card card-default'>
+  <div class="card-body">
+    <h4 class="card-title">Search tips</h4>
+    <ul class="advanced-help">
+     <li>Select "match all" to require all fields.
+     </li>
+
+     <li>Select "match any" to find at least one field.
+     </li>
+
+     <li>Combine keywords and attributes to find specific items.
+     </li>
+
+     <li>Use quotation marks to search as a phrase.
+
+     <li>Use "+" before a term to make it required. (Otherwise results matching only some of your terms may be included).</li>
+
+     <li>Use "-" before a word or phrase to exclude.
+
+     <li>Use "OR", "AND", and "NOT" to create complex boolean logic. You can use parentheses in your complex expressions. </li>
+     <li>Truncation and wildcards are not supported - word-stemming is done automatically.</li>
+   </ul>
+  </div>
+</div>

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

@@ -1,5 +1,6 @@
 <%= render(Blacklight::SearchBarComponent.new(
       url: search_action_url,
+      advanced_search_url: search_action_url(action: 'advanced_search'),
       params: search_state.params_for_search.except(:qt),
       search_fields: Deprecation.silence(Blacklight::ConfigurationHelperBehavior) { search_fields },
       presenter: presenter,

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/app/views/catalog/_zero_results.html.erb

@@ -4,7 +4,7 @@
   <ul>
     <li><%= t 'blacklight.search.zero_results.use_fewer_keywords' %></li>
 
-    <%- if params[:q] and params[:search_field] and params[:search_field] != blacklight_config.default_search_field.try(:key) -%>
+    <%- if params[:q] and params[:search_field] and params[:search_field] != blacklight_config.default_search_field&.key -%>
       <li><%= t 'blacklight.search.zero_results.search_fields', :search_fields => search_field_label(params) %> -
       <%= link_to t('blacklight.search.zero_results.search_everything', field: blacklight_config.default_search_field.label), url_for(search_state.params_for_search(search_field: blacklight_config.default_search_field.key)) %>
       </li>

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

@@ -0,0 +1,17 @@
+<% @page_title = t('blacklight.advanced_search.page_title', application_name: application_name) %>
+
+<div class="advanced-search-form col-sm-12">
+  <h1 class="advanced page-header">
+      <%= t('blacklight.advanced_search.form.title') %>
+  </h1>
+
+  <div class="row">
+    <div class="col-md-8">
+        <%= render 'advanced_search_form' %>
+    </div>
+
+    <div class="col-md-4">
+        <%= render "advanced_search_help" %>
+    </div>
+  </div>
+</div>

data/blacklight.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = '>= 2.3'
+  s.required_ruby_version = '>= 2.5'
 
   s.add_dependency "rails", '>= 5.1', '< 7'
   s.add_dependency "globalid"

data/config/i18n-tasks.yml

@@ -18,3 +18,4 @@ search:
 
 ignore_missing:
   - 'button_label_html'
+  - 'blacklight.advanced_search.*'

data/config/locales/blacklight.en.yml

@@ -239,3 +239,20 @@ en:
     main:
       aria:
         main_container: 'Main content'
+
+    advanced_search:
+      or_html: ' OR '
+      more_options: More options
+      any_of: 'Any of:'
+      op:
+        must: all
+        should: any
+      page_title: Advanced search - %{application_name}
+      form:
+        title: Advanced search
+        search_context: Within search
+        limit_criteria_heading_html: "<strong>AND</strong> have these attributes"
+        query_criteria_heading_html: "Match %{select_menu} of the fields below"
+        sort_label: "Sort results by"
+        start_over_html: "Start over"
+        search_btn_html: 'Search'

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: {},
@@ -132,7 +138,8 @@ module Blacklight
           crawler_detector: nil,
           autocomplete_suggester: 'mySuggester',
           raw_endpoint: OpenStructWithHashAccess.new(enabled: false),
-          track_search_session: true
+          track_search_session: true,
+          advanced_search: OpenStruct.new(enabled: false)
           }
         end
         # rubocop:enable Metrics/MethodLength
@@ -306,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.
@@ -440,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/field.rb

@@ -44,7 +44,7 @@ module Blacklight
 
     def default_label
       if self.key.respond_to?(:titleize)
-        self.key.try(:titleize)
+        self.key.titleize
       else
         self.key.to_s.titleize
       end

data/lib/blacklight/configuration/sort_field.rb

@@ -6,7 +6,7 @@ module Blacklight
 
     def normalize! blacklight_config = nil
       super
-      self.field ||= label.try(:parameterize)
+      self.field ||= label&.parameterize
       self.field ||= sort
 
       self.sort ||= self.field

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

@@ -4,7 +4,9 @@ module Blacklight
   ##
   # An OpenStruct that responds to common Hash methods
   class OpenStructWithHashAccess < OpenStruct
-    delegate :keys, :each, :map, :has_key?, :key?, :include?, :empty?, :length, :delete, :delete_if, :keep_if, :clear, :reject!, :select!, :replace, :fetch, :to_json, :as_json, :any?, to: :to_h
+    delegate :keys, :each, :map, :has_key?, :key?, :include?, :empty?,
+             :length, :delete, :delete_if, :keep_if, :clear, :reject!, :select!,
+             :replace, :fetch, :to_json, :as_json, :any?, to: :to_h
 
     ##
     # Expose the internal hash
@@ -42,8 +44,27 @@ 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
+
+    if Rails.version < '6'
+      # Ported from Rails 6 to fix an incompatibility with ostruct
+      def try(method_name = nil, *args, &block)
+        if method_name.nil? && block_given?
+          if b.arity.zero?
+            instance_eval(&block)
+          else
+            yield self
+          end
+        elsif respond_to?(method_name)
+          public_send(method_name, *args, &b)
+        end
+      end
+    end
   end
 end

data/lib/blacklight/routes/searchable.rb

@@ -8,6 +8,7 @@ module Blacklight
 
       def call(mapper, _options = {})
         mapper.match '/', action: 'index', as: 'search', via: [:get, :post]
+        mapper.get '/advanced', action: 'advanced_search', as: 'advanced_search'
 
         mapper.post ":id/track", action: 'track', as: 'track'
         mapper.get ":id/raw", action: 'raw', as: 'raw', defaults: { format: 'json' }

data/lib/blacklight/search_builder.rb

@@ -28,6 +28,7 @@ module Blacklight
 
       @blacklight_params = {}
       @search_state = Blacklight::SearchState.new(@blacklight_params, @scope&.blacklight_config, @scope)
+      @additional_filters = {}
       @merged_params = {}
       @reverse_merged_params = {}
     end
@@ -47,6 +48,7 @@ module Blacklight
       params_will_change!
       @search_state = @search_state.reset(@search_state.params.merge(q: conditions))
       @blacklight_params = @search_state.params.dup
+      @additional_filters = conditions
       self
     end
 

data/lib/blacklight/search_state.rb

@@ -82,7 +82,7 @@ module Blacklight
 
     def has_constraints?
       Deprecation.silence(Blacklight::SearchState) do
-        !(query_param.blank? && filter_params.blank? && filters.blank?)
+        !(query_param.blank? && filter_params.blank? && filters.blank? && clause_params.blank?)
       end
     end
 
@@ -90,6 +90,10 @@ module Blacklight
       params[:q]
     end
 
+    def clause_params
+      params[:clause] || {}
+    end
+
     def filter_params
       params[:f] || {}
     end
@@ -111,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