blacklight_range_limit 8.0.1 → 8.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bb8b93b89024fcd0473c00ec2c2af5c747efe3647f4da5bf0bb3bbb3c21ac82
-  data.tar.gz: 3b1b0220a810e2013be9d6fdab54b4a43f60ad31459fb102b3f8e7cb72b64545
+  metadata.gz: 05ea7ff70dd0f999147d9990af32784b0df857878223bab69db8017b48306e28
+  data.tar.gz: 44ce74fe4ec5d225e6da988e20b26710495e468e553e780e4e1e83d318dbf8bd
 SHA512:
-  metadata.gz: 978737dd4c81790eff59f6289912ca056e8b7c43e3de40c009fbf386a8edd19d8d32ef8eef6017c98a81ed4f5f79b76d8da3014ae6f1ee84a32b02b64403550d
-  data.tar.gz: 56e8a2d086be0a5d09f8aad3d1046fa29f79cfee82447e0cd7efd1a2d7bc245a1f0d6934567db9faf133f505498d284c28adfd60dafa66c138d16fd64b0e6566
+  metadata.gz: b1b66e4213828f0d2e86625e749a4d406217afb46000e3d8b294d0f3921b5451fa8a5647a9c480ad430b76e38aed2e29db0cd1ab550973b0861e24871c16666c
+  data.tar.gz: 729b9a29d7038dab2aa092939dfe83b8503edc1641812ff0f7b692de4fedda649f7d1f18b5395ccc61591f83956a0a87fe3dfd0159f717bac947bb2ae86e5f58

data/.github/workflows/ruby.yml

@@ -16,61 +16,29 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    name: test (ruby ${{ matrix.ruby }} / rails ${{ matrix.rails_version }})
     strategy:
       matrix:
-        rails_version: [6.1.1]
-        ruby: [2.7, 3.0]
+        ruby: [2.7, '3.0']
+        rails_version: ['6.1.5', '7.0.2.3']
+        additional_engine_cart_rails_options: ['']
+        include:
+        - ruby: '2.7'
+          rails_version: '5.2.4.2'
+        - ruby: '3.1'
+          rails_version: '7.0.2.3'
+        - ruby: '3.0'
+          rails_version: '7.0.2.3'
     env:
       RAILS_VERSION: ${{ matrix.rails_version }}
+      ENGINE_CART_RAILS_OPTIONS: "--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test ${{ matrix.engine_cart_rails_options }}"
     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
+    - uses: actions/checkout@v3
     - 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'
+      run: bundle exec rake ci

data/README.md

@@ -46,7 +46,7 @@ This will install some asset references in your application.js and application.c
 You have at least one solr field you want to display as a range limit, that's why you've installed this plugin. In your CatalogController, the facet configuration should look like:
 
 ```ruby
-config.add_facet_field 'pub_date', label: 'Publication Year', range: true
+config.add_facet_field 'pub_date', label: 'Publication Year', **default_range_config
 ```
 
 You should now get range limit display. More complicated configuration is available if desired, see Range Facet Configuration below.
