blacklight-hierarchy 4.1.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ce7107c42527b0098cfbf8fc89cf72513f60c37ffd747e2dc72d7562cbc0cb0
-  data.tar.gz: 0471c190b5e16bba1db3b5b5b4e5234f7f52f2eaf4604924aa6cc219f0b60126
+  metadata.gz: '05896464df5a8c0e3b6d878771afb366c74eb679a9acbb3cc91b48fc1ec21a67'
+  data.tar.gz: f6544b27132185268d971b49e634b6f83a4ad8986e78014f65cc121d233a7fb1
 SHA512:
-  metadata.gz: 8f17e9a79fdb08d46e858b447d75624ea349960ee6f80a7c130bf58098c37844aeac5684ec8b0afa338c0d314ee864192d022ea98c2088f599718cf5ac506797
-  data.tar.gz: a389b8951e4e93338f54a9b624a3f0f4cae267cd8a5f1de5296a3d2e13ac06bfc636808695b1fd8d2aa8e8e64faadc6680c888185cff03eb2bf1e1fd0b3b73af
+  metadata.gz: e239a2df4fac7caf7a0cce0917fd361c04c1a29ba904246275a592769ede706425cf8a4573c2734829f402f43555c76d3b8b393b6a645350644e4aabe60d5659
+  data.tar.gz: c727ad909a5820f59e4484ef3cf517ade8e48ec61646b943d79f1a52991e2eff290a73bc2033f00bfe62d418ddedc1ebb138fa9f246fc8713857cca1aff34028

data/.github/workflows/ruby.yml

@@ -0,0 +1,53 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.7, 3.0]
+    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
+    - name: Run tests
+      run: bundle exec rake ci
+      env:
+        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+  test_rails5:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.7, 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: 5.2.4.2
+    - name: Run tests
+      run: bundle exec rake ci
+      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'

data/README.md

@@ -1,5 +1,5 @@
 # Blacklight::Hierarchy
-[![Build Status](https://travis-ci.org/sul-dlss/blacklight-hierarchy.svg?branch=master)](https://travis-ci.org/sul-dlss/blacklight-hierarchy) [![Coverage Status](https://coveralls.io/repos/sul-dlss/blacklight-hierarchy/badge.png)](https://coveralls.io/r/sul-dlss/blacklight-hierarchy) [![Gem Version](https://badge.fury.io/rb/blacklight-hierarchy.svg)](http://badge.fury.io/rb/blacklight-hierarchy)
+[![Build Status](https://github.com/sul-dlss/blacklight-hierarchy/workflows/CI/badge.svg)](https://github.com/sul-dlss/blacklight-hierarchy/actions?query=branch%3Amain) [![Coverage Status](https://coveralls.io/repos/sul-dlss/blacklight-hierarchy/badge.png)](https://coveralls.io/r/sul-dlss/blacklight-hierarchy) [![Gem Version](https://badge.fury.io/rb/blacklight-hierarchy.svg)](http://badge.fury.io/rb/blacklight-hierarchy)
 
 This plugin provides hierarchical facets for [Blacklight](https://github.com/projectblacklight/blacklight).
 
@@ -46,18 +46,18 @@ You can skip as many levels as you'd like, as long as the "leaf" values are inde
 
 **Note**: If you use Solr's built-in [PathHierarchyTokenizerFactory](http://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters#solr.PathHierarchyTokenizerFactory), you can index the entire depth by supplying only the leaf nodes.  Otherwise you are expected to build the permutations yourself before loading.
 
-In your Blacklight controller configuration (usually `CatalogController`), tell Blacklight to render the facet using the hierarchy partial.
+In your Blacklight controller configuration (usually `CatalogController`), tell Blacklight to render the facet using the hierarchy component.
 
 
 ```ruby
-config.add_facet_field 'queue_wps',   :label => 'Queue Status', :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'queue_wsp',   :label => 'Queue Status', :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'queue_swp',   :label => 'Queue Status', :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'callnum_top', :label => 'Callnumber',   :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'foo_trunk',   :label => 'Foo L1',       :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'foo_branch',  :label => 'Foo L2',       :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'foo_leaves',  :label => 'Foo L3',       :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'tag_facet',   :label => 'Tag',          :partial => 'blacklight/hierarchy/facet_hierarchy'
+config.add_facet_field 'queue_wps',   label: 'Queue Status', component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'queue_wsp',   label: 'Queue Status', component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'queue_swp',   label: 'Queue Status', component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'callnum_top', label: 'Callnumber',   component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'foo_trunk',   label: 'Foo L1',       component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'foo_branch',  label: 'Foo L2',       component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'foo_leaves',  label: 'Foo L3',       component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'tag_facet',   label: 'Tag',          component: Blacklight::Hierarchy::FacetFieldListComponent
 ```
 
 Add your hierarchy-specific options to the controller configuration:
@@ -106,6 +106,10 @@ en:
       toggle_aria_label: Toggle call number section
 ```
 
+### Javascript
+
+The javascript in this project requires jquery, but it's up to you to provide it in a way that best works for your project.  You may consider the jquery-rails gem or if you use webpacker, you could use the jquery npm package.
+
 ## Caveats
 
 This code was ripped out of another project, and is still quite immature as a standalone project. Every effort has been made to make it as plug-and-play as possible, but it may stomp on Blacklight in unintended ways (e.g., ways that made sense in context of its former host app, but which aren't compatible with generic Blacklight). Proceed with caution, and report issues.

data/app/assets/javascripts/blacklight/hierarchy/blacklight_hierarchy_controller.js

@@ -0,0 +1,12 @@
+import { Controller } from 'stimulus'
+
+export default class extends Controller {
+  static targets = [ "list" ]
+  connect() {
+    this.element.classList.add("twiddle")
+  }
+
+  toggle() {
+    this.element.classList.toggle("twiddle-open")
+  }
+}

data/app/assets/javascripts/blacklight/hierarchy/hierarchy.js

@@ -8,27 +8,23 @@ Blacklight.onLoad(function(){
         Blacklight.hierarchical_facet_expand_contract
      );
   }
-  Blacklight.do_hierarchical_facet_expand_contract_behavior.selector = 'li.h-node';
+  Blacklight.do_hierarchical_facet_expand_contract_behavior.selector = '[data-controller="b-h-collapsible"]';
+  Blacklight.do_hierarchical_facet_expand_contract_behavior.handle = '[data-action="click->b-h-collapsible#toggle"]';
+  Blacklight.do_hierarchical_facet_expand_contract_behavior.list = '[data-b-h-collapsible-target="list"]';
 
   Blacklight.hierarchical_facet_expand_contract = function() {
     var li = $(this);
+    li.addClass('twiddle');
 
-    $('ul', this).each(function() {
-      li.addClass('twiddle');
-      if($('span.selected', this).length == 0){
-        $(this).hide();
-      } else {
+    $(Blacklight.do_hierarchical_facet_expand_contract_behavior.list, this).each(function() {
+      if($('span.selected', this).length != 0){
         li.addClass('twiddle-open');
-        li.children('.toggle-handle').attr('aria-expanded', 'true');
       }
     });
 
     // attach the toggle behavior to the li tag
-    li.children('.toggle-handle').click(function(e){
-      // toggle the content
-      $(this).attr('aria-expanded', $(this).attr('aria-expanded') === 'true' ? 'false' : 'true');
-      $(this).parent('li').toggleClass('twiddle-open');
-      $(this).parent('li').children('ul').slideToggle();
+    li.children(Blacklight.do_hierarchical_facet_expand_contract_behavior.handle).click(function(e){
+      li.toggleClass('twiddle-open');
     });
   };
 })(jQuery);

data/app/components/blacklight/hierarchy/facet_field_component.html.erb

@@ -0,0 +1,19 @@
+<li class="<%= li_class %>" data-controller="<%= controller_name %>" role="treeitem">
+  <% ul_id = "b-h-#{SecureRandom.alphanumeric(10)}" %>
+  <%= helpers.facet_toggle_button(field_name, id, ul_id) if subset.any? %>
+  <% if item.nil? %>
+     <%= key %>
+  <% elsif qfacet_selected? %>
+     <%= render Blacklight::Hierarchy::SelectedQfacetValueComponent.new(field_name: field_name, item: item) %>
+  <% else %>
+     <%= render Blacklight::Hierarchy::QfacetValueComponent.new(field_name: field_name, item: item, id: id) %>
+  <% end %>
+
+  <% unless subset.empty? %>
+    <ul id="<%= ul_id %>" class="collapse" data-b-h-collapsible-target="list" role=\"group\">
+    <% subset.keys.sort.each do |subkey| %>
+      <%= render self.class.new(field_name: field_name, tree: subset[subkey], key: subkey) %>
+    <% end %>
+    </ul>
+  <% end %>
+</li>

data/app/components/blacklight/hierarchy/facet_field_component.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Hierarchy
+    class FacetFieldComponent < ::ViewComponent::Base
+      def initialize(field_name:, tree:, key:)
+        @field_name = field_name
+        @tree = tree
+        @key = key
+        @id = SecureRandom.uuid
+      end
+
+      attr_reader :field_name, :tree, :key, :id
+
+      def subset
+        @subset ||= tree.reject { |k, _v| !k.is_a?(String) }
+      end
+
+      def li_class
+        subset.empty? ? 'h-leaf' : 'h-node'
+      end
+
+      def controller_name
+        subset.empty? ? '' : 'b-h-collapsible'
+      end
+
+
+      def item
+        tree[:_]
+      end
+
+      def qfacet_selected?
+        config = helpers.facet_configuration_for_field(field_name)
+        helpers.search_state.filter(config).include?(item.qvalue)
+      end
+    end
+  end
+end

data/app/components/blacklight/hierarchy/facet_field_list_component.html.erb

@@ -0,0 +1,12 @@
+<%= render(@layout.new(facet_field: @facet_field)) do |component| %>
+  <% component.with(:label) do %>
+    <%= @facet_field.label %>
+  <% end %>
+  <% component.with(:body) do %>
+    <ul class="facet-hierarchy" role="tree">
+      <% tree.keys.sort.collect do |key| %>
+        <%= render Blacklight::Hierarchy::FacetFieldComponent.new(field_name: @facet_field.facet_field.field, tree: tree[key], key: key) %>
+      <% end %>
+    </ul>
+  <% end %>
+<% end %>

data/app/components/blacklight/hierarchy/facet_field_list_component.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Hierarchy
+    class FacetFieldListComponent < Blacklight::FacetFieldListComponent
+      DELIMETER = '_'
+
+      # @param [Blacklight::Configuration::FacetField] as defined in controller with config.add_facet_field (and with :partial => 'blacklight/hierarchy/facet_hierarchy')
+      # @return [String] html for the facet tree
+      def tree
+
+        @tree ||= begin
+          facet_tree_for_prefix = FacetTree.build(prefix: prefix,
+                                                  facet_display: blacklight_config.facet_display,
+                                                  facet_field: @facet_field)
+          facet_tree_for_prefix ? facet_tree_for_prefix[field_name] : nil
+        end
+      end
+
+      def field_name
+        @facet_field.facet_field.field
+      end
+
+      # @return [String]  a key to access the rest of the hierarchy tree, as defined in controller config.facet_display[:hierarchy] declaration.
+      #  e.g. if you had this in controller:
+      #   config.facet_display = {
+      #     :hierarchy => {
+      #       'wf' => [['wps','wsp','swp'], ':'],
+      #       'callnum_top' => [['facet'], '/'],
+      #       'exploded_tag' => [['ssim'], ':']
+      #    }
+      #  }
+      # then possible hkey values would be 'wf', 'callnum_top', and 'exploded_tag'.
+      #
+      # the key in the :hierarchy hash is the "prefix" for the solr field with the hierarchy info.  the value
+      #  in the hash is a list, where the first element is a list of suffixes, and the second element is the delimiter
+      #  used to break up the sections of hierarchical data in the solr field being read.  when joined, the prefix and
+      #  suffix should form the field name.  so, for example, 'wf_wps', 'wf_wsp', 'wf_swp', 'callnum_top_facet', and
+      #  'exploded_tag_ssim' would be the solr fields with blacklight-hierarchy related configuration according to the
+      #  hash above.  ':' would be the delimiter used in all of those fields except for 'callnum_top_facet', which would
+      #  use '/'.  exploded_tag_ssim might contain values like ['Book', 'Book : Multi-Volume Work'], and callnum_top_facet
+      #  might contain values like ['LB', 'LB/2395', 'LB/2395/.C65', 'LB/2395/.C65/1991'].
+      # note: the suffixes (e.g. 'ssim' for 'exploded_tag' in the above example) can't have underscores, otherwise things break.
+      def prefix
+        @prefix ||= field_name.gsub("#{DELIMETER}#{field_name.split(/#{DELIMETER}/).last}", '')
+      end
+
+      delegate :blacklight_config, to: :helpers
+    end
+  end
+end

data/app/components/blacklight/hierarchy/qfacet_value_component.html.erb

@@ -0,0 +1 @@
+<%= link_to_unless suppress_link, item.value, path_for_facet, id: id, class: 'facet_select' %> <%= render_facet_count %>

data/app/components/blacklight/hierarchy/qfacet_value_component.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Hierarchy
+    class QfacetValueComponent < ::ViewComponent::Base
+      def initialize(field_name:, item:, id: nil, suppress_link: false)
+        @field_name = field_name
+        @item = item
+        @id = id
+        @suppress_link = suppress_link
+      end
+
+      attr_reader :field_name, :item, :id, :suppress_link
+
+      def path_for_facet
+        facet_config = helpers.facet_configuration_for_field(field_name)
+        Blacklight::FacetItemPresenter.new(item.qvalue, facet_config, helpers, field_name).href
+      end
+
+      def render_facet_count
+        classes = "facet-count"
+        content_tag("span", t('blacklight.search.facets.count', number: number_with_delimiter(item.hits)), class: classes)
+      end
+    end
+  end
+end

data/app/components/blacklight/hierarchy/selected_qfacet_value_component.html.erb

@@ -0,0 +1,5 @@
+<span class="selected"><%= render Blacklight::Hierarchy::QfacetValueComponent.new(field_name: field_name, item: item, suppress_link: true) %></span>
+<%= link_to(remove_href, class: 'remove') do %>
+  <span class="remove-icon" aria-hidden="true">✖</span>
+  <span class="sr-only"><%= t('blacklight.search.facets.selected.remove') %></span>
+<% end %>

data/app/components/blacklight/hierarchy/selected_qfacet_value_component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Hierarchy
+    # Standard display of a SELECTED facet value, no link, special span with class, and 'remove' button.
+    class SelectedQfacetValueComponent < ::ViewComponent::Base
+      def initialize(field_name:, item:)
+        @field_name = field_name
+        @item = item
+      end
+
+      attr_reader :field_name, :item
+
+      def remove_href
+        helpers.search_action_path(helpers.search_state.remove_facet_params(field_name, item.qvalue))
+      end
+    end
+  end
+end

data/app/helpers/blacklight/hierarchy_helper.rb

@@ -1,186 +1,36 @@
-module Blacklight::HierarchyHelper
-  # Putting bare HTML strings in a helper sucks. But in this case, with a
-  # lot of recursive tree-walking going on, it's an order of magnitude faster
-  # than either render(:partial) or content_tag
-  def render_facet_hierarchy_item(field_name, data, key)
-    item = data[:_]
-    subset = data.reject { |k, _v| !k.is_a?(String) }
-
-    li_class = subset.empty? ? 'h-leaf' : 'h-node'
-    id = SecureRandom.uuid
-    ul = ''
-    li = ''
-    li << facet_toggle_button(field_name, id) if subset.any?
-    li << if item.nil?
-            key
-          elsif facet_in_params?(field_name, item.qvalue)
-            render_selected_qfacet_value(field_name, item)
-          else
-            render_qfacet_value(field_name, item, id: id)
-          end
-
-    unless subset.empty?
-      subul = subset.keys.sort.collect do |subkey|
-        render_facet_hierarchy_item(field_name, subset[subkey], subkey)
-      end.join('')
-      ul = "<ul role=\"group\">#{subul}</ul>".html_safe
-    end
-
-    %(<li class="#{li_class}" role="treeitem">#{li.html_safe}#{ul.html_safe}</li>).html_safe
-  end
-
-  # @param [Blacklight::Configuration::FacetField] as defined in controller with config.add_facet_field (and with :partial => 'blacklight/hierarchy/facet_hierarchy')
-  # @return [String] html for the facet tree
-  def render_hierarchy(bl_facet_field, delim = '_')
-    field_name = bl_facet_field.field
-    prefix = field_name.gsub("#{delim}#{field_name.split(/#{delim}/).last}", '')
-    facet_tree_for_prefix = facet_tree(prefix)
-    tree = facet_tree_for_prefix ? facet_tree_for_prefix[field_name] : nil
-
-    return '' unless tree
-    tree.keys.sort.collect do |key|
-      render_facet_hierarchy_item(field_name, tree[key], key)
-    end.join("\n").html_safe
-  end
-
-  def render_qfacet_value(facet_solr_field, item, options = {})
-    id = options.delete(:id)
-    (link_to_unless(options[:suppress_link], item.value, path_for_facet(facet_solr_field, item.qvalue), id: id, class: 'facet_select') + ' ' + render_facet_count(item.hits)).html_safe
-  end
-
-  # Standard display of a SELECTED facet value, no link, special span with class, and 'remove' button.
-  def render_selected_qfacet_value(facet_solr_field, item)
-    remove_href = search_action_path(search_state.remove_facet_params(facet_solr_field, item.qvalue))
-    content_tag(:span, render_qfacet_value(facet_solr_field, item, suppress_link: true), class: 'selected') + ' ' +
-      link_to(content_tag(:span, '', class: 'glyphicon glyphicon-remove') +
-              content_tag(:span, '[remove]', class: 'sr-only'),
-              remove_href,
-              class: 'remove'
-             )
-  end
-
-  HierarchicalFacetItem = Struct.new :qvalue, :value, :hits
-
-  # @param [String] hkey - a key to access the rest of the hierarchy tree, as defined in controller config.facet_display[:hierarchy] declaration.
-  #  e.g. if you had this in controller:
-  #   config.facet_display = {
-  #     :hierarchy => {
-  #       'wf' => [['wps','wsp','swp'], ':'],
-  #       'callnum_top' => [['facet'], '/'],
-  #       'exploded_tag' => [['ssim'], ':']
-  #    }
-  #  }
-  # then possible hkey values would be 'wf', 'callnum_top', and 'exploded_tag'.
-  #
-  # the key in the :hierarchy hash is the "prefix" for the solr field with the hierarchy info.  the value
-  #  in the hash is a list, where the first element is a list of suffixes, and the second element is the delimiter
-  #  used to break up the sections of hierarchical data in the solr field being read.  when joined, the prefix and
-  #  suffix should form the field name.  so, for example, 'wf_wps', 'wf_wsp', 'wf_swp', 'callnum_top_facet', and
-  #  'exploded_tag_ssim' would be the solr fields with blacklight-hierarchy related configuration according to the
-  #  hash above.  ':' would be the delimiter used in all of those fields except for 'callnum_top_facet', which would
-  #  use '/'.  exploded_tag_ssim might contain values like ['Book', 'Book : Multi-Volume Work'], and callnum_top_facet
-  #  might contain values like ['LB', 'LB/2395', 'LB/2395/.C65', 'LB/2395/.C65/1991'].
-  # note: the suffixes (e.g. 'ssim' for 'exploded_tag' in the above example) can't have underscores, otherwise things break.
-  def facet_tree(hkey)
-    @facet_tree ||= {}
-    return @facet_tree[hkey] unless @facet_tree[hkey].nil?
-    return @facet_tree[hkey] unless blacklight_config.facet_display[:hierarchy] && blacklight_config.facet_display[:hierarchy][hkey]
-    @facet_tree[hkey] = {}
-    facet_config = blacklight_config.facet_display[:hierarchy][hkey]
-    split_regex = Regexp.new("\s*#{Regexp.escape(facet_config.length >= 2 ? facet_config[1] : ':')}\s*")
-    facet_config.first.each do |key|
-      # TODO: remove baked in notion of underscores being part of the blacklight facet field names
-      facet_field = [hkey, key].compact.join('_')
-      @facet_tree[hkey][facet_field] ||= {}
-      data = @response.aggregations[facet_field]
-      next if data.nil?
-      data.items.each do |facet_item|
-        path = facet_item.value.split(split_regex)
-        loc = @facet_tree[hkey][facet_field]
-        loc = loc[path.shift] ||= {} while path.length > 0
-        loc[:_] = HierarchicalFacetItem.new(facet_item.value, facet_item.value.split(split_regex).last, facet_item.hits)
-      end
-    end
-    @facet_tree[hkey]
-  end
+# frozen_string_literal: true
 
-  def facet_toggle_button(field_name, described_by)
+module Blacklight::HierarchyHelper
+  def facet_toggle_button(field_name, described_by, controls)
     aria_label = I18n.t(
       "blacklight.hierarchy.#{field_name}_toggle_aria_label",
       default: :'blacklight.hierarchy.toggle_aria_label'
     )
-    <<-HTML
-      <button
-        aria-expanded="false"
-        aria-label="#{aria_label}"
-        aria-describedby="#{described_by}"
-        class="toggle-handle"
-      >
-        <span aria-hidden="true" class="closed">#{Blacklight::Hierarchy::Engine.config.closed_icon}</span>
-        <span aria-hidden="true" class="opened">#{Blacklight::Hierarchy::Engine.config.opened_icon}</span>
-      </button>
-    HTML
+
+    # For Rails 5.2 support all options must be symbols.  See https://github.com/rails/rails/issues/39813
+    tag.button(aria: {
+                 expanded: 'false',
+                 label: aria_label,
+                 describedby: described_by,
+                 controls: controls
+               },
+               data: {
+                 action: 'click->b-h-collapsible#toggle',
+                 toggle: 'collapse',
+                 target: "##{controls}"
+               },
+               class: 'toggle-handle') do
+      tag.span(Blacklight::Hierarchy::Engine.config.closed_icon, :'aria-hidden' => 'true', class: 'closed') +
+      tag.span(Blacklight::Hierarchy::Engine.config.opened_icon, :'aria-hidden' => 'true', class: 'opened')
+    end
   end
 
   # --------------------------------------------------------------------------------------------------------------------------------
   # below are methods pertaining to the "rotate" notion where you may want to look at the same tree data organized another way
   # --------------------------------------------------------------------------------------------------------------------------------
 
-  # FIXME: remove baked in underscore separator in field name
-  def is_hierarchical?(field_name)
-    (prefix, order) = field_name.split(/_/, 2)
-    (list = blacklight_config.facet_display[:hierarchy][prefix]) && list.include?(order)
-  end
-
-  def facet_order(prefix)
-    param_name = "#{prefix}_facet_order".to_sym
-    params[param_name] || blacklight_config.facet_display[:hierarchy][prefix].first
-  end
-
   def facet_after(prefix, order)
     orders = blacklight_config.facet_display[:hierarchy][prefix]
     orders[orders.index(order) + 1] || orders.first
   end
-
-  # FIXME: remove baked in underscore separator in field name
-  def hide_facet?(field_name)
-    return false unless is_hierarchical?(field_name)
-    prefix = field_name.split(/_/).first
-    field_name != "#{prefix}_#{facet_order(prefix)}"
-  end
-
-  # FIXME: remove baked in colon separator
-  def rotate_facet_value(val, from, to)
-    components = Hash[from.split(//).zip(val.split(/:/))]
-    new_values = components.values_at(*to.split(//))
-    new_values.pop while new_values.last.nil?
-    return nil if new_values.include?(nil)
-    new_values.compact.join(':')
-  end
-
-  # FIXME: remove baked in underscore separator in field name
-  def rotate_facet_params(prefix, from, to, p = params.dup)
-    return p if from == to
-    from_field = "#{prefix}_#{from}"
-    to_field = "#{prefix}_#{to}"
-    p[:f] = (p[:f] || {}).dup # the command above is not deep in rails3, !@#$!@#$
-    p[:f][from_field] = (p[:f][from_field] || []).dup
-    p[:f][to_field] = (p[:f][to_field] || []).dup
-    p[:f][from_field].reject! { |v| p[:f][to_field] << rotate_facet_value(v, from, to); true }
-    p[:f].delete(from_field)
-    p[:f][to_field].compact!
-    p[:f].delete(to_field) if p[:f][to_field].empty?
-    p
-  end
-
-  # FIXME: remove baked in underscore separator in field name
-  def render_facet_rotate(field_name)
-    return unless is_hierarchical?(field_name)
-    (prefix, order) = field_name.split(/_/, 2)
-    return if blacklight_config.facet_display[:hierarchy][prefix].length < 2
-    new_order = facet_after(prefix, order)
-    new_params = rotate_facet_params(prefix, order, new_order)
-    new_params["#{prefix}_facet_order"] = new_order
-    link_to image_tag('icons/rotate.png', title: new_order.upcase).html_safe, new_params, class: 'no-underline'
-  end
 end

data/app/models/blacklight/hierarchy/facet_tree.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Hierarchy
+    class FacetTree
+      def self.build(prefix:, facet_display:, facet_field:)
+        new(prefix: prefix, facet_display: facet_display, facet_field: facet_field).build
+      end
+
+      def initialize(prefix:, facet_display:, facet_field:)
+        @prefix = prefix
+        @facet_config = facet_display.dig(:hierarchy, prefix)
+        @facet_field = facet_field
+      end
+
+      attr_reader :prefix, :facet_config, :data
+
+      def build
+        return unless facet_config
+        {}.tap do |tree|
+          facet_config.first.each do |key|
+            # TODO: remove baked in notion of underscores being part of the blacklight facet field names
+            facet_field = [prefix, key].compact.join('_')
+            tree[facet_field] ||= {}
+            data = @facet_field.display_facet
+            next if data.nil?
+            data.items.each do |facet_item|
+              path = facet_item.value.split(split_regex)
+              loc = tree[facet_field]
+              loc = loc[path.shift] ||= {} while path.length > 0
+              loc[:_] = HierarchicalFacetItem.new(facet_item.value, facet_item.value.split(split_regex).last, facet_item.hits)
+            end
+          end
+        end
+      end
+
+      def split_regex
+        @split_regex ||= Regexp.new("\s*#{Regexp.escape(facet_config.length >= 2 ? facet_config[1] : ':')}\s*")
+      end
+    end
+  end
+end

data/app/models/hierarchical_facet_item.rb

@@ -0,0 +1 @@
+HierarchicalFacetItem = Struct.new :qvalue, :value, :hits

data/app/views/blacklight/hierarchy/_facet_hierarchy.html.erb

@@ -1,3 +1,7 @@
+<% Deprecation.warn(self, "Calling the blacklight/hierarchy/facet_hierarchy partial is " \
+  "deprecated and will be removed in blacklight-hierarchy 5.0. Replace the facet config for '#{facet_field.key}':\n\n\t" \
+  ":partial => 'blacklight/hierarchy/facet_hierarchy'\n\nwith:\n\n\t" \
+  ":component => Blacklight::Hierarchy::FacetFieldListComponent\n\n") %>
 <ul class="facet-hierarchy" role="tree">
   <%= render_hierarchy(facet_field) %>
 </ul>

data/blacklight-hierarchy.gemspec

@@ -18,10 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  # Most likely available for even earlier versions of Blacklight, but this is what I validated
-  s.add_dependency 'blacklight', '> 6.20', '< 8.0'
+  s.add_dependency 'blacklight', '~> 7.13'
   s.add_dependency 'rails', '>= 5.1', '< 7'
-  s.add_dependency 'jquery-rails'
+  s.add_dependency 'deprecation'
 
   s.add_development_dependency 'rsolr'
   s.add_development_dependency 'rspec-rails'

data/lib/blacklight/hierarchy/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Hierarchy
-    VERSION = '4.1.0'.freeze
+    VERSION = '5.1.0'.freeze
   end
 end

data/lib/generators/blacklight_hierarchy/templates/blacklight_hierarchy.js

@@ -1 +1,9 @@
-//= require blacklight/hierarchy/hierarchy
+//= require blacklight/hierarchy/hierarchy
+
+// If you use Stimulus in your application you can remove the line above and require
+// blacklight_hierarchy_controller instead:
+//
+// import BlacklightHierarchyController from 'blacklight-hierarchy/app/assets/javascripts/blacklight/hierarchy/blacklight_hierarchy_controller'
+// import { Application } from 'stimulus'
+// const application = Application.start()
+// application.register("b-h-collapsible", BlacklightHierarchyController)

data/package.json

@@ -1,7 +1,7 @@
 {
   "name": "blacklight-hierarchy",
-  "version": "4.1.0",
-  "description": "[![Build Status](https://travis-ci.org/sul-dlss/blacklight-hierarchy.png?branch=master)](https://travis-ci.org/sul-dlss/blacklight-hierarchy)",
+  "version": "5.1.0",
+  "description": "[![Build Status](https://github.com/sul-dlss/blacklight-hierarchy/workflows/CI/badge.svg)](https://github.com/sul-dlss/blacklight-hierarchy/actions?query=branch%3Amain)",
   "main": "app/assets/javascripts/blacklight/hierarchy/hierarchy.js",
   "files": [
     "app/assets/javascripts/blacklight/hierarchy/*.js",

data/spec/features/basic_spec.rb

@@ -31,8 +31,8 @@ shared_examples 'catalog' do
 
     it 'should display the hierarchy' do
       visit '/'
-      expect(page).to have_selector('li.h-node', text: 'a')
-      expect(page).to have_selector('li.h-node > ul > li.h-node', text: 'b')
+      expect(page).to have_selector('li.h-node[data-controller="b-h-collapsible"]', text: 'a')
+      expect(page).to have_selector('li.h-node > ul > li.h-node[data-controller="b-h-collapsible"]', text: 'b')
       expect(page).to have_selector('li.h-node li.h-leaf', text: 'c 30')
       expect(page).to have_selector('li.h-node li.h-leaf', text: 'd 25')
       expect(page).to have_selector('li.h-node > ul > li.h-node', text: 'c')
@@ -99,9 +99,8 @@ describe 'config_1' do
     before do
       CatalogController.blacklight_config = Blacklight::Configuration.new
       CatalogController.configure_blacklight do |config|
-        #   config.add_facet_field 'rotate_tag_facet', :label => 'Tag',     :partial => 'blacklight/hierarchy/facet_hierarchy'
-        config.add_facet_field 'tag_facet',    label: 'Tag',         partial: 'blacklight/hierarchy/facet_hierarchy'
-        config.add_facet_field 'my_top_facet', label: 'Slash Delim', partial: 'blacklight/hierarchy/facet_hierarchy'
+        config.add_facet_field 'tag_facet',    label: 'Tag',         component: Blacklight::Hierarchy::FacetFieldListComponent
+        config.add_facet_field 'my_top_facet', label: 'Slash Delim', component: Blacklight::Hierarchy::FacetFieldListComponent
         config.facet_display = {
           hierarchy: {
             #       'rotate' => [['tag'  ], ':'], # this would work if config.add_facet_field was called rotate_tag_facet, instead of tag_facet, I think.
@@ -119,8 +118,8 @@ describe 'config_2' do
     before do
       CatalogController.blacklight_config = Blacklight::Configuration.new
       CatalogController.configure_blacklight do |config|
-        config.add_facet_field 'tag_facet',    label: 'Tag',         partial: 'blacklight/hierarchy/facet_hierarchy'
-        config.add_facet_field 'my_top_facet', label: 'Slash Delim', partial: 'blacklight/hierarchy/facet_hierarchy'
+        config.add_facet_field 'tag_facet',    label: 'Tag',         component: Blacklight::Hierarchy::FacetFieldListComponent
+        config.add_facet_field 'my_top_facet', label: 'Slash Delim', component: Blacklight::Hierarchy::FacetFieldListComponent
         config.facet_display = {
           hierarchy: {
             'tag'    => [['facet']], # rely on default delim

data/spec/helpers/hierarchy_helper_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
-describe Blacklight::HierarchyHelper do
-  describe '#render_hierarchy' do
-    it 'should remove the _suffix from the field name' do
-      field = OpenStruct.new(field: 'the_field_name_facet')
-      expect(helper).to receive(:facet_tree).with('the_field_name').and_return({})
-      helper.render_hierarchy(field)
-    end
+RSpec.describe Blacklight::HierarchyHelper do
+  describe '#facet_toggle_button' do
+    subject { helper.facet_toggle_button(field_name, described_by, 'randomtext123') }
+    let(:field_name) { 'exploded_tag_ssim' }
+    let(:described_by) { 'unique-string' }
+
+    it { is_expected.to be_html_safe }
   end
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-hierarchy
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Michael B. Klein
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2021-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '6.20'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '7.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '6.20'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '7.13'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -51,7 +45,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7'
 - !ruby/object:Gem::Dependency
-  name: jquery-rails
+  name: deprecation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -156,18 +150,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- app/assets/javascripts/blacklight/hierarchy/blacklight_hierarchy_controller.js
 - app/assets/javascripts/blacklight/hierarchy/hierarchy.js
 - app/assets/stylesheets/blacklight/hierarchy/hierarchy.scss
+- app/components/blacklight/hierarchy/facet_field_component.html.erb
+- app/components/blacklight/hierarchy/facet_field_component.rb
+- app/components/blacklight/hierarchy/facet_field_list_component.html.erb
+- app/components/blacklight/hierarchy/facet_field_list_component.rb
+- app/components/blacklight/hierarchy/qfacet_value_component.html.erb
+- app/components/blacklight/hierarchy/qfacet_value_component.rb
+- app/components/blacklight/hierarchy/selected_qfacet_value_component.html.erb
+- app/components/blacklight/hierarchy/selected_qfacet_value_component.rb
 - app/helpers/blacklight/hierarchy_helper.rb
+- app/models/blacklight/hierarchy/facet_tree.rb
+- app/models/hierarchical_facet_item.rb
 - app/views/blacklight/hierarchy/_facet_hierarchy.html.erb
 - blacklight-hierarchy.gemspec
 - config/locales/blacklight-hierarchy.ar.yml
@@ -204,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Hierarchical Facets for Blacklight

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 2.5.1
-
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true