im_onix 1.1.1 → 1.3.0

data/lib/onix/contributor.rb

@@ -1,49 +1,84 @@
 require 'onix/subset'
 require 'onix/website'
+require 'onix/professional_affiliation'
+require 'onix/contributor_place'
 
 module ONIX
   class Contributor < SubsetDSL
-    element "SequenceNumber", :integer
-    element "ContributorRole", :subset, :shortcut => :role
-    elements "NameIdentifier", :subset, :shortcut => :identifiers
-    element "PersonName", :text
-    element "PersonNameInverted", :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, :shortcut => :place
-    elements "ContributorDate", :subset, :shortcut => :dates
+    element "SequenceNumber", :integer, :cardinality => 0..1
+    element "ContributorRole", :subset, :shortcut => :role, :cardinality => 1..n
+    elements "FromLanguage", :subset, :klass => "LanguageCode", :cardinality => 0..n
+    elements "ToLanguage", :subset, :klass => "LanguageCode", :cardinality => 0..n
+
+    # element "NameType", :subset, :cardinality => 0..1
+
+
+    elements "NameIdentifier", :subset, :shortcut => :identifiers, :cardinality => 0..n
+    element "PersonName", :text, :cardinality => 0..1
+    element "PersonNameInverted", :text, :cardinality => 0..1
+    element "TitlesBeforeNames", :text, :cardinality => 0..1
+    element "NamesBeforeKey", :text, :shortcut => :name_before_key, :cardinality => 0..1
+    element "PrefixToKey", :text, :cardinality => 0..1
+    element "KeyNames", :text, :cardinality => 0..1
+    element "NamesAfterKey", :text, :cardinality => 0..1
+    element "SuffixToKey", :text, :cardinality => 0..1
+    element "LettersAfterNames", :text, :cardinality => 0..1
+    element "TitlesAfterNames", :text, :cardinality => 0..1
+
+    # element "Gender", :subset, :cardinality => 0..1
+
+
+    element "CorporateName", :text, :cardinality => 0..1
+    element "CorporateNameInverted", :text, :cardinality => 0..1
+
+    # element "UnnamedPersons", :subset, :cardinality => 0..1
+    # elements "AlternativeName", :subset, :cardinality => 0..n
+
+
+    elements "ContributorDate", :subset, :shortcut => :dates, :cardinality => 0..n
+    elements "ProfessionalAffiliation", :subset, :cardinality => 0..n
+    elements "Prize", :subset, :cardinality => 0..n
+    elements "BiographicalNote", :text, :shortcut => :biographies, :cardinality => 0..n
+    elements "Website", :subset, :cardinality => 0..n
+    elements "ContributorDescription", :text, :cardinality => 0..n
+    elements "ContributorPlace", :subset, :shortcut => :places, :cardinality => 0..n
+
+    # @!group Shortcuts
+
+    # @return [ContributorPlace]
+    def place
+      self.places.first
+    end
+
+    # !@endgroup
 
     # @!group High level
     # flatten person name (firstname lastname)
     # @return [String]
     def name
-      return @person_name if @person_name
+      return person_name if person_name
 
-      if @key_names
-        if @names_before_key
-          return "#{@names_before_key} #{@key_names}"
+      if key_names
+        if names_before_key
+          return "#{names_before_key} #{key_names}"
         else
-          return @key_names
+          return key_names
         end
       end
 
-      @corporate_name
+      corporate_name
     end
 
     # inverted flatten person name
     # @return [String]
     def inverted_name
-      @person_name_inverted || @corporate_name_inverted
+      person_name_inverted || corporate_name_inverted
     end
 
     # biography string with HTML
     # @return [String]
     def biography
-      @biographical_note
+      self.biographies.first
     end
 
     # raw biography string without HTML
@@ -72,17 +107,4 @@ module ONIX
 
     # @!endgroup
   end
-
-  class ContributorPlace < SubsetDSL
-    element "ContributorPlaceRelator", :subset
-    element "CountryCode", :subset
-
-    def relator
-      @contributor_place_relator
-    end
-
-    def country_code
-      @country_code.code
-    end
-  end
 end

data/lib/onix/contributor_place.rb

@@ -0,0 +1,12 @@
+module ONIX
+  class ContributorPlace < SubsetDSL
+    element "ContributorPlaceRelator", :subset, :shortcut => :relator, :cardinality => 1
+    element "CountryCode", :subset, :cardinality => 0..1
+    element "RegionCode", :subset, :cardinality => 0..1
+    elements "LocationName", :text, :cardinality => 0..n
+
+    def country_code
+      @country_code.code
+    end
+  end
+end

data/lib/onix/copyright_statement.rb

@@ -0,0 +1,8 @@
+module ONIX
+  class CopyrightStatement < SubsetDSL
+    element "CopyrightType", :subset, :cardinality => 0..1
+    elements "CopyrightYear", :text, :cardinality => 0..n
+
+    # elements "CopyrightOwner", :subset, :cardinality => 0..n
+  end
+end

data/lib/onix/date.rb

@@ -1,62 +1,63 @@
 module ONIX
-  module DateHelper
-    attr_accessor :date_format, :date
-
-    def parse_date(n)
-      @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
-        end
-
-        if t["dateformat"]
-          @date_format = DateFormat.from_code(t["dateformat"])
+  module DateMethods
+    # @return [DateFormat]
+    attr_accessor :date_format
+    # @return [Date]
+    attr_accessor :date
+    # @return [Time]
+    attr_accessor :datetime
+
+    def parse_date
+      if @date_format
+        @deprecated_date_format = true
+      else
+        if @date.is_a?(TextWithAttributes)
+          @date_format = @date.attributes["dateformat"]
         end
       end
 
-      code_format = format_from_code(@date_format.code)
+      @datetime = strpdate!(@date, @date_format)
+      @date = @datetime ? @datetime.to_date : nil
+    end
+
+    # @param [String] date_txt
+    # @param [DateFormat] date_format
+    # @return [Time]
+    def strpdate!(date_txt, date_format)
+      date_format ||= DateFormat.from_code("00")
+      code_format = format_from_code(date_format.code)
       text_format = format_from_string(date_txt)
 
       format = code_format
 
       if code_format != text_format
-        #        puts "EEE date #{n.text} (#{text_format}) do not match code #{@format.code} (#{code_format})"
+        # puts "WARN incorrect date format #{text_format} != #{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
-          end
-        end
-      rescue
+        datetime = Time.strptime(date_txt, format) if format && %w[00 01 02 05 13 14].include?(date_format.code)
+      rescue => e
         # invalid date
       end
+
+      datetime
     end
 
+    # @param [String] code
+    # @return [String]
     def format_from_code(code)
       case code
       when "00"
         "%Y%m%d"
       when "01"
         "%Y%m"
+      when "02"
+        "%Y%%W"
       when "05"
         "%Y"
+      when "13"
+        "%Y%m%dT%H%M%S"
       when "14"
         "%Y%m%dT%H%M%S%z"
       else
@@ -64,6 +65,7 @@ module ONIX
       end
     end
 
+    # @param [String] str
     def format_from_string(str)
       case str
       when /^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}/
@@ -81,67 +83,116 @@ module ONIX
       end
     end
 
+    # @return [Time]
     def time
-      @date.to_time
+      @datetime
+    end
+  end
+
+  # support for datestamp attribute and SentDateTime
+  class DateStamp
+    attr_accessor :format, :datetime
+
+    def initialize(dt = nil, fmt = "%Y%m%d")
+      @datetime = dt
+      @format = fmt unless @datetime.is_a?(String)
+    end
+
+    def supported_formats
+      ["%Y%m%dT%H%M%S%z", "%Y%m%dT%H%M%S", "%Y%m%dT%H%M%z", "%Y%m%dT%H%M", "%Y%m%d"]
+    end
+
+    def parse(tm)
+      @format = nil
+      found_format = nil
+      supported_formats.each do |supported_format|
+        begin
+          @datetime = Time.strptime(tm, supported_format)
+          found_format = supported_format
+          break
+        rescue
+        end
+      end
+      @format = found_format
+      @datetime = tm unless @format
+    end
+
+    def self.from_code(code)
+      ds = self.new
+      ds.parse(code)
+      ds
+    end
+
+    def human
+      @datetime
+    end
+
+    def code
+      @format ? @datetime.strftime(@format) : @datetime
     end
   end
 
   class BaseDate < SubsetDSL
-    include DateHelper
+    include DateMethods
+
+    class << self
+      def date_elements(role)
+        element role, :subset, :shortcut => :role
+        element "DateFormat", :subset
+        element "Date", :text
+      end
+    end
+
+    # use former date representation
+    # @return [Boolean]
+    attr_accessor :deprecated_date_format
+
+    def initialize
+      super
+      @deprecated_date_format = false
+    end
 
     def parse(n)
       super
-      parse_date(n)
+      parse_date
     end
   end
 
   class MarketDate < BaseDate
-    element "Date", :ignore
-    element "DateFormat", :ignore
-    element "MarketDateRole", :subset, :shortcut => :role
+    date_elements "MarketDateRole"
 
     scope :availability, lambda { human_code_match(:market_date_role, ["PublicationDate", "EmbargoDate"]) }
   end
 
   class PriceDate < BaseDate
-    element "Date", :ignore
-    element "DateFormat", :ignore
-    element "PriceDateRole", :subset, :shortcut => :role
+    date_elements "PriceDateRole"
 
     scope :from_date, lambda { human_code_match(:price_date_role, "FromDate") }
     scope :until_date, lambda { human_code_match(:price_date_role, "UntilDate") }
   end
 
   class SupplyDate < BaseDate
-    element "Date", :ignore
-    element "DateFormat", :ignore
-    element "SupplyDateRole", :subset, :shortcut => :role
+    date_elements "SupplyDateRole"
 
     scope :availability, lambda { human_code_match(:supply_date_role, ["ExpectedAvailabilityDate", "EmbargoDate"]) }
   end
 
   class PublishingDate < BaseDate
-    element "Date", :ignore
-    element "DateFormat", :ignore
-    element "PublishingDateRole", :subset, :shortcut => :role
+    date_elements "PublishingDateRole"
 
     scope :publication, lambda { human_code_match(:publishing_date_role, ["PublicationDate", "PublicationDateOfPrintCounterpart"]) }
-    scope :embargo, lambda { human_code_match(:publishing_date_role, "EmbargoDate") }
+    scope :embargo, lambda { human_code_match(:publishing_date_role, "SalesEmbargoDate") }
     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 < BaseDate
-    element "Date", :ignore
-    element "DateFormat", :ignore
-    element "ContentDateRole", :subset, :shortcut => :role
+    date_elements "ContentDateRole"
 
     scope :last_updated, lambda { human_code_match(:content_date_role, "LastUpdated") }
   end
 
   class ContributorDate < BaseDate
-    element "Date", :ignore
-    element "DateFormat", :ignore
-    element "ContributorDateRole", :subset, :shortcut => :role
+    date_elements "ContributorDateRole"
   end
 end

data/lib/onix/descriptive_detail.rb

@@ -1,53 +1,123 @@
 require 'onix/collection'
-require 'onix/collection_sequence'
 require 'onix/epub_usage_constraint'
-require 'onix/epub_usage_limit'
+require 'onix/epub_license'
 require 'onix/extent'
 require 'onix/language'
+require 'onix/ancillary_content'
 require 'onix/product_form_feature'
+require 'onix/product_classification'
 require 'onix/product_part'
 require 'onix/title_detail'
 require 'onix/contributor'
+require 'onix/measure'
 require 'onix/subject'
+require 'onix/audience'
+require 'onix/audience_range'
+require 'onix/complexity'
 
 module ONIX
   class DescriptiveDetail < SubsetDSL
-    element "ProductComposition", :subset, :shortcut => :composition
-    element "ProductForm", :subset, :shortcut => :form
-    elements "ProductFormDetail", :subset, :shortcut => :form_details
-    elements "ProductFormFeature", :subset, :shortcut => :form_features
-    element "ProductFormDescription", :text, :shortcut => :file_description
-    element "PrimaryContentType", :subset, {:klass => "ProductContentType"}
-    elements "ProductContentType", :subset, :shortcut => :content_types
-    elements "EpubTechnicalProtection", :subset
-    elements "EpubUsageConstraint", :subset
-    elements "ProductPart", :subset, :shortcut => :parts
-    elements "Collection", :subset
-    element "NoCollection", :ignore
-    elements "TitleDetail", :subset
-    elements "Contributor", :subset
-    element "EditionType", :subset
-    element "EditionNumber", :integer
-    element "NoEdition", :ignore
-    elements "Language", :subset
-    elements "Extent", :subset
-    elements "Subject", :subset
-    elements "AudienceCode", :subset
+    element "ProductComposition", :subset, :shortcut => :composition, :cardinality => 1
+    element "ProductForm", :subset, :shortcut => :form, :cardinality => 1
+    elements "ProductFormDetail", :subset, :shortcut => :form_details, :cardinality => 0..n
+    elements "ProductFormFeature", :subset, :shortcut => :form_features, :cardinality => 0..n
+    element "ProductPackaging", :subset, :cardinality => 0..1
+    element "ProductFormDescription", :text, :shortcut => :file_description, :cardinality => 0..n
+    element "TradeCategory", :subset, :cardinality => 0..1
+    element "PrimaryContentType", :subset, :klass => "ProductContentType"
+    elements "ProductContentType", :subset, :shortcut => :content_types, :cardinality => 0..n
+    elements "Measure", :subset, :cardinality => 0..n
+    element "CountryOfManufacture", :subset, :klass=>"CountryCode", :cardinality => 0..1
+    elements "EpubTechnicalProtection", :subset, :cardinality => 0..n
+    elements "EpubUsageConstraint", :subset, :cardinality => 0..n
+    element "EpubLicense", :subset, :cardinality => 0..1
+    elements "MapScale", :integer, :cardinality => 0..n
+    elements "ProductClassification", :subset, :cardinality => 0..n
+    elements "ProductPart", :subset, :shortcut => :parts, :cardinality => 0..n
+    elements "Collection", :subset, :cardinality => 0..n
+    element "NoCollection", :bool, :cardinality => 0..1
+    elements "TitleDetail", :subset, :cardinality => 0..n
+    element "ThesisType", :subset, :cardinality => 0..1
+    element "ThesisPresentedTo", :text, :cardinality => 0..1
+    element "ThesisYear", :text, :cardinality => 0..1
+    elements "Contributor", :subset, :cardinality => 0..n
+    elements "ContributorStatement", :text, :cardinality => 0..n
+    element "NoContributor", :bool, :cardinality => 0..1
+
+    # elements "Conference", :subset, :cardinality => 0..n
+    # elements "Event", :subset, :cardinality => 0..n
+
+
+    element "EditionType", :subset, :cardinality => 0..n
+    element "EditionNumber", :integer, :cardinality => 0..1
+    element "EditionVersionNumber", :text, :cardinality => 0..1
+    elements "EditionStatement", :text, :cardinality => 0..n
+    element "NoEdition", :bool, :cardinality => 0..1
+
+    # element "ReligiousText", :subset, :cardinality => 0..1
+
+
+    elements "Language", :subset, :cardinality => 0..1
+    elements "Extent", :subset, :cardinality => 0..n
+    element "Illustrated", :subset, :cardinality => 0..1
+    element "NumberOfIllustrations", :integer, :cardinality => 0..1
+    elements "IllustrationsNote", :text, :cardinality => 0..n
+    elements "AncillaryContent", :subset, :cardinality => 0..n
+    elements "Subject", :subset, :cardinality => 0..n
+
+    # elements "NameAsSubject", :subset, :cardinality => 0..n
+
+
+    elements "AudienceCode", :subset, :cardinality => 0..n
+    elements "Audience", :subset, :cardinality => 0..n
+    elements "AudienceRange", :subset, :cardinality => 0..n
+    elements "AudienceDescription", :text, :cardinality => 0..n
+    elements "Complexity", :subset, :cardinality => 0..n
 
     # @!group Shortcuts
 
+    # @return [Extent]
     def pages_extent
       @extents.page.first
     end
 
+    # @return [TitleElement]
     def product_title_element
       @title_details.distinctive_title.first.title_elements.product_level.first if @title_details.distinctive_title.first
     end
 
+    # @return [Array<ProductFormDetail>]
     def file_formats
       @product_form_details.select { |fd| fd.code =~ /^E1.*/ }
     end
 
+    # @return [Collection]
+    def publisher_collection
+      @collections.publisher.first
+    end
+
+    # @return [Extent]
+    def filesize_extent
+      @extents.filesize.first
+    end
+
+    # @return [Array<ProductFormDetail>]
+    def audio_formats
+      @product_form_details.select { |fd| fd.code =~ /^A.*/ }
+    end
+
+    # BISAC categories
+    # @return [Array<Subject>]
+    def bisac_categories
+      @subjects.bisac
+    end
+
+    # CLIL categories
+    # @return [Array<Subject>]
+    def clil_categories
+      @subjects.clil
+    end
+
     # @!endgroup
 
     # @!group High level
@@ -72,10 +142,6 @@ module ONIX
       end
     end
 
-    def filesize_extent
-      @extents.filesize.first
-    end
-
     # file size in bytes
     # @return [Integer]
     def filesize
@@ -114,18 +180,15 @@ module ONIX
       not audio_formats.empty?
     end
 
+    # @return [String]
     def audio_format
       self.audio_formats.first.human if self.audio_formats.first
     end
 
-    def audio_formats
-      @product_form_details.select { |fd| fd.code =~ /^A.*/ }
-    end
-
     # is digital offer a bundle ?
     # @return [Boolean]
     def bundle?
-      @product_composition.human == "MultipleitemRetailProduct"
+      @product_composition.human == "MultipleComponentRetailProduct"
     end
 
     # digital file format string (Epub,Pdf,AmazonKindle)
@@ -164,11 +227,12 @@ module ONIX
     # protections string array
     # @return [Array<String>]
     def protections
-      return nil if @epub_technical_protections.length == 0
+      return [] if @epub_technical_protections.length == 0
       @epub_technical_protections.map(&:human)
     end
 
     # language of text
+    # @return [String]
     def language_of_text
       l = @languages.of_text.first
       if l
@@ -176,10 +240,6 @@ module ONIX
       end
     end
 
-    def publisher_collection
-      @collections.publisher.first
-    end
-
     # publisher collection title
     # @return [String]
     def publisher_collection_title
@@ -188,24 +248,12 @@ module ONIX
       end
     end
 
-    # BISAC categories
-    # @return [Array<Subject>]
-    def bisac_categories
-      @subjects.bisac
-    end
-
     # BISAC categories identifiers string array (eg: FIC000000)
     # @return [Array<String>]
     def bisac_categories_codes
       self.bisac_categories.map { |c| c.code }.uniq
     end
 
-    # BISAC categories
-    # @return [Array<Subject>]
-    def clil_categories
-      @subjects.clil
-    end
-
     # CLIL categories identifier string array
     # @return [Array<String>]
     def clil_categories_codes
@@ -213,6 +261,7 @@ module ONIX
     end
 
     # keywords string array
+    # @return [Array<String>]
     def keywords
       kws = @subjects.keyword.map { |kw| kw.heading_text }.compact
       kws = kws.flat_map { |kw| kw.split(/;|,|\n/) }.map { |kw| kw.strip }

data/lib/onix/discount.rb

@@ -0,0 +1,9 @@
+module ONIX
+  class Discount < SubsetDSL
+    element "DiscountType", :subset, :cardinality => 0..1
+    element "Quantity", :integer, :cardinality => 0..1
+    element "ToQuantity", :integer, :cardinality => 0..1
+    element "DiscountPercent", :text, :cardinality => 0..1
+    element "DiscountAmount", :text, :cardinality => 0..1
+  end
+end

data/lib/onix/discount_coded.rb

@@ -1,7 +1,7 @@
 module ONIX
   class DiscountCoded < SubsetDSL
-    element "DiscountCodeType", :text, :shortcut => :code_type
-    element "DiscountCodeTypeName", :text, :shortcut => :code_type_name
-    element "DiscountCode", :text, :shortcut => :code
+    element "DiscountCodeType", :text, :shortcut => :code_type, :cardinality => 1
+    element "DiscountCodeTypeName", :text, :shortcut => :code_type_name, :cardinality => 0..1
+    element "DiscountCode", :text, :shortcut => :code, :cardinality => 1
   end
 end