blacklight_range_limit 8.0.1 → 8.2.1

data/spec/presenters/filter_field_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe BlacklightRangeLimit::FilterField do
+  let(:search_state) { Blacklight::SearchState.new(params, blacklight_config, controller) }
+
+  let(:param_values) { {} }
+  let(:params) { ActionController::Parameters.new(param_values) }
+  let(:blacklight_config) do
+    Blacklight::Configuration.new.configure do |config|
+      config.add_facet_field 'some_field', filter_class: described_class
+      config.filter_search_state_fields = true
+    end
+  end
+  let(:controller) { double }
+  let(:filter) { search_state.filter('some_field') }
+
+  describe '#add' do
+    it 'adds a new range parameter' do
+      new_state = filter.add(1999..2099)
+
+      expect(new_state.params.dig(:range, 'some_field')).to include begin: 1999, end: 2099
+    end
+  end
+
+  context 'with some existing data' do
+    let(:param_values) { { range: { some_field: { begin: '2013', end: '2022' } } } }
+
+    describe '#add' do
+      it 'replaces the existing range' do
+        new_state = filter.add(1999..2099)
+
+        expect(new_state.params.dig(:range, 'some_field')).to include begin: 1999, end: 2099
+      end
+    end
+
+    describe '#remove' do
+      it 'removes the existing range' do
+        new_state = filter.remove(2013..2022)
+
+        expect(new_state.params.dig(:range, 'some_field')).to be_blank
+      end
+    end
+
+    describe '#values' do
+      it 'converts the parameters to a Range' do
+        expect(filter.values).to eq [2013..2022]
+      end
+    end
+
+    describe '#include?' do
+      it 'compares the provided value to the parameter values' do
+        expect(filter.include?(2013..2022)).to eq true
+        expect(filter.include?(1234..2345)).to eq false
+      end
+    end
+  end
+
+  context 'with missing data' do
+    let(:param_values) { { range: { some_field: { begin: '', end: '' } } } }
+
+    describe '#values' do
+      it 'drops the empty range' do
+        expect(filter.values).to be_empty
+      end
+    end
+  end
+
+  context 'with array-mangled data' do
+    let(:param_values) { { range: { some_field: { begin: { '0' => '2013' }, end: { '0' => '2022' } } } } }
+
+    describe '#values' do
+      it 'converts the parameters to a Range' do
+        expect(filter.values).to eq [2013..2022]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -21,6 +21,10 @@ Capybara.register_driver :headless_chrome do |app|
   Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
 end
 
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Pathname.new(File.expand_path('support/**/*.rb', __dir__))].sort.each { |f| require f }
+
 RSpec.configure do |config|
   # rspec-rails 3 will no longer automatically infer an example group's spec type
   # from the file location. You can explicitly opt-in to the feature using this
@@ -32,4 +36,7 @@ RSpec.configure do |config|
   #       # Equivalent to being in spec/controllers
   #     end
   config.infer_spec_type_from_file_location!
+
+  config.include PresenterTestHelpers, type: :presenter
+  config.include ViewComponent::TestHelpers, type: :component
 end

data/spec/support/presenter_test_helpers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PresenterTestHelpers
+  def controller
+    @controller ||= ViewComponent::Base.test_controller.constantize.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
+  end
+
+  def request
+    @request ||= ActionDispatch::TestRequest.create
+  end
+end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -27,7 +27,7 @@ class TestAppGenerator < Rails::Generators::Base
 
   def inject_into_catalog_controller
     inject_into_file 'app/controllers/catalog_controller.rb', after: /config.add_facet_field 'format'.*$/ do
-      "\n    config.add_facet_field 'pub_date_si', label: 'Publication Date Sort', range: true"
+      "\n    config.add_facet_field 'pub_date_si', label: 'Publication Date Sort', **default_range_config"
     end
   end
 

metadata

@@ -1,30 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_range_limit
 version: !ruby/object:Gem::Version
-  version: 8.0.1
+  version: 8.2.1
 platform: ruby
 authors:
 - Jonathan Rochkind
 - Chris Beer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2022-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.22.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.22.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -165,7 +171,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - blacklight-development@googlegroups.com
 executables: []
@@ -188,31 +194,40 @@ files:
 - app/assets/javascripts/blacklight_range_limit/range_limit_slider.js
 - app/assets/stylesheets/blacklight_range_limit.css.scss
 - app/assets/stylesheets/blacklight_range_limit/blacklight_range_limit.css
+- app/components/blacklight_range_limit/range_facet_component.html.erb
+- app/components/blacklight_range_limit/range_facet_component.rb
+- app/components/blacklight_range_limit/range_form_component.html.erb
+- app/components/blacklight_range_limit/range_form_component.rb
+- app/components/blacklight_range_limit/range_segments_component.html.erb
+- app/components/blacklight_range_limit/range_segments_component.rb
 - app/helpers/range_limit_helper.rb
-- app/views/blacklight_range_limit/_range_limit_panel.html.erb
+- app/presenters/blacklight_range_limit/facet_field_presenter.rb
+- app/presenters/blacklight_range_limit/facet_item_presenter.rb
+- app/presenters/blacklight_range_limit/filter_field.rb
 - app/views/blacklight_range_limit/_range_segments.html.erb
-- app/views/blacklight_range_limit/range_limit_panel.html.erb
 - app/views/blacklight_range_limit/range_segments.html.erb
+- app/views/catalog/range_limit_panel.html.erb
 - blacklight_range_limit.gemspec
 - config/jetty.yml
 - config/locales/blacklight_range_limit.ar.yml
+- config/locales/blacklight_range_limit.de.yml
 - config/locales/blacklight_range_limit.en.yml
+- config/locales/blacklight_range_limit.it.yml
 - config/routes.rb
 - config/solr.yml
 - doc/example-screenshot.png
 - lib/blacklight_range_limit.rb
 - lib/blacklight_range_limit/controller_override.rb
 - lib/blacklight_range_limit/engine.rb
+- lib/blacklight_range_limit/facet_field_config_override.rb
 - lib/blacklight_range_limit/range_limit_builder.rb
 - lib/blacklight_range_limit/route_sets.rb
 - lib/blacklight_range_limit/routes.rb
 - lib/blacklight_range_limit/routes/range_searchable.rb
 - lib/blacklight_range_limit/segment_calculation.rb
 - lib/blacklight_range_limit/version.rb
-- lib/blacklight_range_limit/view_helper_override.rb
 - lib/generators/blacklight_range_limit/assets_generator.rb
 - lib/generators/blacklight_range_limit/install_generator.rb
-- lib/generators/blacklight_range_limit/templates/search_history_controller.rb
 - lib/tasks/blacklight_range_limit.rake
 - solr/conf/_rest_managed.json
 - solr/conf/admin-extra.html
@@ -231,14 +246,18 @@ files:
 - solr/conf/xslt/example_rss.xsl
 - solr/conf/xslt/luke.xsl
 - solr/sample_solr_documents.yml
+- spec/components/range_facet_component_spec.rb
 - spec/features/a_javascript_spec.rb
 - spec/features/blacklight_range_limit_spec.rb
 - spec/fixtures/solr_documents/unknown_year.yml
 - spec/fixtures/solr_documents/zero_year.yml
 - spec/helpers/blacklight_range_limit_helper_spec.rb
 - spec/lib/blacklight_range_limit/segment_calculation_spec.rb
-- spec/lib/blacklight_range_limit/view_helper_override_helper_spec.rb
+- spec/presenters/facet_field_presenter_spec.rb
+- spec/presenters/facet_item_presenter_spec.rb
+- spec/presenters/filter_field_spec.rb
 - spec/spec_helper.rb
+- spec/support/presenter_test_helpers.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 - vendor/assets/javascripts/bootstrap-slider.js
@@ -257,7 +276,7 @@ homepage: https://github.com/projectblacklight/blacklight_range_limit
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -272,18 +291,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Blacklight Range Limit plugin
 test_files:
+- spec/components/range_facet_component_spec.rb
 - spec/features/a_javascript_spec.rb
 - spec/features/blacklight_range_limit_spec.rb
 - spec/fixtures/solr_documents/unknown_year.yml
 - spec/fixtures/solr_documents/zero_year.yml
 - spec/helpers/blacklight_range_limit_helper_spec.rb
 - spec/lib/blacklight_range_limit/segment_calculation_spec.rb
-- spec/lib/blacklight_range_limit/view_helper_override_helper_spec.rb
+- spec/presenters/facet_field_presenter_spec.rb
+- spec/presenters/facet_item_presenter_spec.rb
+- spec/presenters/filter_field_spec.rb
 - spec/spec_helper.rb
+- spec/support/presenter_test_helpers.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb

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

@@ -1,90 +0,0 @@
-<%- # requires solr_config local passed in
-  field_config = range_config(field_name)
-  label = facet_field_label(field_name)
-
-  input_label_range_begin = field_config[:input_label_range_begin] || t("blacklight.range_limit.range_begin", field_label: label)
-  input_label_range_end   = field_config[:input_label_range_end] || t("blacklight.range_limit.range_end", field_label: label)
-  maxlength = field_config[:maxlength]
--%>
-
-<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">
-        <span class="facet-label">
-          <span class="selected"><%= range_display(field_name) %></span>
-          <%= link_to search_action_url(remove_range_param(field_name).except(:controller, :action)), :class=>"remove", :title => t('blacklight.range_limit.remove_limit') do %>
-            <span class="remove-icon">✖</span>
-            <span class="sr-only">[<%= t('blacklight.range_limit.remove_limit') %>]</span>
-          <% end %>
-        </span>
-        <span class="selected facet-count"><%= number_with_delimiter(@response.total) %></span>
-      </li>
-    </ul>
-
-  <% end %>
-
-  <!-- no results profile if missing is selected -->
-  <% unless selected_missing_for_range_limit?(field_name) %>
-    <!-- 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 stats_for_field?(field_name) %>
-          <!-- No stats information found for field  in search response -->
-        <% end %>
-
-        <% if (min = range_results_endpoint(field_name, :min)) &&
-              (max = range_results_endpoint(field_name, :max)) %>
-
-          <% if field_config[:segments] != false %>
-            <div class="distribution subsection <%= 'chart_js' unless field_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 solr_range_queries_to_a(field_name).length > 0 %>
-
-                 <%= render(:partial => "blacklight_range_limit/range_segments", :locals => {:solr_field => field_name}) %>
-
-              <% else %>
-                <%= link_to(t('blacklight.range_limit.view_distribution'), range_limit_url(range_field: field_name, range_start: min, range_end: max), :class => "load_distribution") %>
-              <% end %>
-            </div>
-          <% end %>
-          <p class="range subsection <%= "slider_js" unless field_config[:slider_js] == false %>">
-            <%= t('blacklight.range_limit.results_range_html', min: range_results_endpoint(field_name, :min), max: range_results_endpoint(field_name, :max)) %>
-          </p>
-        <% end %>
-    </div>
-
-    <%= form_tag search_action_path, :method => :get, class: [BlacklightRangeLimit.classes[:form], "range_#{field_name} d-flex justify-content-center"].join(' ') do %>
-      <%= render_hash_as_hidden_fields(search_state.params_for_search.except(:page)) %>
-      <div class="input-group input-group-sm mb-3 flex-nowrap range-limit-input-group">
-        <%= render_range_input(field_name, :begin, input_label_range_begin, maxlength) %>
-        <%= render_range_input(field_name, :end, input_label_range_end, maxlength) %>
-        <div class="input-group-append">
-          <%= submit_tag t('blacklight.range_limit.submit_limit'), class: BlacklightRangeLimit.classes[:submit] %>
-        </div>
-      </div>
-    <% end %>
-
-    <%= link_to t('blacklight.range_limit.view_larger', field_name: label),
-        range_limit_panel_url(id: field_name, range_start: 0, range_end: 2019),
-        class: 'view_larger mt-1',
-        data: { blacklight_modal: 'trigger' } %>
-
-    <% unless request.xhr? %>
-      <% if (stats = stats_for_field(field_name)) && stats["missing"] > 0 %>
-        <ul class="missing list-unstyled facet-values subsection">
-          <li>
-            <span class="facet-label">
-              <%= link_to t('blacklight.range_limit.missing'), search_action_url(add_range_missing(field_name).except(:controller, :action)) %>
-            </span>
-            <%# note important there be no whitespace inside facet-count to avoid
-                bug in some versions of Blacklight (including 7.1.0.alpha) %>
-            <span class="facet-count"><%= number_with_delimiter(stats["missing"]) %></span>
-          </li>
-        </ul>
-      <% end %>
-    <% end %>
-  <% end %>
-</div>

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

@@ -1,10 +0,0 @@
-<div class="modal-header">
-  <h1 class="modal-title"><%= facet_field_label(@facet.key) %></h1>
-  <button type="button" class="blacklight-modal-close close" data-dismiss="modal" aria-label="<%= t('blacklight.modal.close') %>">
-    <span aria-hidden="true">&times;</span>
-  </button>
-</div>
-
-<div class="modal-body">
-  <%= render :partial => "blacklight_range_limit/range_limit_panel", :locals => {field_name: @facet.key} %>
-</div>

data/lib/blacklight_range_limit/view_helper_override.rb

@@ -1,100 +0,0 @@
-  # Meant to be applied on top of Blacklight helpers, to over-ride
-  # Will add rendering of limit itself in sidebar, and of constraings
-  # display.
-  module BlacklightRangeLimit::ViewHelperOverride
-
-
-
-    def facet_partial_name(display_facet)
-      config = range_config(display_facet.name)
-      return config[:partial] || 'blacklight_range_limit/range_limit_panel' if config && should_show_limit(display_facet.name)
-      super
-    end
-
-    def query_has_constraints?(my_params = params)
-      super || has_range_limit_parameters?(my_params)
-    end
-
-    # 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)
-      # add a constraint for ranges?
-      range_params(my_params).keys.each_with_object(super) do |solr_field, content|
-        content << render_constraint_element(
-          facet_field_label(solr_field),
-          range_display(solr_field, my_params),
-          escape_value: false,
-          remove: search_action_path(remove_range_param(solr_field, my_params))
-        )
-      end
-    end
-
-    def render_search_to_s_filters(my_params)
-      # add a constraint for ranges?
-      range_params(my_params).keys.each_with_object(super) do |solr_field, content|
-        content << render_search_to_s_element(
-          facet_field_label(solr_field),
-          range_display(solr_field, my_params),
-          escape_value: false
-        )
-      end
-    end
-
-    def remove_range_param(solr_field, my_params = params)
-      my_params = Blacklight::SearchState.new(my_params, blacklight_config).to_h
-      if ( my_params["range"] )
-        my_params = my_params.dup
-        my_params["range"] = my_params["range"].dup
-        my_params["range"].delete(solr_field)
-      end
-      return my_params
-    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)
-      return [] unless @response["facet_counts"] && @response["facet_counts"]["facet_queries"]
-
-      array = []
-
-      @response["facet_counts"]["facet_queries"].each_pair do |query, count|
-        if query =~ /#{solr_field}: *\[ *(-?\d+) *TO *(-?\d+) *\]/
-          array << {:from => $1, :to => $2, :count => count}
-        end
-      end
-      array = array.sort_by {|hash| hash[:from].to_i }
-
-      return array
-    end
-
-    def range_config(solr_field)
-      BlacklightRangeLimit.range_config(blacklight_config, solr_field)
-    end
-
-    private
-
-    def range_params(my_params = params)
-      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'].presence,
-         range_options['begin'].presence,
-         range_options['end'].presence].any?
-      end
-    end
-  end

data/lib/generators/blacklight_range_limit/templates/search_history_controller.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-class SearchHistoryController < ApplicationController
-  include Blacklight::SearchHistory
-
-  helper BlacklightRangeLimit::ViewHelperOverride
-  helper RangeLimitHelper
-end

data/spec/lib/blacklight_range_limit/view_helper_override_helper_spec.rb

@@ -1,137 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe BlacklightRangeLimit::ViewHelperOverride, type: :helper do
-  describe '#render_constraints_filters' do
-    before do
-      allow(helper).to receive_messages(
-        facet_field_label: 'Date Range',
-        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
-
-    it 'does not return any content when the range parameter invalid' do
-      params = ActionController::Parameters.new(range: 'garbage')
-
-      expect(helper.render_constraints_filters(params)).to eq ''
-    end
-
-    it 'renders a constraint for the given data in the range param' do
-      params = ActionController::Parameters.new(
-        range: { range_field: { 'begin' => 1900, 'end' => 2000 } }
-      )
-      constraints = helper.render_constraints_filters(params)
-
-      expect(constraints).to have_css(
-        '.constraint .filter-name', text: 'Date Range'
-      )
-      expect(constraints).to have_css(
-        '.constraint .filter-value', text: '1900 to 2000'
-      )
-    end
-  end
-
-  describe 'render_search_to_s_filters' do
-    before do
-      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
-      params = ActionController::Parameters.new(range: 'garbage')
-
-      expect(helper.render_search_to_s_filters(params)).to eq ''
-    end
-
-    it 'renders a constraint for the given data in the range param' do
-      params = ActionController::Parameters.new(
-        range: { range_field: { 'begin' => 1900, 'end' => 2000 } }
-      )
-      constraints = helper.render_search_to_s_filters(params)
-
-      expect(constraints).to have_css(
-        '.constraint .filter-name', text: 'Date Range:'
-      )
-      expect(constraints).to have_css(
-        '.constraint .filter-values', text: '1900 to 2000'
-      )
-    end
-  end
-
-  describe '#range_params' do
-    it 'handles no range input' do
-      expect(
-        helper.send(:range_params, ActionController::Parameters.new(q: 'blah'))
-      ).to eq({})
-    end
-
-    it 'handles non-compliant range input' do
-      expect(
-        helper.send(:range_params, ActionController::Parameters.new(range: 'blah'))
-      ).to eq({})
-
-      expect(
-        helper.send(:range_params, ActionController::Parameters.new(range: ['blah']))
-      ).to eq({})
-
-      expect(
-        helper.send(:range_params, ActionController::Parameters.new(range: { 'wrong' => 'data' }))
-      ).to eq({})
-
-      expect(
-        helper.send(
-          :range_params,
-          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
-      expect(
-        helper.send(
-          :range_params,
-          ActionController::Parameters.new(range: { field_name: { 'missing' => true } })
-        ).permit!.to_h
-      ).to eq({ 'field_name' => { 'missing' => true } })
-
-      expect(
-        helper.send(
-          :range_params,
-          ActionController::Parameters.new(range: { field_name: { 'begin' => '1800', 'end' => '1900' } })
-        ).permit!.to_h
-      ).to eq({ 'field_name' => { 'begin' => '1800', 'end' => '1900' } })
-
-      expect(
-        helper.send(
-          :range_params,
-          ActionController::Parameters.new(
-            range: {
-              field_name: { 'begin' => '1800', 'end' => '1900' },
-              field_name2: { 'begin' => '1800', 'end' => '1900' }
-            }
-          )
-        ).permit!.to_h
-      ).to eq(
-        {
-          'field_name' => { 'begin' => '1800', 'end' => '1900' },
-          'field_name2' => { 'begin' => '1800', 'end' => '1900' }
-        }
-      )
-    end
-  end
-end