blacklight 7.13.0 → 7.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc85c2e67bf13d0e9c856d53d545896d372495fc242fc3b69d43fdd738681af2
-  data.tar.gz: 573ca993f0519fdb53560d8c14443dc5dd6f092753ba2bcee7a933595234b957
+  metadata.gz: 8cb69c90e780b277faa807c99cf35b99d2ad0e04b68fd3c56f36a6c170eb8112
+  data.tar.gz: d5d7f85ff7af44d193e93a041a658a332a2d0ae31d9dd362f2000135e97ad54d
 SHA512:
-  metadata.gz: d08af97a62b30095f7c66ac49f829d0085ca7e2faa1c7cd96d961834031e4fab8eaf3ffb785c8e2d30c970837a27d2fdb0c03e75258ff8ff3f8e43571697948f
-  data.tar.gz: a18de70871cd90a83341a55ebf039b3fb007bd2b49dd27f0786415dc68a21115ddfbcc06a72c57e6043ed7e0a62b18f7cc0913b9e9cbb7eaec7d1d54eaa89106
+  metadata.gz: 9e8369e2769bb01b1388da32990b3a4868a14a9214ac070a6827871f5aa8a3659804cf0c11eb53b5f3d49a8f5925fafbd063be53977d1159cfa6f24954762771
+  data.tar.gz: 91046b20b9d00fc7cbe8a2f65f888e6a3e891fbf33230b203d0f4f7dc8d1a6d8317acdeec6d067f284bd47ecc51e469c0b6999a053816eec75fde5b7328b526a

data/.github/workflows/ruby.yml

@@ -0,0 +1,109 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+    - name: Install dependencies
+      run: bundle install
+    - name: Run linter
+      run: bundle exec rake rubocop
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.7, 3.0]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake ci
+      env:
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+  test_rails6_0:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+      env:
+        RAILS_VERSION: 6.0.3.4
+    - name: Run tests
+      run: bundle exec rake ci
+      env:
+        RAILS_VERSION: 6.0.3.4
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+  test_rails5_2:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.5]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+      env:
+        RAILS_VERSION: 5.2.4.2
+    - name: Run tests
+      run: bundle exec rake ci
+      env:
+        RAILS_VERSION: 5.2.4.2
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+  api_test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.7]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake ci
+      env:
+        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'
+  docker_build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build docker image
+      run: docker-compose build app

data/README.md

@@ -1,7 +1,5 @@
 # Blacklight
 
