blacklight-hierarchy 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 697c2ee0eb4208a5849d3d4ac87a06649926581ff2bceebf4286251a6502cb31
-  data.tar.gz: 243b6ae6bcb6a0f9f25335e251fee8d45b2ee0020337f4187728c0a20b2fd643
+  metadata.gz: '05896464df5a8c0e3b6d878771afb366c74eb679a9acbb3cc91b48fc1ec21a67'
+  data.tar.gz: f6544b27132185268d971b49e634b6f83a4ad8986e78014f65cc121d233a7fb1
 SHA512:
-  metadata.gz: 575224c30019574f9cd0396676e1dc402a3c5d4743538bcb04cd0eeefbb97106102f35deb02f342063d6d8c51da5f719a86d5bcb290998124ea0e0d81423599b
-  data.tar.gz: 1ca5e9d6fe3a6aae330a2bb4d6815e40b8923df00e9559a7dcb6ac3145837f02df1d844bd0bed964d7c245a78bf33c3e0dee4cc3ee905ec9f313b7e35a8e86b0
+  metadata.gz: e239a2df4fac7caf7a0cce0917fd361c04c1a29ba904246275a592769ede706425cf8a4573c2734829f402f43555c76d3b8b393b6a645350644e4aabe60d5659
+  data.tar.gz: c727ad909a5820f59e4484ef3cf517ade8e48ec61646b943d79f1a52991e2eff290a73bc2033f00bfe62d418ddedc1ebb138fa9f246fc8713857cca1aff34028

data/.github/workflows/ruby.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.6, 2.7]
+        ruby: [2.7, 3.0]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
@@ -35,7 +35,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.5, 2.6]
+        ruby: [2.7, 2.6]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby

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,6 +20,11 @@ module Blacklight
         subset.empty? ? 'h-leaf' : 'h-node'
       end
 
+      def controller_name
+        subset.empty? ? '' : 'b-h-collapsible'
+      end
+
+
       def item
         tree[:_]
       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,17 +1,25 @@
 # frozen_string_literal: true
 
 module Blacklight::HierarchyHelper
-  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'
     )
 
     # For Rails 5.2 support all options must be symbols.  See https://github.com/rails/rails/issues/39813
-    tag.button(:'aria-expanded' => 'false',
-                :'aria-label' => aria_label,
-                :'aria-describedby' => described_by,
-                class: 'toggle-handle') do
+    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

data/lib/blacklight/hierarchy/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Hierarchy
-    VERSION = '5.0.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,6 +1,6 @@
 {
   "name": "blacklight-hierarchy",
-  "version": "4.1.0",
+  "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": [

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

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 RSpec.describe Blacklight::HierarchyHelper do
   describe '#facet_toggle_button' do
-    subject { helper.facet_toggle_button(field_name, described_by) }
+    subject { helper.facet_toggle_button(field_name, described_by, 'randomtext123') }
     let(:field_name) { 'exploded_tag_ssim' }
     let(:described_by) { 'unique-string' }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-hierarchy
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Michael B. Klein
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -159,6 +159,7 @@ files:
 - 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