blacklight_range_limit 8.4.0 → 9.0.0.beta1

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

@@ -1,161 +0,0 @@
-// for Blacklight.onLoad:
-
-Blacklight.onLoad(function() {
-
-  $(".range_limit .profile .range.slider_js").each(function() {
-    BlacklightRangeLimit.buildSlider(this);
-  });
-
-  // Support for Blacklight 7 and 8:
-  const modalSelector = Blacklight.modal?.modalSelector || Blacklight.Modal.modalSelector 
-
-  $(modalSelector).on('shown.bs.modal', function() {
-    $(this).find(".range_limit .profile .range.slider_js").each(function() {
-      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");
-
-    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.
-BlacklightRangeLimit.min_max = function min_max(range_element) {
-  var current_limit =  $(range_element).closest(".limit_content.range_limit").find(".current")
-  let min, max
-  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
-BlacklightRangeLimit.isInt = function isInt(n) {
-  return n % 1 === 0;
-}
-
-BlacklightRangeLimit.buildSlider = function buildSlider(thisContext) {
-    var range_element = $(thisContext);
-
-    var boundaries = BlacklightRangeLimit.min_max(thisContext);
-    var min = boundaries[0];
-    var max = boundaries[1];
-
-    if (BlacklightRangeLimit.isInt(min) && BlacklightRangeLimit.isInt(max)) {
-      $(thisContext).contents().wrapAll('<div class="sr-only visually-hidden" />');
-
-      var range_element = $(thisContext);
-      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="hidden" data-slider-placeholder="true" />').appendTo(range_element);
-
-      // make sure slider is loaded
-      if (placeholder_input.slider !== undefined) {
-        placeholder_input.slider({
-          min: min,
-          max: max,
-          value: [min, max],
-          tooltip: "hide"
-        });
-
-        // try to make slider width/orientation match chart's
-        var container = range_element.closest(".range_limit");
-        var plot_el = container.find(".chart_js");
-        var plot = plot_el.data("plot");
-        var slider_el = container.find(".slider");
-
-        if (plot_el) {
-          plot_el.attr('aria-hidden', 'true');
-        }
-
-        if (slider_el) {
-          slider_el.attr('aria-hidden', 'true');
-        }
-
-        if (plot && slider_el) {
-          slider_el.width(plot.width());
-          slider_el.css("display", "block")
-        } else if (slider_el) {
-          slider_el.css("width", "100%");
-        }
-      }
-
-      // Slider change should update text input values.
-      var parent = $(thisContext).parent();
-      var form = $(parent).closest(".limit_content").find("form.range_limit");
-      $(parent).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]);
-      });
-    }
-
-    begin_el.val(min);
-    end_el.val(max);
-
-    begin_el.on('input', function() {
-      var val = BlacklightRangeLimit.parseNum(this.value);
-      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.on('input', function() {
-      var val = BlacklightRangeLimit.parseNum(this.value);
-      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);
-    });
-
-    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/assets/javascripts/blacklight_range_limit.js

@@ -1,25 +0,0 @@
-// Master manifest file for engine, so local app can require
-// this one file, but get all our files -- and local app
-// require does not need to change if we change file list.
-//
-// Note JQuery is required to be loaded for flot and blacklight_range_limit
-// JS to work, expect host app to load it.
-
-
-//= require 'flot/jquery.canvaswrapper.js'
-//= require 'flot/jquery.colorhelpers.js'
-//= require 'flot/jquery.flot.js'
-//= require 'flot/jquery.flot.browser.js'
-//= require 'flot/jquery.flot.saturated.js'
-//= require 'flot/jquery.flot.drawSeries.js'
-//= require 'flot/jquery.event.drag.js'
-//= require 'flot/jquery.flot.hover.js'
-//= require 'flot/jquery.flot.uiConstants.js'
-//= require 'flot/jquery.flot.selection.js'
-//= require 'bootstrap-slider'
-
-// 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/stylesheets/blacklight_range_limit/blacklight_range_limit.css

@@ -1,60 +0,0 @@
-form.range_limit {
-  /* leave room for buttons not to collide on line wrap */
-  line-height: 3;
-}
-
-.range_limit .range-limit-input-group {
-  max-width: 350px;
-  width: 100% !important;
-}
-
-.range_limit input.range_begin, .range_limit input.range_end {
-  display: inline-block;
-  width: 4.5em;
-}
-
-.limit_content .subsection {
-  margin-top: 0.5em;
-}
-
-.hover_legend {
-  padding: 0.25em;
-}
-
-.slider_js .slider-selection {
-  /* color from flot selection */
-  background: #e8cfac;
-}
-
-.slider_js .slider-horizontal {
-  margin-left: 5px;
-  margin-right: 5px;
-}
-
-.chart_js .flot-x-axis {
-  font-size: 14px;
-}
-
-.modal-body .view_larger {
-  display: none;
-}
-
-/* Prevent an unstyled flash of content for values we'll replace with a chart */
-.js .distribution .facet-values {
-  display: none;
-}
-
-.modal-body .range_limit {
-  justify-content: center;
-}
-
-.view_larger {
-  display: block;
-  text-align: center;
-}
-
-.range_limit .chart_js {
-  min-height: 80px;
-  margin-left: -12px;
-  margin-right: -14px;
-}

data/app/assets/stylesheets/blacklight_range_limit.css

@@ -1,7 +0,0 @@
-/* Master manifest file for engine, so local app can require
- * 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'
- */

data/app/helpers/range_limit_helper.rb

@@ -1,130 +0,0 @@
-module RangeLimitHelper
-  extend Deprecation
-
-  def range_limit_url(options = {})
-    main_app.url_for(search_state.to_h.merge(action: 'range_limit').merge(options))
-  end
-  deprecation_deprecate :range_limit_url
-
-  def range_limit_panel_url(options = {})
-    search_facet_path(id: options[:id])
-  end
-  deprecation_deprecate :range_limit_panel_url
-
-  # type is 'begin' or 'end'
-  def render_range_input(solr_field, type, input_label = nil, maxlength=4)
-    range_form_component(solr_field).render_range_input(type, input_label, maxlength)
-  end
-  deprecation_deprecate :render_range_input
-
-  # type is 'min' or 'max'
-  # Returns smallest and largest value in current result set, if available
-  # from stats component response.
-  def range_results_endpoint(solr_field, type)
-    presenter = range_facet_field_presenter(solr_field)
-
-    case type.to_s
-    when 'min'
-      presenter.min
-    when 'max'
-      presenter.max
-    end
-  end
-  deprecation_deprecate :range_results_endpoint
-
-  def range_display(solr_field, my_params = params)
-    facet_config = blacklight_config.facet_fields[solr_field]
-    presenter = range_facet_field_presenter(solr_field)
-    return unless presenter.selected_range
-
-    facet_item = Blacklight::Solr::Response::Facets::FacetItem.new(value: presenter.selected_range, hits: presenter.response.total)
-
-    facet_config.item_presenter.new(facet_item, facet_config, self, solr_field).label
-  end
-  deprecation_deprecate :range_display
-
-  ##
-  # 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)
-    Deprecation.warn(RangeLimitHelper, 'Helper #format_range_display_value is deprecated without replacement')
-    facet_item_presenter(facet_configuration_for_field(solr_field), value, solr_field).label
-  end
-
-  # Show the limit area if:
-  # 1) we have a limit already set
-  # OR
-  # 2) stats show max > min, OR
-  # 3) count > 0 if no stats available.
-  def should_show_limit(solr_field)
-    presenter = range_facet_field_presenter(solr_field)
-
-    presenter.selected_range ||
-      (presenter.max && presenter.min && presenter.max > presenter.min) ||
-      @response.total.positive?
-  end
-
-  def stats_for_field(solr_field)
-    range_facet_field_presenter(solr_field).send(:stats_for_field)
-  end
-  deprecation_deprecate :stats_for_field
-
-  def stats_for_field?(solr_field)
-    stats_for_field(solr_field).present?
-  end
-  deprecation_deprecate :stats_for_field?
-
-  def add_range_missing(solr_field, my_params = params)
-    Blacklight::SearchState.new(my_params.except(:page), blacklight_config).filter(solr_field).add(Blacklight::SearchState::FilterField::MISSING)
-  end
-  deprecation_deprecate :add_range_missing
-
-  def add_range(solr_field, from, to, my_params = params)
-    Blacklight::SearchState.new(my_params.except(:page), blacklight_config).filter(solr_field).add(from..to)
-  end
-  deprecation_deprecate :add_range
-
-  def has_selected_range_limit?(solr_field)
-    range_facet_field_presenter(solr_field).selected_range.present?
-  end
-  deprecation_deprecate :has_selected_range_limit?
-
-  def selected_missing_for_range_limit?(solr_field)
-    search_state.filter(solr_field).values.first == Blacklight::SearchState::FilterField::MISSING
-  end
-  deprecation_deprecate :selected_missing_for_range_limit?
-
-  def remove_range_param(solr_field, my_params = params)
-    Blacklight::SearchState.new(my_params.except(:page), blacklight_config).filter(solr_field).remove(0..0)
-  end
-
-  # Looks in the solr @response for ["facet_counts"]["facet_queries"][solr_field], for elements
-  # expressed as "solr_field:[X to Y]", turns them into
-  # a list of hashes with [:from, :to, :count], sorted by
-  # :from. Assumes integers for sorting purposes.
-  def solr_range_queries_to_a(solr_field)
-    range_facet_field_presenter(solr_field).range_queries.map do |item|
-      { from: item.value.first, to: item.value.last, count: item.hits }
-    end
-  end
-  deprecation_deprecate :solr_range_queries_to_a
-
-  def range_config(solr_field)
-    BlacklightRangeLimit.range_config(blacklight_config, solr_field)
-  end
-  deprecation_deprecate :range_config
-
-  private
-
-  def range_facet_field_presenter(key)
-    facet_config = blacklight_config.facet_fields[key] || Blacklight::Configuration::FacetField.new(key: key, **BlacklightRangeLimit.default_range_config)
-    facet_field_presenter(facet_config, Blacklight::Solr::Response::Facets::FacetField.new(key, [], response: @response))
-  end
-
-  def range_form_component(key)
-    presenter = range_facet_field_presenter(key)
-
-    BlacklightRangeLimit::RangeFormComponent.new(facet_field: presenter)
-  end
-end

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

@@ -1,8 +0,0 @@
-<% Deprecation.warn(BlacklightRangeLimit, 'The blacklight_range_limit/range_segments partial is deprecated. Render the RangeSegmentsComponent directly.') %>
-
-<%
-  facet = blacklight_config.facet_fields[solr_field]
-  display_facet = @response.aggregations[facet.field] || Blacklight::Solr::Response::Facets::FacetField.new(facet.key, [], response: @response)
-  presenter = (facet.presenter || BlacklightRangeLimit::FacetFieldPresenter).new(facet, display_facet, self)
-%>
-<%= render BlacklightRangeLimit::RangeSegmentsComponent.new(facet_field: presenter) %>

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

@@ -1 +0,0 @@
-<%= render BlacklightRangeLimit::RangeSegmentsComponent.new(facet_field: facet_field) %>

data/app/views/catalog/range_limit_panel.html.erb

@@ -1 +0,0 @@
-<%= render template: 'catalog/facet' %>

data/spec/features/a_javascript_spec.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'JavaScript', js: true do
-  it 'initializes canvas chart' do
-    visit search_catalog_path
-
-    click_button 'Publication Date Sort'
-    expect(page).to have_css '.flot-base'
-  end
-  it 'has a View larger modal' do
-    visit search_catalog_path
-
-    click_button 'Publication Date Sort'
-    sleep(1) # resize is debounced
-    click_link 'View larger »'
-
-    within '.modal-body' do
-      expect(page).to have_css '.flot-base'
-    end
-  end
-
-  context 'when assumed boundaries configured' do
-    before do
-      CatalogController.blacklight_config.facet_fields['pub_date_si'].range_config = {
-        assumed_boundaries: 1990...2000
-      }
-    end
-
-    after do
-      CatalogController.blacklight_config.facet_fields['pub_date_si'].range_config = {}
-    end
-
-    it 'should show the range limit with set boundaries' do
-      visit '/catalog'
-      click_button 'Publication Date Sort'
-      expect(page).to have_field :range_pub_date_si_begin, with: '1990'
-      expect(page).to have_field :range_pub_date_si_end, with: '2000'
-    end
-  end
-
-  describe '"Unknown" link' do
-    context 'when in the facet (e.g. non-xhr)' do
-      it 'is displayed' do
-        visit search_catalog_path
-
-        click_button 'Publication Date Sort'
-
-        within 'ul.subsection.missing' do
-          expect(page).to have_link '[Missing]'
-        end
-      end
-    end
-
-    context 'when in the modal (e.g. via xhr)' do
-      it 'is not displayed' do
-        visit search_catalog_path
-
-        click_button 'Publication Date Sort'
-        sleep(1) # resize is debounced
-        click_link 'View larger »'
-
-        within '.modal-body' do
-          expect(page).not_to have_css 'ul.subsection.missing'
-        end
-      end
-    end
-  end
-end

data/spec/helpers/blacklight_range_limit_helper_spec.rb

@@ -1,37 +0,0 @@
-require "spec_helper"
-
-describe "Blacklight Range Limit Helper" do
-  let(:config) { Blacklight::Configuration.new }
-  before do
-    allow(helper).to receive(:blacklight_config).and_return(config)
-    allow(helper).to receive(:search_state).and_return(Blacklight::SearchState.new({}, config))
-  end
-
-  it "should render range text fields with/without labels" do
-    begin_html = Capybara.string(helper.render_range_input('pub_date', 'begin'))
-    begin_from_pub_html = Capybara.string(helper.render_range_input('pub_date', 'begin', 'from pub date'))
-    expect(begin_html).to have_css 'input.form-control.range_begin#range_pub_date_begin'
-    expect(begin_from_pub_html).to have_css 'label.sr-only[for="range_pub_date_begin"]'
-  end
-
-  it "should render range text fields with specified maxlength, defaulting to 4 if not specified" do
-    html_maxlength_default = Capybara.string(helper.render_range_input('pub_date', 'begin'))
-    html_maxlength_6 = Capybara.string(helper.render_range_input('pub_date', 'begin', nil, 6))
-    expect(html_maxlength_default).to have_css 'input.form-control.range_begin#range_pub_date_begin[maxlength="4"]'
-    expect(html_maxlength_6).to have_css 'input.form-control.range_begin#range_pub_date_begin[maxlength="6"]'
-  end
-
-  context "when building requests" do
-    it "should exclude page when adding a range" do
-      params = { q: '', page: '2' }
-      updated_params = helper.add_range('test', '1900', '1995', params)
-      expect(updated_params.to_h).not_to include(:page)
-    end
-
-    it "should exclude page when adding a missing range" do
-      params = { q: '', page: '2' }
-      updated_params = helper.add_range_missing('test', params)
-      expect(updated_params.to_h).not_to include(:page)
-    end
-  end
-end