blacklight 7.21.0 → 7.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f9ecb2c98805e0783286a52510875f35da4b19983fa3c9f174fcce921d2b630
-  data.tar.gz: 221bbc331cace14c9212c4be38d372b3a62b15fa5d16af116f79e90c53a5dafe
+  metadata.gz: 6db63ed11099851dc7e85c6d2e9e6ec15d39b6a4baec81545625f6362f7eafb7
+  data.tar.gz: 35c166e0e26c7e6cbfaf8775338677e3968d91f3ad07335c2cc08f92a710b5f4
 SHA512:
-  metadata.gz: ebee61b6584dbf10836b754f3f390acc24dce35da380caf633986bd1792991aaec3c07b9299f0f32beed54e339eaec4e0051f2350c08b2111e855688665bf4d4
-  data.tar.gz: 251aca6a6d0908be8a3b75312bd1604e88b4a55810f3553b6634f281ecd79b176ac2ef04797e3a02f42f41c8eaec0d49d734f10a699f8a739c17a65a5cf515ca
+  metadata.gz: d24a44e67f15f30fb674da5102a7ad48401172da23bddaed461f220805429d4816e6912ffe7a069683d4ee2710e478d2e75ab43ff88ddf4caf2f3349ce1a7830
+  data.tar.gz: 25e2ad757ecc09eb6b5c3243b012f963894f6829314a7db86393ea4ec826b4b5deb4aeb79ad55cb1084a5043f9e33f39de3640638ce6e8a16f8377ceeea623a3

data/.docker/app/Dockerfile

@@ -9,8 +9,10 @@ RUN apk add --update --no-cache \
   libxml2-dev \
   libxslt-dev \
   nodejs \
+  shared-mime-info \
   sqlite-dev \
-  tzdata
+  tzdata \
+  yarn
 
 RUN mkdir /app
 WORKDIR /app

data/.dockerignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.internal_test_app
+.solr_wrapper.yml

data/.env

@@ -1,5 +1,5 @@
-ALPINE_RUBY_VERSION=2.6.5
-RAILS_VERSION=5.2.5
+ALPINE_RUBY_VERSION=2.7.5
+RAILS_VERSION=5.2.6
 SOLR_PORT=8983
 SOLR_URL=http://solr:8983/solr/blacklight-core
 SOLR_VERSION=latest

data/.github/workflows/ruby.yml

@@ -9,9 +9,10 @@ name: CI
 
 on:
   push:
-    branches: [ main ]
+    branches:
+      - main
+      - 'release-*'
   pull_request:
-    branches: [ main ]
 
 jobs:
   lint:

data/VERSION

@@ -1 +1 @@
-7.21.0
+7.22.1

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

@@ -1,6 +1,6 @@
 "use strict";
 
