blacklight-hierarchy 5.4.0 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f94c79bf8bbe805effc4bec475a954cf3dc958eb6e4bed158c72432ff21c63e
-  data.tar.gz: 2f2b214a450f319ba642b309646162833a8205b6081bd03b81e8fb254cf884a1
+  metadata.gz: 3415fa86520ce7eabf392993b65a8897e22af37496dc97c75d7ecde676e4a626
+  data.tar.gz: 5573391147e54e00060f28d0c2b5e4eb152f520640648e009a84e6e0a0302669
 SHA512:
-  metadata.gz: 66a38ecc4ffa59c73d6121110cf7fdb9dab24a56d5001e3b3e9a262595d3e5b47c9af52b8b7b1a38006b94d9794c2984e8a2610c698cc3432ddd6189fff0c816
-  data.tar.gz: 4b7274458273f4c9f86f3f93de9af1adbb15d5e03dc7519d12f9700763cd73ca27f7d2e5f17d18836ee537230da27dd9d7e4ac7ec785d048ca54e75a9b68a926
+  metadata.gz: 79df7ced8f2612552179ced087766cc682ef54c6adba01ebea38c31a404f43f7641c7937261f196377ec54253dac9651e96c980f0c435bcc58700b3983996785
+  data.tar.gz: 43eb2002ce53bf3d697c317ed9d0ace1a0c352cbe9a1cc8751779d4a2dada8b6bface7505c7fee18551118c9de45186fe4e887e3b9e9153b0f5417d5cf1d7fc0

data/.github/workflows/ruby.yml

@@ -18,24 +18,11 @@ jobs:
     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]
+        ruby: [2.7, '3.0']
+        rails_version: ['7.0.2.2', '6.1.4.6']
+        include:
+          - ruby: '2.7'
+            rails_version: '5.2.4.2'
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
@@ -45,9 +32,9 @@ jobs:
     - name: Install dependencies
       run: bundle install
       env:
-        RAILS_VERSION: 5.2.4.2
+        RAILS_VERSION: ${{ matrix.rails_version }}
     - name: Run tests
       run: bundle exec rake ci
       env:
-        RAILS_VERSION: 5.2.4.2
+        RAILS_VERSION: ${{ matrix.rails_version }}
         ENGINE_CART_RAILS_OPTIONS: '--skip-git --skip-listen --skip-spring --skip-keeps --skip-action-cable --skip-coffee --skip-test'

data/README.md

@@ -83,15 +83,17 @@ Facet fields should be added for each permutation of hierarchy key and term valu
 config.facet_display[:hierarchy].each{ |k,v| puts "#{k}_#{v}" }
 ```
 
-### Overriding the icon
-The icon is available in an engine configuration.  You can change them in an initializer in your app.
+### Changing the icons
+We store our closed/open icons as the SASS variables `$b-h-closed-icon` and `$b-h-closed-icon` in `hierarchy.scss`. By default we use SVGs provided by the [Font Awesome](https://github.com/FortAwesome/Font-Awesome) library. To change the icon, reassign these SASS variables with new SVG code.
 
-```ruby
-Blacklight::Hierarchy::Engine.config.closed_icon = '➕'
-Blacklight::Hierarchy::Engine.config.opened_icon = '➖'
+```scss
+  /* app/assets/stylesheets/blacklight/hierarchy/hierarchy.scss */
 
+  // plus sign
+  $b-h-closed-icon: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512'><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d='M200 344V280H136C122.7 280 112 269.3 112 256C112 242.7 122.7 232 136 232H200V168C200 154.7 210.7 144 224 144C237.3 144 248 154.7 248 168V232H312C325.3 232 336 242.7 336 256C336 269.3 325.3 280 312 280H248V344C248 357.3 237.3 368 224 368C210.7 368 200 357.3 200 344zM0 96C0 60.65 28.65 32 64 32H384C419.3 32 448 60.65 448 96V416C448 451.3 419.3 480 384 480H64C28.65 480 0 451.3 0 416V96zM48 96V416C48 424.8 55.16 432 64 432H384C392.8 432 400 424.8 400 416V96C400 87.16 392.8 80 384 80H64C55.16 80 48 87.16 48 96z'/></svg>") !default;
 ```
 
+
 ### Aria Labels
 For screen reader purposes we have used "Toggle subgroup" as the aria-label attribute of the button.  This is internationalized using rails' i18n feature.
 
@@ -114,9 +116,17 @@ The javascript in this project requires jquery, but it's up to you to provide it
 
 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.
 
+## Release
+
+In order to cut a new release you will need to publish simultaneously to NPM and RubyGems. Before you do that ensure that versions in `lib/blacklight/hierarchy/version.rb` and `package.json` match. Assuming you have the credentials to do it you can then:
+
+```
+$ gem push blacklight-hiearchy-0.1.0.gem
+$ npm publish
+```
+
 ## TODO
 
 - WRITE TESTS
 - Switch internal facet management from hack-y Hash to `Blacklight::Hierarchy::FacetGroup` class (already implemented, but not plumbed up)
-- Add configuration support for hierarchy delimiters other than `/\s*:\s*/` (baked into `Blacklight::Hierarchy::FacetGroup`, but again, requiring additional plumbing)
 - Clarify when suffix is applied/required/etc.

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

@@ -1,4 +1,4 @@
-import { Controller } from 'stimulus'
+import { Controller } from '@hotwired/stimulus'
 
 export default class extends Controller {
   static targets = [ "list" ]

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

@@ -1,3 +1,8 @@
+// plus sign
+$b-h-closed-icon: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512'><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d='M200 344V280H136C122.7 280 112 269.3 112 256C112 242.7 122.7 232 136 232H200V168C200 154.7 210.7 144 224 144C237.3 144 248 154.7 248 168V232H312C325.3 232 336 242.7 336 256C336 269.3 325.3 280 312 280H248V344C248 357.3 237.3 368 224 368C210.7 368 200 357.3 200 344zM0 96C0 60.65 28.65 32 64 32H384C419.3 32 448 60.65 448 96V416C448 451.3 419.3 480 384 480H64C28.65 480 0 451.3 0 416V96zM48 96V416C48 424.8 55.16 432 64 432H384C392.8 432 400 424.8 400 416V96C400 87.16 392.8 80 384 80H64C55.16 80 48 87.16 48 96z'/></svg>") !default;
+// minus sign
+$b-h-opened-icon: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512'><!--! Font Awesome Free 6.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d='M312 232C325.3 232 336 242.7 336 256C336 269.3 325.3 280 312 280H136C122.7 280 112 269.3 112 256C112 242.7 122.7 232 136 232H312zM0 96C0 60.65 28.65 32 64 32H384C419.3 32 448 60.65 448 96V416C448 451.3 419.3 480 384 480H64C28.65 480 0 451.3 0 416V96zM48 96V416C48 424.8 55.16 432 64 432H384C392.8 432 400 424.8 400 416V96C400 87.16 392.8 80 384 80H64C55.16 80 48 87.16 48 96z'/></svg>") !default;
+
 $text-muted: #777 !default;
 
 .facet-hierarchy {
@@ -34,8 +39,21 @@ $text-muted: #777 !default;
     }
   }
 
+  .twiddle>.toggle-handle {
+    background-color: transparent;
+  }
+
+  .twiddle>.toggle-handle .toggle-icon {
+    background-position: center;
+    background-repeat: no-repeat;
+    margin-top: 3px;
+    min-height: 20px;
+    min-width: 20px;
+  }
+
   .twiddle>.toggle-handle .closed {
-    display: inline;
+    background-image: escape-svg($b-h-closed-icon);
+    display: inline-block;
   }
 
   .twiddle>.toggle-handle .opened {
@@ -47,7 +65,8 @@ $text-muted: #777 !default;
   }
 
   .twiddle-open>.toggle-handle .opened {
-    display: inline;
+    background-image: escape-svg($b-h-opened-icon);
+    display: inline-block;
   }
 
   .h-leaf {

data/app/helpers/blacklight/hierarchy_helper.rb

@@ -22,8 +22,8 @@ module Blacklight::HierarchyHelper
                  bs_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')
+      tag.div( :'aria-hidden' => 'true', class: 'closed toggle-icon') +
+      tag.div( :'aria-hidden' => 'true', class: 'opened toggle-icon')
     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'
-  s.add_dependency 'rails', '>= 5.1', '< 7'
+  s.add_dependency 'rails', '>= 5.1', '< 7.1'
   s.add_dependency 'deprecation'
 
   s.add_development_dependency 'rsolr'

data/lib/blacklight/hierarchy/engine.rb

@@ -4,8 +4,6 @@ require 'rails'
 module Blacklight
   module Hierarchy
     class Engine < Rails::Engine
-      config.closed_icon = '⊞'
-      config.opened_icon = '⊟'
     end
   end
 end

data/lib/blacklight/hierarchy/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Hierarchy
-    VERSION = '5.4.0'.freeze
+    VERSION = '6.0.2'.freeze
   end
 end

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

@@ -4,6 +4,6 @@
 // blacklight_hierarchy_controller instead:
 //
 // import BlacklightHierarchyController from 'blacklight-hierarchy/app/assets/javascripts/blacklight/hierarchy/blacklight_hierarchy_controller'
-// import { Application } from 'stimulus'
+// import { Application } from '@hotwired/stimulus'
 // const application = Application.start()
 // application.register("b-h-collapsible", BlacklightHierarchyController)

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blacklight-hierarchy",
-  "version": "5.4.0",
+  "version": "6.0.2",
   "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": [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-hierarchy
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 6.0.2
 platform: ruby
 authors:
 - Michael B. Klein
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -33,7 +33,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -194,7 +194,7 @@ files:
 homepage: https://github.com/sul-dlss/blacklight-hierarchy
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -209,8 +209,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Hierarchical Facets for Blacklight
 test_files: