blacklight 7.13.2 → 7.15.2

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/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/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_list: @response.documents }, url_opts: Blacklight::Parameters.sanitize(params.to_unsafe_h))) %>
+  <%= 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))) %>
 <% 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/_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,22 +23,23 @@ 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.1'
+  s.required_ruby_version = '>= 2.5'
 
   s.add_dependency "rails", '>= 5.1', '< 7'
   s.add_dependency "globalid"
   s.add_dependency "jbuilder", '~> 2.7'
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results
   s.add_dependency "deprecation"
-  s.add_dependency "view_component"
+  s.add_dependency "i18n", '>= 1.7.0' # added named parameters
+  s.add_dependency "ostruct", '>= 0.3.2'
+  s.add_dependency "view_component", '>= 2.23.0'
 
   s.add_development_dependency "rsolr", ">= 1.0.6", "< 3"  # Library for interacting with rSolr.
   s.add_development_dependency "rspec-rails", "~> 4.0.0.beta2"
   s.add_development_dependency "rspec-its"
   s.add_development_dependency "rspec-collection_matchers", ">= 1.0"
   s.add_development_dependency "capybara", '~> 3'
-  s.add_development_dependency 'webdrivers', '~> 3.0'
-  s.add_development_dependency "selenium-webdriver", '>= 3.13.1'
+  s.add_development_dependency 'apparition'
   s.add_development_dependency 'engine_cart', '~> 2.1'
   s.add_development_dependency "equivalent-xml"
   s.add_development_dependency "simplecov"

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/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/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
@@ -45,5 +47,20 @@ module Blacklight
     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

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