blacklight 3.0.0 → 3.1.0

data/VERSION

@@ -1 +1 @@
-3.0.0
+3.1.0

data/app/helpers/blacklight_helper.rb

@@ -6,111 +6,14 @@
 module BlacklightHelper
   include HashAsHiddenFields
   include RenderConstraintsHelper
+  include HtmlHeadHelper
+  include FacetsHelper
 
   
   def application_name
     'Blacklight'
   end
 
-  ##
-  # This method should be included in any Blacklight layout, including
-  # custom ones. It will output results of #render_js_includes,
-  # #render_stylesheet_includes, and all the content of 
-  # current_controller#extra_head_content.
-  #
-  # Uses controller methods #extra_head_content, #javascript_includes,
-  # and #stylesheet_links to find content. Tolerates it if those
-  # methods don't exist, silently skipping. 
-  #
-  # By a layout outputting this in html HEAD, it provides an easy way for
-  # local config or extra plugins to add HEAD content.
-  # 
-  # Add your own css or remove the defaults by simply editing
-  # controller.stylesheet_links, controller.javascript_includes,
-  # or controller.extra_head_content. 
-  #
-  # 
-  #
-  # in an initializer or other startup file (plugin init.rb?):
-  #
-  # == Apply to all actions in all controllers:
-  # 
-  #   ApplicationController.before_filter do |controller|
-  #     # remove default jquery-ui theme.
-  #     controller.stylesheet_links.each do |args|
-  #       args.delete_if {|a| a =~ /^|\/jquery-ui-[\d.]+\.custom\.css$/ }
-  #     end
-  # 
-  #     # add in a different jquery-ui theme, or any other css or what have you
-  #     controller.stylesheet_links << 'my_css.css'
-  #
-  #     controller.javascript_includes << "my_local_behaviors.js"
-  #
-  #     controller.extra_head_content << '<link rel="something" href="something">'
-  #   end
-  #
-  # == Apply to a particular action in a particular controller:
-  #
-  #   CatalogController.before_filter :only => :show |controller|
-  #     controller.extra_head_content << '<link rel="something" href="something">'
-  #   end
-  #
-  # == Or in a view file that wants to add certain header content? no problem:
-  #
-  #   <%  stylesheet_links << "mystylesheet.css" %>
-  #   <%  javascript_includes << "my_js.js" %>
-  #   <%  extra_head_content << capture do %>
-  #       <%= tag :link, { :href => some_method_for_something, :rel => "alternate" } %> 
-  #   <%  end %>
-  #
-  # == Full power of javascript_include_tag and stylesheet_link_tag
-  # Note that the elements added to stylesheet_links and javascript_links
-  # are arguments to Rails javascript_include_tag and stylesheet_link_tag
-  # respectively, you can pass complex arguments. eg:
-  #
-  # stylesheet_links << ["stylesheet1.css", "stylesheet2.css", {:cache => "mykey"}]
-  # javascript_includes << ["myjavascript.js", {:plugin => :myplugin} ]
-  def render_head_content
-    render_stylesheet_includes +
-    render_js_includes +
-    render_extra_head_content
-  end
-  
-  ##
-  # Assumes controller has a #stylesheet_link_tag method, array with
-  # each element being a set of arguments for stylesheet_link_tag
-  # See #render_head_content for instructions on local code or plugins
-  # adding stylesheets. 
-  def render_stylesheet_includes
-    return "".html_safe unless respond_to?(:stylesheet_links)
-    
-    stylesheet_links.uniq.collect do |args|
-      stylesheet_link_tag(*args)
-    end.join("\n").html_safe
-  end
-  
-
-  ##
-  # Assumes controller has a #js_includes method, array with each
-  # element being a set of arguments for javsascript_include_tag.
-  # See #render_head_content for instructions on local code or plugins
-  # adding js files. 
-  def render_js_includes
-    return "".html_safe unless respond_to?(:javascript_includes)    
-  
-    javascript_includes.uniq.collect do |args|
-      javascript_include_tag(*args)
-    end.join("\n").html_safe
-  end
-
-  ## 
-  # Assumes controller has a #extra_head_content method
-  #
-  def render_extra_head_content
-    return "".html_safe unless respond_to?(:extra_head_content)
-
-    extra_head_content.join("\n").html_safe
-  end
 
   # Create <link rel="alternate"> links from a documents dynamically
   # provided export formats. Currently not used by standard BL layouts,
@@ -158,27 +61,6 @@ module BlacklightHelper
     @extra_body_classes ||= ['blacklight-' + controller.controller_name, 'blacklight-' + [controller.controller_name, controller.action_name].join('-')]
   end
   
-  #
-  # Blacklight.config based helpers ->
-  #
-  
-  # used in the catalog/_facets partial
-  def facet_field_labels
-    Blacklight.config[:facet][:labels]
-  end
-  
-  # used in the catalog/_facets partial
-  def facet_field_names
-    Blacklight.config[:facet][:field_names]
-  end
-
-  # used in the catalog/_facets partial and elsewhere
-  # Renders a single section for facet limit with a specified
-  # solr field used for faceting. Can be over-ridden for custom
-  # display on a per-facet basis. 
-  def render_facet_limit(solr_field)
-    render( :partial => "catalog/facet_limit", :locals => {:solr_field =>solr_field })
-  end
   
   def render_document_list_partial options={}
     render :partial=>'catalog/document_list'
@@ -322,96 +204,6 @@ module BlacklightHelper
     link_to(raw(render_search_to_s(params)), catalog_index_path(params)).html_safe
   end
     
-  #
-  # facet param helpers ->
-  #
-
-  # Standard display of a facet value in a list. Used in both _facets sidebar
-  # partial and catalog/facet expanded list. Will output facet value name as
-  # a link to add that to your restrictions, with count in parens. 
-  # first arg item is a facet value item from rsolr-ext.
-  # options consist of:
-  # :suppress_link => true # do not make it a link, used for an already selected value for instance
-  def render_facet_value(facet_solr_field, item, options ={})    
-    (link_to_unless(options[:suppress_link], item.value, add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select label") + " " + 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_facet_value(facet_solr_field, item)
-    content_tag(:span, render_facet_value(facet_solr_field, item, :suppress_link => true), :class => "selected label") +
-      link_to("[remove]", remove_facet_params(facet_solr_field, item.value, params), :class=>"remove")
-  end
-
-  # Renders a count value for facet limits. Can be over-ridden locally
-  # to change style, for instance not use parens. And can be called
-  # by plugins to get consistent display. 
-  def render_facet_count(num)
-    content_tag("span",  "(" + format_num(num) + ")", :class => "count") 
-  end
-  
-  # adds the value and/or field to params[:f]
-  # Does NOT remove request keys and otherwise ensure that the hash
-  # is suitable for a redirect. See
-  # add_facet_params_and_redirect
-  def add_facet_params(field, value)
-    p = params.dup
-    p[:f] = (p[:f] || {}).dup # the command above is not deep in rails3, !@#$!@#$
-    p[:f][field] = (p[:f][field] || []).dup
-    p[:f][field].push(value)
-    p
-  end
-
-  # Used in catalog/facet action, facets.rb view, for a click
-  # on a facet value. Add on the facet params to existing
-  # search constraints. Remove any paginator-specific request
-  # params, or other request params that should be removed
-  # for a 'fresh' display. 
-  # Change the action to 'index' to send them back to
-  # catalog/index with their new facet choice. 
-  def add_facet_params_and_redirect(field, value)
-    new_params = add_facet_params(field, value)
-
-    # Delete page, if needed. 
-    new_params.delete(:page)
-
-    # Delete any request params from facet-specific action, needed
-    # to redir to index action properly. 
-    Blacklight::Solr::FacetPaginator.request_keys.values.each do |paginator_key| 
-      new_params.delete(paginator_key)
-    end
-    new_params.delete(:id)
-
-    # Force action to be index. 
-    new_params[:action] = "index"
-    new_params    
-  end
-  # copies the current params (or whatever is passed in as the 3rd arg)
-  # removes the field value from params[:f]
-  # removes the field if there are no more values in params[:f][field]
-  # removes additional params (page, id, etc..)
-  def remove_facet_params(field, value, source_params=params)
-    p = source_params.dup
-    # need to dup the facet values too,
-    # if the values aren't dup'd, then the values
-    # from the session will get remove in the show view...
-    p[:f] = p[:f].dup
-    p[:f][field] = p[:f][field].nil? ? [] : p[:f][field].dup
-    p.delete :page
-    p.delete :id
-    p.delete :counter
-    p.delete :commit
-    #return p unless p[field]
-    p[:f][field] = p[:f][field] - [value]
-    p[:f].delete(field) if p[:f][field].size == 0
-    p
-  end
-  
-  # true or false, depending on whether the field and value is in params[:f]
-  def facet_in_params?(field, value)
-    params[:f] and params[:f][field] and params[:f][field].include?(value)
-  end
-  
   #
   # shortcut for built-in Rails helper, "number_with_delimiter"
   #
@@ -602,9 +394,4 @@ module BlacklightHelper
     val
   end
 
-
-  def render_document_unapi_microformat(document, options={})
-    render(:partial=>'catalog/unapi_microformat',  :locals => {:document=> document}.merge(options))
-  end
-
 end

data/app/helpers/facets_helper.rb

@@ -0,0 +1,114 @@
+module FacetsHelper
+
+  #
+  # Blacklight.config based helpers ->
+  #
+  
+  # used in the catalog/_facets partial
+  def facet_field_labels
+    Blacklight.config[:facet][:labels]
+  end
+  
+  # used in the catalog/_facets partial
+  def facet_field_names
+    Blacklight.config[:facet][:field_names]
+  end
+
+  # used in the catalog/_facets partial and elsewhere
+  # Renders a single section for facet limit with a specified
+  # solr field used for faceting. Can be over-ridden for custom
+  # display on a per-facet basis. 
+  def render_facet_limit(solr_field)
+    render( :partial => "catalog/facet_limit", :locals => {:solr_field =>solr_field })
+  end
+
+  #
+  # facet param helpers ->
+  #
+
+  # Standard display of a facet value in a list. Used in both _facets sidebar
+  # partial and catalog/facet expanded list. Will output facet value name as
+  # a link to add that to your restrictions, with count in parens. 
+  # first arg item is a facet value item from rsolr-ext.
+  # options consist of:
+  # :suppress_link => true # do not make it a link, used for an already selected value for instance
+  def render_facet_value(facet_solr_field, item, options ={})    
+    (link_to_unless(options[:suppress_link], item.value, add_facet_params_and_redirect(facet_solr_field, item.value), :class=>"facet_select label") + " " + 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_facet_value(facet_solr_field, item)
+    content_tag(:span, render_facet_value(facet_solr_field, item, :suppress_link => true), :class => "selected label") +
+      link_to("[remove]", remove_facet_params(facet_solr_field, item.value, params), :class=>"remove")
+  end
+
+  # Renders a count value for facet limits. Can be over-ridden locally
+  # to change style, for instance not use parens. And can be called
+  # by plugins to get consistent display. 
+  def render_facet_count(num)
+    content_tag("span",  "(" + format_num(num) + ")", :class => "count") 
+  end
+  
+  # adds the value and/or field to params[:f]
+  # Does NOT remove request keys and otherwise ensure that the hash
+  # is suitable for a redirect. See
+  # add_facet_params_and_redirect
+  def add_facet_params(field, value)
+    p = params.dup
+    p[:f] = (p[:f] || {}).dup # the command above is not deep in rails3, !@#$!@#$
+    p[:f][field] = (p[:f][field] || []).dup
+    p[:f][field].push(value)
+    p
+  end
+
+  # Used in catalog/facet action, facets.rb view, for a click
+  # on a facet value. Add on the facet params to existing
+  # search constraints. Remove any paginator-specific request
+  # params, or other request params that should be removed
+  # for a 'fresh' display. 
+  # Change the action to 'index' to send them back to
+  # catalog/index with their new facet choice. 
+  def add_facet_params_and_redirect(field, value)
+    new_params = add_facet_params(field, value)
+
+    # Delete page, if needed. 
+    new_params.delete(:page)
+
+    # Delete any request params from facet-specific action, needed
+    # to redir to index action properly. 
+    Blacklight::Solr::FacetPaginator.request_keys.values.each do |paginator_key| 
+      new_params.delete(paginator_key)
+    end
+    new_params.delete(:id)
+
+    # Force action to be index. 
+    new_params[:action] = "index"
+    new_params    
+  end
+  # copies the current params (or whatever is passed in as the 3rd arg)
+  # removes the field value from params[:f]
+  # removes the field if there are no more values in params[:f][field]
+  # removes additional params (page, id, etc..)
+  def remove_facet_params(field, value, source_params=params)
+    p = source_params.dup
+    # need to dup the facet values too,
+    # if the values aren't dup'd, then the values
+    # from the session will get remove in the show view...
+    p[:f] = (p[:f] || {}).dup
+    p[:f][field] = (p[:f][field] || []).dup
+    p.delete :page
+    p.delete :id
+    p.delete :counter
+    p.delete :commit
+    p[:f][field] = p[:f][field] - [value]
+    p[:f].delete(field) if p[:f][field].size == 0
+    p
+  end
+  
+  # true or false, depending on whether the field and value is in params[:f]
+  def facet_in_params?(field, value)
+    params[:f] and params[:f][field] and params[:f][field].include?(value)
+  end
+  
+end

data/app/helpers/html_head_helper.rb

@@ -0,0 +1,103 @@
+module HtmlHeadHelper
+  ##
+  # This method should be included in any Blacklight layout, including
+  # custom ones. It will output results of #render_js_includes,
+  # #render_stylesheet_includes, all the content of 
+  # current_controller#extra_head_content as well as any content passed 
+  # in any content_for(:head) blocks.
+  #
+  # Uses controller methods #extra_head_content, #javascript_includes,
+  # and #stylesheet_links to find content. Tolerates it if those
+  # methods don't exist, silently skipping. 
+  #
+  # By a layout outputting this in html HEAD, it provides an easy way for
+  # local config or extra plugins to add HEAD content.
+  # 
+  # Add your own css or remove the defaults by simply editing
+  # controller.stylesheet_links, controller.javascript_includes,
+  # or controller.extra_head_content. 
+  #
+  # 
+  #
+  # in an initializer or other startup file (plugin init.rb?):
+  #
+  # == Apply to all actions in all controllers:
+  # 
+  #   ApplicationController.before_filter do |controller|
+  #     # remove default jquery-ui theme.
+  #     controller.stylesheet_links.each do |args|
+  #       args.delete_if {|a| a =~ /^|\/jquery-ui-[\d.]+\.custom\.css$/ }
+  #     end
+  # 
+  #     # add in a different jquery-ui theme, or any other css or what have you
+  #     controller.stylesheet_links << 'my_css.css'
+  #
+  #     controller.javascript_includes << "my_local_behaviors.js"
+  #
+  #     controller.extra_head_content << '<link rel="something" href="something">'
+  #   end
+  #
+  # == Apply to a particular action in a particular controller:
+  #
+  #   CatalogController.before_filter :only => :show |controller|
+  #     controller.extra_head_content << '<link rel="something" href="something">'
+  #   end
+  #
+  # == Or in a view file that wants to add certain header content? no problem:
+  #
+  #   <%  stylesheet_links << "mystylesheet.css" %>
+  #   <%  javascript_includes << "my_js.js" %>
+  #   <%  extra_head_content << capture do %>
+  #       <%= tag :link, { :href => some_method_for_something, :rel => "alternate" } %> 
+  #   <%  end %>
+  #
+  # == Full power of javascript_include_tag and stylesheet_link_tag
+  # Note that the elements added to stylesheet_links and javascript_links
+  # are arguments to Rails javascript_include_tag and stylesheet_link_tag
+  # respectively, you can pass complex arguments. eg:
+  #
+  # stylesheet_links << ["stylesheet1.css", "stylesheet2.css", {:cache => "mykey"}]
+  # javascript_includes << ["myjavascript.js", {:plugin => :myplugin} ]
+  def render_head_content
+    render_stylesheet_includes +
+    render_js_includes +
+    render_extra_head_content +
+    content_for(:head)
+  end
+  
+  ##
+  # Assumes controller has a #stylesheet_link_tag method, array with
+  # each element being a set of arguments for stylesheet_link_tag
+  # See #render_head_content for instructions on local code or plugins
+  # adding stylesheets. 
+  def render_stylesheet_includes
+    return "".html_safe unless respond_to?(:stylesheet_links)
+    
+    stylesheet_links.uniq.collect do |args|
+      stylesheet_link_tag(*args)
+    end.join("\n").html_safe
+  end
+  
+
+  ##
+  # Assumes controller has a #js_includes method, array with each
+  # element being a set of arguments for javsascript_include_tag.
+  # See #render_head_content for instructions on local code or plugins
+  # adding js files. 
+  def render_js_includes
+    return "".html_safe unless respond_to?(:javascript_includes)    
+  
+    javascript_includes.uniq.collect do |args|
+      javascript_include_tag(*args)
+    end.join("\n").html_safe
+  end
+
+  ## 
+  # Assumes controller has a #extra_head_content method
+  #
+  def render_extra_head_content
+    return "".html_safe unless respond_to?(:extra_head_content)
+
+    extra_head_content.join("\n").html_safe
+  end
+end