im_onix 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 956b2f80b2309dd983629d3e3ec2e14f854c8514ae5fe0cf2030c6929c6db371
-  data.tar.gz: 60b6cfbd37b72e1ee40db946dfff209b18479c1a360fbb7123c4e91da87734f7
+  metadata.gz: 1ae373f892a08b5321d26712145417619ca310f6a5d6f7bc67ad42049d65a7c9
+  data.tar.gz: c6b81828cef14da0196bd9e27e5a92fb6e95718e3e7261b8407f346f9e7dfe64
 SHA512:
-  metadata.gz: 898d6346b0e55f4c1b7521e7f3a91d3c03565503833b3acd481fa964ce31b18d8c44df63cbf6eb9848bce854390464f4c2979fff55421d7f48ad9078517fbc56
-  data.tar.gz: 55b9ace6c959c0d6397d42c1ae01d4bef0c8aba84d073258a7fe8855b1c08ef3697cc1a65a53c307de3895ca319f2ca0a6cfb840a33322f318aae646da768e32
+  metadata.gz: 3595015fab4b4c17898aedbb507189c81ba830cb0c76914b5b280965a574beffcf7bc31f2376c1667568ffadf4e7213b996e91cb89755f2bcee9296bad1a5cd5
+  data.tar.gz: 388f43af3200a38a9d3c20fb1e08e3157a2119a2b6faf91af9505c5b25b36a938c45d3faa6be2ebea90b31dc54bd84f498fa24875d258a067e043b0d0e87e525

data/Gemfile

@@ -1,8 +1,3 @@
 source "http://rubygems.org"
 
-gem 'nokogiri'
-
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler"
-end
+gemspec

data/README.md

@@ -30,7 +30,7 @@ onix3_to_onix3.rb onix.xml
 Launch this command:
 
 ```
-ruby -Ilib:test test/test_im_onix.rb
+bundle exec rake test
 ```
 
 ### Contributors

data/bin/onix_bench.rb

@@ -8,10 +8,26 @@ filename = ARGV[0]
 if filename
   GC.start
   old_memsize = ObjectSpace.count_objects_size[:TOTAL]
+
+  if ENV['PROFILE'] == 'yes'
+    require 'ruby-prof'
+    RubyProf.start
+  end
+
   msg = ONIX::ONIXMessage.new
   bench = Benchmark.measure do
     msg.parse(filename)
   end
+
+  if ENV['PROFILE'] == 'yes'
+    result = RubyProf.stop
+    printer = RubyProf::FlatPrinter.new(result)
+    printer.print(STDOUT, min_percent: 1.0)
+
+    printer = RubyProf::CallTreePrinter.new(result)
+    printer.print
+  end
+
   GC.start
   new_memsize = ObjectSpace.count_objects_size[:TOTAL]
   puts "Parsed #{msg.products.length} products in #{bench.real.round(3)} seconds resulting in use of #{new_memsize - old_memsize} bytes of memory"

data/im_onix.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "im_onix"
-  spec.version       = "1.2.3"
+  spec.version       = "1.3.0"
   spec.authors       = ["Julien Boulnois"]
   spec.email         = ["jboulnois@immateriel.fr"]
 
@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest"
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'shoulda'
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "ruby-prof"
 
   spec.required_ruby_version = '>= 2.1'
 

data/lib/onix/addressee.rb

@@ -2,7 +2,8 @@ require 'onix/identifier'
 
 module ONIX
   class Addressee < SubsetDSL
-    include GlnMethods
+    include IdentifiersMethods::Gln
+
     elements "AddresseeIdentifier", :subset, :shortcut => :identifiers, :cardinality => 0..n
     element "AddresseeName", :text, :shortcut => :name, :cardinality => 0..1
     element "ContactName", :text, :cardinality => 0..1

data/lib/onix/barcode.rb

@@ -0,0 +1,6 @@
+module ONIX
+  class Barcode < SubsetDSL
+    element "BarcodeType", :subset, :cardinality => 1
+    element "PositionOnProduct", :subset, :cardinality => 0..1
+  end
+end

data/lib/onix/builder.rb

@@ -38,6 +38,8 @@ module ONIX
         yield self
       end
 
+      @lax = false
+
       @parent = @doc
     end
 
@@ -55,13 +57,27 @@ module ONIX
       end.to_xml
     end
 
+    # code in block will not check for validity
+    def lax &block
+      if block_given?
+        @lax = true
+        @arity ||= block.arity
+        if @arity <= 0
+          instance_eval(&block)
+        else
+          block.call(self)
+        end
+        @lax = false
+      end
+    end
+
     def method_missing(method, *args, &block)
       # :nodoc:
       if @context && @context.respond_to?(method)
         @context.send(method, *args, &block)
       else
         if @parent
-          parser_el = @parent.class.ancestors_registered_elements[method.to_s]
+          parser_el = @parent.registered_elements[method.to_s]
           if parser_el
             if ONIX.const_defined?(parser_el.klass_name)
               node = get_class(parser_el.klass_name, args)
@@ -82,7 +98,7 @@ module ONIX
               when :ignore
               when :subset
                 # FIXME: dirty
-                if @parent.class.included_modules.include?(DateHelper) && node.is_a?(DateFormat)
+                if @parent.class.included_modules.include?(DateMethods) && node.is_a?(DateFormat)
                   @parent.deprecated_date_format = true
                 end
                 node.attributes = get_attributes(args[1]) if args.length > 1
@@ -129,7 +145,9 @@ module ONIX
       if arg.is_a?(String)
         el = klass.from_code(arg)
         unless el.human
-          raise BuilderInvalidCode, [klass.to_s, arg]
+          unless @lax
+            raise BuilderInvalidCode, [klass.to_s, arg]
+          end
         end
         el
       else
@@ -154,14 +172,12 @@ module ONIX
     end
 
     def get_class(nm, args)
-      el = nil
       if ONIX.const_defined?(nm)
         klass = ONIX.const_get(nm)
-        el = get_element(klass, args)
+        get_element(klass, args)
       else
         raise BuilderUndefinedElement, nm
       end
-      el
     end
 
     def insert(node, &block)

data/lib/onix/code.rb

@@ -1,11 +1,10 @@
-# -*- encoding : utf-8 -*-
 require 'yaml'
 
 module ONIX
   class InvalidCodeAlias < StandardError
   end
 
-  module CodeHelper
+  module CodeMethods
     def parse(n)
       parse_attributes(n.attributes)
       @code = n.text
@@ -33,58 +32,56 @@ 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)
-      unless obj.code
-        raise InvalidCodeAlias, [self.to_s, human]
+    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
-      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.codelist_filename
-      File.dirname(__FILE__) + "/../../data/codelists/codelist-#{self.code_ident}.yml"
-    end
-
-    def self.hash
-      @hash ||= YAML.load(File.open(codelist_filename))[: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
@@ -109,6 +106,7 @@ module ONIX
       end
     end
   end
+
   class NotificationType < CodeFromYaml
     code_identifier 1
   end

data/lib/onix/date.rb

@@ -1,5 +1,5 @@
 module ONIX
-  module DateHelper
+  module DateMethods
     # @return [DateFormat]
     attr_accessor :date_format
     # @return [Date]
@@ -31,7 +31,7 @@ module ONIX
       format = code_format
 
       if code_format != text_format
-        puts "WARN incorrect date format #{text_format} != #{code_format}"
+        # puts "WARN incorrect date format #{text_format} != #{code_format}"
         format = text_format
       end
 
@@ -133,9 +133,15 @@ module ONIX
   end
 
   class BaseDate < SubsetDSL
-    include DateHelper
-    element "DateFormat", :subset
-    element "Date", :text
+    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]
@@ -153,26 +159,26 @@ module ONIX
   end
 
   class MarketDate < BaseDate
-    element "MarketDateRole", :subset, :shortcut => :role
+    date_elements "MarketDateRole"
 
     scope :availability, lambda { human_code_match(:market_date_role, ["PublicationDate", "EmbargoDate"]) }
   end
 
   class PriceDate < BaseDate
-    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 "SupplyDateRole", :subset, :shortcut => :role
+    date_elements "SupplyDateRole"
 
     scope :availability, lambda { human_code_match(:supply_date_role, ["ExpectedAvailabilityDate", "EmbargoDate"]) }
   end
 
   class PublishingDate < BaseDate
-    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, "SalesEmbargoDate") }
@@ -181,12 +187,12 @@ module ONIX
   end
 
   class ContentDate < BaseDate
-    element "ContentDateRole", :subset, :shortcut => :role
+    date_elements "ContentDateRole"
 
     scope :last_updated, lambda { human_code_match(:content_date_role, "LastUpdated") }
   end
 
   class ContributorDate < BaseDate
-    element "ContributorDateRole", :subset, :shortcut => :role
+    date_elements "ContributorDateRole"
   end
 end

data/lib/onix/entity.rb

@@ -7,7 +7,7 @@ module ONIX
   end
 
   class Entity < SubsetDSL
-    include GlnMethods
+    include IdentifiersMethods::Gln
     include EntityHelper
 
     # @return [String]
@@ -60,7 +60,8 @@ module ONIX
   end
 
   class Imprint < SubsetDSL
-    include GlnMethods
+    include IdentifiersMethods::Gln
+
     elements "ImprintIdentifier", :subset, :shortcut => :identifiers, :cardinality => 0..n
     element "ImprintName", :text, :shortcut => :name, :cardinality => 0..1
   end

data/lib/onix/identifier.rb

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

@@ -1,3 +1,4 @@
+require 'onix/publisher_representative'
 require 'onix/product_contact'
 
 module ONIX