blacklight 8.6.1 → 8.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afd3fee02b2c13951464a573d0866db0eaf380043fa25564710e30ff3b123cf5
-  data.tar.gz: e89eaca552de439340a25da85e9cd17ced73352cabe6d739d5b8f903eb14214f
+  metadata.gz: 9358af81c0c58fd1a8ccae1fc02815bc703daa08fcd5b249af15c765da98c311
+  data.tar.gz: 3ffdf6aa8da204915f04db78d379a3c995ec85a19527c7191bf2b0e74f652259
 SHA512:
-  metadata.gz: 6eb41e7758a828af27604f1f914b3026892dd08e1d94e9b07b17e1aeef8e8c94050f2578774bdec730a09a12522513f61c2b3c021b02a6b050892e0a8de010b5
-  data.tar.gz: b908484c6b275c4dfffb5821b795f9ad30c1aa88e66cc5cccd343af3c2ac6fbfbc1a437ecc1b0627ea6de68c0c22780b79e9565f992caec248fc1486beebd67a
+  metadata.gz: 967b1417e1988538686c89ddd80caf619be22f5ec5b9cbcffdab89e56c2dc62cf64d712cf46feb8d8d3899d5fadc3f4dbf232a1c980fc136dd8ab3c086a1cfbd
+  data.tar.gz: 4953cfad3da4a16a170e3efaf0f5e9025a1dbb288d2b8f463f47cd3ed7a54f2dc266b2cb18db73f2aea7861cd6639c4fbc8d88a90379f6a5d207dbbb9be22b8c

data/.github/workflows/ruby.yml

@@ -43,6 +43,9 @@ jobs:
         additional_engine_cart_rails_options: [""]
         additional_name: [""]
         include:
+          - ruby: "3.3"
+            rails_version: "8.0.0"
+            additional_engine_cart_rails_options: --css=bootstrap
           - ruby: "3.2"
             rails_version: "6.1.7.8"
           - ruby: "3.2"
@@ -76,7 +79,7 @@ jobs:
       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-coffee --skip-test ${{ matrix.additional_engine_cart_rails_options }}"
+      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
       - name: Set up Ruby

data/VERSION

@@ -1 +1 @@
-8.6.1
+8.7.0

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

@@ -39,16 +39,6 @@
   }
 }
 
-.search-input-group {
-  width: 80%;
-}
-
-@media (max-width: breakpoint-max(xs)) {
-  .search-input-group {
-    width: auto;
-  }
-}
-
 .modal_form {
   margin-bottom: 0;
 }

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

@@ -22,12 +22,12 @@
 
       <%= f.label @query_param, scoped_t('search.label'), class: 'sr-only visually-hidden' %>
       <% if autocomplete_path.present? %>
-        <auto-complete src="<%= autocomplete_path %>" for="autocomplete-popup" class="search-autocomplete-wrapper">
-          <%= f.search_field @query_param, value: @q, placeholder: scoped_t('search.placeholder'), class: "search-q q form-control rounded-#{search_fields.length > 1 ? '0' : 'left'}", autofocus: @autofocus, aria: { label: scoped_t('search.label'), autocomplete: 'list', controls: 'autocomplete-popup' }  %>
+        <auto-complete src="<%= autocomplete_path %>" for="autocomplete-popup" class="search-autocomplete-wrapper <%= rounded_border_class %>">
+          <%= f.search_field @query_param, value: @q, placeholder: scoped_t('search.placeholder'), class: "search-q q form-control #{rounded_border_class}", autofocus: @autofocus, aria: { label: scoped_t('search.label'), autocomplete: 'list', controls: 'autocomplete-popup' }  %>
           <ul id="autocomplete-popup" class="dropdown-menu" role="listbox" aria-label="<%= scoped_t('search.label') %>" hidden></ul>
         </auto-complete>
       <% else %>
