blacklight 7.5.1 → 7.9.0

data/docker-compose.yml

@@ -0,0 +1,35 @@
+version: "3.7"
+
+services:
+  app:
+    build:
+      context: .
+      dockerfile: .docker/app/Dockerfile
+      args:
+        - ALPINE_RUBY_VERSION
+    volumes:
+      - .:/app
+    depends_on:
+      - solr
+    ports:
+      - "3000:3000"
+    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:
+    environment:
+      - SOLR_PORT # Set via environment variable or use default defined in .env file
+      - SOLR_VERSION # Set via environment variable or use default defined in .env file
+    image: "solr:${SOLR_VERSION}"
+    volumes:
+      - $PWD/lib/generators/blacklight/templates/solr/conf:/opt/solr/conf
+    ports:
+      - "${SOLR_PORT}:8983"
+    entrypoint:
+      - docker-entrypoint.sh
+      - solr-precreate
+      - blacklight-core
+      - /opt/solr/conf
+      - "-Xms256m"
+      - "-Xmx512m"

data/lib/blacklight/configuration.rb

@@ -282,15 +282,10 @@ module Blacklight
     # Provide a 'deep copy' of Blacklight::Configuration that can be modified without effecting
     # the original Blacklight::Configuration instance.
     #
-    # Rails 4.x provides `#deep_dup`, but it aggressively `#dup`'s class names
-    # too. These model names should not be `#dup`'ed or we might break ActiveModel::Naming.
+    # Note: Rails provides `#deep_dup`, but it aggressively `#dup`'s class names too, turning them
+    # into anonymous class instances.
     def deep_copy
-      deep_dup.tap do |copy|
-        %w(repository_class response_model document_model document_presenter_class search_builder_class facet_paginator_class).each do |klass|
-          # Don't copy if nil, so as not to prematurely autoload default classes
-          copy.send("#{klass}=", send(klass)) unless fetch(klass.to_sym, nil).nil?
-        end
-      end
+      deep_transform_values_in_object(self, &method(:_deep_copy))
     end
 
     # builds a copy for the provided controller class
@@ -402,5 +397,37 @@ module Blacklight
       yield(config) if block_given?
       config_hash[name] = config
     end
+
+    # Provide custom duplication for certain types of configuration (intended for use in e.g. deep_transform_values)
+    def _deep_copy(value)
+      case value
+      when Module then value
+      when NestedOpenStructWithHashAccess then value.class.new(value.nested_class, deep_transform_values_in_object(value.to_h, &method(:_deep_copy)))
+      when OpenStruct then value.class.new(deep_transform_values_in_object(value.to_h, &method(:_deep_copy)))
+      else
+        value.dup
+      end
+    end
+
+    # This is a little shim to support Rails 6 (which has Hash#deep_transform_values) and
+    # earlier versions (which use our backport). Once we drop support for Rails 6, this
+    # can go away.
+    def deep_transform_values_in_object(object, &block)
+      return object.deep_transform_values(&block) if object.respond_to?(:deep_transform_values)
+
+      _deep_transform_values_in_object(object, &block)
+    end
+
+    # Ported from Rails 6
+    def _deep_transform_values_in_object(object, &block)
+      case object
+      when Hash
+        object.transform_values { |value| _deep_transform_values_in_object(value, &block) }
+      when Array
+        object.map { |e| _deep_transform_values_in_object(e, &block) }
+      else
+        yield(object)
+      end
+    end
   end
 end

data/lib/blacklight/configuration/field.rb

@@ -19,12 +19,13 @@ module Blacklight
       raise ArgumentError, "Must supply a field name" if self.field.nil?
     end
 
-    def display_label(context = nil)
+    def display_label(context = nil, **options)
       field_label(
         (:"blacklight.search.fields.#{context}.#{key}" if context),
         :"blacklight.search.fields.#{key}",
         label,
-        default_label
+        default_label,
+        **options
       )
     end
 
