blacklight_range_limit 2.3.0 → 5.0.0

data/.gitignore

@@ -20,8 +20,8 @@ pkg
 Gemfile.lock
 
 ## PROJECT::SPECIFIC
-.internal_test_app
+
 /spec/internal
 /jetty
 /pkg
-/tmp
+/tmp

data/.travis.yml

@@ -1,17 +1,11 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.7
+notifications:
+  email: false
 
-matrix:
-  include:
-    - rvm: 2.3.7
-      env: "RAILS_VERSION=4.0.13"
-    - rvm: 2.3.7
-      env: "RAILS_VERSION=4.1.16"
-    - rvm: 2.3.7
-      env: "RAILS_VERSION=4.2.10"
+rvm:
+  - 1.9.3
+  - 2.0.0
 
 notifications:
   irc: "irc.freenode.org#blacklight"
-  email: false
+  email:
+      - blacklight-commits@googlegroups.com

data/Gemfile

@@ -1,42 +1,16 @@
-source 'https://rubygems.org'
+source 'http://rubygems.org'
 
 gemspec
 
-# BEGIN ENGINE_CART BLOCK
-# engine_cart: 1.0.1
-# engine_cart stanza: 0.10.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)
-  begin
-    eval_gemfile file
-  rescue Bundler::GemfileError => e
-    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
-    Bundler.ui.warn e.message
-  end
-else
-  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
-  if ENV['RAILS_VERSION']
-    if ENV['RAILS_VERSION'] == 'edge'
-      gem 'rails', github: 'rails/rails'
-      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
-    else
-      gem 'rails', ENV['RAILS_VERSION']
-    end
-  end
-  case ENV['RAILS_VERSION']
-  when /^4.2/
-    gem 'responders', '~> 2.0'
-    gem 'sass-rails', '>= 5.0'
-    gem 'coffee-rails', '~> 4.1.0'
-  when /^4.[01]/
-    gem 'sass-rails', '< 5.0'
-  end
+gem 'engine_cart'
+
+group :test do
+  gem 'devise'
+  gem 'devise-guests'
+  gem "bootstrap-sass"
+  gem 'turbolinks'
 end
-# END ENGINE_CART BLOCK
 
 if File.exists?('spec/test_app_templates/Gemfile.extra')
   eval File.read('spec/test_app_templates/Gemfile.extra'), nil, 'spec/test_app_templates/Gemfile.extra'
 end
-
-gem 'json', '~> 1.8'

data/LICENSE

@@ -0,0 +1,15 @@
+##########################################################################
+# Copyright 2010-2014 The Board of Trustees of the Leland Stanford Junior University, and Johns Hopkins Universities. 
+# Additional copyright may be held by others, as reflected in the commit log
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

data/README.rdoc

@@ -25,7 +25,7 @@ The pre Solr 1.4 now deprecated sint or slong types should work fine too.
 
 = Installation
 
-Recent versions of this plugin require Blacklight versions 3.2 or later, which requires Rails 3.1 or later and the Rails asset pipeline. 
+Current 5.x version of `blacklight_range_limit` work with `blacklight` 5.x -- we now synchronize the _major version number_ between `blacklight` and `blacklight_range_limit`.  `blacklight_range_limit` 2.1 is the last version believed to work with blacklight 4.x or possibly blacklight 3.x.
 
 Add
 
