im_onix 1.1.1 → 1.3.0

data/lib/onix/entity.rb

@@ -7,51 +7,25 @@ module ONIX
   end
 
   class Entity < SubsetDSL
-    # entity name
-    attr_accessor :name
-    # entity role
-    attr_accessor :role
-    # entity Identifier list
-    attr_accessor :identifiers
-
-    include GlnMethods
+    include IdentifiersMethods::Gln
     include EntityHelper
 
-    def initialize
-      super
-      @identifiers = []
-    end
-
+    # @return [String]
     def self.role_tag
       "#{self.prefix}Role"
     end
 
+    # @return [String]
     def self.name_tag
       "#{self.prefix}Name"
     end
 
+    # @return [String]
     def self.identifier_tag
       "#{self.prefix}Identifier"
     end
 
-    def parse(n)
-      super
-      n.children.each do |t|
-        case t
-        when tag_match(self.class.name_tag)
-          @name = t.text
-        when tag_match(self.class.role_tag)
-          if self.class.role_class
-            @role = self.class.role_class.parse(t)
-          end
-        when tag_match(self.class.identifier_tag)
-          if self.class.identifier_class
-            @identifiers << self.class.identifier_class.parse(t)
-          end
-        end
-      end
-    end
-
+    # @return [String]
     def self.prefix
     end
 
@@ -73,29 +47,40 @@ module ONIX
       define_singleton_method :role_class do
         return role
       end
+
+      self.element self.role_tag, :subset, :klass => self.role_class.to_s, :shortcut => :role, :cardinality => 1
+      self.elements self.identifier_tag, :subset, :klass => self.identifier_class.to_s, :shortcut => :identifiers, :cardinality => 0..n
+      self.element self.name_tag, :text, :shortcut => :name, :cardinality => 0..1
     end
   end
 
   class Agent < Entity
     entity_setup "Agent", AgentIdentifier, AgentRole
+    elements "Website", :subset, :cardinality => 0..n
   end
 
-  class Imprint < Entity
-    entity_setup "Imprint", ImprintIdentifier
+  class Imprint < SubsetDSL
+    include IdentifiersMethods::Gln
+
+    elements "ImprintIdentifier", :subset, :shortcut => :identifiers, :cardinality => 0..n
+    element "ImprintName", :text, :shortcut => :name, :cardinality => 0..1
   end
 
   class Supplier < Entity
-    elements "Website", :subset
     entity_setup "Supplier", SupplierIdentifier, SupplierRole
+    elements "TelephoneNumber", :text, :cardinality => 0..n
+    elements "FaxNumber", :text, :cardinality => 0..n
+    elements "EmailAddress", :text, :cardinality => 0..n
+    elements "Website", :subset, :cardinality => 0..n
   end
 
   class Publisher < Entity
-    elements "Website", :subset
-    entity_setup "Publisher", PublisherIdentifier, PublishingRole
-
     # @note role tag is not PublisherRole but PublishingRole
     def self.role_tag
       "PublishingRole"
     end
+
+    entity_setup "Publisher", PublisherIdentifier, PublishingRole
+    elements "Website", :subset, :cardinality => 0..n
   end
 end

data/lib/onix/epub_license.rb

@@ -0,0 +1,8 @@
+require 'onix/epub_license_expression'
+
+module ONIX
+  class EpubLicense < SubsetDSL
+    elements "EpubLicenseName", :text, :cardinality => 1..n
+    elements "EpubLicenseExpression", :subset, :cardinality => 0..n
+  end
+end

data/lib/onix/epub_license_expression.rb

@@ -0,0 +1,7 @@
+module ONIX
+  class EpubLicenseExpression < SubsetDSL
+    element "EpubLicenseExpressionType", :subset, :cardinality => 1
+    element "EpubLicenseExpressionTypeName", :text, :cardinality => 0..1
+    element "EpubLicenseExpressionLink", :text, :cardinality => 1
+  end
+end

data/lib/onix/epub_usage_constraint.rb

@@ -1,7 +1,9 @@
+require 'onix/epub_usage_limit'
+
 module ONIX
   class EpubUsageConstraint < SubsetDSL
-    element "EpubUsageType", :subset, :shortcut => :type
-    element "EpubUsageStatus", :subset, :shortcut => :status
-    elements "EpubUsageLimit", :subset, :shortcut => :limits
+    element "EpubUsageType", :subset, :shortcut => :type, :cardinality => 1
+    element "EpubUsageStatus", :subset, :shortcut => :status, :cardinality => 1
+    elements "EpubUsageLimit", :subset, :shortcut => :limits, :cardinality => 0..n
   end
 end

data/lib/onix/epub_usage_limit.rb

@@ -1,6 +1,6 @@
 module ONIX
   class EpubUsageLimit < SubsetDSL
-    element "EpubUsageUnit", :subset, :shortcut => :unit
-    element "Quantity", :integer
+    element "Quantity", :integer, :cardinality => 1
+    element "EpubUsageUnit", :subset, :shortcut => :unit, :cardinality => 1
   end
 end

data/lib/onix/error.rb

@@ -3,4 +3,6 @@ module ONIX
   end
   class ExpectsOneButHasSeveral < StandardError
   end
+  class UnknownElement < StandardError
+  end
 end

data/lib/onix/extent.rb

@@ -1,8 +1,9 @@
 module ONIX
   class Extent < SubsetDSL
-    element "ExtentType", :subset, :shortcut => :type
-    element "ExtentUnit", :subset, :shortcut => :unit
-    element "ExtentValue", :text, :shortcut => :value
+    element "ExtentType", :subset, :shortcut => :type, :cardinality => 1
+    element "ExtentValue", :text, :shortcut => :value, :cardinality => 0..1
+    element "ExtentValueRoman", :text, :cardinality => 0..1
+    element "ExtentUnit", :subset, :shortcut => :unit, :cardinality => 1
 
     scope :filesize, lambda { human_code_match(:extent_type, /Filesize/) }
     scope :page, lambda { human_code_match(:extent_type, /Page/) }

data/lib/onix/header.rb

@@ -0,0 +1,17 @@
+require 'onix/sender'
+require 'onix/addressee'
+
+module ONIX
+  class Header < SubsetDSL
+    element "Sender", :subset, :cardinality => 1
+    element "Addressee", :subset, :cardinality => 0..n
+    element "MessageNumber", :integer, :cardinality => 0..1
+    element "MessageRepeat", :integer, :cardinality => 0..1
+    element "SentDateTime", :datestamp, :cardinality => 1,
+            :serialize_lambda => lambda {|v| v.is_a?(Time) ? v.strftime("%Y%m%dT%H%M%S%z") : v}
+    element "MessageNote", :text, :cardinality => 0..n
+    element "DefaultLanguageOfText", :subset, :klass => "LanguageCode", :cardinality => 0..1
+    element "DefaultPriceType", :subset, :klass => "PriceType", :cardinality => 0..1
+    element "DefaultCurrencyCode", :text, :cardinality => 0..1
+  end
+end

data/lib/onix/helper.rb

@@ -1,6 +1,7 @@
 module ONIX
   class Helper
     # convert arbitrary arg to File/String
+    # @param [String, File] arg
     def self.arg_to_data(arg)
       data = ""
       case arg
@@ -33,18 +34,8 @@ module ONIX
       end
     end
 
-    def self.text_at(n, xpath)
-      if n.at_xpath(xpath)
-        n.at_xpath(xpath).text.strip
-      else
-        nil
-      end
-    end
-
-    def self.mandatory_text_at(n, xpath)
-      self.text_at(n, xpath)
-    end
-
+    # @param [String] html
+    # @return [String]
     def self.strip_html(html)
       html.gsub(/&nbsp;/, " ").gsub(/<[^>]*(>+|\s*\z)/m, '')
     end

data/lib/onix/identifier.rb

@@ -1,10 +1,11 @@
 module ONIX
   class Identifier < SubsetDSL
-    element "IDValue", :text, :shortcut => :value
-    element "IDTypeName", :text, :shortcut => :name
-
-    def type
-      nil
+    class << self
+      def identifier_elements(id_type)
+        element id_type, :subset, :shortcut => :type, :cardinality => 1
+        element "IDTypeName", :text, :shortcut => :name, :cardinality => 0..1
+        element "IDValue", :text, :shortcut => :value, :cardinality => 1
+      end
     end
 
     def uniq_id
@@ -13,105 +14,128 @@ module ONIX
   end
 
   class SenderIdentifier < Identifier
-    element "SenderIDType", :subset, :shortcut => :type
+    identifier_elements "SenderIDType"
   end
 
   class AddresseeIdentifier < Identifier
-    element "AddresseeIDType", :subset, :shortcut => :type
+    identifier_elements "AddresseeIDType"
+  end
+
+  class RecordSourceIdentifier < Identifier
+    identifier_elements "RecordSourceIDType"
   end
 
   class AgentIdentifier < Identifier
-    element "AgentIDType", :subset, :shortcut => :type
+    identifier_elements "AgentIDType"
   end
 
   class ImprintIdentifier < Identifier
-    element "ImprintIDType", :subset, :shortcut => :type
+    identifier_elements "ImprintIDType"
   end
 
   class PublisherIdentifier < Identifier
-    element "PublisherIDType", :subset, :shortcut => :type
+    identifier_elements "PublisherIDType"
   end
 
   class SupplierIdentifier < Identifier
-    element "SupplierIDType", :subset, :shortcut => :type
+    identifier_elements "SupplierIDType"
   end
 
   class NameIdentifier < Identifier
-    element "NameIDType", :subset, :shortcut => :type
+    identifier_elements "NameIDType"
   end
 
   class CollectionIdentifier < Identifier
-    element "CollectionIDType", :subset, :shortcut => :type
+    identifier_elements "CollectionIDType"
   end
 
   class ProductIdentifier < Identifier
-    element "ProductIDType", :subset, :shortcut => :type
+    identifier_elements "ProductIDType"
+  end
+
+  class ProductContactIdentifier < Identifier
+    identifier_elements "ProductContactIDType"
   end
 
   class SalesOutletIdentifier < Identifier
-    element "SalesOutletIDType", :subset, :shortcut => :type
+    identifier_elements "SalesOutletIDType"
   end
 
   class WorkIdentifier < Identifier
-    element "WorkIDType", :subset, :shortcut => :type
+    identifier_elements "WorkIDType"
   end
 
-  module EanMethods
-    # EAN string identifier from identifiers
-    def ean
-      if ean_identifier
-        ean_identifier.value
-      else
-        nil
-      end
-    end
+  class SupplyContactIdentifier < Identifier
+    identifier_elements "SupplyContactIDType"
+  end
 
-    private
-    def ean_identifier
-      self.identifiers.select { |id| id.type.human=="Gtin13" }.first || self.identifiers.select { |id| id.type.human=="Isbn13" }.first
-    end
+  class TextItemIdentifier < Identifier
+    identifier_elements "TextItemIDType"
   end
 
-  module IsbnMethods
-    # ISBN-13 string identifier from identifiers
-    def isbn13
-      if isbn13_identifier
-        isbn13_identifier.value
-      else
-        nil
+  module IdentifiersMethods
+    module Ean
+      # EAN string identifier from identifiers
+      # @return [String]
+      def ean
+        if ean_identifier
+          ean_identifier.value
+        else
+          nil
+        end
       end
-    end
 
-    private
-    def isbn13_identifier
-      self.identifiers.select{|id| id.type.human=="Isbn13"}.first
+      private
+
+      def ean_identifier
+        self.identifiers.select { |id| id.type.human == "Gtin13" }.first || self.identifiers.select { |id| id.type.human == "Isbn13" }.first
+      end
     end
-  end
 
-  module GlnMethods
-    # GLN string identifier from identifiers
-    def gln
-      if gln_identifier
-        if gln_identifier.value =~ /\d{13}/
-          gln_identifier.value
+    module Isbn
+      # ISBN-13 string identifier from identifiers
+      # @return [String]
+      def isbn13
+        if isbn13_identifier
+          isbn13_identifier.value
         else
-          puts "Invalid GLN #{gln_identifier.value}"
           nil
         end
-      else
-        nil
+      end
+
+      private
+
+      def isbn13_identifier
+        self.identifiers.select { |id| id.type.human == "Isbn13" }.first
       end
     end
 
-    # private
-    def gln_identifier
-      self.identifiers.select { |id| id.type.human=="Gln" }.first
+    module Gln
+      # GLN string identifier from identifiers
+      # @return [String]
+      def gln
+        if gln_identifier
+          if gln_identifier.value =~ /\d{13}/
+            gln_identifier.value
+          else
+            # puts "WARN Invalid GLN #{gln_identifier.value}"
+            nil
+          end
+        else
+          nil
+        end
+      end
+
+      # private
+      def gln_identifier
+        self.identifiers.select { |id| id.type.human == "Gln" }.first
+      end
     end
-  end
 
-  module ProprietaryIdMethods
-    def proprietary_ids
-      self.identifiers.select { |id| id.type.human=="Proprietary" }
+    module ProprietaryId
+      def proprietary_ids
+        self.identifiers.select { |id| id.type.human == "Proprietary" }
+      end
     end
   end
 end

data/lib/onix/language.rb

@@ -1,7 +1,10 @@
 module ONIX
   class Language < SubsetDSL
-    element "LanguageRole", :subset, :shortcut => :role
-    element "LanguageCode", :subset, :shortcut => :code
+    element "LanguageRole", :subset, :shortcut => :role, :cardinality => 1
+    element "LanguageCode", :subset, :shortcut => :code, :cardinality => 1
+    element "CountryCode", :subset, :cardinality => 0..1
+    element "RegionCode", :subset, :cardinality => 0..1
+    element "ScriptCode", :subset, :cardinality => 0..1
 
     scope :of_text, lambda { human_code_match(:language_role, "LanguageOfText") }
   end

data/lib/onix/market.rb

@@ -1,5 +1,6 @@
 module ONIX
   class Market < SubsetDSL
-    element "Territory", :subset
+    element "Territory", :subset, :cardinality => 1
+    elements "SalesRestriction", :subset, :cardinality => 0..n
   end
 end

data/lib/onix/market_publishing_detail.rb

@@ -1,8 +1,19 @@
+require 'onix/publisher_representative'
+require 'onix/product_contact'
+
 module ONIX
   class MarketPublishingDetail < SubsetDSL
-    elements "PublisherRepresentative", :subset, {:klass => "Agent"}
-    element "MarketPublishingStatus", :subset
-    elements "MarketDate", :subset
+    elements "PublisherRepresentative", :subset, :klass => "Agent", :cardinality => 0..n
+    elements "ProductContact", :subset, :cardinality => 0..n
+    element "MarketPublishingStatus", :subset, :cardinality => 1
+    elements "MarketPublishingStatusNote", :text, :cardinality => 0..n
+    elements "MarketDate", :subset, :cardinality => 0..n
+    elements "PromotionCampaign", :text, :cardinality => 0..n
+    element "PromotionContact", :text, :cardinality => 0..1
+    elements "InitialPrintRun", :text, :cardinality => 0..n
+    elements "ReprintDetail", :text, :cardinality => 0..n
+    elements "CopiesSold", :text, :cardinality => 0..n
+    elements "BookClubAdoption", :text, :cardinality => 0..n
 
     # @!group High level
 

data/lib/onix/measure.rb

@@ -0,0 +1,7 @@
+module ONIX
+  class Measure < SubsetDSL
+    element "MeasureType", :subset, :cardinality => 1
+    element "Measurement", :text, :cardinality => 1
+    element "MeasureUnitCode", :subset, :cardinality => 1
+  end
+end

data/lib/onix/onix21.rb

@@ -2,26 +2,28 @@ module ONIX
   module ONIX21
     class ShortToRef
       def self.names
-        @shortnames ||= YAML.load(File.open(File.dirname(__FILE__) + "/../../data/onix21/shortnames.yml"))
+        @shortnames ||= YAML.load(File.open(File.dirname(__FILE__) + "/../../data/onix21/shortnames.yml")).freeze
       end
     end
 
     class RefToShort
       def self.names
-        @refnames ||= ShortToRef.names.invert
+        @refnames ||= ShortToRef.names.invert.freeze
       end
     end
 
     class SubsetDSL < ONIX::SubsetDSL
-      def self.short_to_ref(name)
-        ONIX::ONIX21::ShortToRef.names[name]
-      end
+      class << self
+        def short_to_ref(name)
+          ONIX::ONIX21::ShortToRef.names[name]
+        end
 
-      def self.ref_to_short(name)
-        ONIX::ONIX21::RefToShort.names[name]
+        def ref_to_short(name)
+          ONIX::ONIX21::RefToShort.names[name]
+        end
       end
 
-      def self.get_class(name)
+      def get_class(name)
         if ONIX::ONIX21.const_defined?(name, false)
           ONIX::ONIX21.const_get(name)
         else
@@ -34,11 +36,11 @@ module ONIX
 
     class CodeFromYaml < Code
       def self.hash
-        @hash ||= YAML.load(File.open(File.dirname(__FILE__) + "/../../data/onix21/codelists/codelist-#{self.code_ident}.yml"))[:codelist]
+        @hash ||= YAML.load(File.open(File.dirname(__FILE__) + "/../../data/onix21/codelists/codelist-#{self.code_ident}.yml"))[:codelist].freeze
       end
 
       def self.list
-        self.hash.to_a.map { |h| h.first }
+        self.hash.keys
       end
 
       def self.code_ident
@@ -131,8 +133,8 @@ module ONIX
     class Price < SubsetDSL
       element "PriceTypeCode", :subset, :klass => "PriceType"
       element "PriceAmount", :float, {
-          :shortcut => :amount,
-          :parse_lambda => lambda { |v| (v * 100).round }
+        :shortcut => :amount,
+        :parse_lambda => lambda { |v| (v * 100).round }
       }
       element "PriceQualifier", :subset, :shortcut => :qualifier
       element "DiscountCoded", :subset
@@ -196,8 +198,8 @@ module ONIX
       element "AvailabilityCode", :text
       element "ProductAvailability", :text
       element "OnSaleDate", :text, {
-          :shortcut => :availability_date,
-          :parse_lambda => lambda { |v| Date.strptime(v, "%Y%m%d") }
+        :shortcut => :availability_date,
+        :parse_lambda => lambda { |v| Date.strptime(v, "%Y%m%d") }
       }
       elements "Price", :subset
 
@@ -232,8 +234,8 @@ module ONIX
     end
 
     class RelatedProduct < SubsetDSL
-      include EanMethods
-      include ProprietaryIdMethods
+      include IdentifiersMethods::Ean
+      include IdentifiersMethods::ProprietaryId
 
       element "RelationCode", :text, :shortcut => :code
       elements "ProductIdentifier", :subset, :shortcut => :identifiers
@@ -246,17 +248,17 @@ module ONIX
       element "SubjectCode", :text, :shortcut => :code
       element "SubjectHeadingText", :text, :shortcut => :heading_text
       element "MainSubjectSchemeIdentifier", :subset, {
-          :shortcut => :scheme_identifier,
-          :klass => "SubjectSchemeIdentifier"
+        :shortcut => :scheme_identifier,
+        :klass => "SubjectSchemeIdentifier"
       }
       element "SubjectSchemeName", :text, :shortcut => :scheme_name
       element "SubjectSchemeVersion", :text, :shortcut => :scheme_version
     end
 
     class Product < SubsetDSL
-      include EanMethods
-      include IsbnMethods
-      include ProprietaryIdMethods
+      include IdentifiersMethods::Ean
+      include IdentifiersMethods::Isbn
+      include IdentifiersMethods::ProprietaryId
 
       element "RecordReference", :text
       elements "ProductIdentifier", :subset, :shortcut => :identifiers
@@ -281,7 +283,7 @@ module ONIX
 
       elements "OtherText", :subset
 
-      elements "SalesRights", :subset, {:pluralize => false}
+      elements "SalesRights", :subset, { :pluralize => false }
       elements "NotForSale", :subset
 
       element "BASICMainSubject", :text
@@ -289,7 +291,7 @@ module ONIX
       elements "Subject", :subset
 
       element "PublishingStatus", :text
-      element "PublicationDate", :text, {:parse_lambda => lambda { |v| Date.strptime(v, "%Y%m%d") }}
+      element "PublicationDate", :text, { :parse_lambda => lambda { |v| Date.strptime(v, "%Y%m%d") } }
 
       elements "RelatedProduct", :subset, :shortcut => :related
 
@@ -440,7 +442,7 @@ module ONIX
         nil
       end
 
-      include ProductSuppliesExtractor
+      include ProductSuppliesMethods
 
       # doesn't apply
       def parts