blacklight 3.0.0pre4 → 3.0.0pre6

data/lib/blacklight/catalog.rb

@@ -1,11 +1,10 @@
 module Blacklight::Catalog 
   extend ActiveSupport::Concern
-
+  include Blacklight::SolrHelper
 
   # The following code is executed when someone includes blacklight::catalog in their
   # own controller.
   included do  
-    include Blacklight::SolrHelper
     before_filter :search_session, :history_session
     before_filter :delete_or_assign_search_session_params, :only => :index
     after_filter :set_additional_search_session_values, :only=>:index
@@ -92,22 +91,6 @@ module Blacklight::Catalog
       @pagination = get_facet_pagination(params[:id], params)
     end
     
-    # single document image resource
-    def image
-    end
-    
-    # single document availability status (true/false)
-    def status
-    end
-    
-    # single document availability info
-    def availability
-    end
-    
-    # collection/search UI via Google maps
-    def map
-    end
-    
     # method to serve up XML OpenSearch description and JSON autocomplete response
     def opensearch
       respond_to do |format|
@@ -122,11 +105,11 @@ module Blacklight::Catalog
     
     # citation action
     def citation
-      @response, @documents = get_solr_response_for_field_values("id",params[:id])
+      @response, @documents = get_solr_response_for_field_values(SolrDocument.unique_key,params[:id])
     end
     # grabs a bunch of documents to export to endnote
     def endnote
-      @response, @documents = get_solr_response_for_field_values("id",params[:id])
+      @response, @documents = get_solr_response_for_field_values(SolrDocument.unique_key,params[:id])
       respond_to do |format|
         format.endnote
       end
@@ -134,14 +117,14 @@ module Blacklight::Catalog
     
     # Email Action (this will render the appropriate view on GET requests and process the form and send the email on POST requests)
     def email
-      @response, @documents = get_solr_response_for_field_values("id",params[:id])
+      @response, @documents = get_solr_response_for_field_values(SolrDocument.unique_key,params[:id])
       if request.post?
         if params[:to]
           from = request.host # host w/o port for From address (from address cannot have port#)
           url_gen_params = {:host => request.host_with_port, :protocol => request.protocol}
           
           if params[:to].match(/^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}$/)
-            email = RecordMailer.create_email_record(@documents, {:to => params[:to], :message => params[:message]}, from, url_gen_params)
+            email = RecordMailer.email_record(@documents, {:to => params[:to], :message => params[:message]}, from, url_gen_params)
           else
             flash[:error] = "You must enter a valid email address"
           end
@@ -155,7 +138,7 @@ module Blacklight::Catalog
     
     # SMS action (this will render the appropriate view on GET requests and process the form and send the email on POST requests)
     def sms 
-      @response, @documents = get_solr_response_for_field_values("id",params[:id])
+      @response, @documents = get_solr_response_for_field_values(SolrDocument.unique_key,params[:id])
       if request.post?
         from = request.host # host w/o port for From address (from address cannot have port#)
         url_gen_params = {:host => request.host_with_port, :protocol => request.protocol}
@@ -166,7 +149,7 @@ module Blacklight::Catalog
             if phone_num.length != 10
               flash[:error] = "You must enter a valid 10 digit phone number"
             else
-              email = RecordMailer.create_sms_record(@documents, {:to => phone_num, :carrier => params[:carrier]}, from, url_gen_params)
+              email = RecordMailer.sms_record(@documents, {:to => phone_num, :carrier => params[:carrier]}, from, url_gen_params)
             end
             email.deliver unless flash[:error]
             redirect_to :back

data/lib/blacklight/controller.rb

@@ -86,7 +86,13 @@ module Blacklight::Controller
     # 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?
+      layout_name unless request.xml_http_request? || ! params[:no_layout].blank?
+    end
+    
+    #over-ride this one locally to change what layout BL controllers use, usually
+    #by defining it in your own application_controller.rb
+    def layout_name
+      'blacklight'
     end
 
     def current_user_session

data/lib/blacklight/engine.rb

@@ -11,17 +11,6 @@ module Blackight
       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|
-      # Check for a blacklight_install envrionment variable - if set then blacklight
-      # is actively being installed and we should not attempt an init at this time.
-      if defined?(Rails::Server)
-        Blacklight.init
-      end      
-    end
-
     # This makes our rake tasks visible.
     rake_tasks do
       Dir.chdir(File.expand_path(File.join(File.dirname(__FILE__), '..'))) do

