blacklight-hierarchy 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09adfc50b7ac284a10660f6286195c933b83c9a9
-  data.tar.gz: b43755bedbfebb4edbf29e47c780fd6396b53e2f
+  metadata.gz: 012ebd86d5d29ce741c86b58a1d78705bec85881
+  data.tar.gz: dc580c62ac00e64bc2afcbf4b6a38e02bde54e06
 SHA512:
-  metadata.gz: ce12c726de86668634fd4d85f5e8f1a48621c8de7856d9bb42b94018f6d89ae96a351ac4cc1054f5463061aa8dea7d6cfa7fd67aa550588543652338760e3894
-  data.tar.gz: 9ea282ea66826a20d233ee8df327925bda14f12c2e01d4441d78f7ea8ff51143f5e3b1f8c92cd09a54d6033b0dc72df6b5f18e1dda5ee7a9b010eed31a4ad398
+  metadata.gz: 7da5e0f9a81a1dcaefdc27b18a375f241bba50bb9f4452ce34e70d9fadfda8e482c4d5feb95fe6b90626b62cbaccc04b4d9a9b201486a3087009b9e4dc25934a
+  data.tar.gz: 974e9e27e9d5a5e7e6767cf7bbc8d8f0fad42f39077d6aa72938abb3f2833c235034f25d8ca6b8ed2f70a21245adc01d631847d0ff22989da4d5a7a985bcf77f

data/.rubocop.yml

@@ -0,0 +1,17 @@
+inherit_from: .rubocop_todo.yml
+
+# rspec expect{...} is conventional
+Style/SpaceBeforeBlockBraces:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+# allow for alignment
+Style/SpaceAroundOperators:
+  AllowForAlignment: true
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 200

data/.rubocop_todo.yml

@@ -0,0 +1,69 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-02-29 14:59:02 -0800 using RuboCop version 0.37.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 5
+Metrics/AbcSize:
+  Max: 49
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 19
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 110
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'app/helpers/blacklight/hierarchy_helper.rb'
+
+# Offense count: 5
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'app/helpers/blacklight/hierarchy_helper.rb'
+    - 'lib/blacklight/hierarchy.rb'
+    - 'lib/blacklight/hierarchy/hierarchical_facet.rb'
+    - 'lib/generators/blacklight_hierarchy/install_generator.rb'
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
+Style/FileName:
+  Exclude:
+    - 'lib/blacklight-hierarchy.rb'
+
+# Offense count: 1
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+Style/PredicateName:
+  Exclude:
+    - 'app/helpers/blacklight/hierarchy_helper.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Exclude:
+    - 'app/helpers/blacklight/hierarchy_helper.rb'
+
+# Offense count: 1
+Style/ZeroLengthPredicate:
+  Exclude:
+    - 'app/helpers/blacklight/hierarchy_helper.rb'

data/.travis.yml

@@ -5,7 +5,6 @@ rvm:
 
 notifications:
   email:
-    - ndushay@stanford.edu
     - cbeer@stanford.edu
 
 env:

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Declare gem dependencies in blacklight-hierarchy-facets.gemspec.
 gemspec
@@ -9,10 +9,10 @@ gemspec
 # your gem to rubygems.org.
 
 # BEGIN ENGINE_CART BLOCK
-# engine_cart: 0.8.0
-# engine_cart stanza: 0.8.0
+# engine_cart: 1.0.1
+# engine_cart stanza: 0.10.0
 # the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
-file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path(".internal_test_app", File.dirname(__FILE__)))
+file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
 if File.exist?(file)
   begin
     eval_gemfile file
@@ -23,13 +23,22 @@ if File.exist?(file)
 else
   Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
 
-  gem 'rails', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
+  if ENV['RAILS_VERSION']
+    if ENV['RAILS_VERSION'] == 'edge'
+      gem 'rails', github: 'rails/rails'
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
+    else
+      gem 'rails', ENV['RAILS_VERSION']
+    end
+  end
 
-  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^4.2/
-    gem 'responders', "~> 2.0"
-    gem 'sass-rails', ">= 5.0"
-  else
-    gem 'sass-rails', "< 5.0"
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+    gem 'coffee-rails', '~> 4.1.0'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
   end
 end
