blacklight-hierarchy 3.0.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 301106611145298332bcd99baa46b594bb6e81cfbb91c67c144ad67ea82ffd4e
-  data.tar.gz: 3de7c9ffe277ba90bc6e3cfd1518f0dd1b91234399c5de0bfa37ed821da23cf3
+  metadata.gz: d7bacf2b0748d1154d75223505d631c5d38edd91a1bb72f514bd0809fb57cce8
+  data.tar.gz: 752c9cb4ba854489493681452862fcbb8dd332d0a1c505c849890f2ae0d85184
 SHA512:
-  metadata.gz: 49ed3184d67352e89bcf78badd554617c9a8618f2bf0ddb4260ec68d43e003604b05b5874a19d2bf5d2d5ac59f0c555f302a6630dd4ca9258ca81269936095ac
-  data.tar.gz: 33cff3c6d664380a251c8956f1de68be41c297067385babbd628b55e61a3e046adf8239a6b5ac04a6d33e861512a122c6601e8ffc9389e5b5e01b54b73e684de
+  metadata.gz: baf85f7b64a20872faa888b8513d82b469757325a0da6dfa597f653f8040059413cb42f8a9cd8ec41636529a335b4c7247173a16447d85ee1f81adee91ae6a07
+  data.tar.gz: 966af183ac26d3db3346018af9bff71e714d5dbc22af73664fc4bab5d8eba816cec2c564408c4dd050685c1cc14d52f13b09c14b50d98c3f5e4495174490cb29

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: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7]
+    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.5, 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/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.5.1
+  - 2.7.1
 
 env:
   global:

data/Gemfile

@@ -31,6 +31,11 @@ else
       gem 'rails', ENV['RAILS_VERSION']
     end
   end
+
+  case ENV['RAILS_VERSION']
+  when /^5.[12]/, /^6.0/
+    gem 'sass-rails', '~> 5.0'
+  end
 end
 # END ENGINE_CART BLOCK
 eval_gemfile File.expand_path("spec/test_app_templates/Gemfile.extra", File.dirname(__FILE__))

data/README.md

@@ -46,18 +46,18 @@ You can skip as many levels as you'd like, as long as the "leaf" values are inde
 
 **Note**: If you use Solr's built-in [PathHierarchyTokenizerFactory](http://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters#solr.PathHierarchyTokenizerFactory), you can index the entire depth by supplying only the leaf nodes.  Otherwise you are expected to build the permutations yourself before loading.
 
-In your Blacklight controller configuration (usually `CatalogController`), tell Blacklight to render the facet using the hierarchy partial.
+In your Blacklight controller configuration (usually `CatalogController`), tell Blacklight to render the facet using the hierarchy component.
 
 
 ```ruby
-config.add_facet_field 'queue_wps',   :label => 'Queue Status', :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'queue_wsp',   :label => 'Queue Status', :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'queue_swp',   :label => 'Queue Status', :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'callnum_top', :label => 'Callnumber',   :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'foo_trunk',   :label => 'Foo L1',       :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'foo_branch',  :label => 'Foo L2',       :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'foo_leaves',  :label => 'Foo L3',       :partial => 'blacklight/hierarchy/facet_hierarchy'
-config.add_facet_field 'tag_facet',   :label => 'Tag',          :partial => 'blacklight/hierarchy/facet_hierarchy'
+config.add_facet_field 'queue_wps',   label: 'Queue Status', component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'queue_wsp',   label: 'Queue Status', component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'queue_swp',   label: 'Queue Status', component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'callnum_top', label: 'Callnumber',   component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'foo_trunk',   label: 'Foo L1',       component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'foo_branch',  label: 'Foo L2',       component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'foo_leaves',  label: 'Foo L3',       component: Blacklight::Hierarchy::FacetFieldListComponent
+config.add_facet_field 'tag_facet',   label: 'Tag',          component: Blacklight::Hierarchy::FacetFieldListComponent
 ```
 
 Add your hierarchy-specific options to the controller configuration:
@@ -83,6 +83,33 @@ 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.
+
+```ruby
+Blacklight::Hierarchy::Engine.config.closed_icon = '➕'
+Blacklight::Hierarchy::Engine.config.opened_icon = '➖'
+
+```
+
+### 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.
+
+The field name is used in the key to allow for facet specific aria labels or defaults back to the generic key/"Toggle subgroup" text.
+
+```yml
+# config/locales/en.yml
+en:
+  blacklight:
+    hierarchy:
+      format_ssim_toggle_aria_label: Toggle format section
+      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.

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

@@ -12,23 +12,23 @@ Blacklight.onLoad(function(){
 
   Blacklight.hierarchical_facet_expand_contract = function() {
     var li = $(this);
-    
+
     $('ul', this).each(function() {
       li.addClass('twiddle');
       if($('span.selected', this).length == 0){
         $(this).hide();
       } else {
         li.addClass('twiddle-open');
+        li.children('.toggle-handle').attr('aria-expanded', 'true');
       }
     });
 
     // attach the toggle behavior to the li tag
-    li.click(function(e){
-      if (e.target == this) {
-        // toggle the content
-        $(this).toggleClass('twiddle-open');
-        $(this).children('ul').slideToggle();
-      }
+    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();
     });
   };
 })(jQuery);

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

@@ -1,23 +1,63 @@
-$text-muted: #777777 !default;
+$text-muted: #777 !default;
 
 .facet-hierarchy {
-  margin-left: -28px;
+  list-style-type: none;
+  padding-left: 0;
 
   ul {
-    margin-left: 0;
-    border-bottom: none;
+    border-bottom: 0;
+    list-style-type: none;
     padding-bottom: 0;
-    li {
-      margin-left: 8px;
+    padding-left: 1.3em;
+  }
+
+  .facet_select {
+    display: inline-block;
+    margin-bottom: 6px;
+    max-width: calc(100% - 5em);
+  }
+
+  .facet-count {
+    float: right;
+  }
+
+  .toggle-handle {
+    border: 0;
+    margin: 0;
+    min-width: 1em;
+    padding: 0;
+    vertical-align: top;
+
+    .closed,
+    .opened {
+      display: none;
     }
   }
+
+  .twiddle>.toggle-handle .closed {
+    display: inline;
+  }
+
+  .twiddle>.toggle-handle .opened {
+    display: none;
+  }
+
+  .twiddle-open>.toggle-handle .closed {
+    display: none;
+  }
+
+  .twiddle-open>.toggle-handle .opened {
+    display: inline;
+  }
+
+  .h-leaf {
+    padding-left: 1.3em;
+  }
+
   .h-node {
     cursor: pointer;
-    list-style-image: asset_data_url("collapsed.png")
-  }
-  .h-node.twiddle-open {
-    list-style-image: asset_data_url("expanded.png");
   }
+
   .remove {
     color: $text-muted;
   }

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

@@ -0,0 +1,18 @@
+<li class="<%= li_class %>" role="treeitem">
+  <%= helpers.facet_toggle_button(field_name, id) if subset.any? %>
+  <% if item.nil? %>
+     <%= key %>
+  <% elsif qfacet_selected? %>
+     <%= render Blacklight::Hierarchy::SelectedQfacetValueComponent.new(field_name: field_name, item: item) %>
+  <% else %>
+     <%= render Blacklight::Hierarchy::QfacetValueComponent.new(field_name: field_name, item: item, id: id) %>
+  <% end %>
+
+  <% unless subset.empty? %>
+    <ul role=\"group\">
+    <% subset.keys.sort.each do |subkey| %>
+      <%= render self.class.new(field_name: field_name, tree: subset[subkey], key: subkey) %>
+    <% end %>
+    </ul>
+  <% end %>
+</li>

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Hierarchy
+    class FacetFieldComponent < ::ViewComponent::Base
+      def initialize(field_name:, tree:, key:)
+        @field_name = field_name
+        @tree = tree
+        @key = key
+        @id = SecureRandom.uuid
+      end
+
+      attr_reader :field_name, :tree, :key, :id
+
+      def subset
+        @subset ||= tree.reject { |k, _v| !k.is_a?(String) }
+      end
+
+      def li_class
+        subset.empty? ? 'h-leaf' : 'h-node'
+      end
+
+      def item
+        tree[:_]
+      end
+
+      def qfacet_selected?
+        config = helpers.facet_configuration_for_field(field_name)
+        helpers.search_state.filter(config).include?(item.qvalue)
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Hierarchy
+    class FacetFieldListComponent < Blacklight::FacetFieldListComponent
+      DELIMETER = '_'
+
+      # @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 ? facet_tree_for_prefix[field_name] : nil
+        end
+      end
+
+      def field_name
+        @facet_field.facet_field.field
+      end
+
+      # @return [String]  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 prefix
+        @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/qfacet_value_component.html.erb

@@ -0,0 +1 @@
+<%= link_to_unless suppress_link, item.value, path_for_facet, id: id, class: 'facet_select' %> <%= render_facet_count %>

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Hierarchy
+    class QfacetValueComponent < ::ViewComponent::Base
+      def initialize(field_name:, item:, id: nil, suppress_link: false)
+        @field_name = field_name
+        @item = item
+        @id = id
+        @suppress_link = suppress_link
+      end
+
+      attr_reader :field_name, :item, :id, :suppress_link
+
+      def path_for_facet
+        facet_config = helpers.facet_configuration_for_field(field_name)
+        Blacklight::FacetItemPresenter.new(item.qvalue, facet_config, helpers, field_name).href
+      end
+
+      def render_facet_count
+        classes = "facet-count"
+        content_tag("span", t('blacklight.search.facets.count', number: number_with_delimiter(item.hits)), class: classes)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+<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>
+<% end %>

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Hierarchy
+    # Standard display of a SELECTED facet value, no link, special span with class, and 'remove' button.
+    class SelectedQfacetValueComponent < ::ViewComponent::Base
+      def initialize(field_name:, item:)
+        @field_name = field_name
+        @item = item
+      end
+
+      attr_reader :field_name, :item
+
+      def remove_href
+        helpers.search_action_path(helpers.search_state.remove_facet_params(field_name, item.qvalue))
+      end
+    end
+  end
+end

data/app/helpers/blacklight/hierarchy_helper.rb

@@ -1,4 +1,8 @@
+require 'deprecation'
+
 module Blacklight::HierarchyHelper
+  extend Deprecation
+
   # 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
@@ -6,25 +10,37 @@ module Blacklight::HierarchyHelper
     item = data[:_]
     subset = data.reject { |k, _v| !k.is_a?(String) }
 
-    li_class = subset.empty? ? 'h-leaf' : 'h-node'
-    ul = ''
-    li = if item.nil?
-           key
-         elsif facet_in_params?(field_name, item.qvalue)
-           render_selected_qfacet_value(field_name, item)
-         else
-           render_qfacet_value(field_name, item)
-         end
-
-    unless subset.empty?
-      subul = subset.keys.sort.collect do |subkey|
-        render_facet_hierarchy_item(field_name, subset[subkey], subkey)
-      end.join('')
-      ul = "<ul>#{subul}</ul>".html_safe
+    Deprecation.silence(Blacklight::HierarchyHelper) do
+      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
+  end
+  deprecation_deprecate :render_facet_hierarchy_item
 
-    %(<li class="#{li_class}">#{li.html_safe}#{ul.html_safe}</li>).html_safe
+  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
@@ -39,10 +55,17 @@ module Blacklight::HierarchyHelper
       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 = {})
-    (link_to_unless(options[:suppress_link], item.value, path_for_facet(facet_solr_field, item.qvalue), class: 'facet_select') + ' ' + render_facet_count(item.hits)).html_safe
+    Deprecation.silence(Blacklight::FacetsHelperBehavior) do
+      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
   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)
@@ -54,8 +77,7 @@ module Blacklight::HierarchyHelper
               class: 'remove'
              )
   end
-
-  HierarchicalFacetItem = Struct.new :qvalue, :value, :hits
+  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:
@@ -99,6 +121,23 @@ module Blacklight::HierarchyHelper
     end
     @facet_tree[hkey]
   end
+  deprecation_deprecate :facet_tree
+
+  def facet_toggle_button(field_name, described_by)
+    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.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
@@ -109,11 +148,13 @@ module Blacklight::HierarchyHelper
     (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]
@@ -126,6 +167,8 @@ module Blacklight::HierarchyHelper
     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)
@@ -135,6 +178,7 @@ module Blacklight::HierarchyHelper
     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)
@@ -150,6 +194,7 @@ module Blacklight::HierarchyHelper
     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)
@@ -161,4 +206,5 @@ module Blacklight::HierarchyHelper
     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/hierarchical_facet_item.rb

@@ -0,0 +1 @@
+HierarchicalFacetItem = Struct.new :qvalue, :value, :hits

data/app/views/blacklight/hierarchy/_facet_hierarchy.html.erb

@@ -1,3 +1,7 @@
-<ul class="facet-hierarchy">
+<% Deprecation.warn(self, "Calling the blacklight/hierarchy/facet_hierarchy partial is " \
+  "deprecated and will be removed in blacklight-hierarchy 5.0. Replace the facet config for '#{facet_field.key}':\n\n\t" \
+  ":partial => 'blacklight/hierarchy/facet_hierarchy'\n\nwith:\n\n\t" \
+  ":component => Blacklight::Hierarchy::FacetFieldListComponent\n\n") %>
+<ul class="facet-hierarchy" role="tree">
   <%= render_hierarchy(facet_field) %>
 </ul>

data/blacklight-hierarchy.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'rails', '>= 4.1', '< 6'
-  s.add_dependency 'jquery-rails'
-  s.add_dependency 'blacklight', '~> 7.0'
+  s.add_dependency 'blacklight', '~> 7.13'
+  s.add_dependency 'rails', '>= 5.1', '< 7'
+  s.add_dependency 'deprecation'
 
   s.add_development_dependency 'rsolr'
   s.add_development_dependency 'rspec-rails'

data/config/locales/blacklight-hierarchy.ar.yml

@@ -0,0 +1,4 @@
+ar:
+  blacklight:
+    hierarchy:
+      toggle_aria_label: تبديل المجموعة الفرعية

data/config/locales/blacklight-hierarchy.en.yml

@@ -0,0 +1,4 @@
+en:
+  blacklight:
+    hierarchy:
+      toggle_aria_label: Toggle subgroup

data/lib/blacklight/hierarchy/engine.rb

@@ -4,6 +4,8 @@ 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 = '3.0.0'.freeze
+    VERSION = '4.3.0'.freeze
   end
 end

data/package.json

@@ -1,10 +1,11 @@
 {
   "name": "blacklight-hierarchy",
-  "version": "3.0.0",
+  "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)",
   "main": "app/assets/javascripts/blacklight/hierarchy/hierarchy.js",
   "files": [
-    "app/assets/javascripts/blacklight/hierarchy/*.js"
+    "app/assets/javascripts/blacklight/hierarchy/*.js",
+    "app/assets/stylesheets/blacklight/hierarchy/*.scss"
   ],
   "repository": {
     "type": "git",

data/spec/features/basic_spec.rb

@@ -99,9 +99,8 @@ describe 'config_1' do
     before do
       CatalogController.blacklight_config = Blacklight::Configuration.new
       CatalogController.configure_blacklight do |config|
-        #   config.add_facet_field 'rotate_tag_facet', :label => 'Tag',     :partial => 'blacklight/hierarchy/facet_hierarchy'
-        config.add_facet_field 'tag_facet',    label: 'Tag',         partial: 'blacklight/hierarchy/facet_hierarchy'
-        config.add_facet_field 'my_top_facet', label: 'Slash Delim', partial: 'blacklight/hierarchy/facet_hierarchy'
+        config.add_facet_field 'tag_facet',    label: 'Tag',         component: Blacklight::Hierarchy::FacetFieldListComponent
+        config.add_facet_field 'my_top_facet', label: 'Slash Delim', component: Blacklight::Hierarchy::FacetFieldListComponent
         config.facet_display = {
           hierarchy: {
             #       'rotate' => [['tag'  ], ':'], # this would work if config.add_facet_field was called rotate_tag_facet, instead of tag_facet, I think.
@@ -119,8 +118,8 @@ describe 'config_2' do
     before do
       CatalogController.blacklight_config = Blacklight::Configuration.new
       CatalogController.configure_blacklight do |config|
-        config.add_facet_field 'tag_facet',    label: 'Tag',         partial: 'blacklight/hierarchy/facet_hierarchy'
-        config.add_facet_field 'my_top_facet', label: 'Slash Delim', partial: 'blacklight/hierarchy/facet_hierarchy'
+        config.add_facet_field 'tag_facet',    label: 'Tag',         component: Blacklight::Hierarchy::FacetFieldListComponent
+        config.add_facet_field 'my_top_facet', label: 'Slash Delim', component: Blacklight::Hierarchy::FacetFieldListComponent
         config.facet_display = {
           hierarchy: {
             'tag'    => [['facet']], # rely on default delim

data/spec/helpers/hierarchy_helper_spec.rb

@@ -1,11 +1,20 @@
 require 'spec_helper'
 
-describe Blacklight::HierarchyHelper do
+RSpec.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
   end
+
+  describe '#facet_toggle_button' do
+    subject { helper.facet_toggle_button(field_name, described_by) }
+    let(:field_name) { 'exploded_tag_ssim' }
+    let(:described_by) { 'unique-string' }
+
+    it { is_expected.to be_html_safe }
+  end
 end

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -17,4 +17,12 @@ class TestAppGenerator < Rails::Generators::Base
   def run_hierarchy_install
     generate 'blacklight_hierarchy:install'
   end
+
+  def create_images_directory
+    run 'mkdir app/assets/images'
+  end
+
+  def add_js_reference
+    inject_into_file 'app/assets/config/manifest.js', "\n//= link application.js", after: '//= link_directory ../stylesheets .css'
+  end
 end

metadata

@@ -1,63 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-hierarchy
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Michael B. Klein
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7.13'
 - !ruby/object:Gem::Dependency
-  name: jquery-rails
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
-  name: blacklight
+  name: deprecation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rsolr
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -159,14 +160,22 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- app/assets/images/collapsed.png
-- app/assets/images/expanded.png
 - app/assets/javascripts/blacklight/hierarchy/hierarchy.js
 - app/assets/stylesheets/blacklight/hierarchy/hierarchy.scss
+- app/components/blacklight/hierarchy/facet_field_component.html.erb
+- app/components/blacklight/hierarchy/facet_field_component.rb
+- app/components/blacklight/hierarchy/facet_field_list_component.html.erb
+- app/components/blacklight/hierarchy/facet_field_list_component.rb
+- app/components/blacklight/hierarchy/qfacet_value_component.html.erb
+- app/components/blacklight/hierarchy/qfacet_value_component.rb
+- 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/hierarchical_facet_item.rb
 - app/views/blacklight/hierarchy/_facet_hierarchy.html.erb
-- app/views/blacklight/hierarchy/_facet_hierarchy_item.html.erb
 - blacklight-hierarchy.gemspec
+- config/locales/blacklight-hierarchy.ar.yml
+- config/locales/blacklight-hierarchy.en.yml
 - lib/blacklight-hierarchy.rb
 - lib/blacklight/hierarchy.rb
 - lib/blacklight/hierarchy/engine.rb
@@ -199,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Hierarchical Facets for Blacklight

data/app/views/blacklight/hierarchy/_facet_hierarchy_item.html.erb

@@ -1,25 +0,0 @@
-<% 
-  item = data[:_]
-  subset = data.reject { |k,v| ! k.is_a?(String) }
-%>
-
-<li class="<%= subset.empty? ? 'h-leaf' : 'h-node'  %>">
-  <% if item.nil? %>
-    <%= key %>              
-  <% else %>
-    <% if facet_in_params?(field_name, item.qvalue) %>
-      <%= render_selected_qfacet_value( field_name, item )%>
-    <% else %>
-      <%= render_qfacet_value(field_name, item) %>              
-    <% end %>
-  <% end %>
-  <% unless subset.empty? %>
-  <ul>
-    <%=
-      raw(subset.keys.sort.collect { |subkey| 
-        render :partial => 'facet_hierarchy_item', :locals => { :field_name => field_name, :data => subset[subkey], :key => subkey } 
-      })
-    %>
-  </ul>
-  <% end %>
-</li>