blacklight 3.1.2 → 3.2.0pre1

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

@@ -0,0 +1,27 @@
+/* This file is generated by Blacklight. You probably don't want to edit
+   this file directly, or you'll have to manually merge your changes if later
+   versions of Blacklight change this file. Instead, use your own CSS file
+   which over-rides things in this file. Or of course you can choose
+   not to use the Blacklight CSS file at all in your local app. */
+
+
+@import "compass";
+@import "compass/reset";
+
+@import 'blacklight/blacklight_defaults';
+
+/* Import this to maintain the old YUI font styles */
+@import "blacklight/layout";
+@import "blacklight/formatting";
+@import "blacklight/header";
+@import "blacklight/catalog";
+@import "blacklight/facets";
+@import "blacklight/folder";
+@import "blacklight/search_history";
+@import "blacklight/print";
+
+
+/* IE 6 Adjustments */
+* html #hd .yui-g .yui-u {margin-top: -5em;}
+* html #hd .yui-g .first {margin-top: 2em;}
+* html #search {left: -1.8em;}

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

@@ -0,0 +1,48 @@
+/* Warning! If you want to change these, just copy them into your own theme css. But you want to remove the !default, which only will set them if not already set. */
+
+/* Grid parameters */
+/* changing total cols is not recommended unless you're going to redo blacklight/_layout.css.sass */
+$total-cols: 24 !default;
+
+/* But the widths are changeable to px, em. */
+$col-width: 2.5em !default;
+$gutter-width: .5em !default;
+$side-gutter-width: 2em !default;
+
+
+$logo_url: 'blacklight/logo.png' !default;
+
+/* Various elements of search customization share these colors */
+
+$search_ui_border_color: #AAAAAA !default;
+$search_ui_bg_color: #F0F0F0 !default;
+
+/* separates documents, facets */
+$dotted_border_color: #CCC !default;
+
+/* background color of page */
+$page_bg_color: #2E4F81 !default;
+
+
+/* label (field names) */
+$field_name_color: #888 !default;
+
+
+/* constraint (you searched for:) details: */
+
+$constraint_bg_color: #E2EDFE !default;
+
+$constraint_border_color: #C4DAFE !default;
+$constraint_border_active_color: #FFD27A !default;
+
+/* dialog that pops up when you pick more on facets */
+$facet_extended_button_bg_color: #F6F6F6 !default;
+$facet_extended_button_border_color: #CCC !default;
+$facet_extended_disabled_button_bg_color: #E2EDFE !default;
+$facet_extended_disabled_border_color: #C4DAFE !default;
+$facet_extended_button_hover_bg_color: #DADADA !default;
+$facet_extended_button_hover_border_color: #999 !default;
+$facet_extended_button_hover_color: #212121 !default;
+
+/* border between items on marc view */
+$marc_item_separator: 1px solid #CCC !default;

data/app/controllers/bookmarks_controller.rb

@@ -2,7 +2,8 @@
 # note that while this is mostly restful routing, the #update and #destroy actions
 # take the Solr document ID as the :id, NOT the id of the actual Bookmark action. 
 class BookmarksController < ApplicationController
-    
+
+  before_filter :require_user_authentication_provider
   before_filter :verify_user
   
   # Beware, :id is the Solr document_id, not the actual Bookmark id.

data/app/controllers/folder_controller.rb

@@ -1,6 +1,10 @@
 # -*- encoding : utf-8 -*-
 class FolderController < ApplicationController
+  include Blacklight::Configurable
   include Blacklight::SolrHelper
+
+  copy_blacklight_config_from(CatalogController)
+
   helper CatalogHelper
 
   # fetch the documents that match the ids in the folder

data/app/controllers/saved_searches_controller.rb

@@ -1,5 +1,9 @@
 # -*- encoding : utf-8 -*-
 class SavedSearchesController < ApplicationController
+  include Blacklight::Configurable
+
+  copy_blacklight_config_from(CatalogController)
+  before_filter :require_user_authentication_provider
   before_filter :verify_user 
   
   def index

data/app/controllers/search_history_controller.rb

@@ -1,5 +1,9 @@
 # -*- encoding : utf-8 -*-
 class SearchHistoryController < ApplicationController
+  include Blacklight::Configurable
+
+  copy_blacklight_config_from(CatalogController)
+
   def index
     @searches = searches_from_history
   end

data/app/helpers/blacklight/blacklight_helper_behavior.rb

@@ -11,9 +11,15 @@ module Blacklight::BlacklightHelperBehavior
 
   
   def application_name
+    return Rails.application.config.application_name if Rails.application.config.respond_to? :application_name
+
     'Blacklight'
   end
 
+  # Provide the full, absolute url for an image
+  def asset_url(*args) 
+    "#{request.protocol}#{request.host_with_port}#{asset_path(*args)}" 
+  end
 
   # Create <link rel="alternate"> links from a documents dynamically
   # provided export formats. Currently not used by standard BL layouts,
@@ -36,7 +42,7 @@ module Blacklight::BlacklightHelperBehavior
       unless( options[:exclude].include?(format) ||
              (options[:unique] && seen.include?(spec[:content_type]))
              )
-        html << tag(:link, {:rel=>"alternate", :title=>format, :type => spec[:content_type], :href=> catalog_url(document.id,  format)}) << "\n"
+        html << tag(:link, {:rel=>"alternate", :title=>format, :type => spec[:content_type], :href=> catalog_url(document,  format)}) << "\n"
         
         seen.add(spec[:content_type]) if options[:unique]
       end
@@ -69,38 +75,45 @@ module Blacklight::BlacklightHelperBehavior
   # Save function area for search results 'index' view, normally
   # renders next to title. Includes just 'Folder' by default.
   def render_index_doc_actions(document, options={})   
-    content_tag("div", :class=>"documentFunctions") do
-      raw("#{render(:partial => 'bookmark_control', :locals => {:document=> document}.merge(options))}
-       #{render(:partial => 'folder_control', :locals => {:document=> document}.merge(options))}")
-    end
+    content = []
+    content << render(:partial => 'bookmark_control', :locals => {:document=> document}.merge(options)) if has_user_authentication_provider? and current_user
+    content << render(:partial => 'folder_control', :locals => {:document=> document}.merge(options))
+
+    content_tag("div", content.join("\n").html_safe, :class=>"documentFunctions")
   end
   
   # Save function area for item detail 'show' view, normally
   # renders next to title. By default includes 'Folder' and 'Bookmarks'
   def render_show_doc_actions(document=@document, options={})
-    content_tag("div", :class=>"documentFunctions") do
-      raw("#{render(:partial => 'bookmark_control', :locals => {:document=> document}.merge(options))}
-       #{render(:partial => 'folder_control', :locals => {:document=> document}.merge(options))}")
-    end
+    content = []
+    content << render(:partial => 'bookmark_control', :locals => {:document=> document}.merge(options)) if has_user_authentication_provider? and current_user
+    content << render(:partial => 'folder_control', :locals => {:document=> document}.merge(options))
+
+    content_tag("div", content.join("\n").html_safe, :class=>"documentFunctions")
   end
   
   # used in the catalog/_index_partials/_default view
+  def index_fields
+    blacklight_config.index_fields
+  end
+
   def index_field_names
-    Blacklight.config[:index_fields][:field_names]
+    index_fields.keys
   end
-  
-  # used in the _index_partials/_default view
+
+  # used in the catalog/_index_partials/_default partial
   def index_field_labels
-    Blacklight.config[:index_fields][:labels]
+    # XXX DEPRECATED
+    Hash[*index_fields.map { |key, field| [key, field.label] }.flatten]
   end
-
+  
   def spell_check_max
-    Blacklight.config[:spell_max] || 0
+    blacklight_config.spell_max
   end
 
   def render_index_field_label args
     field = args[:field]
-    html_escape index_field_labels[field]
+    html_escape index_fields[field].label
   end
 
   def render_index_field_value args
@@ -111,7 +124,7 @@ module Blacklight::BlacklightHelperBehavior
   
   # Used in the show view for displaying the main solr document heading
   def document_heading
-    @document[Blacklight.config[:show][:heading]] || @document.id
+    @document[blacklight_config.show.heading] || @document.id
   end
   def render_document_heading
     content_tag(:h1, document_heading)
@@ -119,42 +132,43 @@ module Blacklight::BlacklightHelperBehavior
   
   # Used in the show view for setting the main html document title
   def document_show_html_title
-    @document[Blacklight.config[:show][:html_title]]
+    @document[blacklight_config.show.html_title]
   end
   
   # Used in citation view for displaying the title
   def citation_title(document)
-    document[Blacklight.config[:show][:html_title]]
+    document[blacklight_config.show.html_title]
   end
   
   # Used in the document_list partial (search view) for building a select element
   def sort_fields
-    Blacklight.config[:sort_fields]
+    blacklight_config.sort_fields.map { |key, x| [x.label, x.key] }
   end
   
   # Used in the document list partial (search view) for creating a link to the document show action
   def document_show_link_field
-    Blacklight.config[:index][:show_link].to_sym
+    blacklight_config.index.show_link.to_sym
   end
   
   # Used in the search form partial for building a select tag
   def search_fields
-    Blacklight.search_field_options_for_select
+    search_field_options_for_select
   end
   
   # used in the catalog/_show/_default partial
   def document_show_fields
-    Blacklight.config[:show_fields][:field_names]
+    blacklight_config.show_fields.keys
   end
   
   # used in the catalog/_show/_default partial
   def document_show_field_labels
-    Blacklight.config[:show_fields][:labels]
+    # XXX DEPRECATED
+    Hash[*blacklight_config.show_fields.map { |key, field| [key, field.label] }.flatten]
   end
 
   def render_document_show_field_label args 
     field = args[:field]
-    html_escape document_show_field_labels[field]
+    html_escape blacklight_config.show_fields[field].label
   end
 
   def render_document_show_field_value args
@@ -178,7 +192,7 @@ module Blacklight::BlacklightHelperBehavior
     # .to_s is necessary otherwise the default return value is not always a string
     # using "_" as sep. to more closely follow the views file naming conventions
     # parameterize uses "-" as the default sep. which throws errors
-    display_type = document[Blacklight.config[:show][:display_type]]
+    display_type = document[blacklight_config.show.display_type]
 
     return 'default' unless display_type
     display_type = display_type.join(" ") if display_type.respond_to?(:join)
@@ -250,13 +264,18 @@ module Blacklight::BlacklightHelperBehavior
     label ||= doc.id
   end
 
+
+  def solr_document_path(*args); catalog_path(*args); end
+  def solr_document_url(*args); catalog_url(*args); end
+
   # link_to_document(doc, :label=>'VIEW', :counter => 3)
   # Use the catalog_path RESTful route to create a link to the show page for a specific item. 
   # catalog_path accepts a HashWithIndifferentAccess object. The solr query params are stored in the session,
   # so we only need the +counter+ param here. We also need to know if we are viewing to document as part of search results.
-  def link_to_document(doc, opts={:label=>Blacklight.config[:index][:show_link].to_sym, :counter => nil, :results_view => true})
+  def link_to_document(doc, opts={:label=>nil, :counter => nil, :results_view => true})
+    label ||= blacklight_config.index.show_link.to_sym
     label = render_document_index_label doc, opts
-    link_to_with_data(label, catalog_path(doc.id), {:method => :put, :class => label.parameterize, :data => opts}).html_safe
+    link_to label, doc, :'data-counter' => opts[:counter]
   end
 
   # link_back_to_catalog(:label=>'Back to Search')
@@ -278,7 +297,20 @@ module Blacklight::BlacklightHelperBehavior
     
     options = {:params => params, :omit_keys => [:page]}.merge(options)
     my_params = options[:params].dup
-    options[:omit_keys].each {|omit_key| my_params.delete(omit_key)}
+    options[:omit_keys].each do |omit_key|
+      case omit_key
+        when Hash
+          omit_key.each do |key, values|
+            next unless my_params[key]
+            my_params[key] = my_params[key].dup
+
+            values = [values] unless values.respond_to? :each
+            values.each { |v| my_params[key].delete(v) }
+          end
+        else
+          my_params.delete(omit_key)
+      end
+    end
     # removing action and controller from duplicate params so that we don't get hidden fields for them.
     my_params.delete(:action)
     my_params.delete(:controller)
@@ -293,12 +325,12 @@ module Blacklight::BlacklightHelperBehavior
 
   def link_to_previous_document(previous_document)
     return if previous_document == nil
-    link_to_document previous_document, :label=>'« Previous', :counter => session[:search][:counter].to_i - 1
+    link_to '« Previous', previous_document, :class => "previous", :'data-counter' => session[:search][:counter].to_i - 1
   end
 
   def link_to_next_document(next_document)
     return if next_document == nil
-    link_to_document next_document, :label=>'Next »', :counter => session[:search][:counter].to_i + 1
+    link_to 'Next »', next_document, :class => "next", :'data-counter' => session[:search][:counter].to_i + 1
   end
 
   # Use case, you want to render an html partial from an XML (say, atom)
@@ -313,79 +345,6 @@ module Blacklight::BlacklightHelperBehavior
     return result
   end
   
-
-  # This is an updated +link_to+ that allows you to pass a +data+ hash along with the +html_options+
-  # which are then written to the generated form for non-GET requests. The key is the form element name
-  # and the value is the value:
-  #
-  #  link_to_with_data('Name', some_path(some_id), :method => :post, :html)
-  def link_to_with_data(*args, &block)
-    if block_given?
-      options      = args.first || {}
-      html_options = args.second
-      concat(link_to(capture(&block), options, html_options))
-    else
-      name         = args.first
-      options      = args.second || {}
-      html_options = args.third
-
-      url = url_for(options)
-
-      if html_options
-        html_options = html_options.stringify_keys
-        href = html_options['href']
-        convert_options_to_javascript_with_data!(html_options, url)
-        tag_options = tag_options(html_options)
-      else
-        tag_options = nil
-      end
-
-      href_attr = "href=\"#{url}\"" unless href
-      "<a #{href_attr}#{tag_options}>#{h(name) || h(url)}</a>".html_safe
-    end
-  end
-
-  # This is derived from +convert_options_to_javascript+ from module Blacklight::+UrlHelperBehavior+ in +url_helper.rb+
-  def convert_options_to_javascript_with_data!(html_options, url = '')
-    confirm, popup = html_options.delete("confirm"), html_options.delete("popup")
-
-    method, href = html_options.delete("method"), html_options['href']
-    data = html_options.delete("data")
-    data = data.stringify_keys if data
-    
-    html_options["onclick"] = case
-      when method
-        "#{method_javascript_function_with_data(method, url, href, data)}return false;"
-      else
-        html_options["onclick"]
-    end
-  end
-
-  # This is derived from +method_javascript_function+ from module Blacklight::+UrlHelperBehavior+ in +url_helper.rb+
-  def method_javascript_function_with_data(method, url = '', href = nil, data=nil)
-    action = (href && url.size > 0) ? "'#{url}'" : 'this.href'
-    submit_function =
-      "var f = document.createElement('form'); f.style.display = 'none'; " +
-      "this.parentNode.appendChild(f); f.method = 'POST'; f.action = #{action};"+
-      "if(event.metaKey || event.ctrlKey){f.target = '_blank';};" # if the command or control key is being held down while the link is clicked set the form's target to _blank
-    if data
-      data.each_pair do |key, value|
-        submit_function << "var d = document.createElement('input'); d.setAttribute('type', 'hidden'); "
-        submit_function << "d.setAttribute('name', '#{key}'); d.setAttribute('value', '#{escape_javascript(value.to_s)}'); f.appendChild(d);"
-      end
-    end
-    unless method == :post
-      submit_function << "var m = document.createElement('input'); m.setAttribute('type', 'hidden'); "
-      submit_function << "m.setAttribute('name', '_method'); m.setAttribute('value', '#{method}'); f.appendChild(m);"
-    end
-
-    if protect_against_forgery?
-      submit_function << "var s = document.createElement('input'); s.setAttribute('type', 'hidden'); "
-      submit_function << "s.setAttribute('name', '#{request_forgery_protection_token}'); s.setAttribute('value', '#{escape_javascript form_authenticity_token}'); f.appendChild(s);"
-    end
-    submit_function << "f.submit();"
-  end
-  
   # determines if the given document id is in the folder
   def item_in_folder?(doc_id)
     session[:folder_document_ids] && session[:folder_document_ids].include?(doc_id) ? true : false
@@ -413,4 +372,5 @@ module Blacklight::BlacklightHelperBehavior
     val
   end
 
+
 end

data/app/helpers/blacklight/catalog_helper_behavior.rb

@@ -63,18 +63,18 @@ module Blacklight::CatalogHelperBehavior
   end
   
   # Look up search field user-displayable label
-  # based on params[:qt] and configuration.
+  # based on params[:qt] and blacklight_configuration.
   def search_field_label(params)
-    h( Blacklight.label_for_search_field(params[:search_field]) )
+    h( 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))}"        
+    "http://www.refworks.com/express/expressimport.asp?vendor=#{CGI.escape(application_name)}&filter=MARC%20Format&encoding=65001&url=#{CGI.escape(catalog_path(document, :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
+   'blacklight-' + document.get(blacklight_config.index.record_display_type).parameterize rescue nil
   end
 
   def render_document_sidebar_partial(document = @document)

data/app/helpers/blacklight/facets_helper_behavior.rb

@@ -1,25 +1,72 @@
 module Blacklight::FacetsHelperBehavior
 
   #
-  # Blacklight.config based helpers ->
+  # blacklight_config based helpers ->
   #
   
+  def facet_configuration_for_field(field)
+    blacklight_config.facet_fields[field] || Blacklight::Configuration::FacetField.new(:field => field)
+  end
+
   # used in the catalog/_facets partial
   def facet_field_labels
-    Blacklight.config[:facet][:labels]
+    # DEPRECATED
+    Hash[*blacklight_config.facet_fields.map { |key, facet| [key, facet.label] }.flatten]
   end
   
   # used in the catalog/_facets partial
   def facet_field_names
-    Blacklight.config[:facet][:field_names]
+    blacklight_config.facet_fields.keys
+  end
+
+  # Render a collection of facet fields
+  def render_facet_partials fields = facet_field_names, options = {}
+    solr_fields = fields.map do |solr_field|
+      case solr_field
+        when String, Symbol
+          @response.facet_by_field_name(solr_field)
+        when Blacklight::Configuration::FacetField
+          @response.facet_by_field_name(solr_field.field)
+        else
+          solr_field
+        end
+    end.compact
+
+    solr_fields.map do |display_facet|
+      next if display_facet.items.blank?
+      render_facet_limit(display_facet, options)
+    end.compact.join("\n").html_safe
   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 })
+  #
+  # @param [RSolr::Ext::Response::Facets::FacetField] facet_field
+  # @param [Hash] options parameters to use for rendering the facet limit partial
+  #
+  def render_facet_limit(display_facet, options = {})
+    if display_facet.is_a? String or display_facet.is_a? Symbol
+      $stderr.puts "DEPRECATION WARNING: Blacklight::FacetsHelper#render_facet_limit: use #render_facet_partials to render facets by field name"
+      return render_facet_partials([display_facet])
+    end
+    options = options.dup
+    options[:partial] ||= facet_partial_name(display_facet)
+    options[:layout] ||= "facet_layout"
+    options[:locals] ||= {}
+    options[:locals][:solr_field] ||= display_facet.name 
+    options[:locals][:facet_field] ||= facet_configuration_for_field(display_facet.name)
+    options[:locals][:display_facet] ||= display_facet 
+
+    render(options)
+  end
+
+  # the name of the partial to use to render a facet field. Can be over-ridden for custom
+  # display on a per-facet basis. 
+  def facet_partial_name(display_facet = nil)
+    name = facet_configuration_for_field(display_facet.name).try(:partial)
+    name ||= "facet_limit"
   end
 
   #