data/lib/blacklight/routes.rb

@@ -0,0 +1,91 @@
+module Blacklight
+  class Routes
+
+    def initialize(router, options)
+      @router = router
+      @options = options
+    end
+
+    def draw
+      route_sets.each do |r|
+        self.send(r)
+      end
+    end
+
+    protected
+
+    def add_routes &blk
+      @router.instance_exec(@options, &blk)
+    end
+
+    def route_sets
+      (@options[:only] || default_route_sets) - (@options[:except] || [])
+    end
+
+    def default_route_sets
+      [:bookmarks, :folders, :search_history, :saved_searches, :catalog, :feedback]
+    end
+
+    module RouteSets
+      def bookmarks
+        add_routes do |options|
+          match "bookmarks/clear", :to => "bookmarks#clear", :as => "clear_bookmarks"
+          resources :bookmarks
+        end
+      end
+  
+  
+      def folders
+        add_routes do |options|
+           match "folder/clear", :to => "folder#clear", :as => "clear_folder"
+          match "folder/destroy", :to => "folder#destroy"
+          resources :folder, :only => [:index, :update, :destroy] 
+        end
+      end
+    
+      def search_history
+        add_routes do |options|
+          match "search_history",             :to => "search_history#index",   :as => "search_history"
+          match "search_history/clear",       :to => "search_history#clear",   :as => "clear_search_history"
+          match "search_history/destroy/:id", :to => "search_history#destroy", :as => "delete_search"
+        end
+      end
+  
+  
+      def saved_searches
+        add_routes do |options|
+          match "saved_searches/clear",       :to => "saved_searches#clear",   :as => "clear_saved_searches"
+          match "saved_searches",       :to => "saved_searches#index",   :as => "saved_searches"
+          match "saved_searches/save/:id",    :to => "saved_searches#save",    :as => "save_search"
+          match "saved_searches/forget/:id",  :to => "saved_searches#forget",  :as => "forget_search"
+        end
+      end
+    
+      def catalog
+        add_routes do |options|
+          # Catalog stuff.
+          match 'catalog/opensearch', :as => "opensearch_catalog"
+          match 'catalog/citation', :as => "citation_catalog"
+          match 'catalog/email', :as => "email_catalog"
+          match 'catalog/sms', :as => "sms_catalog"
+          match 'catalog/endnote', :as => "endnote_catalog"
+          match 'catalog/send_email_record', :as => "send_email_record_catalog"
+          match "catalog/facet/:id", :to => 'catalog#facet', :as => 'catalog_facet'
+          match 'catalog/unapi', :to => "catalog#unapi", :as => 'unapi'
+          resources :catalog, :only => [:index, :show, :update]
+          match 'catalog/:id/librarian_view', :to => "catalog#librarian_view", :as => "librarian_view_catalog"
+        end
+      end
+  
+    
+      # Feedback
+      def feedback
+        add_routes do |options|
+          match "feedback", :to => "feedback#show"    
+          match "feedback/complete", :to => "feedback#complete"
+        end
+      end
+    end
+    include RouteSets
+  end
+end

data/lib/blacklight/solr/document.rb

@@ -82,6 +82,7 @@ module Blacklight::Solr::Document
   
   def self.included(base)      
     base.send :include, RSolr::Ext::Model
+    base.send :include, InstanceMethods
     base.send :extend,  ClassMethods
    
     # after_initialize hook comes from RSolr::Ext::Model, I think.
@@ -90,7 +91,13 @@ module Blacklight::Solr::Document
        apply_extensions 
     end
   end    
-    
+
+  module InstanceMethods
+    def id
+      self[self.class.unique_key]
+    end
+  end
+
 
     # Needs to be called in initializer of class including this module, to
     # apply all registered extensions on a per-document basis
@@ -192,6 +199,14 @@ module Blacklight::Solr::Document
   # extendability architecture
   module ClassMethods
     attr_writer :registered_extensions
+
+     def unique_key
+       Blacklight.config[:unique_key] || 'id'
+     end
+
+     def connection
+      @connection ||= Blacklight.solr
+     end
     
     # Returns array of hashes of registered extensions. Each hash
     # has a :module_obj key and a :condition_proc key. Usually this

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

@@ -39,6 +39,10 @@ module Blacklight::Solr::Document::MarcExport
   def export_as_mla_citation_txt
     mla_citation( to_marc )
   end
+  
+  def export_as_chicago_citation_txt
+    chicago_citation( to_marc )
+  end
 
   # Exports as an OpenURL KEV (key-encoded value) query string.
   # For use to create COinS, among other things. COinS are
@@ -220,6 +224,129 @@ module Blacklight::Solr::Document::MarcExport
 
   protected
   
+  # Main method for defining chicago style citation.  If we don't end up converting to using a citation formatting service
+  # we should make this receive a semantic document and not MARC so we can use this with other formats.
+  def chicago_citation(marc)
+    authors = get_all_authors(marc)    
+    author_text = ""
+    unless authors[:primary_authors].blank?
+      if authors[:primary_authors].length > 10
+        authors[:primary_authors].each_with_index do |author,index|
+          if index < 7
+            if index == 0
+              author_text << "#{author}"
+              if author.ends_with?(",")
+                author_text << " "
+              else
+                author_text << ", "
+              end
+            else
+              author_text << "#{name_reverse(author)}, "
+            end
+          end
+        end
+        author_text << " et al."
+      elsif authors[:primary_authors].length > 1
+        authors[:primary_authors].each_with_index do |author,index|
+          if index == 0
+            author_text << "#{author}"
+            if author.ends_with?(",")
+              author_text << " "
+            else
+              author_text << ", "
+            end
+          elsif index + 1 == authors[:primary_authors].length
+            author_text << "and #{name_reverse(author)}."
+          else
+            author_text << "#{name_reverse(author)}, "
+          end 
+        end
+      else
+        author_text << authors[:primary_authors].first
+      end
+    else
+      temp_authors = []
+      authors[:translators].each do |translator|
+        temp_authors << [translator, "trans."]
+      end
+      authors[:editors].each do |editor|
+        temp_authors << [editor, "ed."]
+      end
+      authors[:compilers].each do |compiler|
+        temp_authors << [compiler, "comp."]
+      end
+      
+      unless temp_authors.blank?
+        if temp_authors.length > 10
+          temp_authors.each_with_index do |author,index|
+            if index < 7
+              author_text << "#{author.first} #{author.last} "
+            end
+          end
+          author_text << " et al."
+        elsif temp_authors.length > 1
+          temp_authors.each_with_index do |author,index|
+            if index == 0
+              author_text << "#{author.first} #{author.last}, "
+            elsif index + 1 == temp_authors.length
+              author_text << "and #{name_reverse(author.first)} #{author.last}"
+            else
+              author_text << "#{name_reverse(author.first)} #{author.last}, "
+            end
+          end
+        else
+          author_text << "#{temp_authors.first.first} #{temp_authors.first.last}"
+        end
+      end
+    end
+    title = ""
+    additional_title = ""
+    section_title = ""
+    if marc["245"] and (marc["245"]["a"] or marc["245"]["b"])
+      title << citation_title(clean_end_punctuation(marc["245"]["a"]).strip) if marc["245"]["a"]
+      title << ": #{citation_title(clean_end_punctuation(marc["245"]["b"]).strip)}" if marc["245"]["b"]
+    end
+    if marc["245"] and (marc["245"]["n"] or marc["245"]["p"])
+      section_title << citation_title(clean_end_punctuation(marc["245"]["n"])) if marc["245"]["n"]
+      if marc["245"]["p"]
+        section_title << ", <i>#{citation_title(clean_end_punctuation(marc["245"]["p"]))}.</i>"
+      elsif marc["245"]["n"]
+        section_title << "."
+      end
+    end
+    
+    if !authors[:primary_authors].blank? and (!authors[:translators].blank? or !authors[:editors].blank? or !authors[:compilers].blank?)
+        additional_title << "Translated by #{authors[:translators].collect{|name| name_reverse(name)}.join(" and ")}. " unless authors[:translators].blank?
+        additional_title << "Edited by #{authors[:editors].collect{|name| name_reverse(name)}.join(" and ")}. " unless authors[:editors].blank?
+        additional_title << "Compiled by #{authors[:compilers].collect{|name| name_reverse(name)}.join(" and ")}. " unless authors[:compilers].blank?
+    end
+    
+    edition = ""
+    edition << setup_edition(marc) unless setup_edition(marc).nil?
+    
+    pub_info = ""
+    if marc["260"] and (marc["260"]["a"] or marc["260"]["b"]) 
+      pub_info << clean_end_punctuation(marc["260"]["a"]).strip if marc["260"]["a"]
+      pub_info << ": #{clean_end_punctuation(marc["260"]["b"]).strip}" if marc["260"]["b"]
+      pub_info << ", #{setup_pub_date(marc)}" if marc["260"]["c"]
+    elsif marc["502"] and marc["502"]["a"] # MARC 502 is the Dissertation Note.  This holds the correct pub info for these types of records.
+      pub_info << marc["502"]["a"]
+    elsif marc["502"] and (marc["502"]["b"] or marc["502"]["c"] or marc["502"]["d"]) #sometimes the dissertation note is encoded in pieces in the $b $c and $d sub fields instead of lumped into the $a
+      pub_info << "#{marc["502"]["b"]}, #{marc["502"]["c"]}, #{clean_end_punctuation(marc["502"]["d"])}"
+    end
+    
+    citation = ""
+    citation << "#{author_text} " unless author_text.blank?
+    citation << "<i>#{title}.</i> " unless title.blank?
+    citation << "#{section_title} " unless section_title.blank?
+    citation << "#{additional_title} " unless additional_title.blank?
+    citation << "#{edition} " unless edition.blank?
+    citation << "#{pub_info}." unless pub_info.blank?
+    citation
+  end
+  
+  
+  
   def mla_citation(record)
     text = ''
     authors_final = []
@@ -320,11 +447,11 @@ module Blacklight::Solr::Document::MarcExport
     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?
+        date_value = pub_date.find{|s| s.code == 'c'}.value.gsub(/[^0-9|n\.d\.]/, "")[0,4] unless pub_date.find{|s| s.code == 'c'}.value.gsub(/[^0-9|n\.d\.]/, "")[0,4].blank?
       end
-      return nil unless !date_value.nil?
+      return nil if date_value.nil?
     end
-    date_value
+    clean_end_punctuation(date_value) if date_value
   end
   def setup_pub_info(record)
     text = ''
@@ -357,6 +484,22 @@ module Blacklight::Solr::Document::MarcExport
     end
     new_text.join(" ")
   end
+  
+  # This will replace the mla_citation_title method with a better understanding of how MLA and Chicago citation titles are formatted.
+  # This method will take in a string and capitalize all of the non-prepositions.
+  def citation_title(title_text)
+    prepositions = ["a","about","across","an","and","before","but","by","for","it","of","the","to","with","without"]
+    new_text = []
+    title_text.split(" ").each_with_index do |word,index|
+      if (index == 0 and word != word.upcase) or (word.length > 1 and word != word.upcase and !prepositions.include?(word))
+        # the split("-") will handle the capitalization of hyphenated words
+        new_text << word.split("-").map!{|w| w.capitalize }.join("-")
+      else
+        new_text << word
+      end
+    end
+    new_text.join(" ")
+  end
 
   def setup_title_info(record)
     text = ''
@@ -407,11 +550,37 @@ module Blacklight::Solr::Document::MarcExport
         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
   
+  # This is a replacement method for the get_author_list method.  This new method will break authors out into primary authors, translators, editors, and compilers
+  def get_all_authors(record)
+    translator_code = "trl"; editor_code = "edt"; compiler_code = "com"
+    primary_authors = []; translators = []; editors = []; compilers = []
+    record.find_all{|f| f.tag === "100" }.each do |field|
+      primary_authors << field["a"] if field["a"]
+    end
+    record.find_all{|f| f.tag === "700" }.each do |field|
+      if field["a"]
+        relators = []
+        relators << clean_end_punctuation(field["e"]) if field["e"]
+        relators << clean_end_punctuation(field["4"]) if field["4"]
+        if relators.include?(translator_code)
+          translators << field["a"]
+        elsif relators.include?(editor_code)
+          editors << field["a"]
+        elsif relators.include?(compiler_code)
+          compilers << field["a"]
+        else
+          primary_authors << field["a"]
+        end
+      end
+    end
+    {:primary_authors => primary_authors, :translators => translators, :editors => editors, :compilers => compilers}
+  end
+  
   def abbreviate_name(name)
     name_parts = name.split(", ")
     first_name_parts = name_parts.last.split(" ")
@@ -423,6 +592,7 @@ module Blacklight::Solr::Document::MarcExport
 
   def name_reverse(name)
     name = clean_end_punctuation(name)
+    return name unless name =~ /,/
     temp_name = name.split(", ")
     return temp_name.last + " " + temp_name.first
   end