-        <%= f.search_field @query_param, value: @q, placeholder: scoped_t('search.placeholder'), class: "search-q q form-control rounded-#{search_fields.length > 1 ? '0' : 'left'}", autofocus: @autofocus, aria: { label: scoped_t('search.label') }  %>
+        <%= f.search_field @query_param, value: @q, placeholder: scoped_t('search.placeholder'), class: "search-q q form-control #{rounded_border_class}", autofocus: @autofocus, aria: { label: scoped_t('search.label') }  %>
       <% end %>
 
       <%= append %>

data/app/components/blacklight/search_bar_component.rb

@@ -60,6 +60,12 @@ module Blacklight
       blacklight_config.advanced_search.enabled
     end
 
+    def rounded_border_class
+      return 'rounded-0' if search_fields.length > 1
+
+      'rounded-left rounded-start'
+    end
+
     private
 
     def blacklight_config

data/app/components/blacklight/skip_link_component.rb

@@ -3,13 +3,19 @@
 module Blacklight
   class SkipLinkComponent < Blacklight::Component
     def link_to_search
-      link_to t('blacklight.skip_links.search_field'), '#search_field', class: link_classes
+      link_to t('blacklight.skip_links.search_field'), search_id, class: link_classes
     end
 
     def link_to_main
       link_to t('blacklight.skip_links.main_content'), '#main-container', class: link_classes
     end
 
+    def search_id
+      return '#search_field' if helpers.blacklight_config.search_fields.values.many? { |field_def| helpers.should_render_field?(field_def) }
+
+      '#q'
+    end
+
     def link_classes
       'd-inline-flex p-2 m-1'
     end

data/blacklight.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.7'
 
-  s.add_dependency "rails", '>= 6.1', '< 8'
+  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
@@ -49,6 +49,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rubocop-capybara"
   s.add_development_dependency "rubocop-rspec_rails"
   s.add_development_dependency "rubocop-factory_bot"
-  s.add_development_dependency "i18n-tasks"
+  s.add_development_dependency "i18n-tasks", '~> 1.0'
   s.add_development_dependency "solr_wrapper"
 end

data/lib/blacklight/solr/search_builder_behavior.rb

@@ -334,7 +334,7 @@ module Blacklight::Solr
 
     ##
     # Convert a facet/value pair into a solr fq parameter
-    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     def facet_value_to_fq_string(facet_field, value, use_local_params: true)
       facet_config = blacklight_config.facet_fields[facet_field]
 
@@ -353,14 +353,16 @@ module Blacklight::Solr
         end
       elsif value.is_a?(Range)
         prefix = "{!#{local_params.join(' ')}}" unless local_params.empty?
-        "#{prefix}#{solr_field}:[#{value.first} TO #{value.last}]"
+        start = value.begin || '*'
+        finish = value.end || '*'
+        "#{prefix}#{solr_field}:[#{start} TO #{finish}]"
       elsif value == Blacklight::SearchState::FilterField::MISSING
         "-#{solr_field}:[* TO *]"
       else
         "{!term f=#{solr_field}#{" #{local_params.join(' ')}" unless local_params.empty?}}#{convert_to_term_value(value)}"
       end
     end
-    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     def facet_inclusive_value_to_fq_string(facet_field, values)
       return if values.blank?

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

@@ -20,6 +20,8 @@ module Blacklight
           CONTENT
         end
 
+        return unless defined?(Sprockets)
+
         append_to_file 'app/assets/config/manifest.js' do
           <<~CONTENT
             //= link blacklight/manifest.js
@@ -28,9 +30,15 @@ module Blacklight
       end
 
       def append_blacklight_javascript
+        # This may already be present if rails new was invoked with `--css bootstrap'
+        append_to_file 'app/javascript/application.js' do
+          <<~CONTENT
+            import * as bootstrap from "bootstrap"
+          CONTENT
+        end
+
         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
@@ -38,13 +46,27 @@ module Blacklight
       end
 
       def add_stylesheet
-        gem "sassc-rails", "~> 2.1" if Rails.version > '7'
+        if File.exist? 'app/assets/stylesheets/application.bootstrap.scss'
+          if ENV['CI']
+            run "yarn add file:#{Blacklight::Engine.root}"
+          else
+            run "yarn add blacklight-frontend@#{Blacklight::VERSION}"
+          end
 
