iso-bib-item 0.1.0

data/lib/iso_bib_item/contribution_info.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Isobib module
+module IsoBibItem
+  # Contributor's role.
+  class ContributorRole
+    # @return [Array<IsoBibItem::FormattedString>]
+    attr_reader :description
+
+    # @return [ContributorRoleType]
+    attr_reader :type
+
+    # @param type [ContributorRoleType] allowed types "author", "editor",
+    #   "cartographer", "publisher"
+    def initialize(type, description = [])
+      @type = type
+      @description = description.map { |d| FormattedString.new d }
+    end
+
+    def to_xml(builder)
+      builder.role(type: type) do
+        description.each do |d|
+          builder.description do |desc|
+            d.to_xml(desc)
+          end
+        end
+      end
+    end
+  end
+
+  # Contribution info.
+  class ContributionInfo
+    # @return [Array<IsoBibItem::ContributorRole>]
+    attr_reader :role
+
+    # @return
+    #   [IsoBibItem::Person, IsoBibItem::Organization,
+    #    IsoBibItem::IsoProjectGroup]
+    attr_reader :entity
+
+    # @param entity [IsoBibItem::Person, IsoBibItem::Organization,
+    #   IsoBibItem::IsoProjectGroup]
+    # @param role [Array<String>]
+    def initialize(entity:, role: ['publisher'])
+      @entity = entity
+      @role   = role.map { |r| ContributorRole.new(r) }
+    end
+
+    def to_xml(builder)
+      entity.to_xml builder
+    end
+  end
+end

data/lib/iso_bib_item/contributor.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module IsoBibItem
+  # Contact method.
+  class ContactMethod
+    # @return [String] @todo TBD
+    attr_reader :contact
+  end
+
+  # Affilation.
+  class Affilation
+    # @return [IsoBibItem::LocalizedString]
+    attr_reader :name
+
+    # @return [Array<IsoBibItem::FormattedString>]
+    attr_reader :description
+
+    # @return [IsoBibItem::Organization]
+    attr_reader :organization
+
+    # @param organization [IsoBibItem::Organization]
+    def initialize(organization)
+      @organization = organization
+      @description  = []
+    end
+  end
+
+  # Contributor.
+  class Contributor
+    # @return [URI]
+    attr_reader :uri
+
+    # @return [Array<IsoBibItem::ContactMethod>]
+    attr_reader :contacts
+
+    # @param url [String]
+    def initialize(url = nil)
+      @uri = URI url if url
+      @contacts = []
+    end
+
+    # @return [String]
+    # def url
+    #   @uri.to_s
+    # end
+
+    def to_xml(builder)
+      contacts.each { |contact| contact.to_xml builder }
+    end
+  end
+end

data/lib/iso_bib_item/document_relation_collection.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module IsoBibItem
+  # module DocumentRelationType
+  #   PARENT        = 'parent'
+  #   CHILD         = 'child'
+  #   OBSOLETES     = 'obsoletes'
+  #   UPDATES       = 'updates'
+  #   COMPLEMENTS   = 'complements'
+  #   DERIVED_FORM  = 'derivedForm'
+  #   ADOPTED_FORM  = 'adoptedForm'
+  #   EQUIVALENT    = 'equivalent'
+  #   IDENTICAL     = 'identical'
+  #   NONEQUIVALENT = 'nonequivalent'
+  # end
+
+  # class SpecificLocalityType
+  #   SECTION   = 'section'
+  #   CLAUSE    = 'clause'
+  #   PART      = 'part'
+  #   PARAGRAPH = 'paragraph'
+  #   CHAPTER   = 'chapter'
+  #   PAGE      = 'page'
+  #   WHOLE     = 'whole'
+  #   TABLE     = 'table'
+  #   ANNEX     = 'annex'
+  #   FIGURE    = 'figure'
+  #   NOTE      = 'note'
+  #   EXAMPLE   = 'example'
+  #   # generic String is allowed
+  # end
+
+  # Bibliographic item locality.
+  class BibItemLocality
+    # @return [IsoBibItem::SpecificLocalityType]
+    attr_reader :type
+
+    # @return [IsoBibItem::LocalizedString]
+    attr_reader :reference_from
+
+    # @return [IsoBibItem::LocalizedString]
+    attr_reader :reference_to
+
+    # @param type [String]
+    # @param referenceFrom [IsoBibItem::LocalizedString]
+    # @param referenceTo [IsoBibItem::LocalizedString]
+    def initialize(type, reference_from, reference_to = nil)
+      @type           = type
+      @reference_from = reference_from
+      @reference_to   = reference_to
+    end
+  end
+
+  # Documett relation
+  class DocumentRelation
+    # @return [String]
+    attr_reader :type
+
+    # @return [String]
+    attr_reader :identifier, :url
+
+    # @return [IsoBibItem::BibliographicItem]
+    attr_reader :bibitem
+
+    # @return [Array<IsoBibItem::BibItemLocality>]
+    attr_reader :bib_locality
+
+    # @param type [String]
+    # @param identifier [String]
+    def initialize(type:, identifier:, url:, bib_locality: [])
+      @type         = type
+      @identifier   = identifier
+      @url          = url
+      @bib_locality = bib_locality
+    end
+
+    def to_xml(builder)
+      builder.relation(type: type) do
+        builder.bibitem do
+          builder.formattedref identifier
+          builder.docidentifier identifier
+        end
+        # builder.url url
+      end
+    end
+  end
+
+  # Document relations collection
+  class DocRelationCollection < Array
+    # @param [Array<Hash{type=>String, identifier=>String}>]
+    def initialize(relations)
+      super relations.map { |r| DocumentRelation.new(r) }
+    end
+
+    # @return [Array<IsoBibItem::DocumentRelation>]
+    def replaces
+      select { |r| r.type == 'replace' }
+    end
+  end
+end

data/lib/iso_bib_item/document_status.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'iso_bib_item/localized_string'
+
+module IsoBibItem
+  # Dovument status.
+  class DocumentStatus
+    # @return [IsoBibItem::LocalizedString]
+    attr_reader :status
+
+    # @param status [IsoBibItem::LocalizedString]
+    def initialize(status)
+      @status = status
+    end
+
+    def to_xml(builder)
+      builder.status do
+        # FormattedString.instance_method(:to_xml).bind(status).call builder
+        status.to_xml builder
+      end
+    end
+  end
+end

data/lib/iso_bib_item/formatted_string.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'iso_bib_item/localized_string'
+
+module IsoBibItem
+  # Formatted string
+  class FormattedString < LocalizedString
+    # @return [String]
+    attr_reader :type
+
+    # @param content [String]
+    # @param language [String] language code Iso639
+    # @param script [String] script code Iso15924
+    # @param type [String] the format type, default "plain"
+    #   available types "plain", "html", "dockbook", "tei", "asciidoc",
+    #   "markdown", "isodoc"
+    def initialize(content:, language:, script:, type: 'plain')
+      super(content, language, script)
+      @type = type
+    end
+
+    def to_xml(builder)
+      builder.parent['format'] = type
+      super
+    end
+  end
+end

data/lib/iso_bib_item/iso_bibliographic_item.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: false
+
+require 'nokogiri'
+require 'isoics'
+require 'iso_bib_item/bibliographic_item'
+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'
+
+# Add filter method to Array.
+# class Array
+#   def filter(type:)
+#     select { |e| e.type == type }
+#   end
+# end
+
+module IsoBibItem
+  # Iso document id.
+  class IsoDocumentId
+    # @return [Integer]
+    attr_reader :tc_document_number
+
+    # @return [Integer]
+    attr_reader :project_number
+
+    # @return [Integer]
+    attr_reader :part_number
+
+    # @param project_number [Integer]
+    # @param part_number [Integer]
+    def initialize(project_number:, part_number:)
+      @project_number = project_number
+      @part_number    = part_number
+    end
+
+    def to_xml(builder)
+      builder.docidentifier(project_number + '-' + part_number)
+    end
+  end
+
+  # module IsoDocumentType
+  #   INTERNATIONAL_STANDART           = "internationalStandard"
+  #   TECHNICAL_SPECIFICATION          = "techinicalSpecification"
+  #   TECHNICAL_REPORT                 = "technicalReport"
+  #   PUPLICLY_AVAILABLE_SPECIFICATION = "publiclyAvailableSpecification"
+  #   INTERNATIONAL_WORKSHOP_AGREEMENT = "internationalWorkshopAgreement"
+  # end
+
+  # Iso ICS classificator.
+  class Ics < Isoics::ICS
+    # @param field [Integer]
+    # @param group [Integer]
+    # @param subgroup [Integer]
+    def initialize(field:, group:, subgroup:)
+      super fieldcode: field, groupcode: group, subgroupcode: subgroup
+    end
+  end
+
+  # Bibliographic item.
+  class IsoBibliographicItem < BibliographicItem
+    # @return [IsoBibItem::IsoDocumentId]
+    attr_reader :docidentifier
+
+    # @return [String]
+    attr_reader :edition
+
+    # @!attribute [r] title
+    #   @return [Array<IsoBibItem::IsoLocalizedTitle>]
+
+    # @return [IsoBibItem::IsoDocumentType]
+    attr_reader :type
+
+    # @return [IsoBibItem::IsoDocumentStatus]
+    attr_reader :status
+
+    # @return [IsoBibItem::IsoProjectGroup]
+    attr_reader :workgroup
+
+    # @return [Array<IsoBibItem::Ics>]
+    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}>]
+    # @param edition [String]
+    # @param language [Array<String>]
+    # @param script [Arrra<String>]
+    # @param type [String]
+    # @param docstatus [Hash{status=>String, stage=>String, substage=>String}]
+    # @param workgroup [Hash{name=>String, abbreviation=>String, url=>String,
+    #   technical_committee=>Hash{name=>String, type=>String, number=>Integer}}]
+    # @param ics [Array<Hash{field=>Integer, group=>Integer,
+    #   subgroup=>Integer}>]
+    # @param dates [Array<Hash{type=>String, from=>String, to=>String}>]
+    # @param abstract [Array<Hash{content=>String, language=>String,
+    #   script=>String, type=>String}>]
+    # @param contributors [Array<Hash{entity=>Hash{name=>String, url=>String,
+    #   abbreviation=>String}, roles=>Array<String>}>]
+    # @param copyright [Hash{owner=>Hash{name=>String, abbreviation=>String,
+    #   url=>String}, form=>String, to=>String}]
+    # @param source [Array<Hash{type=>String, content=>String}>]
+    # @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
+      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])
+      @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) }
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    # @param lang [String] language code Iso639
+    # @return [IsoBibItem::IsoLocalizedTitle]
+    def title(lang: nil)
+      if lang
+        @title.find { |t| t.language == lang }
+      else
+        @title
+      end
+    end
+
+    # @todo need to add ISO/IEC/IEEE
+    # @return [String]
+    def shortref(**opts)
+      year = if opts[:all_parts] then ':All Parts'
+             elsif opts[:no_year] then ''
+             else ':' + @copyright.from&.year&.to_s
+             end
+
+      "#{id(' ')}#{year}"
+    end
+
+    # @param type [Symbol] type of url, can be :src/:obp/:rss
+    # @return [String]
+    def url(type = :src)
+      @source.find { |s| s.type == type.to_s }.content.to_s
+    end
+
+    # @return [String]
+    def to_xml(builder = nil, **opts)
+      if builder
+        render_xml builder, opts
+      else
+        Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+          render_xml xml, opts
+        end.doc.root.to_xml
+      end
+    end
+
+    private
+
+    def publishers
+      @contributors.select do |c|
+        c.role.select { |r| r.type == 'publisher' }.any?
+      end
+    end
+
+    def id(delim = '')
+      contribs = publishers.map { |p| p&.entity&.abbreviation }.join '/'
+      idstr = "#{contribs}#{delim}#{@docidentifier.project_number}"
+      if @docidentifier.part_number&.size&.positive?
+        idstr << "-#{@docidentifier.part_number}"
+      end
+      idstr
+    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 }
+        source.each { |s| s.to_xml builder }
+        # docidentifier.to_xml builder
+        builder.docidentifier shortref(opts.merge(no_year: true))
+        dates.each { |d| d.to_xml builder, opts }
+        contributors.each do |c|
+          builder.contributor do
+            c.role.each { |r| r.to_xml builder }
+            c.to_xml builder
+          end
+        end
+        builder.edition edition
+        language.each { |l| builder.language l }
+        script.each { |s| builder.script s }
+        abstract.each { |a| builder.abstract { a.to_xml(builder) } }
+        status.to_xml builder
+        copyright.to_xml builder
+        relations.each { |r| r.to_xml builder }
+        if opts[:note]
+          builder.note("ISO DATE: #{opts[:note]}", format: 'text/plain')
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end