blacklight 7.14.1 → 7.15.0

data/app/presenters/blacklight/document_presenter.rb

@@ -97,8 +97,12 @@ module Blacklight
       field_presenter(field_config, options).render
     end
 
+    def thumbnail_presenter_class
+      view_config.thumbnail_presenter || thumbnail_presenter
+    end
+
     def thumbnail
-      @thumbnail ||= thumbnail_presenter.new(document, view_context, view_config)
+      @thumbnail ||= thumbnail_presenter_class.new(document, view_context, view_config)
     end
 
     ##

data/app/presenters/blacklight/facet_field_presenter.rb

@@ -40,6 +40,10 @@ module Blacklight
       view_context.facet_field_label(key)
     end
 
+    def values
+      search_state&.filter(facet_field)&.values || []
+    end
+
     # @private
     # @deprecated
     def html_id

data/app/presenters/blacklight/facet_grouped_item_presenter.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class FacetGroupedItemPresenter < Blacklight::FacetItemPresenter
+    attr_reader :group
+
+    delegate :key, to: :facet_config
+
+    def initialize(group, facet_item, facet_config, view_context, facet_field, search_state = view_context.search_state)
+      @group = group
+      @facet_item = facet_item
+      @facet_config = facet_config
+      @view_context = view_context
+      @facet_field = facet_field
+      @search_state = search_state
+    end
+
+    ##
+    # Check if the query parameters have the given facet field with the
+    # given value.
+    def selected?
+      group.include?(facet_item)
+    end
+
+    # @private
+    def remove_href(path = search_state)
+      new_state = path.filter(facet_config).remove(group)
+      new_state = new_state.filter(facet_config).add(group - [facet_item])
+
+      view_context.search_action_path(new_state)
+    end
+
+    # @private
+    def add_href(_path_options = {})
+      if facet_config.url_method
+        return view_context.public_send(facet_config.url_method, facet_config.key, facet_item)
+      end
+
+      new_state = search_state.filter(facet_config).remove(@group)
+      new_state = new_state.filter(facet_config).add(@group + [facet_item])
+
+      view_context.search_action_path(new_state)
+    end
+  end
+end

data/app/presenters/blacklight/facet_item_presenter.rb

@@ -4,7 +4,7 @@ module Blacklight
   class FacetItemPresenter
     attr_reader :facet_item, :facet_config, :view_context, :search_state, :facet_field
 
-    delegate :hits, :items, to: :facet_item
+    delegate :key, to: :facet_config
 
     def initialize(facet_item, facet_config, view_context, facet_field, search_state = view_context.search_state)
       @facet_item = facet_item
@@ -14,12 +14,24 @@ module Blacklight
       @search_state = search_state
     end
 
+    def hits
+      return unless @facet_item.respond_to? :hits
+
+      @facet_item.hits
+    end
+
+    def items
+      return unless @facet_item.respond_to? :items
+
+      @facet_item.items
+    end
+
     ##
     # Check if the query parameters have the given facet field with the
     # given value.
     def selected?
       Deprecation.silence(Blacklight::SearchState) do
-        search_state.has_facet? facet_config, value: facet_value
+        search_state.has_facet? facet_config, value: value
       end
     end
 
@@ -34,21 +46,29 @@ module Blacklight
     def label
       return @view_context.facet_display_value(@facet_field, @facet_item) unless @view_context.method(:facet_display_value).owner == Blacklight::FacetsHelperBehavior
 
-      value = if facet_item.respond_to? :label
-                facet_item.label
-              else
-                facet_value
-              end
+      label_value = if facet_item.respond_to? :label
+                      facet_item.label
+                    else
+                      value
+                    end
 
       if facet_config.helper_method
-        view_context.public_send(facet_config.helper_method, value)
-      elsif facet_config.query && facet_config.query[value]
-        facet_config.query[value][:label]
+        view_context.public_send(facet_config.helper_method, label_value)
+      elsif facet_config.query && facet_config.query[label_value]
+        facet_config.query[label_value][:label]
       elsif facet_config.date
         localization_options = facet_config.date == true ? {} : facet_config.date
-        I18n.l(Time.zone.parse(value), **localization_options)
+        I18n.l(Time.zone.parse(label_value), **localization_options)
+      else
+        label_value
+      end
+    end
+
+    def value
+      if facet_item.respond_to? :value
+        facet_item.value
       else
-        value
+        facet_item
       end
     end
 
@@ -78,14 +98,6 @@ module Blacklight
 
     private
 
-    def facet_value
-      if facet_item.respond_to? :value
-        facet_item.value
-      else
-        facet_item
-      end
-    end
-
     def facet_field_presenter
       @facet_field_presenter ||= view_context.facet_field_presenter(facet_config, {})
     end

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/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/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/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

@@ -132,7 +132,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

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

data/lib/blacklight/search_state/filter_field.rb

