blacklight 7.40.0 → 7.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e1a5889b0f9dee50b64165ffe292482619e54780bac24b14af00b3b1cba2fdd
-  data.tar.gz: 0ed718e93da4bca43bb242e5a97c6ced3546aa8ec9f17d18ce00a444dca95d93
+  metadata.gz: 52a04abd135541f36cb96f7e8538c190b034ca08d2a66a52b46bc7ac22c1ee21
+  data.tar.gz: 26250b77f584c4b7d7316dd51a86fb465444e30c91f3c3bcd6ff5899a8012b65
 SHA512:
-  metadata.gz: ee5a1dc4ddb014510defa98a6c36a3d0e3ef9913c5cce5195878c688d062f7b95e3b30b376558adbc300ce4586f894e2e2af75dac933bc621c5401e2f7cf1eff
-  data.tar.gz: 0cd9ec1e44e68aeae47dbc86f95e18f1402831579b94d942c6ed4e9b264eab2b1f698bbe776616f962b4f6f28b4fe0fedb1e8e6d37aeb4b5be376425cd7d795d
+  metadata.gz: b9c4b32a75d4bbefe63e2cb4e54d2e221d110a152014b7150c124950c8a457da8059ab5ed87a0bbe2a7e0d754914abad0457745366a4060b62878284e95076b6
+  data.tar.gz: aa0a5810de6e1b1eb19a611061b310e093f57179261c3eff3f8e6a8830cb03ef47f5ce22800f2a9a3653a1867842d12786a1d805ee3d3e26e856c5e85d753574

data/.github/matrix.json

@@ -0,0 +1,71 @@
+{
+  "ruby": ["3.3"],
+  "rails_version": [
+    "7.1.5.1",
+    "7.2.2.1"
+  ],
+  "bootstrap_version": [
+    null
+  ],
+  "view_component_version": [
+    "~> 3.12"
+  ],
+  "api": [
+    null
+  ],
+  "additional_engine_cart_rails_options": [
+    ""
+  ],
+  "additional_name": [
+    ""
+  ],
+  "include": [
+    {
+      "ruby": "3.2",
+      "rails_version": "7.1.5.1"
+    },
+    {
+      "ruby": "3.3",
+      "rails_version": "7.1.5.1",
+      "bootstrap_version": "~> 5.0",
+      "additional_name": "| bootstrap 5"
+    },
+    {
+      "ruby": "3.4",
+      "rails_version": "7.2.2.1"
+    },
+    {
+      "ruby": "3.4",
+      "rails_version": "8.0.2"
+    },
+    {
+      "ruby": "3.4",
+      "rails_version": "8.1.3"
+    },
+    {
+      "ruby": "3.4",
+      "rails_version": "8.1.3",
+      "bootstrap_version": "~> 4.0"
+    },
+    {
+      "ruby": "3.3",
+      "rails_version": "7.1.5.1",
+      "view_component_version": "~> 2.74",
+      "additional_name": "| View Component 2"
+    },
+    {
+      "ruby": "3.2",
+      "rails_version": "7.1.5.1",
+      "api": "true",
+      "additional_engine_cart_rails_options": "--api --skip-yarn",
+      "additional_name": "| API"
+    },
+    {
+      "ruby": "3.3",
+      "rails_version": "7.1.5.1",
+      "api:": "true",
+      "additional_engine_cart_rails_options": "--api --skip-yarn",
+      "additional_name": "| API"
+    }
+  ]
+}

data/.github/workflows/build.yml

@@ -0,0 +1,16 @@
+on:
+  workflow_call:
+    inputs:
+      ref:
+        required: false
+        type: string
+        default: ''
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+      - name: Build docker image
+        run: docker compose build app

data/.github/workflows/lint.yml

@@ -0,0 +1,23 @@
+on:
+  workflow_call:
+    inputs:
+      ref:
+        required: false
+        type: string
+        default: ''
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler: "default"
+      - name: Install dependencies
+        run: bundle install
+      - name: Run linter
+        run: bundle exec rake rubocop

data/.github/workflows/main.yml

@@ -0,0 +1,23 @@
+# 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:
+      - main
+      - 'release-*'
+  pull_request:
+
+jobs:
+  lint:
+    uses: ./.github/workflows/lint.yml
+  test:
+    uses: ./.github/workflows/test.yml
+  docker_build:
+    uses: ./.github/workflows/build.yml

