im_onix 1.1.1 → 1.3.0

data/lib/onix/code.rb

@@ -1,19 +1,24 @@
-# -*- encoding : utf-8 -*-
 require 'yaml'
 
 module ONIX
-  module CodeHelper
+  class InvalidCodeAlias < StandardError
+  end
+
+  module CodeMethods
     def parse(n)
+      parse_attributes(n.attributes)
       @code = n.text
       @human = self.class.hash[n.text]
     end
 
     # Humanized string code
+    # @return [String]
     def human
       @human
     end
 
     # ONIX code
+    # @return [String]
     def onix
       @code
     end
@@ -27,57 +32,63 @@ module ONIX
     #   @return [String] humanized string (eg: "Digital watermarking" become DigitalWatermarking, "PDF" become Pdf, "BISAC Subject Heading" become BisacSubjectHeading, etc)
     attr_accessor :human
 
-    include CodeHelper
-
-    # create Code from ONIX code
-    # @param [String] code ONIX code
-    # @return [Code]
-    def self.from_code(code)
-      obj = self.new
-      obj.code = code
-      obj.human = self.hash[code]
-      obj
-    end
-
-    # create Code from human readable code
-    # @param [String] human human readable code
-    # @return [Code]
-    def self.from_human(human)
-      obj = self.new
-      obj.human = human
-      obj.code = self.hash.key(human)
-      obj
-    end
+    include CodeMethods
+
+    class << self
+      # create Code from ONIX code
+      # @param [String] code ONIX code
+      # @return [Code]
+      def from_code(code)
+        obj = self.new
+        obj.code = code
+        obj.human = self.hash[code]
+        obj
+      end
 
-    private
+      # create Code from human readable code
+      # @param [String] human human readable code
+      # @return [Code]
+      def from_human(human)
+        obj = self.new
+        obj.human = human
+        obj.code = self.hash.key(human)
+        unless obj.code
+          raise InvalidCodeAlias, [self.to_s, human]
+        end
+        obj
+      end
 
-    def self.hash
-      {}
+      def hash
+        {}
+      end
     end
   end
 
   class CodeFromYaml < Code
-    def self.hash
-      @hash ||= YAML.load(File.open(File.dirname(__FILE__) + "/../../data/codelists/codelist-#{self.code_ident}.yml"))[:codelist]
-    end
+    class << self
+      def hash
+        @hash ||= YAML.load(File.open(File.dirname(__FILE__) + "/../../data/codelists/codelist-#{self.code_ident}.yml"))[:codelist].freeze
+      end
 
-    def self.list
-      self.hash.to_a.map { |h| h.first }
-    end
+      def list
+        self.hash.keys
+      end
 
-    def self.code_ident
-      nil
-    end
+      def code_ident
+        nil
+      end
 
-    def self.code_identifier code
-      define_singleton_method :code_ident do
-        return code
+      def code_identifier code
+        define_singleton_method :code_ident do
+          return code
+        end
       end
     end
   end
 
   class CodeFromYamlWithMime < CodeFromYaml
     # main formats
+    # @return [String]
     def mimetype
       case self.human
       when "Epub"
@@ -104,14 +115,30 @@ module ONIX
     code_identifier 2
   end
 
+  class RecordSourceType < CodeFromYaml
+    code_identifier 3
+  end
+
   class ProductIDType < CodeFromYaml
     code_identifier 5
   end
 
+  class ProductClassificationType < CodeFromYaml
+    code_identifier 9
+  end
+
+  class TradeCategory < CodeFromYaml
+    code_identifier 12
+  end
+
   class CollectionIDType < CodeFromYaml
     code_identifier 13
   end
 
+  class TextCase < CodeFromYaml
+    code_identifier 14
+  end
+
   class TitleType < CodeFromYaml
     code_identifier 15
   end
@@ -124,6 +151,18 @@ module ONIX
     code_identifier 17
   end
 
+  class NameType < CodeFromYaml
+    code_identifier 18
+  end
+
+  class UnnamedPersons < CodeFromYaml
+    code_identifier 19
+  end
+
+  class ConferenceRole < CodeFromYaml
+    code_identifier 20
+  end
+
   class EditionType < CodeFromYaml
     code_identifier 21
   end
@@ -140,6 +179,10 @@ module ONIX
     code_identifier 24
   end
 
+  class AncillaryContentType < CodeFromYaml
+    code_identifier 25
+  end
+
   class SubjectSchemeIdentifier < CodeFromYaml
     code_identifier 27
   end
@@ -148,6 +191,38 @@ module ONIX
     code_identifier 28
   end
 
+  class AudienceCodeType < CodeFromYaml
+    code_identifier 29
+  end
+
+  class AudienceRangeQualifier < CodeFromYaml
+    code_identifier 30
+  end
+
+  class AudienceRangePrecision < CodeFromYaml
+    code_identifier 31
+  end
+
+  class ComplexitySchemeIdentifier < CodeFromYaml
+    code_identifier 32
+  end
+
+  class TextFormat < CodeFromYaml
+    code_identifier 34
+  end
+
+  class PrizeCode < CodeFromYaml
+    code_identifier 41
+  end
+
+  class TextItemType < CodeFromYaml
+    code_identifier 42
+  end
+
+  class TextItemIDType < CodeFromYaml
+    code_identifier 43
+  end
+
   class IDType < CodeFromYaml
     code_identifier 44
   end
@@ -158,6 +233,9 @@ module ONIX
   class AddresseeIDType < IDType
   end
 
+  class RecordSourceIDType < IDType
+  end
+
   class PublisherIDType < IDType
   end
 
@@ -167,6 +245,12 @@ module ONIX
   class NameIDType < IDType
   end
 
+  class NameIDType < IDType
+  end
+
+  class ProductContactIDType < IDType
+  end
+
   class PublishingRole < CodeFromYaml
     code_identifier 45
   end
@@ -175,14 +259,26 @@ module ONIX
     code_identifier 46
   end
 
+  class MeasureType < CodeFromYaml
+    code_identifier 48
+  end
+
   class RegionCode < CodeFromYaml
     code_identifier 49
   end
 
+  class MeasureUnitCode < CodeFromYaml
+    code_identifier 50
+  end
+
   class ProductRelationCode < CodeFromYaml
     code_identifier 51
   end
 
+  class ReturnsCodeType < CodeFromYaml
+    code_identifier 53
+  end
+
   class DateFormat < CodeFromYaml
     code_identifier 55
   end
@@ -199,6 +295,10 @@ module ONIX
     code_identifier 59
   end
 
+  class PricePer < CodeFromYaml
+    code_identifier 60
+  end
+
   class PriceStatus < CodeFromYaml
     code_identifier 61
   end
@@ -223,10 +323,18 @@ module ONIX
     code_identifier 69
   end
 
+  class StockQuantityCodeType < CodeFromYaml
+    code_identifier 70
+  end
+
   class SalesRestrictionType < CodeFromYaml
     code_identifier 71
   end
 
+  class ThesisType < CodeFromYaml
+    code_identifier 72
+  end
+
   class WebsiteRole < CodeFromYaml
     code_identifier 73
   end
@@ -239,10 +347,50 @@ module ONIX
     code_identifier 79
   end
 
+  class ProductPackaging < CodeFromYaml
+    code_identifier 80
+  end
+
   class ProductContentType < CodeFromYaml
     code_identifier 81
   end
 
+  class BibleContents < CodeFromYaml
+    code_identifier 82
+  end
+
+  class BibleVersion < CodeFromYaml
+    code_identifier 83
+  end
+
+  class StudyBibleType < CodeFromYaml
+    code_identifier 84
+  end
+
+  class BiblePurpose < CodeFromYaml
+    code_identifier 85
+  end
+
+  class BibleTextOrganization < CodeFromYaml
+    code_identifier 86
+  end
+
+  class BibleReferenceLocation < CodeFromYaml
+    code_identifier 87
+  end
+
+  class ReligiousTextIdentifier < CodeFromYaml
+    code_identifier 88
+  end
+
+  class ReligiousTextFeatureType < CodeFromYaml
+    code_identifier 89
+  end
+
+  class ReligiousTextFeatureCode < CodeFromYaml
+    code_identifier 90
+  end
+
   class CountryCode < CodeFromYaml
     code_identifier 91
   end
@@ -259,10 +407,30 @@ module ONIX
     code_identifier 93
   end
 
+  class BibleTextFeature < CodeFromYaml
+    code_identifier 97
+  end
+
+  class DiscountCodeType < CodeFromYaml
+    code_identifier 100
+  end
+
   class SalesOutletIDType < CodeFromYaml
     code_identifier 102
   end
 
+  class ScriptCode < CodeFromYaml
+    code_identifier 121
+  end
+
+  class BarcodeType < CodeFromYaml
+    code_identifier 141
+  end
+
+  class PositionOnProduct < CodeFromYaml
+    code_identifier 142
+  end
+
   class EpubTechnicalProtection < CodeFromYaml
     code_identifier 144
   end
@@ -283,10 +451,6 @@ module ONIX
     code_identifier 148
   end
 
-  class CollectionSequenceType < CodeFromYaml
-    code_identifier 197
-  end
-
   class TitleElementLevel < CodeFromYaml
     code_identifier 149
   end
@@ -299,6 +463,10 @@ module ONIX
     code_identifier 151
   end
 
+  class Illustrated < CodeFromYaml
+    code_identifier 152
+  end
+
   class TextType < CodeFromYaml
     code_identifier 153
   end
@@ -311,6 +479,14 @@ module ONIX
     code_identifier 155
   end
 
+  class CitedContentType < CodeFromYaml
+    code_identifier 156
+  end
+
+  class SourceType < CodeFromYaml
+    code_identifier 157
+  end
+
   class ResourceContentType < CodeFromYaml
     code_identifier 158
   end
@@ -343,18 +519,46 @@ module ONIX
     code_identifier 164
   end
 
+  class SupplierCodeType < CodeFromYaml
+    code_identifier 165
+  end
+
   class SupplyDateRole < CodeFromYaml
     code_identifier 166
   end
 
+  class PriceConditionType < CodeFromYaml
+    code_identifier 167
+  end
+
+  class PriceConditionQuantityType < CodeFromYaml
+    code_identifier 168
+  end
+
+  class QuantityUnit < CodeFromYaml
+    code_identifier 169
+  end
+
+  class DiscountType < CodeFromYaml
+    code_identifier 170
+  end
+
   class TaxType < CodeFromYaml
     code_identifier 171
   end
 
+  class CurrencyZone < CodeFromYaml
+    code_identifier 172
+  end
+
   class PriceDateRole < CodeFromYaml
     code_identifier 173
   end
 
+  class PrintedOnProduct < CodeFromYaml
+    code_identifier 174
+  end
+
   class ProductFormDetail < CodeFromYamlWithMime
     code_identifier 175
   end
@@ -366,4 +570,80 @@ module ONIX
   class SupportingResourceFileFormat < CodeFromYamlWithMime
     code_identifier 178
   end
+
+  class PriceCodeType < CodeFromYaml
+    code_identifier 179
+  end
+
+  class CollectionSequenceType < CodeFromYaml
+    code_identifier 197
+  end
+
+  class ProductContactRole < CodeFromYaml
+    code_identifier 198
+  end
+
+  class ReturnsCode < CodeFromYaml
+    code_identifier 204
+  end
+
+  class Proximity < CodeFromYaml
+    code_identifier 215
+  end
+
+  class VelocityMetric < CodeFromYaml
+    code_identifier 216
+  end
+
+  class PriceIDType < CodeFromYaml
+    code_identifier 217
+  end
+
+  class EpubLicenseExpressionType < CodeFromYaml
+    code_identifier 218
+  end
+
+  class CopyrightType < CodeFromYaml
+    code_identifier 219
+  end
+
+  class FundingIDType < CodeFromYaml
+    code_identifier 228
+  end
+
+  class Gender < CodeFromYaml
+    code_identifier 229
+  end
+
+  class PriceConstraintType < CodeFromYaml
+    code_identifier 230
+  end
+
+  class SupplyContactRole < CodeFromYaml
+    code_identifier 239
+  end
+
+  class AVItemType < CodeFromYaml
+    code_identifier 240
+  end
+
+  class AVItemIDType < CodeFromYaml
+    code_identifier 241
+  end
+
+  class EventIDType < CodeFromYaml
+    code_identifier 244
+  end
+
+  class EventType < CodeFromYaml
+    code_identifier 245
+  end
+
+  class EventStatus < CodeFromYaml
+    code_identifier 246
+  end
+
+  class OccurrenceDateRole < CodeFromYaml
+    code_identifier 247
+  end
 end

data/lib/onix/collateral_detail.rb

@@ -1,18 +1,14 @@
-module ONIX
-  class TextContent < SubsetDSL
-    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") }
-  end
+require 'onix/text_content'
+require 'onix/supporting_resource'
+require 'onix/cited_content'
+require 'onix/prize'
 
+module ONIX
   class CollateralDetail < SubsetDSL
-    elements "TextContent", :subset
-    elements "SupportingResource", :subset
+    elements "TextContent", :subset, :cardinality => 0..n
+    elements "CitedContent", :subset, :cardinality => 0..n
+    elements "SupportingResource", :subset, :cardinality => 0..n
+    elements "Prize", :subset, :cardinality => 0..n
 
     # @!group High level
 

data/lib/onix/collection.rb

@@ -1,15 +1,23 @@
+require 'onix/collection_sequence'
+
 module ONIX
   class Collection < SubsetDSL
-    element "CollectionType", :subset, :shortcut => :type
-    elements "CollectionIdentifier", :subset, :shortcut => :identifiers
-    elements "TitleDetail", :subset
-    elements "CollectionSequence", :subset, :shortcut => :sequences
+    element "CollectionType", :subset, :shortcut => :type, :cardinality => 1
+    element "SourceName", :text, :cardinality => 0..1
+    elements "CollectionIdentifier", :subset, :shortcut => :identifiers, :cardinality => 0..n
+    elements "CollectionSequence", :subset, :shortcut => :sequences, :cardinality => 0..n
+    elements "TitleDetail", :subset, :cardinality => 0..n
+    elements "Contributor", :subset, :cardinality => 0..n
+    elements "ContributorStatement", :text, :cardinality => 0..n
+    elements "ContributorStatement", :text, :cardinality => 0..n
+    element "NoContributor", :bool, :cardinality => 0..1
 
     scope :publisher, lambda { human_code_match(:collection_type, "PublisherCollection") }
 
     # @!group High level
 
     # collection title string
+    # @return [String]
     def title
       if collection_title_element
         collection_title_element.title
@@ -17,12 +25,14 @@ module ONIX
     end
 
     # collection subtitle string
+    # @return [String]
     def subtitle
       if collection_title_element
         collection_title_element.subtitle
       end
     end
 
+    # @return [TitleElement]
     def collection_title_element
       distinctive_title = @title_details.distinctive_title.first
       #select { |td| td.type.human=~/DistinctiveTitle/}.first

data/lib/onix/collection_sequence.rb

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

data/lib/onix/comparison_product_price.rb

@@ -0,0 +1,17 @@
+require 'onix/code'
+require 'onix/identifier'
+
+module ONIX
+  class ComparisonProductPrice < SubsetDSL
+    elements "ProductIdentifier", :subset, :cardinality => 1..n
+    element "PriceType", :subset, :shortcut => :type, :cardinality => 0..1
+    element "PriceAmount", :float,
+            {
+              :shortcut => :amount,
+              :parse_lambda => lambda { |v| (v * 100).round },
+              :serialize_lambda => lambda { |v| v / 100.0 },
+              :cardinality => 1
+            }
+    element "CurrencyCode", :text, :shortcut => :currency, :cardinality => 0..1
+  end
+end

data/lib/onix/complexity.rb

@@ -0,0 +1,6 @@
+module ONIX
+  class Complexity < SubsetDSL
+    element "ComplexitySchemeIdentifier", :subset, :cardinality => 1
+    element "ComplexityCode", :text, :cardinality => 1
+  end
+end

data/lib/onix/content_detail.rb

@@ -0,0 +1,7 @@
+require 'onix/content_item'
+
+module ONIX
+  class ContentDetail < SubsetDSL
+    elements "ContentItem", :subset, :cardinality => 0..n
+  end
+end

data/lib/onix/content_item.rb

@@ -0,0 +1,38 @@
+require 'onix/text_item'
+require 'onix/contributor'
+require 'onix/language'
+require 'onix/subject'
+require 'onix/title_detail'
+require 'onix/text_content'
+require 'onix/cited_content'
+require 'onix/supporting_resource'
+require 'onix/related_work'
+require 'onix/related_product'
+
+module ONIX
+  class ContentItem < SubsetDSL
+    element "LevelSequenceNumber", :integer, :cardinality => 0..1
+    element "TextItem", :subset, :cardinality => 0..1
+
+    # element "AVItem", :subset, :cardinality => 0..1
+
+
+    element "ComponentTypeName", :text, :cardinality => 0..1
+    element "ComponentNumber", :text, :cardinality => 0..1
+    elements "TitleDetail", :subset, :cardinality => 0..n
+    elements "Contributor", :subset, :cardinality => 0..n
+    elements "ContributorStatement", :text, :cardinality => 0..n
+    element "NoContributor", :bool, :cardinality => 0..1
+    elements "Language", :subset, :cardinality => 0..n
+    elements "Subject", :subset, :cardinality => 0..n
+
+    # elements "NameAsSubject", :subset, :cardinality => 0..n
+
+
+    elements "TextContent", :subset, :cardinality => 0..n
+    elements "CitedContent", :subset, :cardinality => 0..n
+    elements "SupportingResource", :subset, :cardinality => 0..n
+    elements "RelatedWork", :subset, :cardinality => 0..n
+    elements "RelatedProduct", :subset, :cardinality => 0..n
+  end
+end