umlaut 3.3.1 → 4.0.0.beta1

data/app/models/sfx4/local/base.rb

@@ -1,8 +1,6 @@
 module Sfx4
   module Local
     class Base < ActiveRecord::Base
-      attr_accessible
-
       # Was a SFX DB connection set in database.yml to connect directly to sfx?
       def self.connection_configured?
         config = ActiveRecord::Base.configurations["sfx_db"]

data/app/models/sfx_url.rb

@@ -14,7 +14,7 @@ class SfxUrl < ActiveRecord::Base
     ActiveRecord::Base.connection_pool.with_connection do
       # Does it match any of our supplementary configged strings or regexps?
       UmlautController.umlaut_config.lookup!("sfx.additional_sfx_controlled_urls", []).each do |test|
-        '===' # will match a regexp or equality on a string
+        # '===' will match a regexp or equality on a string
         return true if test === url
       end
       
@@ -29,7 +29,7 @@ class SfxUrl < ActiveRecord::Base
       # If URI was malformed, just punt and say no.
       return false unless host    
       
-      return SfxUrl.find(:all, :conditions => ["url = ?", host]).length > 0
+      return SfxUrl.where(:url => host).count > 0
     end
   end
 end

data/app/presentation/section_renderer.rb

@@ -63,6 +63,8 @@
 #   ServiceTypeValue["fulltext"]
 #
 # * The section will be displayed with stock heading block including a title
+#   from Rails i18n under key `umlaut.display_sections.#{section_id}.title`,
+#   or if not there then 
 #   constructed from the display_name of ServiceTypeValue["fulltext"], or 
 #   in general the display_name of the first ServiceTypeValue included
 #   in this section.
@@ -102,10 +104,17 @@
 #
 # === Customizing heading display
 #
-# You can supply a title for the section that's different than what would
+# Using Rails i18n, you can supply a title for the section that's different than what would
 # be guessed from it's ServiceTypeValues. You can also supply a prompt.
 #
-#   {:div_id =>"excerpts", :section_title=>"Lots of good stuff", :section_prompt => "Limited previes and excerpts."}
+#   {:div_id =>"excerpts"}
+#
+# In your config/locales/en.yml (or other language):
+#    umlaut:
+#      display_sections:
+#         excerpts:
+#           title: "Really great Excerpts"
+#           prompt: "Click on them to see them, far out!"
 #
 # You can also suppress display of the stock section heading at all:
 #   {:show_heading => false, ...}
@@ -120,8 +129,15 @@
 #   {:show_spinner => false, ...}
 #
 # By default, the spinner displays what type of thing it's waiting on, guessing
-# from the ServiceTypeValue configured. If you want to specify this item name:
-#   {:item_name_plural => "Related Items", ...}
+# from the ServiceTypeValue configured. If you want to specify this item name, 
+# use Rails i18n under the section_id in config/locales/en.yml, generally
+# using a plural name:
+#
+#     umlaut:
+#       display_sections:
+#         excerpts:
+#           load_more_item_name: "amazing excerpts"
+#   
 #
 # === Customizing visibility of section
 #
@@ -231,15 +247,12 @@ class SectionRenderer
   #            generally as unique ID for the section.
   # * [service_type_values] ServiceTypeValue's that this section contains.
   #                         defaults to [ServiceTypeValue[div_id]]
-  # * [section_title] Title for the section. Defaults to 
+  # * [section_title] (DEPRECATED, use Rails i18n) Title for the section. Defaults to 
   #                   service_type_values.first.display_name
   # * [section_prompt] Prompt. Default nil.
   # * [show_heading] Show the heading section at all. Default true.
   # * [show_spinner] Show a stock spinner for bg action for service_type_values.
   #                  default true.
-  # * [item_name_plural] Pluralized name of the objects included, used in
-  #                       spinner message. Default 
-  #                       service_type_values.first.display_name_pluralize
   # * [visibilty] What logic to use to decide whether to show the section at
   #               all. true|false|:any_services|:in_progress|:responses_exist|:complete_with_responses|(lambda object)
   # * [list_visible_limit] Use list_with_limit to limit initially displayed
@@ -287,7 +300,7 @@ class SectionRenderer
       @responses = {}
       service_type_values.each do |st|
         @responses[st.name] = @umlaut_request.get_service_type(st) 
-      end
+      end      
     end
     @responses
   end
@@ -323,11 +336,15 @@ class SectionRenderer
   # a spinner for this section. Called by section_display partial,
   # nobody else should need to call it. 
   def spinner_render_hash
+    custom_item_name = I18n.t("load_more_item_name", :scope => "umlaut.display_sections.#{self.div_id}", :default => "")
+    custom_item_name = nil if custom_item_name.blank?
+
     { :partial => "background_progress",
       :locals =>{ :svc_types => service_type_values,
                   :div_id => "progress_#{@section_id}",
                   :current_set_empty => responses_empty?,
-                  :item_name => @options[:item_name_plural]}
+                  :item_name => custom_item_name
+                }
     }
   end
   
@@ -397,7 +414,7 @@ class SectionRenderer
   # if they've completed without doing so?.         
   def any_services?
     nil != @umlaut_request.dispatched_services.to_a.find do |ds|
-        ! (service_type_values & ds.service.service_types_generated ).empty? 
+        ! (service_type_values & ds.can_generate_service_types ).empty? 
     end
   end
 
@@ -405,12 +422,49 @@ class SectionRenderer
     @options[:list_visible_limit]
   end
   
+  # Display title of the section can come from several places, in order
+  # of precedence:
+  #   * 1. (DEPRECATED) :section_title key in config hash. Prefer i18n instead. 
+  #   * 2. Rails i18n, under key 'umlaut.display_sections.#{section_id}.title'
+  #   * 3. If not given, as a default we use the display_name of the first ServiceTypeValue
+  #        object included in this section's results. 
+  #  If still blank after all those lookups, then no section title. Set a section title
+  #  to the empty string in i18n to force no section title. 
   def section_title
-    @options[:section_title]
+    section_title = nil
+
+    if @options.has_key? :section_title
+      # deprecation warning? Not sure the right way to do that. 
+      section_title = @options[:section_title]
+    else
+      section_title = I18n.t("title", :scope => "umlaut.display_sections.#{self.div_id}", 
+        :default => Proc.new {
+          # Look up from service_type name if possible as default
+          if (service_type_values.length > 0)
+            service_type_values.first.display_name_pluralize.titlecase
+          else
+            ""
+          end
+      })
+    end
+
+    section_title = nil if section_title.blank?
+    return section_title
   end
 
+  # Optional section prompt, from Rails i18n key `umlaut.display_sections.#{section_div_id}.prompt`
+  # Deprecated legacy, you can force with :section_prompt key in section config hash. 
   def section_prompt
-    @options[:section_prompt]
+    prompt = nil
+
+    if @options.has_key?(:section_prompt)
+      prompt = @options[:section_prompt]
+    else
+      prompt = I18n.t("prompt", :scope => "umlaut.display_sections.#{self.div_id}", :default => "")
+    end
+    
+    prompt = nil if prompt.blank?
+    return prompt
   end
 
   # For a given resonse type section, returns a string that will change 
@@ -450,15 +504,7 @@ class SectionRenderer
     
 
     # service type value default to same name as section_id
-    @options[:service_type_values] ||= [@section_id]
-
-    
-    # Fill in calculatable-defaults
-    if (service_type_values.length > 0)
-      @options = {:section_title => 
-                    service_type_values.first.display_name
-                  }.merge(@options)
-    end
+    @options[:service_type_values] ||= [@section_id]    
 
     # Partials to display. Default to _standard_response_item item partial.
     if ( @options[:partial] == true)

data/app/service_adaptors/ajax_export.rb

@@ -18,6 +18,7 @@ class AjaxExport < Service
       
     request.add_service_response(:service=>self, 
       :display_text => @display_text,
+      :display_text_i18n => @display_text_i18n,
       :link_supports_ajax_call => true,
       :notes=> @note,
       :service_type_value => 'export_citation'  )

data/app/service_adaptors/amazon.rb

@@ -239,7 +239,8 @@ class Amazon < Service
       unless ( desc_text.blank? )
         request.add_service_response(
           :service=>self, 
-          :display_text => "Description from Amazon.com", 
+          :display_text => "Description from Amazon.com",
+          :display_text_i18n => "description", 
           :url => item_url, 
           :key=>'abstract', 
           :value_string=>asin, 
@@ -341,6 +342,7 @@ class Amazon < Service
         request.add_service_response( 
           :service => self,
           :display_text=>@display_name,
+          :display_text_i18n => "display_name",
           :url=> reader_url,
           :service_type_value => :search_inside
          )   
@@ -357,7 +359,8 @@ class Amazon < Service
             :service=>self,
             :url => reader_url, 
             :asin=>asin,
-            :display_text => @display_name,            
+            :display_text => @display_name,
+            :display_text_i18n => "display_name",
             :service_type_value => 'excerpts')
          
       elsif ( @service_types.include?("highlighted_link"))
@@ -372,7 +375,8 @@ class Amazon < Service
             :service=>self,
             :url => amazon_page, 
             :asin=>asin,
-            :display_text => @display_text,            
+            :display_text => @display_text,
+            :display_text_i18n => "display_text",
             :service_type_value => 'highlighted_link')
       end
       

data/app/service_adaptors/email_export.rb

@@ -2,6 +2,7 @@ class EmailExport < AjaxExport
 
   def initialize(config)
     @display_text ||= "Email"
+    @display_text_i18n ||= "display_text"
     @form_controller ||= "export_email"
     @form_action ||= "email"
     super(config)

data/app/service_adaptors/google_book_search.rb

@@ -296,8 +296,6 @@ class GoogleBookSearch < Service
   # We only create a fulltext service response if we have a full view.
   # We create only as many full views as are specified in config.
   def create_fulltext_service_response(request, data)
-    display_name = @display_name
-
     full_views = find_entries(data, ViewFullValue)
     return nil if full_views.empty?
     
@@ -308,7 +306,8 @@ class GoogleBookSearch < Service
           
       request.add_service_response(
           :service => self, 
-          :display_text => display_name, 
+          :display_text => @display_name, 
+          :display_text_i18n => "display_name",
           :url => remove_query_context(uri),           
           :service_type_value =>  :fulltext  
       )
@@ -328,6 +327,7 @@ class GoogleBookSearch < Service
       request.add_service_response( 
         :service => self,
         :display_text=>@display_name,
+        :display_text_i18n => "display_name",
         :url=> remove_query_context(url),
         :service_type_value => :search_inside
        )                  
@@ -358,16 +358,21 @@ class GoogleBookSearch < Service
     if (viewability == ViewPartialValue && 
         url = iv["volumeInfo"]["previewLink"])
       display_text = @display_name
+      display_text_i18n = "display_name"
       type = ServiceTypeValue[:excerpts]
     else
       url = url = iv["volumeInfo"]["infoLink"]
       display_text = "Book Information"
+      display_text_i18n = "book_information"
       type = ServiceTypeValue[:highlighted_link]
     end
+
+
     request.add_service_response( 
         :service=>self,    
         :url=> remove_query_context(url),
         :display_text=>display_text,
+        :display_text_i18n => display_text_i18n,
         :service_type_value => type    
      )
   end

data/app/service_adaptors/google_scholar_link.rb

@@ -36,11 +36,13 @@ class GoogleScholarLink < Service
     link = "http://scholar.google.com/scholar?q=#{CGI.escape construct_query(request)}"
     
     request.add_service_response(
-      :service      => self,      
-      :display_text => "Look for article on Google Scholar",
-      :url          => link,
+      :service            => self,      
+      :display_text       => "Look for article on Google Scholar",
+      :display_text_i18n  => "display_text",
+      :url                => link,
       :service_type_value => @service_type,
-      :notes        => "This article <b>may</b> be available on the public web, look for links labelled <span class='gscholar_example'>[html]</span> or <span class='gscholar_example'>[pdf]</span>".html_safe
+      :notes              => "This article <b>may</b> be available on the public web, look for links labelled <span class='gscholar_example'>[html]</span> or <span class='gscholar_example'>[pdf]</span>".html_safe,
+      :notes_i18n         => "notes_html"
     )
     
     return request.dispatched(self, true)

data/app/service_adaptors/hathi_trust.rb

@@ -149,7 +149,6 @@ class HathiTrust < Service
   def create_fulltext_service_response(request, items)
     return nil if items.empty?
     
-    display_name = @display_name
     count = 0
     
     items.each do |item|         
@@ -160,9 +159,11 @@ class HathiTrust < Service
       
       request.add_service_response(
           :service=>self, 
-          :display_text=>display_name,           
+          :display_text=> @display_name,
+          :display_text_i18n => "display_name",
           :url=> direct_url_to(item), 
-          :notes=> note_for(item), 
+          :add_i18n_notes => "single_volume", # signal for transform_view_data
+          :source_for_i18n => item['orig'],
           :service_type_value => :fulltext 
       )
       count += 1
@@ -183,12 +184,16 @@ class HathiTrust < Service
     full_ids.each do |recordId|
       record = ht_json.values.first["records"][recordId]
       next unless record && record["recordURL"]
-        
+    
+      record_title = record["titles"].first if record["titles"].kind_of?(Array)
+    
       request.add_service_response(
           :service=>self, 
-          :display_text=>@display_name,           
+          :display_text=> @display_name,
+          :display_text_i18n => "display_name",
           :url=> record["recordURL"],
-          :notes => excerpt_note_for(record),
+          :add_i18n_notes => "partial_volume", # signal for transform_view_data
+          :title_for_i18n => record_title,
           :service_type_value => :excerpts
       )
     end
@@ -204,7 +209,8 @@ class HathiTrust < Service
         
         request.add_service_response(
             :service=>self, 
-            :display_text=>"Search inside some volumes",           
+            :display_text=> "Search inside some volumes",
+            :display_text_i18n => "search_inside_some_vols",
             :url=> record["recordURL"],
             :service_type_value => :highlighted_link             
         )   
@@ -231,7 +237,8 @@ class HathiTrust < Service
 
     request.add_service_response( 
         :service => self,
-        :display_text=>@display_name,
+        :display_text=> @display_name,
+        :display_text_i18n => "display_name",
         :url=> direct_url,
         :service_type_value => :search_inside
        )
@@ -248,19 +255,17 @@ class HathiTrust < Service
       item['itemURL']
     end
   end
-  
-  def note_for(item)
-    if item['orig']
-      "Digitized from #{item['orig']}"
-    else
-      nil
+
+  def transform_view_data(hash)
+    if hash[:add_i18n_notes] == "single_volume"
+      hash[:notes] = translate("note_for_single_vol", :source => (hash[:source_for_i18n] || ""))
+    elsif hash[:add_i18n_notes] == "partial_volume"
+      hash[:notes] = translate("note_for_multi_vol", :title => (hash[:title_for_i18n] || ""))
     end
+
+    return hash
   end
   
-  def excerpt_note_for(record)
-    return nil unless record["titles"].kind_of?(Array)
-    "Some volumes of: #{record["titles"].first}"
-  end
   
   def is_serial_part?(item)
     # if it's got enumCron, then it's just part of a serial,

data/app/service_adaptors/hip_holding_search.rb

@@ -31,7 +31,7 @@ class HipHoldingSearch < Hip3Service
   def handle(request)
     
     # Only do anything if we have no holdings results from someone else.
-    holdings = request.service_types.find(:all, :conditions=>["service_type_value_name = ?", "holding"])
+    holdings = request.service_types.where(:service_type_value_name => "holding")
     
     if (holdings.length > 0)
       return request.dispatched(self, true)

data/app/service_adaptors/internet_archive.rb

@@ -146,6 +146,7 @@ class InternetArchive < Service
           request.add_service_response(
             :service => self,
             :display_text=> @display_name,
+            :display_text_i18n => "display_name",
             :url => direct_url.to_s,
             :service_type_value => :search_inside
           )
@@ -170,6 +171,7 @@ class InternetArchive < Service
         request.add_service_response(
             :service=>self, 
             :display_text=>display_name, 
+            :display_text_i18n => "display_name",
             :url=>create_result_url(result),
             :match_reliability => ServiceResponse::MatchUnsure,
             :edition_str => edition_str(result),

data/app/service_adaptors/isi.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-# Uses ISI Web of Knowledge to generates links to "cited by" and "similar"
+# Uses ISI Web of Science to generates links to "cited by" and "similar"
 # articles.
 #
 # REQUIREMENTS: You must be an ISI customer if you want these links to actually
@@ -39,7 +39,7 @@ class Isi < Service
   def initialize(config)
     #defaults
     @wos_app_name = "Umlaut"
-    @display_name = "Web of Knowledge\xc2\xae" # trademark symbol
+    @display_name = "Web of Science\xc2\xae" # trademark symbol
     @api_url = "https://ws.isiknowledge.com/cps/xrpc"
     @include_cited_by = true
     @include_similar = true

data/app/service_adaptors/service.rb

@@ -30,7 +30,9 @@
 # A link_out_filter service defines link_out_filter(request, url). If service
 # returns a new url from filter_url, that's the url the user will be directed
 # to. If service returns original url or nil, original url will still be used. 
-
+#
+# See documentation at ServiceResponse regarding how a service generates
+# ServiceResponses to respond to a user request. 
 class Service
   attr_reader :priority, :service_id, :url, :task, :status, :name, :group
   attr_accessor :request
@@ -115,43 +117,15 @@ class Service
     raise Exception.new("#{self.class}: #link_out_filter must be implemented by Service concrete sub-class with task link_out_filter!")
   end
 
-  
-  def display_name
-    # If no display_name is set, default to the id string. Not a good idea,
-    # but hey. 
-    return @display_name ||= self.service_id    
+  # Name of this service, like "Amazon", or "OCLC Worldcat". 
+  # First tries to look up an i18n translation using #translate, if not
+  # found, uses a @display_name set in this service, if still not found
+  # uses service_id for lack of anything else. 
+  def display_name    
+    self.translate("display_name", :default => @display_name || self.service_id)
   end
 
 
-  # Pass this method a ServiceResponse object, it will return a hash-like object of 
-  # display values, for the view. Implementation is usually in sub-class, by
-  # means of a set of methods "to_[service type name]" implemented in sub-class
-  #. parseResponse will find those. Subclasses will not generally override
-  # view_data_from_service_type, although they can for complete custom
-  # handling. Make sure to return a Hash or hash-like (duck-typed) object.
-  def view_data_from_service_type(service_response)
-  
-    service_type_code = service_response.service_type_value.name
-    
-    begin
-      # try to call a method named "to_#{service_type_code}", implemented by sub-class
-      self.send("to_#{service_type_code}", service_response)
-    rescue NoMethodError 
-    # No to_#{response_type} method? How about the catch-all method?
-    # If not implemented in sub-class, we have a VERY basic
-    # default implementation in this class. 
-        self.send("response_to_view_data", service_response)
-    end
-  end
-
-  # Default implementation to take a ServiceResponse and parse
-  # into a hash of values useful to the view. Basic implementation
-  # just asks ServiceResposne for it's data_values object, which
-  # contains all ServiceResponse data (including arbitrary keys serialized
-  # in the hash) in an object with the hash accessor method [] . 
-  def response_to_view_data(service_response)
-      return service_response.data_values
-  end
 
   # Sub-class can call class method like:
   #  required_config_params  :symbol1, :symbol2, symbol3
@@ -183,6 +157,21 @@ class Service
    return url
  end
 
+ # Look up an i18n key scoped to this service, first under the unique ID of
+ # the service, then under the service class name:
+ # * First look for translation under `umlaut.services.#{service_id.underscore}.key`
+ # * If not found, look for translation under `umlaut.services.#{service_class_name.underscore}`
+ # * If still not found, pass in optional default, otherwise you'll get I18n
+ #    configured failure behavior. 
+ #
+ # second arg is options that can be passed to standard I18n.t, including defaults
+ # and template arguments. 
+ def translate(key, options = {})
+    # Modify/add options[:default] to look up under class name too
+    options[:default] = [:"umlaut.services.#{self.class.name.underscore}.#{key}"].concat(Array( options[:default] ))
+
+    I18n.t("umlaut.services.#{self.service_id.underscore}.#{key}", options)
+ end
 
  # Pre-emption hashes specify a combination of existing responses or
  # service executions that can pre-empt this service. Can specify
@@ -240,12 +229,13 @@ class Service
         end
       else
         # Check service responses
-        preemption = 
-          uml_request.service_responses.to_a.find do |response|
-          ( other_type == "*" || other_type == "+" ||
-            response.service_type_value.name == other_type)  &&
-          ( service == "*" ||
-            response.service_id == service)         
+        preemption = Request.connection_pool.with_connection do 
+            uml_request.service_responses.to_a.find do |response|
+            ( other_type == "*" || other_type == "+" ||
+              response.service_type_value.name == other_type)  &&
+            ( service == "*" ||
+              response.service_id == service)         
+          end
         end
       end
       break if preemption