@@ -50,10 +51,10 @@ module Blacklight
     #     before falling  back to the label
     #   @param [Symbol] any number of additional keys
     #   @param [Symbol] ...
-    def field_label *i18n_keys
+    def field_label *i18n_keys, **options
       first, *rest = i18n_keys.compact
 
-      I18n.t(first, default: rest)
+      I18n.t(first, default: rest, **options)
     end
   end
 end

data/lib/blacklight/engine.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require 'view_component/engine'
+
 module Blacklight
   class Engine < Rails::Engine
     engine_name "blacklight"
@@ -9,12 +11,6 @@ module Blacklight
       ActionView::Base.send :include, BlacklightHelper
     end
 
-    config.autoload_paths += %W(
-      #{config.root}/app/presenters
-      #{config.root}/app/controllers/concerns
-      #{config.root}/app/models/concerns
-    )
-
     # This makes our rake tasks visible.
     rake_tasks do
       Dir.chdir(File.expand_path(File.join(File.dirname(__FILE__), '..'))) do

data/lib/blacklight/search_state.rb

@@ -37,6 +37,42 @@ module Blacklight
     end
     alias to_h to_hash
 
+    def to_unsafe_h
+      Deprecation.warn(self, 'Use SearchState#to_h instead of SearchState#to_unsafe_h')
+      to_hash
+    end
+
+    def method_missing(method_name, *arguments, &block)
+      if @params.respond_to?(method_name)
+        Deprecation.warn(self, "Calling `#{method_name}` on Blacklight::SearchState " \
+          'is deprecated and will be removed in Blacklight 8. Call #to_h first if you ' \
+          ' need to use hash methods (or, preferably, use your own SearchState implementation)')
+        @params.public_send(method_name, *arguments, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @params.respond_to?(method_name, include_private) || super
+    end
+
+    # Tiny shim to make it easier to migrate raw params access to using this class
+    delegate :[], to: :params
+    deprecation_deprecate :[]
+
+    def has_constraints?
+      !(query_param.blank? && filter_params.blank?)
+    end
+
+    def query_param
+      params[:q]
+    end
+
+    def filter_params
+      params[:f] || {}
+    end
+
     def reset(params = nil)
       self.class.new(params || ActionController::Parameters.new, blacklight_config, controller)
     end
@@ -57,6 +93,12 @@ module Blacklight
       end
     end
 
+    def remove_query_params
+      p = reset_search_params
+      p.delete(:q)
+      p
+    end
+
     # adds the value and/or field to params[:f]
     # Does NOT remove request keys and otherwise ensure that the hash
     # is suitable for a redirect. See
@@ -130,6 +172,16 @@ module Blacklight
       p
     end
 
+    def has_facet?(config, value: nil)
+      facet = params&.dig(:f, config.key)
+
+      if value
+        (facet || []).include? value
+      else
+        facet.present?
+      end
+    end
+
     # Merge the source params with the params_to_merge hash
     # @param [Hash] params_to_merge to merge into above
     # @return [ActionController::Parameters] the current search parameters after being sanitized by Blacklight::Parameters.sanitize

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

@@ -210,6 +210,8 @@ module Blacklight::Solr::Response::Facets
         Blacklight::Solr::Response::Facets::FacetItem.new(value: key, hits: hits, label: facet_field.query[key][:label])
       end
 
+      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
     end
   end

data/lib/generators/blacklight/assets_generator.rb

@@ -22,6 +22,16 @@ module Blacklight
       end
     end
 
+    ##
+    # Remove the empty generated app/assets/images directory. Without doing this,
+    # the default Sprockets 4 manifest will raise an exception.
+    def appease_sprockets4
+      return if !defined?(Sprockets::VERSION) || Sprockets::VERSION < '4'
+
+      append_to_file 'app/assets/config/manifest.js', "\n//= link application.js"
+      empty_directory 'app/assets/images'
+    end
+
     def assets
       copy_file "blacklight.scss", "app/assets/stylesheets/blacklight.scss"
 

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -84,7 +84,7 @@ class <%= controller_name.classify %>Controller < ApplicationController
     config.add_facet_field 'subject_geo_ssim', label: 'Region'
     config.add_facet_field 'subject_era_ssim', label: 'Era'
 
-    config.add_facet_field 'example_pivot_field', label: 'Pivot Field', :pivot => ['format', 'language_ssim']
+    config.add_facet_field 'example_pivot_field', label: 'Pivot Field', pivot: ['format', 'language_ssim'], collapsing: true
 
     config.add_facet_field 'example_query_facet_field', label: 'Publish Date', :query => {
        :years_5 => { label: 'within 5 Years', fq: "pub_date_ssim:[#{Time.zone.now.year - 5 } TO *]" },

data/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "7.1.0",
+  "version": "7.7.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -1884,9 +1884,9 @@
       "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE="
     },
     "jquery": {
-      "version": "3.4.1",
-      "resolved": "https://registry.npmjs.org/jquery/-/jquery-3.4.1.tgz",
-      "integrity": "sha512-36+AdBzCL+y6qjw5Tx7HgzeGCzC81MDDgaUP8ld2zhx58HdqXGoBd+tHdrBMiyjGQs0Hxs/MLZTu/eHNJJuWPw=="
+      "version": "3.5.1",
+      "resolved": "https://registry.npmjs.org/jquery/-/jquery-3.5.1.tgz",
+      "integrity": "sha512-XwIBPqcMn57FxfT+Go5pzySnm4KWkT1Tv7gjrpT1srtf8Weynl6R273VJ5GjkRb51IzMp5nbaPjJXMWeju2MKg=="
     },
     "js-tokens": {
       "version": "4.0.0",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "7.5.1",
+  "version": "7.7.0",
   "description": "[![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) [![Coverage Status](https://coveralls.io/repos/github/projectblacklight/blacklight/badge.svg?branch=master)](https://coveralls.io/github/projectblacklight/blacklight?branch=master)",
   "main": "app/assets/javascripts/blacklight",
   "scripts": {
@@ -24,7 +24,7 @@
   "dependencies": {
     "bloodhound-js": "^1.2.3",
     "bootstrap": "^4.3.1",
-    "jquery": "^3.4.1",
+    "jquery": "^3.5.1",
     "typeahead.js": "^0.11.1"
   }
 }

data/spec/{views/catalog/_constraints_element.html.erb_spec.rb → components/blacklight/constraint_layout_component_spec.rb}

@@ -1,24 +1,34 @@
 # frozen_string_literal: true
 
-RSpec.describe "catalog/_constraints_element.html.erb" do
+require 'spec_helper'
+
+RSpec.describe Blacklight::ConstraintLayoutComponent, type: :component do
+  subject(:render) do
+    render_inline(described_class.new(params))
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
   describe "for simple display" do
-    before do
-      render partial: "catalog/constraints_element", locals: { label: "my label", value: "my value" }
+    let(:params) do
+      { label: "my label", value: "my value" }
     end
 
     it "renders label and value" do
       expect(rendered).to have_selector("span.applied-filter.constraint") do |s|
         expect(s).to have_css("span.constraint-value")
         expect(s).not_to have_css("a.constraint-value")
-        expect(s).to have_selector "span.filter-name", content: "my label"
-        expect(s).to have_selector "span.filter-value", content: "my value"
+        expect(s).to have_selector "span.filter-name", text: "my label"
+        expect(s).to have_selector "span.filter-value", text: "my value"
       end
     end
   end
 
   describe "with remove link" do
-    before do
-      render partial: "catalog/constraints_element", locals: { label: "my label", value: "my value", options: { remove: "http://remove" } }
+    let(:params) do
+      { label: "my label", value: "my value", remove_path: "http://remove" }
     end
 
     it "includes remove link" do
@@ -28,14 +38,14 @@ RSpec.describe "catalog/_constraints_element.html.erb" do
     end
     it "has an accessible remove label" do
       expect(rendered).to have_selector(".remove") do |s|
-        expect(s).to have_content("Remove constraint my label: my value")
+        expect(s).to have_selector('.sr-only', text: 'Remove constraint my label: my value')
       end
     end
   end
 
   describe "with custom classes" do
-    before do
-      render partial: "catalog/constraints_element", locals: { label: "my label", value: "my value", options: { classes: %w[class1 class2] } }
+    let(:params) do
+      { label: "my label", value: "my value", classes: %w[class1 class2] }
     end
 
     it "includes them" do
@@ -44,8 +54,8 @@ RSpec.describe "catalog/_constraints_element.html.erb" do
   end
 
   describe "with no escaping" do
-    before do
-      render(partial: "catalog/constraints_element", locals: { label: "<span class='custom_label'>my label</span>".html_safe, value: "<span class='custom_value'>my value</span>".html_safe })
+    let(:params) do
+      { label: "<span class='custom_label'>my label</span>".html_safe, value: "<span class='custom_value'>my value</span>".html_safe }
     end
 
     it "does not escape key and value" do

data/spec/components/blacklight/facet_field_list_component_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::FacetFieldListComponent, type: :component do
+  subject(:render) do
+    render_inline(described_class.new(facet_field: facet_field))
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
+  let(:facet_field) do
+    instance_double(
+      Blacklight::FacetFieldPresenter,
+      paginator: paginator,
+      key: 'field',
+      label: 'Field',
+      active?: false,
+      collapsed?: false,
+      modal_path: nil,
+      html_id: 'facet-field'
+    )
+  end
+
+  let(:paginator) do
+    instance_double(Blacklight::FacetPaginator, items: [
+                      double(label: 'x', hits: 10),
+                      double(label: 'y', hits: 33)
+                    ])
+  end
+
+  it 'renders a collapsible card' do
+    expect(rendered).to have_selector '.card'
+    expect(rendered).to have_button 'Field'
+    expect(rendered).to have_selector 'button[data-target="#facet-field"]'
+    expect(rendered).to have_selector '#facet-field.collapse.show'
+  end
+
+  it 'renders the facet items' do
+    expect(rendered).to have_selector 'ul.facet-values'
+    expect(rendered).to have_selector 'li', count: 2
+  end
+
+  context 'with an active facet' do
+    let(:facet_field) do
+      instance_double(
+        Blacklight::FacetFieldPresenter,
+        paginator: paginator,
+        key: 'field',
+        label: 'Field',
+        active?: true,
+        collapsed?: false,
+        modal_path: nil,
+        html_id: 'facet-field'
+      )
+    end
+
+    it 'adds the facet-limit-active class' do
+      expect(rendered).to have_selector 'div.facet-limit-active'
+    end
+  end
+
+  context 'with a collapsed facet' do
+    let(:facet_field) do
+      instance_double(
+        Blacklight::FacetFieldPresenter,
+        paginator: paginator,
+        key: 'field',
+        label: 'Field',
+        active?: false,
+        collapsed?: true,
+        modal_path: nil,
+        html_id: 'facet-field'
+      )
+    end
+
+    it 'renders a collapsed facet' do
+      expect(rendered).to have_selector '.facet-content.collapse'
+      expect(rendered).not_to have_selector '.facet-content.collapse.show'
+    end
+
+    it 'renders the toggle button in the collapsed state' do
+      expect(rendered).to have_selector '.btn.collapsed'
+      expect(rendered).to have_selector '.btn[aria-expanded="false"]'
+    end
+  end
+
+  context 'with a modal_path' do
+    let(:facet_field) do
+      instance_double(
+        Blacklight::FacetFieldPresenter,
+        paginator: paginator,
+        key: 'field',
+        label: 'Field',
+        active?: false,
+        collapsed?: false,
+        modal_path: '/catalog/facet/modal',
+        html_id: 'facet-field'
+      )
+    end
+
+    it 'renders a link to the modal' do
+      expect(rendered).to have_link 'more Field', href: '/catalog/facet/modal'
+    end
+  end
+end