blacklight_range_limit 9.0.0.beta2 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfe80b379721a4e19e01ecb97a0f1ca6335e2e85ae3914abec0f2ae9ee9546b6
-  data.tar.gz: cdc7468b2f1e7f649f72a9f4200948cbc543d9f1e6a86bcac03b467c65b18ba2
+  metadata.gz: 1eb86d2b4a964fa439b38733a97efb61faa03e3db7a4a51a0ffa4daea379fe9d
+  data.tar.gz: 2444a4e758791ecb567d8f2f3aa0ee16a14a8cd20e3b4652a4b1b565a9511f0f
 SHA512:
-  metadata.gz: df819d6ceb0f782c612d1eb83648a178ed2f555b599df666240cfa2cc7a75d0b3554ff29ff12ada5bdf3766bb74be88b76d054a95fd233d41309d2737bcb6cf2
-  data.tar.gz: 269df83223ddbed2fa371c9b0aa1ebc6d5afff775d5a313a6482ba8948412456b59bbe7b1b438e51143fe2941c3e643b3ba98f5a918287ce32b4867542871c69
+  metadata.gz: 423928f6a8c0b71b04a8ac60a4bff7b2581aacb0a398bb4d7c933ba6c87e4b92540871e9709870e8342f7471830995552ba465e2c19357d0fa4b5637b80c5d10
+  data.tar.gz: 9799b189b778c9a34ca56fcb794143f328cbac9cb9ce7df829c18c23146842b6f8c961ac866c7692cc9eef31923dc0d0a012171afe658fe5778e91a5cdd18651

data/.github/workflows/ruby.yml

@@ -12,6 +12,8 @@ on:
     branches: [main]
   pull_request:
     branches: ['**']
+  schedule:
+    - cron: "0 2 * * TUE"
 
 jobs:
   test:
@@ -24,8 +26,8 @@ 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,
@@ -42,29 +44,53 @@ jobs:
             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" }'
             ruby: "3.3"
             additional_name: "/ esbuild"
             additional_engine_cart_rails_options: "--css=bootstrap --javascript=esbuild"
 
+          # BLACKLIGHT 9, with beta cause that's all that's out as we write this
+          # and with Rails 8.0 only for simplicity
+          #
+
+          - rails_version: "~> 8.0.0"
+            blacklight_version: '~> 9.0.0.beta'
+            ruby: "3.4"
+            additional_name: "/ importmap-rails"
+            additional_engine_cart_rails_options: "--css=bootstrap"
+
+          - rails_version: "~> 8.0.0"
+            blacklight_version: '~> 9.0.0.beta'
+            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: "~> 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 +99,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 +111,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 +124,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/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/Rakefile

@@ -32,10 +32,11 @@ task :guard_version_match do
 
   # 9.0.0.beta1 in gem becomes 9.0.0-beta1 in npm
   gem_version_parts = gem_version.split(".")
+
   npm_version_required = [
     gem_version_parts.slice(0, 3).join("."),
     gem_version_parts.slice(3, gem_version_parts.length).join(".")
-  ].join("-")
+  ].collect {|s| s if s && !s.empty? }.compact.join("-")
 
   if npm_version != npm_version_required
     raise <<~EOS

data/VERSION

@@ -1 +1 @@
-9.0.0.beta2
+9.1.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_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

@@ -18,7 +18,7 @@ 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 'view_component', ">= 2.54", "< 5"
 
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-rails'

data/lib/blacklight_range_limit/range_limit_builder.rb

@@ -48,6 +48,12 @@ module BlacklightRangeLimit
     # range_field, range_start, range_end
     def fetch_specific_range_limit(solr_params)
       field_key = blacklight_params[:range_field] # what field to fetch for
+
+      unless  blacklight_params[:range_start].present? && blacklight_params[:range_start].kind_of?(String) &&
+              blacklight_params[:range_end].present? && blacklight_params[:range_end].kind_of?(String)
+        raise BlacklightRangeLimit::InvalidRange
+      end
+
       start = blacklight_params[:range_start].to_i
       finish = blacklight_params[:range_end].to_i
 
@@ -61,6 +67,9 @@ module BlacklightRangeLimit
       solr_params[:rows] = 0
 
       return solr_params
+    rescue BlacklightRangeLimit::InvalidRange
+      # This will make Rails return a 400
+      raise ActionController::BadRequest, "invalid range_start (#{blacklight_params[:range_start]}) or range_end (#{blacklight_params[:range_end]})"
     end
 
     # hacky polyfill for new Blacklight behavior we need, if we don't have it yet

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-beta2",
+  "version": "9.1.0",
   "description": "A range facet UI component plugin for blacklight",
   "type": "module",
 

data/spec/controllers/range_limit_action_method_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+RSpec.describe CatalogController,  type: :controller do
+  # Note that ActionController::BadRequest is caught by rails and turned into a 400
+  # response, and ActionController::RoutingError is caught by raisl and turned into 404
+  describe "bad params" do
+    let (:facet_field) { "pub_date_si" }
+
+    it "without start param present raise BadRequest " do
+      expect {
+        get :range_limit, params: {
+          "range_field"=> facet_field,
+          "range_start"=>"1931"
+        }
+      }.to raise_error(ActionController::BadRequest)
+    end
+
+    it "without end param raise BadRequest " do
+      expect {
+        get :range_limit, params: {
+          "range_field"=> facet_field,
+          "range_start"=>"1931"
+        }
+      }.to raise_error(ActionController::BadRequest)
+    end
+
+    it "without either boundary raise BadRequest" do
+      expect {
+        get :range_limit, params: {
+          "range_field"=> facet_field,
+        }
+      }.to raise_error(ActionController::BadRequest)
+    end
+
+    it "without a range_field raise RoutingError" do
+      expect {
+        get :range_limit, params: {}
+      }.to raise_error(ActionController::RoutingError)
+    end
+
+    it "with params out of order raise BadRequest"  do
+      expect {
+        get :range_limit, params: {
+          "range_field"=> facet_field,
+          "range_start"=>"1940",
+          "range_end"=>"1930"
+        }
+      }.to raise_error(ActionController::BadRequest)
+    end
+
+    it "with one of the params is an array raise BadRequest" do
+      expect {
+        get :range_limit, params: {
+          "range_field"=> facet_field,
+          "range_start"=>"1931",
+          "range_end"=>["1940"]
+        }
+      }.to raise_error(ActionController::BadRequest)
+    end
+  end
+end

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/lib/generators/test_app_generator.rb

@@ -13,9 +13,13 @@ class TestAppGenerator < Rails::Generators::Base
   end
 
   def run_bl8_jsbundling_fixup
-    # while it's named confusingly, the BL8 assets:propshaft generator has what we need
-    # for jsbundling, I think.
-    if File.exist?("package.json") && Blacklight::VERSION.split(".").first == "8"
+    # BL 8.7.0 doesn't seem to need anything, but BL8 before that the automatic BL
+    # install process doesn't do everything we need.
+    #
+    # By manually triggering the BL8 assets:propshaft generator, we can get what we need
+    # for jsbundling, even though it's named confusingly for that, it works in these
+    # versions.
+    if File.exist?("package.json") && Gem::Requirement.create("~> 8.0", "< 8.7.0").satisfied_by?(Gem::Version.new(Blacklight::VERSION))
       generate "blacklight:assets:propshaft"
     end
   end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 9.0.0.beta2
+  version: 9.1.0
 platform: ruby
 authors:
 - Jonathan Rochkind
 - Chris Beer
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -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: []
@@ -250,6 +248,7 @@ files:
 - spec/components/range_facet_component_spec.rb
 - spec/components/range_form_component_spec.rb
 - spec/components/range_segments_component_spec.rb
+- spec/controllers/range_limit_action_method_spec.rb
 - spec/features/blacklight_range_limit_spec.rb
 - spec/features/run_through_spec.rb
 - spec/fixtures/solr_documents/unknown_year.yml
@@ -267,7 +266,6 @@ homepage: https://github.com/projectblacklight/blacklight_range_limit
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -282,14 +280,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Blacklight Range Limit plugin
 test_files:
 - spec/components/range_facet_component_spec.rb
 - spec/components/range_form_component_spec.rb
 - spec/components/range_segments_component_spec.rb
+- spec/controllers/range_limit_action_method_spec.rb
 - spec/features/blacklight_range_limit_spec.rb
 - spec/features/run_through_spec.rb
 - spec/fixtures/solr_documents/unknown_year.yml