blacklight_range_limit 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3332162f26f3c37988434d3f9f5cfcf4ad3f8ac
-  data.tar.gz: 1b58632167c84866a291472c294540977417fce6
+  metadata.gz: 370e3efeb2a4d7b7256ed5110183816b00291c7a
+  data.tar.gz: a483e4d5767c82b12ba43445bf9d071ef318210d
 SHA512:
-  metadata.gz: 8cae1eb92de55315ef2318ce89029b2bb70bcb2bcdea411b6adc5a94470fceadd6d3d3be551f0af364710ed01aab5125a7561a4d4a3c49ddabfdf422f8895005
-  data.tar.gz: 7f2356c2213b6c1bf522f9ad7e7c555a497c44a187d50c8e185fc07c0bc6f178d23a8e22521bcbca31e7a2ca033f8843b67fb3e53ed07c7b3a9be4fe4b31b713
+  metadata.gz: 280bc39080fd5ec46d354422505ea09a2dec4a978f2ef8e6aef7ece8d4e974250aea22e412b9f91378b6a978132c6bb7d76cd98cb136186720a454daaaf99521
+  data.tar.gz: 5b393841ea0a2c52452b75b84d0bd4f5c5f69bc2846f652877054bd49f94027930ce59d30b98d4bf638312c0041292460968a7b441b193d76ea5d68e0b848e91

data/.travis.yml

@@ -2,13 +2,17 @@ notifications:
   email: false
 
 language: ruby
-cache: bundler
 sudo: false
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.2.2
+
+before_install:
+  - gem install bundler
 
 notifications:
   irc: "irc.freenode.org#blacklight"
   email:
       - blacklight-commits@googlegroups.com
+
+global_env:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Gemfile

@@ -16,3 +16,10 @@ else
     gem 'sass-rails', "< 5.0"
   end
 end
+
+# I'm sorry, this is harsh and I think ought to be done some other way with
+# engine_cart, but I don't understand how or what's going on, and this
+# is all I could to avoid:
+# undefined method `type' for .focus:Sass::Selector::Class
+#         (in .../blacklight_range_limit/spec/internal/app/assets/stylesheets/blacklight.css.scss)
+gem 'sass', "~> 3.4"

data/VERSION

@@ -1 +1 @@
-5.1.0
+5.2.0

data/blacklight_range_limit.gemspec

@@ -18,10 +18,8 @@ Gem::Specification.new do |s|
   s.license     = "Apache 2.0"
 
   s.add_dependency "rails", ">= 3.0", "< 5.0"
-  s.add_dependency "jquery-rails" # our JS needs jquery_rails
-  # for blacklight, we want to allow 5.0.0.preX, as well as all 5.x.y, 
-  # but not 6. can't seem to make it do so other than this:
-  s.add_dependency "blacklight", ">= 5.0.0.pre4", "< 6"
+  s.add_dependency "jquery-rails" # our JS needs jquery_rails  
+  s.add_dependency "blacklight", "~> 5.15"
 
   s.add_development_dependency "rspec", "~> 3.0"
   s.add_development_dependency "rspec-rails"

data/lib/blacklight_range_limit.rb

@@ -1,9 +1,10 @@
 # BlacklightRangeLimit
 
 module BlacklightRangeLimit
-  autoload :ControllerOverride, 'blacklight_range_limit/controller_override'
-  autoload :ViewHelperOverride, 'blacklight_range_limit/view_helper_override'
-  autoload :RouteSets, 'blacklight_range_limit/route_sets'
+  require 'blacklight_range_limit/range_limit_builder'
+  require 'blacklight_range_limit/controller_override'
+  require 'blacklight_range_limit/view_helper_override'
+  require 'blacklight_range_limit/route_sets'
 
   require 'blacklight_range_limit/version'
   require 'blacklight_range_limit/engine'
@@ -51,5 +52,23 @@ module BlacklightRangeLimit
   def self.safe_arr_add(array, element)
     array << element unless array.include?(element)
   end
+
+  # Convenience method for returning range config hash from
+  # blacklight config, for a specific solr field, in a normalized
+  # way. 
+  #
+  # Returns false if range limiting not configured. 
+  # Returns hash even if configured to 'true'
+  # for consistency. 
+  def self.range_config(blacklight_config, solr_field)
+    field = blacklight_config.facet_fields[solr_field.to_s]
+
+    return false unless field.range
+
+    config = field.range
+    config = {} if config === true
+
+    config
+  end
   
 end

data/lib/blacklight_range_limit/controller_override.rb

@@ -4,19 +4,25 @@
 require 'blacklight_range_limit/segment_calculation'
 module BlacklightRangeLimit
   module ControllerOverride
-    include SegmentCalculation
     extend ActiveSupport::Concern
   
-    included do
-      solr_search_params_logic << :add_range_limit_params
-      helper_method :range_config
-  
-      
-      
+    included do        
       unless BlacklightRangeLimit.omit_inject[:view_helpers]
         helper BlacklightRangeLimit::ViewHelperOverride
         helper RangeLimitHelper
       end
+
+      if self.respond_to? :search_params_logic
+        search_params_logic << :add_range_limit_params
+      end
+      if self.blacklight_config.search_builder_class
+        unless self.blacklight_config.search_builder_class.include?(BlacklightRangeLimit::RangeLimitBuilder)
+          self.blacklight_config.search_builder_class.send(:include,  
+              BlacklightRangeLimit::RangeLimitBuilder  
+          ) 
+          self.blacklight_config.search_builder_class.default_processor_chain << :add_range_limit_params
+        end
+      end
     end
   
     # Action method of our own!
@@ -24,88 +30,17 @@ module BlacklightRangeLimit
     # Used when we need a second Solr query to get range facets, after the
     # first found min/max from result set. 
     def range_limit
-      solr_field = params[:range_field] # what field to fetch for
-      start = params[:range_start].to_i
-      finish = params[:range_end].to_i
-      
-      solr_params = solr_search_params(params)
-  
-      # Remove all field faceting for efficiency, we won't be using it.
-      solr_params.delete("facet.field")
-      solr_params.delete("facet.field".to_sym)
-      
-      add_range_segments_to_solr!(solr_params, solr_field, start, finish )
-      # We don't need any actual rows or facets, we're just going to look
-      # at the facet.query's
-      solr_params[:rows] = 0
-      solr_params[:facets] = nil
-      solr_params[:qt] ||= blacklight_config.qt
-      # Not really any good way to turn off facet.field's from the solr default,
-      # no big deal it should be well-cached at this point.
-
-      @response = Blacklight.default_index.connection.get( blacklight_config.solr_path, :params => solr_params )
+      # We need to swap out the add_range_limit_params search param filter,
+      # and instead add in our fetch_specific_range_limit filter,
+      # to fetch only the range limit segments for only specific
+      # field (with start/end params) mentioned in query params
+      # range_field, range_start, and range_end
 
-      render('blacklight_range_limit/range_segments', :locals => {:solr_field => solr_field}, :layout => !request.xhr?)
-    end
-    
-    # Method added to solr_search_params_logic to fetch
-    # proper things for date ranges. 
-    def add_range_limit_params(solr_params, req_params)
-       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.  
-       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    
-      
-        hash =  req_params["range"] && req_params["range"][solr_field] ?
-          req_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 != "*")
-            # 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)
-          # assumed_boundaries in config
-          add_range_segments_to_solr!(solr_params, solr_field, boundaries[0], boundaries[1])
-        end
+      @response, _ = search_results(params, search_params_logic) do |search_builder|
+        search_builder.except(:add_range_limit_params).append(:fetch_specific_range_limit)
       end
-      
-      return solr_params
-    end
-  
-    # Returns range config hash for named solr field. Returns false
-    # if not configured. Returns hash even if configured to 'true'
-    # for consistency. 
-    def range_config(solr_field)
-      field = blacklight_config.facet_fields[solr_field.to_s]
-
-      return false unless field.range
-
-      config = field.range
-      config = {} if config === true
 
-      config
+      render('blacklight_range_limit/range_segments', :locals => {:solr_field => params[:range_field]}, :layout => !request.xhr?)
     end
   end
 end

data/lib/blacklight_range_limit/range_limit_builder.rb

@@ -0,0 +1,83 @@
+require 'blacklight_range_limit/segment_calculation'
+
+module BlacklightRangeLimit
+  module RangeLimitBuilder
+    include BlacklightRangeLimit::SegmentCalculation
+
+    # Method added to solr_search_params_logic to fetch
+    # proper things for date ranges. This should be added in by default to standard
+    # processing chain. 
+    def add_range_limit_params(solr_params)
+       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.  
+       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    
+      
+        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 != "*")
+            # 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)
+          # assumed_boundaries in config
+          add_range_segments_to_solr!(solr_params, solr_field, boundaries[0], boundaries[1])
+        end
+      end
+      
+      return solr_params
+    end
+
+
+    # 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. 
+    #
+    # It turns off facetting and sets rows to 0 as well, only results for
+    # single specified field are needed. 
+    #
+    # Specified field and parameters are specified in incoming parameters
+    # range_field, range_start, range_end
+    def fetch_specific_range_limit(solr_params)
+      solr_field = blacklight_params[:range_field] # what field to fetch for
+      start = blacklight_params[:range_start].to_i
+      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      
+
+      return solr_params
+    end
+
+  end
+end

data/lib/blacklight_range_limit/segment_calculation.rb

@@ -12,7 +12,7 @@ module BlacklightRangeLimit
     #
     # Changes solr_params passed in. 
     def add_range_segments_to_solr!(solr_params, solr_field, min, max)
-      field_config = range_config(solr_field)    
+      field_config = BlacklightRangeLimit.range_config(blacklight_config, solr_field)    
     
       solr_params[:"facet.query"] ||= []
       
@@ -98,6 +98,8 @@ module BlacklightRangeLimit
     def floorInBase(n, base) 
        return base * (n / base).floor
     end
+
+
     
   end
 end

data/lib/blacklight_range_limit/view_helper_override.rb

@@ -103,6 +103,10 @@
 
       return array
     end
+
+    def range_config(solr_field)
+      BlacklightRangeLimit.range_config(blacklight_config, solr_field)
+    end
     
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2015-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -49,22 +49,16 @@ dependencies:
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0.pre4
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0.pre4
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.15'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +196,7 @@ files:
 - lib/blacklight_range_limit.rb
 - lib/blacklight_range_limit/controller_override.rb
 - lib/blacklight_range_limit/engine.rb
+- lib/blacklight_range_limit/range_limit_builder.rb
 - lib/blacklight_range_limit/route_sets.rb
 - lib/blacklight_range_limit/segment_calculation.rb
 - lib/blacklight_range_limit/version.rb