iso-bib-item 0.1.11 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35146363462622bb4a40fd392cd10ee47b411bbfee238108da476e365944f263
-  data.tar.gz: a1ed4d24e83c8ace967b7c38d4a745b160497744f43e956a5644610641d0eda5
+  metadata.gz: 1fa989f9c13fbb68e055a71c3e69b85c1aaaa2659ab20065bd3b07ac24154e47
+  data.tar.gz: 953d20175ece7b483a185dbd48028f03f99dafd39fa0d7467e7feebe202c5aa6
 SHA512:
-  metadata.gz: b62d9e9c5aeab6ab50f62a2fd3f81b0e4d981034dd258cd05c15279be94afe4f410a99e1fbfd8fc028a7f596a4cf00e564d581b89c6ed0651244554e51d280e3
-  data.tar.gz: 69921f12e852458b2047f01825412e35228a4fcd9df581b30b6ec82d1bb4755f152bca5aedde1a3cbdfaa360eeed031bb0f6f52b18c95a4e0b507d077d5ef811
+  metadata.gz: ca6ac6fc0f254f5932c4c2a1704e628e7aeab626804def141c900d9d778b195683c261074ac2ecd3652fef5ea394f82f2476f8c2d866b6ddb6aa54cc807def9d
+  data.tar.gz: e984e55d216273d9b5db76e71135e33b02ea04e9cef07a5ac9651f0a326dc1646b0e6bcec4313f7bc59bd90deac41de5ea8053bda957266f4f93d8db6c65e47f

data/.travis.yml

@@ -1,5 +1,14 @@
 sudo: false
 language: ruby
+
 rvm:
-  - 2.4.0
+  - 2.5
+  - 2.4
+  - 2.3
+  - ruby-head
+
 before_install: gem install bundler -v 1.16.1
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/README.adoc

@@ -416,3 +416,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 == License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/lib/iso_bib_item/bibliographic_date.rb

@@ -23,9 +23,9 @@ module IsoBibItem
     def initialize(type:, on: nil, from: nil, to: nil)
       raise ArgumentError, 'expected :on or :form argument' unless on || from
       @type = type
-      @on   = Time.strptime(on, '%Y-%d') if on
-      @from = Time.strptime(from, '%Y-%d') if from
-      @to   = Time.strptime(to, '%Y-%d') if to
+      @on   = parse_date on
+      @from = parse_date from
+      @to   = parse_date to
     end
 
     # rubocop:disable Metric/AbcSize
@@ -43,5 +43,17 @@ module IsoBibItem
       end
     end
     # rubocop:enable Metric/AbcSize
+
+    private
+
+    # @params date [String] 'yyyy' or 'yyyy-mm'
+    def parse_date(date)
+      return unless date
+      if date =~ /\d{4}/
+        Time.strptime date, '%Y'
+      else
+        Time.strptime date, '%Y-%m'
+      end
+    end
   end
 end

data/lib/iso_bib_item/bibliographic_item.rb

@@ -59,7 +59,9 @@ module IsoBibItem
     # @param from [String] date
     # @param to [String] date
     def initialize(owner:, from:, to: nil)
-      @owner = ContributionInfo.new entity: Organization.new(owner)
+      @owner = if owner.is_a?(Hash)
+                 ContributionInfo.new entity: Organization.new(owner)
+               else owner end
       @from  = Time.strptime(from, '%Y') unless from.empty?
       @to    = Time.parse(to) if to
     end
@@ -169,18 +171,21 @@ module IsoBibItem
         d.is_a?(Hash) ? BibliographicDate.new(d) : d
       end
       @contributors = (args[:contributors] || []).map do |c|
-        e = c[:entity].is_a?(Hash) ? Organization.new(c[:entity]) : c[:entity]
-        ContributionInfo.new(entity: e, role: c[:roles])
+        if c.is_a? Hash
+          e = c[:entity].is_a?(Hash) ? Organization.new(c[:entity]) : c[:entity]
+          ContributionInfo.new(entity: e, role: c[:roles])
+        else c
+        end
       end
       @notes         = []
       @language      = args[:language]
       @script        = args[:script]
       @status        = args[:docstatus]
       @abstract      = (args[:abstract] || []).map do |a|
-        FormattedString.new(a)
+        a.is_a?(Hash) ? FormattedString.new(a) : a
       end
       @relations = DocRelationCollection.new(args[:relations] || [])
-      @link = args[:link].map { |s| TypedUri.new(s) }
+      @link = args[:link].map { |s| s.is_a?(Hash) ? TypedUri.new(s) : s }
       @series = args[:series]
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize

data/lib/iso_bib_item/document_relation_collection.rb

@@ -67,7 +67,7 @@ module IsoBibItem
 
     # @param type [String]
     # @param identifier [String]
-    def initialize(type:, identifier:, url:, bib_locality: [], bibitem: nil)
+    def initialize(type:, identifier:, url: nil, bib_locality: [], bibitem: nil)
       type = "obsoletes" if type == "Now withdrawn"
       @type         = type
       @identifier   = identifier
@@ -76,12 +76,13 @@ module IsoBibItem
       @bibitem      = bibitem
     end
 
+    # @param builder [Nokogiri::XML::Builder]
     def to_xml(builder)
       builder.relation(type: type) do
         if @bibitem.nil? 
           builder.bibitem do
             builder.formattedref identifier
-            builder.docidentifier identifier
+            # builder.docidentifier identifier
           end
         else
           @bibitem.to_xml(builder, {})
@@ -95,7 +96,7 @@ module IsoBibItem
   class DocRelationCollection < Array
     # @param [Array<Hash{type=>String, identifier=>String}>]
     def initialize(relations)
-      super relations.map { |r| DocumentRelation.new(r) }
+      super relations.map { |r| r.is_a?(Hash) ? DocumentRelation.new(r) : r }
     end
 
     # @return [Array<IsoBibItem::DocumentRelation>]

data/lib/iso_bib_item/from_xml.rb

@@ -1,27 +1,142 @@
 require 'nokogiri'
+
 module IsoBibItem
   class << self
-    def from_xml(doc)
-      xml = Nokogiri::XML(doc)
-      IsoBibliographicItem.new(
-=begin
+    def from_xml(xml)
+      doc = Nokogiri::XML(xml)
+      IsoBibliographicItem.new( 
         docid:        fetch_docid(doc),
-        edition:      edition,
-        language:     langs(doc).map { |l| l[:lang] },
-        script:       langs(doc).map { |l| script(l[:lang]) }.uniq,
-        titles:       titles,
-        type:         fetch_type(hit_data['title']),
-        docstatus:    fetch_status(doc, hit_data['status']),
+        edition:      doc.at('/bibitem/edition')&.text,
+        language:     doc.xpath('/bibitem/language').map(&:text),
+        script:       doc.xpath('/bibitem/script').map(&:text),
+        titles:       fetch_titles(doc),
+        type:         doc.at('bibitem')&.attr(:type),
+        docstatus:    fetch_status(doc),
         ics:          fetch_ics(doc),
         dates:        fetch_dates(doc),
-        contributors: fetch_contributors(hit_data['title']),
+        contributors: fetch_contributors(doc),
         workgroup:    fetch_workgroup(doc),
-        abstract:     abstract,
-        copyright:    fetch_copyright(hit_data['title'], doc),
-        link:       fetch_link(doc, url),
+        abstract:     fetch_abstract(doc),
+        copyright:    fetch_copyright(doc),
+        link:         fetch_link(doc),
         relations:    fetch_relations(doc)
-=end
-      )
+  )
+    end
+
+    private
+
+    def fetch_docid(doc)
+      did = doc.at('/bibitem/docidentifier')
+      return unless did
+      id = did.text.match(/(?<project>\d+)(?<hyphen>-)?(?(<hyphen>)(?<part>\d*))/)
+      IsoBibItem::IsoDocumentId.new project_number: id[:project],
+                                    part_number:    id[:part]
+    end
+
+    def fetch_titles(doc)
+      doc.xpath('/bibitem/title').map do |t|
+        titl = t.text.split ' -- '
+        case titl.size
+        when 0
+          intro, main, part = nil, "", nil
+        when 1
+          intro, main, part = nil, titl[0], nil
+        when 2
+          if /^(Part|Partie) \d+:/.match? titles[1]
+            intro, main, part = nil, titl[0], titles[1]
+          else
+            intro, main, part = titl[0], titl[1], nil
+          end
+        when 3
+          intro, main, part = titl[0], titl[1], titl[2]
+        else
+          intro, main, part = titl[0], titl[1], titl[2..-1]&.join(" -- ")
+        end
+        IsoLocalizedTitle.new(title_intro: intro, title_main: main,
+                              title_part: part, language: t[:language],
+                              script: t[:script])
+      end
+    end
+
+    def fetch_status(doc)
+      status    = doc.at('/bibitem/status')
+      stage     = status&.at('stage')&.text
+      substage  = status&.at('substage')&.text
+      iteration = status&.at('iterarion')&.text&.to_i
+      IsoDocumentStatus.new(status: status&.text, stage: stage,
+                            substage: substage, iteration: iteration)
+    end
+
+    def fetch_ics(doc)
+      doc.xpath('/bibitem/ics/code').map { |ics| Ics.new ics.text }
+    end
+
+    def fetch_dates(doc)
+      doc.xpath('/bibitem/date').map do |d|
+        BibliographicDate.new(type: d[:type], on: d.at('on')&.text,
+                              from: d.at('from')&.text,
+                              to: d.at('to')&.text)
+      end
+    end
+
+    def fetch_contributors(doc)
+      doc.xpath('/bibitem/contributor').map do |c|
+        o = c.at 'organization'
+        org = Organization.new(name: o.at('name')&.text,
+                               abbreviation: o.at('abbreviation')&.text,
+                               url: o.at('uri')&.text)
+        ContributionInfo.new entity: org, role: [c.at('role')[:type]]
+      end
+    end
+
+    # @TODO Organization doesn't recreated
+    def fetch_workgroup(doc)
+      eg = doc.at('/bibitem/editorialgroup')
+      tc = eg.at('technical_committee')
+      sc = eg.at('subcommittee')
+      scom = sc && iso_subgroup(cs)
+      wg   = eg.at('workgroup')
+      wgrp = wg && iso_subgroup(wg)
+      IsoProjectGroup.new(technical_committee: iso_subgroup(tc),
+                          subcommittee: scom, workgroup: wgrp)
+    end
+
+    def iso_subgroup(com)
+      IsoSubgroup.new(name: com.text, type: com[:type],
+                      number: com[:number].to_i)
+    end
+
+    def fetch_abstract(doc)
+      doc.xpath('/bibitem/abstract').map do |a|
+        FormattedString.new(content: a.text, language: a[:language],
+                            script: a[:script], type: a[:format])
+      end
+    end
+
+    def fetch_copyright(doc)
+      cp     = doc.at('/bibitem/copyright')
+      org    = cp.at('owner/organization')
+      name   = org.at('name').text
+      abbr   = org.at('abbreviation').text
+      url    = org.at('uri')&.text
+      entity = Organization.new(name: name, abbreviation: abbr, url: url)
+      from   = cp.at('from').text
+      to     = cp.at('to')&.text
+      owner  = ContributionInfo.new entity: entity
+      CopyrightAssociation.new(owner: owner, from: from, to: to)
+    end
+
+    def fetch_link(doc)
+      doc.xpath('/bibitem/uri').map do |l|
+        TypedUri.new type: l[:type], content: l.text
+      end
+    end
+
+    def fetch_relations(doc)
+      doc.xpath('/bibitem/relation').map do |r|
+        DocumentRelation.new(type: r[:type],
+                             identifier: r.at('bibitem/formattedref').text)
+      end
     end
   end
 end

data/lib/iso_bib_item/iso_bibliographic_item.rb

@@ -58,7 +58,12 @@ module IsoBibItem
     # @param field [Integer]
     # @param group [Integer]
     # @param subgroup [Integer]
-    def initialize(field:, group:, subgroup:)
+    def initialize(code = nil, field: nil, group: nil, subgroup: nil)
+      unless code || field
+        raise ArgumentError, "wrong arguments (should be string or { fieldcode: [String] }"
+      end
+
+      field, group, subgroup = code.split '.' if code
       super fieldcode: field, groupcode: group, subgroupcode: subgroup
     end
 
@@ -70,6 +75,8 @@ module IsoBibItem
     end
   end
 
+  # rubocop:disable Metrics/ClassLength
+
   # Bibliographic item.
   class IsoBibliographicItem < BibliographicItem
     # @return [IsoBibItem::IsoDocumentId]
@@ -93,9 +100,8 @@ module IsoBibItem
     # @return [Array<IsoBibItem::Ics>]
     attr_reader :ics
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-
-    # @param docid [Hash{project_number=>Integer, part_number=>Integer}]
+    # @param docid [Hash{project_number=>Integer, part_number=>Integer},
+    #   IsoBibItem::IsoDocumentId]
     # @param titles [Array<Hash{title_intro=>String, title_main=>String,
     #   title_part=>String, language=>String, script=>String}>]
     # @param edition [String]
@@ -114,7 +120,7 @@ module IsoBibItem
     #   abbreviation=>String}, roles=>Array<String>}>]
     # @param copyright [Hash{owner=>Hash{name=>String, abbreviation=>String,
     #   url=>String}, form=>String, to=>String}]
-    # @param link [Array<Hash{type=>String, content=>String}>]
+    # @param link [Array<Hash{type=>String, content=>String}, IsoBibItem::TypedUri>]
     # @param relations [Array<Hash{type=>String, identifier=>String}>]
     def initialize(**args)
       super_args = args.select do |k|
@@ -123,24 +129,36 @@ module IsoBibItem
         ].include? k
       end
       super(super_args)
-      @docidentifier = IsoDocumentId.new args[:docid]
-      @edition       = args[:edition]
-      @title         = args[:titles].map { |t| IsoLocalizedTitle.new(t) }
-      @type          = args[:type]
-      @status        = IsoDocumentStatus.new(args[:docstatus])
-      @workgroup     = IsoProjectGroup.new(args[:workgroup]) if args[:workgroup]
-      @ics = args[:ics].map { |i| Ics.new(i) }
-      @copyright = CopyrightAssociation.new args[:copyright] if args[:copyright]
-      @link = args[:link].map { |s| TypedUri.new(s) }
+      @docidentifier = if args[:docid].is_a?(Hash)
+                         IsoDocumentId.new(args[:docid])
+                       else args[:docid] end
+      @edition = args[:edition]
+      @title   = args[:titles].map do |t|
+        t.is_a?(Hash) ? IsoLocalizedTitle.new(t) : t
+      end
+      @type   = args[:type]
+      @status = if args[:docstatus].is_a?(Hash)
+                  IsoDocumentStatus.new(args[:docstatus])
+                else args[:docstatus] end
+      if args[:workgroup]
+        @workgroup = if args[:workgroup].is_a?(Hash)
+                       IsoProjectGroup.new(args[:workgroup])
+                     else args[:workgroup] end
+      end
+      @ics = args[:ics].map { |i| i.is_a?(Hash) ? Ics.new(i) : i }
+      if args[:copyright]
+        @copyright = if args[:copyright].is_a?(Hash)
+                       CopyrightAssociation.new args[:copyright]
+                     else args[:copyright] end
+      end
+      @link = args[:link].map { |s| s.is_a?(Hash) ? TypedUri.new(s) : s }
       @id_attribute = true
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-    
+
     def disable_id_attribute
       @id_attribute = false
     end
-  
-    # convert ISO nnn-1 reference into an All Parts reference: 
+
     # remove title part components and abstract  
     def to_all_parts
       #me = Duplicate.duplicate(self)
@@ -208,6 +226,7 @@ module IsoBibItem
 
     private
 
+    # @return [Array<IsoBibItem::ContributionInfo>]
     def publishers
       @contributors.select do |c|
         c.role.select { |r| r.type == 'publisher' }.any?
@@ -251,6 +270,7 @@ module IsoBibItem
         status.to_xml builder
         copyright&.to_xml builder
         relations.each { |r| r.to_xml builder }
+        workgroup.to_xml builder
         if opts[:note]
           builder.note("ISO DATE: #{opts[:note]}", format: 'text/plain')
         end
@@ -260,4 +280,5 @@ module IsoBibItem
       end
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/iso_bib_item/iso_document_status.rb

@@ -4,43 +4,62 @@ require 'iso_bib_item/document_status'
 require 'iso_bib_item/localized_string'
 
 module IsoBibItem
-  module IsoDocumentStageCodes
-    PREELIMINARY = '00'
-    PROPOSAL     = '10'
-    PREPARATORY  = '20'
-    COMMITTE     = '30'
-    ENQUIRY      = '40'
-    APPROVAL     = '50'
-    PUBLICATION  = '60'
-    REVIEW       = '90'
-    WITHDRAWAL   = '95'
-  end
+  # module IsoDocumentStageCodes
+  #   PREELIMINARY = '00'
+  #   PROPOSAL     = '10'
+  #   PREPARATORY  = '20'
+  #   COMMITTE     = '30'
+  #   ENQUIRY      = '40'
+  #   APPROVAL     = '50'
+  #   PUBLICATION  = '60'
+  #   REVIEW       = '90'
+  #   WITHDRAWAL   = '95'
+  # end
 
-  module IsoDocumentSubstageCodes
-    REGISTRATION              = '00'
-    START_OF_MAIN_ACTION      = '20'
-    COMPLETION_OF_MAIN_ACTION = '60'
-    REPEAT_AN_EARLIER_PHASE   = '92'
-    REPEAT_CURRENT_PHASE      = '92'
-    ABADON                    = '98'
-    PROCEED                   = '99'
-  end
+  # module IsoDocumentSubstageCodes
+  #   REGISTRATION              = '00'
+  #   START_OF_MAIN_ACTION      = '20'
+  #   COMPLETION_OF_MAIN_ACTION = '60'
+  #   REPEAT_AN_EARLIER_PHASE   = '92'
+  #   REPEAT_CURRENT_PHASE      = '92'
+  #   ABADON                    = '98'
+  #   PROCEED                   = '99'
+  # end
 
   # ISO Document status.
   class IsoDocumentStatus < DocumentStatus
-    # @return [IsoDocumentStageCodes]
-    attr_accessor :stage
+    # @return [String, NilClass]
+    attr_reader :stage
+
+    # @return [String, NilClass]
+    attr_reader :substage
 
-    # @return [IsoDocumentSubstageCodes]
-    attr_accessor :substage
+    # @return [Integer, NilClass]
+    attr_reader :iteration
 
-    # @param status [String]
-    # @param stage [IsoDocumentStageCodes]
-    # @param substage [IsoDocumentSubstageCodes]
-    def initialize(status:, stage:, substage:)
+    # @param status [String, NilClass]
+    # @param stage [String, NilClass]
+    # @param substage [String, NilClass]
+    # @param iteration [Integer, NilClass]
+    def initialize(status: nil, stage: nil, substage: nil, iteration: nil)
+      raise ArgumentError, 'status or stage is required' unless status || stage
       super LocalizedString.new(status)
-      @stage    = stage
-      @substage = substage
+      @stage     = stage
+      @substage  = substage
+      @iteration = iteration
+    end
+
+    # @param builder [Nkogiri::XML::Builder]
+    def to_xml(builder)
+      if stage
+        builder.status do
+          builder.stage stage
+          builder.substage substage if substage
+          builder.iteration iteration if iteration
+        end
+      else
+        super
+      end
     end
   end
 end

data/lib/iso_bib_item/iso_project_group.rb

@@ -4,14 +4,14 @@ require 'iso_bib_item/organization'
 
 module IsoBibItem
   # ISO project group.
-  class IsoProjectGroup < Organization
+  class IsoProjectGroup
     # @return [IsoBibItem::IsoSubgroup]
     attr_reader :technical_committee
 
-    # @return [IsoBibItem::soSubgroup]
+    # @return [IsoBibItem::IsoSubgroup]
     attr_reader :subcommittee
 
-    # @return [IsoBibItem::soSubgroup]
+    # @return [IsoBibItem::IsoSubgroup]
     attr_reader :workgroup
 
     # @return [String]
@@ -21,10 +21,30 @@ module IsoBibItem
     # @param url [String]
     # @param technical_commite [Hash{name=>String, type=>String,
     #   number=>Integer}]
-    def initialize(name:, abbreviation: nil, url:, technical_committee:)
-      super name: name, abbreviation: abbreviation, url: url
-      @technical_committe = IsoSubgroup.new(technical_committee)
+    # @param subcommittee [IsoBibItem::IsoSubgroup]
+    # @param workgroup [IsoBibItem::IsoSubgroup]
+    # @param secretariat [String]
+    def initialize(technical_committee:, **args)
+      @technical_committee = if technical_committee.is_a? Hash
+                               IsoSubgroup.new(technical_committee)
+                             else technical_committee end
+      @subcommittee        = args[:subcommittee]
+      @workgroup           = args[:workgroup]
+      @secretariat         = args[:secretariat]
     end
+
+    # rubocop:disable Metrics/AbcSize
+
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.editorialgroup do
+        builder.technical_committee { technical_committee.to_xml builder }
+        builder.subcommittee { subcommittee.to_xml builder } if subcommittee
+        builder.workgroup { workgroup.to_xml builder } if workgroup
+        builder.secretariat secretariat if secretariat
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
   end
 
   # ISO subgroup.
@@ -41,10 +61,17 @@ module IsoBibItem
     # @param name [String]
     # @param type [String]
     # @param number [Integer]
-    def initialize(name:, type:, number:)
+    def initialize(name:, type: nil, number: nil)
       @name   = name
       @type   = type
       @number = number
     end
+
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.parent[:number] = number if number
+      builder.parent[:type] = type if type
+      builder.text name
+    end
   end
 end

data/lib/iso_bib_item/organization.rb

@@ -42,6 +42,7 @@ module IsoBibItem
     # @param name [String]
     # @param abbreviation [String]
     # @param url [String]
+    # @TODO identifier
     def initialize(name:, abbreviation: nil, url: nil)
       super(url: url)
       @name         = LocalizedString.new name
@@ -49,7 +50,7 @@ module IsoBibItem
       @identifiers  = []
     end
 
-    # @return [String]
+    # @param builder [Nokogiri::XML::Builder]
     def to_xml(builder)
       builder.organization do
         builder.name { |b| name.to_xml b }

data/lib/iso_bib_item/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: false
 
 module IsoBibItem
-  VERSION = '0.1.11'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iso-bib-item
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-10 00:00:00.000000000 Z
+date: 2018-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler