blacklight 7.12.0 → 7.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 795afb3fdb4a13aa033d1b37180537e51ebfd53ab8f0ef894d05b6370b1c1238
-  data.tar.gz: 003ccd0c42c44636d463df31c141a7b9b6ab1276bab6d771d1637d2eb7ff17fc
+  metadata.gz: 125e5713e43315d9fdbae35677048bb1a1bb9830970f8ff43101ecaed9979385
+  data.tar.gz: 34d83a1474edd010642bc2ddf9f72a5409dd66f80bd28f3e6576fafdaa119475
 SHA512:
-  metadata.gz: 1e9cdd317ae4535217bc98930c09095ca8aaebe01124863b6a507a2c9bfbd4851a18d72f139bbb6c2f152094e1cb3cf3462eea26747f3212dc484c24603f6ec4
-  data.tar.gz: a7f142dbaaabff9a9477d116ccd283ab67b2e72fb6d5f0c0482b495ed57f69486aa73f3ef6f67b31f0d00316d1dfb0b61fffaae08ebd1208aebae18a495c9746
+  metadata.gz: ab411c9cd2690a01b3d61fa1c8f602b910686b920e26ac638eddfb08e4b43af86d6beca036509056f510a2d56041059dadcfa0ee92cccedcbe238bfe5d7abc4b
+  data.tar.gz: ed2cea2667023dbe7720c4939f4dc4b3cd98d26be0e7a1bc89dba416d0b077bf3792b810fe9e479ef5890f2cad3b3003154822778722b5528051df106f570e51

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/.rubocop.yml

@@ -37,6 +37,8 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Exclude:
     - "lib/blacklight/configuration.rb"
+    - "lib/blacklight/search_builder.rb"
+    - "lib/blacklight/search_state.rb"
 
 Layout/LineLength:
   Max: 200
@@ -46,6 +48,7 @@ Layout/LineLength:
 Metrics/ModuleLength:
   Exclude:
     - 'app/controllers/concerns/blacklight/catalog.rb'
+    - 'lib/blacklight/solr/search_builder_behavior.rb'
 
 Naming/HeredocDelimiterNaming:
   Enabled: false

data/README.md

@@ -1,6 +1,6 @@
 # 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)
+[![Build Status](https://travis-ci.com/projectblacklight/blacklight.png?branch=master)](https://travis-ci.com/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.

data/VERSION

@@ -1 +1 @@
-7.12.0
+7.14.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/components/blacklight/constraints_component.rb

@@ -22,7 +22,7 @@ module Blacklight
           @query_constraint_component.new(
             search_state: @search_state,
             value: @search_state.query_param,
-            label: @view_context.constraint_query_label(@search_state.params),
+            label: label,
             remove_path: @view_context.remove_constraint_url(@search_state),
             classes: 'query'
           )
@@ -46,14 +46,22 @@ module Blacklight
 
     private
 
+    def label
+      Deprecation.silence(Blacklight::ConfigurationHelperBehavior) do
+        @view_context.constraint_query_label(@search_state.params)
+      end
+    end
+
     def facet_item_presenters
-      @search_state.filter_params.each_pair.flat_map do |facet, values|
-        facet_config = @view_context.facet_configuration_for_field(facet)
+      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)
 
-        Array(values).map do |val|
-          next if val.blank? # skip empty string
+          Array(values).map do |val|
+            next if val.blank? # skip empty string
 
-          facet_item_presenter(facet_config, val, facet)
+            facet_item_presenter(facet_config, val, facet)
+          end
         end
       end
     end

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

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

@@ -10,7 +10,7 @@ module Blacklight
       def initialize(presenter:, counter:)
         @presenter = presenter
         @counter = counter
-        @use_thumbnail_tag = @presenter.thumbnail != Blacklight::ThumbnailPresenter
+        @use_thumbnail_tag = !@presenter.thumbnail.instance_of?(Blacklight::ThumbnailPresenter)
       end
 
       def render?

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

@@ -19,6 +19,7 @@
         <%= actions %>
       </header>
 
+      <%= embed %>
       <%= content %>
       <%= metadata %>
     </div>

data/app/components/blacklight/document_component.rb

@@ -6,7 +6,7 @@ module Blacklight
     # the accessors below.
     with_content_areas :header, :body, :footer,
                        :before_title, :title, :after_title,
-                       :actions, :metadata, :thumbnail,
+                       :actions, :embed, :metadata, :thumbnail,
                        :partials
     with_collection_parameter :document
 
@@ -25,6 +25,7 @@ module Blacklight
     def initialize(document: nil, presenter: nil,
                    id: nil, classes: [], component: :article, title_component: :h4,
                    metadata_component: Blacklight::DocumentMetadataComponent,
+                   embed_component: nil,
                    counter: nil, document_counter: nil, counter_offset: 0,
                    show: false)
       if presenter.nil? && document.nil?
@@ -39,8 +40,10 @@ module Blacklight
       @id = id || ('document' if show)
       @classes = classes
 
+      @embed_component = embed_component
       @metadata_component = metadata_component
 
+      @document_counter = document_counter
       @counter = counter
       @counter ||= document_counter + 1 + counter_offset if document_counter.present?
 
@@ -101,6 +104,16 @@ module Blacklight
       @before_title || counter
     end
 
+    def embed
+      return @embed if @embed
+
+      component = @embed_component || presenter.view_config.embed_component
+
+      return unless component
+
+      @view_context.render(component.new(document: @document, presenter: presenter, document_counter: @document_counter))
+    end
+
     private
 
     def counter

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

@@ -1,6 +1,7 @@
 <div class="card facet-limit blacklight-<%= @facet_field.key %> <%= 'facet-limit-active' if @facet_field.active? %>">
   <h3 class="card-header p-0 facet-field-heading" id="<%= @facet_field.html_id %>-header">
     <button
+      type="button"
       class="btn btn-block p-2 text-left collapse-toggle <%= "collapsed" if @facet_field.collapsed? %>"
       data-toggle="collapse"
       data-target="#<%= @facet_field.html_id %>"

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

@@ -1,9 +1,9 @@
 <div class="prev_next_links btn-group">
-  <%= link_to_previous_page @facet_field.paginator, raw(t('views.pagination.previous')), params: @facet_field.search_state.to_h, param_name: param_name, class: 'btn btn-link', data: { blacklight_modal: "preserve" } do %>
+  <%= @view_context.link_to_previous_page @facet_field.paginator, raw(t('views.pagination.previous')), params: @facet_field.search_state.to_h, param_name: param_name, class: 'btn btn-link', data: { blacklight_modal: "preserve" } do %>
     <%= content_tag :span, raw(t('views.pagination.previous')), class: 'disabled btn' %>
   <% end %>
 
-  <%= link_to_next_page @facet_field.paginator, raw(t('views.pagination.next')), params: @facet_field.search_state.to_h, param_name: param_name, class: 'btn btn-link',  data: { blacklight_modal: "preserve" } do %>
+  <%= @view_context.link_to_next_page @facet_field.paginator, raw(t('views.pagination.next')), params: @facet_field.search_state.to_h, param_name: param_name, class: 'btn btn-link',  data: { blacklight_modal: "preserve" } do %>
     <%= content_tag :span, raw(t('views.pagination.next')), class: 'disabled btn' %>
   <% end %>
 </div>
@@ -11,9 +11,9 @@
 <div class="sort-options btn-group">
   <% if @facet_field.paginator.sort == 'index' -%>
     <span class="active az btn btn-outline-secondary"><%= t('blacklight.search.facets.sort.index') %></span>
-    <%= link_to(t('blacklight.search.facets.sort.count'), sort_facet_url('count'), class: "sort_change numeric btn btn-outline-secondary", data: { blacklight_modal: "preserve" }) %>
+    <%= @view_context.link_to(t('blacklight.search.facets.sort.count'), sort_facet_url('count'), class: "sort_change numeric btn btn-outline-secondary", data: { blacklight_modal: "preserve" }) %>
   <% elsif @facet_field.paginator.sort == 'count' -%>
-    <%=  link_to(t('blacklight.search.facets.sort.index'), sort_facet_url('index'), class: "sort_change az btn btn-outline-secondary",  data: { blacklight_modal: "preserve" }) %>
+    <%= @view_context.link_to(t('blacklight.search.facets.sort.index'), sort_facet_url('index'), class: "sort_change az btn btn-outline-secondary",  data: { blacklight_modal: "preserve" }) %>
     <span class="active numeric btn btn-outline-secondary"><%= t('blacklight.search.facets.sort.count') %></span>
   <% end -%>
 </div>

data/app/components/blacklight/facet_field_pagination_component.rb

@@ -6,10 +6,6 @@ module Blacklight
       @facet_field = facet_field
     end
 
-    def render?
-      @facet_field.facet_field.index_range&.any?
-    end
-
     def sort_facet_url(sort)
       @facet_field.paginator.params_for_resort_url(sort, @facet_fieldsearch_state.to_h)
     end

data/app/components/blacklight/hidden_search_state_component.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Blacklight
+  # Writes out zero or more <input type="hidden"> elements, completely
+  # representing a hash passed in using Rails-style request parameters
+  # for hashes nested with arrays and other hashes.
+  class HiddenSearchStateComponent < ::ViewComponent::Base
+    # @param [Hash] hash
+    def initialize(params:)
+      Deprecation.warn(self, "Passing page as a parameter to HiddenSearchStateComponent is deprecated and will not be supported in Blacklight 8") if params.key?(:page)
+      @params = params.except(:utf8)
+    end
+
+    def call
+      hidden_fields = []
+      flatten_hash(@params).each do |name, value|
+        value = Array.wrap(value)
+        value.each do |v|
+          hidden_fields << hidden_field_tag(name, v.to_s, id: nil)
+        end
+      end
+
+      safe_join(hidden_fields, "\n")
+    end
+
+    private
+
+    def flatten_hash(hash = params, ancestor_names = [])
+      flat_hash = {}
+      hash.each do |k, v|
+        names = Array.new(ancestor_names)
+        names << k
+        if v.is_a?(Hash)
+          flat_hash.merge!(flatten_hash(v, names))
+        else
+          key = flat_hash_key(names)
+          key += "[]" if v.is_a?(Array)
+          flat_hash[key] = v
+        end
+      end
+
+      flat_hash
+    end
+
+    def flat_hash_key(names)
+      names = Array.new(names)
+      name = names.shift.to_s.dup
+      names.each do |n|
+        name << "[#{n}]"
+      end
+      name
+    end
+  end
+end

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

@@ -1,27 +1,29 @@
-<%= form_tag @url, method: @method, class: @classes.join(' '), role: 'search', 'aria-label' => t('blacklight.search.form.submit') do %>
+<%= form_tag @url, method: @method, class: @classes.join(' '), role: 'search', 'aria-label' => scoped_t('submit') do %>
   <%= render_hash_as_hidden_fields(@params) %>
   <% if @search_fields.length > 1 %>
-    <label for="search_field" class="sr-only"><%= t('blacklight.search.form.search_field.label') %></label>
+    <label for="search_field" class="sr-only"><%= scoped_t('search_field.label') %></label>
   <% end %>
   <div class="input-group">
+    <%= prepend %>
+
     <% if @search_fields.length > 1 %>
         <%= select_tag(:search_field,
                        options_for_select(@search_fields, h(@search_field)),
-                       title: t('blacklight.search.form.search_field.title'),
+                       title: scoped_t('search_field.title'),
                        id: "#{@prefix}search_field",
                        class: "custom-select search-field") %>
     <% elsif @search_fields.length == 1 %>
       <%= hidden_field_tag :search_field, @search_fields.first.last %>
     <% end %>
 
-    <label for="<%= @prefix %>q" class="sr-only"><%= t('blacklight.search.form.search.label') %></label>
-    <%= text_field_tag :q, @q, placeholder: t('blacklight.search.form.search.placeholder'), class: "search-q q form-control rounded-#{@search_fields.length > 1 ? '0' : 'left'}", id: "#{@prefix}q", autocomplete: autocomplete_path.present? ? "off" : "", autofocus: @autofocus, data: { autocomplete_enabled: autocomplete_path.present?, autocomplete_path: autocomplete_path }  %>
-
-    <%= content %>
+    <label for="<%= @prefix %><%= @query_param %>" class="sr-only"><%= scoped_t('search.label') %></label>
+    <%= text_field_tag @query_param, @q, placeholder: scoped_t('search.placeholder'), class: "search-q q form-control rounded-#{@search_fields.length > 1 ? '0' : 'left'}", id: "#{@prefix}q", autocomplete: autocomplete_path.present? ? "off" : "", autofocus: @autofocus, data: { autocomplete_enabled: autocomplete_path.present?, autocomplete_path: autocomplete_path }  %>
 
     <span class="input-group-append">
+      <%= append %>
+
       <button type="submit" class="btn btn-primary search-btn" id="<%= @prefix %>search">
-        <span class="submit-search-text"><%= t('blacklight.search.form.submit') %></span>
+        <span class="submit-search-text"><%= scoped_t('submit') %></span>
         <%= blacklight_icon :search, aria_hidden: true %>
       </button>
     </span>

data/app/components/blacklight/search_bar_component.rb

@@ -2,10 +2,18 @@
 
 module Blacklight
   class SearchBarComponent < ::ViewComponent::Base
+    with_content_areas :append, :prepend
+
     # rubocop:disable Metrics/ParameterLists
-    def initialize(url:, params:, classes: ['search-query-form'], presenter: nil, prefix: '', method: 'GET', q: nil, search_field: nil, search_fields: [], autocomplete_path: nil, autofocus: nil)
+    def initialize(
+      url:, params:, classes: ['search-query-form'], presenter: nil,
+      prefix: '', method: 'GET', q: nil, query_param: :q,
+      search_field: nil, search_fields: [], autocomplete_path: nil,
+      autofocus: nil, i18n: { scope: 'blacklight.search.form' }
+    )
       @url = url
       @q = q || params[:q]
+      @query_param = query_param
       @search_field = search_field || params[:search_field]
       @params = params.except(:q, :search_field, :utf8, :page)
       @prefix = prefix
@@ -15,6 +23,7 @@ module Blacklight
       @autocomplete_path = autocomplete_path
       @autofocus = autofocus
       @search_fields = search_fields
+      @i18n = i18n
     end
     # rubocop:enable Metrics/ParameterLists
 
@@ -47,5 +56,9 @@ module Blacklight
         @view_context.render_hash_as_hidden_fields(*args)
       end
     end
+
+    def scoped_t(key, **args)
+      t(key, default: t(key, scope: 'blacklight.search.form'), **@i18n, **args)
+    end
   end
 end