blacklight_range_limit 9.2.0 → 9.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb2770ee329bb6bc941864e6e371eab6f676a5aba369c9ece4aebb244703089d
-  data.tar.gz: ed51729efb72aa983fbe046995ab9b633cd31923a083f05579912b496a192942
+  metadata.gz: 795e8e6e2b3472dd8978285eabc633113251c2f14b9c59f506b13f9c3f0c402c
+  data.tar.gz: 53f4cc96793fea0579a7ebf85b44610d70dc9845594282cbd3f7034e7b6a9b60
 SHA512:
-  metadata.gz: f40f9917b407aa32b7cb5b0040fd69dde006f911cea0470ddf56c885985e84232ac70488db753a8b3d07efae7e48e3915474f98e9832ad1518c279e5de0347e8
-  data.tar.gz: faa8fe7325e92e8cc8694b67c89229c9f346471f06415069b0c5736efa797a1dba040e4b5033559639c36ac52ea21a05b5699b3ab081530aca23d2712bc342a5
+  metadata.gz: ca5b95998473a58142dfe87743ce359e18cc8272fb5e9fedf8ebddf0dab32ad673a1de5f5f0acbb01e85d9cfa9538b65f08ded53daddf0b3a7e0fabb95ed8095
+  data.tar.gz: 19c4558b8fded3636ef41e8f7bdfa1d2f31ddd553e85b9cb555172feb02bd6bc33c1096549513767ff75bdb015f0c8cfb42c65e78b71acc10f526536b690cbab

data/.github/workflows/ruby.yml

@@ -42,13 +42,13 @@ jobs:
           # BLACKLIGHT EDGE, can test with latest rails, importmap and esbuild
           #
 
-          - rails_version: "~> 8.1.0.rc1"
+          - rails_version: "~> 8.1.0"
             blacklight_version: 'https://github.com/projectblacklight/blacklight.git'
             ruby: "3.3"
             additional_name: "/ importmap-rails"
             additional_engine_cart_rails_options: "--css=bootstrap"
 
-          - rails_version: "~> 8.1.0.rc1"
+          - rails_version: "~> 8.1.0"
             blacklight_version: 'https://github.com/projectblacklight/blacklight.git'
             ruby: "3.3"
             additional_name: "/ esbuild"
@@ -57,13 +57,13 @@ jobs:
           # BLACKLIGHT 9 and with Rails 8 and 8.1
           #
 
-          - rails_version: "~> 8.1.0.rc1"
+          - rails_version: "~> 8.1.0"
             blacklight_version: '~> 9.0'
             ruby: "3.4"
             additional_name: "/ importmap-rails"
             additional_engine_cart_rails_options: "--css=bootstrap"
 
-          - rails_version: "~> 8.1.0.rc1"
+          - rails_version: "~> 8.1.0"
             blacklight_version: '~> 9.0'
             ruby: "3.4"
             additional_name: "/ esbuild"
@@ -85,13 +85,13 @@ jobs:
           # BLACKLIGHT 8, can test with use importmaps and esbuild, also rails 8 and 8.1
           # and a bit of 7.2
 
-          - rails_version: "~> 8.1.0.rc1"
+          - rails_version: "~> 8.1.0"
             blacklight_version: "~> 8.0"
             ruby: "3.3"
             additional_name: "/ importmap-rails, propshaft"
             additional_engine_cart_rails_options: "-a propshaft --css=bootstrap"
 
-          - rails_version: "~> 8.1.0.rc1"
+          - rails_version: "~> 8.1.0"
             blacklight_version: "~> 8.0"
             ruby: "3.3"
             additional_engine_cart_rails_options: "-a propshaft --javascript=esbuild --css=bootstrap"
@@ -131,24 +131,31 @@ jobs:
 
 
           # BLACKLIGHT 7, only test with esbuild, not sure if it supports importmaps, it won't generate it
+          # Blacklight 7 generator uses old `Bundler.with_clean_env`, so needs a bundler < 4. (there is no
+          # bundler 3!)
 
           - rails_version: "7.2.1"
             blacklight_version: "~> 7.0"
             ruby: "3.3"
             additional_engine_cart_rails_options: "--javascript=esbuild"
             additional_name: "/ esbuild, sprockets"
+            bundler: "2.7.2"
 
+            # This combo failed on BL 7.42.0, and we didn't have the capacity to fix/support.
+            # https://github.com/projectblacklight/blacklight_range_limit/issues/339
           - rails_version: "7.2.1"
-            blacklight_version: "~> 7.0"
+            blacklight_version: "7.41.0"
             ruby: "3.3"
             additional_engine_cart_rails_options: "--javascript=esbuild --css=bootstrap  -a propshaft"
             additional_name: "/ esbuild, propshaft"
+            bundler: "2.7.2"
 
           - rails_version: "7.1.4"
             blacklight_version: "~> 7.0"
             ruby: "3.2"
             additional_engine_cart_rails_options: "--javascript=esbuild"
             additional_name: "/ esbuild, sprockets"
+            bundler: "2.7.2"
 
 
     env:
@@ -161,7 +168,10 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler: "latest"
+          #bundler: ${{ matrix.bundler != '' && matrix.bundler || 'latest' }}
+          # Bundler locked to <4, see https://github.com/projectblacklight/blacklight_range_limit/pull/328
+          bundler: ${{ matrix.bundler != '' && matrix.bundler || '2.7.2' }}
+
 
       - name: Install dependencies
         run: bundle install

data/.solr_wrapper.yml

@@ -6,9 +6,11 @@
 
 port: 8983
 verbose: true
-version: 9.6.1
+version: 9.10.1
   <% ENV['CI'] && FileUtils.mkdir_p('ci_dl_solr_dist') %>
 download_dir: <%= 'ci_dl_solr_dist' if ENV['CI'] %>
 collection:
   dir: solr/conf/
   name: blacklight-core
+env:
+  SOLR_OPTS: "-Dsolr.config.lib.enabled=true"

data/README.md

@@ -19,7 +19,8 @@ Decimal numbers and Dates are NOT supported; they theoretically could be in the
 
 * Javascript requires you to be using either rails-importmaps or a package.json-based builder like jsbundling-rails or vite-ruby.  Legacy "sprockets-only" is not supported, however propshaft or sprockets can be used as your base asset pipeline.
 
-* Blacklight 7.0+.  Rails 7.0+
+* Blacklight 7.0+.  Rails 7.0+.
+  * Note blacklight 7.x >= 7.42.0 are no longer tested in CI, see https://github.com/projectblacklight/blacklight_range_limit/issues/339. They might still work.
 
 
 # Installation

data/VERSION

@@ -1 +1 @@
-9.2.0
+9.3.0

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

@@ -4,6 +4,7 @@
     @input_value,
     min: @min_value,
     max: @max_value,
+    inputmode: 'numeric',
     class: "form-control form-control-sm #{@css_class}" %>
 </div>
 

data/lib/blacklight_range_limit/range_limit_builder.rb

@@ -47,15 +47,15 @@ module BlacklightRangeLimit
     # Specified field and parameters are specified in incoming parameters
     # range_field, range_start, range_end
     def fetch_specific_range_limit(solr_params)
-      field_key = blacklight_params[:range_field] # what field to fetch for
+      field_key = _bl_range_limit_app_params[:range_field] # what field to fetch for
 
-      unless  blacklight_params[:range_start].present? && blacklight_params[:range_start].kind_of?(String) &&
-              blacklight_params[:range_end].present? && blacklight_params[:range_end].kind_of?(String)
+      unless  _bl_range_limit_app_params[:range_start].present? && _bl_range_limit_app_params[:range_start].kind_of?(String) &&
+              _bl_range_limit_app_params[:range_end].present? && _bl_range_limit_app_params[:range_end].kind_of?(String)
         raise BlacklightRangeLimit::InvalidRange
       end
 
-      start = blacklight_params[:range_start].to_i
-      finish = blacklight_params[:range_end].to_i
+      start = _bl_range_limit_app_params[:range_start].to_i
+      finish = _bl_range_limit_app_params[:range_end].to_i
 
       add_range_segments_to_solr!(solr_params, field_key, start, finish )
 
@@ -69,14 +69,29 @@ module BlacklightRangeLimit
       return solr_params
     rescue BlacklightRangeLimit::InvalidRange
       # This will make Rails return a 400
-      raise ActionController::BadRequest, "invalid range_start (#{blacklight_params[:range_start]}) or range_end (#{blacklight_params[:range_end]})"
+      raise ActionController::BadRequest, "invalid range_start (#{_bl_range_limit_app_params[:range_start]}) or range_end (#{_bl_range_limit_app_params[:range_end]})"
+    end
+
+    bl_version = Gem.loaded_specs["blacklight"]&.version
+
+    # get the query params correct way for old or newer blacklight
+    #
+    # https://github.com/projectblacklight/blacklight/pull/3851
+    # https://github.com/projectblacklight/blacklight/pull/3849
+    if bl_version && bl_version < Gem::Version.new("9.1.0")
+      def _bl_range_limit_app_params
+        blacklight_params
+      end
+    else
+      def _bl_range_limit_app_params
+        search_state.params
+      end
     end
 
     # hacky polyfill for new Blacklight behavior we need, if we don't have it yet
     #
     # https://github.com/projectblacklight/blacklight/pull/3213
     # https://github.com/projectblacklight/blacklight/pull/3443
-    bl_version = Gem.loaded_specs["blacklight"]&.version
     if bl_version && (bl_version <= Gem::Version.new("8.6.1"))
       def facet_value_to_fq_string(facet_field, value, use_local_params: true)
         facet_config = blacklight_config.facet_fields[facet_field]

data/lib/blacklight_range_limit/segment_calculation.rb

@@ -1,7 +1,6 @@
 # Meant to be in a Controller, included in our ControllerOverride module.
 module BlacklightRangeLimit
   module SegmentCalculation
-
     protected
 
     # Calculates segment facets within a given start and end on a given
@@ -12,7 +11,8 @@ module BlacklightRangeLimit
     #
     # Changes solr_params passed in.
     def add_range_segments_to_solr!(solr_params, facet_field, min, max)
-      raise InvalidRange, "The min date must be before the max date" if min > max
+      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
@@ -26,7 +26,7 @@ module BlacklightRangeLimit
       # 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
+        last =  boundaries[index + 1].to_i - 1
 
         solr_params[:"facet.query"] << "#{field_config.field}:[#{first} TO #{last}]"
       end
@@ -43,7 +43,8 @@ module BlacklightRangeLimit
     # 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)
-      raise ArgumentError, "The first date must be before the last date" if last < first
+      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
@@ -54,58 +55,55 @@ module BlacklightRangeLimit
 
       # Don't know what most of these variables mean, just copying
       # 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
+      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 )
-           size = 2.5;
-           dec = dec + 1
-         end
-       elsif (norm < 7.5)
-         size = 5
-       end
-
-       size = size * magn
-
-       boundaries = []
-
-       start = floorInBase(first, size)
-       i = 0
-       v = Float::MAX
-       prev = nil
-       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.
-       boundaries.delete_if {|b| b <= first || b >= last}
-       boundaries.unshift(first)
-       boundaries.push(last)
-
-       return boundaries
+      if norm < 1.5
+        size = 1
+      elsif norm < 3
+        size = 2
+        # special case for 2.5, requires an extra decimal
+        if norm > 2.25
+          size = 2.5
+          dec + 1
+        end
+      elsif norm < 7.5
+        size = 5
+      end
+
+      size *= magn
+
+      boundaries = []
+
+      start = floorInBase(first, size)
+      i = 0
+      v = Float::MAX
+      prev = nil
+      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.
+      boundaries.delete_if { |b| b <= first || b >= last }
+      boundaries.unshift(first)
+      boundaries.push(last)
+
+      boundaries
     end
 
     # Cribbed from Flot.  Round to nearby lower multiple of base
     def floorInBase(n, base)
-       return base * (n / base).floor
+      base * (n / base).floor
     end
-
-
-
   end
 end

data/lib/generators/blacklight_range_limit/assets_generator.rb

@@ -77,9 +77,9 @@ module BlacklightRangeLimit
             # chart.js is dependency of blacklight-range-limit, currently is not working
             # as vendored importmaps, but instead must be pinned to CDN. You may want to update
             # versions perioidically.
-            pin "chart.js", to: "https://ga.jspm.io/npm:chart.js@4.2.0/dist/chart.js"
+            pin "chart.js", to: "https://cdn.jsdelivr.net/npm/chart.js@4.5.1/+esm"
             # single dependency of chart.js:
-            pin "@kurkle/color", to: "https://ga.jspm.io/npm:@kurkle/color@0.3.2/dist/color.esm.js"
+            pin "@kurkle/color", to: "https://cdn.jsdelivr.net/npm/@kurkle/color@0.4.0/dist/color.esm.min.js"
           EOS
         end
       else

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-range-limit",
-  "version": "9.2.0",
+  "version": "9.3.0",
   "description": "A range facet UI component plugin for blacklight",
   "type": "module",
 

data/solr/conf/schema.xml

@@ -71,7 +71,7 @@
     <dynamicField name="*_isi" type="int" stored="true" indexed="true" multiValued="false"/>
     <dynamicField name="*_isim" type="int" stored="true" indexed="true" multiValued="true"/>
 
-    <!-- trie integer (_it...) (for faster range queries) -->
+    <!-- IntegerPointField (_it...) (for faster range queries) -->
 
     <dynamicField name="*_iti" type="tint" stored="false" indexed="true" multiValued="false"/>
     <dynamicField name="*_itim" type="tint" stored="false" indexed="true" multiValued="true"/>
@@ -93,7 +93,7 @@
     <dynamicField name="*_dtsi" type="date" stored="true" indexed="true" multiValued="false"/>
     <dynamicField name="*_dtsim" type="date" stored="true" indexed="true" multiValued="true"/>
 
-    <!-- trie date (_dtt...) (for faster range queries) -->
+    <!-- DatePointField (_dtt...) (for faster range queries) -->
 
     <dynamicField name="*_dtti" type="tdate" stored="false" indexed="true" multiValued="false"/>
     <dynamicField name="*_dttim" type="tdate" stored="false" indexed="true" multiValued="true"/>
@@ -113,7 +113,7 @@
     <dynamicField name="*_lsi" type="long" stored="true" indexed="true" multiValued="false"/>
     <dynamicField name="*_lsim" type="long" stored="true" indexed="true" multiValued="true"/>
 
-    <!-- trie long (_lt...) (for faster range queries) -->
+    <!-- LongPointField (_lt...) (for faster range queries) -->
 
     <dynamicField name="*_lti" type="tlong" stored="false" indexed="true" multiValued="false"/>
     <dynamicField name="*_ltim" type="tlong" stored="false" indexed="true" multiValued="true"/>
@@ -133,7 +133,7 @@
     <dynamicField name="*_dbsi" type="double" stored="true" indexed="true" multiValued="false"/>
     <dynamicField name="*_dbsim" type="double" stored="true" indexed="true" multiValued="true"/>
 
-    <!-- trie double (_dbt...) (for faster range queries) -->
+    <!-- DoublePointField (_dbt...) (for faster range queries) -->
 
     <dynamicField name="*_dbti" type="tdouble" stored="false" indexed="true" multiValued="false"/>
     <dynamicField name="*_dbtim" type="tdouble" stored="false" indexed="true" multiValued="true"/>
@@ -153,7 +153,7 @@
     <dynamicField name="*_fsi" type="float" stored="true" indexed="true" multiValued="false"/>
     <dynamicField name="*_fsim" type="float" stored="true" indexed="true" multiValued="true"/>
 
-    <!-- trie float (_ft...) (for faster range queries) -->
+    <!-- FloatPointField (_ft...) (for faster range queries) -->
 
     <dynamicField name="*_fti" type="tfloat" stored="false" indexed="true" multiValued="false"/>
     <dynamicField name="*_ftim" type="tfloat" stored="false" indexed="true" multiValued="true"/>
@@ -175,6 +175,16 @@
     <dynamicField name="*_coordinate" type="tdouble" indexed="true"  stored="false" />
 
 
+    <!-- location (_ll...) -->
+
+    <dynamicField name="*_lli" type="location" stored="false" indexed="true" multiValued="false"/>
+    <dynamicField name="*_llim" type="location" stored="false" indexed="true" multiValued="true"/>
+
+    <dynamicField name="*_lls" type="location" stored="true" indexed="false" multiValued="false"/>
+    <dynamicField name="*_llsm" type="location" stored="true" indexed="false" multiValued="true"/>
+    <dynamicField name="*_llsi" type="location" stored="true" indexed="true" multiValued="false"/>
+    <dynamicField name="*_llsim" type="location" stored="true" indexed="true" multiValued="true"/>
+
     <dynamicField name="*_srpt" type="location_rpt" stored="true" indexed="true" multiValued="true" />
     <dynamicField name="*_bbox" type="bbox" stored="true" indexed="true" />
 
@@ -221,23 +231,23 @@
     <fieldType name="rand" class="solr.RandomSortField" omitNorms="true"/>
 
     <!-- Default numeric field types.  -->
-    <fieldType name="int" class="solr.TrieIntField" precisionStep="0" positionIncrementGap="0"/>
-    <fieldType name="float" class="solr.TrieFloatField" precisionStep="0" positionIncrementGap="0"/>
-    <fieldType name="long" class="solr.TrieLongField" precisionStep="0" positionIncrementGap="0"/>
-    <fieldType name="double" class="solr.TrieDoubleField" precisionStep="0" positionIncrementGap="0"/>
+    <fieldType name="int" class="solr.IntPointField" docValues="true"/>
+    <fieldType name="float" class="solr.FloatPointField" docValues="true"/>
+    <fieldType name="long" class="solr.LongPointField" docValues="true"/>
+    <fieldType name="double" class="solr.DoublePointField" docValues="true"/>
 
-    <!-- trie numeric field types for faster range queries -->
-    <fieldType name="tint" class="solr.TrieIntField" precisionStep="8" positionIncrementGap="0"/>
-    <fieldType name="tfloat" class="solr.TrieFloatField" precisionStep="8" positionIncrementGap="0"/>
-    <fieldType name="tlong" class="solr.TrieLongField" precisionStep="8" positionIncrementGap="0"/>
-    <fieldType name="tdouble" class="solr.TrieDoubleField" precisionStep="8" positionIncrementGap="0"/>
+    <!-- PointField numeric field types for faster range queries -->
+    <fieldType name="tint" class="solr.IntPointField" docValues="true"/>
+    <fieldType name="tfloat" class="solr.FloatPointField" docValues="true"/>
+    <fieldType name="tlong" class="solr.LongPointField" docValues="true"/>
+    <fieldType name="tdouble" class="solr.DoublePointField" docValues="true"/>
 
     <!-- The format for this date field is of the form 1995-12-31T23:59:59Z
          Optional fractional seconds are allowed: 1995-12-31T23:59:59.999Z
       -->
-    <fieldType name="date" class="solr.TrieDateField" precisionStep="0" positionIncrementGap="0"/>
-    <!-- A Trie based date field for faster date range queries and date faceting. -->
-    <fieldType name="tdate" class="solr.TrieDateField" precisionStep="6" positionIncrementGap="0"/>
+    <fieldType name="date" class="solr.DatePointField" docValues="true"/>
+    <!-- A PointField based date field for faster date range queries and date faceting. -->
+    <fieldType name="tdate" class="solr.DatePointField" docValues="true"/>
 
 
     <!-- This point type indexes the coordinates as separate fields (subFields)
@@ -253,6 +263,9 @@
      -->
     <fieldType name="point" class="solr.PointType" dimension="2" subFieldSuffix="_d"/>
 
+    <!-- A specialized field for geospatial search filters and distance sorting. -->
+    <fieldType name="location" class="solr.LatLonPointSpatialField" docValues="true"/>
+
     <!-- An alternative geospatial field type new to Solr 4.  It supports multiValued and polygon shapes.
       For more information about this and other Spatial fields new to Solr 4, see:
       http://wiki.apache.org/solr/SolrAdaptersForLuceneSpatial4
@@ -263,7 +276,7 @@
     <field name="bbox" type="bbox" />
     <fieldType name="bbox" class="solr.BBoxField"
                geo="true" distanceUnits="kilometers" numberType="_bbox_coord" storeSubFields="false"/>
-    <fieldType name="_bbox_coord" class="solr.TrieDoubleField" precisionStep="8" docValues="true" stored="false"/>
+    <fieldType name="_bbox_coord" class="solr.DoublePointField" docValues="true" stored="false"/>
 
     <fieldType name="text" class="solr.TextField" omitNorms="false">
       <analyzer>
@@ -373,3 +386,4 @@
   </types>
 
 </schema>
+

data/spec/test_app_templates/Gemfile.extra

@@ -8,3 +8,8 @@ if ENV['BLACKLIGHT_VERSION']
   end
 end
 
+
+# pin json to less than 3 in Gemfile until Rails has some releases that work
+# with json 3, at which point we can relax for versions that can handle it
+# https://github.com/rails/rails/pull/58601
+gem "json", "< 3"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 9.2.0
+  version: 9.3.0
 platform: ruby
 authors:
 - Jonathan Rochkind