blacklight-hierarchy 6.3.0 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b780d7ff6b7ed70d165c74da681cfb5f4d5212c2e7526d82fe7777f1b441776b
-  data.tar.gz: 426ae299d6fb8c506e9620d5896326616a1d821dc5b51ab2a2f44421a4a85347
+  metadata.gz: '0087020faf523fb8671351fa18c62b7d4f2bd09f254b24564a5a5d7aac9d5593'
+  data.tar.gz: 6ffb7349402eea8340d105cc747d95d0089c94a552700f5f1106cb6fb069173a
 SHA512:
-  metadata.gz: 938ae89b5c5de9a0ee0e6fd8dd2ad2dbf1f7b2443aef8dce648b20fc38ae2b5cba76d1bbf7fbf89bfc8d382a2ac029ff797ef08f08810d9ba6330d205559f828
-  data.tar.gz: 230b2979506a765f719efee9193724b1bc13515e67839cefd2c55db064257a1a0380fcb13aaa8ef5e3a0d09c7fad537aaaaf94850344d375a0b6775425b566eb
+  metadata.gz: 66d064cea30098266d2276b2806775a348250f8f1eb9bd27958018502589dbd6402bf18273ab1cd034e85a6747ef0fa74aee88e93d0d1bda71552284c656d192
+  data.tar.gz: 685bd238b6bec0f0c41d2b3bbd831111734c3b472f5949e8f27b90f13ffa3c387784d486b617b4cab07ba5b16e490bd6584c94b0c20e557f0c0479a5697107d3

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ruby.yml

@@ -9,40 +9,40 @@ name: CI
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ['3.0', '3.1', '3.2', '3.3']
-        rails_version: ['7.0.8']
-        blacklight_version: ['7.35.0']
+        ruby: ["3.3", "3.4"]
+        rails_version: ["7.2.2.1", "8.0.2"]
+        blacklight_version: ["8.8.4"]
         include:
-          - ruby: '2.7'
-            rails_version: '6.1.7.6'
-          - ruby: '3.2'
-            rails_version: '7.0.8'
-            name: 'Blacklight 8.1'
-            blacklight_version: '8.1.0'
+          - ruby: "3.2"
+            rails_version: "7.1.3.4"
+          - ruby: "3.3"
+            rails_version: "7.1.3.4"
+            name: "Blacklight 7"
+            blacklight_version: "7.38.0"
     env:
       BLACKLIGHT_VERSION: ${{ matrix.blacklight_version }}
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler: latest
-    - name: Install dependencies
-      run: bundle install
-      env:
-        RAILS_VERSION: ${{ matrix.rails_version }}
-    - name: Run tests
-      run: bundle exec rake ci
-      env:
-        RAILS_VERSION: ${{ matrix.rails_version }}
-        ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: latest
+      - name: Install dependencies
+        run: bundle install
+        env:
+          RAILS_VERSION: ${{ matrix.rails_version }}
+      - name: Run tests
+        run: bundle exec rake ci
+        env:
+          RAILS_VERSION: ${{ matrix.rails_version }}
+          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

@@ -146,3 +146,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/stylesheets/blacklight/hierarchy/hierarchy.scss

@@ -5,6 +5,10 @@ $b-h-opened-icon: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg
 
 $text-muted: #777 !default;
 
+:root {
+  --text-muted: #{$text-muted};
+}
+
 .facet-hierarchy {
   list-style-type: none;
   padding-left: 0;
@@ -49,11 +53,11 @@ $text-muted: #777 !default;
     }
   }
 
-  .twiddle>.toggle-handle {
+  .twiddle > .toggle-handle {
     background-color: transparent;
   }
 
-  .twiddle>.toggle-handle .toggle-icon {
+  .twiddle > .toggle-handle .toggle-icon {
     background-position: center;
     background-repeat: no-repeat;
     margin-top: 0.25rem;
@@ -61,25 +65,26 @@ $text-muted: #777 !default;
     min-width: 1.1rem;
   }
 
-  .twiddle>.toggle-handle .closed {
+  .twiddle > .toggle-handle .closed {
     background-image: escape-svg($b-h-closed-icon);
     display: inline-block;
   }
 
-  .twiddle>.toggle-handle .opened {
+  .twiddle > .toggle-handle .opened {
     display: none;
   }
 
-  .twiddle-open>.toggle-handle .closed {
+  .twiddle-open > .toggle-handle .closed {
     display: none;
   }
 
-  .twiddle-open>.toggle-handle .opened {
+  .twiddle-open > .toggle-handle .opened {
     background-image: escape-svg($b-h-opened-icon);
     display: inline-block;
   }
 
-  .h-node, .h-leaf {
+  .h-node,
+  .h-leaf {
     display: flex;
     flex-wrap: wrap;
     padding: 3px 0;
@@ -90,6 +95,6 @@ $text-muted: #777 !default;
   }
 
   .remove {
-    color: $text-muted;
+    color: var(--text-muted);
   }
 }

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.2'
+  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.3.0'.freeze
+    VERSION = '6.5.0'.freeze
   end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-hierarchy",
-  "version": "6.3.0",
+  "version": "6.4.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/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.3.0
+  version: 6.5.0
 platform: ruby
 authors:
 - Michael B. Klein
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-07 00:00:00.000000000 Z
+date: 2025-04-04 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.2'
+        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.2'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +140,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
@@ -179,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
@@ -200,13 +200,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
-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