blacklight_range_limit 7.7.0 → 7.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2167f6be6b6b4e9b67276d274aed5d5a3422779297c7630509bc9d562d355a76
-  data.tar.gz: 290370f3bfc33223c8a8ead2547241f6d5af25647acd6fce5f37bfefbcf3bbdc
+  metadata.gz: 68ba781f0cbb0071d01c7c4f271e2f313acb1d9c12b867ccc49fdc707c886b4f
+  data.tar.gz: 9653d4141da91db97aa7130563fe5048dab111e5e42ccc46ec820aa1477d3d84
 SHA512:
-  metadata.gz: 52823d196806781d9c00ffe501f9b96c1d6c0808fdb6cd0aa14484873624ab744079d0751a8c9a9f9de5082b28cf1226214bcd517cbc2eae04d7125dff3d0a6d
-  data.tar.gz: '04678a126c9947e4d6dcd9f56a9ffb71b61072e9d0f3f5f907ca6e98c1b0958bf8e2fd89d7057c5114ad08af444301f3d19a9b65dd1c2c1e093eef0a8eb897e8'
+  metadata.gz: 7ea0eac18d3819f38f2b92fc103cca7023553d9d8c3cac27561b8d8c188825f46f6d6f5f270876162c46864a53d7fb4902cd2d7855dcd58b74790156993eb0bb
+  data.tar.gz: 35295bea937bb314c4354d20f1f0d7962f702096af42c079bd74b76feb985019d21513b12049dd52e3578245ffd04e1aa79a731e12bd70e34cff58b71ff77775

data/.travis.yml

@@ -1,4 +1,4 @@
-dist: trusty
+dist: bionic
 language: ruby
 addons:
   chrome: stable
@@ -14,6 +14,8 @@ matrix:
       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.6.5
+      env: "RAILS_VERSION=5.2.3 BLACKLIGHT_VERSION=7.6.0"
     - rvm: 2.5.7
       env: "RAILS_VERSION=5.1.7"
 
@@ -25,4 +27,4 @@ notifications:
 global_env:
   - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
 
-jdk: oraclejdk9
+jdk: openjdk11

data/README.md

@@ -52,7 +52,7 @@ config.add_facet_field 'pub_date', label: 'Publication Year', range: true
 You should now get range limit display. More complicated configuration is available if desired, see Range Facet Configuration below.
 
 
-You can also configure the look and feel of the Flot chart using the jQuery .data() method. On the `.facet-limit` container you want to configure, add a Flot options associative array (documented at http://people.iola.dk/olau/flot/API.txt) as the `plot-config` key. The `plot-config` key to set the `plot-config` key on the appropriate `.facet-limit` container. In order to customize the plot colors, for example, you could use this code:
+You can also configure the look and feel of the Flot chart using the jQuery .data() method. On the `.blrl-plot-config` or `.facet-limit` container you want to configure, add a Flot options associative array (documented at http://people.iola.dk/olau/flot/API.txt) as the `plot-config` key. The `plot-config` key to set the `plot-config` key on the appropriate `.blrl-plot-config` or `.facet-limit` container. In order to customize the plot colors, for example, you could use this code:
 
 ```javascript
 $('.blacklight-year_i').data('plot-config', {

data/VERSION

@@ -1 +1 @@
-7.7.0
+7.9.1

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

@@ -166,12 +166,12 @@ Blacklight.onLoad(function() {
         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").text());
-        var max = BlacklightRangeLimit.parseNum($(container).find("ul li:last-child span.to").text());
+        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").text());
-            var to = BlacklightRangeLimit.parseNum($(this).find("span.to").text());
+            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));
 
@@ -191,7 +191,7 @@ Blacklight.onLoad(function() {
 
 
         var plot;
-        var config = $(container).closest('.facet-limit').data('plot-config') || {};
+        var config = $(container).closest('.blrl-plot-config').data('plot-config') || $(container).closest('.facet-limit').data('plot-config') || {};
 
         try {
           plot = $.plot($(container), [series_data],

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

@@ -33,10 +33,10 @@ function min_max(range_element) {
    
    
    
-   var min = max = BlacklightRangeLimit.parseNum(current_limit.find(".single").text())
+   var min = max = BlacklightRangeLimit.parseNum(current_limit.find(".single").data('blrlSingle'))
    if ( isNaN(min)) {
-     min = BlacklightRangeLimit.parseNum(current_limit.find(".from").first().text());
-     max = BlacklightRangeLimit.parseNum(current_limit.find(".to").first().text());
+     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)) {
@@ -44,7 +44,6 @@ function min_max(range_element) {
       min = BlacklightRangeLimit.parseNum($(range_element).find(".min").first().text());
       max = BlacklightRangeLimit.parseNum($(range_element).find(".max").first().text());
    }
-   
    return [min, max]
 }
 

data/app/helpers/range_limit_helper.rb

@@ -42,13 +42,35 @@ module RangeLimitHelper
       return t('blacklight.range_limit.missing')
     elsif hash["begin"] || hash["end"]
       if hash["begin"] == hash["end"]
-        return t('blacklight.range_limit.single_html', begin: h(hash['begin']))
+        return t(
+          'blacklight.range_limit.single_html',
+          begin: format_range_display_value(hash['begin'], solr_field),
+          begin_value: hash['begin']
+        )
       else
-        return t('blacklight.range_limit.range_html', begin: h(hash['begin']), end: h(hash['end']))
+        return t(
+          'blacklight.range_limit.range_html',
+          begin: format_range_display_value(hash['begin'], solr_field),
+          begin_value: hash['begin'],
+          end: format_range_display_value(hash['end'], solr_field),
+          end_value: hash['end']
+        )
       end
     end
 
-    return ""
+    ''
+  end
+
+  ##
+  # 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
+  # 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_limit_panel.html.erb

@@ -7,7 +7,7 @@
   maxlength = field_config[:maxlength]
 -%>
 
-<div class="limit_content range_limit">
+<div class="limit_content range_limit <%= field_name %>-config blrl-plot-config">
   <% if has_selected_range_limit?(field_name) %>
     <ul class="current list-unstyled facet-values">
       <li class="selected">

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

@@ -7,8 +7,11 @@
         <span class="facet-label">
             <%= link_to(
                   t('blacklight.range_limit.range_html',
-                  begin: facet_display_value(solr_field, hash[:from]),
-                  end: 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,14 +17,14 @@ 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', '~> 2.0'
   s.add_development_dependency 'engine_cart', '~> 2.1'
   s.add_development_dependency 'selenium-webdriver', '>= 3.13.1'
   s.add_development_dependency 'webdrivers', '~>3.0'

data/config/locales/blacklight_range_limit.ar.yml

@@ -9,5 +9,5 @@ ar:
       view_distribution: 'عرض التوزيع'
       view_larger: 'عرض بحجم أكبر »'
       results_range_html: 'تمتد النتائج الحالية من <span class="min">%{min}</span> إلى<span class="max">%{max}</span>'
-      single_html: '<span class="single">%{begin}</span>'
-      range_html: '<span class="from">%{begin}</span> إلى<span class="to">%{end}</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>'

data/config/locales/blacklight_range_limit.en.yml

@@ -9,5 +9,5 @@ en:
       view_distribution: 'View distribution'
       view_larger: 'View larger »'
       results_range_html: 'Current results range from <span class="min">%{min}</span> to <span class="max">%{max}</span>'
-      single_html: '<span class="single">%{begin}</span>'
-      range_html: '<span class="from">%{begin}</span> to <span class="to">%{end}</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> to <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,3 +1,3 @@
-gem 'blacklight', github: 'projectblacklight/blacklight', branch: 'master'
 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.7.0
+  version: 7.9.1
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-08-24 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
@@ -101,14 +101,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: engine_cart
   requirement: !ruby/object:Gem::Requirement