blacklight-hierarchy 4.2.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c27766d9e3478e114c0c47f20a6d9e117aabd392bdfbe95ced2a1280b80759ee
-  data.tar.gz: 4661be605018474298c69155324327607665e0e0ddd6561ea960a40ffd91cb51
+  metadata.gz: 5ea0e001e3224b9a048ae7926b34382fe198ca6e8fdf76c5162db41b9517275c
+  data.tar.gz: adc4876dacf6a6d1a7aace70b94b673b1f309923e3cf18c26ab580fb706273c1
 SHA512:
-  metadata.gz: 4e6ff1475cfdb98679c258e5174ddea50be40324b384b8cf29c6affbc04f66ad2c2fd4ef89368c0979731e878a0af3e31fe889125b9f7786d823e3aeef9d29a6
-  data.tar.gz: 79b0d2b32e5b861f8931d47b73dfb4bf37662954cb6274c34dbb2d9ff6086ac54c88069e5b9c3155e93da8e36572155d7f2fe53c00c7ab91bd69cec59784a702
+  metadata.gz: e807065e18dade227ffacd4569aa6a63219319d75c5cfc30619fd9f831f482d612eeb8ec86518d966aed33a78dc3eacad9a777ed2410eb8a0e6506db6b848ab5
+  data.tar.gz: b14642993987dce24ce443efb75c1dccba8e2fea2118c5860f2b938a4c55b1ac3dc1a6292102c677e105b203589a470322166dfe0439544ba49573fba9d0334e

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).
 

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

@@ -1,5 +1,6 @@
-<li class="<%= li_class %>" role="treeitem">
-  <%= helpers.facet_toggle_button(field_name, id) if subset.any? %>
+<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? %>
@@ -9,7 +10,7 @@
   <% end %>
 
   <% unless subset.empty? %>
-    <ul role=\"group\">
+    <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 %>

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

@@ -20,13 +20,18 @@ module Blacklight
         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.has_facet?(config, value: item.qvalue)
+        helpers.search_state.filter(config).include?(item.qvalue)
       end
     end
   end

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

@@ -1,8 +1,8 @@
 <%= render(@layout.new(facet_field: @facet_field)) do |component| %>
-  <% component.with(:label) do %>
+  <% component.label do %>
     <%= @facet_field.label %>
   <% end %>
-  <% component.with(:body) do %>
+  <% component.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) %>

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

@@ -8,8 +8,11 @@ module Blacklight
       # @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 = facet_tree
+          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
@@ -42,31 +45,7 @@ module Blacklight
         @prefix ||= field_name.gsub("#{DELIMETER}#{field_name.split(/#{DELIMETER}/).last}", '')
       end
 
-
       delegate :blacklight_config, to: :helpers
-
-      def facet_tree
-        @facet_tree ||= {}
-        return @facet_tree[prefix] unless @facet_tree[prefix].nil?
-        return @facet_tree[prefix] unless blacklight_config.facet_display[:hierarchy] && blacklight_config.facet_display[:hierarchy][prefix]
-        @facet_tree[prefix] = {}
-        facet_config = blacklight_config.facet_display[:hierarchy][prefix]
-        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 = [prefix, key].compact.join('_')
-          @facet_tree[prefix][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 = @facet_tree[prefix][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[prefix]
-      end
     end
   end
 end

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

@@ -1,4 +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="glyphicon glyphicon-remove"></span><span class="sr-only">[remove]</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/helpers/blacklight/hierarchy_helper.rb

@@ -1,206 +1,36 @@
-require 'deprecation'
+# frozen_string_literal: true
 
 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 qfacet_selected?(field_name, item)
-            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
-  deprecation_deprecate :render_facet_hierarchy_item
-
-  def qfacet_selected?(field_name, item)
-    config = facet_configuration_for_field(field_name)
-    search_state.has_facet?(config, value: facet_value_for_facet_item(item.qvalue))
-  end
-  private :qfacet_selected?
-
-  # @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
-  deprecation_deprecate :render_hierarchy
-
-  def render_qfacet_value(facet_solr_field, item, options = {})
-    id = options.delete(:id)
-    facet_config = facet_configuration_for_field(facet_solr_field)
-    path_for_facet = facet_item_presenter(facet_config, item.qvalue, facet_solr_field).href
-    (link_to_unless(options[:suppress_link], item.value, path_for_facet, id: id, class: 'facet_select') + ' ' + render_facet_count(item.hits)).html_safe
-  end
-  deprecation_deprecate :render_qfacet_value
-
-  # 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
-  deprecation_deprecate :render_selected_qfacet_value
-
-  # @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
-  deprecation_deprecate :facet_tree
-
-  def facet_toggle_button(field_name, described_by)
+  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
-  deprecation_deprecate :is_hierarchical?
-
-  def facet_order(prefix)
-    param_name = "#{prefix}_facet_order".to_sym
-    params[param_name] || blacklight_config.facet_display[:hierarchy][prefix].first
-  end
-  deprecation_deprecate :facet_order
-
   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
-  deprecation_deprecate :hide_facet?
-
-
-  # 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
-  deprecation_deprecate :rotate_facet_value
-
-  # 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
-  deprecation_deprecate :rotate_facet_params
-
-  # 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
-  deprecation_deprecate :render_facet_rotate
 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/blacklight-hierarchy.gemspec

@@ -18,8 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  # A version of blacklight with view_component is required
-  s.add_dependency 'blacklight', '~> 7.9'
+  s.add_dependency 'blacklight', '~> 7.18'
   s.add_dependency 'rails', '>= 5.1', '< 7'
   s.add_dependency 'deprecation'
 

data/lib/blacklight/hierarchy/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Hierarchy
-    VERSION = '4.2.0'.freeze
+    VERSION = '5.2.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.2.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')

data/spec/helpers/hierarchy_helper_spec.rb

@@ -1,12 +1,11 @@
 require 'spec_helper'
 
-describe Blacklight::HierarchyHelper do
-  describe '#render_hierarchy' do
-    it 'should remove the _suffix from the field name' do
-      expect(Deprecation).to receive(:warn)
-      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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-hierarchy
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Michael B. Klein
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.9'
+        version: '7.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.9'
+        version: '7.18'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -150,15 +150,16 @@ 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
@@ -170,6 +171,7 @@ files:
 - 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
@@ -207,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.7.1
-
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true