-# END ENGINE_CART BLOCK
+# END ENGINE_CART BLOCK

data/README.md

@@ -3,28 +3,34 @@
 
 This plugin provides hierarchical facets for [Blacklight](https://github.com/projectblacklight/blacklight).
 
+Please note this is does not directly follow any of the competing approaches of [Hierarchical Facets in Solr](http://wiki.apache.org/solr/HierarchicalFaceting), including Solr PivotFacets.
+
 ## Usage
 
-Add the plugin to your Blacklight app's Gemfile
-
-    gem 'blacklight-hierarchy'
-        
-Index your hierarchies in colon-separated list. For example, items in a "processing" queue with a "copy" action, might be indexed as
-
-    <doc>
-      <field name="id">foo</field>
-      <field name="queue_status_facet">processing</field>
-      <field name="queue_status_facet">processing:copy</field>
-      <field name="queue_status_facet">processing:copy:waiting</field>
-    </doc>
-    <doc>
-      <field name="id">bar</field>
-      <field name="queue_status_facet">processing</field>
-      <field name="queue_status_facet">processing:copy</field>
-      <field name="queue_status_facet">processing:copy:completed</field>
-    </doc>
-        
-That would cause the facet count to appear at all three levels
+Add the plugin to your Blacklight app's Gemfile.
+
+```ruby
+gem 'blacklight-hierarchy'
+```
+
+Index your hierarchies in a (colon-)separated list. For example, items in a "processing" queue with a "copy" action, might be indexed as:
+
+```xml
+<doc>
+  <field name="id">foo</field>
+  <field name="queue_status_facet">processing</field>
+  <field name="queue_status_facet">processing:copy</field>
+  <field name="queue_status_facet">processing:copy:waiting</field>
+</doc>
+<doc>
+  <field name="id">bar</field>
+  <field name="queue_status_facet">processing</field>
+  <field name="queue_status_facet">processing:copy</field>
+  <field name="queue_status_facet">processing:copy:completed</field>
+</doc>
+```
+
+That would cause the facet count to appear at all three levels:
 
 - [processing](#) (2)
     - [copy](#) (2)
@@ -38,24 +44,45 @@ You can skip as many levels as you'd like, as long as the "leaf" values are inde
         - [completed](#) (1)
         - [waiting](#) (1)
 
-(**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.)
+**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 partial.
 
-    config.add_facet_field 'queue_status_facet', :label => 'Queue Status', 
-        :partial => 'blacklight/hierarchy/facet_hierarchy'
 
+```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'
+```
 
-Add the hierarchy-specific options to the controller configuration
+Add your hierarchy-specific options to the controller configuration:
 
-    config.facet_display = {
-      :hierarchy => {
-        'queue_status' => [['facet'], ':']
-      }
-    }
+```ruby
+config.facet_display = {
+  :hierarchy => {
+    'queue'   => [['wps','wsp','swp'], ':'],       # values are arrays: 1st element is array, 2nd is delimiter string
+    'callnum' => [['top'], '/'],
+    'foo'     => [['trunk', 'branch', 'leaves']],  # implied default delimiter
+    'tag'     => [[nil]]                           # TODO: explain
+  }
+}
+```
 
 In the above configuration, 'queue_status_facet' is the full Solr field name, and ':' is the delimiter within the field.  Note that suffixes ('facet' in the above example) should not contain underscores, since the methods that deal with the Solr fields and match them to the config assume the "prefix" ('queue_status' in the above example) will be everything up to the last underscore in the field name.  See the facet_tree method for further explanation and some relevant code, as well as the render_hierarchy method for relevant code.
 
+The `[nil]` value is present in support of rotatable facet hierarchies, a totally undocumented feature.
+
+Facet fields should be added for each permutation of hierarchy key and term values, joined by **_**.  Or, the output of:
+
+```ruby
+config.facet_display[:hierarchy].each{ |k,v| puts "#{k}_#{v}" }
+```
+
 ## 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.
@@ -64,4 +91,5 @@ This code was ripped out of another project, and is still quite immature as a st
 
 - 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)
+- 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/Rakefile

@@ -7,23 +7,21 @@ rescue LoadError
 end
 
 require 'engine_cart/rake_task'
-TEST_APP_TEMPLATES = 'spec/test_app_templates'
-TEST_APP = 'spec/internal'
-#ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.0.0.zip"
-APP_ROOT = File.expand_path("..", __FILE__)
-
-task :default => :ci
+TEST_APP_TEMPLATES = 'spec/test_app_templates'.freeze
+TEST_APP = 'spec/internal'.freeze
+# ZIP_URL = "https://github.com/projectblacklight/blacklight-jetty/archive/v4.0.0.zip"
+APP_ROOT = File.expand_path('..', __FILE__)
 
+task default: :ci
 
 require 'rspec/core/rake_task'
 
-desc "Run specs"
+desc 'Run specs'
 RSpec::Core::RakeTask.new(:rspec)
-task :spec => :rspec
-
+task spec: :rspec
 
-desc "Execute Continuous Integration Build"
-task :ci => ['engine_cart:clean', 'engine_cart:generate', 'rspec']
+desc 'Execute Continuous Integration Build'
+task ci: ['engine_cart:clean', 'engine_cart:generate', 'rspec']
 
 begin
   require 'rdoc/task'
@@ -33,7 +31,7 @@ rescue LoadError
   RDoc::Task = Rake::RDocTask
 end
 
-desc "Create rdoc"
+desc 'Create rdoc'
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Blacklight::Hierarchy'

data/app/helpers/blacklight/hierarchy_helper.rb

@@ -1,22 +1,20 @@
 module Blacklight::HierarchyHelper
-
   # 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) }
+    subset = data.reject { |k, _v| !k.is_a?(String) }
 
     li_class = subset.empty? ? 'h-leaf' : 'h-node'
-    li = ul = ''
-
-    if item.nil?
-      li = key
-    elsif facet_in_params?(field_name, item.qvalue)
-      li = render_selected_qfacet_value(field_name, item)
-    else
-      li = render_qfacet_value(field_name, item)
-    end
+    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|
@@ -25,32 +23,35 @@ module Blacklight::HierarchyHelper
       ul = "<ul>#{subul}</ul>".html_safe
     end
 
-    %{<li class="#{li_class}">#{li.html_safe}#{ul.html_safe}</li>}.html_safe
+    %(<li class="#{li_class}">#{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')
   # @return [String] html for the facet tree
-  def render_hierarchy(bl_facet_field, delim='_')
+  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
 
+    return '' unless tree
     tree.keys.sort.collect do |key|
       render_facet_hierarchy_item(field_name, tree[key], key)
     end.join("\n").html_safe
   end
 
-  def render_qfacet_value(facet_solr_field, item, options ={})
-    (link_to_unless(options[:suppress_link], item.value, search_state.add_facet_params(facet_solr_field, item.qvalue), :class=>"facet_select") + " " + render_facet_count(item.hits)).html_safe
+  def render_qfacet_value(facet_solr_field, item, options = {})
+    (link_to_unless(options[:suppress_link], item.value, search_state.add_facet_params(facet_solr_field, item.qvalue), 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.
   def render_selected_qfacet_value(facet_solr_field, item)
-    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_facet_params(facet_solr_field, item.qvalue, params), :class=>"remove")
+    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_facet_params(facet_solr_field, item.qvalue, params),
+              class: 'remove'
+             )
   end
 
   HierarchicalFacetItem = Struct.new :qvalue, :value, :hits
@@ -68,11 +69,11 @@ module Blacklight::HierarchyHelper
   #
   # 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 
+  #  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 
+  #  '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)
@@ -80,35 +81,32 @@ module Blacklight::HierarchyHelper
     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]
+    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 { |key|
+    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_field = [hkey, key].compact.join('_')
       @facet_tree[hkey][facet_field] ||= {}
       data = @response.aggregations[facet_field]
       next if data.nil?
-
-      data.items.each { |facet_item|
+      data.items.each do |facet_item|
         path = facet_item.value.split(split_regex)
         loc = @facet_tree[hkey][facet_field]
-        while path.length > 0
-          loc = loc[path.shift] ||= {}
-        end
+        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
 
-# --------------------------------------------------------------------------------------------------------------------------------
-# below are methods pertaining to the "rotate" notion where you may want to look at the same tree data organized another way
-# --------------------------------------------------------------------------------------------------------------------------------
+  # --------------------------------------------------------------------------------------------------------------------------------
+  # 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
+  # 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] and list.include?(order)
+    (prefix, order) = field_name.split(/_/, 2)
+    (list = blacklight_config.facet_display[:hierarchy][prefix]) && list.include?(order)
   end
 
   def facet_order(prefix)
@@ -118,35 +116,27 @@ module Blacklight::HierarchyHelper
 
   def facet_after(prefix, order)
     orders = blacklight_config.facet_display[:hierarchy][prefix]
-    orders[orders.index(order)+1] || orders.first
+    orders[orders.index(order) + 1] || orders.first
   end
 
-  # FIXME:  remove baked in underscore separator in field name
+  # FIXME: remove baked in underscore separator in field name
   def hide_facet?(field_name)
-    if is_hierarchical?(field_name)
-      prefix = field_name.split(/_/).first
-      field_name != "#{prefix}_#{facet_order(prefix)}"
-    else
-      false
-    end
+    return false unless is_hierarchical?(field_name)
+    prefix = field_name.split(/_/).first
+    field_name != "#{prefix}_#{facet_order(prefix)}"
   end
 
-  # FIXME:  remove baked in colon separator
+  # 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(//)))
-    while new_values.last.nil?
-      new_values.pop
-    end
-    if new_values.include?(nil)
-      nil
-    else
-      new_values.compact.join(':')
-    end
+    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
 
-  # FIXME:  remove baked in underscore separator in field name
-  def rotate_facet_params(prefix, from, to, p=params.dup)
+  # 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}"
@@ -160,18 +150,14 @@ module Blacklight::HierarchyHelper
     p
   end
 
-  # FIXME:  remove baked in underscore separator in field name
+  # FIXME: remove baked in underscore separator in field name
   def render_facet_rotate(field_name)
-    if 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
+    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
-
 end

data/blacklight-hierarchy.gemspec

@@ -3,29 +3,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'blacklight/hierarchy/version'
 
 Gem::Specification.new do |s|
-  s.name        = "blacklight-hierarchy"
+  s.name        = 'blacklight-hierarchy'
   s.version     = Blacklight::Hierarchy::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Michael B. Klein"]
-  s.email       = ["dlss-dev@lists.stanford.edu"]
-  s.homepage    = "https://github.com/sul-dlss/blacklight-hierarchy"
-  s.summary     = "Hierarchical Facets for Blacklight"
-  s.description = "Allows delimited Solr facets to become hierarchical trees in Blacklight."
+  s.authors     = ['Michael B. Klein']
+  s.email       = ['dlss-dev@lists.stanford.edu']
+  s.homepage    = 'https://github.com/sul-dlss/blacklight-hierarchy'
+  s.summary     = 'Hierarchical Facets for Blacklight'
+  s.description = 'Allows delimited Solr facets to become hierarchical trees in Blacklight.'
 
   s.files         = `git ls-files -z`.split("\x0")
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.bindir        = 'exe'
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
-  s.add_dependency "rails", '~> 4.1'
-  s.add_dependency "jquery-rails"
-  s.add_dependency "blacklight", ">= 6.0.0.pre3", "< 7"
-  
-  s.add_development_dependency "rsolr"
-  s.add_development_dependency "rspec-rails"
-  s.add_development_dependency "sqlite3"
-  s.add_development_dependency "engine_cart", '~> 0.8'
-  s.add_development_dependency "capybara"
-  s.add_development_dependency "coveralls"
+  s.add_dependency 'rails', '~> 4.1'
+  s.add_dependency 'jquery-rails'
+  s.add_dependency 'blacklight', '~> 6.0'
+
+  s.add_development_dependency 'rsolr'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'engine_cart', '~> 1.0'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'coveralls'
 end

data/lib/blacklight-hierarchy.rb

@@ -1 +1 @@
-require 'blacklight/hierarchy'
+require 'blacklight/hierarchy'

data/lib/blacklight/hierarchy/hierarchical_facet.rb

@@ -2,21 +2,21 @@ module Blacklight
   module Hierarchy
     class FacetItem
       attr_reader :qname, :hits
-  
+
       def initialize(qname, hits, facet)
         @qname = qname
         @hits = hits
         @facet = facet
       end
-  
+
       def [](value)
-        @facet.facets([qname,value].select(&:present?).join(@facet.delimiter))
+        @facet.facets([qname, value].select(&:present?).join(@facet.delimiter))
       end
 
       def each_pair
         keys.each { |k| yield k, self[k] }
       end
-  
+
       def keys
         @facet.keys(qname)
       end
@@ -24,11 +24,11 @@ module Blacklight
       def path
         @qname.split(@facet.delimiter)[0..-2]
       end
-  
+
       def name
         @qname.split(@facet.delimiter).last
       end
-  
+
       def inspect
         "#<#{self.class.name}:#{name}=>#{hits.inspect} (#{keys.join ', '})>"
       end
@@ -37,36 +37,36 @@ module Blacklight
     class FacetGroup
       attr_reader :facet_data, :qname, :hits, :delimiter
       include Enumerable
-  
-      def initialize(facet_data, delimiter=":")
+
+      def initialize(facet_data, delimiter = ':')
         @facet_data = Hash[*facet_data]
         @delimiter = delimiter
       end
-  
-      def each &block
+
+      def each(&block)
         facets.each &block
       end
-  
+
       def each_pair
         facets.each { |f| yield f.name, f }
       end
-  
-      def keys(prefix=nil)
+
+      def keys(prefix = nil)
         if prefix.nil?
-          facet_data.collect { |k,v| k.split(delimiter).first }.uniq
+          facet_data.collect { |k, _v| k.split(delimiter).first }.uniq
         else
           path = prefix.to_s.split(delimiter)
-          facet_data.collect do |k,v|
+          facet_data.collect do |k, _v|
             facet_path = k.split(delimiter)
-            facet_path[0..path.length-1] == path ? facet_path[path.length] : nil
+            facet_path[0..path.length - 1] == path ? facet_path[path.length] : nil
           end.compact.uniq
         end
       end
-  
-      def facets(prefix=nil)
-        FacetItem.new(prefix.to_s,facet_data[prefix],self)
+
+      def facets(prefix = nil)
+        FacetItem.new(prefix.to_s, facet_data[prefix], self)
       end
-  
+
       def [](value)
         facets(value)
       end

data/lib/blacklight/hierarchy/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Hierarchy
-    VERSION = "0.2.0"
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/generators/blacklight_hierarchy/install_generator.rb

@@ -5,8 +5,8 @@ module BlacklightHierarchy
     source_root File.expand_path('../templates', __FILE__)
 
     def assets
-      copy_file "blacklight_hierarchy.css.scss", "app/assets/stylesheets/blacklight_hierarchy.css.scss"
-      copy_file "blacklight_hierarchy.js", "app/assets/javascripts/blacklight_hierarchy.js"
+      copy_file 'blacklight_hierarchy.scss', 'app/assets/stylesheets/blacklight_hierarchy.scss'
+      copy_file 'blacklight_hierarchy.js', 'app/assets/javascripts/blacklight_hierarchy.js'
     end
   end
-end
+end

data/spec/features/basic_spec.rb

@@ -1,113 +1,111 @@
 require 'spec_helper'
 
-shared_examples "catalog" do
-
-  context "facet tree without repeated nodes" do
-    before {
-      solr_facet_resp = {'responseHeader'=>{'status'=>0, 'QTime'=>4, 'params'=>{'wt'=>'ruby','rows'=>'0'}},
-                          'response'=>{'numFound'=>30, 'start'=>0, 'maxScore'=>1.0, 'docs' => []},
-                                      'facet_counts' => {
-                                        'facet_queries' => {},
-                                        'facet_fields' => {
-                                          'tag_facet' => [
-                                              'a:b:c', 30,
-                                              'a:b:d', 25,
-                                              'a:c:d', 5,
-                                              'p:r:q', 25,
-                                              'x:y', 5,
-                                              'n', 1 ],
-                                          'my_top_facet' => [
-                                              'f/g/h', 30,
-                                              'j/k', 5,
-                                              'z', 1 ],
-                                         },
-                                        'facet_dates' => {},
-                                        'facet_ranges' => {}
-                                      }
+shared_examples 'catalog' do
+  context 'facet tree without repeated nodes' do
+    before do
+      solr_facet_resp = { 'responseHeader' => { 'status' => 0, 'QTime' => 4, 'params' => { 'wt' => 'ruby', 'rows' => '0' } },
+                          'response' => { 'numFound' => 30, 'start' => 0, 'maxScore' => 1.0, 'docs' => [] },
+                          'facet_counts' => {
+                            'facet_queries' => {},
+                            'facet_fields' => {
+                              'tag_facet' => [
+                                'a:b:c', 30,
+                                'a:b:d', 25,
+                                'a:c:d', 5,
+                                'p:r:q', 25,
+                                'x:y', 5,
+                                'n', 1],
+                              'my_top_facet' => [
+                                'f/g/h', 30,
+                                'j/k', 5,
+                                'z', 1]
+                            },
+                            'facet_dates' => {},
+                            'facet_ranges' => {}
+                          }
                           }
-      rsolr_client = double("rsolr_client")
+      rsolr_client = double('rsolr_client')
       expect(rsolr_client).to receive(:send_and_receive).and_return solr_facet_resp
       expect(RSolr).to receive(:connect).and_return rsolr_client
-    }
+    end
 
-    it "should display the hierarchy" do
+    it 'should display the hierarchy' do
       visit '/'
-      expect(page).to have_selector('li.h-node', :text => 'a')
-      expect(page).to have_selector('li.h-node > ul > li.h-node', :text => 'b')
-      expect(page).to have_selector('li.h-node li.h-leaf', :text => 'c 30')
-      expect(page).to have_selector('li.h-node li.h-leaf', :text => 'd 25')
-      expect(page).to have_selector('li.h-node > ul > li.h-node', :text => 'c')
-      expect(page).to have_selector('li.h-node li.h-leaf', :text => 'd 5')
-      expect(page).to have_selector('li.h-node', :text => 'p')
-      expect(page).to have_selector('li.h-node > ul > li.h-node', :text => 'r')
-      expect(page).to have_selector('li.h-node li.h-leaf', :text => 'q 25')
-      expect(page).to have_selector('li.h-node', :text => 'x')
-      expect(page).to have_selector('li.h-node li.h-leaf', :text => 'y 5')
-      expect(page).to have_selector('.facet-hierarchy > li.h-leaf', :text => 'n 1')
+      expect(page).to have_selector('li.h-node', text: 'a')
+      expect(page).to have_selector('li.h-node > ul > li.h-node', text: 'b')
+      expect(page).to have_selector('li.h-node li.h-leaf', text: 'c 30')
+      expect(page).to have_selector('li.h-node li.h-leaf', text: 'd 25')
+      expect(page).to have_selector('li.h-node > ul > li.h-node', text: 'c')
+      expect(page).to have_selector('li.h-node li.h-leaf', text: 'd 5')
+      expect(page).to have_selector('li.h-node', text: 'p')
+      expect(page).to have_selector('li.h-node > ul > li.h-node', text: 'r')
+      expect(page).to have_selector('li.h-node li.h-leaf', text: 'q 25')
+      expect(page).to have_selector('li.h-node', text: 'x')
+      expect(page).to have_selector('li.h-node li.h-leaf', text: 'y 5')
+      expect(page).to have_selector('.facet-hierarchy > li.h-leaf', text: 'n 1')
     end
 
-    it "should properly link the hierarchy" do
+    it 'should properly link the hierarchy' do
       visit '/'
       expect(page.all(:css, 'li.h-leaf a').map { |a| a[:href].to_s }).to include(root_path('f' => { 'tag_facet' => ['n'] }))
       expect(page.all(:css, 'li.h-leaf a').map { |a| a[:href].to_s }).to include(root_path('f' => { 'tag_facet' => ['a:b:c'] }))
       expect(page.all(:css, 'li.h-leaf a').map { |a| a[:href].to_s }).to include(root_path('f' => { 'tag_facet' => ['x:y'] }))
     end
 
-    it "should work with a different value delimiter" do
+    it 'should work with a different value delimiter' do
       visit '/'
-      expect(page).to have_selector('li.h-node', :text => 'f')
-      expect(page).to have_selector('li.h-node > ul > li.h-node', :text => 'g')
-      expect(page).to have_selector('li.h-node li.h-leaf', :text => 'h 30')
-      expect(page).to have_selector('li.h-node', :text => 'j')
-      expect(page).to have_selector('li.h-node li.h-leaf', :text => 'k 5')
-      expect(page).to have_selector('.facet-hierarchy > li.h-leaf', :text => 'z 1')
+      expect(page).to have_selector('li.h-node', text: 'f')
+      expect(page).to have_selector('li.h-node > ul > li.h-node', text: 'g')
+      expect(page).to have_selector('li.h-node li.h-leaf', text: 'h 30')
+      expect(page).to have_selector('li.h-node', text: 'j')
+      expect(page).to have_selector('li.h-node li.h-leaf', text: 'k 5')
+      expect(page).to have_selector('.facet-hierarchy > li.h-leaf', text: 'z 1')
     end
   end # facet tree without repeated nodes
 
-  context "facet tree with repeated nodes" do
+  context 'facet tree with repeated nodes' do
     before do
-      facet_resp = {'responseHeader'=>{'status'=>0, 'QTime'=>4, 'params'=>{'wt'=>'ruby','rows'=>'0'}},
-                          'response'=>{'numFound'=>30, 'start'=>0, 'maxScore'=>1.0, 'docs' => []},
-                                      'facet_counts' => {
-                                        'facet_queries' => {},
-                                        'facet_fields' => {
-                                          'tag_facet' => [
-                                              'm:w:w:t', 15,
-                                              'm:w:v:z', 10],
-                                         },
-                                        'facet_dates' => {},
-                                        'facet_ranges' => {}
-                                      }
+      facet_resp = { 'responseHeader' => { 'status' => 0, 'QTime' => 4, 'params' => { 'wt' => 'ruby', 'rows' => '0' } },
+                     'response' => { 'numFound' => 30, 'start' => 0, 'maxScore' => 1.0, 'docs' => [] },
+                     'facet_counts' => {
+                       'facet_queries' => {},
+                       'facet_fields' => {
+                         'tag_facet' => [
+                           'm:w:w:t', 15,
+                           'm:w:v:z', 10]
+                       },
+                       'facet_dates' => {},
+                       'facet_ranges' => {}
+                     }
                     }
-      my_rsolr_client = double("rsolr_client")
+      my_rsolr_client = double('rsolr_client')
       expect(my_rsolr_client).to receive(:send_and_receive).and_return facet_resp
       expect(RSolr).to receive(:connect).and_return my_rsolr_client
     end
-    it "should display all child nodes when a node value is repeated at its child level" do
+    it 'should display all child nodes when a node value is repeated at its child level' do
       visit '/'
-      expect(page).to have_selector('li.h-node', :text => 'm')
-      expect(page).to have_selector('li.h-node > ul > li.h-node', :text => 'w')
-      expect(page).to have_selector('li.h-node > ul > li.h-node > ul > li.h-node', :text => 'w')
-      expect(page).to have_selector('li.h-node > ul > li.h-node > ul > li.h-node', :text => 'v')
-      expect(page).to have_selector('li.h-node li.h-leaf', :text => 't 15')
-      expect(page).to have_selector('li.h-node li.h-leaf', :text => 'z 10')
+      expect(page).to have_selector('li.h-node', text: 'm')
+      expect(page).to have_selector('li.h-node > ul > li.h-node', text: 'w')
+      expect(page).to have_selector('li.h-node > ul > li.h-node > ul > li.h-node', text: 'w')
+      expect(page).to have_selector('li.h-node > ul > li.h-node > ul > li.h-node', text: 'v')
+      expect(page).to have_selector('li.h-node li.h-leaf', text: 't 15')
+      expect(page).to have_selector('li.h-node li.h-leaf', text: 'z 10')
     end
   end
-
 end
 
-describe "config_1" do
-  it_behaves_like "catalog" do
+describe 'config_1' do
+  it_behaves_like 'catalog' 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 '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.facet_display = {
-          :hierarchy => {
-    #       'rotate' => [['tag'  ], ':'], # this would work if config.add_facet_field was called rotate_tag_facet, instead of tag_facet, I think.
-            'tag'    => [['facet'], ':'],  # stupidly, the facet field is expected to have an underscore followed by SOMETHING;  in this case it is "facet"
+          hierarchy: {
+            #       'rotate' => [['tag'  ], ':'], # this would work if config.add_facet_field was called rotate_tag_facet, instead of tag_facet, I think.
+            'tag'    => [['facet'], ':'], # stupidly, the facet field is expected to have an underscore followed by SOMETHING;  in this case it is "facet"
             'my_top' => [['facet'], '/']
           }
         }
@@ -116,16 +114,16 @@ describe "config_1" do
   end
 end
 
-describe "config_2" do
-  it_behaves_like "catalog" do
+describe 'config_2' do
+  it_behaves_like 'catalog' 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',         partial: 'blacklight/hierarchy/facet_hierarchy'
+        config.add_facet_field 'my_top_facet', label: 'Slash Delim', partial: 'blacklight/hierarchy/facet_hierarchy'
         config.facet_display = {
-          :hierarchy => {
-            'tag'    => [['facet']],      # rely on default delim
+          hierarchy: {
+            'tag'    => [['facet']], # rely on default delim
             'my_top' => [['facet'], '/']
           }
         }

data/spec/helpers/hierarchy_helper_spec.rb

@@ -1,10 +1,10 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Blacklight::HierarchyHelper do
   describe '#render_hierarchy' do
     it 'should remove the _suffix from the field name' do
-      field = OpenStruct.new(field: "the_field_name_facet")
-      expect(helper).to receive(:facet_tree).with("the_field_name").and_return({})
+      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

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-ENV["RAILS_ENV"] ||= "test"
+ENV['RAILS_ENV'] ||= 'test'
 
 require 'rsolr'
 

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

@@ -4,17 +4,12 @@ class TestAppGenerator < Rails::Generators::Base
   def add_gems
     gem 'blacklight'
     Bundler.with_clean_env do
-      run "bundle install"
+      run 'bundle install'
     end
   end
 
-  # This is only necessary for Rails 3
-  def remove_index
-    remove_file "public/index.html"
-  end
-
   def run_blacklight_generator
-    say_status("warning", "GENERATING BL", :yellow)
+    say_status('warning', 'GENERATING BL', :yellow)
 
     generate 'blacklight:install'
   end
@@ -22,5 +17,4 @@ class TestAppGenerator < Rails::Generators::Base
   def run_hierarchy_install
     generate 'blacklight_hierarchy:install'
   end
-
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-hierarchy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael B. Klein
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -42,22 +42,16 @@ dependencies:
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.0.0.pre3
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.0.0.pre3
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rsolr
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -152,6 +146,8 @@ files:
 - ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -163,7 +159,7 @@ files:
 - app/assets/images/minus_arrow.png
 - app/assets/images/plus_arrow.png
 - app/assets/javascripts/blacklight/hierarchy/hierarchy.js
-- app/assets/stylesheets/blacklight/hierarchy/hierarchy.css.scss
+- 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
@@ -174,8 +170,8 @@ files:
 - lib/blacklight/hierarchy/hierarchical_facet.rb
 - lib/blacklight/hierarchy/version.rb
 - lib/generators/blacklight_hierarchy/install_generator.rb
-- lib/generators/blacklight_hierarchy/templates/blacklight_hierarchy.css.scss
 - lib/generators/blacklight_hierarchy/templates/blacklight_hierarchy.js
+- lib/generators/blacklight_hierarchy/templates/blacklight_hierarchy.scss
 - spec/features/basic_spec.rb
 - spec/helpers/hierarchy_helper_spec.rb
 - spec/spec_helper.rb
@@ -199,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: Hierarchical Facets for Blacklight