@@ -92,7 +92,7 @@ Instead of simply passing "true", you can pass a hash with additional configurat
    
 == 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 is added with excanvas[http://excanvas.sourceforge.net/]. 
+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. 
 
 A `require 'blacklight_range_limit'` in a Rails asset pipeline manifest file will automatically include all of these things. The blacklight_range_limit adds just this line to your `app/assets/application.js`. 
 
@@ -102,7 +102,28 @@ Note this means a copy of jquery, from the jquery-rails gem, will be included in
 
 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. 
 
-The excanvas inclusion for IE is handled a bit differently. Coudln't get conditional inclusion of excanvas in pure JS to work, it does need an actual seperate script line in the HTML document surrounded by IE conditional comments; this gem adds that line using Blacklight's `extra_head_content` feature allowing dependencies to inject content in HTML head; requires your layout to follow BL conventions, or just add excanvas yourself manually. This gem's attempt to inject the excanvas script line can be turned off in configuration, see Injection below. 
+== 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
+[bootstrap_slider](http://www.eyecon.ro/bootstrap-slider/), which says if you add
+Modernizr to your page, touch events will be supported. We haven't tested it
+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. 
 
 
 == Injection
@@ -122,8 +143,7 @@ You can also turn off injection of individual components, which could be more us
   BlacklightRangeLimit.omit_inject = {
     :view_helpers => false,
     :controller_mixin => false,
-    :routes => false,
-    :excanvas => false
+    :routes => false
   }
 [:view_helpers]
   Set to false and the plugin will not insert it's own rails view helpers into the app. It will raise lots of errors if you do this, you probably don't want to. 
@@ -131,8 +151,6 @@ You can also turn off injection of individual components, which could be more us
   The plugin mixes some methods into CatalogController, both over-riding Blacklight methods, and providing a new action of it's own. Set to false, and the plugin won't. You've basically disabled the plugin if you do this.  
 [:routes]
   Disable automatic routes loading
-[:excanvas]
-  Disables injection of a conditionally-commented script tag to load the excanvas library for supporting 'canvas' on IE.  blacklight_range_limit does this in the controller mixin, using Blacklight's "extra_head_content" feature to add actual conditional script tag for IE in html <head>. 
   
 See Javascript Dependencies above for disabling injection of gem's js.   
   

data/Rakefile

@@ -24,8 +24,7 @@ RSpec::Core::RakeTask.new do |t|
 end
 
 task :ci => ['jetty:clean', 'engine_cart:generate'] do
-  ENV['environment'] = "test"
-  jetty_params = Jettywrapper.load_config
+  jetty_params = Jettywrapper.load_config('test')
   jetty_params[:startup_wait]= 60
   error = Jettywrapper.wrap(jetty_params) do
     Rake::Task["test:seed"].invoke
@@ -38,9 +37,9 @@ namespace :test do
 
   desc "Put sample data into solr"
   task :seed => ['engine_cart:generate'] do
-    docs = File.join(APP_ROOT, 'solr', 'sample_solr_documents.yml')
     within_test_app do
-      system "RAILS_ENV=test rake blacklight_test_app:seed DOC_PATH=#{docs}"
+      ENV['RAILS_ENV'] ||= 'test'
+      system "rake blacklight:solr:seed"
     end
   end
 

data/VERSION

@@ -1 +1 @@
-2.3.0
+5.0.0

data/app/assets/javascripts/blacklight_range_limit.js

@@ -3,8 +3,11 @@
 // require does not need to change if we change file list.
 
 //= require 'jquery'
-//= require 'jquery-ui-1.9.2.custom.js'
+
 //= require 'flot/jquery.flot.js'
 //= require 'flot/jquery.flot.selection.js'
-//= require bootstrap-tooltip
+//= require 'bootstrap-slider'
+
+//= require bootstrap/tooltip
+
 //= require_tree './blacklight_range_limit'

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

@@ -1,4 +1,18 @@
-jQuery(document).ready(function($) {
+// for Blacklight.onLoad:
+//= require blacklight/core
+
+/* 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. */
+
+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());
@@ -16,13 +30,118 @@ jQuery(document).ready(function($) {
       });
   });
 
-  function turnIntoPlot(container) {
-    wrapPrepareForFlot($(container),
-      $(container).closest(".range_limit.limit_content"),
-      1/(1.618 * 2), // half a golden rectangle, why not.
-      function(container) {
-        areaChart($(container));
-      });
+  // 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").size() == 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. 
+      turnIntoPlot(container, 1100);
+    }
+  });
+
+
+
+  // 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);
+  });
+
+  // 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.
+  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) {
+      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
@@ -78,28 +197,24 @@ jQuery(document).ready(function($) {
           alert(err);
         }
 
-        // Div initially hidden to show hover mouseover legend for
-        // each segment.
-        $('<div class="subsection hover_legend ui-corner-all"></div>').css('display', 'block').insertAfter(container);
-
         find_segment_for = function_for_find_segment(pointer_lookup);
         var last_segment = null;
 
         $(container).bind("plothover", function (event, pos, item) {
-            segment = find_segment_for(pos.x);
+          segment = find_segment_for(pos.x);
 
-            if(segment != last_segment) {
+          if(segment != last_segment) {
             $('.distribution').tooltip('destroy');
             $('.distribution').tooltip({'title': function() { return find_segment_for(pos.x).label  + ' (' + segment.count + ')' }, 'placement': 'bottom', 'trigger': 'manual', 'delay': { show: 0, hide: 100}});
+            $('.distribution').tooltip('show');
 
-             last_segment  = segment;
+            last_segment  = segment;
            }
-            $('.distribution').tooltip('show');
-           // showHoverLegend(container, segment.label + '<span class="count">(' + segment.count + ')</span>');
         });
+
         $(container).bind("mouseout", function() {
-            $('.distribution').tooltip('hide');
-          //$(container).next(".hover_legend").hide();
+          last_segment = null;
+          $('.distribution').tooltip('hide');
         });
         $(container).bind("plotclick", function (event, pos, item) {
             if ( plot.getSelection() == null) {
@@ -107,7 +222,7 @@ jQuery(document).ready(function($) {
               plot.setSelection( normalized_selection(segment.from, segment.to));
             }
         });
-        $(container).bind("plotselected plotselecting", function(event, ranges) {
+        $(container).bind("plotselected plotselecting", function(event, ranges) {          
             if (ranges != null ) {
               var from = Math.floor(ranges.xaxis.from);
               var to = Math.floor(ranges.xaxis.to);
@@ -116,11 +231,10 @@ jQuery(document).ready(function($) {
               form.find("input.range_begin").val(from);
               form.find("input.range_end").val(to);
               
-              var slider_container = $(container).closest(".limit_content").find(".profile .range");
-							$(document).ready(function() {
-								slider_container.slider("values", 0, from);
-	              slider_container.slider("values", 1, to+1);
-							});
+              var slider_placeholder = $(container).closest(".limit_content").find("[data-slider-placeholder]");
+              if (slider_placeholder) {
+							  slider_placeholder.slider("setValue", [from, to+1]);
+              }								
             }
         });
 
@@ -128,24 +242,15 @@ jQuery(document).ready(function($) {
         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").bind("slide", function(event, ui) {
-           plot.setSelection( normalized_selection(ui.values[0], Math.max(ui.values[0], ui.values[1]-1)), 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}}  );
-        
-        // try to make slider width/orientation match chart's
-        var slider_container = $(container).closest(".limit_content").find(".profile .range");
-        slider_container.width(plot.width());
-        slider_container.css('margin-right', 'auto');
-        slider_container.css('margin-left', 'auto');   
-        // And set slider min/max to match charts, for sure
-				$(document).ready(function() {
-	        slider_container.slider("option", "min", min);
-	        slider_container.slider("option", "max", max+1);					
-				});
-
       }
     }
 
@@ -184,13 +289,6 @@ jQuery(document).ready(function($) {
       };
     }
         
-    function showHoverLegend(container, contents) {
-      var el = $(container).next(".hover_legend");
-
-      el.html(contents);                   
-      el.show();
-    }
-    
     // Check if Flot is loaded, and if browser has support for
     // canvas object, either natively or via IE excanvas. 
     function domDependenciesMet() {    
@@ -199,26 +297,4 @@ jQuery(document).ready(function($) {
 
       return (flotLoaded && canvasAvailable);
     }
-
-   /* Set up dom for flot rendering: flot needs to render in a non-hidden
-     div with explicitly set width and height. The non-hidden thing
-     is annoying to us, since it might be in a hidden facet limit.
-     Can we get away with moving it off-screen? Not JUST the flot
-     container, or it will render weird. But the whole parent
-     limit content, testing reveals we can. */
-    function wrapPrepareForFlot(container, parent_section, widthToHeight, call_block) {
-      var c = $(parent_section).closest(".panel-collapse.collapse");
-        var parent_originally_hidden = c != [];
-        if (parent_originally_hidden) {
-          c.collapse('show');
-        }
-        $(container).width( $(parent_section).width() );
-        $(container).height( $(parent_section).width() * widthToHeight );
-
-        call_block(container);
-
-        if (parent_originally_hidden) {
-          c.collapse('hide');
-        }
-    }
 });