@@ -36,12 +36,16 @@ module Blacklight
         end
 
         params = new_state.params
+        param = :f
         value = as_url_parameter(item)
+        param = :f_inclusive if value.is_a?(Array)
 
         # value could be a string
         params[param] = (params[param] || {}).dup
 
-        if config.single
+        if value.is_a? Array
+          params[param][key] = value
+        elsif config.single
           params[param][key] = [value]
         else
           params[param][key] = Array(params[param][key] || []).dup
@@ -60,7 +64,10 @@ module Blacklight
         end
 
         params = new_state.params
+
+        param = :f
         value = as_url_parameter(item)
+        param = :f_inclusive if value.is_a?(Array)
 
         # need to dup the facet values too,
         # if the values aren't dup'd, then the values
@@ -86,7 +93,10 @@ module Blacklight
       # @return [Array] an array of applied filters
       def values
         params = search_state.params
-        Array(params.dig(param, key)) || []
+        f = Array(params.dig(:f, key))
+        f_inclusive = [params.dig(:f_inclusive, key)] if params.dig(:f_inclusive, key).present?
+
+        f + (f_inclusive || [])
       end
       delegate :any?, to: :values
 
@@ -100,15 +110,15 @@ module Blacklight
         value = as_url_parameter(item)
         params = search_state.params
 
-        (params.dig(param, key) || []).include?(value)
+        if value.is_a?(Array)
+          (params.dig(:f_inclusive, key) || []).to_set == value.to_set
+        else
+          (params.dig(:f, key) || []).include?(value)
+        end
       end
 
       private
 
-      def param
-        :f
-      end
-
       # TODO: this code is duplicated in Blacklight::FacetsHelperBehavior
       def as_url_parameter(item)
         if item.respond_to? :value

data/lib/blacklight/solr/repository.rb

@@ -58,8 +58,17 @@ module Blacklight::Solr
     # @return [Blacklight::Solr::Response] the solr response object
     def send_and_receive(path, solr_params = {})
       benchmark("Solr fetch", level: :debug) do
-        key = blacklight_config.http_method == :post ? :data : :params
-        res = connection.send_and_receive(path, { key => solr_params.to_hash, method: blacklight_config.http_method })
+        res = if solr_params[:json].present?
+                connection.send_and_receive(
+                  path,
+                  data: { params: solr_params.to_hash.except(:json) }.merge(solr_params[:json]).to_json,
+                  method: :post,
+                  headers: { 'Content-Type' => 'application/json' }
+                )
+              else
+                key = blacklight_config.http_method == :post ? :data : :params
+                connection.send_and_receive(path, { key => solr_params.to_hash, method: blacklight_config.http_method })
+              end
 
         solr_response = blacklight_config.response_model.new(res, solr_params, document_model: blacklight_config.document_model, blacklight_config: blacklight_config)
 

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -8,7 +8,8 @@ module Blacklight::Solr
         :default_solr_parameters, :add_query_to_solr, :add_facet_fq_to_solr,
         :add_facetting_to_solr, :add_solr_fields_to_query, :add_paging_to_solr,
         :add_sorting_to_solr, :add_group_config_to_solr,
-        :add_facet_paging_to_solr
+        :add_facet_paging_to_solr, :add_adv_search_clauses,
+        :add_additional_filters
       ]
     end
 
@@ -61,12 +62,62 @@ module Blacklight::Solr
       elsif search_field&.solr_local_parameters.present?
         add_search_field_with_local_parameters(solr_parameters)
       elsif search_state.query_param.is_a? Hash
-        add_multifield_search_query(solr_parameters)
-      elsif blacklight_params[:q]
+        add_additional_filters(solr_parameters, search_state.query_param)
+      elsif search_state.query_param
         solr_parameters[:q] = search_state.query_param
       end
     end
 
+    def add_additional_filters(solr_parameters, additional_filters = nil)
+      q = additional_filters || @additional_filters
+
+      return if q.blank?
+
+      solr_parameters[:q] = if q.values.any?(&:blank?)
+                              # if any field parameters are empty, exclude _all_ results
+                              "{!lucene}NOT *:*"
+                            else
+                              "{!lucene}" + q.map do |field, values|
+                                "#{field}:(#{Array(values).map { |x| solr_param_quote(x) }.join(' OR ')})"
+                              end.join(" AND ")
+                            end
+
+      solr_parameters[:defType] = 'lucene'
+      solr_parameters[:spellcheck] = 'false'
+    end
+
+    # Transform "clause" parameters into the Solr JSON Query DSL
+    def add_adv_search_clauses(solr_parameters)
+      return if search_state.clause_params.blank?
+
+      defaults = { must: [], must_not: [], should: [] }
+      bool_query = (solr_parameters.dig(:json, :query, :bool) || {}).reverse_merge(defaults)
+
+      default_op = blacklight_params[:op]&.to_sym || :must
+
+      search_state.clause_params.each_value do |clause|
+        op, query = adv_search_clause(clause, default_op)
+        bool_query[op] << query if defaults.key?(op) && query
+      end
+
+      return if bool_query.values.all?(&:blank?)
+
+      solr_parameters[:mm] = 1 if default_op == :should
+      solr_parameters[:json] ||= { query: { bool: {} } }
+      solr_parameters[:json][:query] ||= { bool: {} }
+      solr_parameters[:json][:query][:bool] = bool_query.reject { |_k, v| v.blank? }
+    end
+
+    # @return [Array] the first element is the query operator and the second is the value to add
+    def adv_search_clause(clause, default_op)
+      op = clause[:op]&.to_sym || default_op
+      field = (blacklight_config.search_fields || {})[clause[:field]] if clause[:field]
+
+      return unless field&.clause_params && clause[:query].present?
+
+      [op, field.clause_params.transform_values { |v| v.merge(query: clause[:query]) }]
+    end
+
     ##
     # Add any existing facet limits, stored in app-level HTTP query
     # as :f, to solr as appropriate :fq query.
@@ -84,8 +135,13 @@ module Blacklight::Solr
           solr_parameters.merge!(subqueries) if subqueries
         else
           filter.values.reject(&:blank?).each do |value|
-            filter_query, subqueries = facet_value_to_fq_string(filter.config.key, value)
-            solr_parameters.append_filter_query(filter_query)
+            filter_query, subqueries = if value.is_a?(Array)
+                                         facet_inclusive_value_to_fq_string(filter.key, value.reject(&:blank?))
+                                       else
+                                         facet_value_to_fq_string(filter.config.key, value)
+                                       end
+
+            solr_parameters.append_filter_query filter_query
             solr_parameters.merge!(subqueries) if subqueries
           end
         end
@@ -250,16 +306,17 @@ module Blacklight::Solr
 
     ##
     # Convert a facet/value pair into a solr fq parameter
-    def facet_value_to_fq_string(facet_field, value)
+    def facet_value_to_fq_string(facet_field, value, use_local_params: true)
       facet_config = blacklight_config.facet_fields[facet_field]
 
       solr_field = facet_config.field if facet_config && !facet_config.query
       solr_field ||= facet_field
 
       local_params = []
-      local_params << "tag=#{facet_config.tag}" if facet_config && facet_config.tag
 
-      prefix = "{!#{local_params.join(' ')}}" unless local_params.empty?
+      if use_local_params
+        local_params << "tag=#{facet_config.tag}" if facet_config && facet_config.tag
+      end
 
       if facet_config && facet_config.query
         if facet_config.query[value]
@@ -269,12 +326,34 @@ module Blacklight::Solr
           '-*:*'
         end
       elsif value.is_a?(Range)
+        prefix = "{!#{local_params.join(' ')}}" unless local_params.empty?
         "#{prefix}#{solr_field}:[#{value.first} TO #{value.last}]"
       else
         "{!term f=#{solr_field}#{(' ' + local_params.join(' ')) unless local_params.empty?}}#{convert_to_term_value(value)}"
       end
     end
 
+    def facet_inclusive_value_to_fq_string(facet_field, values)
+      return if values.blank?
+
+      return facet_value_to_fq_string(facet_field, values.first) if values.length == 1
+
+      facet_config = blacklight_config.facet_fields[facet_field]
+
+      local_params = []
+      local_params << "tag=#{facet_config.tag}" if facet_config && facet_config.tag
+
+      solr_filters = values.each_with_object({}).with_index do |(v, h), index|
+        h["f_inclusive.#{facet_field}.#{index}"] = facet_value_to_fq_string(facet_field, v, use_local_params: false)
+      end
+
+      filter_query = solr_filters.keys.map do |k|
+        "{!query v=$#{k}}"
+      end.join(' OR ')
+
+      ["{!lucene#{(' ' + local_params.join(' ')) unless local_params.empty?}}#{filter_query}", solr_filters]
+    end
+
     def convert_to_term_value(value)
       if value.is_a?(DateTime) || value.is_a?(Time)
         value.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
@@ -322,20 +401,5 @@ module Blacklight::Solr
       # params!
       solr_parameters["spellcheck.q"] ||= search_state.query_param
     end
-
-    def add_multifield_search_query(solr_parameters)
-      q = search_state.query_param
-      solr_parameters[:q] = if q.values.any?(&:blank?)
-                              # if any field parameters are empty, exclude _all_ results
-                              "{!lucene}NOT *:*"
-                            else
-                              "{!lucene}" + q.map do |field, values|
-                                "#{field}:(#{Array(values).map { |x| solr_param_quote(x) }.join(' OR ')})"
-                              end.join(" AND ")
-                            end
-
-      solr_parameters[:defType] = 'lucene'
-      solr_parameters[:spellcheck] = 'false'
-    end
   end
 end