iso-bib-item 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 186fc45016ad7f72189281554e2fe4a195145ad7765e8718565a4b8fe4d70dfb
-  data.tar.gz: 1416aee5aa32dd0fc815f0055e30c3cccb6690744fa212dfe6bc2587e797adc0
+SHA1:
+  metadata.gz: 28b47902774baa20582877c3f4bb40b511858665
+  data.tar.gz: 0b91cba1d8b30a5b725ef4cb5c6945ac17fdc197
 SHA512:
-  metadata.gz: 186f877bb88a117b1e1cca056c00cdd4bddfd3727e2de81a461d228298306e962b9b726fd16699c9a7c02a2bd42841a2330ce382c78088dec16b7a80747cd5df
-  data.tar.gz: 6be1a5e689c6039f93e394449430d0eb678adc295c45488c25df87278f22e5e62fa753481d80b0cea29926d0a8139b6c33ad05e2274a9d2f10afe979f3ac0518
+  metadata.gz: 9fe3106f7ce849ad2f8687abb31c936ab782e9cb143c8a6cd94a0e276ace015fd9289bce6fb1426537dcd5aa9d0c2998c58087d7888252cbdcef23ca52e04bc4
+  data.tar.gz: 7a8de9331fa305198f6f63c04a93f913d34a276687dd9ff164d7575ef1648ce5900bd594d3b879d26fc6d198ec5abec633870eb3fa1b378471e4d57ebd9f087e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    iso-bib-item (0.1.6)
+    iso-bib-item (0.1.7)
       duplicate
       isoics (~> 0.1.6)
       nokogiri

data/lib/iso_bib_item.rb

@@ -2,8 +2,3 @@
 
 require 'iso_bib_item/version'
 require 'iso_bib_item/iso_bibliographic_item'
-
-# ISO bibliographic model.
-# module IsoBibItem
-#   # Your code goes here...
-# end

data/lib/iso_bib_item/bibliographic_date.rb

@@ -28,6 +28,10 @@ module IsoBibItem
       @to   = Time.strptime(to, '%Y-%d') if to
     end
 
+    # rubocop:disable Metric/AbcSize
+
+    # @param builder [Nokogiri::XML::Builder]
+    # @return [Nokogiri::XML::Builder]
     def to_xml(builder, **opts)
       builder.date(type: type) do
         if on
@@ -38,5 +42,6 @@ module IsoBibItem
         end
       end
     end
+    # rubocop:enable Metric/AbcSize
   end
 end

data/lib/iso_bib_item/bibliographic_item.rb

@@ -83,6 +83,9 @@ module IsoBibItem
 
   # Bibliographic item
   class BibliographicItem
+    # @return [String]
+    attr_reader :id
+
     # @return [Array<IsoBibItem::FormattedString>]
     attr_reader :title
 
@@ -128,6 +131,11 @@ module IsoBibItem
     # @return [IsoBibItem::DocRelationCollection]
     attr_reader :relations
 
+    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    # @param id [Arrat<IsoBibItem::DocumentIdentifier>]
+    # @param title [Array<IsoBibItem::FormattedString>]
     # @param language [Arra<String>]
     # @param script [Array<String>]
     # @param dates [Array<Hash{type=>String, from=>String, to=>String}>]
@@ -136,14 +144,16 @@ module IsoBibItem
     # @param abstract [Array<Hash{content=>String, language=>String,
     #   script=>String, type=>String}>]
     # @param relations [Array<Hash{type=>String, identifier=>String}>]
-    # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def initialize(**args)
-      @title         = []
+      @id            = args[:id]
+      @title         = (args[:titles] || []).map { |t| FormattedString.new t }
       @docidentifier = []
-      @dates         = (args[:dates] || []).map { |d| BibliographicDate.new(d) }
-      @contributors  = (args[:contributors] || []).map do |c|
-        ContributionInfo.new(entity: Organization.new(c[:entity]),
-                             role:   c[:roles])
+      @dates         = (args[:dates] || []).map do |d|
+        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])
       end
       @notes         = []
       @language      = args[:language]
@@ -152,13 +162,10 @@ module IsoBibItem
         FormattedString.new(a)
       end
       @relations = DocRelationCollection.new(args[:relations] || [])
+      @source = args[:source].map { |s| TypedUri.new(s) }
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
-
-    # @param docid [DocumentIdentifier]
-    # def add_docidentifier(docid)
-    #   @docidentifier << docid
-    # end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     # @param lang [String] language code Iso639
     # @return [IsoBibItem::FormattedString, Array<IsoBibItem::FormattedString>]
@@ -169,5 +176,23 @@ module IsoBibItem
         @abstract
       end
     end
+
+    # @return [String]
+    def to_xml
+      Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+        xml.bibitem(id: id) do
+          title.each { |t| xml.title { t.to_xml xml } }
+          source.each { |s| s.to_xml xml }
+          dates.each { |d| d.to_xml xml }
+          contributors.each do |c|
+            xml.contributor do
+              c.role.each { |r| r.to_xml xml }
+              c.to_xml xml
+            end
+          end
+          language.each { |l| xml.language l }
+        end
+      end.doc.root.to_xml
+    end
   end
 end

data/lib/iso_bib_item/contribution_info.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'iso_bib_item/person'
+
 # Isobib module
 module IsoBibItem
   # Contributor's role.
@@ -10,8 +12,9 @@ module IsoBibItem
     # @return [ContributorRoleType]
     attr_reader :type
 
-    # @param type [ContributorRoleType] allowed types "author", "editor",
+    # @param type [String] allowed types "author", "editor",
     #   "cartographer", "publisher"
+    # @param description [Array<String>]
     def initialize(type, description = [])
       @type = type
       @description = description.map { |d| FormattedString.new d }
@@ -20,9 +23,7 @@ module IsoBibItem
     def to_xml(builder)
       builder.role(type: type) do
         description.each do |d|
-          builder.description do |desc|
-            d.to_xml(desc)
-          end
+          builder.description { |desc| d.to_xml(desc) }
         end
       end
     end

data/lib/iso_bib_item/contributor.rb

@@ -3,10 +3,66 @@
 require 'uri'
 
 module IsoBibItem
-  # Contact method.
-  class ContactMethod
-    # @return [String] @todo TBD
-    attr_reader :contact
+  # Address class.
+  class Address
+    # @return [Array<String>]
+    attr_reader :street
+
+    # @return [String]
+    attr_reader :city
+
+    # @return [String, NilClass]
+    attr_reader :state
+
+    # @return [String]
+    attr_reader :country
+
+    # @return [String, NilClass]
+    attr_reader :postcode
+
+    # @param street [Array<String>]
+    # @param city [String]
+    # @param state [String]
+    # @param country [String]
+    # @param postcode [String]
+    def initialize(street:, city:, state: nil, country:, postcode: nil)
+      @street   = street
+      @city     = city
+      @state    = state
+      @country  = country
+      @postcode = postcode
+    end
+
+    # @param builder [Nokogiri::XML::Document]
+    def to_xml(doc)
+      doc.address do
+        street.each { |str| doc.street str }
+        doc.city city
+        doc.state state if state
+        doc.country country
+        doc.postcode postcode if postcode
+      end
+    end
+  end
+
+  # Contact class.
+  class Contact
+    # @return [String] allowed "phone", "email" or "uri"
+    attr_reader :type
+
+    # @return [String]
+    attr_reader :value
+
+    # @param phone [String]
+    def initialize(type:, value:)
+      @type  = type
+      @value = value
+    end
+
+    # @param builder [Nokogiri::XML::Document]
+    def to_xml(doc)
+      doc.send type, value
+    end
   end
 
   # Affilation.
@@ -25,6 +81,14 @@ module IsoBibItem
       @organization = organization
       @description  = []
     end
+
+    def to_xml(builder)
+      builder.affilation do
+        builder.name { name.to_xml builder } if name
+        description.each { |d| builder.description { d.to_xml builder } }
+        organization.to_xml builder
+      end
+    end
   end
 
   # Contributor.
@@ -32,13 +96,14 @@ module IsoBibItem
     # @return [URI]
     attr_reader :uri
 
-    # @return [Array<IsoBibItem::ContactMethod>]
+    # @return [Array<IsoBibItem::Address, IsoBibItem::Phone>]
     attr_reader :contacts
 
     # @param url [String]
-    def initialize(url = nil)
+    # @param contacts [Array<IsoBibItem::Address, IsoBibItem::Phone>]
+    def initialize(url: nil, contacts: [])
       @uri = URI url if url
-      @contacts = []
+      @contacts = contacts
     end
 
     # @return [String]

data/lib/iso_bib_item/iso_bibliographic_item.rb

@@ -93,6 +93,7 @@ module IsoBibItem
     attr_reader :ics
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+
     # @param docid [Hash{project_number=>Integer, part_number=>Integer}]
     # @param titles [Array<Hash{title_intro=>String, title_main=>String,
     #   title_part=>String, language=>String, script=>String}>]
@@ -116,7 +117,9 @@ module IsoBibItem
     # @param relations [Array<Hash{type=>String, identifier=>String}>]
     def initialize(**args)
       super_args = args.select do |k|
-        %i[language script dates abstract contributors relations].include? k
+        %i[
+          id language script dates abstract contributors relations source
+        ].include? k
       end
       super(super_args)
       @docidentifier = IsoDocumentId.new args[:docid]
@@ -126,10 +129,7 @@ module IsoBibItem
       @status        = IsoDocumentStatus.new(args[:docstatus])
       @workgroup     = IsoProjectGroup.new(args[:workgroup]) if args[:workgroup]
       @ics = args[:ics].map { |i| Ics.new(i) }
-      if args[:copyright]
-        @copyright = CopyrightAssociation.new(args[:copyright])
-      end
-      @source = args[:source].map { |s| TypedUri.new(s) }
+      @copyright = CopyrightAssociation.new args[:copyright] if args[:copyright]
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
   
@@ -139,10 +139,11 @@ module IsoBibItem
     def to_all_parts
       me = Duplicate.duplicate(self)
       @relations << DocumentRelation.new(type: "partOf", identifier: nil, url: nil, bibitem: me)
-      @title.each { |t| t.remove_part }
+
+      @title.each(&:remove_part)
       @abstract = []
       @docidentifier.remove_part
-      @allParts = true
+      @all_parts = true
     end
 
     # convert ISO:yyyy reference to reference to most recent
@@ -211,7 +212,6 @@ module IsoBibItem
       idstr.strip
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def render_xml(builder, **opts)
       builder.send(:bibitem, type: type, id: id) do
         title.each { |t| t.to_xml builder }
@@ -236,10 +236,9 @@ module IsoBibItem
           builder.note("ISO DATE: #{opts[:note]}", format: 'text/plain')
         end
         ics.each { |i| i.to_xml builder }
-        builder.allParts "true" if @allParts
+        builder.allParts 'true' if @all_parts
         yield(builder) if block_given?
       end
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
   end
 end

data/lib/iso_bib_item/iso_localized_title.rb

@@ -23,13 +23,14 @@ module IsoBibItem
     # @param title_part [String]
     # @param language [String] language Iso639 code
     # @param script [String] script Iso15924 code
-    def initialize(title_intro:, title_main:, title_part: nil, language:, script:)
+    def initialize(title_intro:, title_main:, title_part: nil, language:,
+                   script:)
       @title_intro = title_intro
       @title_main  = title_main
       @title_part  = title_part
       @language    = language
       @script      = script
-      @title_main = "[ -- ]" if @title_main.nil? || @title_main.empty?
+      @title_main = '[ -- ]' if @title_main.nil? || @title_main.empty?
       # "[ -- ]" # title cannot be nil
     end
 

data/lib/iso_bib_item/organization.rb

@@ -43,7 +43,7 @@ module IsoBibItem
     # @param abbreviation [String]
     # @param url [String]
     def initialize(name:, abbreviation: nil, url: nil)
-      super(url)
+      super(url: url)
       @name         = LocalizedString.new name
       @abbreviation = LocalizedString.new abbreviation
       @identifiers  = []

data/lib/iso_bib_item/person.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'iso_bib_item/contributor'
 
 module IsoBibItem
@@ -6,30 +8,57 @@ module IsoBibItem
     # @return [Array<IsoBibItem::LocalizedString>]
     attr_accessor :forenames
 
-    # @return [Array<IsoBibItem::LocalizedString]
-    attr_accessor :inials
+    # @return [Array<IsoBibItem::LocalizedString>]
+    attr_accessor :initials
 
     # @return [IsoBibItem::LocalizedString]
     attr_accessor :surname
 
-    # @return [Array<IsoBibItem::LocalizedString]
+    # @return [Array<IsoBibItem::LocalizedString>]
     attr_accessor :additions
 
-    # @return [Array<IsoBibItem::LocalizedString]
+    # @return [Array<IsoBibItem::LocalizedString>]
     attr_accessor :prefix
 
-    def initialize(surname)
-      @surname   = surname
-      @forenames = []
-      @initials  = []
-      @additions = []
-      @prefix    = []
+    # @return [IsoBibItem::LocalizedString]
+    attr_reader :completename
+
+    # @param surname [IsoBibItem::LocalizedString]
+    # @param forenames [Array<IsoBibItem::LocalizedString>]
+    # @param initials [Array<IsoBibItem::LocalizedString>]
+    # @param prefix [Array<IsoBibItem::LocalizedString>]
+    # @param completename [IsoBibItem::LocalizedString]
+    def initialize(**args)
+      unless args[:surname] || args[:completename]
+        raise ArgumentError, 'Should be given :surname or :completename'
+      end
+      @surname      = args[:surname]
+      @forenames    = args[:forenames]
+      @initials     = args[:initials]
+      @additions    = args[:additions]
+      @prefix       = args[:prefix]
+      @completename = args[:completename]
+    end
+
+    # @param builder [Nokogiri::XML::Builder]
+    def to_xml(builder)
+      builder.name do
+        if completename
+          builder.completename { completename.to_xml builder }
+        else
+          builder.prefix { prefix.each { |p| p.to_xml builder } } if prefix
+          builder.initial { initials.each { |i| i.to_xml builder } } if initials
+          builder.addition { additions.each { |a| a.to_xml builder } } if additions
+          builder.surname { surname.to_xml builder }
+          builder.forename { forenames.each { |f| f.to_xml builder } } if forenames
+        end
+      end
     end
   end
 
   module PersonIdentifierType
-    ISNI = 'isni'.freeze
-    URI  = 'uri'.freeze
+    ISNI = 'isni'
+    URI  = 'uri'
   end
 
   # Person identifier.
@@ -57,10 +86,20 @@ module IsoBibItem
     # @return [Array<IsoBibItem::PersonIdentifier>]
     attr_accessor :identifiers
 
-    def initialize
-      super
-      @affilation = []
+    # @param name [IsoBibItem::FullName]
+    # @param affilation [Array<IsoBibItem::Affilation>]
+    def initialize(name:, affilation: [], contacts:)
+      super(contacts: contacts)
+      @name        = name
+      @affilation  = affilation
       @identifiers = []
     end
+
+    def to_xml(builder)
+      builder.person do
+        name.to_xml builder
+        affilation.each { |a| a.to_xml builder }
+      end
+    end
   end
 end

data/lib/iso_bib_item/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iso-bib-item
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-18 00:00:00.000000000 Z
+date: 2018-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: 'IsoBibItem: Ruby ISOXMLDOC impementation.'