bento_search 0.7.0 → 0.8.0

data/app/helpers/bento_search_helper.rb

@@ -158,30 +158,7 @@ module BentoSearchHelper
     return counter + results.start + 1
   end
     
-  
-  # first 3 authors, each in a <span>, using item.author_display, seperated by
-  # semi-colons. 
-  def bento_item_authors(item)
-    parts = []
-    
-    first_three = item.authors.slice(0,3) 
-        
-    first_three.each_with_index do |author, index|
-      parts << content_tag("span", :class => "authors") do
-          item.author_display(author)
-      end
-      if (index + 1) < first_three.length
-        parts << "; "
-      end      
-    end
-    
-    if item.authors.length > 3
-      parts << I18n.t("bento_search.authors_et_al")
-    end
-    
-    return safe_join(parts, "")
-  end
-  
+     
   # returns a hash of label => key suitable for passing to rails
   # options_for_select. (Yes, it works backwards from how you'd expect). 
   # Label is looked up using I18n, at bento_search.sort_keys.*

data/app/item_decorators/bento_search/standard_decorator.rb

@@ -2,7 +2,19 @@ module BentoSearch
   class StandardDecorator < DecoratorBase
     
     
-    # How to display a BentoSearch::Author object as a name
+    # convenience method that returns true if any of the keys
+    # are #present?  eg
+    # item.any_present?(:source_title, :authors) === item.source_title.present? || item.authors.present?
+    #
+    # note present? is false for nil, empty strings, and empty arrays. 
+    def any_present?(*keys)
+      keys.each do |key|
+        return true if self.send(key).present?
+      end
+      return false
+    end
+    
+    # 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)}"
@@ -15,6 +27,66 @@ module BentoSearch
       end
     end
     
+    # display multiple authors, with HTML markup, returns html_safe string.
+    # experimentally trying this as a decorator helper method rather
+    # than a view partial, not sure which is best. 
+    #
+    # Will limit to first three authors, with elipsis if there are more.
+    #
+    # Over-ride if you want to format authors names differently, or
+    # show more or less than first 3, etc. 
+    def render_authors_list
+      parts = []
+      
+      first_three = self.authors.slice(0,3) 
+          
+      first_three.each_with_index do |author, index|
+        parts << _h.content_tag("span", :class => "author") do
+          self.author_display(author)
+        end
+        if (index + 1) < first_three.length
+          parts << "; "
+        end      
+      end
+      
+      if self.authors.length > 3
+        parts << I18n.t("bento_search.authors_et_al")
+      end
+      
+      return _h.safe_join(parts, "")
+    end
+    
+    # Returns source publication name OR publisher, along with volume/issue/pages
+    # if present, all wrapped in various tags and labels. Returns html_safe
+    # with tags. 
+    #
+    # Experiment to do this in a decorator helper instead of a partial template,
+    # might be more convenient we think. 
+    def render_source_info
+      parts = []
+      
+      if self.source_title.present?
+        parts << _h.content_tag("span", I18n.t("bento_search.published_in"), :class=> "source_label")        
+        parts << _h.content_tag("span", self.source_title, :class => "source_title")  
+        parts << ". "
+      elsif self.publisher.present?
+        parts << _h.content_tag("span", self.publisher, :class => "publisher")
+        parts << ". "
+      end
+      
+      if text = self.render_citation_details
+        parts << text << "."
+      end
+          
+      return _h.safe_join(parts, "")
+    end
+    
+    # if enough info is present that there will be non-empty render_source_info
+    # should be over-ridden to match display_source_info
+    def has_source_info?
+      self.any_present?(:source_title, :publisher, :start_page)
+    end
+    
     # Put together title and subtitle if neccesary. 
     def complete_title
       t = self.title
@@ -31,33 +103,23 @@ module BentoSearch
     
     
     
-    
-    
-    # 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
+    # volume, issue, and page numbers. With prefixed labels from I18n. 
+    # That's it.
+    def render_citation_details
+      # \u00A0 is unicode non-breaking space to keep labels and values from
+      # getting separated. 
       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?      
+      result_elements.push("#{I18n.t('bento_search.volume')}\u00A0#{volume}") if volume.present?
       
-      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?
+      result_elements.push("#{I18n.t('bento_search.issue')}\u00A0#{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}"
+        result_elements.push html_escape "#{I18n.t('bento_search.pages')}\u00A0#{start_page}-#{end_page}"
       elsif ! start_page.blank?
-        result_elements.push html_escape "#{I18n.t('bento_search.page')} #{start_page}"
+        result_elements.push html_escape "#{I18n.t('bento_search.page')}\u00A0#{start_page}"
       end
-      
+                  
       return nil if result_elements.empty?
       
       return result_elements.join(", ").html_safe

data/app/views/bento_search/_std_item.html.erb

@@ -26,11 +26,13 @@
     <div class="bento_item_body">
       
       
-      <% if item.authors.length > 0 || item.year.present? %>
+      <% if item.any_present?(:authors, :year) %>
         <p class="bento_item_row first_about">
             
           <% if item.authors.length > 0 %>
-            <%= bento_item_authors(item) %>
+            <span class="authors">
+              <%= item.render_authors_list %>
+            </span>
           <% end %>
           
           <% if item.year.present? %>
@@ -46,12 +48,12 @@
         </p>
       <% end %>
       
-      <% if item.published_in %>
+      <% if item.has_source_info? %>
         <p class="bento_item_row second_about">
-          <%= item.published_in %>
+          <%= item.render_source_info %>        
         </p>
       <% end %>
-      
+                  
       <% if item.other_links.present? %>
         <p class="bento_item_other_links">
           <%= render :partial => "bento_search/link", :collection => item.other_links %>

data/lib/bento_search/version.rb

@@ -1,3 +1,3 @@
 module BentoSearch
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end