blacklight_facet_extras 0.0.1pre1

data/README.rdoc

@@ -0,0 +1,93 @@
+BlacklightFacetExtras: Blacklight plugin that exposes Solr facet parameters (range, query, tagging + exclusions, etc) to Blacklight
+
+= Description
+
+BlacklightFacetExtras adds some ugly parsing and manipulating to the Blacklight solr configuration and solr parameter parsing, but seems to get the job done, more or less.
+
+= Requirements
+
+A Rails app using the Blacklight plugin (tested against post-version 2.7). 
+
+= Installation
+
+This is a plugin, not a gem (because the structure was copied from existing plugins; in theory, it should be possible to make this a gem in the future).
+
+ A couple different ways to get the source into your vendor/plugins directory. 
+
+Go into your application directory, and run: 
+
+./script/plugin install git://github.com/cbeer/blacklight_facet_extras.git
+
+Later you can run ./script/plugin update blacklight_facet_extras if you like. 
+
+Requires git installed on your system. There are other ways to get the plugin in there too.
+
+OR
+cd $your_app/vendor/plugins
+git clone git://github.com/cbeer/blacklight_facet_extras.git 
+
+= Configuration
+
+config[:facets] = {
+   :field_names => [
+     "format",
+     "dc_date_year_i",
+     "timestamp_query",
+     "author"
+   ],
+   :labels => {
+     "format" => "display_partial",
+     "dc_date_year_i" => "Year",
+     "timestamp_query" => "Published"
+   }
+   :rangex => {
+     "dc_date_year_i" => {  # turns dc_date_year_i into a range facet
+       :start => 1940,
+       :end => 2010,
+       :gap => 10
+     }
+   },
+   :tag => {
+     "format" => {  # turns format into a OR'ed set of facets
+       :ex => "format"
+     }
+   },
+   :query => {
+     "timestamp_query" => { # the facet "Published" may contain two values, the results of these queries: 
+       'this week' => 'timestamp:[NOW-7DAY TO *]'
+       'this week' => 'timestamp:[NOW-1MONTH TO *]'
+     }
+   },
+   :pivot => {
+     "author" => ["author", "title"]
+   },
+   :filter => {
+     "subject" => lambda { |value| value =~ /--/ }, 
+     "date" => lambda { |value| Chronic.parse(value) rescue value }
+   }
+}
+
+== Injection
+
+This plugin assumes it is in a Blacklight Rails app, uses Blacklight methods, Rails methods, and standard ruby module includes to inject it's behaviors into the app.  
+
+You can turn off this injection if you like, although it will make the plugin less (or non-) functional unless you manually do similar injection. See lib/blacklight_facet_extras.rb#inject! to see exactly what's going on. 
+
+In any initializer, you can set:
+
+  BlacklightFacetExtras.omit_inject = true
+
+to turn off all injection. The plugin will be completely non-functional if you do this, of course. But perhaps you could try to re-use some of it's classes in a non-Blacklight, highly hacked Blacklight, or even non-Rails application this way. 
+
+You can also turn off injection of individual components, which could be more useful:
+   
+  BlacklightFacetExtras.omit_inject = {
+    :view_helpers => false,
+    :controller_mixin => false
+  }
+
+= Tests
+
+There are none. This is bad I know, sorry. 
+
+

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1pre1

data/app/views/catalog/_facet_limit.html.erb

@@ -0,0 +1,35 @@
+<%-  # required to pass in local :solr_field
+     # optional :display_heading parameter, sometimes set to false
+     #     by plugins that might re-use this inside something else. 
+     display_heading = true unless local_assigns.has_key?(:display_heading)
+-%>
+   
+    <% display_facet = facet_values_for(solr_field) %>
+      <% if display_facet && display_facet.items.length > 0 %>
+        <% if display_heading %>
+          <h3><%= facet_field_labels[solr_field] -%></h3>
+        <% end %>
+        <ul>
+         <% paginator =
+              Blacklight::Solr::FacetPaginator.new(display_facet.items,
+                :limit => facet_limit_for(solr_field))
+          %>
+
+          <% paginator.items.each do |item| -%>
+            <li>
+            <% if facet_in_params?( solr_field, item.value ) %>
+                <%= render_selected_facet_value(solr_field, item) %>
+              <% else %>
+                <%= render_facet_value(solr_field, item) %>
+            <% end -%>
+            </li>
+
+          <% end %>
+
+          <% if(paginator.has_next?)  %>
+            <li class="more_facets_link"><%= link_to('more »', params.merge(:id => solr_field, :action=>"facet"), :class => "more_facets_link") %></li>
+          <% end %>
+
+        </ul>
+
+      <% end %>

data/app/views/catalog/_facet_partials/_pivot.html.erb

@@ -0,0 +1,47 @@
+<%-  # required to pass in local :solr_field
+     # optional :display_heading parameter, sometimes set to false
+     #     by plugins that might re-use this inside something else. 
+     display_heading = true unless local_assigns.has_key?(:display_heading)
+-%>
+   
+   <% display_facet = solr_pivot_to_a(solr_field) %>
+      <% if display_facet && display_facet.items.length > 0 %>
+        <% if display_heading %>
+          <h3><%= facet_field_labels[solr_field] -%></h3>
+        <% end %>
+        <ul>
+          <% paginator =    
+              Blacklight::Solr::FacetPaginator.new(display_facet.items,        
+                :limit => facet_limit_for(solr_field))
+          %>
+          <% paginator.items.each do |item| -%>
+            <li>
+            <% if facet_in_params?( solr_field, item.value ) %>              
+                <%= render_selected_facet_value(solr_field, item) %>              
+              <% else %>              
+                <%= render_facet_value(solr_field, item) %>              
+            <% end -%>
+
+             <% if item.facets.length > 0 %>
+            <ul>
+               <% item.facets.each do |pivot| %>
+                 <li>
+            <% if facet_in_params?( pivot.field, pivot.value ) %>              
+                <%= render_selected_facet_value(pivot.field, pivot) %>              
+              <% else %>              
+                <%= render_facet_value(pivot.field, pivot) %>              
+            <% end -%>
+          </li>
+               <% end %>
+          </ul>
+             <% end %>  
+            </li>
+          <% end %>
+          
+          <% if(paginator.has_next?)  %>
+            <li class="more_facets_link"><%= link_to('more »', params.merge(:id => solr_field, :action=>"facet"), :class => "more_facets_link") %></li>
+          <% end %>
+          
+        </ul>
+      <% end %>
+   

data/app/views/catalog/_facet_partials/_query.html.erb

@@ -0,0 +1,35 @@
+<%-  # required to pass in local :solr_field
+     # optional :display_heading parameter, sometimes set to false
+     #     by plugins that might re-use this inside something else. 
+     display_heading = true unless local_assigns.has_key?(:display_heading)
+-%>
+   
+    <% display_facet = solr_query_to_a(solr_field) %>
+      <% if display_facet && display_facet.items.length > 0 %>
+        <% if display_heading %>
+          <h3><%= facet_field_labels[solr_field] -%></h3>
+        <% end %>
+        <ul>
+         <% paginator =
+              Blacklight::Solr::FacetPaginator.new(display_facet.items,
+                :limit => facet_limit_for(solr_field))
+          %>
+
+          <% paginator.items.each do |item| -%>
+            <li>
+            <% if facet_in_params?( solr_field, item.value ) %>
+                <%= render_selected_facet_value(solr_field, item) %>
+              <% else %>
+                <%= render_facet_value(solr_field, item) %>
+            <% end -%>
+            </li>
+
+          <% end %>
+
+          <% if(paginator.has_next?)  %>
+            <li class="more_facets_link"><%= link_to('more »', params.merge(:id => solr_field, :action=>"facet"), :class => "more_facets_link") %></li>
+          <% end %>
+
+        </ul>
+
+      <% end %>

data/app/views/catalog/_facet_partials/_range.html.erb

@@ -0,0 +1,40 @@
+<%-  # required to pass in local :solr_field
+     # optional :display_heading parameter, sometimes set to false
+     #     by plugins that might re-use this inside something else. 
+     display_heading = true unless local_assigns.has_key?(:display_heading)
+-%>
+   
+    <% display_facet = solr_range_to_a(solr_field) %>
+      <% if (display_facet && display_facet.items.length > 0) or (params[:f] and params[:f][solr_field]) %>
+        <% if display_heading %>
+          <h3><%= facet_field_labels[solr_field] -%></h3>
+        <% end %>
+        <ul>
+         <% paginator =
+              Blacklight::Solr::FacetPaginator.new(display_facet.items,
+                :limit => facet_limit_for(solr_field))
+          %>
+
+          <% params[:f][solr_field].select { |x| x =~ /\[(\d+) TO (\d+)\]/ }.map { |x| r = x.scan(/\[(\d+) TO (\d+)\]/).first; BlacklightFacetExtras::Range::FacetItem.new("#{r.first} - #{r.last}", @response.total, { :from => r.first, :to => r.last}) }.each do |item| -%>
+            <li>
+              <%= render_selected_facet_value(solr_field, item) %>
+            </li>
+          <% end if params[:f] and params[:f][solr_field] -%>
+          <% paginator.items.each do |item| -%>
+            <li>
+            <% if facet_in_params?( solr_field, item.value ) %>
+                <%= render_selected_facet_value(solr_field, item) %>
+              <% else %>
+                <%= render_facet_value(solr_field, item) %>
+            <% end -%>
+            </li>
+
+          <% end %>
+
+          <% if(paginator.has_next?)  %>
+            <li class="more_facets_link"><%= link_to('more »', params.merge(:id => solr_field, :action=>"facet"), :class => "more_facets_link") %></li>
+          <% end %>
+
+        </ul>
+
+      <% end %>

data/app/views/catalog/_hierarchical_constraints_element.html.erb

@@ -0,0 +1,39 @@
+<%- # local params:
+    # label 
+    # value
+    # options =>
+    #   :remove => url for a remove constraint link
+    #   :classes => array of classes to add to container span
+    options ||= {}
+    options[:escape_label] = true unless options.has_key?(:escape_label)
+    options[:escape_value] = true unless options.has_key?(:escape_value)
+-%>
+
+<span class="appliedFilter constraint <%= options[:classes].join(" ") if options[:classes] %>">
+      <%- unless label.blank? -%>
+        <span class="filterName"><%= options[:escape_label] ? h(label) : label %></span> 
+      <%- end -%>
+
+      <% asdf = [] %>
+      <% value.split("/").each do |v| %>
+      <%- unless v.blank? -%>
+        <span class="filterValue"><%= options[:escape_value] ? h(v) : v %></span>
+      <%- end -%>
+      <%- unless options[:remove].blank? -%>
+        <% accessible_remove_label =               
+                if label.blank?
+                  "Remove constraint #{options[:escape_value] ? h(v) : v}"
+                else
+                  "Remove constraint #{options[:escape_value] ? h(v) : v}: #{options[:escape_value] ? h(v) : v}"
+                end              
+        %>                
+        <%= link_to(accessible_remove_label,
+                                                                options[:remove].gsub(/=(#{Regexp.escape(CGI::escape(asdf.join("/")))})[^&]+/, "=#{CGI::escape(asdf.join("/"))}"), # FIXME: Ugh.
+					:class=>'btnRemove imgReplace',
+          :alt=>'remove'
+                   ) %>
+        <% asdf << v %>
+                 <% end %>
+      <%- end -%>
+</span>
+

data/blacklight_facet_extras.gemspec

@@ -0,0 +1,24 @@
+ # -*- coding: utf-8 -*-
+require File.join(File.dirname(__FILE__), "lib/blacklight_facet_extras/version")
+
+Gem::Specification.new do |s|
+  s.name = "blacklight_facet_extras"
+  s.version = BlacklightFacetExtras::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Chris Beer"]
+  s.email = ["chris_beer@wgbh.org"]
+  s.homepage    = "http://projectblacklight.org/"
+  s.summary = "Blacklight facet extras plugin"
+
+  s.rubyforge_project = "blacklight"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+
+  s.add_dependency "rails", "~> 3.0"
+  s.add_dependency "blacklight"
+end
+

data/lib/blacklight_facet_extras/controller_extension.rb

@@ -0,0 +1,9 @@
+module BlacklightFacetExtras::ControllerExtension
+  def self.included(some_class)
+    some_class.helper_method :blacklight_facet_config
+    some_class.helper BlacklightFacetExtras::ViewHelperExtension
+  end
+    def blacklight_facet_config(solr_field)
+      {}
+    end
+end

data/lib/blacklight_facet_extras/engine.rb

@@ -0,0 +1,14 @@
+require 'blacklight'
+require 'blacklight_facet_extras'
+require 'rails'
+
+module BlacklightFacetExtras
+  class Engine < Rails::Engine
+    config.to_prepare do
+      unless BlacklightFacetExtras.omit_inject[:routes]
+        Blacklight::Routes.send(:include, BlacklightFacetExtras::RouteSets)
+      end
+    end
+  end
+end
+

data/lib/blacklight_facet_extras/facet_item.rb

@@ -0,0 +1,11 @@
+module BlacklightFacetExtras
+  class FacetItem < RSolr::Ext::Response::Facets::FacetItem 
+    attr_accessor :display_label
+
+    def initialize value, hits, opts = {}
+      super(value, hits)
+      @display_label = opts[:display_label] || value
+    end
+
+  end
+end

data/lib/blacklight_facet_extras/filter/controller_extension.rb

@@ -0,0 +1,19 @@
+# Meant to be applied on top of a controller that implements
+# Blacklight::SolrHelper. Will inject filter limiting behaviors
+# to solr parameters creation. 
+module BlacklightFacetExtras::Filter::ControllerExtension
+  def self.included(some_class)
+    some_class.send :include,BlacklightFacetExtras::ControllerExtension
+    some_class.helper_method :facet_filter_config
+    some_class.helper BlacklightFacetExtras::Filter::ViewHelperExtension
+  end
+    def facet_filter_config(solr_field)
+      config = blacklight_filter_config[solr_field] || false
+      config = {} if config == true
+      config
+    end
+
+    def blacklight_filter_config
+      Blacklight.config[:facet][:filter] || {}
+    end
+end

data/lib/blacklight_facet_extras/filter/view_helper_extension.rb

@@ -0,0 +1,18 @@
+module BlacklightFacetExtras::Filter::ViewHelperExtension
+  def facet_values_for(solr_field)
+    config = facet_filter_config(solr_field)
+    facet_field = super(solr_field)
+    return facet_field unless config
+
+    items = facet_field.items.map do  |i|
+      value = config.call(i.value)
+      value = i.value if value === true
+      next unless value
+      BlacklightFacetExtras::FacetItem.new(i.value, i.hits, :display_label => value)
+    end
+
+    facet_field.items.replace(items)
+
+    facet_field
+  end
+end

data/lib/blacklight_facet_extras/filter.rb

@@ -0,0 +1,4 @@
+module BlacklightFacetExtras::Filter
+  autoload :ControllerExtension, 'blacklight_facet_extras/filter/controller_extension'
+  autoload :ViewHelperExtension, 'blacklight_facet_extras/filter/view_helper_extension'
+end

data/lib/blacklight_facet_extras/hierarchy/controller_extension.rb

@@ -0,0 +1,39 @@
+# Meant to be applied on top of a controller that implements
+# Blacklight::SolrHelper. Will inject hierarchy limiting behaviors
+# to solr parameters creation. 
+module BlacklightFacetExtras::Hierarchy::ControllerExtension
+  def self.included(some_class)
+    some_class.send :include,BlacklightFacetExtras::ControllerExtension
+    some_class.helper_method :facet_hierarchy_config
+    some_class.helper_method :blacklight_hierarchy_config
+    some_class.solr_search_params_logic << :add_hierarchy_facets_to_solr
+    some_class.helper BlacklightFacetExtras::Hierarchy::ViewHelperExtension
+  end
+  def add_hierarchy_facets_to_solr(solr_parameters, user_parameters)
+    blacklight_hierarchy_config.each do |k, config|
+
+      fq = (solr_parameters[:fq] || []).select { |x| x.starts_with? "{!raw f=#{k}}" }.first.to_s
+
+      value = fq.gsub("{!raw f=#{k}}", "")
+      solr_parameters[:fq].delete(fq)
+
+      if value.blank?
+        solr_parameters[:"f.#{k}.facet.prefix"] ||= "1/" 
+      else
+        solr_parameters[:fq] << "{!raw f=#{k}}#{value.count("/") + 1}/#{value}"
+        solr_parameters[:"f.#{k}.facet.prefix"] ||= "#{value.count("/") + 2}/#{value}/"
+      end
+    end
+
+    solr_parameters
+  end
+    def facet_hierarchy_config(solr_field)
+      config = blacklight_hierarchy_config[solr_field] || false
+      config = {} if config == true
+      config
+    end
+
+    def blacklight_hierarchy_config
+      Blacklight.config[:facet][:hierarchy] || {}
+    end
+end

data/lib/blacklight_facet_extras/hierarchy/view_helper_extension.rb

@@ -0,0 +1,43 @@
+module BlacklightFacetExtras::Hierarchy::ViewHelperExtension
+  def facet_values_for(solr_field)
+    config = facet_hierarchy_config(solr_field)
+    facet_field = super(solr_field)
+    return facet_field unless config
+
+    items = facet_field.items.map do  |i|
+      value = i.value.split('/').last
+      BlacklightFacetExtras::FacetItem.new(i.value.split("/", 2).last, i.hits, :display_label => value)
+    end
+
+    facet_field.items.replace(items)
+
+    facet_field
+  end
+
+  def add_facet_params field, value
+    p = super(field, value) 
+    p[:f][field] = [p[:f][field].last] if facet_hierarchy_config(field)
+    p  
+  end
+
+  def remove_facet_params(field, value, source_params=params)
+    p = super(field, value, source_params) 
+
+    if facet_hierarchy_config(field)
+      hierarchy = value.split("/")
+      hierarchy.pop
+      unless hierarchy.empty?
+        p[:f][field] ||= []
+        p[:f][field] << hierarchy.join("/") 
+      end
+    end
+    p
+  end
+
+  def render_constraint_element(label, value, options = {})
+    return super(label, value, options) unless options[:classes].any? { |x| blacklight_hierarchy_config.keys.map { |y| "filter-#{y.parameterize}" }.include? x }
+
+    return ''.html_safe if value.blank?
+    render(:partial => "catalog/hierarchical_constraints_element", :locals => {:label => label, :value => value, :options => options})
+  end
+end

data/lib/blacklight_facet_extras/hierarchy.rb

@@ -0,0 +1,6 @@
+module BlacklightFacetExtras
+  module Hierarchy
+    autoload :ControllerExtension, 'blacklight_facet_extras/hierarchy/controller_extension'
+    autoload :ViewHelperExtension, 'blacklight_facet_extras/hierarchy/view_helper_extension'
+  end
+end

data/lib/blacklight_facet_extras/pivot/controller_extension.rb

@@ -0,0 +1,35 @@
+
+# Meant to be applied on top of a controller that implements
+# Blacklight::SolrHelper. Will inject pivot limiting behaviors
+# to solr parameters creation. 
+module BlacklightFacetExtras::Pivot::ControllerExtension
+  def self.included(some_class)
+    some_class.send :include,BlacklightFacetExtras::ControllerExtension
+    some_class.helper_method :facet_pivot_config
+    some_class.solr_search_params_logic << :add_pivot_facets_to_solr
+    some_class.helper BlacklightFacetExtras::Pivot::ViewHelperExtension
+  end
+  def add_pivot_facets_to_solr(solr_parameters, user_parameters)
+
+    blacklight_pivot_config.each do |k, config|
+      solr_parameters[:"facet.field"].select { |x| x == k }.each do |x|
+        solr_parameters[:"facet.field"].delete x
+      end if solr_parameters[:"facet.field"]
+
+      solr_parameters[:"facet.pivot"] ||= []
+      solr_parameters[:"facet.pivot"] << config.join(",")
+    end
+
+    solr_parameters
+  end
+
+    def facet_pivot_config(solr_field)
+      config = blacklight_pivot_config[solr_field] || false
+      config = {} if config == true
+      config
+    end
+
+    def blacklight_pivot_config
+      Blacklight.config[:facet][:pivot] || {}
+    end
+end

data/lib/blacklight_facet_extras/pivot/view_helper_extension.rb

@@ -0,0 +1,53 @@
+module BlacklightFacetExtras::Pivot::ViewHelperExtension
+
+    def render_facet_limit(solr_field)
+      config = facet_pivot_config(solr_field)
+      if ( config )
+        render(:partial => "catalog/_facet_partials/pivot", :locals=> {:solr_field => solr_field })
+      else
+        super(solr_field)
+      end
+    end
+    def solr_pivot_to_a(solr_field)
+      config = facet_pivot_config(solr_field)
+      return RSolr::Ext::Response::Facets::FacetField.new(solr_field, []) unless config and @response and @response["facet_counts"] and @response["facet_counts"]["facet_pivot"] and @response["facet_counts"]["facet_pivot"]
+
+      arr = []
+      pivot_field = config.join(",")
+
+      data = @response["facet_counts"]["facet_pivot"][pivot_field]
+      return RSolr::Ext::Response::Facets::FacetField.new(solr_field, []) unless data
+
+      data.each do |parent|
+        item = BlacklightFacetExtras::Pivot::FacetItem.new(parent['value'], parent['count'], :field => solr_field)
+
+        item.facets ||= []
+        parent['pivot'].each do |child|
+          label = child['value'].split(" / ").last
+
+
+          item.facets << BlacklightFacetExtras::Pivot::FacetItem.new(child['value'], child['count'], :display_label => label, :field => child['field'], :parent => item)
+        end
+
+
+        arr << item
+      end
+
+      RSolr::Ext::Response::Facets::FacetField.new(solr_field, arr)
+    end
+
+    def render_facet_value(facet_solr_field, item, options ={})
+      if item.is_a? BlacklightFacetExtras::Pivot::FacetItem
+        p = add_facet_params_and_redirect(item.field || facet_solr_field, item.value)
+
+        if item.parent
+          p[:f][item.parent.field] ||= []
+          p[:f][item.parent.field].push(item.parent.value)
+        end
+
+        (link_to_unless(options[:suppress_link], item.display_label || item.value , p, :class=>"facet_select label") + " " + render_facet_count(item.hits)).html_safe
+      else
+        super(facet_solr_field, item, options ={})
+      end
+    end
+end

data/lib/blacklight_facet_extras/pivot.rb

@@ -0,0 +1,19 @@
+module BlacklightFacetExtras::Pivot
+    autoload :ControllerExtension, 'blacklight_facet_extras/pivot/controller_extension'
+    autoload :ViewHelperExtension, 'blacklight_facet_extras/pivot/view_helper_extension'
+  class FacetItem <  RSolr::Ext::Response::Facets::FacetItem
+    attr_accessor :display_label
+    attr_accessor :facets
+    attr_accessor :field
+    attr_accessor :parent
+
+    def initialize value, hits, opts = {}
+      super(value, hits)
+      @display_label = opts[:display_label]
+      @field = opts[:field]
+      @parent = opts[:parent]
+      @facets = opts[:facets]
+    end
+  end
+
+end

data/lib/blacklight_facet_extras/query/controller_extension.rb

@@ -0,0 +1,41 @@
+
+# Meant to be applied on top of a controller that implements
+# Blacklight::SolrHelper. Will inject query limiting behaviors
+# to solr parameters creation. 
+module BlacklightFacetExtras::Query::ControllerExtension
+  def self.included(some_class)
+    some_class.send :include,BlacklightFacetExtras::ControllerExtension
+    some_class.solr_search_params_logic << :add_query_facets_to_solr
+    some_class.helper_method :facet_query_config
+    some_class.helper BlacklightFacetExtras::Query::ViewHelperExtension
+  end
+  def add_query_facets_to_solr(solr_parameters, user_parameters)
+    blacklight_query_config.each do |k, config|
+      solr_parameters[:fq].select { |x| x.starts_with?("{!raw f=#{k}}") }.each do |x|
+        v = solr_parameters[:fq].delete x
+        value = v.gsub("{!raw f=#{k}}", "")
+        value = config[value] if config[value]                  
+        solr_parameters[:fq] << value
+      end if solr_parameters[:fq]
+
+      solr_parameters[:"facet.field"].select { |x| x == k }.each do |x|
+        solr_parameters[:"facet.field"].delete x
+      end if solr_parameters[:"facet.field"]
+
+      solr_parameters[:"facet.query"] ||= []
+      config.each do |label, query|
+        solr_parameters[:"facet.query"] << query
+      end
+    end
+  end
+
+    def facet_query_config(solr_field)
+      config = blacklight_query_config[solr_field] || false
+      config = {} if config == true
+      config
+    end
+
+    def blacklight_query_config
+      Blacklight.config[:facet][:query] || {}
+    end
+end

data/lib/blacklight_facet_extras/query/view_helper_extension.rb

@@ -0,0 +1,24 @@
+module BlacklightFacetExtras::Query::ViewHelperExtension
+
+    def render_facet_limit(solr_field)
+      config = facet_query_config(solr_field)
+      if ( config )
+        render(:partial => "catalog/_facet_partials/query", :locals=> {:solr_field => solr_field })
+      else
+        super(solr_field)
+      end
+    end
+
+    def solr_query_to_a(solr_field)
+      config = facet_query_config(solr_field)
+      return RSolr::Ext::Response::Facets::FacetField.new(solr_field, []) unless config and @response and @response["facet_counts"] and @response["facet_counts"]["facet_queries"] and @response["facet_counts"]["facet_queries"]
+
+      arr = []
+      config.each do |display_label, query|
+        next unless @response["facet_counts"]["facet_queries"][query] and @response["facet_counts"]["facet_queries"][query] > 0 and  @response["facet_counts"]["facet_queries"][query] < @response.total
+        arr <<  RSolr::Ext::Response::Facets::FacetItem.new(display_label,@response["facet_counts"]["facet_queries"][query])
+      end
+
+      RSolr::Ext::Response::Facets::FacetField.new(solr_field, arr)
+    end
+end

data/lib/blacklight_facet_extras/query.rb

@@ -0,0 +1,4 @@
+module BlacklightFacetExtras::Query
+    autoload :ControllerExtension, 'blacklight_facet_extras/query/controller_extension'
+    autoload :ViewHelperExtension, 'blacklight_facet_extras/query/view_helper_extension'
+end

data/lib/blacklight_facet_extras/range/controller_extension.rb

@@ -0,0 +1,43 @@
+
+# Meant to be applied on top of a controller that implements
+# Blacklight::SolrHelper. Will inject range limiting behaviors
+# to solr parameters creation. 
+module BlacklightFacetExtras::Range::ControllerExtension
+  def self.included(some_class)
+    some_class.send :include,BlacklightFacetExtras::ControllerExtension
+    some_class.solr_search_params_logic << :add_range_facets_to_solr
+    some_class.helper_method :facet_range_config
+    some_class.helper BlacklightFacetExtras::Range::ViewHelperExtension
+  end
+  def add_range_facets_to_solr(solr_parameters, user_parameters)
+    solr_parameters['facet.range.other'] = 'all'
+    blacklight_range_config.each do |k, config|
+      solr_parameters['facet.range'] = k
+
+      solr_parameters[:fq] ||= []
+      fq = solr_parameters[:fq].select { |x| x.starts_with?("{!raw f=#{k}}") and x =~ /\[.* TO .*\]/ }.map { |x| solr_parameters[:fq].delete(x) }.map { |x| x.gsub("{!raw f=#{k}}", "") }.map { |x| x.scan(/\[(.*) TO (.*)\]/).first }
+
+      range_start = fq.map { |x| x.first }.max
+      range_end = fq.map { |x| x.last }.min
+      range_gap = ((range_end.to_i - range_start.to_i) / (facet_limit_for(k) || 10)) if range_start and range_end
+
+
+      solr_parameters["f.#{k}.facet.range.start"] = range_start || config[:start]
+      solr_parameters["f.#{k}.facet.range.end"] = range_end || config[:end]
+      solr_parameters["f.#{k}.facet.range.gap"] = range_gap || config[:gap]
+      solr_parameters["f.#{k}.facet.mincount"] = config[:mincount] if config[:mincount]
+
+      solr_parameters[:fq] << "#{k}:[#{range_start} TO #{range_end}]" if range_start and range_end
+    end
+  end
+
+    def facet_range_config(solr_field)
+      config = blacklight_range_config[solr_field] || false
+      config = {} if config == true
+      config
+    end
+
+    def blacklight_range_config
+      Blacklight.config[:facet][:rangex] || {}
+    end
+end

data/lib/blacklight_facet_extras/range/view_helper_extension.rb

@@ -0,0 +1,39 @@
+module BlacklightFacetExtras::Range::ViewHelperExtension
+
+    def render_facet_limit(solr_field)
+      config = facet_range_config(solr_field)
+      if ( config )
+        render(:partial => "catalog/_facet_partials/range", :locals=> {:solr_field => solr_field })
+      else
+        super(solr_field)
+      end
+    end
+    def solr_range_to_a(solr_field)
+      config = facet_range_config(solr_field)
+      return RSolr::Ext::Response::Facets::FacetField.new(solr_field,[]) unless config and @response and @response["facet_counts"] and @response["facet_counts"]["facet_ranges"] and @response["facet_counts"]["facet_ranges"][solr_field]
+
+      data = @response["facet_counts"]["facet_ranges"][solr_field]
+
+      arr = []
+
+      arr << BlacklightFacetExtras::Range::FacetItem.new("before", data[:before], :from => '*', :to => data[:start]) if data[:before] > 0
+
+      last = 0
+      range = data[:counts].each_slice(2).map { |value, hits| BlacklightFacetExtras::Range::FacetItem.new(value,hits) }
+
+      if range.length > 1
+      
+      range.each_cons(2) do |item, peek| 
+        item.from = item.value
+        item.to = peek.value
+        item.display_label = "#{item.from} - #{item.to}"
+        arr << item
+      end
+
+      arr << range.last.tap { |x| x.from = x.value; x.to = data[:end]; x.display_label = "#{x.from} - #{x.to}" }
+      end
+
+      arr << BlacklightFacetExtras::Range::FacetItem.new("after", data[:after], :from => data[:end], :to => '*') if data[:after] > 0
+      RSolr::Ext::Response::Facets::FacetField.new(solr_field, arr)
+    end
+end

data/lib/blacklight_facet_extras/range.rb

@@ -0,0 +1,19 @@
+module BlacklightFacetExtras::Range
+    autoload :ControllerExtension, 'blacklight_facet_extras/range/controller_extension'
+    autoload :ViewHelperExtension, 'blacklight_facet_extras/range/view_helper_extension'
+  class FacetItem <  BlacklightFacetExtras::FacetItem
+    attr_accessor :from, :to
+
+    def initialize value, hits, opts = {}
+      super(value, hits, opts = {})
+      @from = opts[:from]
+      @to = opts[:to]
+    end
+
+    def value
+      return"[#{self.from} TO #{self.to}]" if self.from and self.to
+      super
+    end
+  end
+
+end

data/lib/blacklight_facet_extras/route_sets.rb

@@ -0,0 +1,3 @@
+module BlacklightFacetExtras::RouteSets
+
+end

data/lib/blacklight_facet_extras/tag/controller_extension.rb

@@ -0,0 +1,41 @@
+
+# Meant to be applied on top of a controller that implements
+# Blacklight::SolrHelper. Will inject tag limiting behaviors
+# to solr parameters creation. 
+module BlacklightFacetExtras::Tag::ControllerExtension
+  def self.included(some_class)
+    some_class.send :include,BlacklightFacetExtras::ControllerExtension
+    some_class.solr_search_params_logic << :add_tag_facets_to_solr
+    some_class.helper_method :facet_tag_config
+    some_class.helper BlacklightFacetExtras::Tag::ViewHelperExtension
+  end
+  def add_tag_facets_to_solr(solr_parameters, user_parameters)
+    blacklight_tag_config.each do |k, config|
+
+
+      values = []
+      if solr_parameters[:fq]
+        solr_parameters[:fq].select { |x| x.starts_with?("{!raw f=#{k}}") }.each do |x|
+          values << solr_parameters[:fq].delete(x)
+        end 
+        solr_parameters[:fq] << "{!tag=#{config[:ex]}} #{values.map { |x| "_query_:\"#{x}\""}.join(" OR ") }" unless values.empty?
+      end
+
+      solr_parameters[:"facet.field"].each_with_index.select { |value, index| value == k }.each do |value, index|
+        solr_parameters[:"facet.field"][index] = "{!ex=#{config[:ex]}}#{value}"
+      end if solr_parameters[:"facet.field"]
+    end
+
+    solr_parameters
+  end
+
+    def facet_tag_config(solr_field)
+      config = blacklight_tag_config[solr_field] || false
+      config = {} if config == true
+      config
+    end
+
+    def blacklight_tag_config
+      Blacklight.config[:facet][:tag] || {}
+    end
+end

data/lib/blacklight_facet_extras/tag/view_helper_extension.rb

@@ -0,0 +1,3 @@
+module BlacklightFacetExtras::Tag::ViewHelperExtension
+
+end

data/lib/blacklight_facet_extras/tag.rb

@@ -0,0 +1,4 @@
+module BlacklightFacetExtras::Tag
+  autoload :ControllerExtension, 'blacklight_facet_extras/tag/controller_extension'
+  autoload :ViewHelperExtension, 'blacklight_facet_extras/tag/view_helper_extension'
+end

data/lib/blacklight_facet_extras/version.rb

@@ -0,0 +1,10 @@
+module BlacklightFacetExtras
+  unless BlacklightFacetExtras.const_defined? :VERSION
+    def self.version
+      @version ||= File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).chomp
+    end
+
+    VERSION = self.version
+  end
+end
+

data/lib/blacklight_facet_extras/view_helper_extension.rb

@@ -0,0 +1,14 @@
+module BlacklightFacetExtras::ViewHelperExtension
+  def render_facet_value(facet_solr_field, item, options ={})
+    if item.respond_to? :display_label
+      (link_to_unless(options[:suppress_link], item.display_label || item.value , add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select label") + " " + render_facet_count(item.hits)).html_safe
+    else
+      super(facet_solr_field, item, options ={})
+    end
+  end
+
+  def facet_values_for(solr_field)
+    @response.facets.detect {|f| f.name == solr_field}
+  end
+end
+

data/lib/blacklight_facet_extras.rb

@@ -0,0 +1,34 @@
+# BlacklightFacetExtras
+
+module BlacklightFacetExtras
+  autoload :ControllerExtension, 'blacklight_facet_extras/controller_extension'
+  autoload :ViewHelperExtension, 'blacklight_facet_extras/view_helper_extension'
+  autoload :RouteSets, 'blacklight_facet_extras/route_sets'
+
+  autoload :FacetItem, 'blacklight_facet_extras/facet_item'
+  autoload :Filter, 'blacklight_facet_extras/filter'
+  autoload :Hierarchy, 'blacklight_facet_extras/hierarchy'
+  autoload :Pivot, 'blacklight_facet_extras/pivot'
+  autoload :Range, 'blacklight_facet_extras/range'
+  autoload :Query, 'blacklight_facet_extras/query'
+  autoload :Tag, 'blacklight_facet_extras/tag'
+
+  require 'blacklight_facet_extras/version'
+  require 'blacklight_facet_extras/engine'
+
+  @omit_inject = {}
+  def self.omit_inject=(value)
+    value = Hash.new(true) if value == true
+    @omit_inject = value      
+  end
+  def self.omit_inject ; @omit_inject ; end
+  
+  def self.inject!
+  end
+
+  # Add element to array only if it's not already there
+  def self.safe_arr_add(array, element)
+    array << element unless array.include?(element)
+  end
+  
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: blacklight_facet_extras
+version: !ruby/object:Gem::Version
+  version: 0.0.1pre1
+  prerelease: 5
+platform: ruby
+authors:
+- Chris Beer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-06 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2153125440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153125440
+- !ruby/object:Gem::Dependency
+  name: blacklight
+  requirement: &2153124860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153124860
+description: 
+email:
+- chris_beer@wgbh.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.rdoc
+- Rakefile
+- VERSION
+- app/views/catalog/_facet_limit.html.erb
+- app/views/catalog/_facet_partials/_pivot.html.erb
+- app/views/catalog/_facet_partials/_query.html.erb
+- app/views/catalog/_facet_partials/_range.html.erb
+- app/views/catalog/_hierarchical_constraints_element.html.erb
+- assets/javascripts/blacklight_facet_extras.js
+- assets/stylesheets/blacklight_facet_extras.css
+- blacklight_facet_extras.gemspec
+- lib/blacklight_facet_extras.rb
+- lib/blacklight_facet_extras/controller_extension.rb
+- lib/blacklight_facet_extras/engine.rb
+- lib/blacklight_facet_extras/facet_item.rb
+- lib/blacklight_facet_extras/filter.rb
+- lib/blacklight_facet_extras/filter/controller_extension.rb
+- lib/blacklight_facet_extras/filter/view_helper_extension.rb
+- lib/blacklight_facet_extras/hierarchy.rb
+- lib/blacklight_facet_extras/hierarchy/controller_extension.rb
+- lib/blacklight_facet_extras/hierarchy/view_helper_extension.rb
+- lib/blacklight_facet_extras/pivot.rb
+- lib/blacklight_facet_extras/pivot/controller_extension.rb
+- lib/blacklight_facet_extras/pivot/view_helper_extension.rb
+- lib/blacklight_facet_extras/query.rb
+- lib/blacklight_facet_extras/query/controller_extension.rb
+- lib/blacklight_facet_extras/query/view_helper_extension.rb
+- lib/blacklight_facet_extras/range.rb
+- lib/blacklight_facet_extras/range/controller_extension.rb
+- lib/blacklight_facet_extras/range/view_helper_extension.rb
+- lib/blacklight_facet_extras/route_sets.rb
+- lib/blacklight_facet_extras/tag.rb
+- lib/blacklight_facet_extras/tag/controller_extension.rb
+- lib/blacklight_facet_extras/tag/view_helper_extension.rb
+- lib/blacklight_facet_extras/version.rb
+- lib/blacklight_facet_extras/view_helper_extension.rb
+has_rdoc: true
+homepage: http://projectblacklight.org/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: blacklight
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Blacklight facet extras plugin
+test_files: []