blacklight-hierarchy 6.4.0 → 6.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26cd69f479cdeed50d1d81525856bb1aaa30f4b308865b4560ec27623d331a6c
-  data.tar.gz: 1f8fadf9e59ac9dbcf4713bfa86084cb0ef19616bd2c4d1d0c5d400bbc34cdb0
+  metadata.gz: 653bcfc6322d881f68b3e497d01f83bae1e50a180734511849d5f3e34abc1cde
+  data.tar.gz: eca2782a3f9e8e1573ac4d8ce551bef7c8342e7bc9531d4a75a18da558c180df
 SHA512:
-  metadata.gz: 2f7525164912a4e448138ee84f6e911ada7430d140ccce9525ab665bff85fed658e4552cb22d6c4a98c5f8a72aa18bf14e829482c75d1988143911ecc8b954dc
-  data.tar.gz: 9a799edaa82ababdd09a754d7d737d18005ff24c356a76d5ddbe9e6632935d9e7d8091522d683043f46c960ad18f56ae84ab15968c2e3e2c6e22091e5cf5d805
+  metadata.gz: 761b1a427e8ceb7e8839898322469c8d54418308b8d193511570312c7427e6f6e7d15ef4b8afdf78d2bd8b023fc520d4e4204521f7b58988d0a654792d6930c5
+  data.tar.gz: a8b501673443997fa510da6a5cc68b3b62832fa514bd39396498df3b203a45fab11c5bccbbf5df7db6c510ddf1eb6a31cc1c49907a8e2219e58b6e79e4e45ab8

data/.github/workflows/ruby.yml

@@ -18,18 +18,20 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ["3.2", "3.3"]
-        rails_version: ["7.1.3.4", "7.2.0"]
-        blacklight_version: ["7.38.0"]
+        ruby: ["3.3", "3.4"]
+        rails_version: ["7.2.2.1", "8.0.2"]
+        blacklight_version: ["8.8.4"]
         include:
-          - ruby: "3.1"
-            rails_version: "6.1.7.8"
           - ruby: "3.2"
-            rails_version: "7.0.8.4"
+            rails_version: "7.1.3.4"
           - ruby: "3.3"
             rails_version: "7.1.3.4"
-            name: "Blacklight 8.3"
-            blacklight_version: "8.3.0"
+            name: "Blacklight 7"
+            blacklight_version: "7.38.0"
+          - ruby: "3.4"
+            rails_version: "8.0.2"
+            name: "Blacklight 9 beta"
+            blacklight_version: "9.0.0.beta2"
     env:
       BLACKLIGHT_VERSION: ${{ matrix.blacklight_version }}
     steps:
@@ -39,8 +41,6 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler: latest
-      - name: Change permissions
-        run: "chmod -f -R o-w /opt/hostedtoolcache/Ruby/3.2.5/x64/lib/ruby/gems/3.2.0/gems | :"
       - name: Install dependencies
         run: bundle install
         env:
@@ -49,4 +49,4 @@ jobs:
         run: bundle exec rake ci
         env:
           RAILS_VERSION: ${{ matrix.rails_version }}
-          ENGINE_CART_RAILS_OPTIONS: "--skip-git --skip-listen --skip-spring --skip-keeps --skip-coffee --skip-test"
+          ENGINE_CART_RAILS_OPTIONS: "--skip-git --skip-listen --skip-spring --skip-keeps --skip-kamal --skip-solid --skip-coffee --skip-test -a propshaft --css=bootstrap"

data/README.md

@@ -124,10 +124,6 @@ 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.
@@ -146,3 +142,10 @@ $ npm publish
 - WRITE TESTS
 - Switch internal facet management from hack-y Hash to `Blacklight::Hierarchy::FacetGroup` class (already implemented, but not plumbed up)
 - Clarify when suffix is applied/required/etc.
+
+## Developing gem
+- Clone locally `git@github.com:sul-dlss/blacklight-hierarchy.git`
+- go into project directory `cd blacklight-hierarchy`
+- install dependencies `bundle install`
+- Create a test app to develop and test against `bundle exec rake engine_cart:generate
+- Run tests `bundle exec rspec`

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

@@ -1,31 +1,31 @@
-Blacklight.onLoad(function(){
-  Blacklight.do_hierarchical_facet_expand_contract_behavior();
-});
+Blacklight.onLoad(() => Blacklight.do_hierarchical_facet_expand_contract_behavior())
 
-(function($) {
-  Blacklight.do_hierarchical_facet_expand_contract_behavior = function() {
-    $( Blacklight.do_hierarchical_facet_expand_contract_behavior.selector ).each (
-        Blacklight.hierarchical_facet_expand_contract
-     );
+(() => {
+  Blacklight.do_hierarchical_facet_expand_contract_behavior = () => {
+    const elements = document.querySelectorAll(Blacklight.do_hierarchical_facet_expand_contract_behavior.selector)
+    elements.forEach(elem => Blacklight.hierarchical_facet_expand_contract(elem))
   }
-  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.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');
+  Blacklight.hierarchical_facet_expand_contract = (element) => {
+    element.classList.add('twiddle')
 
-    $(Blacklight.do_hierarchical_facet_expand_contract_behavior.list, this).each(function() {
-      if($('span.selected', this).length != 0){
-        li.addClass('twiddle-open');
-        li.children('.collapse').addClass('show');
+    const lists = element.querySelectorAll(Blacklight.do_hierarchical_facet_expand_contract_behavior.list)
+
+    lists.forEach((list) => {
+      if (list.querySelector('span.selected')) {
+        element.classList.add('twiddle-open')
+        const collapseElement = element.querySelector('.collapse')
+        if (collapseElement) {
+          collapseElement.classList.add('show')
+        }
       }
-    });
+    })
 
     // attach the toggle behavior to the li tag
-    li.children(Blacklight.do_hierarchical_facet_expand_contract_behavior.handle).click(function(e){
-      li.toggleClass('twiddle-open');
-    });
-  };
-})(jQuery);
+    const handle = element.querySelector(Blacklight.do_hierarchical_facet_expand_contract_behavior.handle)
+    handle?.addEventListener('click', () => element.classList.toggle('twiddle-open'))
+  }
+})()

data/app/assets/stylesheets/blacklight/hierarchy/hierarchy.scss

@@ -88,6 +88,7 @@ $text-muted: #777 !default;
     display: flex;
     flex-wrap: wrap;
     padding: 3px 0;
+    align-items: center;
   }
 
   .h-leaf {

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

@@ -2,7 +2,8 @@
 
 module Blacklight
   module Hierarchy
-    class FacetFieldListComponent < Blacklight::FacetFieldListComponent
+    superklass = defined?(Blacklight::Facets::ListComponent) ? Blacklight::Facets::ListComponent : Blacklight::FacetFieldListComponent
+    class FacetFieldListComponent < superklass
       DELIMITER = '_'
 
       # @param [Blacklight::Configuration::FacetField] as defined in controller with config.add_facet_field (and with :partial => 'blacklight/hierarchy/facet_hierarchy')

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

@@ -28,6 +28,8 @@ module Blacklight
               path = facet_item.value.split(split_regex)
               loc = tree[facet_field]
               loc = loc[path.shift] ||= {} while path.length > 0
+              raise(StandardError, "Expected non-empty array after splitting facet value. Original facet value: '#{facet_item.value}'") unless facet_item.value.split(split_regex).present?
+
               loc[:_] = HierarchicalFacetItem.new(facet_item.value, facet_item.value.split(split_regex).last, facet_item.hits)
             end
           end

data/blacklight-hierarchy.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_dependency 'blacklight', '>= 7.18', '< 9'
-  s.add_dependency 'rails', '>= 6.1', '< 7.3'
+  s.add_dependency 'rails', '>= 7.1', '< 9'
   s.add_dependency 'deprecation'
 
   s.add_development_dependency 'rsolr'

data/lib/blacklight/hierarchy/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Hierarchy
-    VERSION = '6.4.0'.freeze
+    VERSION = '6.6.0'.freeze
   end
 end

data/package.json

@@ -19,7 +19,6 @@
   "homepage": "https://github.com/sul-dlss/blacklight-hierarchy#readme",
   "devDependencies": {},
   "dependencies": {
-    "blacklight-frontend": ">=7.1 || 8.0",
-    "jquery": ">=3.0"
+    "blacklight-frontend": ">=7.1 <10.0.0"
   }
 }

data/spec/models/blacklight/hierarchy/facet_tree_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+RSpec.describe Blacklight::Hierarchy::FacetTree do
+  let(:prefix) { 'lc' }
+  let(:facet_display) { { hierarchy: { 'lc' => [['facet'], ':'] } } }
+  let(:display_facet) do
+    instance_double(Blacklight::Solr::Response::Facets::FacetField, name: 'lc_facet', items:, limit: 1001, sort: :index, offset: 0, prefix: nil)
+  end
+  let(:items) do
+    [
+      Blacklight::Solr::Response::Facets::FacetItem.new(label: ':', value: ':', hits: 100),
+      Blacklight::Solr::Response::Facets::FacetItem.new(label: 'A - General Works', value: 'A - General Works', hits: 5),
+      Blacklight::Solr::Response::Facets::FacetItem.new(label: 'A - General Works:AC - Collections Works', value: 'A - General Works:AC - Collections Works', hits: 4)
+    ]
+  end
+  let(:facet_field) do
+    instance_double(
+      Blacklight::FacetFieldPresenter,
+      display_facet:,
+      key: 'lc_facet',
+      label: 'Classification'
+    )
+  end
+  context 'with only valid items' do
+    let(:items) do
+      [
+        Blacklight::Solr::Response::Facets::FacetItem.new(label: 'A - General Works', value: 'A - General Works', hits: 5),
+        Blacklight::Solr::Response::Facets::FacetItem.new(label: 'A - General Works:AC - Collections Works', value: 'A - General Works:AC - Collections Works', hits: 4)
+      ]
+    end
+    it 'creates HierarchicalFacetItems' do
+      facet_tree = described_class.build(prefix:, facet_display:, facet_field:)
+      expect(facet_tree['lc_facet'].size).to eq(1)
+      expect(facet_tree['lc_facet'].keys.first).to eq('A - General Works')
+      expect(facet_tree['lc_facet']['A - General Works'].keys).to match_array([:_, 'AC - Collections Works'])
+      expect(facet_tree['lc_facet']['A - General Works'][:_]).to be_an_instance_of(HierarchicalFacetItem)
+    end
+  end
+
+
+  context 'with an invalid item' do
+    let(:items) do
+      [
+        Blacklight::Solr::Response::Facets::FacetItem.new(label: ':', value: ':', hits: 100),
+        Blacklight::Solr::Response::Facets::FacetItem.new(label: 'A - General Works', value: 'A - General Works', hits: 5),
+        Blacklight::Solr::Response::Facets::FacetItem.new(label: 'A - General Works:AC - Collections Works', value: 'A - General Works:AC - Collections Works', hits: 4)
+      ]
+    end
+
+    it 'raises an error' do
+      expect do
+        described_class.build(prefix:, facet_display:, facet_field:)
+      end.to raise_error(StandardError, "Expected non-empty array after splitting facet value. Original facet value: ':'")
+    end
+  end
+
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-hierarchy
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 6.6.0
 platform: ruby
 authors:
 - Michael B. Klein
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-13 00:00:00.000000000 Z
+date: 2025-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -36,20 +35,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.3'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.3'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -180,13 +179,13 @@ files:
 - package.json
 - spec/features/basic_spec.rb
 - spec/helpers/hierarchy_helper_spec.rb
+- spec/models/blacklight/hierarchy/facet_tree_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb
 homepage: https://github.com/sul-dlss/blacklight-hierarchy
 licenses: []
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -201,13 +200,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Hierarchical Facets for Blacklight
 test_files:
 - spec/features/basic_spec.rb
 - spec/helpers/hierarchy_helper_spec.rb
+- spec/models/blacklight/hierarchy/facet_tree_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/Gemfile.extra
 - spec/test_app_templates/lib/generators/test_app_generator.rb