blacklight_range_limit 8.5.0 → 9.0.0.beta2

data/spec/presenters/filter_field_spec.rb

@@ -19,9 +19,18 @@ RSpec.describe BlacklightRangeLimit::FilterField do
   describe '#add' do
     it 'adds a new range parameter' do
       new_state = filter.add(1999..2099)
-
       expect(new_state.params.dig(:range, 'some_field')).to include begin: 1999, end: 2099
     end
+
+    it "adds end-less range" do
+      new_state = filter.add(1999..nil)
+      expect(new_state.params.dig(:range, 'some_field')).to include begin: 1999, end: nil
+    end
+
+    it "adds begin-less range" do
+      new_state = filter.add(nil..2099)
+      expect(new_state.params.dig(:range, 'some_field')).to include begin: nil, end: 2099
+    end
   end
 
   context 'with some existing data' do
@@ -32,6 +41,12 @@ RSpec.describe BlacklightRangeLimit::FilterField do
         new_state = filter.add(1999..2099)
 
         expect(new_state.params.dig(:range, 'some_field')).to include begin: 1999, end: 2099
+
+        new_state = filter.add(1999..nil)
+        expect(new_state.params.dig(:range, 'some_field')).to include begin: 1999, end: nil
+
+        new_state = filter.add(nil..2099)
+        expect(new_state.params.dig(:range, 'some_field')).to include begin: nil, end: 2099
       end
     end
 
@@ -66,6 +81,26 @@ RSpec.describe BlacklightRangeLimit::FilterField do
     end
   end
 
+  context 'with an end-less range' do
+    let(:param_values) { { range: { some_field: { begin: '2013', end: '' } } } }
+
+    describe '#values' do
+      it 'converts the parameters to a Range' do
+        expect(filter.values).to eq [2013..nil]
+      end
+    end
+  end
+
+  context 'with an begin-less range' do
+    let(:param_values) { { range: { some_field: { begin: '', end: '2022' } } } }
+
+    describe '#values' do
+      it 'converts the parameters to a Range' do
+        expect(filter.values).to eq [nil..2022]
+      end
+    end
+  end
+
   context 'with empty data' do
     let(:param_values) { { range: { some_field: { begin: '', end: '' } } } }
 

data/spec/requests/bad_param_requests_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe CatalogController, type: :request do
+  let(:range_facet_field) { "pub_date_si" }
+
+  let(:parsed_body) { Nokogiri::HTML(response.body) }
+
+  describe "bad params should not produce uncaught exception when" do
+    it "bad root range" do
+      get "/catalog?range=bad"
+
+      expect(response.code).to eq("200")
+      expect(parsed_body.css("span.applied-filter")).not_to be_present
+    end
+
+    it "facet params are ill structured" do
+      get "/catalog?#{  {"f" => { range_facet_field => [{"=Library&q="=>""}] } }.to_param  }"
+
+      expect(response.code).to eq("200")
+      expect(parsed_body.css("span.applied-filter")).not_to be_present
+    end
+
+    it "newline in range facet does not interupt facet" do
+      get "/catalog?#{ {"range"=>{ range_facet_field => {"begin"=>"1588\n", "end"=>"2020\n"}}}.to_param }"
+
+      expect(response.code).to eq("200")
+      expect(parsed_body.css("span.applied-filter")).to be_present
+      expect(parsed_body.css("span.applied-filter").collect(&:text)).to include(/1588.*to.*2020/)
+    end
+
+    it "weird attack in range value is ignored" do
+      param_hash = {"range"=>{"year_facet_isim"=>{"begin"=>"1989',(;))#- --", "end"=>"1989',(;))#- --"}}}
+      get "/catalog?#{ param_hash.to_param  }"
+
+      expect(response.code).to eq("200")
+      expect(parsed_body.css("span.applied-filter")).not_to be_present
+    end
+
+    it "empty range param is ignored" do
+      get "/catalog?#{ { "range" => { "year_facet_isim" => nil } }.to_param }"
+
+      expect(response.code).to eq("200")
+      expect(parsed_body.css("span.applied-filter")).not_to be_present
+    end
+
+    describe "out of bounds range config" do
+      let(:max) { BlacklightRangeLimit.default_range_config[:range_config][:max_value] }
+      let(:min) { BlacklightRangeLimit.default_range_config[:range_config][:min_value] }
+
+      let(:too_high) { max.abs * 2 }
+      let(:too_low) { min.abs * -2 }
+
+      it "does not error" do
+        get "/catalog?#{ {"range"=>{ range_facet_field => {"begin"=> too_low, "end"=> too_high }}}.to_param }"
+
+        expect(response.code).to eq("200")
+        expect(parsed_body.css("span.applied-filter")).to be_present
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ EngineCart.load_application!
 require 'rspec/rails'
 require 'capybara/rspec'
 require 'selenium-webdriver'
+require 'capybara-screenshot/rspec'
 
 Capybara.javascript_driver = :headless_chrome
 
@@ -16,10 +17,16 @@ Capybara.register_driver :headless_chrome do |app|
     opts.args << '--disable-gpu'
     opts.args << '--no-sandbox'
     opts.args << '--window-size=1280,1696'
+
+    opts.add_option('goog:loggingPrefs', browser: 'ALL')
   end
   Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
 end
 
+Capybara::Screenshot.register_driver(:headless_chrome) do |driver, path|
+  driver.browser.save_screenshot(path)
+end
+
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir[Pathname.new(File.expand_path('support/**/*.rb', __dir__))].sort.each { |f| require f }
@@ -38,4 +45,7 @@ RSpec.configure do |config|
 
   config.include PresenterTestHelpers, type: :presenter
   config.include ViewComponent::TestHelpers, type: :component
+
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
 end

data/spec/test_app_templates/Gemfile.extra

@@ -1,2 +1,12 @@
 gem 'rails-controller-testing'
-gem 'blacklight', ENV['BLACKLIGHT_VERSION'] if ENV['BLACKLIGHT_VERSION']
+
+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'])
+  else
+    gem "blacklight", ENV['BLACKLIGHT_VERSION']
+  end
+end
+

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

@@ -3,19 +3,50 @@ require 'rails/generators'
 class TestAppGenerator < Rails::Generators::Base
   source_root File.expand_path("../../../../spec/test_app_templates", __FILE__)
 
-  # This is only necessary for Rails 3
-  def remove_index
-    remove_file "public/index.html"
+  # While blacklight works with jsbundling-rails (and vite-ruby with layout modification),
+  # it's generators can't set it up at present, we hackily do so.
+  def run_bl7_jsbundling_fixup
+    if File.exist?("package.json") && Blacklight::VERSION.split(".").first == "7"
+      say_status("warning", "BlacklightRangeLimit: Blacklight 7.x package.json-based Test App fixup", {color: :yellow})
+      generate "blacklight_range_limit:jsbundling_bl7_fixup"
+    end
+  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"
+      generate "blacklight:assets:propshaft"
+    end
   end
 
   def run_blacklight_generator
-    say_status("warning", "GENERATING BL", :yellow)
+    say_status("warning", "GENERATING Blacklight", :yellow)
 
     generate 'blacklight:install', '--devise'
   end
 
+  def run_bl8_importmaps_fixup
+    # In BL8, if we have CSS-bundling rails but ALSO are using importmaps for JS, the BL8 installer
+    # gets us a LOT of the way there, but doesn't actually set up importmap pins for JS and needs
+    # some fixup. Maybe fixed in BL9?  We fix up here if we are in that situation.
+    if Pathname(destination_root).join("config/importmap.rb").exist? && Blacklight::VERSION.split(".").first == "8"
+      # BL's importmap setup annoyingly uses a different name for the BL package than their package.json setup
+      gsub_file("app/javascript/application.js", 'import Blacklight from "blacklight-frontend";', 'import Blacklight from "blacklight";')
+
+      # these pins copied from BL8 ImportMapsGenerator
+      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.3.2'}/dist/js/bootstrap.js"
+        CONTENT
+      end
+    end
+  end
+
   def run_blacklight_range_limit_generator
-    say_status("warning", "GENERATING BL", :yellow)
+    say_status("warning", "GENERATING BlacklightRangeLimit", :yellow)
 
     generate 'blacklight_range_limit:install'
   end
@@ -27,7 +58,7 @@ class TestAppGenerator < Rails::Generators::Base
 
   def inject_into_catalog_controller
     inject_into_file 'app/controllers/catalog_controller.rb', after: /config.add_facet_field 'format'.*$/ do
-      "\n    config.add_facet_field 'pub_date_si', label: 'Publication Date Sort', **default_range_config"
+      "\n    config.add_facet_field 'pub_date_si', label: 'Publication Date Sort', range: true"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 8.5.0
+  version: 9.0.0.beta2
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-05 00:00:00.000000000 Z
+date: 2024-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -51,20 +51,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-- !ruby/object:Gem::Dependency
-  name: deprecation
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +93,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: capybara-screenshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -193,37 +193,23 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- app/assets/javascripts/blacklight_range_limit.js
-- app/assets/javascripts/blacklight_range_limit/blacklight_range_limit.esm.js
-- app/assets/javascripts/blacklight_range_limit/blacklight_range_limit.esm.js.map
-- app/assets/javascripts/blacklight_range_limit/blacklight_range_limit.umd.js
-- app/assets/javascripts/blacklight_range_limit/blacklight_range_limit.umd.js.map
-- app/assets/stylesheets/blacklight_range_limit.css
-- app/assets/stylesheets/blacklight_range_limit/blacklight_range_limit.css
+- app/assets/javascripts/blacklight-range-limit/index.js
 - app/components/blacklight_range_limit/range_facet_component.html.erb
 - 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_segments_component.html.erb
 - app/components/blacklight_range_limit/range_segments_component.rb
-- app/helpers/range_limit_helper.rb
-- app/javascript/blacklight_range_limit/index.js
-- app/javascript/blacklight_range_limit/range_limit_distro_facets.js
-- app/javascript/blacklight_range_limit/range_limit_plotting.js
-- app/javascript/blacklight_range_limit/range_limit_shared.js
-- app/javascript/blacklight_range_limit/range_limit_slider.js
-- app/javascripts/blacklight_range_limit/index.js
 - app/presenters/blacklight_range_limit/facet_field_presenter.rb
 - app/presenters/blacklight_range_limit/facet_item_presenter.rb
 - app/presenters/blacklight_range_limit/filter_field.rb
-- app/views/blacklight_range_limit/_range_segments.html.erb
-- app/views/blacklight_range_limit/range_segments.html.erb
-- app/views/catalog/range_limit_panel.html.erb
 - blacklight_range_limit.gemspec
+- config/importmap.rb
 - config/jetty.yml
 - config/locales/blacklight_range_limit.ar.yml
 - config/locales/blacklight_range_limit.de.yml
 - config/locales/blacklight_range_limit.en.yml
+- config/locales/blacklight_range_limit.es.yml
 - config/locales/blacklight_range_limit.it.yml
 - config/routes.rb
 - config/solr.yml
@@ -240,10 +226,10 @@ files:
 - lib/blacklight_range_limit/version.rb
 - lib/generators/blacklight_range_limit/assets_generator.rb
 - lib/generators/blacklight_range_limit/install_generator.rb
+- lib/generators/blacklight_range_limit/jsbundling_bl7_fixup_generator.rb
 - lib/tasks/blacklight_range_limit.rake
 - package-lock.json
 - package.json
-- rollup.config.js
 - solr/conf/_rest_managed.json
 - solr/conf/admin-extra.html
 - solr/conf/elevate.xml
@@ -263,31 +249,20 @@ files:
 - solr/sample_solr_documents.yml
 - spec/components/range_facet_component_spec.rb
 - spec/components/range_form_component_spec.rb
-- spec/features/a_javascript_spec.rb
+- spec/components/range_segments_component_spec.rb
 - spec/features/blacklight_range_limit_spec.rb
+- spec/features/run_through_spec.rb
 - spec/fixtures/solr_documents/unknown_year.yml
 - spec/fixtures/solr_documents/zero_year.yml
-- spec/helpers/blacklight_range_limit_helper_spec.rb
 - spec/lib/blacklight_range_limit/segment_calculation_spec.rb
 - spec/presenters/facet_field_presenter_spec.rb
 - spec/presenters/facet_item_presenter_spec.rb
 - spec/presenters/filter_field_spec.rb
+- spec/requests/bad_param_requests_spec.rb
 - spec/spec_helper.rb
 - spec/support/presenter_test_helpers.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
-- vendor/assets/javascripts/bootstrap-slider.js
-- vendor/assets/javascripts/flot/jquery.canvaswrapper.js
-- vendor/assets/javascripts/flot/jquery.colorhelpers.js
-- vendor/assets/javascripts/flot/jquery.event.drag.js
-- vendor/assets/javascripts/flot/jquery.flot.browser.js
-- vendor/assets/javascripts/flot/jquery.flot.drawSeries.js
-- vendor/assets/javascripts/flot/jquery.flot.hover.js
-- vendor/assets/javascripts/flot/jquery.flot.js
-- vendor/assets/javascripts/flot/jquery.flot.saturated.js
-- vendor/assets/javascripts/flot/jquery.flot.selection.js
-- vendor/assets/javascripts/flot/jquery.flot.uiConstants.js
-- vendor/assets/stylesheets/slider.css
 homepage: https://github.com/projectblacklight/blacklight_range_limit
 licenses:
 - Apache 2.0
@@ -307,22 +282,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.9
 signing_key:
 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/features/a_javascript_spec.rb
+- spec/components/range_segments_component_spec.rb
 - spec/features/blacklight_range_limit_spec.rb
+- spec/features/run_through_spec.rb
 - spec/fixtures/solr_documents/unknown_year.yml
 - spec/fixtures/solr_documents/zero_year.yml
-- spec/helpers/blacklight_range_limit_helper_spec.rb
 - spec/lib/blacklight_range_limit/segment_calculation_spec.rb
 - spec/presenters/facet_field_presenter_spec.rb
 - spec/presenters/facet_item_presenter_spec.rb
 - spec/presenters/filter_field_spec.rb
+- spec/requests/bad_param_requests_spec.rb
 - spec/spec_helper.rb
 - spec/support/presenter_test_helpers.rb
 - spec/test_app_templates/Gemfile.extra