blacklight_range_limit 8.2.3 → 8.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ffae79e3156b14c7ad9b8c1c98bfb4862a9976996c9fafb9962d2f03d9688e4
-  data.tar.gz: 37bec61cbc86e6facaa7052e9a84a561664a0538fdfbd53c71960be16c35b5f3
+  metadata.gz: f27dcb701e35e32cec10ac4e6c203264c1fc5681cc7d754af1085eb8c5cf8e82
+  data.tar.gz: 3189accdc1592a669f87e65729d1fc174794db399b847a43d8b354a2597137d1
 SHA512:
-  metadata.gz: d3e17cf2f4a0a4851f585c2309a5f2c4dde6ff1ab24c0f168b17fd56e7fe3c416facede0bb6c9fa7e4a9e60842f0fa04b7c2d3f525e035d4374879dada9988a9
-  data.tar.gz: 5d8b218cb0063215f452f1debc5b7ba5e04530fb3fc16b7eae90ca670dd45684a223bf49261d8fbd2b4cb36a7807125141365a86aa89618891558a38a13e73e3
+  metadata.gz: ec927ebe8aff759c1cd16911203cb65f2687c7df61914ee9a01f51d4469eff66f5b41a51c0a17fbaf6bb838f8b8ca5757f6f4df1f70fd66b662b8d55368e67a2
+  data.tar.gz: 772c9541b39355fd40e9c6c822563864bc02ad944a9fec4a2eaa29bb2ebfec7964c826e1e8462f38c38119aee235179dd969a623764c44800a9c3ca95776e812

data/.github/workflows/ruby.yml

@@ -20,15 +20,15 @@ jobs:
     strategy:
       matrix:
         ruby: [2.7, '3.0']
-        rails_version: ['6.1.5', '7.0.2.3']
+        rails_version: ['6.1.7.1', '7.0.4.1']
         additional_engine_cart_rails_options: ['']
         include:
-        - ruby: '2.7'
-          rails_version: '5.2.4.2'
+        - ruby: '3.2'
+          rails_version: '7.0.4.1'
         - ruby: '3.1'
-          rails_version: '7.0.2.3'
+          rails_version: '7.0.4.1'
         - ruby: '3.0'
-          rails_version: '7.0.2.3'
+          rails_version: '7.0.4.1'
     env:
       RAILS_VERSION: ${{ matrix.rails_version }}
       ENGINE_CART_RAILS_OPTIONS: "--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test ${{ matrix.engine_cart_rails_options }}"

data/Gemfile

@@ -10,8 +10,8 @@ group :test do
 end
 
 # BEGIN ENGINE_CART BLOCK
-# engine_cart: 0.10.0
-# engine_cart stanza: 0.10.0
+# engine_cart: 2.5.0
+# engine_cart stanza: 2.5.0
 # the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
 file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
 if File.exist?(file)
@@ -31,11 +31,16 @@ else
     else
       gem 'rails', ENV['RAILS_VERSION']
     end
-  end
 
-  case ENV['RAILS_VERSION']
-  when /^5.[12]/, /^6.0/
-    gem 'sass-rails', '~> 5.0'
+    case ENV['RAILS_VERSION']
+    when /^6.0/
+      gem 'sass-rails', '>= 6'
+      gem 'webpacker', '~> 4.0'
+    when /^5.[12]/
+      gem 'sass-rails', '~> 5.0'
+      gem 'sprockets', '~> 3.7'
+      gem 'thor', '~> 0.20'
+    end
   end
 end
 # END ENGINE_CART BLOCK

data/README.md

@@ -102,7 +102,7 @@ config.add_facet_field 'pub_date', label: 'Publication Year',
 
 ## Javascript dependencies
 
-The selectable histograms/barcharts are done with Javascript, using [Flot](http://code.google.com/p/flot/). Flot requires JQuery, as well as support for the HTML5 canvas element. In IE previous to IE9, canvas element support can be added with [excanvas](http://excanvas.sourceforge.net/). For the slider, [bootstrap-slider](http://www.eyecon.ro/bootstrap-slider/) is used (bootstrap-slider is actually third party, not officially bootstrap). Flot and bootstrap-slider are both directly included in blacklight_range_limit in vendor, rather than referenced as dependencies.
+The selectable histograms/barcharts are done with Javascript, using [Flot](http://code.google.com/p/flot/). Flot requires JQuery, as well as support for the HTML5 canvas element. For the slider, [bootstrap-slider](http://www.eyecon.ro/bootstrap-slider/) is used (bootstrap-slider is actually third party, not officially bootstrap). Flot and bootstrap-slider are both directly included in blacklight_range_limit in vendor, rather than referenced as dependencies.
 
 The blacklight_range_limit installer will add `require 'blacklight_range_limit'` to your `application.js` sprockets manifest. This will include flot, bootstrap-slider, and the blacklight_range_limit glue JS.
 
@@ -110,19 +110,6 @@ Both flot and blacklight_range_limit's own JS depend on JQuery; the host app is
 
 If you don't want any of this gem's JS, you can simply remove the `require 'blacklight_range_limit'` line from your application.js, and hack something else together yourself.
 
-## IE8, excanvas
-
-IE8 and below do not support the 'canvas' element, needed for flot to render the chart.
-Without canvas, view will cleanly degrade to an ordinary textual listing of range segments
-as facets.
-
-Or, you can use excanvas.js to add canvas support to IE.  `blacklight_range_limit` includes
-the `excanvas.js` file, but you'll have to manually add a reference to it to your Rails layout
-template -- if you were previously using the stock Blacklight layout, you'll have to add a
-local custom layout instead. Then add this to the html `<head>` section:
-
-    <!--[if lte IE 8]><%= javascript_include_tag 'flot/excanvas.min' %><![endif]-->
-
 ## Touch?
 
 For touch screens, one wants the UI to work well. The slider used is
@@ -182,6 +169,10 @@ bundle exec rspec spec/features/blacklight_range_limit_spec.rb
 
 Once you are done iterating on your test you will need to stop the application server with `Ctrl-C`.
 
+# Publishing Javascript
+
+run `npm publish` to push the javascript package to https://npmjs.org/package/blacklight-range-limit
+
 # Possible future To Do
 
 * StatsComponent replacement. We use StatsComponent to get min/max of result set, as well as missing count. StatsComponent is included on every non-drilldown request, so ranges and slider can be displayed. However, StatsComponent really can slow down the solr response with a large result set. So replace StatsComponent with other strategies. No ideal ones, we can use facet.missing to get missing count instead, but RSolr makes it harder than it should be to grab this info. We can use seperate solr queries to get min/max (sort on our field, asc and desc), but this is more complicated, more solr queries, and possibly requires redesign of AJAXy stuff, so even a lone slider can have min/max.

data/VERSION

@@ -1 +1 @@
-8.2.3
+8.3.0

data/app/assets/javascripts/blacklight_range_limit/range_limit_distro_facets.js

@@ -31,8 +31,11 @@ Blacklight.onLoad(function() {
     }
   });
 
+  // Support for Blacklight 7 and 8:
+  const modalSelector = Blacklight.modal?.modalSelector || Blacklight.Modal.modalSelector 
+
   // When loaded in a modal
-  $(Blacklight.modal.modalSelector).on('shown.bs.modal', function() {
+  $(modalSelector).on('shown.bs.modal', function() {
     $(this).find(".range_limit .profile .distribution.chart_js ul").each(function() {
       BlacklightRangeLimit.turnIntoPlot($(this).parent());
     });
@@ -51,7 +54,7 @@ Blacklight.onLoad(function() {
   // be triggered. The function will be called after it stops being called for
   // N milliseconds. If `immediate` is passed, trigger the function on the
   // leading edge, instead of the trailing.
-  debounce = function(func, wait, immediate) {
+  const debounce = function(func, wait, immediate) {
     var timeout;
     return function() {
       var context = this, args = arguments;

data/app/assets/javascripts/blacklight_range_limit/range_limit_shared.js

@@ -1,88 +1,73 @@
 /**
- * Global BlacklightRangeLimit module setup.
+ * BlacklightRangeLimit module setup.
  */
-!function(global) {
-  'use strict';
+'use strict';
 
-  var previousBlacklightRangeLimit = global.BlacklightRangeLimit;
+const BlacklightRangeLimit = function (options) {
+  this.options = options || {};
+}
 
-  function BlacklightRangeLimit(options) {
-    this.options = options || {};
-  }
-
-  BlacklightRangeLimit.display_ratio = 1/(1.618 * 2); // half a golden rectangle, why not
-  /* A custom event "plotDrawn.blacklight.rangeLimit" will be sent when flot plot
-     is (re-)drawn on screen possibly with a new size. target of event will be the DOM element
-     containing the plot.  Used to resize slider to match. */
-  BlacklightRangeLimit.redrawnEvent = "plotDrawn.blacklight.rangeLimit";
-
-  // takes a string and parses into an integer, but throws away commas first, to avoid truncation when there is a comma
-  // use in place of javascript's native parseInt
-  BlacklightRangeLimit.parseNum = function parseNum(str) {
-    str = String(str).replace(/[^0-9-]/g, '');
-    return parseInt(str, 10);
-  };
+BlacklightRangeLimit.display_ratio = 1/(1.618 * 2); // half a golden rectangle, why not
+/* A custom event "plotDrawn.blacklight.rangeLimit" will be sent when flot plot
+    is (re-)drawn on screen possibly with a new size. target of event will be the DOM element
+    containing the plot.  Used to resize slider to match. */
+BlacklightRangeLimit.redrawnEvent = "plotDrawn.blacklight.rangeLimit";
 
-  BlacklightRangeLimit.form_selection = function form_selection(form, min, max) {
-    var begin_val = BlacklightRangeLimit.parseNum($(form).find("input.range_begin").val());
-    if (isNaN(begin_val) || begin_val < min) {
-      begin_val = min;
-    }
-    var end_val = BlacklightRangeLimit.parseNum($(form).find("input.range_end").val());
-    if (isNaN(end_val) || end_val > max) {
-      end_val = max;
-    }
+// takes a string and parses into an integer, but throws away commas first, to avoid truncation when there is a comma
+// use in place of javascript's native parseInt
+BlacklightRangeLimit.parseNum = function parseNum(str) {
+  str = String(str).replace(/[^0-9-]/g, '');
+  return parseInt(str, 10);
+};
 
-    return BlacklightRangeLimit.normalized_selection(begin_val, end_val);
+BlacklightRangeLimit.form_selection = function form_selection(form, min, max) {
+  var begin_val = BlacklightRangeLimit.parseNum($(form).find("input.range_begin").val());
+  if (isNaN(begin_val) || begin_val < min) {
+    begin_val = min;
   }
-
-  // Add AJAX fetched range facets if needed, and add a chart to em
-  BlacklightRangeLimit.checkForNeededFacetsToFetch = function checkForNeededFacetsToFetch() {
-    $(".range_limit .profile .distribution a.load_distribution").each(function() {
-      var container = $(this).parent('div.distribution');
-
-      $(container).load($(this).attr('href'), function(response, status) {
-        if ($(container).hasClass("chart_js") && status == "success" ) {
-          BlacklightRangeLimit.turnIntoPlot(container);
-          }
-      });
-    });
+  var end_val = BlacklightRangeLimit.parseNum($(form).find("input.range_end").val());
+  if (isNaN(end_val) || end_val > max) {
+    end_val = max;
   }
 
-  BlacklightRangeLimit.function_for_find_segment = function function_for_find_segment(pointer_lookup_arr) {
-    return function(x_coord) {
-      for (var i = pointer_lookup_arr.length-1 ; i >= 0 ; i--) {
-        var hash = pointer_lookup_arr[i];
-        if (x_coord >= hash.from)
-          return hash;
-      }
-      return pointer_lookup_arr[0];
-    };
-  }
+  return BlacklightRangeLimit.normalized_selection(begin_val, end_val);
+}
 
-  // Send endpoint to endpoint+0.99999 to have display
-  // more closely approximate limiting behavior esp
-  // at small resolutions. (Since we search on whole numbers,
-  // inclusive, but flot chart is decimal.)
-  BlacklightRangeLimit.normalized_selection = function normalized_selection(min, max) {
-    max += 0.99999;
+// Add AJAX fetched range facets if needed, and add a chart to em
+BlacklightRangeLimit.checkForNeededFacetsToFetch = function checkForNeededFacetsToFetch() {
+  $(".range_limit .profile .distribution a.load_distribution").each(function() {
+    var container = $(this).parent('div.distribution');
 
-    return {xaxis: { 'from':min, 'to':max}}
-  }
+    $(container).load($(this).attr('href'), function(response, status) {
+      if ($(container).hasClass("chart_js") && status == "success" ) {
+        BlacklightRangeLimit.turnIntoPlot(container);
+        }
+    });
+  });
+}
 
-  // Check if Flot is loaded, and if browser has support for
-  // canvas object, either natively or via IE excanvas.
-  BlacklightRangeLimit.domDependenciesMet = function domDependenciesMet() {
-    var flotLoaded = (typeof $.plot != "undefined");
-    var canvasAvailable = ((typeof(document.createElement('canvas').getContext) != "undefined") || (typeof  window.CanvasRenderingContext2D != 'undefined' || typeof G_vmlCanvasManager != 'undefined'));
+BlacklightRangeLimit.function_for_find_segment = function function_for_find_segment(pointer_lookup_arr) {
+  return function(x_coord) {
+    for (var i = pointer_lookup_arr.length-1 ; i >= 0 ; i--) {
+      var hash = pointer_lookup_arr[i];
+      if (x_coord >= hash.from)
+        return hash;
+    }
+    return pointer_lookup_arr[0];
+  };
+}
 
-    return (flotLoaded && canvasAvailable);
-  }
+// Send endpoint to endpoint+0.99999 to have display
+// more closely approximate limiting behavior esp
+// at small resolutions. (Since we search on whole numbers,
+// inclusive, but flot chart is decimal.)
+BlacklightRangeLimit.normalized_selection = function normalized_selection(min, max) {
+  max += 0.99999;
 
-  BlacklightRangeLimit.noConflict = function noConflict() {
-    global.BlacklightRangeLimit = previousBlacklightRangeLimit;
-    return BlacklightRangeLimit;
-  };
+  return {xaxis: { 'from':min, 'to':max}}
+}
 
-  global.BlacklightRangeLimit = BlacklightRangeLimit;
-}(this);
+// Check if Flot is loaded
+BlacklightRangeLimit.domDependenciesMet = function domDependenciesMet() {
+  return typeof $.plot != "undefined"
+}

data/app/assets/javascripts/blacklight_range_limit/range_limit_slider.js

@@ -6,7 +6,10 @@ Blacklight.onLoad(function() {
     BlacklightRangeLimit.buildSlider(this);
   });
 
-  $(Blacklight.modal.modalSelector).on('shown.bs.modal', function() {
+  // Support for Blacklight 7 and 8:
+  const modalSelector = Blacklight.modal?.modalSelector || Blacklight.Modal.modalSelector 
+
+  $(modalSelector).on('shown.bs.modal', function() {
     $(this).find(".range_limit .profile .range.slider_js").each(function() {
       BlacklightRangeLimit.buildSlider(this);
     });
@@ -31,8 +34,8 @@ Blacklight.onLoad(function() {
 // Will return NaN as min or max in case of error or other weirdness.
 BlacklightRangeLimit.min_max = function min_max(range_element) {
   var current_limit =  $(range_element).closest(".limit_content.range_limit").find(".current")
-
-  var min = max = BlacklightRangeLimit.parseNum(current_limit.find(".single").data('blrlSingle'))
+  let min, max
+  min = max = BlacklightRangeLimit.parseNum(current_limit.find(".single").data('blrlSingle'))
   if ( isNaN(min)) {
     min = BlacklightRangeLimit.parseNum(current_limit.find(".from").first().data('blrlBegin'));
     max = BlacklightRangeLimit.parseNum(current_limit.find(".to").first().data('blrlEnd'));

data/app/components/blacklight_range_limit/range_facet_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module BlacklightRangeLimit
-  class RangeFacetComponent < ::ViewComponent::Base
+  class RangeFacetComponent < Blacklight::Component
     renders_one :more_link, ->(key:, label:) do
       tag.div class: 'more_facets' do
         link_to t('blacklight.range_limit.view_larger', field_name: label),

data/app/components/blacklight_range_limit/range_form_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module BlacklightRangeLimit
-  class RangeFormComponent < ::ViewComponent::Base
+  class RangeFormComponent < Blacklight::Component
     delegate :search_action_path, to: :helpers
 
     def initialize(facet_field:, classes: BlacklightRangeLimit.classes)

data/app/components/blacklight_range_limit/range_segments_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module BlacklightRangeLimit
-  class RangeSegmentsComponent < ::ViewComponent::Base
+  class RangeSegmentsComponent < Blacklight::Component
     def initialize(facet_field:, facet_items: nil, item_component: nil, classes: [])
       super
 

data/blacklight_range_limit.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.license     = 'Apache 2.0'
 
   s.add_dependency 'blacklight', '>= 7.25.2', '< 9'
+  s.add_dependency 'deprecation'
 
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-rails'
@@ -27,6 +28,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'solr_wrapper'
   s.add_development_dependency 'engine_cart', '~> 2.1'
   s.add_development_dependency 'selenium-webdriver', '>= 3.13.1'
-  s.add_development_dependency 'webdrivers', '~>3.0'
-  s.add_development_dependency 'rexml' # pending https://github.com/SeleniumHQ/selenium/issues/9001
+  s.add_development_dependency 'webdrivers', '~>5.0'
 end

data/lib/blacklight_range_limit/engine.rb

@@ -4,14 +4,6 @@ require 'rails'
 
 module BlacklightRangeLimit
   class Engine < Rails::Engine
-    # Need to tell asset pipeline to precompile the excanvas
-    # we use for IE.
-    initializer "blacklight_range_limit.assets", :after => "assets" do
-      if defined? Sprockets
-        Rails.application.config.assets.precompile += %w( flot/excanvas.min.js )
-      end
-    end
-
     config.action_dispatch.rescue_responses.merge!(
       "BlacklightRangeLimit::InvalidRange" => :not_acceptable
     )

data/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "blacklight-range-limit",
+  "version": "8.3.0",
+  "description": "A range facet UI component plugin for blacklight",
+  "main": "app/assets/javascripts/blacklight_range_limit",
+  "scripts": {
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/projectblacklight/blacklight_range_limit.git"
+  },
+  "files": [
+    "app/assets", "vendor/assets"
+  ],
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/projectblacklight/blacklight_range_limit/issues"
+  },
+  "homepage": "https://github.com/projectblacklight/blacklight_range_limit#readme",
+  "devDependencies": {
+  },
+  "browserslist": [
+    "defaults",
+    "not IE 11"
+  ],
+  "dependencies": {
+  }
+}

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

@@ -30,11 +30,4 @@ class TestAppGenerator < Rails::Generators::Base
       "\n    config.add_facet_field 'pub_date_si', label: 'Publication Date Sort', **default_range_config"
     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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 8.2.3
+  version: 8.3.0
 platform: ruby
 authors:
 - Jonathan Rochkind
 - Chris Beer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2023-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -31,6 +31,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
+- !ruby/object:Gem::Dependency
+  name: deprecation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
@@ -149,29 +163,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rexml
-  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: 
+        version: '5.0'
+description:
 email:
 - blacklight-development@googlegroups.com
 executables: []
@@ -192,7 +192,7 @@ files:
 - app/assets/javascripts/blacklight_range_limit/range_limit_plotting.js
 - app/assets/javascripts/blacklight_range_limit/range_limit_shared.js
 - app/assets/javascripts/blacklight_range_limit/range_limit_slider.js
-- app/assets/stylesheets/blacklight_range_limit.css.scss
+- app/assets/stylesheets/blacklight_range_limit.css
 - app/assets/stylesheets/blacklight_range_limit/blacklight_range_limit.css
 - app/components/blacklight_range_limit/range_facet_component.html.erb
 - app/components/blacklight_range_limit/range_facet_component.rb
@@ -229,6 +229,7 @@ files:
 - lib/generators/blacklight_range_limit/assets_generator.rb
 - lib/generators/blacklight_range_limit/install_generator.rb
 - lib/tasks/blacklight_range_limit.rake
+- package.json
 - solr/conf/_rest_managed.json
 - solr/conf/admin-extra.html
 - solr/conf/elevate.xml
@@ -277,7 +278,7 @@ homepage: https://github.com/projectblacklight/blacklight_range_limit
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -292,8 +293,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.19
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Blacklight Range Limit plugin
 test_files: