im_onix 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f4feeceb8c2275507ee70aac9c2eb2cf8cc335d14ae60fb480b8493b539ecd9
-  data.tar.gz: ead4f5e2dfb4e4a5cbcd14c14a5a3f8efe0004aac253c9c26aab3a91500d689a
+  metadata.gz: 956b2f80b2309dd983629d3e3ec2e14f854c8514ae5fe0cf2030c6929c6db371
+  data.tar.gz: 60b6cfbd37b72e1ee40db946dfff209b18479c1a360fbb7123c4e91da87734f7
 SHA512:
-  metadata.gz: 8a4c862b06d7613c47a9395737227d0f212f76a7780cba9832060a613e2fc0f0a1ee445e937d08e59921a788c93fc60ff38a3d571a1e8cbc4c46864b1b046215
-  data.tar.gz: f0c1496ae0a1b33d8b10a2e8403383e6918f51982bfe946eceac4111aac12ee543454a68d74211102f2193b73043c036425b3b3ac7890d279b0f995097115c4a
+  metadata.gz: 898d6346b0e55f4c1b7521e7f3a91d3c03565503833b3acd481fa964ce31b18d8c44df63cbf6eb9848bce854390464f4c2979fff55421d7f48ad9078517fbc56
+  data.tar.gz: 55b9ace6c959c0d6397d42c1ae01d4bef0c8aba84d073258a7fe8855b1c08ef3697cc1a65a53c307de3895ca319f2ca0a6cfb840a33322f318aae646da768e32

data/doc-src/handlers.rb

@@ -1,3 +1,4 @@
+require 'yaml'
 class DSLHelpers
   def self.inflectors
     [['ox', 'oxes'],
@@ -47,6 +48,10 @@ class ElementDSLAttributeHandler < YARD::Handlers::Ruby::Base
   handles method_call(:element)
   namespace_only
 
+  def n
+    Float::INFINITY
+  end
+
   process do
     name = statement.parameters[0].jump(:tstring_content, :ident).source
     type = statement.parameters[1].jump(:tstring_content, :ident).source
@@ -93,6 +98,10 @@ class ElementsDSLAttributeHandler < YARD::Handlers::Ruby::Base
   handles method_call(:elements)
   namespace_only
 
+  def n
+    Float::INFINITY
+  end
+
   process do
     name = statement.parameters[0].jump(:tstring_content, :ident).source
     type = statement.parameters[1].jump(:tstring_content, :ident).source
@@ -133,10 +142,8 @@ class ElementsDSLAttributeHandler < YARD::Handlers::Ruby::Base
       register(object)
     end
   end
-
 end
 
-
 class DefDelegatorAttributeHandler < YARD::Handlers::Ruby::Base
   handles method_call(:def_delegator)
   namespace_only
@@ -152,3 +159,26 @@ class DefDelegatorAttributeHandler < YARD::Handlers::Ruby::Base
     register(object)
   end
 end
+
+class CodeAttributeHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:code_identifier)
+  namespace_only
+
+  process do
+    name = statement.parameters[0].jump(:tstring_content, :ident).source
+    codelist_filename = File.dirname(__FILE__) + "/../data/codelists/codelist-#{name}.yml"
+    if File.exist?(codelist_filename)
+      codelist = YAML.load(File.read(codelist_filename))[:codelist]
+      humanized = []
+      codelist.each do |k,v|
+        humanized << "#{v} (#{k})"
+      end
+      returns = YARD::DocstringParser.new.parse("@return [String] humanized name (from code): "+humanized.join(", ")).to_docstring.tags.first
+      object = YARD::CodeObjects::MethodObject.new(namespace, "human", :instance)
+      object.dynamic = true
+      object.add_tag(returns) if returns
+      object[:group] = 'Low level'
+      register(object)
+    end
+  end
+end

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.2"
+  spec.version       = "1.2.3"
   spec.authors       = ["Julien Boulnois"]
   spec.email         = ["jboulnois@immateriel.fr"]
 

data/lib/onix/audience_range.rb

@@ -3,6 +3,7 @@ module ONIX
     element "AudienceRangeQualifier", :subset, :cardinality => 1
     element "AudienceRangePrecision", :subset, :cardinality => 1
     element "AudienceRangeValue", :integer, :cardinality => 1
+
     # element "AudienceRangePrecision", :subset, :cardinality => 0..1
     # element "AudienceRangeValue", :integer, :cardinality => 0..1
   end

data/lib/onix/code.rb

@@ -13,11 +13,13 @@ module ONIX
     end
 
     # Humanized string code
+    # @return [String]
     def human
       @human
     end
 
     # ONIX code
+    # @return [String]
     def onix
       @code
     end
@@ -89,6 +91,7 @@ module ONIX
 
   class CodeFromYamlWithMime < CodeFromYaml
     # main formats
+    # @return [String]
     def mimetype
       case self.human
       when "Epub"

data/lib/onix/collection.rb

@@ -17,6 +17,7 @@ module ONIX
     # @!group High level
 
     # collection title string
+    # @return [String]
     def title
       if collection_title_element
         collection_title_element.title
@@ -24,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/content_item.rb

@@ -13,7 +13,10 @@ 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
@@ -22,7 +25,10 @@ module ONIX
     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

data/lib/onix/contributor.rb

@@ -9,7 +9,10 @@ module ONIX
     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
@@ -21,11 +24,17 @@ module ONIX
     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
@@ -34,6 +43,15 @@ module ONIX
     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]
@@ -63,10 +81,6 @@ module ONIX
       self.biographies.first
     end
 
-    def place
-      self.places.first
-    end
-
     # raw biography string without HTML
     # @return [String]
     def raw_biography

data/lib/onix/copyright_statement.rb

@@ -2,6 +2,7 @@ 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,6 +1,11 @@
 module ONIX
   module DateHelper
-    attr_accessor :date_format, :date, :datetime
+    # @return [DateFormat]
+    attr_accessor :date_format
+    # @return [Date]
+    attr_accessor :date
+    # @return [Time]
+    attr_accessor :datetime
 
     def parse_date
       if @date_format
@@ -15,6 +20,9 @@ module ONIX
       @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)
@@ -36,6 +44,8 @@ module ONIX
       datetime
     end
 
+    # @param [String] code
+    # @return [String]
     def format_from_code(code)
       case code
       when "00"
@@ -55,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}/
@@ -72,6 +83,7 @@ module ONIX
       end
     end
 
+    # @return [Time]
     def time
       @datetime
     end
@@ -124,6 +136,9 @@ module ONIX
     include DateHelper
     element "DateFormat", :subset
     element "Date", :text
+
+    # use former date representation
+    # @return [Boolean]
     attr_accessor :deprecated_date_format
 
     def initialize

data/lib/onix/descriptive_detail.rb

@@ -43,14 +43,20 @@ module ONIX
     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
@@ -58,7 +64,10 @@ module ONIX
     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
@@ -67,18 +76,48 @@ module ONIX
 
     # @!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
@@ -103,10 +142,6 @@ module ONIX
       end
     end
 
-    def filesize_extent
-      @extents.filesize.first
-    end
-
     # file size in bytes
     # @return [Integer]
     def filesize
@@ -145,14 +180,11 @@ 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?
@@ -200,6 +232,7 @@ module ONIX
     end
 
     # language of text
+    # @return [String]
     def language_of_text
       l = @languages.of_text.first
       if l
@@ -207,10 +240,6 @@ module ONIX
       end
     end
 
-    def publisher_collection
-      @collections.publisher.first
-    end
-
     # publisher collection title
     # @return [String]
     def publisher_collection_title
@@ -219,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
@@ -244,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/entity.rb

@@ -10,18 +10,22 @@ module ONIX
     include GlnMethods
     include EntityHelper
 
+    # @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
 
+    # @return [String]
     def self.prefix
     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

@@ -74,6 +74,7 @@ module ONIX
 
   module EanMethods
     # EAN string identifier from identifiers
+    # @return [String]
     def ean
       if ean_identifier
         ean_identifier.value
@@ -90,6 +91,7 @@ module ONIX
 
   module IsbnMethods
     # ISBN-13 string identifier from identifiers
+    # @return [String]
     def isbn13
       if isbn13_identifier
         isbn13_identifier.value
@@ -106,6 +108,7 @@ module ONIX
 
   module GlnMethods
     # GLN string identifier from identifiers
+    # @return [String]
     def gln
       if gln_identifier
         if gln_identifier.value =~ /\d{13}/

data/lib/onix/onix_message.rb

@@ -89,6 +89,7 @@ module ONIX
     end
 
     # open with arg detection
+    # @param [String, File] arg
     def open(arg, force_encoding = nil)
       data = ONIX::Helper.arg_to_data(arg)
 
@@ -104,6 +105,7 @@ module ONIX
     end
 
     # release as an integer eg: 210, 300, 301
+    # @return [Number]
     def version
       if @release
         @release.gsub(/\./, "").to_i * 10 ** (3 - @release.scan(".").length - 1)
@@ -111,6 +113,7 @@ module ONIX
     end
 
     # detect ONIX version from XML tags
+    # @return [String]
     def detect_release(element)
       if element
         return "3.0" if element.search("//DescriptiveDetail").length > 0
@@ -144,6 +147,7 @@ module ONIX
     end
 
     # parse filename or file
+    # @param [String, File] arg
     def parse(arg, force_encoding = nil, force_release = nil)
       @products = []
       xml = open(arg, force_encoding)

data/lib/onix/price.rb

@@ -8,25 +8,33 @@ require 'onix/comparison_product_price'
 module ONIX
   class Price < SubsetDSL
     # elements "PriceIdentifier", :subset, :cardinality => 0..n
+
+
     element "PriceType", :subset, :shortcut => :type, :cardinality => 0..1
     element "PriceQualifier", :subset, :shortcut => :qualifier, :cardinality => 0..1
     elements "EpubTechnicalProtection", :subset, :cardinality => 0..n
+
     # elements "PriceConstraint", :subset, :cardinality => 0..n
+
+
     element "EpubLicense", :subset, :cardinality => 0..1
     element "PriceTypeDescription", :text, :cardinality => 0..n
+
     # element "PricePer", :subset, :cardinality => 0..1
     # elements "PriceCondition", :subset, :cardinality => 0..n
     # element "MinimumOrderQuantity", :integer, :cardinality => 0..1
     # elements "BatchBonus", :subset, :cardinality => 0..n
+
+
     elements "DiscountCoded", :subset, :cardinality => 0..n
     elements "Discount", :subset, :cardinality => 0..n
     element "PriceStatus", :subset
     element "PriceAmount", :float,
             {
-                :shortcut => :amount,
-                :parse_lambda => lambda { |v| (v * 100).round },
-                :serialize_lambda => lambda { |v| format("%.2f", v / 100.0) },
-                :cardinality => 0..1
+              :shortcut => :amount,
+              :parse_lambda => lambda { |v| (v * 100).round },
+              :serialize_lambda => lambda { |v| format("%.2f", v / 100.0) },
+              :cardinality => 0..1
             }
     element "Tax", :subset, :cardinality => 0..n
     element "TaxExempt", :bool, :cardinality => 0..1
@@ -39,6 +47,7 @@ module ONIX
     element "PositionOnProduct", :subset, :cardinality => 0..1
 
     # FIXME discount_coded != discount
+    # @return [DiscountCoded]
     def discount
       self.discount_codeds.first
     end

data/lib/onix/product.rb

@@ -29,10 +29,16 @@ module ONIX
     elements "RecordSourceIdentifier", :subset, :cardinality => 0..n
     element "RecordSourceName", :text, :cardinality => 0..1
     elements "ProductIdentifier", :subset, :shortcut => :identifiers, :cardinality => 0..n
+
     # elements "Barcode", :subset, :cardinality => 0..n
+
+
     element "DescriptiveDetail", :subset, :cardinality => 0..1
     element "CollateralDetail", :subset, :cardinality => 0..1
+
     # element "PromotionDetail", :subset, :cardinality => 0..1
+
+
     element "ContentDetail", :subset, :cardinality => 0..1
     element "PublishingDetail", :subset, :cardinality => 0..1
     element "RelatedMaterial", :subset, :cardinality => 0..1
@@ -99,19 +105,23 @@ module ONIX
     def_delegator :publishing_detail, :imprint
     def_delegator :publishing_detail, :publisher
 
+    # @return [CollateralDetail]
     def collateral_detail
       @collateral_detail || CollateralDetail.new
     end
 
+    # @return [DescriptiveDetail]
     def descriptive_detail
       @descriptive_detail || DescriptiveDetail.new
     end
 
+    # @return [PublishingDetail]
     def publishing_detail
       @publishing_detail || PublishingDetail.new
     end
 
     # product LanguageCode of text
+    # @return [String]
     def language_of_text
       @descriptive_detail.language_of_text || @default_language_of_text
     end

data/lib/onix/product_part.rb

@@ -9,7 +9,10 @@ module ONIX
     element "ProductForm", :subset, :shortcut => :form, :cardinality => 1
     elements "ProductFormDetail", :subset, :shortcut => :form_details, :cardinality => 0..n
     elements "ProductFormFeature", :subset, :cardinality => 0..n
+
     # element "ProductPackaging", :subset, :cardinality => 0..1
+
+
     elements "ProductFormDescription", :text, :shortcut => :file_description, :cardinality => 0..n
     elements "ProductContentType", :subset, :shortcut => :content_types, :cardinality => 0..n
     elements "Measure", :subset, :cardinality => 0..n
@@ -21,11 +24,13 @@ module ONIX
       @product_form_details.select { |fd| fd.code =~ /^E1.*/ }
     end
 
+    # @return [ProductFormDescription]
     def product_form_description
       product_form_descriptions.first
     end
 
     # full Product if referenced in ONIXMessage
+    # @return [Product]
     attr_accessor :product
 
     # this ProductPart is part of Product

data/lib/onix/product_supply.rb

@@ -41,6 +41,7 @@ module ONIX
       @supply_details.delete_if { |supply_detail| supply_detail.available? }
     end
 
+    # @return [Boolean]
     def available?
       self.available_supply_details.length > 0
     end

data/lib/onix/publishing_detail.rb

@@ -21,6 +21,7 @@ module ONIX
 
     # @!group High level
 
+    # @return [Publisher]
     def publisher
       main_publishers = @publishers.select { |p| p.role.human == "Publisher" }
       return nil if main_publishers.empty?
@@ -31,6 +32,7 @@ module ONIX
       end
     end
 
+    # @return [Imprint]
     def imprint
       if @imprints.length > 0
         if @imprints.length == 1
@@ -42,6 +44,7 @@ module ONIX
     end
 
     # date of publication
+    # @return [Date]
     def publication_date
       pub = @publishing_dates.publication.first
       if pub
@@ -50,6 +53,7 @@ module ONIX
     end
 
     # date of embargo
+    # @return [Date]
     def embargo_date
       pub = @publishing_dates.embargo.first
       if pub
@@ -57,6 +61,7 @@ module ONIX
       end
     end
 
+    # @return [Date]
     def preorder_embargo_date
       pub = @publishing_dates.preorder_embargo.first
       if pub
@@ -64,6 +69,7 @@ module ONIX
       end
     end
 
+    # @return [Date]
     def public_announcement_date
       pub = @publishing_dates.public_announcement.first
       if pub

data/lib/onix/related_material.rb

@@ -7,21 +7,25 @@ module ONIX
 
     # @!group High level
 
+    # @return [Array<RelatedProduct>]
     def linking(human)
       @related_products.select{|rp| rp.code.human==human}
     end
 
     # print products RelatedProduct array
+    # @return [Array<RelatedProduct>]
     def print_products
       linking("EpublicationBasedOnPrintProduct") + self.alternative_format_products.select{|rp| rp.form && rp.form.code=~/^B/}
     end
 
     # is part of products RelatedProduct array
+    # @return [Array<RelatedProduct>]
     def part_of_products
       linking("IsPartOf")
     end
 
     # alternative format products RelatedProduct array
+    # @return [Array<RelatedProduct>]
     def alternative_format_products
       linking("AlternativeFormat")
     end

data/lib/onix/related_product.rb

@@ -9,19 +9,23 @@ module ONIX
     elements "ProductFormDetail", :subset, :shortcut => :form_details, :cardinality => 0..n
 
     # full Product if referenced in ONIXMessage
+    # @return [Product]
     attr_accessor :product
 
+    # @return [ProductRelationCode]
     def code
       self.codes.first
     end
 
     # @!group High level
+    # @return [String]
     def file_format
       file_formats.first.human if file_formats.first
     end
 
     # @!endgroup
 
+    # @return [Array<ProductFormDetail>]
     def file_formats
       @product_form_details.select { |fd| fd.code =~ /^E1.*/ }
     end

data/lib/onix/related_work.rb

@@ -5,6 +5,7 @@ module ONIX
     elements "WorkIdentifier", :subset, :shortcut => :identifiers, :cardinality => 0..n
 
     # full Product if referenced in ONIXMessage
+    # @return [Product]
     attr_accessor :product
   end
 end

data/lib/onix/resource_version.rb

@@ -7,16 +7,19 @@ module ONIX
     elements "ResourceLink", :text, :shortcut => :links, :cardinality => 1..n
     elements "ContentDate", :subset, :cardinality => 0..n
 
+    # @return [String]
     def filename
       if @resource_form.human == "DownloadableFile"
         resource_links.first
       end
     end
 
+    # @return [ResourceVersionFeature]
     def file_format_feature
       @resource_version_features.select { |f| f.type.human == "FileFormat" }.first
     end
 
+    # @return [String]
     def file_format
       if ["DownloadableFile", "LinkableResource"].include?(@resource_form.human)
         if file_format_feature

data/lib/onix/sales_outlet.rb

@@ -3,10 +3,12 @@ module ONIX
     elements "SalesOutletIdentifier", :subset, :shortcut => :identifiers, :cardinality => 0..n
     element "SalesOutletName", :text, :shortcut => :name, :cardinality => 0..1
 
+    # @return [SalesOutletIdentifier]
     def sales_outlet_identifier
       self.sales_outlet_identifiers.first
     end
 
+    # @return [SalesOutletIdentifier]
     def identifier
       self.identifiers.first
     end

data/lib/onix/sales_restriction.rb

@@ -7,6 +7,7 @@ module ONIX
     element "StartDate", :date, :cardinality => 0..1
     element "EndDate", :date, :cardinality => 0..1
 
+    # @return [SalesRestrictionNote]
     def note
       self.notes.first
     end

data/lib/onix/subject.rb

@@ -7,6 +7,7 @@ module ONIX
     element "SubjectCode", :text, :shortcut => :code, :cardinality => 0..1
     elements "SubjectHeadingText", :text, :shortcut => :heading_texts, :cardinality => 0..n
 
+    # @return [String]
     def heading_text
       self.heading_texts.first
     end

data/lib/onix/subset.rb

@@ -26,8 +26,10 @@ module ONIX
   end
 
   module Attributes
+    # @return [Hash<String,Code>]
     attr_accessor :attributes
 
+    # @return [Hash<String,String>]
     def serialized_attributes
       if @attributes and @attributes.length > 0
         attrs = {}
@@ -38,6 +40,8 @@ module ONIX
       end
     end
 
+    # @param [String] attr
+    # @return [Class]
     def self.attribute_class(attr)
       case attr
       when "textcase"
@@ -68,6 +72,7 @@ module ONIX
     include Attributes
 
     # instanciate Subset form Nokogiri::XML::Element
+    # @param [Nokogiri::XML::Element] n
     def self.parse(n)
       o = self.new
       o.parse(n)
@@ -75,6 +80,7 @@ module ONIX
     end
 
     # parse Nokogiri::XML::Element
+    # @param [Nokogiri::XML::Element] n
     def parse(n) end
 
     def unsupported(tag)

data/lib/onix/supply_detail.rb

@@ -12,18 +12,26 @@ module ONIX
     element "ProductAvailability", :subset, :shortcut => :availability, :cardinality => 1
     elements "SupplyDate", :subset, :cardinality => 0..n
     element "OrderTime", :integer, :cardinality => 0..1
+
     # element "NewSupplier", :subset, :cardinality => 0..1
     # elements "Stock", :subset, :cardinality => 0..n
+
+
     element "PackQuantity", :integer, :cardinality => 0..1
     element "PalletQuantity", :integer, :cardinality => 0..1
     element "OrderQuantityMinimum", :integer, :cardinality => 0..1
+
     # element "OrderQuantityMinimum", :integer, :cardinality => 0..1
+
+
     element "OrderQuantityMultiple", :integer, :cardinality => 0..1
     element "UnpricedItemType", :subset, :cardinality => 0..1
     elements "Price", :subset, :cardinality => 0..n
+
     # element "Reissue", :subset, :cardinality => 0..1
 
     # @!group Shortcuts
+    # @return [Array<Supplier>]
     def distributors
       @suppliers.select { |s| s.role.human =~ /Distributor/ }.uniq
     end

data/lib/onix/supporting_resource.rb

@@ -17,10 +17,12 @@ module ONIX
     scope :image, lambda { human_code_match(:resource_mode, "Image") }
     scope :text, lambda { human_code_match(:resource_mode, "Text") }
 
+    # @return [ResourceFeature]
     def caption_feature
       self.features.caption.first
     end
 
+    # @return [String]
     def caption
       if self.caption_feature
         self.caption_feature.value

data/lib/onix/territory.rb

@@ -33,6 +33,7 @@ module ONIX
       self.class.worldwide?(self.countries)
     end
 
+    # @param [Array<String>] v
     def countries= v
       if (v.uniq & CountryCode.list).length == CountryCode.list.length
         @regions_included = "WORLD"
@@ -43,6 +44,8 @@ module ONIX
 
     # !@endgroup
 
+    # @param [String] region
+    # @return [Array<String>]
     def self.region_to_countries(region)
       case region
       when "WORLD"
@@ -55,6 +58,7 @@ module ONIX
       end
     end
 
+    # @return [Boolean]
     def self.worldwide?(countries)
       (countries & CountryCode.list).length == CountryCode.list.length
     end

data/lib/onix/title_detail.rb

@@ -10,6 +10,7 @@ module ONIX
 
     # :category: High level
     # flatten title string
+    # @return [String]
     def title
       return title_statement if title_statement
 

data/lib/onix/title_element.rb

@@ -15,6 +15,7 @@ module ONIX
 
     # @!group High level
     # flatten title string
+    # @return [String]
     def title
       if title_text
         title_text

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: im_onix
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Julien Boulnois
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler