blacklight 7.5.0 → 7.8.1

data/config/locales/blacklight.de.yml

@@ -22,6 +22,7 @@ de:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'Links überspringen'
       main_content: 'Zum Hauptinhalt gehen'
       search_field: 'Gehen Sie zur Suchleiste'
       first_result: 'Gehe zum ersten Suchergebnis'
@@ -151,6 +152,7 @@ de:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> pro Seite</span>'
         title: 'Anzahl der Ergebnisse, die pro Seite angezeigt werden'
         submit: 'Aktualisieren'
+        aria_label: 'Ergebnisnavigation'
       sort:
         label: 'Ordnen nach %{field}' # TODO: Remove during major release
         label_html: 'Ordnen<span class="d-none d-sm-inline"> nach %{field}</span>'

data/config/locales/blacklight.en.yml

@@ -22,6 +22,7 @@ en:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'Skip links'
       main_content: 'Skip to main content'
       search_field: 'Skip to search'
       first_result: 'Skip to first result'
@@ -151,6 +152,7 @@ en:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> per page</span>'
         title: 'Number of results to display per page'
         submit: 'Update'
+        aria_label: 'Results navigation'
       sort:
         label: 'Sort by %{field}' # TODO: Remove during major release
         label_html: 'Sort<span class="d-none d-sm-inline"> by %{field}</span>'

data/config/locales/blacklight.es.yml

@@ -22,6 +22,7 @@ es:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'Saltar enlaces'
       main_content: 'Saltar al contenido principal'
       search_field: 'Salta a la búsqueda'
       first_result: 'Salta al primer resultado de búsqueda'
@@ -151,6 +152,7 @@ es:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> por página</span>'
         title: 'El número de resultados a mostrar por página'
         submit: 'Actualización'
+        aria_label: 'Navegación de resultados'
       sort:
         label: 'Ordenar por %{field}' # TODO: Remove during major release
         label_html: 'Ordenar<span class="d-none d-sm-inline"> por %{field}</span>'

data/config/locales/blacklight.fr.yml

@@ -22,6 +22,7 @@ fr:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'Sauter les liens'
       main_content: 'Aller au contenu principal'
       search_field: 'Aller à la recherche'
       first_result: 'Aller au premier résultat de recherche'
@@ -154,6 +155,7 @@ fr:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> par page</span>'
         title: 'Nombre de résultats à afficher par page'
         submit: 'mettre à jour'
+        aria_label: 'Navigation dans les résultats'
       sort:
         label: 'Trier par %{field}' # TODO: Remove during major release
         label_html: 'Trier<span class="d-none d-sm-inline"> par %{field}</span>'

data/config/locales/blacklight.hu.yml

@@ -22,6 +22,7 @@ hu:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'átugrani a linkeket'
       main_content: 'Ugrás a tartalomra'
       search_field: 'Ugrás a keresésre'
       first_result: 'Ugrás az első keresési eredményre'
@@ -151,6 +152,7 @@ hu:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> oldalanként</span>'
         title: 'Az eredmények száma oldalanként'
         submit: 'Frissítés'
+        aria_label: 'Eredmények navigáció'
       sort:
         label: 'Rendezés %{field}' # TODO: Remove during major release
         label_html: 'Rendezés<span class="d-none d-sm-inline"> %{field}</span>'

data/config/locales/blacklight.it.yml

@@ -22,6 +22,7 @@ it:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'Saltare i collegamenti'
       main_content: 'Vai al contenuto principale'
       search_field: 'Vai alla ricerca'
       first_result: 'Vai al primo risultato di ricerca'
@@ -151,6 +152,7 @@ it:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> per pagina</span>'
         title: 'Risultati per pagina'
         submit: 'Aggiorna'
+        aria_label: 'Navigazione dei risultati'
       sort:
         label: 'Ordina per %{field}' # TODO: Remove during major release
         label_html: 'Ordina<span class="d-none d-sm-inline"> per %{field}</span>'

data/config/locales/blacklight.nl.yml

@@ -22,6 +22,7 @@ nl:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'links overslaan'
       main_content: 'Ga naar de hoofdinhoud'
       search_field: 'Ga naar de zoekopdracht'
       first_result: 'Ga naar het eerste zoekresultaat'
@@ -151,6 +152,7 @@ nl:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> per pagina</span>'
         title: 'Toon aantal zoekresultaten per pagina'
         submit: 'Update'
+        aria_label: 'Resultaten navigatie'
       sort:
         label: 'Sorteer op %{field}' # TODO: Remove during major release
         label_html: 'Sorteer<span class="d-none d-sm-inline"> op %{field}</span>'

data/config/locales/blacklight.pt-BR.yml

@@ -23,6 +23,7 @@ pt-BR:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'pular links'
       main_content: 'Ir para o conteúdo principal'
       search_field: 'Ir para a pesquisa'
       first_result: 'Ir para o primeiro resultado da pesquisa'
@@ -152,6 +153,7 @@ pt-BR:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> por página</span>'
         title: 'Número de resultados para mostrar por página'
         submit: 'Atualizar'
+        aria_label: 'Navegação de resultados'
       sort:
         label: 'Ordenar por %{field}' # TODO: Remove during major release
         label_html: 'Ordenar<span class="d-none d-sm-inline"> por %{field}</span>'

data/config/locales/blacklight.sq.yml

@@ -22,6 +22,7 @@ sq:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: 'lidhjet e kaloni'
       main_content: 'Shkoni tek përmbajtja kryesore'
       search_field: 'Shkoni në kërkim'
       first_result: 'Shkoni te rezultati i parë i kërkimit'
@@ -151,6 +152,7 @@ sq:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> për faqe</span>'
         title: 'Numri i rezultateve që do të shfaqen për faqe'
         submit: 'Përditëso'
+        aria_label: 'Rezultatet e lundrimit'
       sort:
         label: 'Klasifikoj sipas %{field}' # TODO: Remove during major release
         label_html: 'Klasifikoj<span class="d-none d-sm-inline"> sipas %{field}</span>'

data/config/locales/blacklight.zh.yml

@@ -22,6 +22,7 @@ zh:
   blacklight:
     application_name: 'Blacklight'
     skip_links:
+      label: '跳过链接'
       main_content: '转到主要内容'
       search_field: '转到搜索'
       first_result: '转到第一个搜索结果'
@@ -151,6 +152,7 @@ zh:
         button_label_html: '%{count}<span class="d-none d-sm-inline"> 每页</span>'
         title: '每页显示结果数'
         submit: '更新'
+        aria_label: '结果导航'
       sort:
         label: '按 %{field} 排序' # TODO: Remove during major release
         label_html: '<span class="d-none d-sm-inline">按 %{field} </span>排序'

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/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/nested_open_struct_with_hash_access.rb

@@ -89,7 +89,7 @@ module Blacklight
       len = args.length
 
       if len.zero?
-        new_ostruct_member(mid)
+        new_ostruct_member!(mid)
         @table[mid]
       else
         super

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "7.5.0",
+  "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": {

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