blacklight_range_limit 7.8.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c31bc65d3f409a118dffda97b7b744f1d846151e57e7c64b3757660fb2af23c
-  data.tar.gz: baf34fb3d88a9f0d438b3689dfd51aa1ec3dfc4e5636ef654bc414a46ff17646
+  metadata.gz: b8c8deb666a17d47f0972d7d85098ec88b0d980c12d92cd7fa554b943ee36ff6
+  data.tar.gz: 7696cd12ba7d0c1b2ce4c4c451190ca36398edbae08edb2966dcb1575aa63692
 SHA512:
-  metadata.gz: 3c4dd6d2ce9248b5587687d3b2f56db705ebb2915e1e6772e799493bad5c1bb4d47a822eeb5319c3daba2f88d7f60b62188f9856cb0dbbd16feb2c9e4f78294d
-  data.tar.gz: b08cc82a380cedb3ed79122c5dd92a21e0232c6e6fa5644b66cb82e67787e71126c382be80bab556786fb852e40c4557cb2524242af58877048fe89f7a134f03
+  metadata.gz: 935f5b470677a89d09bd510b84be8319675ce0873da638218083dd54f328138737b39a0b1f0d0912e4ca18a163f47cd90b77136199a29eaadd662bed7e863d00
+  data.tar.gz: 763fdb463b094db59d12ead36b0e44a487aeb3ca85e6608479de898868aa669a78ed52ca2c5e01aaf6651cefc780a2b8940aec576939a798c6f0104e75e25e9a

data/.github/workflows/ruby.yml

@@ -0,0 +1,76 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        rails_version: [6.1.1]
+        ruby: [2.7, 3.0]
+    env:
+      RAILS_VERSION: ${{ matrix.rails_version }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies with Rails ${{ matrix.rails_version }}
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+  test_rails6_0:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+      env:
+        RAILS_VERSION: 6.0.3.4
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        RAILS_VERSION: 6.0.3.4
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+  test_rails5_2:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.5]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+      env:
+        RAILS_VERSION: 5.2.4.2
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        RAILS_VERSION: 5.2.4.2
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'

data/Gemfile

@@ -36,13 +36,6 @@ else
   case ENV['RAILS_VERSION']
   when /^5.[12]/, /^6.0/
     gem 'sass-rails', '~> 5.0'
-  when /^4.2/
-    gem 'responders', '~> 2.0'
-    gem 'sass-rails', '>= 5.0'
-    gem 'coffee-rails', '~> 4.1.0'
-    gem 'json', '~> 1.8'
-  when /^4.[01]/
-    gem 'sass-rails', '< 5.0'
   end
 end
 # END ENGINE_CART BLOCK

data/README.md

@@ -1,6 +1,6 @@
 BlacklightRangeLimit:  integer range limiting and profiling for Blacklight applications
 
-[![Build Status](https://travis-ci.org/projectblacklight/blacklight_range_limit.png?branch=v5.0.0)](https://travis-ci.org/projectblacklight/blacklight_range_limit) [![Gem Version](https://badge.fury.io/rb/blacklight_range_limit.png)](http://badge.fury.io/rb/blacklight_range_limit)
+![Build Status](https://github.com/projectblacklight/blacklight/workflows/CI/badge.svg) [![Gem Version](https://badge.fury.io/rb/blacklight_range_limit.png)](http://badge.fury.io/rb/blacklight_range_limit)
 
 ![Screen shot](doc/example-screenshot.png)
 
@@ -133,6 +133,33 @@ ourselves yet.
 Also not sure how well the flot select UI works on a touch screen. The slider
 is probably the best touch UI anyway, if it can be made to work well.
 
+## JavaScript Customization
+
+There are two main types of JavaScript implemented for BlacklightRangeLimit:
+ - Initialization and refresh of Range Limit plugin based off of events
+ - Range Limit plugin functionality called from event listeners
+ 
+ The second class of range limit functionality is customizable in your local application by overriding the specified function.
+ 
+ A simple example of this is overriding the display ratio used to create the histogram
+ 
+ ```javascript
+ BlacklightRangeLimit.display_ratio = 1
+```
+
+This will now create a square histogram.
+
+Not only these variables and functions be customized, you can call them based off of custom events in your application.
+
+```javascript
+$('.custom-class').on('doSomething', function() {
+  BlacklightRangeLimit.checkForNeededFacetsToFetch();
+  $(".range_limit .profile .range.slider_js").each(function() {
+    BlacklightRangeLimit.buildSlider(this);
+  });
+});
+```
+
 # Tests
 
 Test coverage is not great, but there are some tests, using rspec.  Run `bundle exec rake ci` or just `bundle exec rake` to seed and

data/VERSION

@@ -1 +1 @@
-7.8.0
+8.0.0

data/app/assets/javascripts/blacklight_range_limit.js

@@ -17,4 +17,8 @@
 //= require 'flot/jquery.flot.selection.js'
 //= require 'bootstrap-slider'
 
-//= require_tree './blacklight_range_limit'
+// Ensure that range_limit_shared is loaded first
+//= require 'blacklight_range_limit/range_limit_shared'
+//= require 'blacklight_range_limit/range_limit_plotting'
+//= require 'blacklight_range_limit/range_limit_slider'
+//= require 'blacklight_range_limit/range_limit_distro_facets'

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

@@ -1,23 +1,19 @@
 // for Blacklight.onLoad:
 
-/* 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. */
+/**
+ * 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() {
-  // ratio of width to height for desired display, multiply width by this ratio
-  // to get height. hard-coded in for now.
-  var display_ratio = 1/(1.618 * 2); // half a golden rectangle, why not
-  var redrawnEvent = "plotDrawn.blacklight.rangeLimit";
-
-
 
   // Facets already on the page? Turn em into a chart.
   $(".range_limit .profile .distribution.chart_js ul").each(function() {
-      turnIntoPlot($(this).parent());
+      BlacklightRangeLimit.turnIntoPlot($(this).parent());
   });
 
-  checkForNeededFacetsToFetch();
+  BlacklightRangeLimit.checkForNeededFacetsToFetch();
 
   // Listen for twitter bootstrap collapsible open events, to render flot
   // in previously hidden divs on open, if needed.
@@ -31,66 +27,23 @@ Blacklight.onLoad(function() {
       // 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.
-      turnIntoPlot(container, 1100);
+      BlacklightRangeLimit.turnIntoPlot(container, 1100);
     }
   });
 
   // When loaded in a modal
   $(Blacklight.modal.modalSelector).on('shown.bs.modal', function() {
     $(this).find(".range_limit .profile .distribution.chart_js ul").each(function() {
-      turnIntoPlot($(this).parent());
+      BlacklightRangeLimit.turnIntoPlot($(this).parent());
     });
 
     // Case when there is no currently selected range
-    checkForNeededFacetsToFetch();
+    BlacklightRangeLimit.checkForNeededFacetsToFetch();
   });
 
-  // Add AJAX fetched range facets if needed, and add a chart to em
-  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" ) {
-          turnIntoPlot(container);
-          }
-      });
-    });
-  }
-
-
-  // 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.
-
-  function redrawPlot(container) {
-    if (container && container.width() > 0) {
-      // resize the container's height, since width may have changed.
-      container.height( container.width() * 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(redrawnEvent);
-      }
-    }
-  }
-
   $("body").on("shown.bs.collapse", function(event) {
     var container =  $(event.target).filter(".facet-content").find(".chart_js");
-    redrawPlot(container);
+    BlacklightRangeLimit.redrawPlot(container);
   });
 
   // debouce borrowed from underscore
@@ -115,197 +68,7 @@ Blacklight.onLoad(function() {
 
   $(window).on("resize", debounce(function() {
     $(".chart_js").each(function(i, container) {
-      redrawPlot($(container));
+      BlacklightRangeLimit.redrawPlot($(container));
     });
   }, 350));
-
-  // 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
-  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() * display_ratio;
-
-      // Need an explicit height to make flot happy.
-      container.height( height )
-
-      areaChart($(container));
-
-      $(container).trigger(redrawnEvent);
-    }
-    else if (wait_for_visible > 0) {
-      setTimeout(function() {
-        turnIntoPlot(container, wait_for_visible - 50);
-      }, 50);
-    }
-  }
-
-     // Takes a div holding a ul of distribution segments produced by
-    // blacklight_range_limit/_range_facets and makes it into
-    // a flot area chart.
-    function areaChart(container) {
-      //flot loaded? And canvas element supported.
-      if (  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.parseNum($(container).find("ul li:first-child span.from").first().data('blrlBegin'));
-        var max = BlacklightRangeLimit.parseNum($(container).find("ul li:last-child span.to").first().data('blrlEnd'));
-
-        $(container).find("ul li").each(function() {
-            var from = BlacklightRangeLimit.parseNum($(this).find("span.from").first().data('blrlBegin'));
-            var to = BlacklightRangeLimit.parseNum($(this).find("span.to").first().data('blrlEnd'));
-            var count = BlacklightRangeLimit.parseNum($(this).find("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").html() });
-        });
-        var max_plus_one = BlacklightRangeLimit.parseNum($(container).find("ul li:last-child span.to").text())+1;
-        x_ticks.push( max_plus_one );
-
-
-
-        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);
-        }
-
-        find_segment_for = 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) {
-          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( 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+1]);
-              }
-            }
-        });
-
-        var form = $(container).closest(".limit_content").find("form.range_limit");
-        form.find("input.range_begin, input.range_end").change(function () {
-           plot.setSelection( 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( normalized_selection(values[0], Math.max(values[0], values[1]-1)), true);
-        });
-
-        // initially entirely selected, to match slider
-        plot.setSelection( {xaxis: { from:min, to:max+0.9999}}  );
-      }
-    }
-
-
-    // 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.)
-    function normalized_selection(min, max) {
-      max += 0.99999;
-
-      return {xaxis: { 'from':min, 'to':max}}
-    }
-
-    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 normalized_selection(begin_val, end_val);
-    }
-
-    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];
-      };
-    }
-
-    // Check if Flot is loaded, and if browser has support for
-    // canvas object, either natively or via IE excanvas.
-    function domDependenciesMet() {
-      var flotLoaded = (typeof $.plot != "undefined");
-      var canvasAvailable = ((typeof(document.createElement('canvas').getContext) != "undefined") || (typeof  window.CanvasRenderingContext2D != 'undefined' || typeof G_vmlCanvasManager != 'undefined'));
-
-      return (flotLoaded && canvasAvailable);
-    }
 });

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

@@ -0,0 +1,173 @@
+// 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);
+  }
+}
+
+// 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.parseNum($(container).find("ul li:first-child span.from").first().data('blrlBegin'));
+    var max = BlacklightRangeLimit.parseNum($(container).find("ul li:last-child span.to").first().data('blrlEnd'));
+
+    $(container).find("ul li").each(function() {
+        var from = BlacklightRangeLimit.parseNum($(this).find("span.from").first().data('blrlBegin'));
+        var to = BlacklightRangeLimit.parseNum($(this).find("span.to").first().data('blrlEnd'));
+        var count = BlacklightRangeLimit.parseNum($(this).find("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").html() });
+    });
+    var max_plus_one = BlacklightRangeLimit.parseNum($(container).find("ul li:last-child span.to").text())+1;
+    x_ticks.push( max_plus_one );
+
+
+
+    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+1]);
+        }
+      }
+    });
+
+    var form = $(container).closest(".limit_content").find("form.range_limit");
+    form.find("input.range_begin, input.range_end").change(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]-1)), true);
+    });
+
+    // initially entirely selected, to match slider
+    plot.setSelection( {xaxis: { from:min, to:max+0.9999}}  );
+  }
+}
+
+// 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,6 +1,6 @@
-
-// 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
+/**
+ * Global BlacklightRangeLimit module setup.
+ */
 !function(global) {
   'use strict';
 
@@ -10,11 +10,75 @@
     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, 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'));
+
+    return (flotLoaded && canvasAvailable);
+  }
+
   BlacklightRangeLimit.noConflict = function noConflict() {
     global.BlacklightRangeLimit = previousBlacklightRangeLimit;
     return BlacklightRangeLimit;

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

@@ -3,66 +3,64 @@
 Blacklight.onLoad(function() {
 
   $(".range_limit .profile .range.slider_js").each(function() {
-    buildSlider(this);
+    BlacklightRangeLimit.buildSlider(this);
   });
 
   $(Blacklight.modal.modalSelector).on('shown.bs.modal', function() {
     $(this).find(".range_limit .profile .range.slider_js").each(function() {
-      buildSlider(this);
+      BlacklightRangeLimit.buildSlider(this);
     });
   });
 
-// catch event for redrawing chart, to redraw slider to match width
-$("body").on("plotDrawn.blacklight.rangeLimit", function(event) {
-  var area       = $(event.target).closest(".limit_content.range_limit");
-  var plot       = area.find(".chart_js").data("plot");
-  var slider_el  = area.find(".slider");
+  // catch event for redrawing chart, to redraw slider to match width
+  $("body").on("plotDrawn.blacklight.rangeLimit", function(event) {
+    var area       = $(event.target).closest(".limit_content.range_limit");
+    var plot       = area.find(".chart_js").data("plot");
+    var slider_el  = area.find(".slider");
 
-  if (plot && slider_el) {
+    if (plot && slider_el) {
       slider_el.width(plot.width());
       slider_el.css("display", "block")
-  }
+    }
+  });
 });
 
 // returns two element array min/max as numbers. If there is a limit applied,
 // it's boundaries are are limits. Otherwise, min/max in current result
 // set as sniffed from HTML. Pass in a DOM element for a div.range
 // Will return NaN as min or max in case of error or other weirdness. 
-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'))
-   if ( isNaN(min)) {
-     min = BlacklightRangeLimit.parseNum(current_limit.find(".from").first().data('blrlBegin'));
-     max = BlacklightRangeLimit.parseNum(current_limit.find(".to").first().data('blrlEnd'));
-   }
-  
-   if (isNaN(min) || isNaN(max)) {
-      //no current limit, take from results min max included in spans
-      min = BlacklightRangeLimit.parseNum($(range_element).find(".min").first().text());
-      max = BlacklightRangeLimit.parseNum($(range_element).find(".max").first().text());
-   }
-   console.log(min, max)
-   return [min, max]
+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'))
+  if ( isNaN(min)) {
+    min = BlacklightRangeLimit.parseNum(current_limit.find(".from").first().data('blrlBegin'));
+    max = BlacklightRangeLimit.parseNum(current_limit.find(".to").first().data('blrlEnd'));
+  }
+
+  if (isNaN(min) || isNaN(max)) {
+    //no current limit, take from results min max included in spans
+    min = BlacklightRangeLimit.parseNum($(range_element).find(".min").first().text());
+    max = BlacklightRangeLimit.parseNum($(range_element).find(".max").first().text());
+  }
+  return [min, max]
 }
 
 
 // Check to see if a value is an Integer
 // see: http://stackoverflow.com/questions/3885817/how-to-check-if-a-number-is-float-or-integer
-function isInt(n) {
+BlacklightRangeLimit.isInt = function isInt(n) {
   return n % 1 === 0;
 }
 
-  function buildSlider(thisContext) {
+BlacklightRangeLimit.buildSlider = function buildSlider(thisContext) {
     var range_element = $(thisContext);
 
-    var boundaries = min_max(thisContext);
+    var boundaries = BlacklightRangeLimit.min_max(thisContext);
     var min = boundaries[0];
     var max = boundaries[1];
 
-    if (isInt(min) && isInt(max)) {
+    if (BlacklightRangeLimit.isInt(min) && BlacklightRangeLimit.isInt(max)) {
       $(thisContext).contents().wrapAll('<div class="sr-only" />');
 
       var range_element = $(thisContext);
@@ -138,4 +136,3 @@ function isInt(n) {
       placeholder_input.slider("setValue", values);
     });
   }
-});

data/app/helpers/range_limit_helper.rb

@@ -63,9 +63,14 @@ module RangeLimitHelper
 
   ##
   # A method that is meant to be overridden downstream to format how a range
-  # label might be displayed to a user. By default it just returns the value.
-  def format_range_display_value(value, _solr_field)
-    value
+  # label might be displayed to a user. By default it just returns the value
+  # as rendered by the presenter
+  def format_range_display_value(value, solr_field)
+    if respond_to?(:facet_item_presenter)
+      facet_item_presenter(facet_configuration_for_field(solr_field), value, solr_field).label
+    else
+      facet_display_value(solr_field, value)
+    end
   end
 
   # Show the limit area if:

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

@@ -7,10 +7,11 @@
         <span class="facet-label">
             <%= link_to(
                   t('blacklight.range_limit.range_html',
-                  begin: format_range_display_value(facet_display_value(solr_field, hash[:from]), solr_field),
-                  begin_value: facet_display_value(solr_field, hash[:from]),
-                  end: format_range_display_value(facet_display_value(solr_field, hash[:to]), solr_field),
-                  end_value: facet_display_value(solr_field, hash[:to])),
+                    begin: format_range_display_value(hash[:from], solr_field),
+                    begin_value: hash[:from],
+                    end: format_range_display_value(hash[:to], solr_field),
+                    end_value: hash[:to]
+                  ),
                   search_action_url(add_range(solr_field, hash[:from], hash[:to]).except(:controller, :action)),
                   class: 'facet_select'
               ) %>

data/blacklight_range_limit.gemspec

@@ -17,15 +17,16 @@ Gem::Specification.new do |s|
 
   s.license     = 'Apache 2.0'
 
-  s.add_dependency 'blacklight', '>= 7.0'
+  s.add_dependency 'blacklight', '~> 7.0'
 
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'capybara', '~> 3'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'launchy'
-  s.add_development_dependency 'solr_wrapper', '~> 0.14'
+  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
 end

data/config/locales/blacklight_range_limit.ar.yml

@@ -10,4 +10,4 @@ ar:
       view_larger: 'عرض بحجم أكبر »'
       results_range_html: 'تمتد النتائج الحالية من <span class="min">%{min}</span> إلى<span class="max">%{max}</span>'
       single_html: '<span class="single" data-blrl-single="%{begin_value}">%{begin}</span>'
-      range_html: '<span class="from" data-blrl-begin="%{begin_value}">%{begin}</span> إلى<span class="to" data-blrl-end="%{end_value}">%{end}</span>'
+      range_html: '<span class="from" data-blrl-begin="%{begin_value}">%{begin}</span> الى <span class="to" data-blrl-end="%{end_value}">%{end}</span>'

data/lib/blacklight_range_limit/engine.rb

@@ -7,7 +7,9 @@ module BlacklightRangeLimit
     # Need to tell asset pipeline to precompile the excanvas
     # we use for IE.
     initializer "blacklight_range_limit.assets", :after => "assets" do
-      Rails.application.config.assets.precompile += %w( flot/excanvas.min.js )
+      if defined? Sprockets
+        Rails.application.config.assets.precompile += %w( flot/excanvas.min.js )
+      end
     end
 
     config.action_dispatch.rescue_responses.merge!(

data/lib/blacklight_range_limit/view_helper_override.rb

@@ -35,7 +35,7 @@
           facet_field_label(solr_field),
           range_display(solr_field, my_params),
           escape_value: false,
-          remove: remove_range_param(solr_field, my_params)
+          remove: search_action_path(remove_range_param(solr_field, my_params))
         )
       end
     end
@@ -87,14 +87,14 @@
     private
 
     def range_params(my_params = params)
-      return {} unless my_params[:range].is_a?(ActionController::Parameters)
+      return {} unless my_params[:range].is_a?(ActionController::Parameters) || my_params[:range].is_a?(Hash)
 
       my_params[:range].select do |_solr_field, range_options|
         next unless range_options
 
-        [range_options['missing'],
-         range_options['begin'],
-         range_options['end']].any?
+        [range_options['missing'].presence,
+         range_options['begin'].presence,
+         range_options['end'].presence].any?
       end
     end
   end

data/lib/generators/blacklight_range_limit/install_generator.rb

@@ -9,7 +9,7 @@ module BlacklightRangeLimit
     end
 
     def install_catalog_controller_mixin
-      inject_into_class 'app/controllers/catalog_controller.rb', CatalogController do
+      inject_into_file 'app/controllers/catalog_controller.rb', after: /include Blacklight::Catalog.*$/ do
         "\n  include BlacklightRangeLimit::ControllerOverride\n"
       end
     end

data/spec/features/blacklight_range_limit_spec.rb

@@ -24,7 +24,15 @@ describe "Blacklight Range Limit" do
     click_link 'View distribution'
     click_link '2000 to 2008'
 
-    expect(page).to have_content "2000 to 2008 ✖ [remove] 12"
+    within '.blacklight-pub_date_si' do
+      expect(page).to have_content "2000 to 2008 ✖ [remove] 12"
+    end
+
+    within '.constraints-container'  do
+      expect(page).to have_content '2000 to 2008'
+    end
+
+    expect(page).to have_content '1 - 10 of 12'
   end
 
   it "should not include page parameter" do

data/spec/lib/blacklight_range_limit/view_helper_override_helper_spec.rb

@@ -5,7 +5,13 @@ RSpec.describe BlacklightRangeLimit::ViewHelperOverride, type: :helper do
     before do
       allow(helper).to receive_messages(
         facet_field_label: 'Date Range',
-        remove_range_param: '/remove'
+        remove_range_param: {},
+        search_action_path: '/catalog',
+        blacklight_config: CatalogController.blacklight_config,
+        search_state: {},
+      )
+      allow(controller).to receive_messages(
+        search_state_class: Blacklight::SearchState,
       )
     end
 
@@ -32,7 +38,11 @@ RSpec.describe BlacklightRangeLimit::ViewHelperOverride, type: :helper do
 
   describe 'render_search_to_s_filters' do
     before do
-      allow(helper).to receive_messages(facet_field_label: 'Date Range')
+      allow(helper).to receive_messages(
+        facet_field_label: 'Date Range',
+        blacklight_config: CatalogController.blacklight_config,
+        search_state: {},
+      )
     end
 
     it 'does not return any content when the range parameter invalid' do
@@ -82,6 +92,13 @@ RSpec.describe BlacklightRangeLimit::ViewHelperOverride, type: :helper do
           ActionController::Parameters.new(range: { field_name: { 'wrong' => 'data' } })
         )
       ).to eq({})
+
+      expect(
+        helper.send(
+          :range_params,
+          ActionController::Parameters.new(range: { field_name: { 'begin' => '', 'end' => '' } })
+        )
+      ).to eq({})
     end
 
     it 'returns the range parameters that are present' do

data/spec/test_app_templates/Gemfile.extra

@@ -1,2 +1,2 @@
 gem 'rails-controller-testing'
-gem 'thor', '~> 0.20'
+gem 'blacklight', ENV['BLACKLIGHT_VERSION'] if ENV['BLACKLIGHT_VERSION']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 7.8.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
@@ -99,16 +99,16 @@ dependencies:
   name: solr_wrapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: engine_cart
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +151,20 @@ dependencies:
     - - "~>"
       - !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: 
 email:
 - blacklight-development@googlegroups.com
@@ -158,10 +172,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".solr_wrapper.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -169,6 +183,7 @@ files:
 - 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.scss
@@ -256,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Blacklight Range Limit plugin

data/.travis.yml

@@ -1,28 +0,0 @@
-dist: trusty
-language: ruby
-addons:
-  chrome: stable
-before_install:
-  - google-chrome-stable --headless --disable-gpu --remote-debugging-port=9222 http://localhost &
-
-notifications:
-  email: false
-
-matrix:
-  include:
-    - rvm: 2.6.5
-      env: "RAILS_VERSION=6.0.0 ENGINE_CART_RAILS_OPTIONS=\"--skip-webpack-install\""
-    - rvm: 2.6.5
-      env: "RAILS_VERSION=5.2.3"
-    - rvm: 2.5.7
-      env: "RAILS_VERSION=5.1.7"
-
-notifications:
-  irc: "irc.freenode.org#blacklight"
-  email:
-      - blacklight-commits@googlegroups.com
-
-global_env:
-  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-
-jdk: oraclejdk9