blacklight-hierarchy 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 301106611145298332bcd99baa46b594bb6e81cfbb91c67c144ad67ea82ffd4e
-  data.tar.gz: 3de7c9ffe277ba90bc6e3cfd1518f0dd1b91234399c5de0bfa37ed821da23cf3
+  metadata.gz: 7f9ee155eb2b3ed03902a2de1322be9adcd84c8f976476c1531e10a2113ebe71
+  data.tar.gz: d43f7f0f8f2bd2180adfb39f98499c5ccb464c356b210c1083aea7d13fccb0fa
 SHA512:
-  metadata.gz: 49ed3184d67352e89bcf78badd554617c9a8618f2bf0ddb4260ec68d43e003604b05b5874a19d2bf5d2d5ac59f0c555f302a6630dd4ca9258ca81269936095ac
-  data.tar.gz: 33cff3c6d664380a251c8956f1de68be41c297067385babbd628b55e61a3e046adf8239a6b5ac04a6d33e861512a122c6601e8ffc9389e5b5e01b54b73e684de
+  metadata.gz: 924135616707307f18fd9411bf2ba6aee1c5a14eff9f5c79cacb86f5bdb4d04db81ed38357aa7cae95a2f855cb9ac3f0e67adf270e2df85d34e61de13cb471b4
+  data.tar.gz: 35415e9645e01d973adb5a9a7b65a50c276bb520d2d2c2f4efd913697ddc611b50576ded53a05ba8d1f7374f7fcf075fd393fc213bb4f604404e13be35e522b3

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

@@ -83,6 +83,29 @@ 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
+```
+
 ## 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/helpers/blacklight/hierarchy_helper.rb

@@ -7,23 +7,26 @@ module Blacklight::HierarchyHelper
     subset = data.reject { |k, _v| !k.is_a?(String) }
 
     li_class = subset.empty? ? 'h-leaf' : 'h-node'
+    id = SecureRandom.uuid
     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
+    li = ''
+    li << facet_toggle_button(field_name, id) if subset.any?
+    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, 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>#{subul}</ul>".html_safe
+      ul = "<ul role=\"group\">#{subul}</ul>".html_safe
     end
 
-    %(<li class="#{li_class}">#{li.html_safe}#{ul.html_safe}</li>).html_safe
+    %(<li class="#{li_class}" role="treeitem">#{li.html_safe}#{ul.html_safe}</li>).html_safe
   end
 
   # @param [Blacklight::Configuration::FacetField] as defined in controller with config.add_facet_field (and with :partial => 'blacklight/hierarchy/facet_hierarchy')
@@ -41,7 +44,8 @@ module Blacklight::HierarchyHelper
   end
 
   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
+    id = options.delete(:id)
+    (link_to_unless(options[:suppress_link], item.value, path_for_facet(facet_solr_field, item.qvalue), id: id, class: 'facet_select') + ' ' + render_facet_count(item.hits)).html_safe
   end
 
   # Standard display of a SELECTED facet value, no link, special span with class, and 'remove' button.
@@ -100,6 +104,24 @@ module Blacklight::HierarchyHelper
     @facet_tree[hkey]
   end
 
+  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'
+    )
+    <<-HTML
+      <button
+        aria-expanded="false"
+        aria-label="#{aria_label}"
+        aria-describedby="#{described_by}"
+        class="toggle-handle"
+      >
+        <span aria-hidden="true" class="closed">#{Blacklight::Hierarchy::Engine.config.closed_icon}</span>
+        <span aria-hidden="true" class="opened">#{Blacklight::Hierarchy::Engine.config.opened_icon}</span>
+      </button>
+    HTML
+  end
+
   # --------------------------------------------------------------------------------------------------------------------------------
   # below are methods pertaining to the "rotate" notion where you may want to look at the same tree data organized another way
   # --------------------------------------------------------------------------------------------------------------------------------

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

@@ -1,3 +1,3 @@
-<ul class="facet-hierarchy">
+<ul class="facet-hierarchy" role="tree">
   <%= render_hierarchy(facet_field) %>
 </ul>

data/blacklight-hierarchy.gemspec

@@ -18,9 +18,10 @@ 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'
+  # Most likely available for even earlier versions of Blacklight, but this is what I validated
+  s.add_dependency 'blacklight', '> 6.20', '< 8.0'
+  s.add_dependency 'rails', '>= 5.1', '< 7'
   s.add_dependency 'jquery-rails'
-  s.add_dependency 'blacklight', '~> 7.0'
 
   s.add_development_dependency 'rsolr'
   s.add_development_dependency 'rspec-rails'

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.0.0'.freeze
   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,69 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-hierarchy
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Michael B. Klein
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2019-12-13 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'
+        version: '6.20'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '6.20'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '8.0'
 - !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: jquery-rails
   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
@@ -159,14 +165,12 @@ 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/helpers/blacklight/hierarchy_helper.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.en.yml
 - lib/blacklight-hierarchy.rb
 - lib/blacklight/hierarchy.rb
 - lib/blacklight/hierarchy/engine.rb

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>