blacklight_range_limit 9.0.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e201cd7f8b701d21bf9e6b97410f4559b10a727ac170941acbafbf30ca42d2b
-  data.tar.gz: eacc2e3ec1f19a84436f36b0ae5379ad8af4a1c0895c7f4bf0aabe743301407c
+  metadata.gz: cb2770ee329bb6bc941864e6e371eab6f676a5aba369c9ece4aebb244703089d
+  data.tar.gz: ed51729efb72aa983fbe046995ab9b633cd31923a083f05579912b496a192942
 SHA512:
-  metadata.gz: ebe7cd1f8b4aff796900985f5f5b2ef1d38191ef2682d331963a18f715191d266ca41de8f3b6882ebd0de5556ed6a4bf0c0486bd1229eb80890b06cf50898b2a
-  data.tar.gz: e678a32a7854cb0310e834ece0f4d82577829288a03eb7944665f1f799dfb4178bae51ddb36c90a8550064d0162edc19b25d9465641b6004d3ce1eb63853210a
+  metadata.gz: f40f9917b407aa32b7cb5b0040fd69dde006f911cea0470ddf56c885985e84232ac70488db753a8b3d07efae7e48e3915474f98e9832ad1518c279e5de0347e8
+  data.tar.gz: faa8fe7325e92e8cc8694b67c89229c9f346471f06415069b0c5736efa797a1dba040e4b5033559639c36ac52ea21a05b5699b3ab081530aca23d2712bc342a5

data/.github/workflows/ruby.yml

@@ -12,6 +12,8 @@ on:
     branches: [main]
   pull_request:
     branches: ['**']
+  schedule:
+    - cron: "0 2 * * TUE"
 
 jobs:
   test:
@@ -24,47 +26,97 @@ jobs:
         #
         #   * Blacklight: 7, 8, or 9
         #   * Rails: 7 or 8
-        #   * sprockets or propshaft(with cssbundling-rails sass)
-        #   * importmap-rails or esbuild  (each with sprockets or importmaps)
+        #   * sprockets or propshaft (with cssbundling-rails sass)
+        #   * importmap-rails or esbuild (each with sprockets or importmaps)
         #
         # We should work with almost every combo of these (even though BL itself
         # doesn't officially support every one), but we don't test with every one,
         # that'd be too much. Plus BL can't *generate* every one even though it
         # can be made to work with every one. We test with some good significant
         # representative samples.
+        #
+        # If 'blacklight_version' includes `://`, will be understood as github url,
+        # used for testing off blacklight main.
 
         include:
-          # BLACKLIGHT EDGE, can test with Rails 8 beta, importmap and esbuild
+          # BLACKLIGHT EDGE, can test with latest rails, importmap and esbuild
           #
 
-          - rails_version: "~> 8.0.0"
-            blacklight_version: '{ "git": "https://github.com/projectblacklight/blacklight.git" }'
+          - rails_version: "~> 8.1.0.rc1"
+            blacklight_version: 'https://github.com/projectblacklight/blacklight.git'
             ruby: "3.3"
             additional_name: "/ importmap-rails"
             additional_engine_cart_rails_options: "--css=bootstrap"
-          - rails_version: "~> 8.0.0"
-            blacklight_version: '{ "git": "https://github.com/projectblacklight/blacklight.git" }'
+
+          - rails_version: "~> 8.1.0.rc1"
+            blacklight_version: 'https://github.com/projectblacklight/blacklight.git'
             ruby: "3.3"
             additional_name: "/ esbuild"
             additional_engine_cart_rails_options: "--css=bootstrap --javascript=esbuild"
 
+          # BLACKLIGHT 9 and with Rails 8 and 8.1
+          #
+
+          - rails_version: "~> 8.1.0.rc1"
+            blacklight_version: '~> 9.0'
+            ruby: "3.4"
+            additional_name: "/ importmap-rails"
+            additional_engine_cart_rails_options: "--css=bootstrap"
 
+          - rails_version: "~> 8.1.0.rc1"
+            blacklight_version: '~> 9.0'
+            ruby: "3.4"
+            additional_name: "/ esbuild"
+            additional_engine_cart_rails_options: "--css=bootstrap --javascript=esbuild"
 
