blacklight 3.1.0 → 3.1.1

data/app/helpers/catalog_helper.rb

@@ -1,87 +1,3 @@
-# -*- encoding : utf-8 -*-
 module CatalogHelper
-
-  # Pass in an RSolr::Response (or duck-typed similar) object, 
-  # it translates to a Kaminari-paginatable
-  # object, with the keys Kaminari views expect. 
-  def paginate_params(response)
-    per_page = response.rows
-    per_page = 1 if per_page < 1
-    current_page = (response.start / per_page).ceil + 1
-    num_pages = (response.total / per_page.to_f).ceil
-    Struct.new(:current_page, :num_pages, :limit_value).new(current_page, num_pages, per_page)
-  end    
-
-  # Equivalent to kaminari "paginate", but takes an RSolr::Response as first argument. 
-  # Will convert it to something kaminari can deal with (using #paginate_params), and
-  # then call kaminari paginate with that. Other arguments (options and block) same as
-  # kaminari paginate, passed on through. 
-  # will output HTML pagination controls. 
-  def paginate_rsolr_response(response, options = {}, &block)
-    paginate paginate_params(response), options, &block
-  end
-
-  #
-  # shortcut for built-in Rails helper, "number_with_delimiter"
-  #
-  def format_num(num); number_with_delimiter(num) end
-
-  #
-  # Pass in an RSolr::Response. Displays the "showing X through Y of N" message. 
-  def render_pagination_info(response, options = {})
-      start = response.start + 1
-      per_page = response.rows
-      current_page = (response.start / per_page).ceil + 1
-      num_pages = (response.total / per_page.to_f).ceil
-      total_hits = response.total
-
-      start_num = format_num(start)
-      end_num = format_num(start + response.docs.length - 1)
-      total_num = format_num(total_hits)
-
-      entry_name = options[:entry_name] ||
-        (response.empty?? 'entry' : response.docs.first.class.name.underscore.sub('_', ' '))
-
-      if num_pages < 2
-        case response.docs.length
-        when 0; "No #{h(entry_name.pluralize)} found".html_safe
-        when 1; "Displaying <b>1</b> #{h(entry_name)}".html_safe
-        else;   "Displaying <b>all #{total_num}</b> #{entry_name.pluralize}".html_safe
-        end
-      else
-        "Displaying #{h(entry_name.pluralize)} <b>#{start_num} - #{end_num}</b> of <b>#{total_num}</b>".html_safe
-      end
-  end
-
-  # Like  #render_pagination_info above, but for an individual
-  # item show page. Displays "showing X of Y items" message. Actually takes
-  # data from session though (not a great design). 
-  # Code should call this method rather than interrogating session directly,
-  # because implementation of where this data is stored/retrieved may change. 
-  def item_page_entry_info
-    "Showing item <b>#{session[:search][:counter].to_i} of #{format_num(session[:search][:total])}</b> from your search.".html_safe
-  end
-  
-  # Look up search field user-displayable label
-  # based on params[:qt] and configuration.
-  def search_field_label(params)
-    h( Blacklight.label_for_search_field(params[:search_field]) )
-  end
-
-  # Export to Refworks URL, called in _show_tools
-  def refworks_export_url(document = @document)
-    "http://www.refworks.com/express/expressimport.asp?vendor=#{CGI.escape(application_name)}&filter=MARC%20Format&encoding=65001&url=#{CGI.escape(catalog_path(document.id, :format => 'refworks_marc_txt', :only_path => false))}"        
-  end
-  
-  def render_document_class(document = @document)
-   'blacklight-' + document.get(Blacklight.config[:index][:record_display_type]).parameterize rescue nil
-  end
-
-  def render_document_sidebar_partial(document = @document)
-    render :partial => 'show_sidebar'
-  end
-
-  def has_search_parameters?
-    !params[:q].blank? or !params[:f].blank? or !params[:search_field].blank?
-  end
+  include Blacklight::CatalogHelperBehavior
 end

data/app/helpers/facets_helper.rb

@@ -1,114 +1,3 @@
 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
-  
+  include Blacklight::FacetsHelperBehavior
 end

data/app/helpers/hash_as_hidden_fields_helper.rb

@@ -0,0 +1,3 @@
+module HashAsHiddenFieldsHelper
+  include Blacklight::HashAsHiddenFieldsHelperBehavior
+end

data/app/helpers/html_head_helper.rb

@@ -1,103 +1,3 @@
 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
+  include Blacklight::HtmlHeadHelperBehavior
 end

data/app/helpers/render_constraints_helper.rb

@@ -1,121 +1,3 @@
-# -*- encoding : utf-8 -*-
-# All methods in here are 'api' that may be over-ridden by plugins and local
-# code, so method signatures and semantics should not be changed casually.
-# implementations can be of course.
-#
-# Includes methods for rendering contraints graphically on the
-# search results page (render_constraints(_*)), and also
-# for rendering more textually on Search History page
-# (render_search_to_s(_*))
 module RenderConstraintsHelper
-
-  # Render actual constraints, not including header or footer
-  # info. 
-  def render_constraints(localized_params = params)
-    (render_constraints_query(localized_params) + render_constraints_filters(localized_params)).html_safe
-  end
-  
-  def render_constraints_query(localized_params = params)
-    # So simple don't need a view template, we can just do it here.
-    if (!localized_params[:q].blank?)
-      label = 
-        if (localized_params[:search_field] == Blacklight.default_search_field[:key] or localized_params[:search_field].blank? )
-          nil
-        else
-          Blacklight.label_for_search_field(localized_params[:search_field])
-        end
-    
-      render_constraint_element(label,
-            localized_params[:q], 
-            :classes => ["query"], 
-            :remove => catalog_index_path(localized_params.merge(:q=>nil, :action=>'index')))
-    else
-      "".html_safe
-    end
-  end
-
-  def render_constraints_filters(localized_params = params)
-     return "".html_safe unless localized_params[:f]
-     content = ""
-     localized_params[:f].each_pair do |facet,values|
-        values.each do |val|
-           content << render_constraint_element( facet_field_labels[facet],
-                  val, 
-                  :remove => catalog_index_path(remove_facet_params(facet, val, localized_params)),
-                  :classes => ["filter", "filter-" + facet.parameterize] 
-                ) + "\n"                 					            
-				end
-     end 
-
-     return content.html_safe    
-  end
-
-  # Render a label/value constraint on the screen. Can be called
-  # by plugins and such to get application-defined rendering.
-  #
-  # Can be over-ridden locally to render differently if desired,
-  # although in most cases you can just change CSS instead.
-  #
-  # Can pass in nil label if desired.
-  #
-  # options:
-  # [:remove]
-  #    url to execute for a 'remove' action  
-  # [:classes] 
-  #    can be an array of classes to add to container span for constraint.
-  # [:escape_label]
-  #    default true, HTML escape.
-  # [:escape_value]
-  #    default true, HTML escape. 
-  def render_constraint_element(label, value, options = {})
-    render(:partial => "catalog/constraints_element", :locals => {:label => label, :value => value, :options => options})    
-  end
-
-
-  # Simpler textual version of constraints, used on Search History page.
-  # Theoretically can may be DRY'd up with results page render_constraints,
-  # maybe even using the very same HTML with different CSS? 
-  # But too tricky for now, too many changes to existing CSS. TODO.  
-  def render_search_to_s(params)
-    render_search_to_s_q(params) +
-    render_search_to_s_filters(params)
-  end
-
-  def render_search_to_s_q(params)
-    return "".html_safe if params[:q].blank?
-    
-    label = (params[:search_field] == Blacklight.default_search_field[:key]) ? 
-      nil :
-      Blacklight.label_for_search_field(params[:search_field])
-    
-    render_search_to_s_element(label , params[:q] )        
-  end
-  def render_search_to_s_filters(params)
-    return "".html_safe unless params[:f]
-
-    params[:f].collect do |facet_field, value_list|
-      render_search_to_s_element(Blacklight.config[:facet][:labels][facet_field],
-        value_list.collect do |value|
-          render_filter_value(value)
-        end.join(content_tag(:span, 'and', :class =>'label')).html_safe
-      )    
-    end.join(" \n ").html_safe    
-  end
-
-  # value can be Array, in which case elements are joined with
-  # 'and'.   Pass in option :escape_value => false to pass in pre-rendered
-  # html for value. key with escape_key if needed.  
-  def render_search_to_s_element(key, value, options = {})
-    content_tag(:span, render_filter_name(key) + render_filter_value(value), :class => 'constraint')
-  end
-
-  def render_filter_name name
-    return "".html_safe if name.blank?
-    content_tag(:span, h(name) + ":", :class => 'filterName')
-  end
-
-  def render_filter_value value
-    content_tag(:span, h(value), :class => 'filterValue')
-  end
-  
+  include Blacklight::RenderConstraintsHelperBehavior
 end

data/lib/blacklight/solr/document/marc_export.rb

@@ -165,13 +165,9 @@ module Blacklight::Solr::Document::MarcExport
     }
     marc_obj = to_marc
 
-    # TODO. This was inherited functionality (although refactored),
-    # but it wasn't actually clear that :display_type would
-    # be used this way. This should be rewritten to guess
+    # TODO. This should be rewritten to guess
     # from actual Marc instead, probably.
-    format_str = Blacklight.config[:show][:display_type]
-    format_str = format_str[0] if format_str.kind_of?(Array)
-    format_str = format_str.titlecase
+    format_str = 'Generic'
     
     text = ''
     text << "%0 #{ format_str }\n"