data/.github/workflows/test.yml

@@ -0,0 +1,52 @@
+on:
+  workflow_call:
+    inputs:
+      ref:
+        required: false
+        type: string
+        default: ""
+        description: The branch or reference to run the workflow against
+jobs:
+  set_matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.matrix.outputs.matrix }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ inputs.ref }}
+      - name: Echo ./.github/matrix.json
+        id: matrix
+        run: |
+          echo "matrix<<EOF" >> $GITHUB_OUTPUT
+          cat ./.github/matrix.json >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+  test:
+    needs: set_matrix
+    runs-on: ubuntu-latest
+    name: ruby ${{ matrix.ruby }} | rails ${{ matrix.rails_version }} ${{ matrix.additional_name }}
+    strategy:
+      fail-fast: false
+      matrix: ${{fromJson(needs.set_matrix.outputs.matrix)}}
+    env:
+      RAILS_VERSION: ${{ matrix.rails_version }}
+      SOLR_VERSION: ${{ matrix.solr_version || 'latest' }}
+      VIEW_COMPONENT_VERSION: ${{ matrix.view_component_version }}
+      BOOTSTRAP_VERSION: ${{ matrix.bootstrap_version }}
+      BLACKLIGHT_API_TEST: ${{ matrix.api }}
+      ENGINE_CART_RAILS_OPTIONS: "--skip-git --skip-listen --skip-spring --skip-keeps --skip-kamal --skip-solid --skip-coffee --skip-test ${{ matrix.additional_engine_cart_rails_options }}"
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Change permissions
+        run: "chmod -f -R o-w /opt/hostedtoolcache/Ruby/3.2.5/x64/lib/ruby/gems/3.2.0/gems | :"
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake ci

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-capybara
   - rubocop-rails
   - rubocop-rspec

data/.rubocop_todo.yml

@@ -8,12 +8,12 @@
 
 # Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
-Capybara/CurrentPathExpectation:
+Capybara/RSpec/CurrentPathExpectation:
   Exclude:
     - 'spec/features/alternate_controller_spec.rb'
 
 # Offense count: 20
-Capybara/VisibilityMatcher:
+Capybara/RSpec/VisibilityMatcher:
   Exclude:
     - 'spec/features/facets_spec.rb'
     - 'spec/features/search_filters_spec.rb'

data/.solr_wrapper.yml

@@ -1,5 +1,7 @@
 # Place any default configuration for solr_wrapper here
 # port: 8983
+env:
+  SOLR_MODULES: analysis-extras
 collection:
-  dir: lib/generators/blacklight/templates/solr/conf
+  dir: lib/generators/blacklight/templates/solr/
   name: blacklight-core

data/VERSION

@@ -1 +1 @@
-7.40.0
+7.42.0

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

@@ -60,9 +60,7 @@ module Blacklight
         end
       end
 
-      def key
-        @action.key
-      end
+      delegate :key, to: :@action
     end
   end
 end

data/app/components/blacklight/search_context/server_item_pagination_component.html.erb

@@ -0,0 +1,10 @@
+<div class='pagination-search-widgets'>
+
+  <div class="page-links">
+    <%= link_to_previous_document %> |
+
+    <%= item_page_entry_info %> |
+
+    <%= link_to_next_document %>
+  </div>
+</div>

data/app/components/blacklight/search_context/server_item_pagination_component.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module SearchContext
+    class ServerItemPaginationComponent < Blacklight::SearchContextComponent
+      with_collection_parameter :search_context
+
+      def initialize(search_context:, search_session:, current_document:)
+        @search_context = search_context
+        @search_session = search_session
+        @current_document_id = current_document.id
+      end
+    end
+  end
+end

data/app/components/blacklight/search_context_component.rb

@@ -5,6 +5,7 @@ module Blacklight
     with_collection_parameter :search_context
 
     def initialize(search_context:, search_session:)
+      Deprecation.warn("Blacklight::SearchContextComponent is deprecated and will be moved to Blacklight::SearchContext::ServerItemPaginationComponent in Blacklight 8.0.0")
       @search_context = search_context
       @search_session = search_session
     end

data/app/controllers/concerns/blacklight/search_fields.rb

@@ -40,7 +40,7 @@ module Blacklight::SearchFields
   # if not set in blacklight_config, defaults to first field listed in #search_field_list
   # @deprecated
   def default_search_field
-    blacklight_config.default_search_field || (Deprecation.silence(Blacklight::SearchFields) { search_field_list.first })
+    blacklight_config.default_search_field || Deprecation.silence(Blacklight::SearchFields) { search_field_list.first }
   end
   deprecation_deprecate default_search_field: 'Use Blacklight::Configuration#default_search_field'
 end

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -106,7 +106,7 @@ module Blacklight::CatalogHelperBehavior
                                                        total: number_with_delimiter(search_session['total']),
                                                        count: search_session['total'].to_i).html_safe
   end
-  deprecation_deprecate item_page_entry_info: 'Use Blacklight::SearchContextComponent methods instead'
+  deprecation_deprecate item_page_entry_info: 'Use Blacklight::SearchContext::ServerItemPaginationComponent methods instead'
 
   ##
   # Look up search field user-displayable label

data/app/helpers/blacklight/url_helper_behavior.rb

@@ -58,7 +58,7 @@ module Blacklight::UrlHelperBehavior
       tag.span raw(t('views.pagination.previous')), class: 'previous'
     end
   end
-  deprecation_deprecate link_to_previous_document: 'Moving to Blacklight::SearchContextComponent'
+  deprecation_deprecate link_to_previous_document: 'Moving to Blacklight::SearchContext::ServerItemPaginationComponent'
 
   ##
   # Link to the next document in the current search context
@@ -69,7 +69,7 @@ module Blacklight::UrlHelperBehavior
       tag.span raw(t('views.pagination.next')), class: 'next'
     end
   end
-  deprecation_deprecate link_to_previous_document: 'Moving to Blacklight::SearchContextComponent'
+  deprecation_deprecate link_to_previous_document: 'Moving to Blacklight::SearchContext::ServerItemPaginationComponent'
 
   ##
   # Attributes for a link that gives a URL we can use to track clicks for the current search session

data/app/presenters/blacklight/json_presenter.rb

@@ -12,9 +12,7 @@ module Blacklight
 
     attr_reader :blacklight_config
 
-    def documents
-      @response.documents
-    end
+    delegate :documents, to: :@response
 
     # @return [Array<Blacklight::Solr::Response::Facets::FacetField>]
     def search_facets

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

@@ -1,2 +1,2 @@
-<% Deprecation.warn(self, 'The partial _previous_next_doc.html.erb will be removed in 8.0. Render Blacklight::SearchContextComponent instead.') %>
+<% Deprecation.warn(self, 'The partial _previous_next_doc.html.erb will be removed in 8.0. Render Blacklight::SearchContext::ServerItemPaginationComponent instead.') %>
 <%= render(Blacklight::SearchContextComponent.new(search_context: @search_context, search_session: search_session)) %>

data/blacklight.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.7'
 
-  s.add_dependency "rails", '>= 6.1', '< 7.3'
+  s.add_dependency "rails", '>= 6.1', '< 9'
   s.add_dependency "globalid"
   s.add_dependency "jbuilder", '~> 2.7'
   s.add_dependency "kaminari", ">= 0.15" # the pagination (page 1,2,3, etc..) of our search results

data/config/importmap.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+pin_all_from File.expand_path("../app/javascript/blacklight", __dir__), under: "blacklight"

data/docker-compose.yml

@@ -23,6 +23,7 @@ services:
     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
+      - SOLR_MODULES=analysis-extras
     image: "solr:${SOLR_VERSION}"
     volumes:
       - $PWD/lib/generators/blacklight/templates/solr/conf:/opt/solr/conf

data/lib/blacklight/configuration/field.rb

@@ -16,20 +16,20 @@ module Blacklight
 
     def normalize! _blacklight_config = nil
       self.field ||= key
-      self.key ||= self.field
+      self.key ||= field
 
       self.label ||= default_label
 
       self.if = true if self.if.nil?
       self.unless = false if self.unless.nil?
 
-      self.field &&= self.field.to_s
+      self.field &&= field.to_s
 
       self
     end
 
     def validate!
-      raise ArgumentError, "Must supply a field name" if self.field.nil?
+      raise ArgumentError, "Must supply a field name" if field.nil?
     end
 
     def display_label(context = nil, **options)
@@ -43,10 +43,10 @@ module Blacklight
     end
 
     def default_label
-      if self.key.respond_to?(:titleize)
-        self.key.titleize
+      if key.respond_to?(:titleize)
+        key.titleize
       else
-        self.key.to_s.titleize
+        key.to_s.titleize
       end
     end
 

data/lib/blacklight/configuration/sort_field.rb

@@ -9,13 +9,13 @@ module Blacklight
       self.field ||= label&.parameterize
       self.field ||= sort
 
-      self.sort ||= self.field
+      self.sort ||= field
 
       self
     end
 
     def validate!
-      raise ArgumentError.new, "Must supply a sort string" if self.sort.nil?
+      raise ArgumentError.new, "Must supply a sort string" if sort.nil?
     end
   end
 end

data/lib/blacklight/engine.rb

@@ -38,13 +38,18 @@ module Blacklight
       end
     end
 
-    initializer "blacklight.assets.precompile" do
+    initializer "blacklight.assets.precompile" do |app|
       PRECOMPILE_ASSETS = %w(favicon.ico blacklight/blacklight.js blacklight/blacklight.js.map).freeze
 
       # When Rails has been generated in API mode, it does not have sprockets available
-      if Rails.application.config.respond_to?(:assets)
-        Rails.application.config.assets.precompile += PRECOMPILE_ASSETS
-      end
+      next unless app.config.respond_to?(:assets)
+
+      app.config.assets.paths << Engine.root.join("app/javascript")
+      app.config.assets.precompile += PRECOMPILE_ASSETS
+    end
+
+    initializer "blacklight.importmap", before: "importmap" do |app|
+      app.config.importmap.paths << Engine.root.join("config/importmap.rb") if app.config.respond_to?(:importmap)
     end
 
     bl_global_config = OpenStructWithHashAccess.new

data/lib/blacklight/nested_open_struct_with_hash_access.rb

@@ -120,7 +120,7 @@ module Blacklight
 
     def set_default_proc!
       self.default_proc = lambda do |hash, key|
-        hash[key] = nested_class.new(key: key)
+        hash[key] = nested_class.new({ key: key })
       end
     end
   end

data/lib/generators/blacklight/assets/importmap_generator.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Assets
+    class ImportmapGenerator < Rails::Generators::Base
+      class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 5.1'), desc: "Set the generated app's bootstrap version"
+
+      # This could be skipped if you want to use webpacker
+      def add_javascript_dependencies
+        gem 'bootstrap', options[:'bootstrap-version'].presence # in rails 7, only for stylesheets
+        gem 'jquery-rails' if bootstrap_4? # Bootstrap 4 has a dependency on jquery
+      end
+
+      def import_javascript_assets
+        append_to_file 'config/importmap.rb' do
+          <<~CONTENT
+            pin "@github/auto-complete-element", to: "https://cdn.skypack.dev/@github/auto-complete-element"
+            pin "@popperjs/core", to: "https://ga.jspm.io/npm:@popperjs/core@2.11.6/dist/umd/popper.min.js"
+            pin "bootstrap", to: "https://ga.jspm.io/npm:bootstrap@#{(defined?(Bootstrap) && Bootstrap::VERSION) || '5.2.2'}/dist/js/bootstrap.js"
+          CONTENT
+        end
+
+        append_to_file 'app/assets/config/manifest.js' do
+          <<~CONTENT
+            //= link blacklight/manifest.js
+          CONTENT
+        end
+      end
+
+      def append_blacklight_javascript
+        append_to_file 'app/javascript/application.js' do
+          <<~CONTENT
+            import bootstrap from "bootstrap"
+            import githubAutoCompleteElement from "@github/auto-complete-element"
+            import Blacklight from "blacklight"
+          CONTENT
+        end
+      end
+
+      def add_stylesheet
+        gem "sassc-rails", "~> 2.1" if Rails.version > '7'
+
+        create_file 'app/assets/stylesheets/blacklight.scss' do
+          <<~CONTENT
+            @import 'bootstrap';
+            @import 'blacklight/blacklight';
+          CONTENT
+        end
+      end
+
+      def bootstrap_4?
+        options[:'bootstrap-version'].match?(/\A[^0-9]*4\./)
+      end
+    end
+  end
+end

data/lib/generators/blacklight/assets/propshaft_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Assets
+    class PropshaftGenerator < Rails::Generators::Base
+      def add_package
+        if ENV['CI']
+          run "yarn add blacklight-frontend:#{Blacklight::Engine.root}"
+        else
+          run 'yarn add blacklight-frontend'
+        end
+      end
+
+      def add_third_party_packages
+        run 'yarn add @github/auto-complete-element'
+      end
+
+      def add_package_assets
+        append_to_file 'app/assets/stylesheets/application.bootstrap.scss' do
+          <<~CONTENT
+            @import "blacklight-frontend/app/assets/stylesheets/blacklight/blacklight";
+          CONTENT
+        end
+
+        append_to_file 'app/javascript/application.js' do
+          <<~CONTENT
+            import Blacklight from "blacklight-frontend";
+            import githubAutoCompleteElement from "@github/auto-complete-element";
+          CONTENT
+        end
+      end
+    end
+  end
+end

data/lib/generators/blacklight/assets/sprockets_generator.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Assets
+    class SprocketsGenerator < Rails::Generators::Base
+      class_option :'bootstrap-version', type: :string, default: ENV.fetch('BOOTSTRAP_VERSION', '~> 4.0'), desc: "Set the generated app's bootstrap version"
+
+      def replace_propshaft_with_sprockets
+        return if defined?(Sprockets)
+
+        # Rails 8+ defaults to Propshaft, but Blacklight 7.x JS requires Sprockets
+        gsub_file 'Gemfile', /^gem ['"]propshaft['"].*$/, '# \0'
+        gem 'sprockets-rails'
+      end
+
+      def add_javascript_dependencies
+        gem 'bootstrap', options[:'bootstrap-version'].presence
+        gem 'jquery-rails'
+        gem 'twitter-typeahead-rails', '0.11.1.pre.corejavascript'
+      end
+
+      def add_sass_support
+        gem "sassc-rails", "~> 2.1" if Rails.version > '7'
+      end
+
+      def setup_sprockets_manifest
+        if !defined?(Sprockets)
+          # Rails 8+ with Propshaft replaced: create Sprockets config from scratch
+          directory = File.expand_path('app/assets/config', destination_root)
+          FileUtils.mkdir_p(directory)
+          create_file 'app/assets/config/manifest.js' do
+            <<~CONTENT
+              //= link_tree ../images
+              //= link_directory ../stylesheets .css
+              //= link application.js
+            CONTENT
+          end
+          empty_directory 'app/assets/images'
+        elsif defined?(Sprockets::VERSION) && Sprockets::VERSION >= '4'
+          append_to_file 'app/assets/config/manifest.js', "\n//= link application.js"
+          empty_directory 'app/assets/images'
+        end
+      end
+
+      def assets # rubocop:disable Metrics/MethodLength
+        create_file 'app/assets/stylesheets/blacklight.scss' do
+          <<~CONTENT
+            @import 'bootstrap';
+            @import 'blacklight/blacklight';
+          CONTENT
+        end
+
+        # Ensure application.css is a proper Sprockets manifest that loads blacklight styles
+        application_css = File.expand_path('app/assets/stylesheets/application.css', destination_root)
+        if File.exist?(application_css)
+          content = File.read(application_css)
+          unless content.include?('require blacklight')
+            create_file 'app/assets/stylesheets/application.css', force: true do
+              <<~CONTENT
+                /*
+                 *= require blacklight
+                 *= require_self
+                 */
+              CONTENT
+            end
+          end
+        end
+
+        # Ensure this method is idempotent
+        return if has_blacklight_assets?
+
+        create_file 'app/assets/javascripts/application.js' do
+          <<~CONTENT
+            //= require jquery3
+            //= require rails-ujs
+
+            // Required by Blacklight
+            //= require popper
+            // Twitter Typeahead for autocomplete
+            //= require twitter/typeahead
+            //= require bootstrap
+            //= require blacklight/blacklight
+          CONTENT
+        end
+      end
+
+      private
+
+      def has_blacklight_assets?
+        application_js.include?('blacklight/blacklight')
+      end
+
+      def application_js
+        path = File.expand_path("app/assets/javascripts/application.js", destination_root)
+
+        File.exist?(path) ? File.read(path) : ''
+      end
+    end
+  end
+end