-        create_file 'app/assets/stylesheets/blacklight.scss' do
-          <<~CONTENT
-            @import 'bootstrap';
-            @import 'blacklight/blacklight';
-          CONTENT
+          append_to_file 'app/assets/stylesheets/application.bootstrap.scss' do
+            <<~CONTENT
+              @import "blacklight-frontend/app/assets/stylesheets/blacklight/blacklight";
+            CONTENT
+          end
+        else
+          gem "sassc-rails", "~> 2.1"
+
+          create_file 'app/assets/stylesheets/blacklight.scss' do
+            <<~CONTENT
+              @import 'bootstrap';
+              @import 'blacklight/blacklight';
+            CONTENT
+          end
         end
       end
 

data/lib/generators/blacklight/assets_generator.rb

@@ -7,10 +7,10 @@ module Blacklight
     def run_asset_pipeline_specific_generator
       generated_options = "--bootstrap-version='#{options[:'bootstrap-version']}'" if options[:'bootstrap-version']
 
-      generator = if defined?(Propshaft)
-                    'blacklight:assets:propshaft'
-                  elsif defined?(Importmap)
+      generator = if defined?(Importmap)
                     'blacklight:assets:importmap'
+                  elsif defined?(Propshaft)
+                    'blacklight:assets:propshaft'
                   elsif defined?(Sprockets)
                     'blacklight:assets:sprockets'
                   end

data/lib/generators/blacklight/controller_generator.rb

@@ -31,7 +31,7 @@ module Blacklight
       route <<-EOF
   concern :searchable, Blacklight::Routes::Searchable.new
 
-  resource :catalog, only: [:index], as: 'catalog', path: '/catalog', controller: 'catalog' do
+  resource :catalog, only: [], as: 'catalog', path: '/catalog', controller: 'catalog' do
     concerns :searchable
   end
       EOF

data/lib/generators/blacklight/test_support_generator.rb

@@ -18,7 +18,7 @@ module Blacklight
       copy_file "alternate_controller.rb", "app/controllers/alternate_controller.rb"
 
       routing_code = <<-EOF
-    resource :alternate, controller: 'alternate', only: [:index] do
+    resource :alternate, controller: 'alternate', only: [] do
       concerns :searchable
     end
       EOF

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-frontend",
-  "version": "8.6.1",
+  "version": "8.7.0",
   "description": "The frontend code and styles for Blacklight",
   "main": "app/assets/javascripts/blacklight",
   "type": "module",

data/spec/components/blacklight/search_bar_component_spec.rb

@@ -10,6 +10,7 @@ RSpec.describe Blacklight::SearchBarComponent, type: :component do
   let(:blacklight_config) do
     Blacklight::Configuration.new.configure do |config|
       config.view = { list: nil, abc: nil }
+      config.add_search_field('test_field', label: 'Test Field')
     end
   end
 
@@ -79,4 +80,28 @@ RSpec.describe Blacklight::SearchBarComponent, type: :component do
       expect(render.css("input[name='bar']")).to be_present
     end
   end
+
+  context 'with one search field' do
+    subject(:render) { render_inline(instance) }
+
+    it 'sets the rounded border class' do
+      expect(render.css('.rounded-left.rounded-start')).to be_present
+    end
+  end
+
+  context 'with multiple search fields' do
+    subject(:render) { render_inline(instance) }
+
+    let(:blacklight_config) do
+      Blacklight::Configuration.new.configure do |config|
+        config.view = { list: nil, abc: nil }
+        config.add_search_field('test_field', label: 'Test Field')
+        config.add_search_field('another_field', label: 'Another Field')
+      end
+    end
+
+    it 'sets the rounded border class' do
+      expect(render.css('.rounded-0')).to be_present
+    end
+  end
 end

data/spec/components/blacklight/skip_link_component_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Blacklight::SkipLinkComponent, type: :component do
+  subject(:rendered) do
+    render_inline_to_capybara_node(described_class.new)
+  end
+
+  before do
+    allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
+  end
+
+  context 'with no search fields' do
+    let(:blacklight_config) do
+      Blacklight::Configuration.new.configure do |config|
+        config.search_fields = {}
+      end
+    end
+
+    it 'renders skip links with correct link to search' do
+      expect(rendered).to have_link("Skip to main content", href: '#main-container')
+      expect(rendered).to have_link("Skip to search", href: "#q")
+    end
+  end
+
+  context 'with one search field' do
+    let(:blacklight_config) do
+      Blacklight::Configuration.new.configure do |config|
+        config.search_fields =  { "all_fields" => "" }
+      end
+    end
+
+    it 'renders skip links with correct link to search' do
+      expect(rendered).to have_link("Skip to main content", href: "#main-container")
+      expect(rendered).to have_link("Skip to search", href: "#q")
+    end
+  end
+
+  context 'with two search field' do
+    let(:blacklight_config) do
+      Blacklight::Configuration.new.configure do |config|
+        config.search_fields =  { "all_fields" => "", "title_field" => "" }
+      end
+    end
+
+    it 'renders skip links with correct link to search' do
+      expect(rendered).to have_link("Skip to main content", href: "#main-container")
+      expect(rendered).to have_link("Skip to search", href: "#search_field")
+    end
+  end
+end

data/spec/models/blacklight/solr/search_builder_behavior_spec.rb

@@ -575,6 +575,9 @@ RSpec.describe Blacklight::Solr::SearchBuilderBehavior, :api do
 
     it "handles range requests" do
       expect(subject.send(:facet_value_to_fq_string, "facet_name", 1..5)).to eq "facet_name:[1 TO 5]"
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", 1..nil)).to eq "facet_name:[1 TO *]"
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", nil..5)).to eq "facet_name:[* TO 5]"
+      expect(subject.send(:facet_value_to_fq_string, "facet_name", nil..nil)).to eq "facet_name:[* TO *]"
     end
 
     it "adds tag local parameters" do

data/spec/test_app_templates/Gemfile.extra

@@ -1,4 +1,5 @@
 gem 'rails-controller-testing'
+gem 'rails-i18n', github: 'Shopify/rails-i18n', branch: 'schwad_rails_8'
 
 unless ENV['VIEW_COMPONENT_VERSION'].to_s == ""
   gem 'view_component', ENV.fetch('VIEW_COMPONENT_VERSION')

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -29,12 +29,6 @@ class TestAppGenerator < Rails::Generators::Base
     generate(:'blacklight:test_support')
   end
 
-  def add_local_assets_for_propshaft
-    return unless defined?(Propshaft)
-
-    run "yarn add #{Blacklight::Engine.root}"
-  end
-
   def add_component_template_override
     src_template = File.join(Blacklight::Engine.root, 'app', 'components', 'blacklight', 'top_navbar_component.html.erb')
     target_template = File.join('app', 'components', 'blacklight', 'top_navbar_component.html.erb')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 8.6.1
+  version: 8.7.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-25 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,7 +28,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,7 +38,7 @@ dependencies:
         version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -369,16 +369,16 @@ dependencies:
   name: i18n-tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: solr_wrapper
   requirement: !ruby/object:Gem::Requirement
@@ -848,6 +848,7 @@ files:
 - spec/components/blacklight/search_bar_component_spec.rb
 - spec/components/blacklight/search_context/server_applied_params_component_spec.rb
 - spec/components/blacklight/search_context/server_item_pagination_component_spec.rb
+- spec/components/blacklight/skip_link_component_spec.rb
 - spec/components/blacklight/start_over_button_component_spec.rb
 - spec/components/blacklight/system/flash_message_component_spec.rb
 - spec/controllers/alternate_controller_spec.rb
@@ -1000,7 +1001,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr)
@@ -1030,6 +1031,7 @@ test_files:
 - spec/components/blacklight/search_bar_component_spec.rb
 - spec/components/blacklight/search_context/server_applied_params_component_spec.rb
 - spec/components/blacklight/search_context/server_item_pagination_component_spec.rb
+- spec/components/blacklight/skip_link_component_spec.rb
 - spec/components/blacklight/start_over_button_component_spec.rb
 - spec/components/blacklight/system/flash_message_component_spec.rb
 - spec/controllers/alternate_controller_spec.rb