-Blacklight = function () {
+var Blacklight = function () {
   var buffer = new Array();
   return {
     onLoad: function onLoad(func) {
@@ -48,6 +48,7 @@ Blacklight.onLoad(function () {
   elem.classList.remove('no-js');
   elem.classList.add('js');
 });
+window.Blacklight = Blacklight;
 /*global Bloodhound */
 
 Blacklight.onLoad(function () {
@@ -365,7 +366,7 @@ 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 btn-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');
+  Blacklight.modal.show();
 };
 
 Blacklight.modal.receiveAjax = function (contents) {
@@ -384,7 +385,7 @@ Blacklight.modal.receiveAjax = function (contents) {
   $(Blacklight.modal.modalSelector).trigger(e); // if they did preventDefault, don't show the dialog
 
   if (e.isDefaultPrevented()) return;
-  $(Blacklight.modal.modalSelector).modal('show');
+  Blacklight.modal.show();
 };
 
 Blacklight.modal.modalAjaxLinkClick = function (e) {
@@ -431,7 +432,7 @@ Blacklight.modal.setupModal = function () {
 Blacklight.modal.checkCloseModal = function (event) {
   if ($(event.target).find(Blacklight.modal.modalCloseSelector).length) {
     var modalFlashes = $(this).find('.flash_messages');
-    $(event.target).modal('hide');
+    Blacklight.modal.hide(event.target);
     event.preventDefault();
     var mainFlashes = $('#main-flashes');
     mainFlashes.append(modalFlashes);
@@ -439,6 +440,22 @@ Blacklight.modal.checkCloseModal = function (event) {
   }
 };
 
+Blacklight.modal.hide = function (el) {
+  if (bootstrap.Modal.VERSION >= "5") {
+    bootstrap.Modal.getOrCreateInstance(el || document.querySelector(Blacklight.modal.modalSelector)).hide();
+  } else {
+    $(el || Blacklight.modal.modalSelector).modal('hide');
+  }
+};
+
+Blacklight.modal.show = function (el) {
+  if (bootstrap.Modal.VERSION >= "5") {
+    bootstrap.Modal.getOrCreateInstance(el || document.querySelector(Blacklight.modal.modalSelector)).show();
+  } else {
+    $(el || Blacklight.modal.modalSelector).modal('show');
+  }
+};
+
 Blacklight.onLoad(function () {
   Blacklight.modal.setupModal();
 });

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

@@ -1,6 +1,8 @@
 .constraints-container {
   @extend .mb-2;
   display: flex;
+  flex-wrap: wrap;
+  gap: 0.5rem 0.25rem;
 }
 
 .applied-filter {

data/app/components/blacklight/constraints_component.rb

@@ -86,7 +86,7 @@ module Blacklight
     end
 
     def facet_item_presenter(facet_config, facet_item, facet_field)
-      Blacklight::FacetItemPresenter.new(facet_item, facet_config, @view_context, facet_field)
+      (facet_config.item_presenter || Blacklight::FacetItemPresenter).new(facet_item, facet_config, @view_context, facet_field)
     end
 
     def inclusive_facet_item_presenter(facet_config, facet_item, facet_field)

data/app/components/blacklight/facet_field_checkboxes_component.rb

@@ -17,7 +17,7 @@ module Blacklight
       return to_enum(:presenters) unless block_given?
 
       @facet_field.paginator.items.each do |item|
-        yield Blacklight::FacetItemPresenter.new(item, @facet_field.facet_field, @view_context, @facet_field.key, @facet_field.search_state)
+        yield (@facet_field.facet_field.item_presenter || Blacklight::FacetItemPresenter).new(item, @facet_field.facet_field, @view_context, @facet_field.key, @facet_field.search_state)
       end
     end
   end

data/app/components/blacklight/facet_item_pivot_component.rb

@@ -78,7 +78,7 @@ module Blacklight
     end
 
     def facet_item_presenter(facet_item)
-      Blacklight::FacetItemPresenter.new(facet_item, @facet_item.facet_config, @view_context, @facet_item.facet_field, @facet_item.search_state)
+      (@facet_item.facet_config.item_presenter || Blacklight::FacetItemPresenter).new(facet_item, @facet_item.facet_config, @view_context, @facet_item.facet_field, @facet_item.search_state)
     end
   end
 end

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -319,7 +319,7 @@ module Blacklight::FacetsHelperBehavior
   end
 
   def facet_item_presenter(facet_config, facet_item, facet_field)
-    Blacklight::FacetItemPresenter.new(facet_item, facet_config, self, facet_field)
+    (facet_config.item_presenter || Blacklight::FacetItemPresenter).new(facet_item, facet_config, self, facet_field)
   end
 
   def facet_item_component(facet_config, facet_item, facet_field, **args)

data/app/helpers/blacklight/render_partials_helper_behavior.rb

@@ -9,7 +9,10 @@ module Blacklight::RenderPartialsHelperBehavior
   # @param [Hash] locals to pass to the render call
   # @return [String]
   def render_document_index documents = nil, locals = {}
-    documents ||= @response.documents
+    unless documents
+      Deprecation.warn(self, "Calling render_document_index without documents is deprecated and will be removed in version 8")
+      documents = @response.documents
+    end
     render_document_index_with_view(document_index_view_type, documents, locals)
   end
 

data/app/javascript/blacklight/core.js

@@ -1,4 +1,4 @@
-Blacklight = function() {
+const Blacklight = function() {
   var buffer = new Array;
   return {
     onLoad: function(func) {
@@ -50,3 +50,5 @@ Blacklight.onLoad(function () {
   elem.classList.remove('no-js')
   elem.classList.add('js')
 })
+
+window.Blacklight = Blacklight

data/app/javascript/blacklight/modal.js

@@ -114,7 +114,7 @@ Blacklight.modal.onFailure = function(jqXHR, textStatus, errorThrown) {
             this.type + ' ' + this.url + "\n" + jqXHR.status + ': ' + errorThrown +
             '</pre></div>';
   $(Blacklight.modal.modalSelector).find('.modal-content').html(contents);
-  $(Blacklight.modal.modalSelector).modal('show');
+  Blacklight.modal.show();
 }
 
 Blacklight.modal.receiveAjax = function (contents) {
@@ -135,7 +135,7 @@ Blacklight.modal.receiveAjax = function (contents) {
     // if they did preventDefault, don't show the dialog
     if (e.isDefaultPrevented()) return;
 
-    $(Blacklight.modal.modalSelector).modal('show');
+    Blacklight.modal.show();
 };
 
 
@@ -196,7 +196,7 @@ Blacklight.modal.checkCloseModal = function(event) {
   if ($(event.target).find(Blacklight.modal.modalCloseSelector).length) {
     var modalFlashes = $(this).find('.flash_messages');
 
-    $(event.target).modal('hide');
+    Blacklight.modal.hide(event.target);
     event.preventDefault();
 
     var mainFlashes = $('#main-flashes');
@@ -205,6 +205,22 @@ Blacklight.modal.checkCloseModal = function(event) {
   }
 }
 
+Blacklight.modal.hide = function(el) {
+  if (bootstrap.Modal.VERSION >= "5") {
+    bootstrap.Modal.getOrCreateInstance(el || document.querySelector(Blacklight.modal.modalSelector)).hide();
+  } else {
+    $(el || Blacklight.modal.modalSelector).modal('hide');
+  }
+}
+
+Blacklight.modal.show = function(el) {
+  if (bootstrap.Modal.VERSION >= "5") {
+    bootstrap.Modal.getOrCreateInstance(el || document.querySelector(Blacklight.modal.modalSelector)).show();
+  } else {
+    $(el || Blacklight.modal.modalSelector).modal('show');
+  }
+}
+
 Blacklight.onLoad(function() {
   Blacklight.modal.setupModal();
 });

data/app/views/bookmarks/index.html.erb

@@ -14,7 +14,7 @@
     <%= render 'sort_and_per_page' %>
     <%= render partial: 'tools', locals: { document_list: @response.documents } %>
     <h2 class='section-heading sr-only visually-hidden'><%= t('blacklight.bookmarks.list_title') %></h2>
-    <%= render_document_index %>
+    <%= render_document_index @response.documents %>
     <%= render 'results_pagination' %>
   <% end %>
 </div>

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

@@ -26,7 +26,7 @@
 <%- elsif render_grouped_response? %>
   <%= Deprecation.silence(Blacklight::RenderPartialsHelperBehavior) { render_grouped_document_index } %>
 <%- else %>
-  <%= render_document_index %>
+  <%= render_document_index @response.documents %>
 <%- end %>
 
 <%= render 'results_pagination' %>

data/docker-compose.yml

@@ -7,8 +7,9 @@ services:
       dockerfile: .docker/app/Dockerfile
       args:
         - ALPINE_RUBY_VERSION
-    volumes:
-      - .:/app
+    # mounting . is causing seg-fault on macosx
+    #volumes:
+      #- .:/app
     depends_on:
       - solr
     ports:
@@ -16,6 +17,8 @@ services:
     environment:
       - SOLR_URL # Set via environment variable or use default defined in .env file
       - RAILS_VERSION # Set via environment variable or use default defined in .env file
+      - SOLR_ENV=docker-compose
+      - ENGINE_CART_RAILS_OPTIONS=--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test --skip-solr
 
   solr:
     environment:

data/lib/blacklight/configuration/facet_field.rb

@@ -58,6 +58,8 @@ module Blacklight
     # Rendering:
     # @!attribute presenter
     #   @return [Blacklight::FacetFieldPresenter]
+    # @!attribute item_presenter
+    #   @return [Blacklight::FacetItemPresenter]
     # @!attribute component
     #   @return [Blacklight::FacetFieldListComponent]
     # @!attribute item_component

data/lib/blacklight/solr/response/facets.rb

@@ -61,6 +61,10 @@ module Blacklight::Solr::Response::Facets
       @options[:data] || {}
     end
 
+    def response
+      @options[:response]
+    end
+
     def index?
       sort == 'index'
     end
@@ -180,7 +184,7 @@ module Blacklight::Solr::Response::Facets
       end
 
       options = facet_field_aggregation_options(facet_field_name)
-      facet_field = FacetField.new(facet_field_name, items, options)
+      facet_field = FacetField.new(facet_field_name, items, options.merge(response: self))
 
       if values[nil]
         facet_field.missing = items.find(&:missing)
@@ -213,7 +217,9 @@ module Blacklight::Solr::Response::Facets
 
       items = items.sort_by(&:hits).reverse if facet_field.sort && facet_field.sort.to_sym == :count
 
-      hash[field_name] = Blacklight::Solr::Response::Facets::FacetField.new field_name, items
+      facet_field = Blacklight::Solr::Response::Facets::FacetField.new field_name, items, response: response
+
+      hash[field_name] = facet_field
     end
   end
 
@@ -244,7 +250,9 @@ module Blacklight::Solr::Response::Facets
 
       # alias all the possible blacklight config names..
       blacklight_config.facet_fields.select { |_k, v| v.pivot && v.pivot.join(",") == field_name }.each_key do |key|
-        hash[key] = Blacklight::Solr::Response::Facets::FacetField.new key, items
+        facet_field = Blacklight::Solr::Response::Facets::FacetField.new key, items, response: self
+
+        hash[key] = facet_field
       end
     end
   end
@@ -288,7 +296,7 @@ module Blacklight::Solr::Response::Facets
         i
       end
 
-      options = facet_field_aggregation_options(facet_field_name).merge(data: data)
+      options = facet_field_aggregation_options(facet_field_name).merge(data: data, response: self)
       facet_field = FacetField.new(facet_field_name, items, options)
 
       facet_field.missing = Blacklight::Solr::Response::Facets::FacetItem.new(

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "7.20.1",
+  "version": "7.22.0",
   "description": "[![Build Status](https://travis-ci.com/projectblacklight/blacklight.png?branch=main)](https://travis-ci.com/projectblacklight/blacklight) [![Gem Version](https://badge.fury.io/rb/blacklight.png)](http://badge.fury.io/rb/blacklight) [![Coverage Status](https://coveralls.io/repos/github/projectblacklight/blacklight/badge.svg?branch=main)](https://coveralls.io/github/projectblacklight/blacklight?branch=main)",
   "main": "app/assets/javascripts/blacklight",
   "scripts": {

data/spec/helpers/blacklight/facets_helper_behavior_spec.rb

@@ -305,7 +305,7 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
     let(:search_state) { double(has_facet?: false, add_facet_params_and_redirect: { controller: 'catalog' }) }
 
     before do
-      allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(Blacklight::Configuration::FacetField.new(key: 'simple_field', query: nil, date: nil, helper_method: nil, single: false, url_method: nil))
+      allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(Blacklight::Configuration::FacetField.new(key: 'simple_field', query: nil, date: nil, helper_method: nil, single: false, url_method: nil, item_presenter: nil))
       allow(helper).to receive(:facet_display_value).and_return('Z')
       allow(helper).to receive(:search_state).and_return(search_state)
       allow(helper).to receive(:search_action_path) do |*args|
@@ -326,7 +326,7 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
       let(:expected_html) { '<span class="facet-label"><a class="facet-select" rel="nofollow" href="/blabla">Z</a></span><span class="facet-count">10</span>' }
 
       it "uses that method" do
-        allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(Blacklight::Configuration::FacetField.new(key: 'simple_field', query: nil, date: nil, helper_method: nil, single: false, url_method: :test_method))
+        allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(Blacklight::Configuration::FacetField.new(key: 'simple_field', query: nil, date: nil, helper_method: nil, single: false, url_method: :test_method, item_presenter: nil))
         allow(helper).to receive(:test_method).with('simple_field', item).and_return('/blabla')
         result = helper.render_facet_value('simple_field', item)
         expect(result).to be_equivalent_to(expected_html).respecting_element_order
@@ -345,28 +345,28 @@ RSpec.describe Blacklight::FacetsHelperBehavior do
 
   describe "#facet_display_value" do
     it "justs be the facet value for an ordinary facet" do
-      allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(double(query: nil, date: nil, helper_method: nil, url_method: nil))
+      allow(helper).to receive(:facet_configuration_for_field).with('simple_field').and_return(double(query: nil, date: nil, helper_method: nil, url_method: nil, item_presenter: nil))
       expect(helper.facet_display_value('simple_field', 'asdf')).to eq 'asdf'
     end
 
     it "allows you to pass in a :helper_method argument to the configuration" do
-      allow(helper).to receive(:facet_configuration_for_field).with('helper_field').and_return(double(query: nil, date: nil, url_method: nil, helper_method: :my_facet_value_renderer))
+      allow(helper).to receive(:facet_configuration_for_field).with('helper_field').and_return(double(query: nil, date: nil, url_method: nil, helper_method: :my_facet_value_renderer, item_presenter: nil))
       allow(helper).to receive(:my_facet_value_renderer).with('qwerty').and_return('abc')
       expect(helper.facet_display_value('helper_field', 'qwerty')).to eq 'abc'
     end
 
     it "extracts the configuration label for a query facet" do
-      allow(helper).to receive(:facet_configuration_for_field).with('query_facet').and_return(double(query: { 'query_key' => { label: 'XYZ' } }, date: nil, helper_method: nil, url_method: nil))
+      allow(helper).to receive(:facet_configuration_for_field).with('query_facet').and_return(double(query: { 'query_key' => { label: 'XYZ' } }, date: nil, helper_method: nil, url_method: nil, item_presenter: nil))
       expect(helper.facet_display_value('query_facet', 'query_key')).to eq 'XYZ'
     end
 
     it "localizes the label for date-type facets" do
-      allow(helper).to receive(:facet_configuration_for_field).with('date_facet').and_return(double('date' => true, :query => nil, :helper_method => nil, :url_method => nil))
+      allow(helper).to receive(:facet_configuration_for_field).with('date_facet').and_return(double('date' => true, :query => nil, :helper_method => nil, :url_method => nil, :item_presenter => nil))
       expect(helper.facet_display_value('date_facet', '2012-01-01')).to eq 'Sun, 01 Jan 2012 00:00:00 +0000'
     end
 
     it "localizes the label for date-type facets with the supplied localization options" do
-      allow(helper).to receive(:facet_configuration_for_field).with('date_facet').and_return(double('date' => { format: :short }, :query => nil, :helper_method => nil, :url_method => nil))
+      allow(helper).to receive(:facet_configuration_for_field).with('date_facet').and_return(double('date' => { format: :short }, :query => nil, :helper_method => nil, :url_method => nil, :item_presenter => nil))
       expect(helper.facet_display_value('date_facet', '2012-01-01')).to eq '01 Jan 00:00'
     end
   end

data/spec/models/blacklight/solr/response/facets_spec.rb

@@ -102,6 +102,12 @@ RSpec.describe Blacklight::Solr::Response::Facets, api: true do
         expect(subject.aggregations['my_field'].prefix).to be_nil
       end
     end
+
+    describe '#response' do
+      it 'provides access to the full solr response' do
+        expect(subject.aggregations['my_field'].response).to eq subject
+      end
+    end
   end
 
   describe "#merge_facet" do

data/tasks/blacklight.rake

@@ -21,7 +21,11 @@ def system_with_error_handling(*args)
 end
 
 def with_solr
-  if system('docker-compose -v')
+  # We're being invoked by the app entrypoint script and solr is already up via docker-compose
+  if ENV['SOLR_ENV'] == 'docker-compose'
+    yield
+  elsif system('docker-compose -v')
+    # We're not running docker-compose up but still want to use a docker instance of solr.
     begin
       puts "Starting Solr"
       system_with_error_handling "docker-compose up -d solr"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 7.21.0
+  version: 7.22.1
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2021-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -381,6 +381,7 @@ files:
 - ".babelrc"
 - ".docker/app/Dockerfile"
 - ".docker/app/entrypoint.sh"
+- ".dockerignore"
 - ".env"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -934,7 +935,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)