im_onix 1.0.2 → 1.1.1

data/lib/onix/collateral_detail.rb

@@ -1,45 +1,41 @@
 module ONIX
   class TextContent < SubsetDSL
-    element "TextType", :subset
+    element "TextType", :subset, :shortcut => :type
     element "ContentAudience", :subset
     element "Text", :text
     element "TextAuthor", :text
     element "SourceTitle", :text
 
-    scope :description, lambda { human_code_match(:text_type, "Description")}
-    scope :short_description, lambda { human_code_match(:text_type, "ShortDescriptionannotation")}
-
-    # shortcuts
-    def type
-      @text_type
-    end
+    scope :description, lambda { human_code_match(:text_type, "Description") }
+    scope :short_description, lambda { human_code_match(:text_type, "ShortDescriptionannotation") }
   end
 
   class CollateralDetail < SubsetDSL
     elements "TextContent", :subset
     elements "SupportingResource", :subset
 
+    # @!group High level
+
+    # product description string including HTML
+    # @return [String]
     def description
-      desc_contents=@text_contents.description + @text_contents.short_description
+      desc_contents = @text_contents.description + @text_contents.short_description
       if desc_contents.length > 0
         desc_contents.first.text
-      else
-        nil
       end
     end
 
-    # largest frontcover if multiple
     def frontcover_resource
-      fc=@supporting_resources.front_cover
+      fc = @supporting_resources.front_cover
       if fc.length > 0
         if fc.length > 1
-          best_found=fc.select{|c| c.versions.last and c.versions.last.image_width}.sort { |c1, c2| c2.versions.last.image_width <=> c1.versions.last.image_width }.first
+          best_found = fc.select { |c| c.versions.last and c.versions.last.image_width }.sort { |c1, c2| c2.versions.last.image_width <=> c1.versions.last.image_width }.first
           if best_found
             # we take larger one
             best_found.versions.last
           else
             # we try first that is not gif
-            fc.select{|sr| not sr.versions.last.file_format=="Gif"}.first.versions.last
+            fc.select { |sr| not sr.versions.last.file_format == "Gif" }.first.versions.last
           end
         else
           fc.first.versions.last
@@ -47,18 +43,22 @@ module ONIX
       end
     end
 
+    # product larger front cover URL string
+    # @return [String]
     def frontcover_url
       if self.frontcover_resource
         self.frontcover_resource.links.first.strip
       end
     end
 
+    # product larger front cover last updated date
     def frontcover_last_updated
       if self.frontcover_resource
-          self.frontcover_resource.last_updated
+        self.frontcover_resource.last_updated
       end
     end
 
+    # product larger front cover mimetype
     def frontcover_mimetype
       if self.frontcover_resource
         self.frontcover_resource.file_mimetype
@@ -66,29 +66,36 @@ module ONIX
     end
 
     def epub_sample_resource
-      es=@supporting_resources.sample_content.select{|sr| sr.versions.last and sr.versions.last.file_format=="Epub"}.first
+      es = @supporting_resources.sample_content.select { |sr| sr.versions.last and sr.versions.last.file_format == "Epub" }.first
       if es
         es.versions.last
       end
     end
 
+    # Epub sample URL
+    # @return [String]
     def epub_sample_url
       if self.epub_sample_resource
         self.epub_sample_resource.links.first.strip
       end
     end
 
+    # Epub sample last updated
+    # @return [Date]
     def epub_sample_last_updated
       if self.epub_sample_resource
         self.epub_sample_resource.last_updated
       end
     end
 
+    # Epub sample mimetype
+    # @return [String]
     def epub_sample_mimetype
       if self.epub_sample_resource
         self.epub_sample_resource.file_mimetype
       end
     end
 
+    # @!endgroup
   end
 end

data/lib/onix/collection.rb

@@ -0,0 +1,38 @@
+module ONIX
+  class Collection < SubsetDSL
+    element "CollectionType", :subset, :shortcut => :type
+    elements "CollectionIdentifier", :subset, :shortcut => :identifiers
+    elements "TitleDetail", :subset
+    elements "CollectionSequence", :subset, :shortcut => :sequences
+
+    scope :publisher, lambda { human_code_match(:collection_type, "PublisherCollection") }
+
+    # @!group High level
+
+    # collection title string
+    def title
+      if collection_title_element
+        collection_title_element.title
+      end
+    end
+
+    # collection subtitle string
+    def subtitle
+      if collection_title_element
+        collection_title_element.subtitle
+      end
+    end
+
+    def collection_title_element
+      distinctive_title = @title_details.distinctive_title.first
+      #select { |td| td.type.human=~/DistinctiveTitle/}.first
+      if distinctive_title
+        distinctive_title.title_elements.collection_level.first
+        #select { |te| te.level.human=~/CollectionLevel/ or te.level.human=~/Subcollection/ }.first
+      end
+    end
+
+    # @!endgroup
+
+  end
+end

data/lib/onix/collection_sequence.rb

@@ -0,0 +1,7 @@
+module ONIX
+  class CollectionSequence < SubsetDSL
+    element "CollectionSequenceType", :subset, :shortcut => :type
+    element "CollectionSequenceTypeName", :string, :shortcut => :type_name
+    element "CollectionSequenceNumber", :string, :shortcut => :number
+  end
+end

data/lib/onix/contributor.rb

@@ -4,72 +4,73 @@ require 'onix/website'
 module ONIX
   class Contributor < SubsetDSL
     element "SequenceNumber", :integer
-    element "ContributorRole", :subset
-    elements "NameIdentifier", :subset
-
+    element "ContributorRole", :subset, :shortcut => :role
+    elements "NameIdentifier", :subset, :shortcut => :identifiers
     element "PersonName", :text
     element "PersonNameInverted", :text
-
-    element "NamesBeforeKey", :text
+    element "NamesBeforeKey", :text, :shortcut => :name_before_key
     element "KeyNames", :text
-
+    element "CorporateName", :text
+    element "CorporateNameInverted", :text
     element "BiographicalNote", :text
     elements "Website", :subset
-    element "ContributorPlace", :subset
-
-    def role
-      @contributor_role
-    end
-
-    def identifiers
-      @name_identifiers
-    end
-
-    def place
-      @contributor_place
-    end
-
-    def name_before_key
-      @names_before_key
-    end
+    element "ContributorPlace", :subset, :shortcut => :place
+    elements "ContributorDate", :subset, :shortcut => :dates
 
-    # :category: High level
+    # @!group High level
     # flatten person name (firstname lastname)
+    # @return [String]
     def name
-      if @person_name
-        @person_name
-      else
-        if @key_names
-          if @names_before_key
-            "#{@names_before_key} #{@key_names}"
-          else
-            @key_names
-          end
+      return @person_name if @person_name
+
+      if @key_names
+        if @names_before_key
+          return "#{@names_before_key} #{@key_names}"
+        else
+          return @key_names
         end
       end
+
+      @corporate_name
     end
 
-    # :category: High level
     # inverted flatten person name
+    # @return [String]
     def inverted_name
-      @person_name_inverted
+      @person_name_inverted || @corporate_name_inverted
     end
 
-    # :category: High level
     # biography string with HTML
+    # @return [String]
     def biography
       @biographical_note
     end
 
-    # :category: High level
     # raw biography string without HTML
+    # @return [String]
     def raw_biography
       if self.biography
         Helper.strip_html(self.biography).gsub(/\s+/, " ")
-      else
-        nil
       end
     end
+
+    # date of birth
+    # @return [Time]
+    def birth_date
+      if contributor_date = @contributor_dates.find { |d| d.role.human == "DateOfBirth" }
+        contributor_date.date.to_time
+      end
+    end
+
+    # date of death
+    # @return [Time]
+    def death_date
+      if contributor_date = @contributor_dates.find { |d| d.role.human == "DateOfDeath" }
+        contributor_date.date.to_time
+      end
+    end
+
+    # @!endgroup
   end
 
   class ContributorPlace < SubsetDSL

data/lib/onix/date.rb

@@ -1,18 +1,17 @@
 module ONIX
-
   module DateHelper
     attr_accessor :date_format, :date
 
     def parse_date(n)
-      @date_format=DateFormat.from_code("00")
-      date_txt=nil
-      @date=nil
+      @date_format = DateFormat.from_code("00")
+      date_txt = nil
+      @date = nil
       n.elements.each do |t|
         case t
-          when tag_match("DateFormat")
-            @date_format=DateFormat.parse(t)
-          when tag_match("Date")
-            date_txt=t.text
+        when tag_match("DateFormat")
+          @date_format = DateFormat.parse(t)
+        when tag_match("Date")
+          date_txt = t.text
         end
 
         if t["dateformat"]
@@ -20,29 +19,29 @@ module ONIX
         end
       end
 
-      code_format=format_from_code(@date_format.code)
-      text_format=format_from_string(date_txt)
+      code_format = format_from_code(@date_format.code)
+      text_format = format_from_string(date_txt)
 
-      format=code_format
+      format = code_format
 
-      if code_format!=text_format
-#        puts "EEE date #{n.text} (#{text_format}) do not match code #{@format.code} (#{code_format})"
-        format=text_format
+      if code_format != text_format
+        #        puts "EEE date #{n.text} (#{text_format}) do not match code #{@format.code} (#{code_format})"
+        format = text_format
       end
 
       begin
         if format
           case @date_format.code
-            when "00"
-              @date=Date.strptime(date_txt, format)
-            when "01"
-              @date=Date.strptime(date_txt, format)
-            when "05"
-              @date=Date.strptime(date_txt, format)
-            when "14"
-              @date=Time.strptime(date_txt, format)
-            else
-              @date=nil
+          when "00"
+            @date = Date.strptime(date_txt, format)
+          when "01"
+            @date = Date.strptime(date_txt, format)
+          when "05"
+            @date = Date.strptime(date_txt, format)
+          when "14"
+            @date = Time.strptime(date_txt, format)
+          else
+            @date = nil
           end
         end
       rescue
@@ -52,33 +51,33 @@ module ONIX
 
     def format_from_code(code)
       case code
-        when "00"
-          "%Y%m%d"
-        when "01"
-          "%Y%m"
-        when "05"
-          "%Y"
-        when "14"
-          "%Y%m%dT%H%M%S%z"
-        else
-          nil
+      when "00"
+        "%Y%m%d"
+      when "01"
+        "%Y%m"
+      when "05"
+        "%Y"
+      when "14"
+        "%Y%m%dT%H%M%S%z"
+      else
+        nil
       end
     end
 
     def format_from_string(str)
       case str
-        when /^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}/
-          "%Y%m%dT%H%M%S%z"
-        when /^\d{4}\-\d{2}\-\d{2}$/
-          "%Y-%m-%d"
-        when /^\d{4}\d{2}\d{2}$/
-          "%Y%m%d"
-        when /^\d{4}\d{2}$/
-          "%Y%m"
-        when /^\d{4}$/
-          "%Y"
-        else
-          nil
+      when /^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}/
+        "%Y%m%dT%H%M%S%z"
+      when /^\d{4}\-\d{2}\-\d{2}$/
+        "%Y-%m-%d"
+      when /^\d{4}\d{2}\d{2}$/
+        "%Y%m%d"
+      when /^\d{4}\d{2}$/
+        "%Y%m"
+      when /^\d{4}$/
+        "%Y"
+      else
+        nil
       end
     end
 
@@ -87,17 +86,8 @@ module ONIX
     end
   end
 
-  class MarketDate < SubsetDSL
+  class BaseDate < SubsetDSL
     include DateHelper
-    element "Date", :ignore
-    element "DateFormat", :ignore
-    element "MarketDateRole", :subset
-
-    scope :availability, lambda { human_code_match(:market_date_role, ["PublicationDate","EmbargoDate"])}
-
-    def role
-      @market_date_role
-    end
 
     def parse(n)
       super
@@ -105,79 +95,53 @@ module ONIX
     end
   end
 
-  class PriceDate < SubsetDSL
-    include DateHelper
+  class MarketDate < BaseDate
     element "Date", :ignore
     element "DateFormat", :ignore
-    element "PriceDateRole", :subset
-
-    scope :from_date, lambda { human_code_match(:price_date_role, "FromDate")}
-    scope :until_date, lambda { human_code_match(:price_date_role, "UntilDate")}
+    element "MarketDateRole", :subset, :shortcut => :role
 
-    def role
-      @price_date_role
-    end
-
-    def parse(n)
-      super
-      parse_date(n)
-    end
+    scope :availability, lambda { human_code_match(:market_date_role, ["PublicationDate", "EmbargoDate"]) }
   end
 
-  class SupplyDate < SubsetDSL
-    include DateHelper
+  class PriceDate < BaseDate
     element "Date", :ignore
     element "DateFormat", :ignore
-    element "SupplyDateRole", :subset
-
-    scope :availability, lambda { human_code_match(:supply_date_role, ["ExpectedAvailabilityDate","EmbargoDate"])}
+    element "PriceDateRole", :subset, :shortcut => :role
 
-    def role
-      @supply_date_role
-    end
-
-    def parse(n)
-      super
-      parse_date(n)
-    end
+    scope :from_date, lambda { human_code_match(:price_date_role, "FromDate") }
+    scope :until_date, lambda { human_code_match(:price_date_role, "UntilDate") }
   end
 
-  class PublishingDate < SubsetDSL
-    include DateHelper
+  class SupplyDate < BaseDate
     element "Date", :ignore
     element "DateFormat", :ignore
-    element "PublishingDateRole", :subset
+    element "SupplyDateRole", :subset, :shortcut => :role
 
-    scope :publication, lambda { human_code_match(:publishing_date_role, ["PublicationDate","PublicationDateOfPrintCounterpart"])}
-    scope :embargo, lambda { human_code_match(:publishing_date_role, "EmbargoDate")}
-    scope :preorder_embargo, lambda { human_code_match(:publishing_date_role, "PreorderEmbargoDate")}
-    scope :public_announcement, lambda { human_code_match(:publishing_date_role, "PublicAnnouncementDate")}
+    scope :availability, lambda { human_code_match(:supply_date_role, ["ExpectedAvailabilityDate", "EmbargoDate"]) }
+  end
 
-    def role
-      @publishing_date_role
-    end
+  class PublishingDate < BaseDate
+    element "Date", :ignore
+    element "DateFormat", :ignore
+    element "PublishingDateRole", :subset, :shortcut => :role
 
-    def parse(n)
-      super
-      parse_date(n)
-    end
+    scope :publication, lambda { human_code_match(:publishing_date_role, ["PublicationDate", "PublicationDateOfPrintCounterpart"]) }
+    scope :embargo, lambda { human_code_match(:publishing_date_role, "EmbargoDate") }
+    scope :preorder_embargo, lambda { human_code_match(:publishing_date_role, "PreorderEmbargoDate") }
+    scope :public_announcement, lambda { human_code_match(:publishing_date_role, "PublicAnnouncementDate") }
   end
 
-  class ContentDate < SubsetDSL
-    include DateHelper
+  class ContentDate < BaseDate
     element "Date", :ignore
     element "DateFormat", :ignore
-    element "ContentDateRole", :subset
-
-    scope :last_updated, lambda { human_code_match(:content_date_role, "LastUpdated")}
+    element "ContentDateRole", :subset, :shortcut => :role
 
-    def role
-      @content_date_role
-    end
+    scope :last_updated, lambda { human_code_match(:content_date_role, "LastUpdated") }
+  end
 
-    def parse(n)
-      super
-      parse_date(n)
-    end
+  class ContributorDate < BaseDate
+    element "Date", :ignore
+    element "DateFormat", :ignore
+    element "ContributorDateRole", :subset, :shortcut => :role
   end
 end