blacklight 3.0pre1

data/lib/blacklight/comma_link_renderer.rb

@@ -0,0 +1,27 @@
+require 'will_paginate/view_helpers/link_renderer'
+
+# Custom link renderer for WillPaginate
+# Inserts commas into large page numbers
+# example: 443719 becomes 443,719
+#
+# Note: To use this class, please call:
+# <%= will_paginate(@users, :renderer => CommaLinkRenderer) %>
+
+module Blacklight
+
+  class CommaLinkRenderer < WillPaginate::ViewHelpers::LinkRenderer
+    
+    protected
+    # Just overriding the page_number method, so that large numbers are 
+    # contain appropriate commas. 
+    def page_number(page)
+      unless page == current_page
+        text = @template.number_with_delimiter(page)
+        link(text, page, :rel => rel_value(page))
+      else
+        tag(:em, page)
+      end
+    end
+    
+  end
+end

data/lib/blacklight/configurable.rb

@@ -0,0 +1,46 @@
+module Blacklight::Configurable
+  
+  # The config environment name used by the #config method
+  #
+  # Example:
+  #   class MyThing
+  #     extend Blacklight::Configurable
+  #   end
+  # 
+  # Now MyThing.config will be the result of:
+  #   MyThing.configure(:production) {|config|}
+  #
+  # You set shared attributes by leaving the first argument blank or passing the :shared value:
+  #   MyThing.configure {|config|} 
+  # or
+  #   MyThing.cofigure(:shared) {|config|}
+  
+  # sets the @configs variable to a new Hash with empty Hash for :shared key and @config to nil
+  def reset_configs!
+    @config = nil
+    @configs = {:shared=>{}}
+  end
+  
+  # A hash of all environment configs
+  # The key is the environment name, the value a Hash
+  def configs
+    @configs ? @configs : (reset_configs! and @configs)
+  end
+  
+  # The main config accessor. It merges the current configs[::Rails.env] 
+  # with configs[:shared] and lazy-loads @config to the result.
+  def config
+    @config ||= configs[:shared].merge(configs[::Rails.env] ||= {})
+  end
+  
+  # Accepts a value for the environment to configure and a block
+  # A hash is yielded to the block
+  # If the "env" != :shared,
+  # the hash is created by deep cloning the :shared environment config.
+  # This makes it possible to create defaults in the :shared config
+  def configure(env = :shared, &blk)
+    configs[env] = {}
+    yield configs[env]
+  end
+  
+end

data/lib/blacklight/controller.rb

@@ -0,0 +1,121 @@
+#
+# Filters added to this controller apply to all controllers in the hosting application
+# as this module is mixed-in to the application controller in the hosting app on installation.
+module Blacklight::Controller 
+
+  def self.included(base)
+    base.send :before_filter, :default_html_head # add JS/stylesheet stuff
+    # now in application.rb file under config.filter_parameters
+    # filter_parameter_logging :password, :password_confirmation 
+    base.send :helper_method, :current_user_session, :current_user
+    base.send :after_filter, :discard_flash_if_xhr    
+
+    # handle basic authorization exception with #access_denied
+    base.send :rescue_from, Blacklight::Exceptions::AccessDenied, :with => :access_denied
+    
+    base.send :helper_method, [:request_is_for_user_resource?]#, :user_logged_in?]
+    
+    base.send :layout, :choose_layout
+
+    # extra head content
+    base.send :helper_method, :extra_head_content
+    base.send :helper_method, :stylesheet_links
+    base.send :helper_method, :javascript_includes
+  end
+
+  
+    # test for exception notifier plugin
+    def error
+      raise RuntimeError, "Generating a test error..."
+    end
+    
+    #############
+    # Display-related methods.
+    #############
+    
+    # before filter to set up our default html HEAD content. Sub-class
+    # controllers can over-ride this method, or instead turn off the before_filter
+    # if they like. See:
+    # http://api.rubyonrails.org/classes/ActionController/Filters/ClassMethods.html
+    # for how to turn off a filter in a sub-class and such.
+    def default_html_head
+      stylesheet_links << ['yui', 'jquery/ui-lightness/jquery-ui-1.8.1.custom.css', 'blacklight', {:plugin=>:blacklight, :media=>'all'}]
+      
+      javascript_includes << ['jquery-1.4.2.min.js', 'jquery-ui-1.8.1.custom.min.js', 'blacklight', { :plugin=>:blacklight } ]
+    end
+    
+    
+    # An array of strings to be added to HTML HEAD section of view.
+    # See ApplicationHelper#render_head_content for details.
+    def extra_head_content
+      @extra_head_content ||= []
+    end
+
+    
+    # Array, where each element is an array of arguments to
+    # Rails stylesheet_link_tag helper. See
+    # ApplicationHelper#render_head_content for details.
+    def stylesheet_links
+      @stylesheet_links ||= []
+    end
+    
+    # Array, where each element is an array of arguments to
+    # Rails javascript_include_tag helper. See
+    # ApplicationHelper#render_head_content for details.
+    def javascript_includes
+      @javascript_includes ||= []
+    end
+    
+    protected
+
+    # Returns a list of Searches from the ids in the user's history.
+    def searches_from_history
+      session[:history].blank? ? [] : Search.find(session[:history]) rescue []
+    end
+    
+    #
+    # Controller and view helper for determining if the current url is a request for a user resource
+    #
+    def request_is_for_user_resource?
+      request.env['PATH_INFO'] =~ /\/?users\/?/
+    end
+
+    #
+    # If a param[:no_layout] is set OR
+    # request.env['HTTP_X_REQUESTED_WITH']=='XMLHttpRequest'
+    # don't use a layout, otherwise use the "application.html.erb" layout
+    #
+    def choose_layout
+      'blacklight' unless request.xml_http_request? || ! params[:no_layout].blank?
+    end
+
+    def current_user_session
+      puts "DEPRICATED:  Please use Devise, Authlogic or other authentication system."
+      user_session  # method provided by devise
+    end
+
+    # Should be provided by devise
+    # def current_user
+    # end
+    
+    ##
+    # We discard flash messages generated by the xhr requests to avoid
+    # confusing UX.
+    def discard_flash_if_xhr
+      flash.discard if request.xhr?
+    end
+
+    ##
+    # To handle failed authorization attempts, redirect the user to the 
+    # login form and persist the current request uri as a parameter
+    def access_denied
+      # send the user home if the access was previously denied by the same
+      # request to avoid sending the user back to the login page
+      #   (e.g. protected page -> logout -> returned to protected page -> home)
+      redirect_to root_url and flash.discard and return if request.referer and request.referer.ends_with? request.fullpath
+
+      redirect_to new_user_session_url(:referer => request.fullpath)
+    end
+  
+end
+

data/lib/blacklight/engine.rb

@@ -0,0 +1,32 @@
+# lib/blacklight/engine.rb
+require "blacklight"
+require "rails"
+
+module Blackight
+  class Engine < Rails::Engine
+
+    # BlacklightHelper is needed by all helpers, so we inject it
+    # into action view base here. 
+    initializer 'blacklight.helpers' do |app|
+      ActionView::Base.send :include, BlacklightHelper
+    end
+
+    # Go ahead and innitialize Blacklight at the very end of the rails 
+    # innitilization process.  
+    # See: http://www.cowboycoded.com/2010/08/02/hooking-in-your-rails-3-engine-or-railtie-initializer-in-the-right-place/
+    initializer 'blacklight.init', :after=> :disable_dependency_loading do |app|
+      # Note, check for configuration files before calling init, 
+      # otherwise we can't generate these files with the Generator
+      # and we can't tell at this point if we are begin run as a generator
+      # or not (at least, I didn't see a way)
+      Blacklight.init if File.exists?(Blacklight.solr_file)      
+    end
+
+    # This makes our rake tasks visible.
+    rake_tasks do
+      load "railties/blacklight.rake"
+      load "railties/solr_marc.rake"
+    end
+
+  end
+end

data/lib/blacklight/exceptions.rb

@@ -0,0 +1,13 @@
+module Blacklight
+  module Exceptions
+
+    class AccessDenied < Exception
+    end
+
+    # When a request for a single solr document by id
+    # is not successful, raise this:
+    class InvalidSolrID < RuntimeError
+    end
+
+  end
+end

data/lib/blacklight/marc.rb

@@ -0,0 +1,46 @@
+
+## This module and the ::Document class in it is DEPRECATED, and will go away.
+# It has been replaced by
+# code using the new document extension framework. See
+# Blacklight::Solr::Document::Marc and Blacklight::Solr::Document::MarcExport
+# This code should not really be changed, or used anymore. It is frozen
+# and deprecated until removed. 
+module Blacklight::Marc
+  
+  autoload :Citation, 'blacklight/marc/citation.rb'
+  
+  class UnsupportedMarcFormatType < RuntimeError; end
+  
+  class Document
+    
+    attr_reader :marc
+    
+    include Citation
+    
+    def initialize(marc_data, marc_type)
+      case marc_type.to_s
+        when 'marcxml'
+          reader = MARC::XMLReader.new(StringIO.new(marc_data)).to_a
+          @marc = reader[0]
+        when 'marc21'
+          reader = MARC::Record.new_from_marc(marc_data)
+          @marc = reader
+        else
+          raise UnsupportedMarcFormatType.new("Only marcxml and marc21 are supported.")
+      end
+    end
+    
+    def marc_xml
+      @marc.to_xml.to_s
+    end
+
+    def to_xml
+      if @marc 
+        self.marc_xml
+      else
+        "<not-implemented/>"
+      end
+    end
+  end
+  
+end

data/lib/blacklight/marc/citation.rb

@@ -0,0 +1,251 @@
+## This module is DEPRECATED, and will go away. It has been replaced by
+# code using the new document extension framework. See
+# Blacklight::Solr::Document::Marc and Blacklight::Solr::Document::MarcExport
+# This code should not really be changed, or used anymore. It is frozen
+# and deprecated until removed. 
+module Blacklight::Marc::Citation
+  
+  def to_apa
+    return nil if self.marc.blank?
+    apa_citation(self.marc)
+  end
+  
+  def to_mla
+    return nil if self.marc.blank?
+    mla_citation(self.marc)
+  end
+
+  def to_zotero(format)
+    return nil if self.marc.blank?
+    z3988_span(self.marc, format)
+  end
+
+  protected
+  
+  def mla_citation(record)
+    text = ''
+    authors_final = []
+    
+    #setup formatted author list
+    authors = get_author_list(record)
+
+    if authors.length < 4
+      authors.each do |l|
+        if l == authors.first #first
+          authors_final.push(l)
+        elsif l == authors.last #last
+          authors_final.push(", and " + name_reverse(l) + ".")
+        else #all others
+          authors_final.push(", " + name_reverse(l))
+        end
+      end
+      text += authors_final.join
+      unless text.blank?
+        if text[-1,1] != "."
+          text += ". "
+        else
+          text += " "
+        end
+      end
+    else
+      text += authors.first + ", et al. "
+    end
+    # setup title
+    title = setup_title_info(record)
+    if !title.nil?
+      text += "<i>" + mla_citation_title(title) + "</i> "
+    end
+
+    # Edition
+    edition_data = setup_edition(record)
+    text += edition_data + " " unless edition_data.nil?
+    
+    # Publication
+    text += setup_pub_info(record) + ", " unless setup_pub_info(record).nil?
+    
+    # Get Pub Date
+    text += setup_pub_date(record) unless setup_pub_date(record).nil?
+    if text[-1,1] != "."
+      text += "." unless text.nil? or text.blank?
+    end
+    text
+  end
+
+  def apa_citation(record)
+    text = ''
+    authors_list = []
+    authors_list_final = []
+    
+    #setup formatted author list
+    authors = get_author_list(record)
+    authors.each do |l|
+      authors_list.push(abbreviate_name(l)) unless l.nil?
+    end
+    authors_list.each do |l|
+      if l == authors_list.first #first
+        authors_list_final.push(l.strip)
+      elsif l == authors_list.last #last
+        authors_list_final.push(", &amp; " + l.strip)
+      else #all others
+        authors_list_final.push(", " + l.strip)
+      end
+    end
+    text += authors_list_final.join
+    unless text.blank?
+      if text[-1,1] != "."
+        text += ". "
+      else
+        text += " "
+      end
+    end
+    # Get Pub Date
+    text += "(" + setup_pub_date(record) + "). " unless setup_pub_date(record).nil?
+    
+    # setup title info
+    title = setup_title_info(record)
+    text += "<i>" + title + "</i> " unless title.nil?
+    
+    # Edition
+    edition_data = setup_edition(record)
+    text += edition_data + " " unless edition_data.nil?
+    
+    # Publisher info
+    text += setup_pub_info(record) unless setup_pub_info(record).nil?
+    unless text.blank?
+      if text[-1,1] != "."
+        text += "."
+      end
+    end
+    text
+  end
+  def setup_pub_date(record)
+    if !record.find{|f| f.tag == '260'}.nil?
+      pub_date = record.find{|f| f.tag == '260'}
+      if pub_date.find{|s| s.code == 'c'}
+        date_value = pub_date.find{|s| s.code == 'c'}.value.gsub(/[^0-9]/, "") unless pub_date.find{|s| s.code == 'c'}.value.gsub(/[^0-9]/, "").blank?
+      end
+      return nil unless !date_value.nil?
+    end
+    date_value
+  end
+  def setup_pub_info(record)
+    text = ''
+    pub_info_field = record.find{|f| f.tag == '260'}
+    if !pub_info_field.nil?
+      a_pub_info = pub_info_field.find{|s| s.code == 'a'}
+      b_pub_info = pub_info_field.find{|s| s.code == 'b'}
+      a_pub_info = clean_end_punctuation(a_pub_info.value.strip) unless a_pub_info.nil?
+      b_pub_info = b_pub_info.value.strip unless b_pub_info.nil?
+      text += a_pub_info.strip unless a_pub_info.nil?
+      if !a_pub_info.nil? and !b_pub_info.nil?
+        text += ": "
+      end
+      text += b_pub_info.strip unless b_pub_info.nil?
+    end
+    return nil if text.strip.blank?
+    clean_end_punctuation(text.strip)
+  end
+
+  def mla_citation_title(text)
+    no_upcase = ["a","an","and","but","by","for","it","of","the","to","with"]
+    new_text = []
+    word_parts = text.split(" ")
+    word_parts.each do |w|
+      if !no_upcase.include? w
+        new_text.push(w.capitalize)
+      else
+        new_text.push(w)
+      end
+    end
+    new_text.join(" ")
+  end
+
+  def setup_title_info(record)
+    text = ''
+    title_info_field = record.find{|f| f.tag == '245'}
+    if !title_info_field.nil?
+      a_title_info = title_info_field.find{|s| s.code == 'a'}
+      b_title_info = title_info_field.find{|s| s.code == 'b'}
+      a_title_info = clean_end_punctuation(a_title_info.value.strip) unless a_title_info.nil?
+      b_title_info = clean_end_punctuation(b_title_info.value.strip) unless b_title_info.nil?
+      text += a_title_info unless a_title_info.nil?
+      if !a_title_info.nil? and !b_title_info.nil?
+        text += ": "
+      end
+      text += b_title_info unless b_title_info.nil?
+    end
+    
+    return nil if text.strip.blank?
+    clean_end_punctuation(text.strip) + "."
+    
+  end
+  
+  def clean_end_punctuation(text)
+    if [".",",",":",";","/"].include? text[-1,1]
+      return text[0,text.length-1]
+    end
+    text
+  end  
+
+  def setup_edition(record)
+    edition_field = record.find{|f| f.tag == '250'}
+    edition_code = edition_field.find{|s| s.code == 'a'} unless edition_field.nil?
+    edition_data = edition_code.value unless edition_code.nil?
+    if edition_data.nil? or edition_data == '1st ed.'
+      return nil
+    else
+      return edition_data
+    end    
+  end
+  
+  def get_author_list(record)
+    author_list = []
+    authors_primary = record.find{|f| f.tag == '100'}
+    author_primary = authors_primary.find{|s| s.code == 'a'}.value unless authors_primary.nil?
+    author_list.push(clean_end_punctuation(author_primary)) unless author_primary.nil?
+    authors_secondary = record.find_all{|f| ('700') === f.tag}
+    if !authors_secondary.nil?
+      authors_secondary.each do |l|
+        author_list.push(clean_end_punctuation(l.find{|s| s.code == 'a'}.value)) unless l.find{|s| s.code == 'a'}.value.nil?
+      end
+    end
+
+    author_list.uniq!
+    author_list
+  end
+  
+  def abbreviate_name(name)
+    name_parts = name.split(", ")
+    first_name_parts = name_parts.last.split(" ")
+    temp_name = name_parts.first + ", " + first_name_parts.first[0,1] + "."
+    first_name_parts.shift
+    temp_name += " " + first_name_parts.join(" ") unless first_name_parts.empty?
+    temp_name
+  end
+
+  def name_reverse(name)
+    name = clean_end_punctuation(name)
+    temp_name = name.split(", ")
+    return temp_name.last + " " + temp_name.first
+  end 
+  
+  # Genrates a Z39.88 span element to pass the COinS metadata to Zotero
+  def z3988_span(record,format)
+    title = record.find{|field| field.tag == '245'}
+    author = record.find{|field| field.tag == '100'}
+    publisher_info = record.find{|field| field.tag == '260'}
+    edition = record.find{|field| field.tag == '250'}
+    isbn = record.find{|field| field.tag == '020'}
+    issn = record.find{|field| field.tag == '022'}
+    format.is_a?(Array) ? format = format[0].downcase.strip : format = format.downcase.strip
+    text = "<span class='Z3988' "
+      if format == 'book'
+        text << "title='ctx_ver=Z39.88-2004&amp;rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&amp;rfr_id=info%3Asid%2Fblacklight.rubyforge.org%3Agenerator&amp;rft.genre=book&amp;rft.btitle=#{(title.nil? or title['a'].nil?) ? "" : CGI::escape(title['a'])}+#{(title.nil? or title['b'].nil?) ? "" : CGI::escape(title['b'])}&amp;rft.title=#{(title.nil? or title['a'].nil?) ? "" : CGI::escape(title['a'])}+#{(title.nil? or title['b'].nil?) ? "" : CGI::escape(title['b'])}&amp;rft.au=#{(author.nil? or author['a'].nil?) ? "" : CGI::escape(author['a'])}&amp;rft.date=#{(publisher_info.nil? or publisher_info['c'].nil?) ? "" : CGI::escape(publisher_info['c'])}&amp;rft.pub=#{(publisher_info.nil? or publisher_info['a'].nil?) ? "" : CGI::escape(publisher_info['a'])}&amp;rft.edition=#{(edition.nil? or edition['a'].nil?) ? "" : CGI::escape(edition['a'])}&amp;rft.isbn=#{(isbn.nil? or isbn['a'].nil?) ? "" : isbn['a']}'"
+      elsif format.include?('journal') # checking using include because institutions may use formats like Journal or Journal/Magazine
+        text << "title='ctx_ver=Z39.88-2004&amp;rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Ajournal&amp;rfr_id=info%3Asid%2Fblacklight.rubyforge.org%3Agenerator&amp;rft.genre=article&amp;rft.title=#{(title.nil? or title['a'].nil?) ? "" : CGI::escape(title['a'])}+#{(title.nil? or title['b'].nil?) ? "" : CGI::escape(title['b'])}&amp;rft.atitle=#{(title.nil? or title['a'].nil?) ? "" : CGI::escape(title['a'])}+#{(title.nil? or title['b'].nil?) ? "" : CGI::escape(title['b'])}&amp;rft.date=#{(publisher_info.nil? or publisher_info['c'].nil?) ? "" : CGI::escape(publisher_info['c'])}&amp;rft.issn=#{(issn.nil? or issn['a'].nil?) ? "" : issn['a']}'"
+      else
+        text << "title='ctx_ver=Z39.88-2004&amp;rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Adc&amp;rfr_id=info%3Asid%2Fblacklight.rubyforge.org%3Agenerator&amp;rft.title=#{(title.nil? or title['a'].nil?) ? "" : CGI::escape(title['a'])}+#{(title.nil? or title['b'].nil?) ? "" : CGI::escape(title['b'])}&amp;rft.creator=#{(author.nil? or author['a'].nil?) ? "" : CGI::escape(author['a'])}&amp;rft.date=#{(publisher_info.nil? or publisher_info['c'].nil?) ? "" : CGI::escape(publisher_info['c'])}&amp;rft.pub=#{(publisher_info.nil? or publisher_info['a'].nil?) ? "" : CGI::escape(publisher_info['a'])}&amp;rft.format=#{CGI::escape(format)}'"
+      end
+    text << "></span>"
+  end
+end