Start migrating constraints towards using view components

Author: cbeer

app/components/blacklight/constraint_layout_component.html.erb

@@ -0,0 +1,21 @@
+<span class="btn-group applied-filter constraint <%= @classes %>">
+  <span class="constraint-value btn btn-outline-secondary btn-disabled">
+    <% if @label.present? %>
+      <span class="filter-name"><%= @label %></span>
+    <% end %>
+    <% if @value.present? %>
+      <%= content_tag :span, @value, class: 'filter-value', title: strip_tags(@value) %>
+    <% end %>
+  </span>
+  <% if @remove_path.present? %>
+    <%= link_to(@remove_path, class: 'btn btn-outline-secondary remove') do %>
+      <span class="remove-icon">✖</span>
+      <%= if @label.blank?
+            t('blacklight.search.filters.remove.value', value: @value)
+          else
+            t('blacklight.search.filters.remove.label_value', label: @label, value: @value)
+          end
+      %>
+    <% end %>
+  <% end %>
+</span>

app/components/blacklight/constraint_layout_component.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Blacklight
+  class ConstraintLayoutComponent < ::ViewComponent::Base
+    def initialize(value:, label: nil, remove_path: nil, classes: nil)
+      @value = value
+      @label = label
+      @remove_path = remove_path
+      @classes = Array(classes).join(' ')
+    end
+
+    def render?
+      @value.present?
+    end
+  end
+end

app/helpers/blacklight/render_constraints_helper_behavior.rb

@@ -6,39 +6,57 @@
 # Includes methods for rendering contraints graphically on the
 # search results page (render_constraints(_*))
 module Blacklight::RenderConstraintsHelperBehavior
+  extend Deprecation
+  self.deprecation_horizon = 'blacklight 8.0'
+
   ##
   # Check if the query has any constraints defined (a query, facet, etc)
   #
   # @param [Hash] localized_params query parameters
   # @return [Boolean]
-  def query_has_constraints?(localized_params = params)
-    !(localized_params[:q].blank? && localized_params[:f].blank?)
+  def query_has_constraints?(params_or_search_state = search_state)
+    search_state = convert_to_search_state(params_or_search_state)
+    search_state.has_constraints?
   end
+  deprecation_deprecate :query_has_constraints?
 
   ##
   # Render the actual constraints, not including header or footer
   # info.
   #
   # @param [Hash] localized_params query parameters
   # @return [String]
-  def render_constraints(localized_params = params)
-    render_constraints_query(localized_params) + render_constraints_filters(localized_params)
+  def render_constraints(localized_params = params, local_search_state = search_state)
+    params_or_search_state = if localized_params != params
+                               localized_params
+                             else
+                               local_search_state
+                             end
+
+    Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
+      render_constraints_query(params_or_search_state) + render_constraints_filters(params_or_search_state)
+    end
   end
 
   ##
   # Render the query constraints
   #
   # @param [ActionController::Parameters] localized_params query parameters
   # @return [String]
-  def render_constraints_query(localized_params = params)
+  def render_constraints_query(params_or_search_state = search_state)
+    search_state = convert_to_search_state(params_or_search_state)
+
     # So simple don't need a view template, we can just do it here.
-    return "".html_safe if localized_params[:q].blank?
+    return "".html_safe if search_state.query_param.blank?
 
-    render_constraint_element(constraint_query_label(localized_params),
-                              localized_params[:q],
-                              classes: ["query"],
-                              remove: remove_constraint_url(localized_params))
+    Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
+      render_constraint_element(constraint_query_label(search_state),
+                                search_state.query_param,
+                                classes: ["query"],
+                                remove: remove_constraint_url(search_state))
+    end
   end
+  deprecation_deprecate :render_constraints_query
 
   ##
   # Provide a url for removing a particular constraint. This can be overriden
@@ -47,54 +65,53 @@ def render_constraints_query(localized_params = params)
   #
   # @param [ActionController::Parameters] localized_params query parameters
   # @return [String]
-  def remove_constraint_url(localized_params)
-    scope = localized_params.delete(:route_set) || self
-
-    unless localized_params.is_a? ActionController::Parameters
-      localized_params = ActionController::Parameters.new(localized_params)
-    end
+  def remove_constraint_url(params_or_search_state = search_state)
+    search_state = convert_to_search_state(params_or_search_state)
 
-    options = localized_params.merge(q: nil, action: 'index')
-    options.permit!
-    scope.url_for(options)
+    search_action_path(search_state.remove_query_params)
   end
+  deprecation_deprecate :remove_constraint_url
 
   ##
   # Render the facet constraints
   # @param [Hash] localized_params query parameters
   # @return [String]
-  def render_constraints_filters(localized_params = params)
-    return "".html_safe unless localized_params[:f]
+  def render_constraints_filters(params_or_search_state = search_state)
+    search_state = convert_to_search_state(params_or_search_state)
 
-    path = controller.search_state_class.new(localized_params, blacklight_config, controller)
-    content = []
-    localized_params[:f].each_pair do |facet, values|
-      content << render_filter_element(facet, values, path)
-    end
+    return "".html_safe if search_state.filter_params.blank?
 
-    safe_join(content.flatten, "\n")
+    Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
+      safe_join(search_state.filter_params.each_pair.map do |facet, values|
+        render_filter_element(facet, values, search_state)
+      end, "\n")
+    end
   end
+  deprecation_deprecate :render_constraints_filters
 
   ##
   # Render a single facet's constraint
   # @param [String] facet field
   # @param [Array<String>] values selected facet values
   # @param [Blacklight::SearchState] path query parameters (unused)
   # @return [String]
-  def render_filter_element(facet, values, path)
+  def render_filter_element(facet, values, search_state)
     facet_config = facet_configuration_for_field(facet)
 
     safe_join(Array(values).map do |val|
       next if val.blank? # skip empty string
 
       presenter = facet_item_presenter(facet_config, val, facet)
 
-      render_constraint_element(facet_field_label(facet_config.key),
-                                presenter.label,
-                                remove: presenter.remove_href(path),
-                                classes: ["filter", "filter-" + facet.parameterize])
+      Deprecation.silence(Blacklight::RenderConstraintsHelperBehavior) do
+        render_constraint_element(facet_field_label(facet_config.key),
+                                  presenter.label,
+                                  remove: presenter.remove_href(search_state),
+                                  classes: ["filter", "filter-" + facet.parameterize])
+      end
     end, "\n")
   end
+  deprecation_deprecate :render_filter_element
 
   # Render a label/value constraint on the screen. Can be called
   # by plugins and such to get application-defined rendering.
@@ -113,4 +130,16 @@ def render_filter_element(facet, values, path)
   def render_constraint_element(label, value, options = {})
     render(partial: "catalog/constraints_element", locals: { label: label, value: value, options: options })
   end
+  deprecation_deprecate :render_constraint_element
+
+  private
+
+  def convert_to_search_state(params_or_search_state)
+    if params_or_search_state.is_a? Blacklight::SearchState
+      params_or_search_state
+    else
+      # deprecated
+      controller.search_state_class.new(params_or_search_state, blacklight_config, controller)
+    end
+  end
 end

app/views/catalog/_constraints.html.erb

@@ -4,6 +4,6 @@
 
     <%= render 'start_over' %>
     <span class="constraints-label sr-only"><%= t('blacklight.search.filters.title') %></span>
-    <%= render_constraints(params) %>
+    <%= render_constraints(controller.params != params ? params : search_state) %>
   </div>
 <% end %>

app/views/catalog/_constraints_element.html.erb

@@ -7,27 +7,8 @@
     options ||= {}
 %>
 
-<span class="btn-group applied-filter constraint <%= options[:classes].join(" ") if options[:classes] %>">
-  <span class="constraint-value btn btn-outline-secondary btn-disabled">
-    <% unless label.blank? %>
-      <span class="filter-name"><%= label %></span>
-    <% end %>
-    <% unless value.blank? %>
-      <%= content_tag :span, value, class: 'filter-value', title: strip_tags(value) %>
-    <% end %>
-  </span>
-  <% unless options[:remove].blank? %>
-    <% accessible_remove_label = content_tag :span, class: 'sr-only' do
-        if label.blank?
-          t('blacklight.search.filters.remove.value', value: value)
-        else
-          t('blacklight.search.filters.remove.label_value', label: label, value: value)
-        end
-      end
-    %>
-
-    <%= link_to(content_tag(:span, '✖', class: 'remove-icon') + accessible_remove_label,
-			options[:remove], class: 'btn btn-outline-secondary remove'
-		) %>
-  <%- end -%>
-</span>
+<%= render(Blacklight::ConstraintLayoutComponent.new(
+      classes: options[:classes],
+      label: label,
+      value: value,
+      remove_path: options[:remove])) %>

lib/blacklight/search_state.rb

@@ -37,6 +37,22 @@ def to_hash
     end
     alias to_h to_hash
 
+    # Tiny shim to make it easier to migrate raw params access to using this class
+    delegate :[], to: :params
+    deprecation_deprecate :[]
+
+    def has_constraints?
+      !(query_param.blank? && filter_params.blank?)
+    end
+
+    def query_param
+      params[:q]
+    end
+
+    def filter_params
+      params[:f] || {}
+    end
+
     def reset(params = nil)
       self.class.new(params || ActionController::Parameters.new, blacklight_config, controller)
     end
@@ -57,6 +73,12 @@ def url_for_document(doc, options = {})
       end
     end
 
+    def remove_query_params
+      p = reset_search_params
+      p.delete(:q)
+      p
+    end
+
     # adds the value and/or field to params[:f]
     # Does NOT remove request keys and otherwise ensure that the hash
     # is suitable for a redirect. See

spec/views/catalog/_constraints_element.html.erb_spec.rb renamed to spec/components/blacklight/constraint_layout_component_spec.rb

@@ -1,24 +1,34 @@
 # frozen_string_literal: true
 
-RSpec.describe "catalog/_constraints_element.html.erb" do
+require 'spec_helper'
+
+RSpec.describe Blacklight::ConstraintLayoutComponent, type: :component do
+  subject(:render) do
+    render_inline(described_class.new(params))
+  end
+
+  let(:rendered) do
+    Capybara::Node::Simple.new(render)
+  end
+
   describe "for simple display" do
-    before do
-      render partial: "catalog/constraints_element", locals: { label: "my label", value: "my value" }
+    let(:params) do
+      { label: "my label", value: "my value" }
     end
 
     it "renders label and value" do
       expect(rendered).to have_selector("span.applied-filter.constraint") do |s|
         expect(s).to have_css("span.constraint-value")
         expect(s).not_to have_css("a.constraint-value")
-        expect(s).to have_selector "span.filter-name", content: "my label"
-        expect(s).to have_selector "span.filter-value", content: "my value"
+        expect(s).to have_selector "span.filter-name", text: "my label"
+        expect(s).to have_selector "span.filter-value", text: "my value"
       end
     end
   end
 
   describe "with remove link" do
-    before do
-      render partial: "catalog/constraints_element", locals: { label: "my label", value: "my value", options: { remove: "http://remove" } }
+    let(:params) do
+      { label: "my label", value: "my value", remove_path: "http://remove" }
     end
 
     it "includes remove link" do
@@ -34,8 +44,8 @@
   end
 
   describe "with custom classes" do
-    before do
-      render partial: "catalog/constraints_element", locals: { label: "my label", value: "my value", options: { classes: %w[class1 class2] } }
+    let(:params) do
+      { label: "my label", value: "my value", classes: %w[class1 class2] }
     end
 
     it "includes them" do
@@ -44,8 +54,8 @@
   end
 
   describe "with no escaping" do
-    before do
-      render(partial: "catalog/constraints_element", locals: { label: "<span class='custom_label'>my label</span>".html_safe, value: "<span class='custom_value'>my value</span>".html_safe })
+    let(:params) do
+      { label: "<span class='custom_label'>my label</span>".html_safe, value: "<span class='custom_value'>my value</span>".html_safe }
     end
 
     it "does not escape key and value" do

spec/helpers/blacklight/render_constraints_helper_behavior_spec.rb

@@ -13,6 +13,9 @@
     allow(helper).to receive(:search_action_path) do |*args|
       search_catalog_path *args
     end
+
+    allow(helper).to receive(:blacklight_config).and_return(config)
+    allow(controller).to receive(:search_state_class).and_return(Blacklight::SearchState)
   end
 
   describe '#render_constraints_query' do
@@ -22,24 +25,7 @@
     let(:params) { ActionController::Parameters.new(q: 'foobar', f: { type: 'journal' }) }
 
     it "has a link relative to the current url" do
-      expect(subject).to have_selector "a[href='/?f%5Btype%5D=journal']"
-    end
-
-    context 'with an ordinary hash' do
-      let(:params) { { q: 'foobar', f: { type: 'journal' } } }
-
-      it "has a link relative to the current url" do
-        expect(subject).to have_selector "a[href='/?f%5Btype%5D=journal']"
-      end
-    end
-
-    context "with a route_set" do
-      let(:params) { ActionController::Parameters.new(q: 'foobar', f: { type: 'journal' }, route_set: my_engine) }
-
-      it "accepts an optional route set" do
-        expect(my_engine).to receive(:url_for).and_return('/?f%5Btype%5D=journal')
-        expect(subject).to have_selector "a[href='/?f%5Btype%5D=journal']"
-      end
+      expect(subject).to have_link 'Remove constraint', href: '/catalog?f%5Btype%5D=journal'
     end
   end
 
@@ -73,11 +59,6 @@
 
     let(:params) { ActionController::Parameters.new f: { 'type' => [''] } }
 
-    before do
-      allow(helper).to receive(:blacklight_config).and_return(config)
-      allow(controller).to receive(:search_state_class).and_return(Blacklight::SearchState)
-    end
-
     it "renders nothing for empty facet limit param" do
       expect(subject).to be_blank
     end