-[![Build Status](https://travis-ci.org/projectblacklight/blacklight.png?branch=master)](https://travis-ci.org/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Test Coverage](https://api.codeclimate.com/v1/badges/83fd270492c136594e59/test_coverage)](https://codeclimate.com/github/projectblacklight/blacklight/test_coverage)
-
 Blacklight is an open source Solr user interface discovery platform.
 You can use Blacklight to enable searching and browsing of your collections.
 Blacklight uses the [Apache Solr](http://lucene.apache.org/solr) search engine

data/VERSION

@@ -1 +1 @@
-7.13.0
+7.15.0

data/app/assets/javascripts/blacklight/blacklight.js

@@ -99,6 +99,7 @@ Blacklight.onLoad(function () {
 Blacklight.onLoad(function () {
   // Button clicks should change focus. As of 10/3/19, Firefox for Mac and
   // Safari both do not set focus to a button on button click.
+  // See https://zellwk.com/blog/inconsistent-button-behavior/ for background information
   document.querySelectorAll('button.collapse-toggle').forEach(button => {
     button.addEventListener('click', () => {
       event.target.focus();
@@ -349,8 +350,9 @@ Blacklight.modal.modalCloseSelector = '[data-blacklight-modal~=close]'; // Calle
 // to show to user in modal.  Right now called only for extreme
 // network errors.
 
-Blacklight.modal.onFailure = function (data) {
-  var contents = '<div class="modal-header">' + '<div class="modal-title">Network Error</div>' + '<button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="Close">' + '  <span aria-hidden="true">&times;</span>' + '</button>';
+Blacklight.modal.onFailure = function (jqXHR, textStatus, errorThrown) {
+  console.error('Server error:', this.url, jqXHR.status, errorThrown);
+  var contents = '<div class="modal-header">' + '<div class="modal-title">There was a problem with your request.</div>' + '<button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="Close">' + '  <span aria-hidden="true">&times;</span>' + '</button></div>' + ' <div class="modal-body"><p>Expected a successful response from the server, but got an error</p>' + '<pre>' + this.type + ' ' + this.url + "\n" + jqXHR.status + ': ' + errorThrown + '</pre></div>';
   $(Blacklight.modal.modalSelector).find('.modal-content').html(contents);
   $(Blacklight.modal.modalSelector).modal('show');
 };

data/app/assets/stylesheets/blacklight/_header.scss

@@ -14,11 +14,6 @@
     background: transparent $logo-image no-repeat top left;
   }
 
-  @if $logo_image {
-    // deprecated
-    background: transparent image_url($logo_image) no-repeat top left;
-  }
-
   display: inline-block;
   flex: 0 0 150px;
   height: 50px;

data/app/assets/stylesheets/blacklight/blacklight_defaults.scss

@@ -1,7 +1,6 @@
 /* Warning! If you want to change these, just copy them into your own theme css. But you want to remove the !default, which only will set them if not already set. */
 
 $logo-image: image_url('blacklight/logo.png') !default;
-$logo_image: false !default; // deprecated
 
 /* label (field names) */
 $field_name_color: $text-muted !default;

data/app/components/blacklight/advanced_search_form_component.html.erb

@@ -0,0 +1,46 @@
+<% if constraints.present? %>
+  <div class="constraints well search_history">
+    <h4><%= t 'blacklight.advanced_search.form.search_context' %></h4>
+    <%= constraints %>
+  </div>
+<% end %>
+
+<%= form_tag @url, method: @method, class: @classes.join(' '), role: 'search', 'aria-label' => t('blacklight.search.form.submit') do %>
+  <%= render_hash_as_hidden_fields(@params) %>
+
+  <div class="input-criteria">
+    <div class="query-criteria">
+      <h2 class="query-criteria-heading">
+        <%= t('blacklight.advanced_search.form.query_criteria_heading_html', select_menu: default_operator_menu) %>
+      </h2>
+
+      <div id="advanced_search">
+        <%= search_field_controls %>
+      </div>
+    </div>
+
+    <div class="limit-criteria">
+      <h2 class="limit-criteria-heading"><%= t('blacklight.advanced_search.form.limit_criteria_heading_html')%></h2>
+
+      <div id="advanced_search_facets" class="limit_input">
+        <div class="advanced-facet-limits panel-group">
+          <%= search_filter_controls %>
+        </div>
+      </div>
+    </div>
+  </div>
+
+  <%= content_tag :h2, t('blacklight.advanced_search.form.sort_label') %>
+  <div class="form-group row">
+    <div class="col-sm-offset-3 col-sm-4">
+      <%= sort_fields_select %>
+    </div>
+  </div>
+
+  <div class="form-group row">
+    <div class="submit-buttons col-sm-offset-3 col-sm-9">
+      <%= submit_tag t('blacklight.advanced_search.form.search_btn_html'), class: 'btn btn-primary advanced-search-submit', id: "advanced-search-submit" %>
+      <%= button_tag t('blacklight.advanced_search.form.start_over_html'), type: 'reset', class: 'btn btn-link advanced-search-start-over' %>
+    </div>
+  </div>
+<% end %>

data/app/components/blacklight/advanced_search_form_component.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class AdvancedSearchFormComponent < SearchBarComponent
+    with_content_areas :constraints, :search_field_controls, :search_filter_controls
+
+    def initialize(response:, **options)
+      super(**options)
+      @response = response
+    end
+
+    def default_operator_menu
+      options_with_labels = [:must, :should].index_by { |op| t(op, scope: 'blacklight.advanced_search.op') }
+      select_tag(:op, options_for_select(options_with_labels, params[:op]), class: 'input-small')
+    end
+
+    # Rubocop is just wrong here, so...:
+    # rubocop:disable Rails/ContentTag
+    def search_field_controls
+      @search_field_controls || safe_join(search_fields.values.map.with_index do |field, i|
+        fields_for('clause[]', i, include_id: false) do |f|
+          content_tag(:div, class: 'form-group advanced-search-field row') do
+            f.label(:query, field.display_label('search'), class: "col-sm-3 col-form-label") +
+            content_tag(:div, class: 'col-sm-9') do
+              f.hidden_field(:field, value: field.key) +
+              f.text_field(:query, value: query_for_search_clause(field.key), class: 'form-control')
+            end
+          end
+        end
+      end, "\n")
+    end
+    # rubocop:enable Rails/ContentTag
+
+    def query_for_search_clause(key)
+      field = (@params[:clause] || {}).values.find { |value| value['field'].to_s == key.to_s }
+
+      field&.dig('query')
+    end
+
+    def search_filter_controls
+      return @search_filter_controls if @search_filter_controls
+
+      fields = blacklight_config.facet_fields.select { |_k, v| v.include_in_advanced_search || v.include_in_advanced_search.nil? }
+
+      safe_join(fields.map do |_k, config|
+        display_facet = @response.aggregations[config.field]
+
+        presenter = (config.presenter || Blacklight::FacetFieldPresenter).new(config, display_facet, @view_context)
+        component = config.advanced_search_component || Blacklight::FacetFieldCheckboxesComponent
+        @view_context.render(component.new(facet_field: presenter))
+      end, "\n")
+    end
+
+    def constraints
+      params = @view_context.search_state.params_for_search.except :page, :f_inclusive, :q, :search_field, :op, :index, :sort
+
+      params.except!(*search_fields.map { |_key, field_def| field_def[:key] })
+
+      @view_context.render_search_to_s(params)
+    end
+
+    def sort_fields_select
+      options = sort_fields.values.map { |field_config| [@view_context.sort_field_label(field_config.key), field_config.key] }
+      select_tag(:sort, options_for_select(options, params[:sort]), class: "form-control sort-select")
+    end
+
+    def search_fields
+      blacklight_config.search_fields.select { |_k, v| v.include_in_advanced_search || v.include_in_advanced_search.nil? }
+    end
+
+    def sort_fields
+      blacklight_config.sort_fields.select { |_k, v| v.include_in_advanced_search || v.include_in_advanced_search.nil? }
+    end
+  end
+end

data/app/components/blacklight/constraint_component.html.erb

@@ -1,5 +1,5 @@
 <%= render(@layout.new(
-      classes: (Array(@classes) + ["filter-#{@facet_item_presenter.facet_config.key.parameterize}"]).join(' '),
+      classes: (Array(@classes) + ["filter-#{@facet_item_presenter.key.parameterize}"]).join(' '),
       label: @facet_item_presenter.field_label,
       value: @facet_item_presenter.label,
       remove_path: @facet_item_presenter.remove_href)) %>

data/app/components/blacklight/constraints_component.rb

@@ -15,23 +15,25 @@ module Blacklight
     end
 
     def query_constraints
-      return if @search_state.query_param.blank?
-
       Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
-        @view_context.render(
-          @query_constraint_component.new(
-            search_state: @search_state,
-            value: @search_state.query_param,
-            label: @view_context.constraint_query_label(@search_state.params),
-            remove_path: @view_context.remove_constraint_url(@search_state),
-            classes: 'query'
+        if @search_state.query_param.present?
+          @view_context.render(
+            @query_constraint_component.new(
+              search_state: @search_state,
+              value: @search_state.query_param,
+              label: label,
+              remove_path: @view_context.remove_constraint_url(@search_state),
+              classes: 'query'
+            )
           )
-        )
-      end
+        else
+          ''.html_safe
+        end
+      end + @view_context.render(@facet_constraint_component.with_collection(clause_presenters.to_a))
     end
 
     def facet_constraints
-      @view_context.render(@facet_constraint_component.with_collection(facet_item_presenters))
+      @view_context.render(@facet_constraint_component.with_collection(facet_item_presenters.to_a))
     end
 
     def start_over_path
@@ -46,22 +48,45 @@ module Blacklight
 
     private
 
+    def label
+      Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
+        @view_context.constraint_query_label(@search_state.params)
+      end
+    end
+
     def facet_item_presenters
-      Deprecation.silence(Blacklight::SearchState) do
-        @search_state.filter_params.each_pair.flat_map do |facet, values|
-          facet_config = @view_context.facet_configuration_for_field(facet)
+      return to_enum(:facet_item_presenters) unless block_given?
 
-          Array(values).map do |val|
+      Deprecation.silence(Blacklight::SearchState) do
+        @search_state.filters.map do |facet|
+          facet.values.map do |val|
             next if val.blank? # skip empty string
 
-            facet_item_presenter(facet_config, val, facet)
+            if val.is_a?(Array)
+              yield inclusive_facet_item_presenter(facet.config, val, facet.key) if val.any?(&:present?)
+            else
+              yield facet_item_presenter(facet.config, val, facet.key)
+            end
           end
         end
       end
     end
 
+    def clause_presenters
+      return to_enum(:clause_presenters) unless block_given?
+
+      @search_state.clause_params.each do |key, clause|
+        field_config = @view_context.blacklight_config.search_fields[clause[:field]]
+        yield Blacklight::ClausePresenter.new(key, clause, field_config, @view_context)
+      end
+    end
+
     def facet_item_presenter(facet_config, facet_item, facet_field)
       Blacklight::FacetItemPresenter.new(facet_item, facet_config, @view_context, facet_field)
     end
+
+    def inclusive_facet_item_presenter(facet_config, facet_item, facet_field)
+      Blacklight::InclusiveFacetItemPresenter.new(facet_item, facet_config, @view_context, facet_field)
+    end
   end
 end

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

@@ -1,4 +1,4 @@
-<% value = @use_thumbnail_tag ? @presenter.thumbnail.thumbnail_tag({ alt: '' }, 'aria-hidden': true, tabindex: -1, counter: @counter) : @presenter.thumbnail.render({ alt: '' }) %>
+<% value = @use_thumbnail_tag ? @presenter.thumbnail.thumbnail_tag(@image_options, 'aria-hidden': true, tabindex: -1, counter: @counter) : @presenter.thumbnail.render(@image_options) %>
 
 <% if value %>
   <div class="document-thumbnail">
@@ -6,7 +6,7 @@
       <% warn_about_deprecated_behavior %>
       <%= value %>
     <% else %>
-      <%= @view_context.link_to_document(@presenter.document, value, 'aria-hidden': true, tabindex: -1, counter: @counter) %>
+      <%= helpers.link_to_document(@presenter.document, value, 'aria-hidden': true, tabindex: -1, counter: @counter) %>
     <% end %>
   </div>
 <% end %>

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

@@ -7,10 +7,13 @@ module Blacklight
       with_collection_parameter :presenter
 
       # @param [Blacklight::DocumentPresenter] presenter
-      def initialize(presenter:, counter:)
+      # @param [Integer] counter
+      # @param [Hash] image_options options for the thumbnail presenter's image tag
+      def initialize(presenter:, counter:, image_options: {})
         @presenter = presenter
         @counter = counter
-        @use_thumbnail_tag = @presenter.thumbnail != Blacklight::ThumbnailPresenter
+        @image_options = { alt: '' }.merge(image_options)
+        @use_thumbnail_tag = !@presenter.thumbnail.instance_of?(Blacklight::ThumbnailPresenter)
       end
 
       def render?

data/app/components/blacklight/document_component.rb

@@ -26,6 +26,7 @@ module Blacklight
                    id: nil, classes: [], component: :article, title_component: :h4,
                    metadata_component: Blacklight::DocumentMetadataComponent,
                    embed_component: nil,
+                   thumbnail_component: Blacklight::Document::ThumbnailComponent,
                    counter: nil, document_counter: nil, counter_offset: 0,
                    show: false)
       if presenter.nil? && document.nil?
@@ -42,6 +43,7 @@ module Blacklight
 
       @embed_component = embed_component
       @metadata_component = metadata_component
+      @thumbnail_component = thumbnail_component
 
       @document_counter = document_counter
       @counter = counter
@@ -83,11 +85,14 @@ module Blacklight
     end
 
     # Content for the document thumbnail area
-    def thumbnail
+    def thumbnail(image_options = {})
       return super if block_given?
+      return @thumbnail if @thumbnail
+
       return if @show
 
-      @thumbnail || render(Blacklight::Document::ThumbnailComponent.new(presenter: presenter, counter: @counter))
+      component = @thumbnail_component || presenter.view_config.thumbnail_component
+      render(component.new(presenter: presenter, counter: @counter, image_options: image_options))
     end
 
     # Content for the document metadata area