blacklight-hierarchy 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c9f090f95fb37ee74711fb756c5c4ac2ae9efb8
+  data.tar.gz: 189511ac1bddefc9090b031ab87952112535b70a
+SHA512:
+  metadata.gz: f0bef2770dfe4c05c6a8e9571a256e9548e91cb4efbcd09b0134a8afdcf03128d121a7ea416947f9b542edd150b2ddcb37feed1a3ea6f622f407e4592dee2681
+  data.tar.gz: 945eb9c018efbe582747bd348a6ffaff1856bbf32fd6e1b56884f69ed8e39a311ff574513d949599d75626bec671bd9d8c7fec9537001682cb80d11bd381f821

data/README.md

@@ -1,4 +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) [![Dependency Status](https://gemnasium.com/sul-dlss/blacklight-hierarchy.svg)](https://gemnasium.com/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).
 
@@ -6,7 +7,8 @@ This plugin provides hierarchical facets for [Blacklight](https://github.com/pro
 
 Add the plugin to your Blacklight app's Gemfile
 
-    gem 'blacklight-hierarchy', :git => 'git@github.com:sul-dlss/blacklight-hierarchy.git'
+    gem 'blacklight-hierarchy'
+    #gem 'blacklight-hierarchy', :git => 'git@github.com:sul-dlss/blacklight-hierarchy.git'
         
 Index your hierarchies in colon-separated list. For example, items in a "processing" queue with a "copy" action, might be indexed as
 

data/Rakefile

@@ -1,9 +1,32 @@
 #!/usr/bin/env rake
 begin
   require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 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
+
+
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:rspec) do |spec|
+  spec.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb", "-t ~wip"]
+end
+task :spec => :rspec
+
+
+desc "Execute Continuous Integration Build"
+task :ci => ['engine_cart:clean', 'engine_cart:generate', 'rspec']
+
 begin
   require 'rdoc/task'
 rescue LoadError
@@ -12,6 +35,7 @@ rescue LoadError
   RDoc::Task = Rake::RDocTask
 end
 
+desc "Create rdoc"
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Blacklight::Hierarchy'
@@ -19,20 +43,3 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-
-
-
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task :default => :test

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

@@ -1,4 +1,4 @@
-$(document).ready(function() {
+Blacklight.onLoad(function(){
   Blacklight.do_hierarchical_facet_expand_contract_behavior();
 });
 

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

@@ -8,6 +8,6 @@
       li {
         margin-left: 8px; } }
     li.h-node {
-      list-style-image: asset_data_url("blacklight/hierarchy/collapsed.png"); }
+      list-style-image: asset_data_url("collapsed.png"); }
     li.h-node.twiddle-open {
-      list-style-image: asset_data_url("blacklight/hierarchy/expanded.png"); } } }
+      list-style-image: asset_data_url("expanded.png"); } } }

data/app/helpers/blacklight/hierarchy_helper.rb

@@ -1,135 +1,172 @@
 module Blacklight::HierarchyHelper
 
-def is_hierarchical?(field_name)
-  (prefix,order,suffix) = field_name.split(/_/)
-  list = blacklight_config.facet_display[:hierarchy][prefix] and list.include?(order)
-end
-    
-def facet_order(prefix)
-  param_name = "#{prefix}_facet_order".to_sym
-  params[param_name] || blacklight_config.facet_display[:hierarchy][prefix].first
-end
+  # 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) }
 
-def facet_after(prefix, order)
-  orders = blacklight_config.facet_display[:hierarchy][prefix]
-  orders[orders.index(order)+1] || orders.first
-end
+    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
+  
+    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
+    end
+  
+    %{<li class="#{li_class}">#{li.html_safe}#{ul.html_safe}</li>}.html_safe
+  end
 
-def hide_facet?(field_name)
-  if is_hierarchical?(field_name)
-    prefix = field_name.split(/_/).first
-    field_name != "#{prefix}_#{facet_order(prefix)}_facet"
-  else
-    false
+  # TODO: remove baked in notion of underscores being part of the blacklight facet field names, 
+  # and of _facet being the suffix of the Solr field name seems to be baked in.
+  # 
+  # @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)
+    field_name = bl_facet_field.field
+    prefix = field_name.gsub("_#{field_name.split(/_/).last}", '')
+    tree = facet_tree(prefix)[field_name]
+    if tree
+      result = tree.keys.sort.collect do |key|
+        render_facet_hierarchy_item(field_name, tree[key], key)
+      end.join("\n").html_safe
+    else
+      ""
+    end
   end
-end
 
-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
+  def render_qfacet_value(facet_solr_field, item, options ={})
+    (link_to_unless(options[:suppress_link], item.value, add_facet_params(facet_solr_field, item.qvalue), :class=>"facet_select") + " " + render_facet_count(item.hits)).html_safe
   end
-  if new_values.include?(nil)
-    nil
-  else
-    new_values.compact.join(':')
+
+  # 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")
   end
-end
 
-def rotate_facet_params(prefix, from, to, p=params.dup)
-  return p if from == to
-  from_field = "#{prefix}_#{from}_facet"
-  to_field = "#{prefix}_#{to}_facet"
-  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
+  HierarchicalFacetItem = Struct.new :qvalue, :value, :hits
+  
+  # @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'], '/']
+  #    }
+  #  }
+  # then possible hkey values would be 'wf' and 'callnum'
+  def facet_tree(hkey)
+    @facet_tree ||= {}
+    if blacklight_config.facet_display[:hierarchy] && blacklight_config.facet_display[:hierarchy][hkey] 
+      value_delim = blacklight_config.facet_display[:hierarchy][hkey].last
+      split_regex = Regexp.new("\s*#{Regexp.escape(value_delim)}\s*")
+      if @facet_tree[hkey].nil?
+        @facet_tree[hkey] = {}
+        blacklight_config.facet_display[:hierarchy][hkey].first.each { |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.facet_by_field_name(facet_field)
+          next if data.nil?
 
-def render_facet_rotate(field_name)
-  if is_hierarchical?(field_name)
-    (prefix,order,suffix) = field_name.split(/_/)
-    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'
+          data.items.each { |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[:_] = HierarchicalFacetItem.new(facet_item.value, facet_item.value.split(split_regex).last, facet_item.hits)
+          }
+        }
+      end
+    end
+    @facet_tree[hkey]
   end
-end
 
-# 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) }
+# --------------------------------------------------------------------------------------------------------------------------------  
+# below are methods pertaining to the "rotate" notion where you may want to look at the same tree data organized another way
+# --------------------------------------------------------------------------------------------------------------------------------  
   
-  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)
+  # 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)
   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
+    
+  def facet_order(prefix)
+    param_name = "#{prefix}_facet_order".to_sym
+    params[param_name] || blacklight_config.facet_display[:hierarchy][prefix].first
   end
-  
-  %{<li class="#{li_class}">#{li.html_safe}#{ul.html_safe}</li>}.html_safe
-end
 
-def render_hierarchy(field)
-  prefix = field.field.split(/_/).first
-  tree = facet_tree(prefix)[field.field]
-  tree.keys.sort.collect do |key|
-    render_facet_hierarchy_item(field.field, tree[key], key)
-  end.join("\n").html_safe
-end
+  def facet_after(prefix, order)
+    orders = blacklight_config.facet_display[:hierarchy][prefix]
+    orders[orders.index(order)+1] || orders.first
+  end
 
-def render_qfacet_value(facet_solr_field, item, options ={})    
-  (link_to_unless(options[:suppress_link], item.value, add_facet_params(facet_solr_field, item.qvalue), :class=>"facet_select label") + " " + render_facet_count(item.hits)).html_safe
-end
+  # 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
+  end
+  
+  # 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
+  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 label") +
-    link_to("[remove]", remove_facet_params(facet_solr_field, item.qvalue, params), :class=>"remove")
+  # 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
 
-HierarchicalFacetItem = Struct.new :qvalue, :value, :hits
-def facet_tree(prefix)
-  @facet_tree ||= {}
-  if @facet_tree[prefix].nil?
-    @facet_tree[prefix] = {}
-    blacklight_config.facet_display[:hierarchy][prefix].each { |key|
-      facet_field = [prefix,key,'facet'].compact.join('_')
-      @facet_tree[prefix][facet_field] ||= {}
-      data = @response.facet_by_field_name(facet_field)
-      next if data.nil?
+  # 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
 
-      data.items.each { |facet_item|
-        path = facet_item.value.split(/\s*:\s*/)
-        loc = @facet_tree[prefix][facet_field]
-        while path.length > 0
-          loc = loc[path.shift] ||= {}
-        end
-        loc[:_] = HierarchicalFacetItem.new(facet_item.value, facet_item.value.split(/\s*:\s*/).last, facet_item.hits)
-      }
-    }
+      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
-  @facet_tree[prefix]
-end
 
 end

data/lib/blacklight/hierarchy.rb

@@ -1,6 +1,7 @@
-require 'blacklight/hierarchy/engine'
+require 'blacklight/hierarchy/version'
 
 module Blacklight
   module Hierarchy
+    require 'blacklight/hierarchy/engine'
   end
 end

data/lib/blacklight/hierarchy/engine.rb

@@ -1,3 +1,5 @@
+require 'blacklight'
+
 module Blacklight
   module Hierarchy
     class Engine < Rails::Engine

data/lib/blacklight/hierarchy/version.rb

@@ -1,5 +1,5 @@
 module Blacklight
   module Hierarchy
-    VERSION = "0.0.3"
+    VERSION = "0.1.0"
   end
 end

data/lib/generators/blacklight_hierarchy/install_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators'
+
+module BlacklightHierarchy
+  class Install < Rails::Generators::Base
+    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"
+    end
+  end
+end

data/lib/generators/blacklight_hierarchy/templates/blacklight_hierarchy.css.scss

@@ -0,0 +1,3 @@
+/*
+ *= require blacklight/hierarchy/hierarchy
+ */

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

@@ -0,0 +1 @@
+//= require blacklight/hierarchy/hierarchy