-          # BLACKLIGHT 8, can test with use importmaps and esbuild
-          #
+          - rails_version: "~> 8.0.0"
+            blacklight_version: '~> 9.0'
+            ruby: "3.4"
+            additional_name: "/ importmap-rails"
+            additional_engine_cart_rails_options: "--css=bootstrap"
+
+          - rails_version: "~> 8.0.0"
+            blacklight_version: '~> 9.0'
+            ruby: "3.4"
+            additional_name: "/ esbuild"
+            additional_engine_cart_rails_options: "--css=bootstrap --javascript=esbuild"
+
+
+          # BLACKLIGHT 8, can test with use importmaps and esbuild, also rails 8 and 8.1
+          # and a bit of 7.2
+
+          - rails_version: "~> 8.1.0.rc1"
+            blacklight_version: "~> 8.0"
+            ruby: "3.3"
+            additional_name: "/ importmap-rails, propshaft"
+            additional_engine_cart_rails_options: "-a propshaft --css=bootstrap"
+
+          - rails_version: "~> 8.1.0.rc1"
+            blacklight_version: "~> 8.0"
+            ruby: "3.3"
+            additional_engine_cart_rails_options: "-a propshaft --javascript=esbuild --css=bootstrap"
+            additional_name: "/ esbuild, propshaft"
+
+          - rails_version: "~> 8.0.0"
+            blacklight_version: "~> 8.0"
+            ruby: "3.3"
+            additional_name: "/ importmap-rails, propshaft"
+            additional_engine_cart_rails_options: "-a propshaft --css=bootstrap"
 
           - rails_version: "7.2.1"
             blacklight_version: "~> 8.0"
             ruby: "3.3"
             additional_name: "/ importmap-rails, sprockets"
+
           - rails_version: "7.2.1"
             blacklight_version: "~> 8.0"
             ruby: "3.3"
             additional_name: "/ importmap-rails, propshaft"
             additional_engine_cart_rails_options: "-a propshaft --css=bootstrap"
+
           - rails_version: "7.2.1"
             blacklight_version: "~> 8.0"
-            ruby: 3.3
+            ruby: "3.3"
             additional_engine_cart_rails_options: "-a propshaft --javascript=esbuild --css=bootstrap"
             additional_name: "/ esbuild, propshaft"
 
@@ -73,12 +125,11 @@ jobs:
             # * Blacklight 8 can't easily generate an app with Rails 7 and sprockets and esbuild
             #   (the default layout won't be right), although I think it should work fine.
             #
-            # * Can't test with unreleaed Blacklight main and esbuild because the blacklight-frontend
-            #   npm package doens't work from git checkout.  So currently can't test with Rails8
+            # * Can't test with unreleased Blacklight main and esbuild because the blacklight-frontend
+            #   npm package doesn't work from git checkout.  So currently can't test with Rails 8
             #   and esbuild.
 
 
-
           # BLACKLIGHT 7, only test with esbuild, not sure if it supports importmaps, it won't generate it
 
           - rails_version: "7.2.1"
@@ -86,6 +137,7 @@ jobs:
             ruby: "3.3"
             additional_engine_cart_rails_options: "--javascript=esbuild"
             additional_name: "/ esbuild, sprockets"
+
           - rails_version: "7.2.1"
             blacklight_version: "~> 7.0"
             ruby: "3.3"
@@ -98,15 +150,6 @@ jobs:
             additional_engine_cart_rails_options: "--javascript=esbuild"
             additional_name: "/ esbuild, sprockets"
 
-          - rails_version: "7.0.8.4"
-            blacklight_version: "~> 7.0"
-            ruby: "3.1"
-            additional_engine_cart_rails_options: "--javascript=esbuild"
-            additional_name: "/ esbuild, sprockets"
-
-
-
-
 
     env:
       BLACKLIGHT_VERSION: ${{ matrix.blacklight_version || '~> 8.0' }}

data/Gemfile

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-require 'json'
 
 source 'https://rubygems.org'
 
@@ -10,14 +9,9 @@ group :test do
   gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
 end
 
-# While gemspec allows BL8 and some people are using BL8... the build
-# has never actually passed on BL8 yet. We may choose to run tests on
-# a blacklight version other than the latest allowed by gemspec, to get
-# tests to pass, or to test on older BL still supported here.
 if ENV['BLACKLIGHT_VERSION']
-  # allow direct git and other with serialized json kw args
-  if ENV['BLACKLIGHT_VERSION'].start_with?("{")
-    gem "blacklight", **JSON.parse(ENV['BLACKLIGHT_VERSION'])
+  if ENV['BLACKLIGHT_VERSION'].include?("://")
+    gem "blacklight", git: ENV['BLACKLIGHT_VERSION']
   else
     gem "blacklight", ENV['BLACKLIGHT_VERSION']
   end
@@ -45,16 +39,6 @@ else
     else
       gem 'rails', ENV['RAILS_VERSION']
     end
-
-    case ENV['RAILS_VERSION']
-    when /^6.0/
-      gem 'sass-rails', '>= 6'
-      gem 'webpacker', '~> 4.0'
-    when /^5.[12]/
-      gem 'sass-rails', '~> 5.0'
-      gem 'sprockets', '~> 3.7'
-      gem 'thor', '~> 0.20'
-    end
   end
 end
 # END ENGINE_CART BLOCK

data/README.md

@@ -173,6 +173,8 @@ bundle exec rspec spec/features/blacklight_range_limit_spec.rb
 
 Once you are done iterating on your test you will need to stop the application server with `Ctrl-C`.
 
-# Publishing Javascript
+# Release process
 
-run `npm publish` to push the javascript package to https://npmjs.org/package/blacklight-range-limit
+Make sure you adjust version to match in both `VERSION` *and* `package.json` file.
+
+Release rubygem with `bundle exec rake release` and also be sure to release npm package by running `npm publish` to push the javascript package to https://npmjs.org/package/blacklight-range-limit

data/VERSION

@@ -1 +1 @@
-9.0.0
+9.2.0

data/app/components/blacklight_range_limit/range_facet_component.rb

@@ -6,7 +6,16 @@ module BlacklightRangeLimit
 
     def initialize(facet_field:, layout: nil, classes: BlacklightRangeLimit.classes)
       @facet_field = facet_field
-      @layout = layout == false ? Blacklight::FacetFieldNoLayoutComponent : Blacklight::FacetFieldComponent
+      @layout = if layout == false
+                  Blacklight::FacetFieldNoLayoutComponent
+                elsif layout
+                  layout
+                elsif defined?(Blacklight::Facets::FacetFieldComponent)
+                  Blacklight::Facets::FacetFieldComponent # Blacklight 9
+                else
+                  Blacklight::FacetFieldComponent # Blacklight < 9
+                end
+
       @classes = classes
     end
 
@@ -39,7 +48,7 @@ module BlacklightRangeLimit
       min = @facet_field.selected_range_facet_item&.value&.begin || @facet_field.min
       max = @facet_field.selected_range_facet_item&.value&.end || @facet_field.max
 
-      return nil unless (min && max)
+      return nil unless min && max
 
       range_limit_url(range_start: min, range_end: max)
     end

data/app/components/blacklight_range_limit/range_form_component.html.erb

@@ -3,25 +3,21 @@
 
   <div class="range-limit-input-group">
     <div class="d-flex justify-content-between align-items-end">
-      <div class="d-flex flex-column mr-1 me-1">
-        <%= label_tag(begin_input_name, t("blacklight.range_limit.range_begin_short"), class: 'text-muted small mb-1') %>
-        <%= number_field_tag(begin_input_name,
-                              begin_value_default,
-                              min: range_config[:min_value],
-                              max: range_config[:max_value],
-                              class: "form-control form-control-sm range_begin")
-        %>
-      </div>
+      <%= render BlacklightRangeLimit::RangeInputComponent.new(
+        input_name: begin_input_name,
+        input_value: begin_value_default,
+        label_text: t("blacklight.range_limit.range_begin_short"),
+        min_value: range_config[:min_value],
+        max_value: range_config[:max_value],
+        css_class: "range_begin") %>
 
-      <div class="d-flex flex-column ml-1 ms-1">
-        <%= label_tag(end_input_name, t("blacklight.range_limit.range_end_short"), class: 'text-muted small mb-1') %>
-        <%= number_field_tag(end_input_name,
-                              end_value_default,
-                              min: range_config[:min_value],
-                              max: range_config[:max_value],
-                              class: "form-control form-control-sm range_end")
-        %>
-      </div>
+      <%= render BlacklightRangeLimit::RangeInputComponent.new(
+        input_name: end_input_name,
+        input_value: end_value_default,
+        label_text: t("blacklight.range_limit.range_end_short"),
+        min_value: range_config[:min_value],
+        max_value: range_config[:max_value],
+        css_class: "range_end") %>
     </div>
     <div class="d-flex justify-content-end mt-2">
       <%= submit_tag t('blacklight.range_limit.submit_limit'), class: @classes[:submit], name: nil %>

data/app/components/blacklight_range_limit/range_input_component.html.erb

@@ -0,0 +1,9 @@
+<div class="d-flex flex-column mr-1 me-1">
+  <%= label_tag @input_name, @label_text, class: 'text-muted small mb-1' %>
+  <%= number_field_tag @input_name,
+    @input_value,
+    min: @min_value,
+    max: @max_value,
+    class: "form-control form-control-sm #{@css_class}" %>
+</div>
+

data/app/components/blacklight_range_limit/range_input_component.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BlacklightRangeLimit
+  class RangeInputComponent < Blacklight::Component
+      def initialize(input_name:, input_value:, label_text:, min_value:, max_value:, css_class:)
+        @input_name = input_name
+        @input_value = input_value
+        @label_text = label_text
+        @min_value = min_value
+        @max_value = max_value
+        @css_class = css_class
+      end
+  end
+end

data/app/components/blacklight_range_limit/range_segments_component.rb

@@ -3,11 +3,14 @@
 module BlacklightRangeLimit
   class RangeSegmentsComponent < Blacklight::Component
     def initialize(facet_field:, facet_items: nil, item_component: nil, classes: [])
-      super
+      super()
 
       @facet_field = facet_field
       @facet_items = facet_items || facet_field.try(:range_queries) || []
-      @item_component = facet_field.facet_field.item_component || Blacklight::FacetItemComponent
+      # newer versions of BL9 want Blacklight::Facets::ItemComponent -- the older one is supposed
+      # to be deprecated, but in fact may not work so we use newer if avail.
+      @item_component = facet_field.facet_field.item_component ||
+        (defined?(Blacklight::Facets::ItemComponent) ? Blacklight::Facets::ItemComponent : Blacklight::FacetItemComponent)
       @classes = classes
     end
 

data/blacklight_range_limit.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |s|
 
   s.license     = 'Apache 2.0'
 
-  s.add_dependency 'blacklight', '>= 7.25.2', '< 9'
-  s.add_dependency 'view_component', ">= 2.54", "< 4"
+  s.add_dependency 'blacklight', '>= 7.25.2', '< 10'
+  s.add_dependency 'view_component', ">= 2.54", "< 5"
 
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-rails'

data/lib/blacklight_range_limit/controller_override.rb

@@ -8,18 +8,17 @@ module BlacklightRangeLimit
 
     RANGE_LIMIT_FIELDS = [:range_end, :range_field, :range_start].freeze
 
+    included do
+      # have to do this in before_action so it's done before any application level
+      # before_actions, that might do something that needs it
+      before_action :_range_limit_add_search_state_fields, only: :range_limit
+    end
+
     # Action method of our own!
     # Delivers a _partial_ that's a display of a single fields range facets.
     # Used when we need a second Solr query to get range facets, after the
     # first found min/max from result set.
     def range_limit
-      # The builder in this action will need our special range_limit fields, so we
-      # must allow them.
-      if blacklight_config.search_state_fields
-        missing_keys = RANGE_LIMIT_FIELDS - blacklight_config.search_state_fields
-        blacklight_config.search_state_fields.concat(missing_keys)
-      end
-
       @facet = blacklight_config.facet_fields[params[:range_field]]
       raise ActionController::RoutingError, 'Not Found' unless @facet&.range
 
@@ -40,6 +39,14 @@ module BlacklightRangeLimit
       render BlacklightRangeLimit::RangeSegmentsComponent.new(facet_field: @presenter), layout: !request.xhr?
     end
 
+    def _range_limit_add_search_state_fields
+      # The builder in this action will need our special range_limit fields, so we
+      # must allow them.
+      blacklight_config.search_state_fields ||= []
+      missing_keys = RANGE_LIMIT_FIELDS - blacklight_config.search_state_fields
+      blacklight_config.search_state_fields.concat(missing_keys)
+    end
+
     class_methods do
       def default_range_config
         BlacklightRangeLimit.default_range_config

data/lib/blacklight_range_limit/routes/range_searchable.rb

@@ -9,7 +9,6 @@ module BlacklightRangeLimit
         options = @defaults.merge(options)
 
         mapper.get 'range_limit', action: 'range_limit'
-        mapper.get 'range_limit_panel/:id', action: 'range_limit_panel'
       end
     end
   end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-range-limit",
-  "version": "9.0.0",
+  "version": "9.2.0",
   "description": "A range facet UI component plugin for blacklight",
   "type": "module",
 

data/spec/spec_helper.rb

@@ -44,8 +44,8 @@ RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
 
   config.include PresenterTestHelpers, type: :presenter
+  config.include ViewComponent::TestHelpers, type: :presenter
   config.include ViewComponent::TestHelpers, type: :component
 
   config.example_status_persistence_file_path = 'spec/examples.txt'
-
 end

data/spec/support/presenter_test_helpers.rb

@@ -2,7 +2,9 @@
 
 module PresenterTestHelpers
   def controller
-    @controller ||= ViewComponent::Base.test_controller.constantize.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
+    # view_component 3+ should be just `vc_test_controller_class` when we drop VC 2 support we can
+    # just use that.
+    @controller ||= (respond_to?(:vc_test_controller_class) ? vc_test_controller_class : ApplicationController).new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
   end
 
   def request

data/spec/test_app_templates/Gemfile.extra

@@ -1,10 +1,8 @@
 gem 'rails-controller-testing'
 
 if ENV['BLACKLIGHT_VERSION']
-  # allow direct git and other with serialized json kw args
-  require 'json'
-  if ENV['BLACKLIGHT_VERSION'].start_with?("{")
-    gem "blacklight", **JSON.parse(ENV['BLACKLIGHT_VERSION'])
+  if ENV['BLACKLIGHT_VERSION'].include?("://")
+    gem "blacklight", git: ENV['BLACKLIGHT_VERSION']
   else
     gem "blacklight", ENV['BLACKLIGHT_VERSION']
   end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.2.0
 platform: ruby
 authors:
 - Jonathan Rochkind
 - Chris Beer
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -20,7 +19,7 @@ dependencies:
         version: 7.25.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +29,7 @@ dependencies:
         version: 7.25.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
@@ -40,7 +39,7 @@ dependencies:
         version: '2.54'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -50,7 +49,7 @@ dependencies:
         version: '2.54'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +176,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.13.1
-description:
 email:
 - blacklight-development@googlegroups.com
 executables: []
@@ -198,6 +196,8 @@ files:
 - app/components/blacklight_range_limit/range_facet_component.rb
 - app/components/blacklight_range_limit/range_form_component.html.erb
 - app/components/blacklight_range_limit/range_form_component.rb
+- app/components/blacklight_range_limit/range_input_component.html.erb
+- app/components/blacklight_range_limit/range_input_component.rb
 - app/components/blacklight_range_limit/range_segments_component.html.erb
 - app/components/blacklight_range_limit/range_segments_component.rb
 - app/presenters/blacklight_range_limit/facet_field_presenter.rb
@@ -268,7 +268,6 @@ homepage: https://github.com/projectblacklight/blacklight_range_limit
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -283,8 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Blacklight Range Limit plugin
 test_files: