blacklight_range_limit 7.5.0 → 7.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7193a46aebab2a5537bd404162533d288a54f1817122a2207aaad88265245136
-  data.tar.gz: ca8afcd5b456dbb7a769a3169b405f63f37cd0003a41d905749072726a74110d
+  metadata.gz: 8e1997f0d260501d40769b046bfaa9a31492bb4398bbb144a37d2eb4cc9e6513
+  data.tar.gz: 46c9a11dbf347c2d9a5554f0d92e1b7e324bb6158acffe98908b8ecc4f519713
 SHA512:
-  metadata.gz: 70f3f8ac356959bd04dadd3f998e5a5551dd3f2cbb4efb0f5e1ebc35783fb0a579739a4ffd4184188ebf2b195906443da54d828fc393ff8f01bbc16382aba5f8
-  data.tar.gz: 9794d80970199368df6f9f6ce84544d6d88a392b8de7e59195e6402857d94462a82fe38cd46c88ee7a9b8bf0ae3abc208de4c6c26f0a8c033e6ebe1cfbbc9efb
+  metadata.gz: c9ff387fa687d752654314b976e82e2528c71403374febc52e38e07f22042514d0564ea08d46a4ec6e3f27dead5bf3db2a8942f529af1bd3fbc3a64b6a8516cb
+  data.tar.gz: b186d9febaad180fb2ac5347cd87ec098738a9e8a4a90c54c8305153edb3553bcfb0d83411c3a4f6303229d35efcada3e495f6ec8879da658d95246a762a8a31

data/VERSION

@@ -1 +1 @@
-7.5.0
+7.6.0

data/lib/blacklight_range_limit/range_limit_builder.rb

@@ -23,6 +23,8 @@ module BlacklightRangeLimit
         solr_params["stats.field"] ||= []
         solr_params["stats.field"] << config.field
 
+        range_config = BlacklightRangeLimit.range_config(blacklight_config, config.field)
+
         hash =  blacklight_params["range"] && blacklight_params["range"][field_key] ?
           blacklight_params["range"][field_key] :
           {}
@@ -40,13 +42,13 @@ module BlacklightRangeLimit
           solr_params[:fq] ||= []
           solr_params[:fq] << "#{config.field}: [#{start} TO #{finish}]"
 
-          if (config.segments != false && start != "*" && finish != "*")
+          if (range_config[:segments] != false && start != "*" && finish != "*")
             # Add in our calculated segments, can only do with both boundaries.
             add_range_segments_to_solr!(solr_params, field_key, start.to_i, finish.to_i)
           end
 
-        elsif (config.segments != false &&
-               boundaries = config.assumed_boundaries)
+        elsif (range_config[:segments] != false &&
+               boundaries = range_config[:assumed_boundaries])
           # assumed_boundaries in config
           add_range_segments_to_solr!(solr_params, field_key, boundaries[0], boundaries[1])
         end

data/lib/blacklight_range_limit/segment_calculation.rb

@@ -15,6 +15,8 @@ module BlacklightRangeLimit
       raise InvalidRange, "The min date must be before the max date" if min > max
       field_config = blacklight_config.facet_fields[facet_field.to_s]
 
+      return solr_params unless field_config
+
       range_config = BlacklightRangeLimit.range_config(blacklight_config, facet_field)
 
       solr_params[:"facet.query"] ||= []
@@ -29,7 +31,7 @@ module BlacklightRangeLimit
         solr_params[:"facet.query"] << "#{field_config.field}:[#{first} TO #{last}]"
       end
 
-      return solr_params
+      solr_params
     end
 
     # returns an array of 'boundaries' for producing approx num_div

data/lib/blacklight_range_limit/view_helper_override.rb

@@ -29,39 +29,26 @@
     end
 
     def render_constraints_filters(my_params = params)
-      content = super(my_params)
       # add a constraint for ranges?
-      unless my_params[:range].blank?
-        my_params[:range].each_pair do |solr_field, hash|
-
-          next unless hash["missing"] || (!hash["begin"].blank?) || (!hash["end"].blank?)
-          content << render_constraint_element(
-            facet_field_label(solr_field),
-            range_display(solr_field, my_params),
-            :escape_value => false,
-            :remove => remove_range_param(solr_field, my_params)
-          )
-        end
+      range_params(my_params).keys.each_with_object(super) do |solr_field, content|
+        content << render_constraint_element(
+          facet_field_label(solr_field),
+          range_display(solr_field, my_params),
+          escape_value: false,
+          remove: remove_range_param(solr_field, my_params)
+        )
       end
-      return content
     end
 
     def render_search_to_s_filters(my_params)
-      content = super(my_params)
       # add a constraint for ranges?
-      unless my_params[:range].blank?
-        my_params[:range].each_pair do |solr_field, hash|
-          next unless hash["missing"] || (!hash["begin"].blank?) || (! hash["end"].blank?)
-
-          content << render_search_to_s_element(
-            facet_field_label(solr_field),
-            range_display(solr_field, my_params),
-            :escape_value => false
-          )
-
-        end
+      range_params(my_params).keys.each_with_object(super) do |solr_field, content|
+        content << render_search_to_s_element(
+          facet_field_label(solr_field),
+          range_display(solr_field, my_params),
+          escape_value: false
+        )
       end
-      return content
     end
 
     def remove_range_param(solr_field, my_params = params)
@@ -97,4 +84,17 @@
       BlacklightRangeLimit.range_config(blacklight_config, solr_field)
     end
 
+    private
+
+    def range_params(my_params = params)
+      return {} unless my_params[:range].is_a?(ActionController::Parameters)
+
+      my_params[:range].select do |_solr_field, range_options|
+        next unless range_options
+
+        [range_options['missing'],
+         range_options['begin'],
+         range_options['end']].any?
+      end
+    end
   end

data/spec/features/a_javascript_spec.rb

@@ -21,6 +21,25 @@ describe 'JavaScript', js: true do
     end
   end
 
+  context 'when assumed boundaries configured' do
+    before do
+      CatalogController.blacklight_config.facet_fields['pub_date_si'].range = {
+        assumed_boundaries: [1990, 2000]
+      }
+    end
+
+    after do
+      CatalogController.blacklight_config.facet_fields['pub_date_si'].range = true
+    end
+
+    it 'should show the range limit with set boundaries' do
+      visit '/catalog'
+      click_button 'Publication Date Sort'
+      expect(page).to have_field :range_pub_date_si_begin, with: '1990'
+      expect(page).to have_field :range_pub_date_si_end, with: '2000'
+    end
+  end
+
   describe '"Unknown" link' do
     context 'when in the facet (e.g. non-xhr)' do
       it 'is displayed' do

data/spec/features/blacklight_range_limit_spec.rb

@@ -40,6 +40,10 @@ describe "Blacklight Range Limit" do
       I18n.backend.store_translations(:en, blacklight: {search: {fields: {facet: {pub_date_si: 'Publication Date I18n'}}}})
     end
 
+    after do
+      I18n.backend.store_translations(:en, blacklight: {search: {fields: {facet: {pub_date_si: 'Publication Date Sort'}}}})
+    end
+
     it 'should render the I18n label' do
       visit search_catalog_path
       click_link 'View distribution'

data/spec/lib/blacklight_range_limit/segment_calculation_spec.rb

@@ -4,6 +4,10 @@ RSpec.describe BlacklightRangeLimit::SegmentCalculation do
   let(:dummy_class) do
     Class.new do
       include BlacklightRangeLimit::SegmentCalculation
+
+      def blacklight_config
+        Blacklight::Configuration.new
+      end
     end
   end
 
@@ -45,5 +49,15 @@ RSpec.describe BlacklightRangeLimit::SegmentCalculation do
                                           'The min date must be before the max date'
       end
     end
+
+    context 'when a field that does not exist is passed in' do
+      let(:min) { 100 }
+      let(:max) { 800 }
+      let(:solr_field) { 'i_am_not_real' }
+
+      it 'returns the original solr_params (and does not raise an error)' do
+        expect(subject).to eq({})
+      end
+    end
   end
 end

data/spec/lib/blacklight_range_limit/view_helper_override_helper_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+RSpec.describe BlacklightRangeLimit::ViewHelperOverride, type: :helper do
+  describe '#render_constraints_filters' do
+    before do
+      allow(helper).to receive_messages(
+        facet_field_label: 'Date Range',
+        remove_range_param: '/remove'
+      )
+    end
+
+    it 'does not return any content when the range parameter invalid' do
+      params = ActionController::Parameters.new(range: 'garbage')
+
+      expect(helper.render_constraints_filters(params)).to eq ''
+    end
+
+    it 'renders a constraint for the given data in the range param' do
+      params = ActionController::Parameters.new(
+        range: { range_field: { 'begin' => 1900, 'end' => 2000 } }
+      )
+      constraints = helper.render_constraints_filters(params)
+
+      expect(constraints).to have_css(
+        '.constraint .filter-name', text: 'Date Range'
+      )
+      expect(constraints).to have_css(
+        '.constraint .filter-value', text: '1900 to 2000'
+      )
+    end
+  end
+
+  describe 'render_search_to_s_filters' do
+    before do
+      allow(helper).to receive_messages(facet_field_label: 'Date Range')
+    end
+
+    it 'does not return any content when the range parameter invalid' do
+      params = ActionController::Parameters.new(range: 'garbage')
+
+      expect(helper.render_search_to_s_filters(params)).to eq ''
+    end
+
+    it 'renders a constraint for the given data in the range param' do
+      params = ActionController::Parameters.new(
+        range: { range_field: { 'begin' => 1900, 'end' => 2000 } }
+      )
+      constraints = helper.render_search_to_s_filters(params)
+
+      expect(constraints).to have_css(
+        '.constraint .filter-name', text: 'Date Range:'
+      )
+      expect(constraints).to have_css(
+        '.constraint .filter-values', text: '1900 to 2000'
+      )
+    end
+  end
+
+  describe '#range_params' do
+    it 'handles no range input' do
+      expect(
+        helper.send(:range_params, ActionController::Parameters.new(q: 'blah'))
+      ).to eq({})
+    end
+
+    it 'handles non-compliant range input' do
+      expect(
+        helper.send(:range_params, ActionController::Parameters.new(range: 'blah'))
+      ).to eq({})
+
+      expect(
+        helper.send(:range_params, ActionController::Parameters.new(range: ['blah']))
+      ).to eq({})
+
+      expect(
+        helper.send(:range_params, ActionController::Parameters.new(range: { 'wrong' => 'data' }))
+      ).to eq({})
+
+      expect(
+        helper.send(
+          :range_params,
+          ActionController::Parameters.new(range: { field_name: { 'wrong' => 'data' } })
+        )
+      ).to eq({})
+    end
+
+    it 'returns the range parameters that are present' do
+      expect(
+        helper.send(
+          :range_params,
+          ActionController::Parameters.new(range: { field_name: { 'missing' => true } })
+        ).permit!.to_h
+      ).to eq({ 'field_name' => { 'missing' => true } })
+
+      expect(
+        helper.send(
+          :range_params,
+          ActionController::Parameters.new(range: { field_name: { 'begin' => '1800', 'end' => '1900' } })
+        ).permit!.to_h
+      ).to eq({ 'field_name' => { 'begin' => '1800', 'end' => '1900' } })
+
+      expect(
+        helper.send(
+          :range_params,
+          ActionController::Parameters.new(
+            range: {
+              field_name: { 'begin' => '1800', 'end' => '1900' },
+              field_name2: { 'begin' => '1800', 'end' => '1900' }
+            }
+          )
+        ).permit!.to_h
+      ).to eq(
+        {
+          'field_name' => { 'begin' => '1800', 'end' => '1900' },
+          'field_name2' => { 'begin' => '1800', 'end' => '1900' }
+        }
+      )
+    end
+  end
+end

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

@@ -30,4 +30,11 @@ class TestAppGenerator < Rails::Generators::Base
       "\n    config.add_facet_field 'pub_date_si', label: 'Publication Date Sort', range: true"
     end
   end
+
+  def assets
+    return if !defined?(Sprockets::VERSION) || Sprockets::VERSION < '4'
+
+    append_to_file 'app/assets/config/manifest.js', "\n//= link application.js"
+    empty_directory 'app/assets/images'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 7.5.0
+  version: 7.6.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -222,6 +222,7 @@ files:
 - 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/lib/blacklight_range_limit/view_helper_override_helper_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
@@ -266,6 +267,7 @@ test_files:
 - 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/lib/blacklight_range_limit/view_helper_override_helper_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb