blacklight_range_limit 8.4.0 → 9.0.0.beta1

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

@@ -3,19 +3,50 @@ require 'rails/generators'
 class TestAppGenerator < Rails::Generators::Base
   source_root File.expand_path("../../../../spec/test_app_templates", __FILE__)
 
-  # This is only necessary for Rails 3
-  def remove_index
-    remove_file "public/index.html"
+  # While blacklight works with jsbundling-rails (and vite-ruby with layout modification),
+  # it's generators can't set it up at present, we hackily do so.
+  def run_bl7_jsbundling_fixup
+    if File.exist?("package.json") && Blacklight::VERSION.split(".").first == "7"
+      say_status("warning", "BlacklightRangeLimit: Blacklight 7.x package.json-based Test App fixup", {color: :yellow})
+      generate "blacklight_range_limit:jsbundling_bl7_fixup"
+    end
+  end
+
+  def run_bl8_jsbundling_fixup
+    # while it's named confusingly, the BL8 assets:propshaft generator has what we need
+    # for jsbundling, I think.
+    if File.exist?("package.json") && Blacklight::VERSION.split(".").first == "8"
+      generate "blacklight:assets:propshaft"
+    end
   end
 
   def run_blacklight_generator
-    say_status("warning", "GENERATING BL", :yellow)
+    say_status("warning", "GENERATING Blacklight", :yellow)
 
     generate 'blacklight:install', '--devise'
   end
 
+  def run_bl8_importmaps_fixup
+    # In BL8, if we have CSS-bundling rails but ALSO are using importmaps for JS, the BL8 installer
+    # gets us a LOT of the way there, but doesn't actually set up importmap pins for JS and needs
+    # some fixup. Maybe fixed in BL9?  We fix up here if we are in that situation.
+    if Pathname(destination_root).join("config/importmap.rb").exist? && Blacklight::VERSION.split(".").first == "8"
+      # BL's importmap setup annoyingly uses a different name for the BL package than their package.json setup
+      gsub_file("app/javascript/application.js", 'import Blacklight from "blacklight-frontend";', 'import Blacklight from "blacklight";')
+
+      # these pins copied from BL8 ImportMapsGenerator
+      append_to_file 'config/importmap.rb' do
+        <<~CONTENT
+          pin "@github/auto-complete-element", to: "https://cdn.skypack.dev/@github/auto-complete-element"
+          pin "@popperjs/core", to: "https://ga.jspm.io/npm:@popperjs/core@2.11.6/dist/umd/popper.min.js"
+          pin "bootstrap", to: "https://ga.jspm.io/npm:bootstrap@#{(defined?(Bootstrap) && Bootstrap::VERSION) || '5.3.2'}/dist/js/bootstrap.js"
+        CONTENT
+      end
+    end
+  end
+
   def run_blacklight_range_limit_generator
-    say_status("warning", "GENERATING BL", :yellow)
+    say_status("warning", "GENERATING BlacklightRangeLimit", :yellow)
 
     generate 'blacklight_range_limit:install'
   end
@@ -27,7 +58,7 @@ class TestAppGenerator < Rails::Generators::Base
 
   def inject_into_catalog_controller
     inject_into_file 'app/controllers/catalog_controller.rb', after: /config.add_facet_field 'format'.*$/ do
-      "\n    config.add_facet_field 'pub_date_si', label: 'Publication Date Sort', **default_range_config"
+      "\n    config.add_facet_field 'pub_date_si', label: 'Publication Date Sort', range: true"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 8.4.0
+  version: 9.0.0.beta1
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -51,20 +51,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-- !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
@@ -107,6 +93,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: capybara-screenshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -193,31 +193,23 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- app/assets/javascripts/blacklight_range_limit.js
-- app/assets/javascripts/blacklight_range_limit/range_limit_distro_facets.js
-- 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
-- app/assets/stylesheets/blacklight_range_limit/blacklight_range_limit.css
+- app/assets/javascripts/blacklight-range-limit/index.js
 - app/components/blacklight_range_limit/range_facet_component.html.erb
 - app/components/blacklight_range_limit/range_facet_component.rb
 - app/components/blacklight_range_limit/range_form_component.html.erb
 - app/components/blacklight_range_limit/range_form_component.rb
 - app/components/blacklight_range_limit/range_segments_component.html.erb
 - app/components/blacklight_range_limit/range_segments_component.rb
-- app/helpers/range_limit_helper.rb
 - app/presenters/blacklight_range_limit/facet_field_presenter.rb
 - app/presenters/blacklight_range_limit/facet_item_presenter.rb
 - app/presenters/blacklight_range_limit/filter_field.rb
-- app/views/blacklight_range_limit/_range_segments.html.erb
-- app/views/blacklight_range_limit/range_segments.html.erb
-- app/views/catalog/range_limit_panel.html.erb
 - blacklight_range_limit.gemspec
+- config/importmap.rb
 - config/jetty.yml
 - config/locales/blacklight_range_limit.ar.yml
 - config/locales/blacklight_range_limit.de.yml
 - config/locales/blacklight_range_limit.en.yml
+- config/locales/blacklight_range_limit.es.yml
 - config/locales/blacklight_range_limit.it.yml
 - config/routes.rb
 - config/solr.yml
@@ -234,7 +226,9 @@ files:
 - lib/blacklight_range_limit/version.rb
 - lib/generators/blacklight_range_limit/assets_generator.rb
 - lib/generators/blacklight_range_limit/install_generator.rb
+- lib/generators/blacklight_range_limit/jsbundling_bl7_fixup_generator.rb
 - lib/tasks/blacklight_range_limit.rake
+- package-lock.json
 - package.json
 - solr/conf/_rest_managed.json
 - solr/conf/admin-extra.html
@@ -255,11 +249,11 @@ files:
 - solr/sample_solr_documents.yml
 - spec/components/range_facet_component_spec.rb
 - spec/components/range_form_component_spec.rb
-- spec/features/a_javascript_spec.rb
+- spec/components/range_segments_component_spec.rb
 - spec/features/blacklight_range_limit_spec.rb
+- spec/features/run_through_spec.rb
 - spec/fixtures/solr_documents/unknown_year.yml
 - 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/presenters/facet_field_presenter_spec.rb
 - spec/presenters/facet_item_presenter_spec.rb
@@ -268,18 +262,6 @@ files:
 - spec/support/presenter_test_helpers.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/jquery.canvaswrapper.js
-- vendor/assets/javascripts/flot/jquery.colorhelpers.js
-- vendor/assets/javascripts/flot/jquery.event.drag.js
-- vendor/assets/javascripts/flot/jquery.flot.browser.js
-- vendor/assets/javascripts/flot/jquery.flot.drawSeries.js
-- vendor/assets/javascripts/flot/jquery.flot.hover.js
-- vendor/assets/javascripts/flot/jquery.flot.js
-- vendor/assets/javascripts/flot/jquery.flot.saturated.js
-- vendor/assets/javascripts/flot/jquery.flot.selection.js
-- vendor/assets/javascripts/flot/jquery.flot.uiConstants.js
-- vendor/assets/stylesheets/slider.css
 homepage: https://github.com/projectblacklight/blacklight_range_limit
 licenses:
 - Apache 2.0
@@ -299,18 +281,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Blacklight Range Limit plugin
 test_files:
 - spec/components/range_facet_component_spec.rb
 - spec/components/range_form_component_spec.rb
-- spec/features/a_javascript_spec.rb
+- spec/components/range_segments_component_spec.rb
 - spec/features/blacklight_range_limit_spec.rb
+- spec/features/run_through_spec.rb
 - spec/fixtures/solr_documents/unknown_year.yml
 - 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/presenters/facet_field_presenter_spec.rb
 - spec/presenters/facet_item_presenter_spec.rb

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

@@ -1,77 +0,0 @@
-// for Blacklight.onLoad:
-
-/**
- * Closure functions in this file are mainly concerned with initializing, resizing, and updating
- * range limit functionality based off of page load, facet opening, page resizing, and otherwise
- * events.
- */
-
-Blacklight.onLoad(function() {
-
-  // Facets already on the page? Turn em into a chart.
-  $(".range_limit .profile .distribution.chart_js ul").each(function() {
-      BlacklightRangeLimit.turnIntoPlot($(this).parent());
-  });
-
-  BlacklightRangeLimit.checkForNeededFacetsToFetch();
-
-  // Listen for twitter bootstrap collapsible open events, to render flot
-  // in previously hidden divs on open, if needed.
-  $("body").on("show.bs.collapse", function(event) {
-    // Was the target a .facet-content including a .chart-js?
-    var container =  $(event.target).filter(".facet-content").find(".chart_js");
-
-    // only if it doesn't already have a canvas, it isn't already drawn
-    if (container && container.find("canvas").length == 0) {
-      // be willing to wait up to 1100ms for container to
-      // have width -- right away on show.bs is too soon, but
-      // shown.bs is later than we want, we want to start rendering
-      // while animation is still in progress.
-      BlacklightRangeLimit.turnIntoPlot(container, 1100);
-    }
-  });
-
-  // Support for Blacklight 7 and 8:
-  const modalSelector = Blacklight.modal?.modalSelector || Blacklight.Modal.modalSelector 
-
-  // When loaded in a modal
-  $(modalSelector).on('shown.bs.modal', function() {
-    $(this).find(".range_limit .profile .distribution.chart_js ul").each(function() {
-      BlacklightRangeLimit.turnIntoPlot($(this).parent());
-    });
-
-    // Case when there is no currently selected range
-    BlacklightRangeLimit.checkForNeededFacetsToFetch();
-  });
-
-  $("body").on("shown.bs.collapse", function(event) {
-    var container =  $(event.target).filter(".facet-content").find(".chart_js");
-    BlacklightRangeLimit.redrawPlot(container);
-  });
-
-  // debouce borrowed from underscore
-  // Returns a function, that, as long as it continues to be invoked, will not
-  // 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.
-  const debounce = function(func, wait, immediate) {
-    var timeout;
-    return function() {
-      var context = this, args = arguments;
-      var later = function() {
-        timeout = null;
-        if (!immediate) func.apply(context, args);
-      };
-      var callNow = immediate && !timeout;
-      clearTimeout(timeout);
-      timeout = setTimeout(later, wait);
-      if (callNow) func.apply(context, args);
-    };
-  };
-
-  $(window).on("resize", debounce(function() {
-    $(".chart_js").each(function(i, container) {
-      BlacklightRangeLimit.redrawPlot($(container));
-    });
-  }, 350));
-});

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

@@ -1,185 +0,0 @@
-// second arg, if provided, is a number of ms we're willing to
-// wait for the container to have width before giving up -- we'll
-// set 50ms timers to check back until timeout is expired or the
-// container is finally visible. The timeout is used when we catch
-// bootstrap show event, but the animation hasn't barely begun yet -- but
-// we don't want to wait until it's finished, we want to start rendering
-// as soon as we can.
-//
-// We also will
-BlacklightRangeLimit.turnIntoPlot = function turnIntoPlot(container, wait_for_visible) {
-  // flot can only render in a a div with a defined width.
-  // for instance, a hidden div can't generally be rendered in (although if you set
-  // an explicit width on it, it might work)
-  //
-  // We'll count on later code that catch bootstrap collapse open to render
-  // on show, for currently hidden divs.
-
-  // for some reason width sometimes return negative, not sure
-  // why but it's some kind of hidden.
-  if (container.width() > 0) {
-    var height = container.width() * BlacklightRangeLimit.display_ratio;
-
-    // Need an explicit height to make flot happy.
-    container.height( height )
-
-    BlacklightRangeLimit.areaChart($(container));
-
-    $(container).trigger(BlacklightRangeLimit.redrawnEvent);
-  }
-  else if (wait_for_visible > 0) {
-    setTimeout(function() {
-      BlacklightRangeLimit.turnIntoPlot(container, wait_for_visible - 50);
-    }, 50);
-  }
-}
-
-BlacklightRangeLimit.parseSegment = function parseSegment(el) {
-  if ($(el).find("span.single").first().data('blrlSingle')) {
-    var val = BlacklightRangeLimit.parseNum($(el).find("span.single").first().data('blrlSingle'));
-
-    return [val, val];
-  } else {
-    var from = BlacklightRangeLimit.parseNum($(el).find("span.from").first().data('blrlBegin'));
-    var to = BlacklightRangeLimit.parseNum($(el).find("span.to").first().data('blrlEnd'));
-
-    return [from, to];
-  }
-}
-
-// Takes a div holding a ul of distribution segments produced by
-// blacklight_range_limit/_range_facets and makes it into
-// a flot area chart.
-BlacklightRangeLimit.areaChart = function areaChart(container) {
-  //flot loaded? And canvas element supported.
-  if ( BlacklightRangeLimit.domDependenciesMet()  ) {
-
-    // Grab the data from the ul div
-    var series_data = new Array();
-    var pointer_lookup = new Array();
-    var x_ticks = new Array();
-    var min = BlacklightRangeLimit.parseSegment($(container).find("ul li:first-child").first())[0];
-    var max = BlacklightRangeLimit.parseSegment($(container).find("ul li:last-child").first())[1];
-
-    $(container).find("ul li").each(function() {
-        var segment = BlacklightRangeLimit.parseSegment(this);
-        var from = segment[0];
-        var to = segment[1];
-
-        var count = BlacklightRangeLimit.parseNum($(this).find("span.facet-count,span.count").text());
-        var avg = (count / (to - from + 1));
-
-        //We use the avg as the y-coord, to make the area of each
-        //segment proportional to how many documents it holds.
-        series_data.push( [from, avg ] );
-        series_data.push( [to+1, avg] );
-
-        x_ticks.push(from);
-
-        pointer_lookup.push({'from': from, 'to': to, 'count': count, 'label': $(this).find(".facet-select,.facet_select").html() });
-    });
-
-    x_ticks.push( max + 1 );
-
-    var plot;
-    var config = $(container).closest('.blrl-plot-config').data('plot-config') || $(container).closest('.facet-limit').data('plot-config') || {};
-
-    try {
-      plot = $.plot($(container), [series_data],
-          $.extend(true, config, {
-          yaxis: {  ticks: [], min: 0, autoscaleMargin: 0.1},
-        //xaxis: { ticks: x_ticks },
-        xaxis: { tickDecimals: 0 }, // force integer ticks
-        series: { lines: { fill: true, steps: true }},
-        grid: {clickable: true, hoverable: true, autoHighlight: false, margin: { left: 0, right: 0 }},
-        selection: {mode: "x"}
-      }));
-    }
-    catch(err) {
-      alert(err);
-    }
-
-    var find_segment_for = BlacklightRangeLimit.function_for_find_segment(pointer_lookup);
-    var last_segment = null;
-    $(container).tooltip({'html': true, 'placement': 'bottom', 'trigger': 'manual', 'delay': { show: 0, hide: 100}});
-
-    $(container).bind("plothover", function (event, pos, item) {
-      var segment = find_segment_for(pos.x);
-
-      if(segment != last_segment) {
-        var title = find_segment_for(pos.x).label  + ' (' + BlacklightRangeLimit.parseNum(segment.count) + ')';
-        $(container).attr("title", title).tooltip("_fixTitle").tooltip("show");
-
-        last_segment  = segment;
-       }
-    });
-
-    $(container).bind("mouseout", function() {
-      last_segment = null;
-      $(container).tooltip('hide');
-    });
-    $(container).bind("plotclick", function (event, pos, item) {
-        if ( plot.getSelection() == null) {
-          segment = find_segment_for(pos.x);
-          plot.setSelection(BlacklightRangeLimit.normalized_selection(segment.from, segment.to));
-        }
-    });
-    $(container).bind("plotselected plotselecting", function(event, ranges) {
-      if (ranges != null ) {
-        var from = Math.floor(ranges.xaxis.from);
-        var to = Math.floor(ranges.xaxis.to);
-
-        var form = $(container).closest(".limit_content").find("form.range_limit");
-        form.find("input.range_begin").val(from);
-        form.find("input.range_end").val(to);
-
-        var slider_placeholder = $(container).closest(".limit_content").find("[data-slider-placeholder]");
-        if (slider_placeholder) {
-          slider_placeholder.slider("setValue", [from, to]);
-        }
-      }
-    });
-
-    var form = $(container).closest(".limit_content").find("form.range_limit");
-    form.find("input.range_begin, input.range_end").on('input', function () {
-      plot.setSelection( BlacklightRangeLimit.form_selection(form, min, max), true );
-    });
-    $(container).closest(".limit_content").find(".profile .range").on("slide", function(event, ui) {
-      var values = $(event.target).data("slider").getValue();
-      form.find("input.range_begin").val(values[0]);
-      form.find("input.range_end").val(values[1]);
-      plot.setSelection(BlacklightRangeLimit.normalized_selection(values[0], Math.max(values[0], values[1])), true);
-    });
-
-    // initially entirely selected, to match slider
-    plot.setSelection(BlacklightRangeLimit.normalized_selection(min, max));
-  }
-}
-
-// after a collapsible facet contents is fully shown,
-// resize the flot chart to current conditions. This way, if you change
-// browser window size, you can get chart resized to fit by closing and opening
-// again, if needed.
-BlacklightRangeLimit.redrawPlot = function redrawPlot(container) {
-  if (container && container.width() > 0) {
-    // resize the container's height, since width may have changed.
-    container.height( container.width() * BlacklightRangeLimit.display_ratio  );
-
-    // redraw the chart.
-    var plot = container.data("plot");
-    if (plot) {
-      // how to redraw after possible resize?
-      // Cribbed from https://github.com/flot/flot/blob/master/jquery.flot.resize.js
-      plot.resize();
-      plot.setupGrid();
-      plot.draw();
-      // plus trigger redraw of the selection, which otherwise ain't always right
-      // we'll trigger a fake event on one of the boxes
-      var form = $(container).closest(".limit_content").find("form.range_limit");
-      form.find("input.range_begin").trigger("change");
-
-      // send our custom event to trigger redraw of slider
-      $(container).trigger(BlacklightRangeLimit.redrawnEvent);
-    }
-  }
-}

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

@@ -1,73 +0,0 @@
-/**
- * BlacklightRangeLimit module setup.
- */
-'use strict';
-
-const BlacklightRangeLimit = function (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.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;
-  }
-
-  return BlacklightRangeLimit.normalized_selection(begin_val, end_val);
-}
-
-// 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);
-        }
-    });
-  });
-}
-
-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];
-  };
-}
-
-// 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;
-
-  return {xaxis: { 'from':min, 'to':max}}
-}
-
-// Check if Flot is loaded
-BlacklightRangeLimit.domDependenciesMet = function domDependenciesMet() {
-  return typeof $.plot != "undefined"
-}