blacklight-hierarchy 4.3.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7bacf2b0748d1154d75223505d631c5d38edd91a1bb72f514bd0809fb57cce8
-  data.tar.gz: 752c9cb4ba854489493681452862fcbb8dd332d0a1c505c849890f2ae0d85184
+  metadata.gz: 697c2ee0eb4208a5849d3d4ac87a06649926581ff2bceebf4286251a6502cb31
+  data.tar.gz: 243b6ae6bcb6a0f9f25335e251fee8d45b2ee0020337f4187728c0a20b2fd643
 SHA512:
-  metadata.gz: baf85f7b64a20872faa888b8513d82b469757325a0da6dfa597f653f8040059413cb42f8a9cd8ec41636529a335b4c7247173a16447d85ee1f81adee91ae6a07
-  data.tar.gz: 966af183ac26d3db3346018af9bff71e714d5dbc22af73664fc4bab5d8eba816cec2c564408c4dd050685c1cc14d52f13b09c14b50d98c3f5e4495174490cb29
+  metadata.gz: 575224c30019574f9cd0396676e1dc402a3c5d4743538bcb04cd0eeefbb97106102f35deb02f342063d6d8c51da5f719a86d5bcb290998124ea0e0d81423599b
+  data.tar.gz: 1ca5e9d6fe3a6aae330a2bb4d6815e40b8923df00e9559a7dcb6ac3145837f02df1d844bd0bed964d7c245a78bf33c3e0dee4cc3ee905ec9f313b7e35a8e86b0

data/.github/workflows/ruby.yml

@@ -9,9 +9,9 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   test:

data/README.md

@@ -1,5 +1,5 @@
 # Blacklight::Hierarchy
-[![Build Status](https://travis-ci.org/sul-dlss/blacklight-hierarchy.svg?branch=master)](https://travis-ci.org/sul-dlss/blacklight-hierarchy) [![Coverage Status](https://coveralls.io/repos/sul-dlss/blacklight-hierarchy/badge.png)](https://coveralls.io/r/sul-dlss/blacklight-hierarchy) [![Gem Version](https://badge.fury.io/rb/blacklight-hierarchy.svg)](http://badge.fury.io/rb/blacklight-hierarchy)
+[![Build Status](https://github.com/sul-dlss/blacklight-hierarchy/workflows/CI/badge.svg)](https://github.com/sul-dlss/blacklight-hierarchy/actions?query=branch%3Amain) [![Coverage Status](https://coveralls.io/repos/sul-dlss/blacklight-hierarchy/badge.png)](https://coveralls.io/r/sul-dlss/blacklight-hierarchy) [![Gem Version](https://badge.fury.io/rb/blacklight-hierarchy.svg)](http://badge.fury.io/rb/blacklight-hierarchy)
 
 This plugin provides hierarchical facets for [Blacklight](https://github.com/projectblacklight/blacklight).
 

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

@@ -8,8 +8,11 @@ module Blacklight
       # @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 = FacetTree.build(prefix: prefix,
+                                                  facet_display: blacklight_config.facet_display,
+                                                  facet_field: @facet_field)
           facet_tree_for_prefix ? facet_tree_for_prefix[field_name] : nil
         end
       end
@@ -42,31 +45,7 @@ module Blacklight
         @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/helpers/blacklight/hierarchy_helper.rb

@@ -1,128 +1,6 @@
-require 'deprecation'
+# frozen_string_literal: true
 
 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
-  def render_facet_hierarchy_item(field_name, data, key)
-    item = data[:_]
-    subset = data.reject { |k, _v| !k.is_a?(String) }
-
-    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
-
-  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
-  def render_hierarchy(bl_facet_field, delim = '_')
-    field_name = bl_facet_field.field
-    prefix = field_name.gsub("#{delim}#{field_name.split(/#{delim}/).last}", '')
-    facet_tree_for_prefix = facet_tree(prefix)
-    tree = facet_tree_for_prefix ? facet_tree_for_prefix[field_name] : nil
-
-    return '' unless tree
-    tree.keys.sort.collect do |key|
-      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 = {})
-    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)
-    remove_href = search_action_path(search_state.remove_facet_params(facet_solr_field, item.qvalue))
-    content_tag(:span, render_qfacet_value(facet_solr_field, item, suppress_link: true), class: 'selected') + ' ' +
-      link_to(content_tag(:span, '', class: 'glyphicon glyphicon-remove') +
-              content_tag(:span, '[remove]', class: 'sr-only'),
-              remove_href,
-              class: 'remove'
-             )
-  end
-  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:
-  #   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 facet_tree(hkey)
-    @facet_tree ||= {}
-    return @facet_tree[hkey] unless @facet_tree[hkey].nil?
-    return @facet_tree[hkey] unless blacklight_config.facet_display[:hierarchy] && blacklight_config.facet_display[:hierarchy][hkey]
-    @facet_tree[hkey] = {}
-    facet_config = blacklight_config.facet_display[:hierarchy][hkey]
-    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 = [hkey, key].compact.join('_')
-      @facet_tree[hkey][facet_field] ||= {}
-      data = @response.aggregations[facet_field]
-      next if data.nil?
-      data.items.each do |facet_item|
-        path = facet_item.value.split(split_regex)
-        loc = @facet_tree[hkey][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[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",
@@ -143,68 +21,8 @@ module Blacklight::HierarchyHelper
   # below are methods pertaining to the "rotate" notion where you may want to look at the same tree data organized another way
   # --------------------------------------------------------------------------------------------------------------------------------
 
-  # FIXME: remove baked in underscore separator in field name
-  def is_hierarchical?(field_name)
-    (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]
     orders[orders.index(order) + 1] || orders.first
   end
-
-  # FIXME: remove baked in underscore separator in field name
-  def hide_facet?(field_name)
-    return false unless is_hierarchical?(field_name)
-    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)
-    components = Hash[from.split(//).zip(val.split(/:/))]
-    new_values = components.values_at(*to.split(//))
-    new_values.pop while new_values.last.nil?
-    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)
-    return p if from == to
-    from_field = "#{prefix}_#{from}"
-    to_field = "#{prefix}_#{to}"
-    p[:f] = (p[:f] || {}).dup # the command above is not deep in rails3, !@#$!@#$
-    p[:f][from_field] = (p[:f][from_field] || []).dup
-    p[:f][to_field] = (p[:f][to_field] || []).dup
-    p[:f][from_field].reject! { |v| p[:f][to_field] << rotate_facet_value(v, from, to); true }
-    p[:f].delete(from_field)
-    p[:f][to_field].compact!
-    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)
-    return unless is_hierarchical?(field_name)
-    (prefix, order) = field_name.split(/_/, 2)
-    return if blacklight_config.facet_display[:hierarchy][prefix].length < 2
-    new_order = facet_after(prefix, order)
-    new_params = rotate_facet_params(prefix, order, new_order)
-    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/blacklight/hierarchy/facet_tree.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Blacklight
+  module Hierarchy
+    class FacetTree
+      def self.build(prefix:, facet_display:, facet_field:)
+        new(prefix: prefix, facet_display: facet_display, facet_field: facet_field).build
+      end
+
+      def initialize(prefix:, facet_display:, facet_field:)
+        @prefix = prefix
+        @facet_config = facet_display.dig(:hierarchy, prefix)
+        @facet_field = facet_field
+      end
+
+      attr_reader :prefix, :facet_config, :data
+
+      def build
+        return unless facet_config
+        {}.tap do |tree|
+          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('_')
+            tree[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 = tree[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
+        end
+      end
+
+      def split_regex
+        @split_regex ||= Regexp.new("\s*#{Regexp.escape(facet_config.length >= 2 ? facet_config[1] : ':')}\s*")
+      end
+    end
+  end
+end

data/lib/blacklight/hierarchy/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Hierarchy
-    VERSION = '4.3.0'.freeze
+    VERSION = '5.0.0'.freeze
   end
 end

data/package.json

@@ -1,7 +1,7 @@
 {
   "name": "blacklight-hierarchy",
   "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)",
+  "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": [
     "app/assets/javascripts/blacklight/hierarchy/*.js",

data/spec/helpers/hierarchy_helper_spec.rb

@@ -1,15 +1,6 @@
 require 'spec_helper'
 
 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' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-hierarchy
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Michael B. Klein
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -155,7 +155,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -171,6 +170,7 @@ files:
 - 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/blacklight/hierarchy/facet_tree.rb
 - app/models/hierarchical_facet_item.rb
 - app/views/blacklight/hierarchy/_facet_hierarchy.html.erb
 - blacklight-hierarchy.gemspec

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 2.7.1
-
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true