blacklight_range_limit 2.3.0 → 5.0.0

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

@@ -1,9 +1,8 @@
-jQuery(document).ready(function($) {
-    
-      
-   
+// for Blacklight.onLoad:
+//= require blacklight/core
 
-    
+Blacklight.onLoad(function() {
+        
 $(".range_limit .profile .range.slider_js").each(function() {
    var range_element = $(this);
     
@@ -18,42 +17,75 @@ $(".range_limit .profile .range.slider_js").each(function() {
      var form = $(range_element).closest(".range_limit").find("form.range_limit");
      var begin_el = form.find("input.range_begin");
      var end_el = form.find("input.range_end");
+
+     var placeholder_input = $('<input type="text" data-slider-placeholder="true" style="width:100%;">').appendTo(range_element);
      
-     if ($(this).slider) {
-       $(this).slider({
-           range: true,
-           min: min,
-           max: max+1,
-           values: [min, max+1],
-           slide: function(event, ui) {
-              begin_el.val(ui.values[0]);
-              
-              end_el.val(Math.max(ui.values[1]-1, ui.values[0]));
-            }
-        });
+     // make sure slider is loaded
+     if (placeholder_input.slider !== undefined) {
+      placeholder_input.slider({
+        min: min,
+        max: max+1,
+        value: [min, max+1],
+        tooltip: "hide"
+      });
+
+      // try to make slider width/orientation match chart's
+      var container      = range_element.closest(".range_limit");
+      var plot           = container.find(".chart_js").data("plot");
+      var slider_el      = container.find(".slider");
+       
+      if (plot && slider_el) { 
+        slider_el.width(plot.width());
+        slider_el.css("display", "block")
+        slider_el.css('margin-right', 'auto');
+        slider_el.css('margin-left', 'auto'); 
+      }
+      else if (slider_el) {
+        slider_el.css("width", "100%");
+      }
      }
+   }
+
         
-        begin_el.val(min);
-        end_el.val(max);
+  begin_el.val(min);
+  end_el.val(max);
         
-        begin_el.change( function() {
-           var val = parseInt($(this).val());
-           if ( isNaN(val)  || val < min) {
-             //for weird data, set slider at min           
-             val = min;
-           }
-           range_element.slider("values", 0, val);
-        });
+  begin_el.change( function() {
+    var val = parseInt($(this).val());
+    if ( isNaN(val)  || val < min) {
+      //for weird data, set slider at min           
+      val = min;
+    }
+    var values = placeholder_input.data("slider").getValue();
+    values[0] = val;
+    placeholder_input.slider("setValue", values);
+  });
         
-        end_el.change( function() {
-           var val = parseInt($(this).val());
-           if ( isNaN(val) || val > max ) {
-             //weird entry, set slider to max
-             val = max;
-           }
-           range_element.slider("values", 1, val+1);         
-        });
-   }
+  end_el.change( function() {
+     var val = parseInt($(this).val());
+     if ( isNaN(val) || val > max ) {
+       //weird entry, set slider to max
+       val = max;
+     }
+    var values = placeholder_input.data("slider").getValue();
+    values[1] = val;
+    placeholder_input.slider("setValue", values);
+  });    
+   
+});
+
+// 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) {
+      slider_el.width(plot.width());
+      slider_el.css("display", "block")
+      slider_el.css('margin-right', 'auto');
+      slider_el.css('margin-left', 'auto'); 
+  }
 });
 
 // returns two element array min/max as numbers. If there is a limit applied,

data/app/assets/stylesheets/blacklight_range_limit.css.scss

@@ -2,51 +2,6 @@
  * this one file, but get all our files -- and local app
  * require does not need to change if we change file list. 
  *
+ *= require 'slider'
  *= require_tree './blacklight_range_limit'
  */
-
- .ui-slider { position: relative; text-align: left; }
-.ui-slider .ui-slider-handle { position: absolute; z-index: 2; width: 1.2em; height: 1.2em; cursor: default; }
-.ui-slider .ui-slider-range { position: absolute; z-index: 1; font-size: .7em; display: block; border: 0; background-position: 0 0; }
-
-.ui-slider-horizontal { height: .8em; }
-.ui-slider-horizontal .ui-slider-handle { top: -.3em; margin-left: -.6em; }
-.ui-slider-horizontal .ui-slider-range { top: 0; height: 100%; }
-.ui-slider-horizontal .ui-slider-range-min { left: 0; }
-.ui-slider-horizontal .ui-slider-range-max { right: 0; }
-
-.ui-slider-vertical { width: .8em; height: 100px; }
-.ui-slider-vertical .ui-slider-handle { left: -.3em; margin-left: 0; margin-bottom: -.6em; }
-.ui-slider-vertical .ui-slider-range { left: 0; width: 100%; }
-.ui-slider-vertical .ui-slider-range-min { bottom: 0; }
-.ui-slider-vertical .ui-slider-range-max { top: 0; }
-
-.ui-widget { font-family: Helvetica,Arial,sans-serif; font-size: 1.1em; }
-.ui-widget .ui-widget { font-size: 1em; }
-.ui-widget input, .ui-widget select, .ui-widget textarea, .ui-widget button { font-family: Helvetica,Arial,sans-serif; font-size: 1em; }
-.ui-widget-content { border: 1px solid #dddddd; background: #ffffff; color: #444444; }
-.ui-widget-content a { color: #444444; }
-.ui-widget-header { border: 1px solid #dddddd; background: #dddddd; color: #444444; font-weight: bold; }
-.ui-widget-header a { color: #444444; }
-
-/* Interaction states
-----------------------------------*/
-.ui-state-default, .ui-widget-content .ui-state-default, .ui-widget-header .ui-state-default { border: 1px solid #dddddd; background: #f6f6f6; font-weight: bold; color: #0073ea; }
-.ui-state-default a, .ui-state-default a:link, .ui-state-default a:visited { color: #0073ea; text-decoration: none; }
-.ui-state-hover, .ui-widget-content .ui-state-hover, .ui-widget-header .ui-state-hover, .ui-state-focus, .ui-widget-content .ui-state-focus, .ui-widget-header .ui-state-focus { border: 1px solid #0073ea; background: #0073ea; font-weight: bold; color: #ffffff; }
-.ui-state-hover a, .ui-state-hover a:hover, .ui-state-hover a:link, .ui-state-hover a:visited { color: #ffffff; text-decoration: none; }
-.ui-state-active, .ui-widget-content .ui-state-active, .ui-widget-header .ui-state-active { border: 1px solid #dddddd; background: #ffffff; font-weight: bold; color: #ff0084; }
-.ui-state-active a, .ui-state-active a:link, .ui-state-active a:visited { color: #ff0084; text-decoration: none; }
-
-/* Interaction Cues
-----------------------------------*/
-.ui-state-highlight, .ui-widget-content .ui-state-highlight, .ui-widget-header .ui-state-highlight  {border: 1px solid #cccccc; background: #ffffff; color: #444444; }
-.ui-state-highlight a, .ui-widget-content .ui-state-highlight a,.ui-widget-header .ui-state-highlight a { color: #444444; }
-.ui-state-error, .ui-widget-content .ui-state-error, .ui-widget-header .ui-state-error {border: 1px solid #ff0084; background: #ffffff; color: #222222; }
-.ui-state-error a, .ui-widget-content .ui-state-error a, .ui-widget-header .ui-state-error a { color: #222222; }
-.ui-state-error-text, .ui-widget-content .ui-state-error-text, .ui-widget-header .ui-state-error-text { color: #222222; }
-.ui-priority-primary, .ui-widget-content .ui-priority-primary, .ui-widget-header .ui-priority-primary { font-weight: bold; }
-.ui-priority-secondary, .ui-widget-content .ui-priority-secondary,  .ui-widget-header .ui-priority-secondary { opacity: .7; filter:Alpha(Opacity=70); font-weight: normal; }
-.ui-state-disabled, .ui-widget-content .ui-state-disabled, .ui-widget-header .ui-state-disabled { opacity: .35; filter:Alpha(Opacity=35); background-image: none; }
-.ui-state-disabled .ui-icon { filter:Alpha(Opacity=35); } /* For IE8 - See #6059 */
-

data/app/assets/stylesheets/blacklight_range_limit/blacklight_range_limit.css

@@ -1,6 +1,11 @@
+form.range_limit {
+  /* leave room for buttons not to collide on line wrap */
+  line-height: 3;
+}
+
 form.range_limit input.range_begin, form.range_limit input.range_end {
-  border:1px solid #DDDDDD;
-  width: 4em;
+  display: inline-block;
+  width: 4.5em;
 }
 
 .limit_content .subsection {
@@ -10,3 +15,8 @@ form.range_limit input.range_begin, form.range_limit input.range_end {
 .hover_legend {
   padding: 0.25em;
 }
+
+.slider_js .slider-selection {
+  /* color from flot selection */
+  background: #e8cfac;
+}

data/app/helpers/range_limit_helper.rb

@@ -7,7 +7,7 @@ module RangeLimitHelper
     
     default = params["range"][solr_field][type] if params["range"] && params["range"][solr_field] && params["range"][solr_field][type]
     
-    text_field_tag("range[#{solr_field}][#{type}]", default, :maxlength=>4, :class => "range_#{type}")
+    text_field_tag("range[#{solr_field}][#{type}]", default, :maxlength=>4, :class => "form-control range_#{type}")
   end
 
   # type is 'min' or 'max'
@@ -82,6 +82,12 @@ module RangeLimitHelper
     my_params["range"][solr_field]["begin"] = from
     my_params["range"][solr_field]["end"] = to
     my_params["range"][solr_field].delete("missing")
+
+    # eliminate temporary range status params that were just
+    # for looking things up
+    my_params.delete("range_field")
+    my_params.delete("range_start")
+    my_params.delete("range_end")
     
     return my_params
   end

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

@@ -9,15 +9,24 @@
          ( (! params["range"][solr_field]["begin"].blank?) ||
            (! params["range"][solr_field]["end"].blank?) ||
            params["range"][solr_field]["missing"]) %>
-    <div class="current">
-      <span class="selected"><%= range_display(solr_field) %></span> <span class="count">(<%= format_num(@response.total) %>)</span> <%= link_to "[remove]", remove_range_param(solr_field), :class=>"remove" %>
-    </div>
+    <ul class="current list-unstyled facet-values">
+      <li class="selected">
+        <span class="facet-label">
+          <span class="selected"><%= range_display(solr_field) %></span> 
+           <%= link_to remove_range_param(solr_field), :class=>"remove", :title => "remove" do %>
+            <span class="glyphicon glyphicon-remove"></span>
+            <span class="sr-only">[remove]</span>
+           <% end %>
+        </span>
+        <span class="selected facet-count"><%= number_with_delimiter(@response.total) %></span>
+      </li>
+    </ul>
          
   <% end %>
 
   <% unless params["range"] && params["range"][solr_field] && params["range"][solr_field]["missing"] %>  
     <%= form_tag catalog_index_path, :method => :get, :class=>"range_limit subsection range_#{solr_field} form-inline" do %>
-      <%= search_as_hidden_fields %>
+      <%= render_hash_as_hidden_fields(params_for_search) %>
       
       <!-- we need to include a dummy search_field parameter if none exists,
            to trick blacklight into displaying actual search results instead
@@ -26,8 +35,8 @@
         <%= hidden_field_tag("search_field", "dummy_range") %>
       <% end %>
       
-      <%= render_range_input(solr_field, :begin) %> - <%= render_range_input(solr_field, :end) %>
-      <%= submit_tag 'Limit', :class=>'submit btn' %>
+      <%= render_range_input(solr_field, :begin) %> – <%= render_range_input(solr_field, :end) %>
+      <%= submit_tag 'Limit', :class=>'submit btn btn-default' %>
     
     <% end %>
   <% end %>
@@ -40,9 +49,9 @@
     
         <% if (min = range_results_endpoint(solr_field, :min)) &&
               (max = range_results_endpoint(solr_field, :max)) %>
-          <div class="range subsection <%= "slider_js" unless field_config[:slider_js] == false  %>">
+          <p class="range subsection <%= "slider_js" unless field_config[:slider_js] == false  %>">
             Current results range from <span class="min"><%= range_results_endpoint(solr_field, :min) %></span> to <span class="max"><%= range_results_endpoint(solr_field, :max) %></span>
-          </div>
+          </p>
           
           <% if field_config[:segments] != false %>
             <div class="distribution subsection <%= 'chart_js' unless field_config[:chart_js] == false %>">
@@ -63,9 +72,16 @@
         
         
         <% if (stats = stats_for_field(solr_field)) && stats["missing"] > 0 %>
-          <div class="missing subsection">
-            <%= link_to BlacklightRangeLimit.labels[:missing], add_range_missing(solr_field) %> <%= render_facet_count(stats["missing"]) %>
-          </div>
+          <ul class="missing list-unstyled facet-values subsection">
+            <li>
+              <span class="facet-label">
+                <%= link_to BlacklightRangeLimit.labels[:missing], add_range_missing(solr_field) %>
+              </span>
+              <span class="facet-count">
+                <%= number_with_delimiter(stats["missing"]) %>
+              </span>
+            </li>
+          </ul>
         <% end %>
     </div>
   <% end %>

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

@@ -1,14 +1,19 @@
 <% # must pass in local variable :solr_field
 %>
 
-<ul>
+<ul class="facet-values list-unstyled">
   <% solr_range_queries_to_a(solr_field).each do |hash| %>
-    <li><%= link_to(
-      content_tag("span", hash[:from], :class => "from") + 
-        " to " + 
-        content_tag("span", hash[:to], :class => "to"), 
-        add_range(solr_field, hash[:from], hash[:to]).merge(:action => "index"),
-        :class => "facet_select"
-      ) %> (<%= content_tag("span", hash[:count], :class=>"count")%>)</li>
+    <li>
+        <span class="facet-label">
+            <%= link_to(
+              content_tag("span", facet_display_value(solr_field, hash[:from]), :class => "from") + 
+                " to " + 
+                content_tag("span", facet_display_value(solr_field, hash[:to]), :class => "to"), 
+                add_range(solr_field, hash[:from], hash[:to]).merge(:action => "index"),
+                :class => "facet_select"
+              ) %> 
+        </span>
+        <%= render_facet_count hash[:count], classes: ['count'] %>
+    </li>
   <% end %>
 </ul>

data/blacklight_range_limit.gemspec

@@ -5,31 +5,28 @@ Gem::Specification.new do |s|
   s.name = "blacklight_range_limit"
   s.version = BlacklightRangeLimit::VERSION
   s.platform = Gem::Platform::RUBY
-  s.authors = ["Jonathan Rochkind"]
+  s.authors = ["Jonathan Rochkind", "Chris Beer"]
   s.email = ["blacklight-development@googlegroups.com"]
-  s.homepage    = "http://projectblacklight.org/"
+  s.homepage    = "https://github.com/projectblacklight/blacklight_range_limit"
   s.summary = "Blacklight Range Limit plugin"
 
-  s.rubyforge_project = "blacklight"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.license     = "Apache 2.0"
+
   s.add_dependency "rails", ">= 3.0", "< 5.0"
   s.add_dependency "jquery-rails" # our JS needs jquery_rails
-  s.add_dependency "blacklight", "~> 4.0"
+  # for blacklight, we want to allow 5.0.0.preX, as well as all 5.x.y, 
+  # but not 6. can't seem to make it do so other than this:
+  s.add_dependency "blacklight", ">= 5.0.0.pre4", "< 6"
 
-  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "rspec", ">= 2.0"
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency "capybara"
   s.add_development_dependency "sqlite3"
   s.add_development_dependency 'launchy'
-  s.add_development_dependency "jettywrapper"
-  s.add_development_dependency 'engine_cart', '~> 2.0'
-  s.add_development_dependency 'devise'
-  s.add_development_dependency 'devise-guests'
-  s.add_development_dependency 'bootstrap-sass'
-  s.add_development_dependency 'turbolinks'
+  s.add_development_dependency "jettywrapper", "~> 1.5", ">= 1.5.2"
 end

data/config/jetty.yml

@@ -1,4 +1,9 @@
-default:
+development:
   startup_wait: 15
-  jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8888 %> 
+  jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8888 %>
+  <%= ENV['TEST_JETTY_PATH'] ? "jetty_home: " + ENV['TEST_JETTY_PATH'] : '' %>
+
+test:
+  startup_wait: 15
+  jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8888 %>
   <%= ENV['TEST_JETTY_PATH'] ? "jetty_home: " + ENV['TEST_JETTY_PATH'] : '' %>

data/lib/blacklight_range_limit/controller_override.rb

@@ -17,16 +17,6 @@ module BlacklightRangeLimit
         helper BlacklightRangeLimit::ViewHelperOverride
         helper RangeLimitHelper
       end
-  
-      before_filter do |controller|
-        unless BlacklightRangeLimit.omit_inject[:excanvas]
-               
-          # canvas for IE. Need to inject it like this even with asset pipeline
-          # cause it needs IE conditional include. view_context hacky way
-          # to get asset url helpers. 
-          controller.extra_head_content << ('<!--[if lt IE 9]>' + view_context.javascript_include_tag("flot/excanvas.min.js") + ' <![endif]-->').html_safe
-        end
-      end
     end
   
     # Action method of our own!
@@ -60,7 +50,7 @@ module BlacklightRangeLimit
     
     # Method added to solr_search_params_logic to fetch
     # proper things for date ranges. 
-    def add_range_limit_params(solr_params, req_params)    
+    def add_range_limit_params(solr_params, req_params)
        ranged_facet_configs = 
          blacklight_config.facet_fields.select { |key, config| config.range } 
        # In ruby 1.8, hash.select returns an array of pairs, in ruby 1.9
@@ -107,8 +97,9 @@ module BlacklightRangeLimit
     # Returns range config hash for named solr field. Returns false
     # if not configured. Returns hash even if configured to 'true'
     # for consistency. 
-    def range_config(solr_field)    
-      field = blacklight_config.facet_fields[solr_field]
+    def range_config(solr_field)
+      field = blacklight_config.facet_fields[solr_field.to_s]
+
       return false unless field.range
 
       config = field.range

data/lib/blacklight_range_limit/route_sets.rb

@@ -1,12 +1,29 @@
 module BlacklightRangeLimit
+  # This module is monkey-patch included into Blacklight::Routes, so that
+  # map_resource will route to catalog#range_limit, for our action
+  # that fetches and returns range segments -- that action is
+  # also monkey patched into (eg) CatalogController.
   module RouteSets
+    extend ActiveSupport::Concern
+
+
+    included do |klass|
+      # Have to add ours BEFORE existing,
+      # so catalog/range_limit can take priority over
+      # being considered a document ID.
+      klass.default_route_sets = [:range_limit] + klass.default_route_sets
+    end
+
+
     protected
-    def catalog
+
+
+    # Add route for (eg) catalog/range_limit, pointing to the range_limit
+    # method we monkey patch into (eg) CatalogController.
+    def range_limit(primary_resource)
       add_routes do |options|
-        get 'catalog/range_limit' => 'catalog#range_limit'
+        get "#{primary_resource}/range_limit" => "#{primary_resource}#range_limit"
       end
-
-      super
     end
   end
 end

data/lib/blacklight_range_limit/view_helper_override.rb

@@ -3,10 +3,17 @@
   # display. 
   module BlacklightRangeLimit::ViewHelperOverride
 
-    def has_range_limit_parameters?(my_params = params)
-      my_params[:range] &&
-        my_params[:range].any? do |key, v|
-          v.present? && v.respond_to?(:'[]') &&
+
+    
+    def facet_partial_name(display_facet)
+      return "blacklight_range_limit/range_limit_panel" if range_config(display_facet.name) and should_show_limit(display_facet.name)
+      super
+    end
+
+    def has_range_limit_parameters?(params = params)
+      params[:range] && 
+        params[:range].any? do |key, v| 
+          v.present? && v.respond_to?(:'[]') && 
           (v["begin"].present? || v["end"].present? || v["missing"].present?)
         end
     end
@@ -16,13 +23,21 @@
       super || has_range_limit_parameters?
     end
 
-    def query_has_constraints?(my_params = params)
-      super(my_params) || has_range_limit_parameters?(my_params)
+    def query_has_constraints?(params = params)         
+      super || has_range_limit_parameters?(params)
     end
 
-    def facet_partial_name(display_facet)
-      return "blacklight_range_limit/range_limit_panel" if range_config(display_facet.name) and should_show_limit(display_facet.name)
-      super
+    # Over-ride to recognize our custom params for range facets
+    def facet_field_in_params?(field_name)
+      return super || (
+        range_config(field_name) &&
+        params[:range] &&
+        params[:range][field_name] &&
+          ( params[:range][field_name]["begin"].present? ||
+            params[:range][field_name]["end"].present? ||
+            params[:range][field_name]["missing"].present?
+          )
+      )
     end
 
     def render_constraints_filters(my_params = params)
@@ -30,9 +45,10 @@
       # add a constraint for ranges?
       unless my_params[:range].blank?
         my_params[:range].each_pair do |solr_field, hash|
+
           next unless hash["missing"] || (!hash["begin"].blank?) || (!hash["end"].blank?)
           content << render_constraint_element(
-            facet_field_labels[solr_field],
+            blacklight_config.facet_fields[solr_field].label,
             range_display(solr_field, my_params),
             :escape_value => false,
             :remove => remove_range_param(solr_field, my_params)
@@ -50,7 +66,7 @@
           next unless hash["missing"] || (!hash["begin"].blank?) || (! hash["end"].blank?)        
           
           content << render_search_to_s_element(
-            facet_field_labels[solr_field],
+            blacklight_config.facet_fields[solr_field].label,
             range_display(solr_field, my_params),
             :escape_value => false
           )