blacklight_range_limit 8.2.0 → 8.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '00179d23555229bb58884ff2625e599307bbda4404fe0ebab00fa460a95b0e58'
-  data.tar.gz: 742c87c6be6c52491abda708761027e68986bb0cf7ae1c95cff2605f779e5fd0
+  metadata.gz: 3ffae79e3156b14c7ad9b8c1c98bfb4862a9976996c9fafb9962d2f03d9688e4
+  data.tar.gz: 37bec61cbc86e6facaa7052e9a84a561664a0538fdfbd53c71960be16c35b5f3
 SHA512:
-  metadata.gz: 668f99b158ff431e50e484d851f59d24aa55580699b7e1e2338d326d9346b59a29ac4d9031cf8d61d5e28a4aa0629b6776c6da40f553791a13cf165eb03afbc7
-  data.tar.gz: ed441dacce85f39b0b7ecffecf0afdd14d1174eb8f5d5ab1e7a3832002e5bd3c46d9753779b0b1119e79d916633590f9228672694e1a821c0409cb35de699983
+  metadata.gz: d3e17cf2f4a0a4851f585c2309a5f2c4dde6ff1ab24c0f168b17fd56e7fe3c416facede0bb6c9fa7e4a9e60842f0fa04b7c2d3f525e035d4374879dada9988a9
+  data.tar.gz: 5d8b218cb0063215f452f1debc5b7ba5e04530fb3fc16b7eae90ca670dd45684a223bf49261d8fbd2b4cb36a7807125141365a86aa89618891558a38a13e73e3

data/.github/workflows/ruby.yml

@@ -9,9 +9,9 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   test:

data/VERSION

@@ -1 +1 @@
-8.2.0
+8.2.3

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

@@ -1,12 +1,12 @@
 <%= form_tag search_action_path, method: :get, class: [@classes[:form], "range_#{@facet_field.key} d-flex justify-content-center"].join(' ') do %>
-  <%= render Blacklight::HiddenSearchStateComponent.new(params: @facet_field.search_state.params_for_search.except(:utf8, :page)) %>
+  <%= render hidden_search_state %>
 
   <div class="input-group input-group-sm mb-3 flex-nowrap range-limit-input-group">
     <%= render_range_input(:begin, begin_label) %>
     <%= render_range_input(:end, end_label) %>
     <div class="input-group-append visually-hidden">
-      <%= submit_tag t('blacklight.range_limit.submit_limit'), class: @classes[:submit] %>
+      <%= submit_tag t('blacklight.range_limit.submit_limit'), class: @classes[:submit], name: nil %>
     </div>
-    <%= submit_tag t('blacklight.range_limit.submit_limit'), class: @classes[:submit] + " sr-only", "aria-hidden": "true" %>
+    <%= submit_tag t('blacklight.range_limit.submit_limit'), class: @classes[:submit] + " sr-only", "aria-hidden": "true", name: nil %>
   </div>
 <% end %>

data/app/components/blacklight_range_limit/range_form_component.rb

@@ -39,6 +39,17 @@ module BlacklightRangeLimit
 
     private
 
+    ##
+    # the form needs to serialize any search parameters, including other potential range filters,
+    # as hidden fields. The parameters for this component's range filter are serialized as number
+    # inputs, and should not be in the hidden params.
+    # @return [Blacklight::HiddenSearchStateComponent]
+    def hidden_search_state
+      hidden_search_params = @facet_field.search_state.params_for_search.except(:utf8, :page)
+      hidden_search_params[:range]&.except!(@facet_field.key)
+      Blacklight::HiddenSearchStateComponent.new(params: hidden_search_params)
+    end
+
     def range_config
       @facet_field.range_config
     end

data/app/presenters/blacklight_range_limit/filter_field.rb

@@ -50,17 +50,16 @@ module BlacklightRangeLimit
     def values(except: [])
       params = search_state.params
       param_key = filters_key
-      return [] unless params.dig(param_key, config.key)
-
       range = if params.dig(param_key, config.key).is_a? Range
         params.dig(param_key, config.key)
-      else
-        begins = Array(params.dig(param_key, config.key, :begin)).map(&:to_i)
-        ends = Array(params.dig(param_key, config.key, :end)).map(&:to_i)
-        begins.zip(ends).map { |b_bound, e_bound|  Range.new(b_bound, e_bound) }
+      elsif params.dig(param_key, config.key).is_a? Hash
+        b_bound = params.dig(param_key, config.key, :begin).presence
+        e_bound = params.dig(param_key, config.key, :end).presence
+        Range.new(b_bound&.to_i, e_bound&.to_i) if b_bound && e_bound
       end
 
-      f = except.include?(:filters) ? [] : Array(range)
+      f = except.include?(:filters) ? [] : [range].compact
+
       f_missing = [] if except.include?(:missing)
       f_missing ||= [Blacklight::SearchState::FilterField::MISSING] if params.dig(filters_key, "-#{key}")&.any? { |v| v == Blacklight::Engine.config.blacklight.facet_missing_param }
 
@@ -76,9 +75,8 @@ module BlacklightRangeLimit
     # this filter should allow (expect) hashes if the keys include 'begin' or 'end'
     def permitted_params
       {
-        # { begin: [], end: [] } or [:begin, :end]
-        filters_key => { config.key => { begin: [], end: [] }, "-#{config.key}" => [] },
-        inclusive_filters_key => { config.key => { begin: [], end: [] } }
+        filters_key => { config.key => [:begin, :end], "-#{config.key}" => [] },
+        inclusive_filters_key => { config.key => [:begin, :end] }
       }
     end
   end

data/blacklight_range_limit.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
 
   s.license     = 'Apache 2.0'
 
-  s.add_dependency 'blacklight', '>= 7.22.2', '< 9'
+  s.add_dependency 'blacklight', '>= 7.25.2', '< 9'
 
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-rails'

data/spec/components/range_form_component_spec.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe BlacklightRangeLimit::RangeFormComponent, type: :component do
+  subject(:component) do
+    described_class.new(facet_field: facet_field)
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render_inline(component))
+  end
+
+  let(:facet_field_params) { {} }
+  let(:selected_range) { nil }
+  let(:search_params) { { another_field: 'another_value' } }
+
+  let(:facet_field) do
+    instance_double(
+      BlacklightRangeLimit::FacetFieldPresenter,
+      key: 'key',
+      html_id: 'id',
+      active?: false,
+      collapsed?: false,
+      in_modal?: false,
+      label: 'My facet field',
+      selected_range: selected_range,
+      selected_range_facet_item: nil,
+      missing_facet_item: nil,
+      missing_selected?: false,
+      min: nil,
+      max: nil,
+      search_state: Blacklight::SearchState.new(search_params, nil),
+      range_config: {},
+      modal_path: nil,
+      facet_field: facet_config,
+      **facet_field_params
+    )
+  end
+
+  let(:facet_config) do
+    Blacklight::Configuration::FacetField.new(key: 'key', item_presenter: BlacklightRangeLimit::FacetItemPresenter)
+  end
+
+  it 'renders a form with no selected range' do
+    expect(rendered).to have_selector('form[action="http://test.host/catalog"][method="get"]')
+      .and have_field('range[key][begin]', type: 'number')
+      .and have_field('range[key][end]', type: 'number')
+      .and have_field('another_field', type: 'hidden', with: 'another_value', visible: false)
+    expect(rendered.find_field('range[key][begin]', type: 'number').value).to be_blank
+    expect(rendered.find_field('range[key][end]', type: 'number').value).to be_blank
+    expect(rendered).not_to have_field('range[key][begin]', type: 'hidden')
+  end
+
+  it 'renders submit controls without a name to suppress from formData' do
+    anon_submit = rendered.find('input', visible: true) { |ele| ele[:type] == 'submit' && !ele[:'aria-hidden'] && !ele[:name] }
+    expect(anon_submit).to be_present
+    expect { rendered.find('input') { |ele| ele[:type] == 'submit' && ele[:name] } }.to raise_error(Capybara::ElementNotFound)
+  end
+
+  context 'with range data' do
+    let(:selected_range) { (100..300) }
+    let(:search_params) do
+      { 
+        another_field: 'another_value',
+        range: {
+          another_range: { begin: 128, end: 1024 },
+          key: { begin: selected_range.first, end: selected_range.last }
+        }
+      }      
+    end
+
+    it 'renders a form for the selected range' do
+      expect(rendered).to have_selector('form[action="http://test.host/catalog"][method="get"]')
+        .and have_field('range[key][begin]', type: 'number', with: selected_range.first)
+        .and have_field('range[key][end]', type: 'number', with: selected_range.last)
+        .and have_field('another_field', type: 'hidden', with: 'another_value', visible: false)
+        .and have_field('range[another_range][begin]', type: 'hidden', with: 128, visible: false)
+        .and have_field('range[another_range][end]', type: 'hidden', with: 1024, visible: false)
+      expect(rendered).not_to have_field('range[key][begin]', type: 'hidden')
+    end
+  end
+end

data/spec/features/blacklight_range_limit_spec.rb

@@ -42,6 +42,7 @@ describe "Blacklight Range Limit" do
     click_link '2000 to 2008'
     click_button 'Apply', match: :first
     expect(page.current_url).not_to include('page')
+    expect(page.current_url).not_to include('commit')
   end
 
   context 'when I18n translation is available' do

data/spec/presenters/filter_field_spec.rb

@@ -56,14 +56,32 @@ RSpec.describe BlacklightRangeLimit::FilterField do
       end
     end
 
+    describe '#permitted_params' do
+      let(:rails_params) { ActionController::Parameters.new(param_values) }
+      let(:blacklight_params) { Blacklight::Parameters.new(rails_params, search_state) }
+      let(:permitted_params) { blacklight_params.permit_search_params.to_h }
+      it 'sanitizes single begin/end values as scalars' do
+        expect(permitted_params.dig(:range, 'some_field')).to include 'begin' => '2013', 'end' => '2022'
+      end
+    end
   end
 
-  context 'with array-mangled data' do
-    let(:param_values) { { range: { some_field: { begin: { '0' => '2013' }, end: { '0' => '2022' } } } } }
+  context 'with empty data' do
+    let(:param_values) { { range: { some_field: { begin: '', end: '' } } } }
 
     describe '#values' do
-      it 'converts the parameters to a Range' do
-        expect(filter.values).to eq [2013..2022]
+      it 'drops the empty range' do
+        expect(filter.values).to be_empty
+      end
+    end
+  end
+
+  context 'with missing data' do
+    let(:param_values) { { range: { '-some_field': ['[* TO *]']} } }
+
+    describe '#values' do
+      it 'uses the missing special value' do
+        expect(filter.values).to eq [Blacklight::SearchState::FilterField::MISSING]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 8.2.0
+  version: 8.2.3
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -17,7 +17,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.22.2
+        version: 7.25.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -27,7 +27,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.22.2
+        version: 7.25.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -247,6 +247,7 @@ files:
 - solr/conf/xslt/luke.xsl
 - 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/features/blacklight_range_limit_spec.rb
 - spec/fixtures/solr_documents/unknown_year.yml
@@ -291,12 +292,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.19
 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/features/blacklight_range_limit_spec.rb
 - spec/fixtures/solr_documents/unknown_year.yml