@@ -138,11 +138,11 @@ is probably the best touch UI anyway, if it can be made to work well.
 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
 ```

data/VERSION

@@ -1 +1 @@
-8.0.1
+8.2.1

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

@@ -3,7 +3,7 @@
 /**
  * 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.  
+ * events.
  */
 
 Blacklight.onLoad(function() {

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

@@ -34,6 +34,19 @@ BlacklightRangeLimit.turnIntoPlot = function turnIntoPlot(container, wait_for_vi
   }
 }
 
+BlacklightRangeLimit.parseSegment = function parseSegment(el) {
+  if ($(el).find("span.single").first().data('blrlSingle')) {
+    var val = BlacklightRangeLimit.parseNum($(el).find("span.single").first().data('blrlSingle'));
+
+    return [val, val];
+  } else {
+    var from = BlacklightRangeLimit.parseNum($(el).find("span.from").first().data('blrlBegin'));
+    var to = BlacklightRangeLimit.parseNum($(el).find("span.to").first().data('blrlEnd'));
+
+    return [from, to];
+  }
+}
+
 // Takes a div holding a ul of distribution segments produced by
 // blacklight_range_limit/_range_facets and makes it into
 // a flot area chart.
@@ -45,15 +58,16 @@ BlacklightRangeLimit.areaChart = function areaChart(container) {
     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'));
+    var min = BlacklightRangeLimit.parseSegment($(container).find("ul li:first-child").first())[0];
+    var max = BlacklightRangeLimit.parseSegment($(container).find("ul li:last-child").first())[1];
 
     $(container).find("ul li").each(function() {
-        var 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));
+        var segment = BlacklightRangeLimit.parseSegment(this);
+        var from = segment[0];
+        var to = segment[1];
 
+        var count = BlacklightRangeLimit.parseNum($(this).find("span.facet-count,span.count").text());
+        var avg = (count / (to - from + 1));
 
         //We use the avg as the y-coord, to make the area of each
         //segment proportional to how many documents it holds.
@@ -62,12 +76,10 @@ BlacklightRangeLimit.areaChart = function areaChart(container) {
 
         x_ticks.push(from);
 
-        pointer_lookup.push({'from': from, 'to': to, 'count': count, 'label': $(this).find(".facet_select").html() });
+        pointer_lookup.push({'from': from, 'to': to, 'count': count, 'label': $(this).find(".facet-select,.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 );
-
 
+    x_ticks.push( max + 1 );
 
     var plot;
     var config = $(container).closest('.blrl-plot-config').data('plot-config') || $(container).closest('.facet-limit').data('plot-config') || {};
@@ -123,24 +135,24 @@ BlacklightRangeLimit.areaChart = function areaChart(container) {
 
         var slider_placeholder = $(container).closest(".limit_content").find("[data-slider-placeholder]");
         if (slider_placeholder) {
-          slider_placeholder.slider("setValue", [from, to+1]);
+          slider_placeholder.slider("setValue", [from, to]);
         }
       }
     });
 
     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 );
+    form.find("input.range_begin, input.range_end").on('input', function () {
+      plot.setSelection( BlacklightRangeLimit.form_selection(form, min, max), true );
     });
     $(container).closest(".limit_content").find(".profile .range").on("slide", function(event, ui) {
       var values = $(event.target).data("slider").getValue();
       form.find("input.range_begin").val(values[0]);
       form.find("input.range_end").val(values[1]);
-      plot.setSelection(BlacklightRangeLimit.normalized_selection(values[0], Math.max(values[0], values[1]-1)), true);
+      plot.setSelection(BlacklightRangeLimit.normalized_selection(values[0], Math.max(values[0], values[1])), true);
     });
 
     // initially entirely selected, to match slider
-    plot.setSelection( {xaxis: { from:min, to:max+0.9999}}  );
+    plot.setSelection(BlacklightRangeLimit.normalized_selection(min, max));
   }
 }
 

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

@@ -28,7 +28,7 @@ Blacklight.onLoad(function() {
 // 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. 
+// Will return NaN as min or max in case of error or other weirdness.
 BlacklightRangeLimit.min_max = function min_max(range_element) {
   var current_limit =  $(range_element).closest(".limit_content.range_limit").find(".current")
 
@@ -61,7 +61,7 @@ BlacklightRangeLimit.buildSlider = function buildSlider(thisContext) {
     var max = boundaries[1];
 
     if (BlacklightRangeLimit.isInt(min) && BlacklightRangeLimit.isInt(max)) {
-      $(thisContext).contents().wrapAll('<div class="sr-only" />');
+      $(thisContext).contents().wrapAll('<div class="sr-only visually-hidden" />');
 
       var range_element = $(thisContext);
       var form = $(range_element).closest(".range_limit").find("form.range_limit");
@@ -74,8 +74,8 @@ BlacklightRangeLimit.buildSlider = function buildSlider(thisContext) {
       if (placeholder_input.slider !== undefined) {
         placeholder_input.slider({
           min: min,
-          max: max + 1,
-          value: [min, max + 1],
+          max: max,
+          value: [min, max],
           tooltip: "hide"
         });
 
@@ -114,10 +114,10 @@ BlacklightRangeLimit.buildSlider = function buildSlider(thisContext) {
     begin_el.val(min);
     end_el.val(max);
 
-    begin_el.change(function() {
-      var val = BlacklightRangeLimit.parseNum($(thisContext).val());
+    begin_el.on('input', function() {
+      var val = BlacklightRangeLimit.parseNum(this.value);
       if (isNaN(val) || val < min) {
-        //for weird data, set slider at min           
+        //for weird data, set slider at min
         val = min;
       }
       var values = placeholder_input.data("slider").getValue();
@@ -125,8 +125,8 @@ BlacklightRangeLimit.buildSlider = function buildSlider(thisContext) {
       placeholder_input.slider("setValue", values);
     });
 
-    end_el.change(function() {
-      var val = BlacklightRangeLimit.parseNum($(thisContext).val());
+    end_el.on('input', function() {
+      var val = BlacklightRangeLimit.parseNum(this.value);
       if (isNaN(val) || val > max) {
         //weird entry, set slider to max
         val = max;
@@ -135,4 +135,24 @@ BlacklightRangeLimit.buildSlider = function buildSlider(thisContext) {
       values[1] = val;
       placeholder_input.slider("setValue", values);
     });
+
+    begin_el.change(function() {
+      var val1 = BlacklightRangeLimit.parseNum(begin_el.val());
+      var val2 = BlacklightRangeLimit.parseNum(end_el.val());
+
+      if (val2 < val1) {
+        begin_el.val(val2);
+        end_el.val(val1);
+      }
+    });
+
+    end_el.change(function() {
+      var val1 = BlacklightRangeLimit.parseNum(begin_el.val());
+      var val2 = BlacklightRangeLimit.parseNum(end_el.val());
+
+      if (val2 < val1) {
+        begin_el.val(val2);
+        end_el.val(val1);
+      }
+    });
   }

data/app/components/blacklight_range_limit/range_facet_component.html.erb

@@ -0,0 +1,48 @@
+<%= render(@layout.new(facet_field: @facet_field)) do |component| %>
+  <% component.label do %>
+    <%= @facet_field.label %>
+  <% end %>
+
+  <% component.body do %>
+    <div class="limit_content range_limit <%= @facet_field.key %>-config blrl-plot-config">
+      <% if @facet_field.selected_range_facet_item %>
+        <%= render BlacklightRangeLimit::RangeSegmentsComponent.new(facet_field: @facet_field, facet_items: [@facet_field.selected_range_facet_item], classes: ['current']) %>
+      <% end %>
+
+      <!-- no results profile if missing is selected -->
+      <% unless @facet_field.missing_selected? %>
+        <!-- you can hide this if you want, but it has to be on page if you want
+             JS slider and calculated facets to show up, JS sniffs it. -->
+        <div class="profile">
+          <% if (min = @facet_field.min) &&
+                (max = @facet_field.max) %>
+
+            <% if range_config[:segments] != false %>
+              <div class="distribution subsection <%= 'chart_js' unless range_config[:chart_js] == false %>">
+                <!-- if  we already fetched segments from solr, display them
+                     here. Otherwise, display a link to fetch them, which JS
+                     will AJAX fetch.  -->
+                <% if @facet_field.range_queries.any? %>
+                  <%= render BlacklightRangeLimit::RangeSegmentsComponent.new(facet_field: @facet_field) %>
+                <% else %>
+                  <%= link_to(t('blacklight.range_limit.view_distribution'), range_limit_url(range_start: min, range_end: max), class: "load_distribution") %>
+                <% end %>
+              </div>
+            <% end %>
+            <p class="range subsection <%= "slider_js" unless range_config[:slider_js] == false %>">
+              <%= t('blacklight.range_limit.results_range_html', min: min, max: max) %>
+            </p>
+          <% end %>
+        </div>
+
+        <%= render BlacklightRangeLimit::RangeFormComponent.new(facet_field: @facet_field, classes: @classes) %>
+
+        <%= more_link(key: @facet_field.key, label: @facet_field.label) unless @facet_field.in_modal? %>
+
+        <% if @facet_field.missing_facet_item && !request.xhr? %>
+          <%= render BlacklightRangeLimit::RangeSegmentsComponent.new(facet_field: @facet_field, facet_items: [@facet_field.missing_facet_item], classes: ['missing', 'subsection']) %>
+        <% end %>
+      <% end %>
+    </div>
+  <% end %>
+<% end %>

data/app/components/blacklight_range_limit/range_facet_component.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module BlacklightRangeLimit
+  class RangeFacetComponent < ::ViewComponent::Base
+    renders_one :more_link, ->(key:, label:) do
+      tag.div class: 'more_facets' do
+        link_to t('blacklight.range_limit.view_larger', field_name: label),
+          search_facet_path(id: key),
+          data: { blacklight_modal: 'trigger' }
+      end
+    end
+
+    delegate :search_action_path, :search_facet_path, to: :helpers
+
+    def initialize(facet_field:, layout: nil, classes: BlacklightRangeLimit.classes)
+      @facet_field = facet_field
+      @layout = layout == false ? Blacklight::FacetFieldNoLayoutComponent : Blacklight::FacetFieldComponent
+      @classes = classes
+    end
+
+    def range_config
+      @facet_field.range_config
+    end
+
+    def range_limit_url(options = {})
+      helpers.main_app.url_for(@facet_field.search_state.to_h.merge(range_field: @facet_field.key, action: 'range_limit').merge(options))
+    end
+  end
+end

data/app/components/blacklight_range_limit/range_form_component.html.erb

@@ -0,0 +1,12 @@
+<%= form_tag search_action_path, method: :get, class: [@classes[:form], "range_#{@facet_field.key} d-flex justify-content-center"].join(' ') do %>
+  <%= render Blacklight::HiddenSearchStateComponent.new(params: @facet_field.search_state.params_for_search.except(:utf8, :page)) %>
+
+  <div class="input-group input-group-sm mb-3 flex-nowrap range-limit-input-group">
+    <%= render_range_input(:begin, begin_label) %>
+    <%= render_range_input(:end, end_label) %>
+    <div class="input-group-append visually-hidden">
+      <%= submit_tag t('blacklight.range_limit.submit_limit'), class: @classes[:submit] %>
+    </div>
+    <%= submit_tag t('blacklight.range_limit.submit_limit'), class: @classes[:submit] + " sr-only", "aria-hidden": "true" %>
+  </div>
+<% end %>

data/app/components/blacklight_range_limit/range_form_component.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module BlacklightRangeLimit
+  class RangeFormComponent < ::ViewComponent::Base
+    delegate :search_action_path, to: :helpers
+
+    def initialize(facet_field:, classes: BlacklightRangeLimit.classes)
+      @facet_field = facet_field
+      @classes = classes
+    end
+
+    def begin_label
+      range_config[:input_label_range_begin] || t("blacklight.range_limit.range_begin", field_label: @facet_field.label)
+    end
+
+    def end_label
+      range_config[:input_label_range_end] || t("blacklight.range_limit.range_end", field_label: @facet_field.label)
+    end
+
+    def maxlength
+      range_config[:maxlength]
+    end
+
+    # type is 'begin' or 'end'
+    def render_range_input(type, input_label = nil, maxlength_override = nil)
+      type = type.to_s
+
+      default = if @facet_field.selected_range.is_a?(Range)
+                  case type
+                  when 'begin' then @facet_field.selected_range.first
+                  when 'end' then @facet_field.selected_range.last
+                  end
+                end
+
+      html = number_field_tag("range[#{@facet_field.key}][#{type}]", default, maxlength: maxlength_override || maxlength, class: "form-control text-center range_#{type}")
+      html += label_tag("range[#{@facet_field.key}][#{type}]", input_label, class: 'sr-only visually-hidden') if input_label.present?
+      html
+    end
+
+    private
+
+    def range_config
+      @facet_field.range_config
+    end
+  end
+end

data/app/components/blacklight_range_limit/range_segments_component.html.erb

@@ -0,0 +1,3 @@
+<ul class="facet-values list-unstyled <%= @classes.join(' ') %>">
+  <%= render @item_component.with_collection(facet_item_presenters) %>
+</ul>

data/app/components/blacklight_range_limit/range_segments_component.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BlacklightRangeLimit
+  class RangeSegmentsComponent < ::ViewComponent::Base
+    def initialize(facet_field:, facet_items: nil, item_component: nil, classes: [])
+      super
+
+      @facet_field = facet_field
+      @facet_items = facet_items || facet_field.try(:range_queries) || []
+      @item_component = facet_field.facet_field.item_component || Blacklight::FacetItemComponent
+      @classes = classes
+    end
+
+    def facet_item_presenters
+      @facet_items.map { |item| facet_item_presenter(item) }
+    end
+
+    def facet_item_presenter(facet_item)
+      facet_config.item_presenter.new(facet_item, facet_config, helpers, @facet_field.key)
+    end
+
+    def facet_config
+      @facet_field.facet_field
+    end
+  end
+end