bento_search 0.6.0 → 0.7.0

data/app/item_decorators/bento_search/decorator_base.rb

@@ -0,0 +1,53 @@
+require 'delegate'
+
+module BentoSearch
+  # A delegator with an ActionView context. 
+  # You can access the ActionView context at _h , to call Rails helper
+  # methods (framework or app specific, whatever should be avail at
+  # given context)
+  #
+  # inside a method in a decorator, `_h.content_tag` or `_h.html_escape`
+  # or `_h.url_for` etc.   
+  #
+  #   (Except you can't call html_escape that way becuase Rails makes it
+  #   private for some reason, wtf. We provide an html_escape) 
+  # 
+  # Inside a decorator, access #_base to get undecorated base model. 
+  class DecoratorBase < SimpleDelegator
+    
+    def initialize(base, view_context)
+      super(base)
+      
+      
+      # This worked to make html_escape avail at _h.html_escape, but
+      # yfeldblum warned it messes up the method lookup cache, so
+      # we just provide a straight #html_escape instead.  
+      #if view_context.respond_to?(:html_escape, true)
+        # thanks yfeldblum in #rails for this simple way to make
+        # html_escape public, which I don't entirely understand myself. :)
+       
+      #  class << view_context
+      #    public :html_escape
+      #  end        
+      #end      
+      
+      @view_context = view_context
+      @base = base
+    end
+    
+    def _h
+      @view_context
+    end    
+    
+    def _base
+      @base
+    end
+    
+    # _h.html_escape won't work because Rails makes html_escape
+    # private for some weird reason. We provide our own here instead. 
+    def html_escape(*args, &block)
+      ERB::Util.html_escape(*args, &block)
+    end
+    
+  end  
+end

data/app/item_decorators/bento_search/ebscohost/conditional_openurl_main_link.rb

@@ -0,0 +1,36 @@
+#  DEPRECATED. Just write the logic into a custom Decorator yourself.
+#  See wiki on decorators. 
+#
+#
+# For ebscohost connector, example of an Item Decorator that replaces the main 
+# 'link' with an openurl ONLY if there is NOT fulltext avail from EBSCO.  
+#
+# This example uses crazy metaprogramming to dynamically create
+# a module configured with your base url etc. You don't need to use
+# crazy method like that; just define your own local decorator doing
+# exactly what you need, it's meant to be simple. 
+#
+#  config.item_decorators = [ BentoSearch::Ebscohost::ConditionalOpenurlMainLink[:base_url => "http://resolve.somewhere.edu/foo", :extra_query => "&foo=bar"] ]
+#
+module BentoSearch::Ebscohost::ConditionalOpenurlMainLink
+  def self.[](options)
+    base_url = options[:base_url]
+    extra_query = options[:extra_query] || ""
+    Module.new do
+      
+      define_method :link do
+        if custom_data["fulltext_formats"]
+          super()
+        elsif (ou = to_openurl)
+          "#{base_url}?#{ou.kev}#{extra_query}"
+        else
+          nil
+        end
+      end
+      
+    end
+  end
+  
+  
+  
+end

data/app/item_decorators/bento_search/no_links.rb

@@ -1,5 +1,6 @@
-# An item decorator that just erases all links, main link and other
-# links. 
+# An item decorator mix-in that just erases all links, main link and other
+# links. May be convenient to `include BentoSearch::NoLinks` in your 
+# custom decorator, although you could always just write this yourself too. 
 module BentoSearch::NoLinks
   
   def link

data/app/item_decorators/bento_search/only_premade_openurl.rb

@@ -1,3 +1,7 @@
+#  DEPRECATED. Just write the logic into a custom Decorator yourself.
+#  See wiki on decorators. 
+
+
 require 'openurl'
 
 # A Decorator that will make #to_openurl refuse to construct

data/app/item_decorators/bento_search/openurl_add_other_link.rb

@@ -1,3 +1,7 @@
+#  DEPRECATED. Just write the logic into a custom Decorator yourself.
+#  See wiki on decorators. 
+#
+#
 # Example of an Item Decorator that ADDs an 'other link' with an openurl. 
 #
 # This example uses crazy metaprogramming to dynamically create

data/app/item_decorators/bento_search/openurl_main_link.rb

@@ -1,3 +1,7 @@
+#  DEPRECATED. Just write the logic into a custom Decorator yourself.
+#  See wiki on decorators. 
+
+
 # Example of an Item Decorator that replaces the main 'link'
 # with an openurl. 
 #

data/app/item_decorators/bento_search/standard_decorator.rb

@@ -0,0 +1,122 @@
+module BentoSearch
+  class StandardDecorator < DecoratorBase
+    
+    
+    # How to display a BentoSearch::Author object as a name
+    def author_display(author)
+      if (author.first && author.last)
+        "#{author.last}, #{author.first.slice(0,1)}"
+      elsif author.display
+        author.display
+      elsif author.last
+        author.last
+      else
+        nil
+      end
+    end
+    
+    # Put together title and subtitle if neccesary. 
+    def complete_title
+      t = self.title
+      if self.subtitle
+        t = safe_join([t, ": ", self.subtitle], "")        
+      end
+      
+      if t.blank?
+        t = I18n.translate("bento_search.missing_title")
+      end
+      
+      return t
+    end
+    
+    
+    
+    
+    
+    # A simple user-displayable citation, _without_ author/title.
+    # the journal, year, vol, iss, page; or publisher and year; etc. 
+    # Constructed from individual details. Not formal APA or MLA or anything,
+    # just a rough and ready display. 
+    #
+    # TODO: Should this be moved to a rails helper method? Not sure. 
+    def published_in
+      result_elements = []
+      
+      result_elements.push("<span class='source_label'>#{I18n.t("bento_search.published_in")}</span><span class='source_title'>#{html_escape source_title}</span>".html_safe) unless source_title.blank?      
+      
+      if source_title.blank? && ! publisher.blank?
+        result_elements.push html_escape publisher
+      end
+      
+      result_elements.push("#{I18n.t('bento_search.volume')} #{volume}") if volume.present?
+      
+      result_elements.push("#{I18n.t('bento_search.issue')} #{issue}") if issue.present?
+            
+      if (! start_page.blank?) && (! end_page.blank?)
+        result_elements.push html_escape "#{I18n.t('bento_search.pages')} #{start_page}-#{end_page}"
+      elsif ! start_page.blank?
+        result_elements.push html_escape "#{I18n.t('bento_search.page')} #{start_page}"
+      end
+      
+      return nil if result_elements.empty?
+      
+      return result_elements.join(", ").html_safe
+    end
+    
+        # A display method, this is like #langauge_str, but will be nil if
+    # the language_code matches the current default locale, used
+    # for printing language only when not "English" normally. 
+    #
+    #(Sorry, will be 'Spanish' never 'Espa~nol", we don't
+    # have a data source for language names in other languages right now. )
+    def display_language
+      return nil unless self.language_code
+      
+      default = I18n.locale.try {|l| l.to_s.gsub(/\-.*$/, '')} || "en" 
+      
+      this_doc = self.language_obj.try(:iso_639_1)
+      
+      return nil if this_doc == default
+      
+      self.language_str
+    end
+    
+    # format string to display to user. Uses #format_str if present,
+    # otherwise finds an i18n label from #format. Returns nil if none
+    # available. 
+    def display_format      
+      value = self.format_str || 
+        I18n.t(self.format, :scope => [:bento_search, :format], :default => self.format.to_s.titleize)
+        
+      return value.blank? ? nil : value        
+    end
+
+    
+    ###################
+    # turn into a representative OpenURL
+    #
+    #  use to_openurl_kev to go straight there, 
+    #  or to_openurl to get a ruby OpenURL object.
+    ###################
+    
+
+    # Returns a ruby OpenURL::ContextObject (NISO Z39.88).  
+    # or nil if none avail. 
+    def to_openurl
+      return nil if openurl_disabled
+      
+      BentoSearch::OpenurlCreator.new(self).to_openurl
+    end
+    
+    # Returns a kev encoded openurl, that is a URL query string representing
+    # openurl. Or nil if none available. 
+    #
+    # Right now just calls #to_openurl.kev, can conceivably
+    # be modified to do things more efficient, without a ruby openurl
+    # obj. Law of demeter, represent.     
+    def to_openurl_kev
+      to_openurl.try(:kev)      
+    end
+    
+  end
+end

data/app/models/bento_search/multi_searcher.rb

@@ -2,7 +2,8 @@ require 'celluloid'
 
 # Based on Celluloid, concurrently runs multiple searches in
 # seperate threads. You must include 'celluloid' gem dependency
-# into your local app to use this class. 
+# into your local app to use this class. Requires celluloid 0.12.0
+# or above (for new preferred async syntax). 
 #
 # I am not an expert at use of Celluloid, it's possible there's a better
 # way to do this all, but seems to work. 
@@ -13,7 +14,7 @@ require 'celluloid'
 #     searcher = BentoBox::MultiSearcher.new(:gbs, :scopus)
 #
 # start the concurrent searches, params same as engine.search
-#     searcher.start( query_params )
+#     searcher.search( query_params )
 #
 # retrieve results, blocking until each is completed:
 #     searcher.results
@@ -25,7 +26,12 @@ require 'celluloid'
 # 
 # important to call results at some point after calling start, in order
 # to make sure Celluloid::Actors are properly terminated to avoid
-# resource leakage. 
+# resource leakage. May want to do it in an ensure block. 
+#
+# Note that celluloid uses multi-threading in such a way that you
+# may have to set config.cache_classes=true even in development
+# to avoid problems. Rails class reloading is not thread-safe.
+#
 #
 # TODO: have a method that returns Futures instead of only supplying the blocking
 # results method? Several tricks, including making sure to properly terminate actors. 
@@ -46,14 +52,15 @@ class BentoSearch::MultiSearcher
   end
   
   # Starts all searches, returns self so you can chain method calls if you like. 
-  def start(*search_args)
+  def search(*search_args)
     @engines.each do |engine|
       a = Actor.new(engine)
       @actors << a
-      a.start! *search_args
+      a.async.start *search_args
     end    
     return self
   end
+  alias_method :start, :search # backwards compat
   
   # Call after #start. Blocks until each included engine is finished
   # then returns a Hash keyed by engine registered id, value is a
@@ -87,7 +94,7 @@ class BentoSearch::MultiSearcher
       self.engine = a_engine
     end
     
-    # call as start! with bang, to invoke async. 
+    # call as .async.start, to invoke async. 
     def start(*search_args)
       begin
         @results = self.engine.search(*search_args)

data/app/models/bento_search/openurl_creator.rb

@@ -1,4 +1,5 @@
 require 'openurl'
+require 'cgi'
 
 module BentoSearch
   
@@ -7,7 +8,7 @@ module BentoSearch
   # a NISO Z39.88 OpenURL context object, useful for using
   # with linking software that expects such. http://en.wikipedia.org/wiki/OpenURL
   #
-  #     co = OpenurlCreator.new(  result_item ).to_open_url
+  #     co = OpenurlCreator.new(  decorated_result_item ).to_open_url
   #        # => ruby OpenURL::ContextObject object.
   #
   #     co.kev 
@@ -20,6 +21,9 @@ module BentoSearch
     
     attr_accessor :result_item
     
+    # Pass in a DECORATED result_item, eg StandardDecorator.new(result_item, nil)
+    # Need the display logic methods in the decorator, not just a raw
+    # result_item. 
     def initialize(ri)
       self.result_item = ri
     end
@@ -38,7 +42,13 @@ module BentoSearch
       r.set_format( self.format )
       
       if result_item.doi
-        r.add_identifier("info:doi:#{result_item.doi}")
+        r.add_identifier("info:doi/#{result_item.doi}")
+      end
+      
+      if result_item.oclcnum
+        r.add_identifier("info:oclcnum/#{result_item.oclcnum}")
+        # and do the one that's not actually legal practice, but is common
+        r.set_metadata("oclcnum", result_item.oclcnum)
       end
       
       r.set_metadata("genre", self.genre)
@@ -49,7 +59,13 @@ module BentoSearch
         r.set_metadata("au", result_item.author_display(ensure_no_tags result_item.authors.first))
       end
 
-      r.set_metadata("date",    result_item.year.to_s)
+      if result_item.publication_date
+        r.set_metadata("date", result_item.publication_date.iso8601)
+      else
+        r.set_metadata("date",    result_item.year.to_s)
+      end
+      
+      
       r.set_metadata("volume",  result_item.volume.to_s)
       r.set_metadata("issue",   result_item.issue.to_s)
       r.set_metadata("spage",   result_item.start_page.to_s)
@@ -59,9 +75,13 @@ module BentoSearch
       r.set_metadata("isbn",    result_item.isbn)
       r.set_metadata("pub",     ensure_no_tags(result_item.publisher))
       
+      
       case result_item.format
       when "Book"
         r.set_metadata("btitle", ensure_no_tags(result_item.complete_title))
+      when :book_item         
+        r.set_metadata("btitle", result_item.source_title)
+        r.set_metadata("atitle", result_item.title)                  
       when "Article", :conference_paper
         r.set_metadata("atitle", ensure_no_tags(result_item.complete_title))
       else
@@ -116,8 +136,8 @@ module BentoSearch
     # with much actual software, as a neutral default. 
     def format
       case result_item.format
-      when "Book"
-        "book"
+      when "Book", :book_item
+        "book"      
       when :dissertation
         "dissertation"
       else

data/app/models/bento_search/result_item.rb

@@ -51,6 +51,15 @@ module BentoSearch
     # * schema.org CreativeWork: 'url'
     attr_accessor :link
     
+    # does the #link correspond to fulltext?  true or false -- or nil
+    # for unknown/non-applicable. Not all engines will set. 
+    def link_is_fulltext?
+      @link_is_fulltext
+    end
+    def link_is_fulltext=(v)
+      @link_is_fulltext = v
+    end
+    
     # normalized controlled vocab title, important this is supplied
     # if possible for OpenURL generation and other features. 
     #
@@ -98,7 +107,8 @@ module BentoSearch
     # language_code. 
     # 
     # Consumers can look at language_code or language_str regardless (although
-    # either or both may be nil). You can use language_list gem to normalize to a 
+    # either or both may be nil). You can get a language_list gem obj from
+    # language_obj, and use to normalize to a 
     # 2- or 3-letter from language_code that could be either. 
     attr_accessor :language_code
     attr_writer :language_str
@@ -109,13 +119,24 @@ module BentoSearch
         end
       end
     end
+    # Returns a LanguageList gem language object, from #language_code,
+    # convenience
+    def language_obj
+      return nil unless self.language_code
+      
+      @language_obj ||= LanguageList::LanguageInfo.find( self.language_code )
+    end
     
     # year published. a ruby int
     # PART of:. 
     # * schema.org CreativeWork "datePublished", year portion
     # * dcterms.issued, year portion
     # * prism:coverDate, year portion
+    #
+    # See also publication_date when you have a complete date
     attr_accessor :year
+    # ruby stdlib Date object. 
+    attr_accessor :publication_date
     
     attr_accessor :volume
     attr_accessor :issue
@@ -160,89 +181,10 @@ module BentoSearch
     # for internal use. 
     attr_accessor :custom_data
     
+    # Copied over from engine configuration usually, a string
+    # qualified name of a decorator class. Can be nil for default. 
+    attr_accessor :decorator
     
-    # Returns a ruby OpenURL::ContextObject (NISO Z39.88).     
-    def to_openurl
-      return nil if openurl_disabled
-      
-      BentoSearch::OpenurlCreator.new(self).to_openurl
-    end
-    
-    ##################
-    # Presentation related methods. 
-    # yes, it really makes sense to include them here, they can be overridden
-    # by decorators. 
-    # May extract these to their own base decorator module at some point,
-    # but the OO hieararchy would be basically the same either way. 
-    #######################
-    
-    
-    # How to display a BentoSearch::Author object as a name
-    def author_display(author)
-      if (author.first && author.last)
-        "#{author.last}, #{author.first.slice(0,1)}"
-      elsif author.display
-        author.display
-      elsif author.last
-        author.last
-      else
-        nil
-      end
-    end
-    
-    # Put together title and subtitle if neccesary. 
-    def complete_title
-      t = self.title
-      if self.subtitle
-        t = safe_join([t, ": ", self.subtitle], "")        
-      end
-      
-      if t.blank?
-        t = I18n.translate("bento_search.missing_title")
-      end
-      
-      return t
-    end
-    
-    
-    
-    # A simple user-displayable citation, _without_ author/title.
-    # the journal, year, vol, iss, page; or publisher and year; etc. 
-    # Constructed from individual details. Not formal APA or MLA or anything,
-    # just a rough and ready display. 
-    #
-    # TODO: Should this be moved to a rails helper method? Not sure. 
-    def published_in
-      result_elements = []
-
-      unless year.blank?
-        # wrap year in a span so we can bold it. 
-        result_elements.push "<span class='year'>#{year}</span>"
-      end
-      
-      result_elements.push(source_title) unless source_title.blank?      
-      
-      if source_title.blank? && ! publisher.blank?
-        result_elements.push html_escape publisher
-      end
-      
-      if (! volume.blank?) && (! issue.blank?)
-        result_elements.push html_escape "#{volume}(#{issue})"
-      else
-        result_elements.push html_escape volume unless volume.blank?
-        result_elements.push html_escape issue unless issue.blank?
-      end
-      
-      if (! start_page.blank?) && (! end_page.blank?)
-        result_elements.push html_escape "pp. #{start_page}-#{end_page}"
-      elsif ! start_page.blank?
-        result_elements.push html_escape "p. #{start_page}"
-      end
-      
-      return nil if result_elements.empty?
-      
-      return result_elements.join(", ").html_safe
-    end
     
   end
 end