blacklight_range_limit 6.3.3 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f36982cd7ae0224c85406116f0ce81a46d604aba
-  data.tar.gz: ec2fcf93993ef6375f9de89b6f5a53bebb6d3b97
+SHA256:
+  metadata.gz: d1d06f2026c9872ba165877b0d2e5a533e4522ebe0bc273b46586ce916708db5
+  data.tar.gz: 7d7cae7865815f99228acb3264b59499d9a313f219f69e8bd47090fbc98e767c
 SHA512:
-  metadata.gz: 91401d023fb8db93c5dcd050708f7cb8c6b043502b60faebb87b25e20915114c872e8244037a65f879f2d758deb6d0f41e506102146323c3f4c6961a4c50e57f
-  data.tar.gz: b0031855b0e90123b39c193b209de794963b09a0afcaeb9d922158d31a50b1b5b493cff9848ded63d8768d29baa4ca8ff63addd923f3857d10eabd749a8cde5c
+  metadata.gz: 4cd3f8e9c6d1f32a9a1ff1b8b2ff66b7619d4b45f88a85f4d15c80b38501f681d250ead319b823ef19b3d10249bfc16291d430f4a44c023985cdeb46ae112370
+  data.tar.gz: 3f5a12bedc924cea811b1ad562ae1df9cbb6499b1015143206c64c36b86994eb5441ab968290524324e9a62a7c462a083d3f606c3831faf5e7e57c6b68ed7997

data/.solr_wrapper.yml

@@ -1,6 +1,7 @@
 # Place any default configuration for solr_wrapper here
 port: 8983
 verbose: true
+version: 7.7.2
 collection:
   dir: solr/conf/
   name: blacklight-core

data/.travis.yml

@@ -4,10 +4,11 @@ notifications:
 language: ruby
 sudo: false
 rvm:
-  - 2.3.1
+  - 2.5.8
+  - 2.6.5
 
 before_install:
-  - gem install bundler
+  - google-chrome-stable --headless --disable-gpu --remote-debugging-port=9222 http://localhost &
 
 notifications:
   irc: "irc.freenode.org#blacklight"
@@ -17,4 +18,4 @@ notifications:
 global_env:
   - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
 
-jdk: oraclejdk8
+jdk: oraclejdk9

data/Gemfile

@@ -36,3 +36,7 @@ else
   end
 end
 # END ENGINE_CART BLOCK
+
+if File.exists?('spec/test_app_templates/Gemfile.extra')
+  eval File.read('spec/test_app_templates/Gemfile.extra'), nil, 'spec/test_app_templates/Gemfile.extra'
+end

data/VERSION

@@ -1 +1 @@
-6.3.3
+6.4.0

data/blacklight_range_limit.gemspec

@@ -17,15 +17,18 @@ Gem::Specification.new do |s|
 
   s.license     = 'Apache 2.0'
 
-  s.add_dependency 'rails', '>= 3.0'
+  s.add_dependency 'rails', '>= 4.2', '< 6'
   s.add_dependency 'jquery-rails' # our JS needs jquery_rails
-  s.add_dependency 'blacklight', '>= 6.0.2'
+  s.add_dependency 'blacklight', '>= 6.10.0', '< 7.0.0'
 
+  s.add_development_dependency 'chromedriver-helper'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'capybara'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'launchy'
-  s.add_development_dependency 'solr_wrapper', '~> 0.14'
+  s.add_development_dependency 'selenium-webdriver'
+  s.add_development_dependency 'solr_wrapper', '~> 2.2'
   s.add_development_dependency 'engine_cart', '~> 1.0'
+  s.add_development_dependency 'webdrivers'
 end

data/lib/blacklight_range_limit/range_limit_builder.rb

@@ -12,46 +12,48 @@ module BlacklightRangeLimit
 
     # Method added to to fetch proper things for date ranges.
     def add_range_limit_params(solr_params)
-       ranged_facet_configs = 
-         blacklight_config.facet_fields.select { |key, config| config.range } 
+       ranged_facet_configs =
+         blacklight_config.facet_fields.select { |key, config| config.range }
        # In ruby 1.8, hash.select returns an array of pairs, in ruby 1.9
-       # it returns a hash. Turn it into a hash either way.  
+       # it returns a hash. Turn it into a hash either way.
        ranged_facet_configs = Hash[ ranged_facet_configs ] unless ranged_facet_configs.kind_of?(Hash)
-       
+
        ranged_facet_configs.each_pair do |solr_field, config|
         solr_params["stats"] = "true"
         solr_params["stats.field"] ||= []
-        solr_params["stats.field"] << solr_field    
-      
+        solr_params["stats.field"] << solr_field
+
+        range_config = BlacklightRangeLimit.range_config(blacklight_config, config.field)
+
         hash =  blacklight_params["range"] && blacklight_params["range"][solr_field] ?
           blacklight_params["range"][solr_field] :
           {}
-          
+
         if !hash["missing"].blank?
           # missing specified in request params
           solr_params[:fq] ||= []
           solr_params[:fq] << "-#{solr_field}:[* TO *]"
-          
+
         elsif !(hash["begin"].blank? && hash["end"].blank?)
           # specified in request params, begin and/or end, might just have one
           start = hash["begin"].blank? ? "*" : hash["begin"]
           finish = hash["end"].blank? ? "*" : hash["end"]
-  
+
           solr_params[:fq] ||= []
           solr_params[:fq] << "#{solr_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, solr_field, 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, solr_field, boundaries[0], boundaries[1])
         end
       end
-      
+
       return solr_params
     end
 
@@ -59,10 +61,10 @@ module BlacklightRangeLimit
     # Another processing method, this one is NOT included in default processing chain,
     # it is specifically swapped in *instead of* add_range_limit_params for
     # certain ajax requests that only want to fetch range limit segments for
-    # ONE field. 
+    # ONE field.
     #
     # It turns off facetting and sets rows to 0 as well, only results for
-    # single specified field are needed. 
+    # single specified field are needed.
     #
     # Specified field and parameters are specified in incoming parameters
     # range_field, range_start, range_end
@@ -72,13 +74,13 @@ module BlacklightRangeLimit
       finish = blacklight_params[:range_end].to_i
 
       add_range_segments_to_solr!(solr_params, solr_field, start, finish )
-        
+
       # Remove all field faceting for efficiency, we won't be using it.
       solr_params.delete("facet.field")
       solr_params.delete("facet.field".to_sym)
 
       # We don't need any actual rows either
-      solr_params[:rows] = 0      
+      solr_params[:rows] = 0
 
       return solr_params
     end

data/lib/blacklight_range_limit/segment_calculation.rb

@@ -16,6 +16,8 @@ module BlacklightRangeLimit
 
       field_config = BlacklightRangeLimit.range_config(blacklight_config, solr_field)
 
+      return solr_params unless field_config
+
       solr_params[:"facet.query"] ||= []
 
       boundaries = boundaries_for_range_facets(min, max, (field_config[:num_segments] || 10) )
@@ -28,7 +30,7 @@ module BlacklightRangeLimit
         solr_params[:"facet.query"] << "#{solr_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

@@ -42,39 +42,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)
@@ -110,4 +97,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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'JavaScript', js: true do
+  context 'when assumed boundaries configured' do
+    before do
+      CatalogController.blacklight_config.facet_fields['pub_date_sort'].range = {
+        assumed_boundaries: [1990, 2000]
+      }
+    end
+
+    after do
+      CatalogController.blacklight_config.facet_fields['pub_date_sort'].range = true
+    end
+
+    it 'should show the range limit with set boundaries' do
+      visit '/catalog'
+
+      click_link 'Publication Date Sort'
+      expect(page).to have_field :range_pub_date_sort_begin, with: '1990'
+      expect(page).to have_field :range_pub_date_sort_end, with: '2000'
+    end
+  end
+end

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 .filterName', text: 'Date Range'
+      )
+      expect(constraints).to have_css(
+        '.constraint .filterValue', 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 .filterName', text: 'Date Range:'
+      )
+      expect(constraints).to have_css(
+        '.constraint .filterValues', 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/spec_helper.rb

@@ -5,6 +5,21 @@ EngineCart.load_application!
 
 require 'rspec/rails'
 require 'capybara/rspec'
+require 'selenium-webdriver'
+require 'webdrivers'
+
+Capybara.javascript_driver = :headless_chrome
+
+Capybara.register_driver :headless_chrome do |app|
+  Capybara::Selenium::Driver.load_selenium
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+    opts.args << '--headless'
+    opts.args << '--disable-gpu'
+    opts.args << '--no-sandbox'
+    opts.args << '--window-size=1280,1696'
+  end
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
+end
 
 RSpec.configure do |config|
   # rspec-rails 3 will no longer automatically infer an example group's spec type

data/spec/test_app_templates/Gemfile.extra

@@ -0,0 +1 @@
+gem 'sprockets', '< 4'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 6.3.3
+  version: 6.4.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2020-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,14 +17,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -45,14 +51,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: 6.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: 6.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: chromedriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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
@@ -123,20 +149,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: solr_wrapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: engine_cart
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +191,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - blacklight-development@googlegroups.com
@@ -214,11 +268,14 @@ files:
 - solr/conf/xslt/example_rss.xsl
 - solr/conf/xslt/luke.xsl
 - solr/sample_solr_documents.yml
+- spec/features/a_javascript_spec.rb
 - spec/features/blacklight_range_limit_spec.rb
 - 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
 - vendor/assets/javascripts/bootstrap-slider.js
 - vendor/assets/javascripts/flot/excanvas.min.js
@@ -244,15 +301,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Blacklight Range Limit plugin
 test_files:
+- spec/features/a_javascript_spec.rb
 - spec/features/blacklight_range_limit_spec.rb
 - 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