iso-bib-item 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ac47530f7bb6fa50858b2b0b013864059215c1766a86fcb9691ed2065ed7f0f
-  data.tar.gz: c93b38d67f60d01897b4a8393009f62b2c18fe3aa53d3aa464a8b37ec1b2aa8c
+  metadata.gz: c1a1bd9ee86b20e2f62362a7d3a32a3d652d37a940faf0b84a72a0a33154f7f0
+  data.tar.gz: 3b4368c16c6d0339a4fb248a4b625adf4a4480f4a0d9b2d127f4e097e9a9259e
 SHA512:
-  metadata.gz: ae4298fbec9d77cde74109953eba1f7208234eb507cd2ca1f1383965386553513b498961cf6d57d2632537507b67ccd0bade9bb0127e71044f8f595c2c9b6170
-  data.tar.gz: 7734059bb6fc9e4caed7108fca5a2ff6caa60f7c525278c6c4286f5c8f05d36e5c95d42f8e9510680f524497885e5c9c6702735c75b55ba3cad3ff9a942693fd
+  metadata.gz: bf24100c5bb263e037001e48cce1d93a5125b794f92738ee3c1b6dfb4422cd3af042dd5d6cf2982c222cc8384ff9547cc06dc5fe78748117905cb3be72940501
+  data.tar.gz: 78f2b6faa51d28559b2043bde2e64c47f92487e9b2d1f486218b73258bf0541a844ac82d382e7a6aac725b13502e1fd478de6459bbcf2d5f7edc61a2c6a64cf8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    iso-bib-item (0.3.0)
+    iso-bib-item (0.4.0)
       isoics (~> 0.1.6)
       nokogiri (~> 1.8.4)
       ruby_deep_clone (~> 0.8.0)
@@ -19,7 +19,7 @@ GEM
     json (2.1.0)
     method_source (0.9.0)
     mini_portile2 (2.3.0)
-    nokogiri (1.8.4)
+    nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
@@ -34,7 +34,7 @@ GEM
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)
@@ -61,4 +61,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   1.16.2
+   1.16.6

data/lib/iso_bib_item/bibliographic_item.rb

@@ -133,7 +133,7 @@ module IsoBibItem
     attr_reader :formatted_ref
 
     # @!attribute [r] abstract
-    #   @return [Arra<IsoBibItem::FormattedString>]
+    #   @return [Array<IsoBibItem::FormattedString>]
 
     # @return [IsoBibItem::DocumentStatus]
     attr_reader :status
@@ -147,6 +147,9 @@ module IsoBibItem
     # @return [Array<IsoBibItem::Series>]
     attr_reader :series
 
+    # @return [Date]
+    attr_reader :fetched
+
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
@@ -163,6 +166,7 @@ module IsoBibItem
     #   script=>String, type=>String}>]
     # @param relations [Array<Hash{type=>String, identifier=>String}>]
     # @param series [Array<IsoBibItem::Series>]
+    # @param fetched [Date] default today
     def initialize(**args)
       @id            = args[:id]
       @title         = (args[:titles] || []).map { |t| FormattedString.new t }
@@ -187,6 +191,7 @@ module IsoBibItem
       @relations = DocRelationCollection.new(args[:relations] || [])
       @link = args[:link].map { |s| s.is_a?(Hash) ? TypedUri.new(s) : s }
       @series = args[:series]
+      @fetched = args.fetch :fetched, Date.today
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
     # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
@@ -207,6 +212,7 @@ module IsoBibItem
     def to_xml
       Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
         xml.bibitem(id: id) do
+          xml.fetched fetched
           title.each { |t| xml.title { t.to_xml xml } }
           link.each { |s| s.to_xml xml }
           docidentifier.each { |di| di.to_xml xml }

data/lib/iso_bib_item/iso_bibliographic_item.rb

@@ -8,7 +8,7 @@ require 'iso_bib_item/iso_document_status'
 require 'iso_bib_item/iso_localized_title'
 require 'iso_bib_item/iso_project_group'
 require 'iso_bib_item/document_relation_collection'
-require 'iso_bib_item/from_xml'
+require 'iso_bib_item/xml_parser'
 
 # Add filter method to Array.
 class Array
@@ -23,13 +23,13 @@ module IsoBibItem
     # @return [Integer]
     attr_reader :tc_document_number
 
-    # @return [Integer]
+    # @return [String]
     attr_reader :project_number
 
-    # @return [Integer]
+    # @return [String]
     attr_reader :part_number
 
-    # @return [Integer]
+    # @return [String]
     attr_reader :subpart_number
 
     # @return [String]
@@ -41,19 +41,19 @@ module IsoBibItem
     # @return [String]
     attr_reader :type
 
-    # @param project_number [Integer]
-    # @param part_number [Integer]
-    # @param subpart_number [Integer]
+    # @param project_number [String]
+    # @param part_number [String]
+    # @param subpart_number [String]
     # @param prefix [String]
     # @param id [String]
     # @param type [String]
-    def initialize(project_number:, part_number:, subpart_number: nil, prefix:, id:, type: nil)
-      @project_number = project_number
-      @part_number    = part_number
-      @subpart_number = subpart_number
-      @prefix         = prefix
-      @type           = type
-      @id             = id
+    def initialize(**args)
+      @project_number = args[:project_number]
+      @part_number    = args[:part_number]
+      @subpart_number = args[:subpart_number]
+      @prefix         = args[:prefix]
+      @type           = args[:type]
+      @id             = args[:id]
     end
 
     # in docid manipulations, assume ISO as the default: id-part:year

data/lib/iso_bib_item/version.rb

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

data/lib/iso_bib_item/xml_parser.rb

@@ -0,0 +1,196 @@
+require 'nokogiri'
+
+module IsoBibItem
+  class XMLParser
+    class << self
+      def from_xml(xml)
+        doc = Nokogiri::XML(xml)
+        IsoBibliographicItem.new( 
+          docid:        fetch_docid(doc),
+          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(doc),
+          workgroup:    fetch_workgroup(doc),
+          abstract:     fetch_abstract(doc),
+          copyright:    fetch_copyright(doc),
+          link:         fetch_link(doc),
+          relations:    fetch_relations(doc)
+        )
+      end
+
+      private
+
+      def get_id(did)
+        did.text.match(/^(?<project>.*?\d+)(?<hyphen>-)?(?(<hyphen>)(?<part>\d*))/)
+      end
+
+      def fetch_docid(doc)
+        ret = []
+        doc.xpath("/bibitem/docidentifier").each do |did|
+          #did = doc.at('/bibitem/docidentifier')
+          type = did.at("./@type")
+          if did.text == "IEV" then ret << IsoBibItem::IsoDocumentId.new(project_number: "IEV", part_number: nil, prefix: nil)
+          else
+            id = get_id did
+            ret << IsoBibItem::IsoDocumentId.new(project_number: id.nil? ? did.text : id[:project],
+                                                 part_number:    id.nil? ? nil : id[:part],
+                                                 prefix:         nil,
+                                                 id:             did.text,
+                                                 type:           type&.text)
+          end
+        end
+        ret
+      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? titl[1]
+              intro, main, part = nil, titl[0], titl[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 get_org(org)
+        names = org.xpath('name').map do |n|
+          { content: n.text, language: n[:language], script: n[:script] }
+        end
+        IsoBibItem::Organization.new(name: names,
+                                     abbreviation: org.at('abbreviation')&.text,
+                                     url: org.at('uri')&.text)
+      end
+
+      def get_person(person)
+        name = person.at './name/completename'
+        affilations = person.xpath('./affiliation').map do |a|
+          org = a.at './organization'
+          IsoBibItem::Affilation.new get_org(org)
+        end
+        contacts = person.xpath('./contact').map do |c|
+          if (addr = c.at './address')
+            streets = addr.xpath('./street').map(&:text)
+            IsoBibItem::Address.new(
+              street: streets,
+              city: addr.at('./city').text,
+              state: addr.at('./state').text,
+              country: addr.at('./country').text,
+              postcode: addr.at('./postcode').text
+            )
+          else
+            contact = c.child
+            IsoBibItem::Contact.new(type: contact[:name], value: contact.text)
+          end
+        end
+        completename = IsoBibItem::LocalizedString.new(name.text, name[:language])
+        IsoBibItem::Person.new(
+          name: IsoBibItem::FullName.new(completename: completename),
+          affiliation: affilations,
+          contacts: contacts
+        )
+      end
+
+      def fetch_contributors(doc)
+        doc.xpath('/bibitem/contributor').map do |c|
+          entity = if (org = c.at './organization') then get_org(org)
+                   elsif (person = c.at './person') then get_person(person)
+                   end
+          IsoBibItem::ContributionInfo.new entity: entity, 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 = iso_subgroup(sc)
+        wg   = eg&.at('workgroup')
+        wgrp = iso_subgroup(wg)
+        IsoProjectGroup.new(technical_committee: iso_subgroup(tc),
+                            subcommittee: scom, workgroup: wgrp)
+      end
+
+      def iso_subgroup(com)
+        return nil if com.nil?
+        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') || return
+        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
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iso-bib-item
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-19 00:00:00.000000000 Z
+date: 2018-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -163,7 +163,6 @@ files:
 - lib/iso_bib_item/document_relation_collection.rb
 - lib/iso_bib_item/document_status.rb
 - lib/iso_bib_item/formatted_string.rb
-- lib/iso_bib_item/from_xml.rb
 - lib/iso_bib_item/iso_bibliographic_item.rb
 - lib/iso_bib_item/iso_document_status.rb
 - lib/iso_bib_item/iso_localized_title.rb
@@ -173,6 +172,7 @@ files:
 - lib/iso_bib_item/person.rb
 - lib/iso_bib_item/series.rb
 - lib/iso_bib_item/version.rb
+- lib/iso_bib_item/xml_parser.rb
 homepage: https://github.com/riboseinc/gdbib
 licenses:
 - BSD-2-Clause

data/lib/iso_bib_item/from_xml.rb

@@ -1,154 +0,0 @@
-require 'nokogiri'
-
-module IsoBibItem
-  class << self
-    def from_xml(xml)
-      doc = Nokogiri::XML(xml)
-      IsoBibliographicItem.new( 
-        docid:        fetch_docid(doc),
-        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(doc),
-        workgroup:    fetch_workgroup(doc),
-        abstract:     fetch_abstract(doc),
-        copyright:    fetch_copyright(doc),
-        link:         fetch_link(doc),
-        relations:    fetch_relations(doc)
-  )
-    end
-
-    private
-
-    def fetch_docid(doc)
-      ret = []
-      doc.xpath("/bibitem/docidentifier").each do |did|
-        #did = doc.at('/bibitem/docidentifier')
-        type = did.at("./@type")
-        if did.text == "IEV" then ret << IsoBibItem::IsoDocumentId.new(project_number: "IEV", part_number: nil, prefix: nil)
-        else
-          id = did.text.match(/^(?<project>.*\d+)(?<hyphen>-)?(?(<hyphen>)(?<part>\d*))(-(?<subpart>\d+))?$/)
-          ret << IsoBibItem::IsoDocumentId.new(project_number: id.nil? ? did.text : id[:project],
-                                               part_number:    id.nil? ? nil : id[:part],
-                                               subpart_number:    id.nil? ? nil : id[:subpart],
-                                               prefix:         nil,
-                                               id:             did.text,
-                                               type:           type&.text)
-        end
-      end
-      ret
-    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? titl[1]
-            intro, main, part = nil, titl[0], titl[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 = iso_subgroup(sc)
-      wg   = eg&.at('workgroup')
-      wgrp = iso_subgroup(wg)
-      IsoProjectGroup.new(technical_committee: iso_subgroup(tc),
-                          subcommittee: scom, workgroup: wgrp)
-    end
-
-    def iso_subgroup(com)
-      return nil if com.nil?
-      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') || return
-      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