blacklight_range_limit 6.1.2 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97ddf1ebca36774bb73a9d4d4de5fd6b99ea0bb4
-  data.tar.gz: e47912a11157c9123a360c04b73cf09f2cded2cb
+  metadata.gz: eb869c85a59ab43a06d60fcbe6515595c68ef57c
+  data.tar.gz: 32b3de05633cd25ca26465840e1d50afe7bceeaa
 SHA512:
-  metadata.gz: 578e651961133f7e5a1f7f524b7c6aec58c9b3895017a30efad6d387b080a008851352b71d2d182ffd7ae06928764c4e447e9b76bfc82e84792ab4f8d30a6411
-  data.tar.gz: 99437a54195da9626c8c41bec83705979e7be2a0fde3016f0e3d4cd10133b55c9d7cbcd5d64f99968ce19b499d4a53d3d9f6a8ce4dc6410fe41f46fde24f9cb4
+  metadata.gz: a4209b4107bfc5c05794aa238f7fe17020f98cd2f4a91a3a242a6884eb1305fc7f6bc4175f1196a6e28632d8b682123b77123f5a9e3523c86d4acb9ddb0133a8
+  data.tar.gz: d85a7d7ff3057d76355e8417d417f2e23b50f274caad3e06d75e679f990b9928dc20570ce5fcff5ace4b907740ed9fadaa58bcc56ed6222c3b4bddfdd5d6774a

data/VERSION

@@ -1 +1 @@
-6.1.2
+6.2.0

data/app/views/blacklight_range_limit/_range_limit_panel.html.erb

@@ -29,7 +29,7 @@
   <% end %>
 
   <% unless params["range"] && params["range"][solr_field] && params["range"][solr_field]["missing"] %>  
-    <%= form_tag search_action_path, :method => :get, :class=>"range_limit subsection range_#{solr_field} form-inline" do %>
+    <%= form_tag search_action_path, :method => :get, class: [BlacklightRangeLimit.classes[:form], "range_#{solr_field}"].join(' ') do %>
       <%= render_hash_as_hidden_fields(search_state.params_for_search) %>
       
       <!-- we need to include a dummy search_field parameter if none exists,
@@ -40,7 +40,7 @@
       <% end %>
       
       <%= render_range_input(solr_field, :begin, input_label_range_begin, maxlength) %> – <%= render_range_input(solr_field, :end, input_label_range_end, maxlength) %>
-      <%= submit_tag t('blacklight.range_limit.submit_limit'), :class=>'submit btn btn-default' %>
+      <%= submit_tag t('blacklight.range_limit.submit_limit'), class: BlacklightRangeLimit.classes[:submit] %>
     
     <% end %>
   <% end %>

data/blacklight_range_limit.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'rails', '>= 3.0'
   s.add_dependency 'jquery-rails' # our JS needs jquery_rails
-  s.add_dependency 'blacklight', '~> 6.0'
-  
+  s.add_dependency 'blacklight', '>= 6.0.2'
+
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'capybara'

data/lib/blacklight_range_limit.rb

@@ -10,11 +10,18 @@ module BlacklightRangeLimit
 
   autoload :Routes, 'blacklight_range_limit/routes'
 
-  mattr_accessor :labels
+  # Raised when an invalid range is encountered
+  class InvalidRange < TypeError; end
+
+  mattr_accessor :labels, :classes
   self.labels = {
     :missing => "Unknown"
   }
-  
+  self.classes = {
+    form: 'range_limit subsection form-inline',
+    submit: 'submit btn btn-default'
+  }
+
   # Add element to array only if it's not already there
   def self.safe_arr_add(array, element)
     array << element unless array.include?(element)
@@ -22,11 +29,11 @@ module BlacklightRangeLimit
 
   # Convenience method for returning range config hash from
   # blacklight config, for a specific solr field, in a normalized
-  # way. 
+  # way.
   #
-  # Returns false if range limiting not configured. 
+  # Returns false if range limiting not configured.
   # Returns hash even if configured to 'true'
-  # for consistency. 
+  # for consistency.
   def self.range_config(blacklight_config, solr_field)
     field = blacklight_config.facet_fields[solr_field.to_s]
 

data/lib/blacklight_range_limit/engine.rb

@@ -9,5 +9,9 @@ module BlacklightRangeLimit
     initializer "blacklight_range_limit.assets", :after => "assets" do
       Rails.application.config.assets.precompile += %w( flot/excanvas.min.js )
     end
+
+    config.action_dispatch.rescue_responses.merge!(
+      "BlacklightRangeLimit::InvalidRange" => :not_acceptable
+    )
   end
 end

data/lib/blacklight_range_limit/segment_calculation.rb

@@ -3,32 +3,34 @@ module BlacklightRangeLimit
   module SegmentCalculation
 
     protected
-    
+
     # Calculates segment facets within a given start and end on a given
     # field, returns request params to be added on to what's sent to
     # solr to get the calculated facet segments.
     # Assumes solr_field is an integer, as range endpoint will be found
     # by subtracting one from subsequent boundary.
     #
-    # Changes solr_params passed in. 
+    # Changes solr_params passed in.
     def add_range_segments_to_solr!(solr_params, solr_field, min, max)
-      field_config = BlacklightRangeLimit.range_config(blacklight_config, solr_field)    
-    
+      raise InvalidRange, "The min date must be before the max date" if min > max
+
+      field_config = BlacklightRangeLimit.range_config(blacklight_config, solr_field)
+
       solr_params[:"facet.query"] ||= []
-      
-      boundaries = boundaries_for_range_facets(min, max, (field_config[:num_segments] || 10) ) 
-      
+
+      boundaries = boundaries_for_range_facets(min, max, (field_config[:num_segments] || 10) )
+
       # Now make the boundaries into actual filter.queries.
       0.upto(boundaries.length - 2) do |index|
         first = boundaries[index]
         last =  boundaries[index+1].to_i - 1
-      
+
         solr_params[:"facet.query"] << "#{solr_field}:[#{first} TO #{last}]"
       end
-  
+
       return solr_params
     end
-  
+
     # returns an array of 'boundaries' for producing approx num_div
     # segments between first and last.  The boundaries are 'nicefied'
     # to factors of 5 or 10, so exact number of segments may be more
@@ -36,70 +38,71 @@ module BlacklightRangeLimit
     #
     # Because of arithmetic issues with creating boundaries that will
     # be turned into inclusive ranges, the FINAL boundary will be one
-    # unit more than the actual end of the last range later computed. 
-    def boundaries_for_range_facets(first, last, num_div)    
+    # unit more than the actual end of the last range later computed.
+    def boundaries_for_range_facets(first, last, num_div)
+      raise ArgumentError, "The first date must be before the last date" if last < first
       # arithmetic issues require last to be one more than the actual
       # last value included in our inclusive range
       last += 1
-    
+
       # code cribbed from Flot auto tick calculating, but leaving out
-      # some of Flot's options becuase it started to get confusing. 
+      # some of Flot's options becuase it started to get confusing.
       delta = (last - first).to_f / num_div
-    
+
       # Don't know what most of these variables mean, just copying
-      # from Flot. 
+      # from Flot.
       dec = -1 * ( Math.log10(delta) ).floor
       magn = (10 ** (-1 * dec)).to_f
       norm = (magn == 0) ? delta : (delta / magn) # norm is between 1.0 and 10.0
-  
+
       size = 10
        if (norm < 1.5)
          size = 1
        elsif (norm < 3)
          size = 2;
          # special case for 2.5, requires an extra decimal
-         if (norm > 2.25 ) 
+         if (norm > 2.25 )
            size = 2.5;
            dec = dec + 1
-         end                
+         end
        elsif (norm < 7.5)
          size = 5
        end
-      
+
        size = size * magn
-  
-       boundaries = []     
-  
+
+       boundaries = []
+
        start = floorInBase(first, size)
        i = 0
        v = Float::MAX
        prev = nil
-       begin 
+       begin
          prev = v
          v = start + i * size
          boundaries.push(v.to_i)
          i += 1
        end while ( v < last && v != prev)
-  
+
        # Can create dups for small ranges, tighten up
        boundaries.uniq!
-       
+
        # That algorithm i don't entirely understand will sometimes
        # extend past our first and last, tighten it up and make sure
-       # first and last are endpoints.     
+       # first and last are endpoints.
        boundaries.delete_if {|b| b <= first || b >= last}
        boundaries.unshift(first)
        boundaries.push(last)
-  
+
        return boundaries
     end
-  
+
     # Cribbed from Flot.  Round to nearby lower multiple of base
-    def floorInBase(n, base) 
+    def floorInBase(n, base)
        return base * (n / base).floor
     end
 
 
-    
+
   end
 end

data/lib/blacklight_range_limit/view_helper_override.rb

@@ -1,10 +1,10 @@
   # Meant to be applied on top of Blacklight helpers, to over-ride
   # Will add rendering of limit itself in sidebar, and of constraings
-  # display. 
+  # display.
   module BlacklightRangeLimit::ViewHelperOverride
 
 
-    
+
     def facet_partial_name(display_facet)
       return "blacklight_range_limit/range_limit_panel" if range_config(display_facet.name) and should_show_limit(display_facet.name)
       super
@@ -12,8 +12,8 @@
 
     def has_range_limit_parameters?(my_params = params)
       my_params[:range] &&
-        my_params[:range].any? do |key, v|
-          v.present? && v.respond_to?(:'[]') && 
+        my_params[:range].to_unsafe_h.any? do |key, v|
+          v.present? && v.respond_to?(:'[]') &&
           (v["begin"].present? || v["end"].present? || v["missing"].present?)
         end
     end
@@ -52,7 +52,7 @@
             range_display(solr_field, my_params),
             :escape_value => false,
             :remove => remove_range_param(solr_field, my_params)
-          )                      
+          )
         end
       end
       return content
@@ -63,14 +63,14 @@
       # 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?)        
-          
+          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
       end
       return content
@@ -89,7 +89,7 @@
     # Looks in the solr @response for ["facet_counts"]["facet_queries"][solr_field], for elements
     # expressed as "solr_field:[X to Y]", turns them into
     # a list of hashes with [:from, :to, :count], sorted by
-    # :from. Assumes integers for sorting purposes. 
+    # :from. Assumes integers for sorting purposes.
     def solr_range_queries_to_a(solr_field)
       return [] unless @response["facet_counts"] && @response["facet_counts"]["facet_queries"]
 
@@ -108,6 +108,5 @@
     def range_config(solr_field)
       BlacklightRangeLimit.range_config(blacklight_config, solr_field)
     end
-    
-  end
 
+  end

data/spec/lib/blacklight_range_limit/segment_calculation_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+RSpec.describe BlacklightRangeLimit::SegmentCalculation do
+  let(:dummy_class) do
+    Class.new do
+      include BlacklightRangeLimit::SegmentCalculation
+    end
+  end
+
+  describe '#boundaries_for_range_facets' do
+    subject { dummy_class.new.send(:boundaries_for_range_facets, first, last, num_div) }
+
+    context "the happy path" do
+      let(:first) { 1000 }
+      let(:last) { 2008 }
+      let(:num_div) { 10 }
+
+      it { is_expected.to eq [1000, 1100, 1200, 1300, 1400, 1500, 1600, 1700, 1800, 1900, 2000, 2009] }
+    end
+
+    context 'when the last is before the first' do
+      let(:first) { 1000 }
+      let(:last) { 800 }
+      let(:num_div) { 3 }
+
+      it 'raises and error' do
+        expect { subject }.to raise_error ArgumentError,
+                                          'The first date must be before the last date'
+      end
+    end
+  end
+
+  describe "#add_range_segments_to_solr!" do
+    subject { dummy_class.new.send(:add_range_segments_to_solr!, solr_params, solr_field, min, max) }
+
+    let(:solr_params) { {} }
+    let(:solr_field) { 'date_dt' }
+
+    context 'when the last is before the first' do
+      let(:min) { 1000 }
+      let(:max) { 800 }
+
+      it 'raises an error' do
+        expect { subject }.to raise_error BlacklightRangeLimit::InvalidRange,
+                                          'The min date must be before the max date'
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 6.1.2
+  version: 6.2.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,16 +43,16 @@ dependencies:
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.0.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -217,6 +217,7 @@ files:
 - 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/spec_helper.rb
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - vendor/assets/javascripts/bootstrap-slider.js
@@ -252,5 +253,6 @@ test_files:
 - 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/spec_helper.rb
 - spec/test_app_templates/lib/generators/test_app_generator.rb