relaton-iso-bib 1.16.2 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4da0e98206115f1448b10d16ba8c6521a38bc25762f9b1ecabf07e11b415c293
-  data.tar.gz: f09b435e8ec48229bd3fbe516d476cda07f0ade028a5f141174fc97d7f3b07cc
+  metadata.gz: 240dcef5e33b4150ea0b8dbd7e5fca3d33b9142272444bec69f563465fef421f
+  data.tar.gz: 991fc22a605a89a0e60cf1e0fdcda36d762dbd009423b2a72f6c84eb31a44ca3
 SHA512:
-  metadata.gz: bd267c0503570dc5e86586a574cb0da0f032680019d68eea433ab5d97ac11551f41c2a646653aef17b7ed70dea3879cc0f9eb8cfcd7b73f4751bf33d58c40a6d
-  data.tar.gz: 1761fbed48d7aa9d0d200fb0061aa2ca17fc0e3c8264e3a75349ac3a797457f996c1557d23c16d43af6e4ddff6310f2ec6af57d0e5076150814805e4bc7b5937
+  metadata.gz: e4127f04b3be531d2bfd44faaa8c2d7df59c67009175ca06d52912cc0e0f4bac19a971ce60dba7d19f59abf6d178b8cc019035080b809bb92d0b123f155d7bf4
+  data.tar.gz: 45e28f577e029540ae0baaab72fc3cc2e1eb2fae114f71178d1f503a6c9c0ad9a4764379bcdd31869638eda4c831022779693064d55874d13b786f5a0924137e

data/.github/workflows/rake.yml

@@ -10,4 +10,4 @@ on:
 
 jobs:
   rake:
-    uses: relaton/support/.github/workflows/rake.yml@master
+    uses: relaton/support/.github/workflows/rake.yml@main

data/.github/workflows/release.yml

@@ -17,7 +17,7 @@ on:
 
 jobs:
   release:
-    uses: relaton/support/.github/workflows/release.yml@master
+    uses: relaton/support/.github/workflows/release.yml@main
     with:
       next_version: ${{ github.event.inputs.next_version }}
     secrets:

data/grammars/basicdoc.rng

@@ -95,8 +95,89 @@
       <ref name="pagebreak"/>
       <ref name="hr"/>
       <ref name="bookmark"/>
+      <ref name="amend"/>
     </choice>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <ref name="AmendType"/>
+    </element>
+  </define>
+  <define name="AmendType">
+    <optional>
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+    </optional>
+    <attribute name="change">
+      <choice>
+        <value>add</value>
+        <value>modify</value>
+        <value>delete</value>
+        <value>replace</value>
+      </choice>
+    </attribute>
+    <optional>
+      <attribute name="path"/>
+    </optional>
+    <optional>
+      <attribute name="path_end"/>
+    </optional>
+    <optional>
+      <attribute name="title"/>
+    </optional>
+    <optional>
+      <element name="location">
+        <zeroOrMore>
+          <choice>
+            <ref name="locality"/>
+            <ref name="localityStack"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="description">
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="newcontent">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="contributor"/>
+    </zeroOrMore>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
   <define name="paragraph">
     <element name="p">
       <ref name="ParagraphType"/>
@@ -715,27 +796,36 @@
   </define>
   <define name="ruby">
     <element name="ruby">
-      <zeroOrMore>
-        <choice>
-          <ref name="PureTextElement"/>
-          <ref name="rp"/>
-          <ref name="rt"/>
-        </choice>
-      </zeroOrMore>
+      <choice>
+        <ref name="ruby_pronunciation"/>
+        <ref name="ruby_annotation"/>
+      </choice>
+      <choice>
+        <text/>
+        <ref name="ruby"/>
+      </choice>
     </element>
   </define>
-  <define name="rp">
-    <element name="rp">
-      <zeroOrMore>
-        <ref name="PureTextElement"/>
-      </zeroOrMore>
+  <define name="ruby_pronunciation">
+    <element name="pronunciation">
+      <attribute name="value"/>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="lang"/>
+      </optional>
     </element>
   </define>
-  <define name="rt">
-    <element name="rt">
-      <zeroOrMore>
-        <ref name="PureTextElement"/>
-      </zeroOrMore>
+  <define name="ruby_annotation">
+    <element name="annotation">
+      <attribute name="value"/>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="lang"/>
+      </optional>
     </element>
   </define>
   <define name="br">
@@ -914,44 +1004,49 @@
   -->
   <define name="image">
     <element name="image">
-      <attribute name="id">
-        <data type="ID"/>
+      <ref name="Image"/>
+    </element>
+  </define>
+  <define name="Image">
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <attribute name="src">
+      <data type="anyURI"/>
+    </attribute>
+    <attribute name="mimetype"/>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <attribute name="width">
+        <ref name="ImageSize"/>
       </attribute>
-      <attribute name="src">
+    </optional>
+    <optional>
+      <attribute name="height">
+        <ref name="ImageSize"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="alt"/>
+    </optional>
+    <optional>
+      <attribute name="title"/>
+    </optional>
+    <optional>
+      <attribute name="longdesc">
         <data type="anyURI"/>
       </attribute>
-      <attribute name="mimetype"/>
-      <optional>
-        <attribute name="filename"/>
-      </optional>
-      <optional>
-        <attribute name="width">
-          <choice>
-            <data type="int"/>
-            <value>auto</value>
-          </choice>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="height">
-          <choice>
-            <data type="int"/>
-            <value>auto</value>
-          </choice>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="alt"/>
-      </optional>
-      <optional>
-        <attribute name="title"/>
-      </optional>
-      <optional>
-        <attribute name="longdesc">
-          <data type="anyURI"/>
-        </attribute>
-      </optional>
-    </element>
+    </optional>
+  </define>
+  <define name="ImageSize">
+    <choice>
+      <data type="string">
+        <param name="pattern">\d+([.]\d+)?(%?)</param>
+      </data>
+      <value>auto</value>
+    </choice>
   </define>
   <define name="video">
     <element name="video">

data/grammars/biblio-standoc.rng

@@ -9,11 +9,42 @@
   -->
   <include href="biblio.rng">
     <define name="BibData">
-      <ref name="BibliographicItem"/>
+      <ref name="StandardBibliographicItem"/>
       <optional>
         <ref name="ext"/>
       </optional>
     </define>
+    <define name="docrelation">
+      <element name="relation">
+        <attribute name="type">
+          <ref name="DocRelationType"/>
+        </attribute>
+        <optional>
+          <element name="description">
+            <ref name="FormattedString"/>
+          </element>
+        </optional>
+        <element name="bibitem">
+          <ref name="StandardReducedBibliographicItem"/>
+        </element>
+        <choice>
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="localityStack"/>
+          </zeroOrMore>
+        </choice>
+        <choice>
+          <zeroOrMore>
+            <ref name="sourceLocality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="sourceLocalityStack"/>
+          </zeroOrMore>
+        </choice>
+      </element>
+    </define>
   </include>
   <define name="ext">
     <element name="ext">
@@ -161,4 +192,16 @@
       </optional>
     </element>
   </define>
+  <define name="StandardBibliographicItem">
+    <ref name="BibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
+  <define name="StandardReducedBibliographicItem">
+    <ref name="ReducedBibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
 </grammar>

data/grammars/biblio.rng

@@ -241,6 +241,9 @@
     </element>
   </define>
   <define name="FullNameType">
+    <optional>
+      <ref name="name_abbreviation"/>
+    </optional>
     <choice>
       <group>
         <zeroOrMore>
@@ -266,6 +269,11 @@
       <ref name="variantname"/>
     </zeroOrMore>
   </define>
+  <define name="name_abbreviation">
+    <element name="abbreviation">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
   <define name="prefix">
     <element name="prefix">
       <ref name="LocalizedString"/>
@@ -348,6 +356,9 @@
       <zeroOrMore>
         <ref name="contact"/>
       </zeroOrMore>
+      <optional>
+        <ref name="logo"/>
+      </optional>
     </element>
   </define>
   <define name="orgname">
@@ -366,6 +377,21 @@
       </choice>
     </element>
   </define>
+  <define name="logo">
+    <element name="logo">
+      <ref name="image"/>
+    </element>
+  </define>
+  <define name="depiction">
+    <element name="depiction">
+      <optional>
+        <attribute name="scope"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="image"/>
+      </zeroOrMore>
+    </element>
+  </define>
   <define name="NameWithVariants">
     <element name="primary">
       <ref name="LocalizedString"/>
@@ -752,6 +778,9 @@
     <optional>
       <ref name="validity"/>
     </optional>
+    <optional>
+      <ref name="depiction"/>
+    </optional>
   </define>
   <define name="ReducedBibliographicItem">
     <optional>
@@ -849,6 +878,9 @@
     <optional>
       <ref name="validity"/>
     </optional>
+    <optional>
+      <ref name="depiction"/>
+    </optional>
   </define>
   <define name="btitle">
     <element name="title">

data/lib/relaton_iso_bib/document_type.rb

@@ -0,0 +1,32 @@
+module RelatonIsoBib
+  class DocumentType < RelatonBib::DocumentType
+    DOCTYPES = %w[
+      international-standard technical-specification technical-report
+      publicly-available-specification international-workshop-agreement guide
+      amendment technical-corrigendum directive
+    ].freeze
+
+    #
+    # Create a new DocumentType object.
+    #
+    # @param [String] type document type
+    # @param [String, nil] abbreviation type abbreviation
+    #
+    def initialize(type:, abbreviation: nil)
+      check_doctype type
+      super
+    end
+
+    #
+    # Check if type is valid.
+    #
+    # @param [String] type document type
+    #
+    def check_doctype(type)
+      unless DOCTYPES.include? type
+        Util.warn "WARNING: invalid doctype: `#{type}`"
+        Util.warn "Allowed doctypes are: `#{DOCTYPES.join('`, `')}`"
+      end
+    end
+  end
+end

data/lib/relaton_iso_bib/hash_converter.rb

@@ -1,52 +1,57 @@
 module RelatonIsoBib
-  class HashConverter < RelatonBib::HashConverter
-    class << self
-      private
-
-      #
-      # Ovverides superclass's method
-      #
-      # @param item [Hash]
-      # @retirn [RelatonIsoBib::IsoBibliographicItem]
-      def bib_item(item)
-        IsoBibliographicItem.new(**item)
-      end
+  module HashConverter
+    include RelatonBib::HashConverter
+    extend self
 
-      #
-      # Ovverides superclass's method
-      #
-      # @param title [Hash]
-      # @return [RelatonBib::TypedTitleString]
-      def typed_title_strig(title)
-        RelatonBib::TypedTitleString.new(**title)
-      end
+    private
 
-      # @param ret [Hash]
-      def editorialgroup_hash_to_bib(ret)
-        eg = ret[:editorialgroup]
-        return unless eg
-
-        ret[:editorialgroup] = EditorialGroup.new(
-          technical_committee: RelatonBib.array(eg[:technical_committee]),
-          subcommittee: RelatonBib.array(eg[:subcommittee]),
-          workgroup: RelatonBib.array(eg[:workgroup]),
-          secretariat: eg[:secretariat],
-        )
-      end
+    #
+    # Ovverides superclass's method
+    #
+    # @param item [Hash]
+    # @retirn [RelatonIsoBib::IsoBibliographicItem]
+    def bib_item(item)
+      IsoBibliographicItem.new(**item)
+    end
 
-      # @param ret [Hash]
-      def ics_hash_to_bib(ret)
-        ret[:ics] = RelatonBib.array(ret[:ics]).map do |ics|
-          Ics.new(ics[:code] || ics)
-        end
-      end
+    #
+    # Ovverides superclass's method
+    #
+    # @param title [Hash]
+    # @return [RelatonBib::TypedTitleString]
+    def typed_title_strig(title)
+      RelatonBib::TypedTitleString.new(**title)
+    end
 
-      # @param ret [Hash]
-      def structuredidentifier_hash_to_bib(ret)
-        return unless ret[:structuredidentifier]
+    # @param ret [Hash]
+    def editorialgroup_hash_to_bib(ret)
+      eg = ret[:editorialgroup]
+      return unless eg
 
-        ret[:structuredidentifier] = RelatonIsoBib::StructuredIdentifier.new(**ret[:structuredidentifier])
+      ret[:editorialgroup] = EditorialGroup.new(
+        technical_committee: RelatonBib.array(eg[:technical_committee]),
+        subcommittee: RelatonBib.array(eg[:subcommittee]),
+        workgroup: RelatonBib.array(eg[:workgroup]),
+        secretariat: eg[:secretariat],
+      )
+    end
+
+    # @param ret [Hash]
+    def ics_hash_to_bib(ret)
+      ret[:ics] = RelatonBib.array(ret[:ics]).map do |ics|
+        Ics.new(ics[:code] || ics)
       end
     end
+
+    # @param ret [Hash]
+    def structuredidentifier_hash_to_bib(ret)
+      return unless ret[:structuredidentifier]
+
+      ret[:structuredidentifier] = RelatonIsoBib::StructuredIdentifier.new(**ret[:structuredidentifier])
+    end
+
+    def create_doctype(**args)
+      DocumentType.new(**args)
+    end
   end
 end

data/lib/relaton_iso_bib/iso_bibliographic_item.rb

@@ -18,22 +18,16 @@ end
 module RelatonIsoBib
   # Bibliographic item.
   class IsoBibliographicItem < RelatonBib::BibliographicItem
-    DOCTYPES = %w[
-      international-standard technical-specification technical-report
-      publicly-available-specification international-workshop-agreement guide
-      amendment technical-corrigendum directive
-    ].freeze
-
     SUBDOCTYPES = %w[specification method-of-test vocabulary code-of-practice].freeze
 
     # @return [RelatonIsoBib::StructuredIdentifier]
     attr_reader :structuredidentifier
 
-    # @!attribute [r] title
-    #   @return [Array<RelatonBib::TypedTitleString>]
+    # @return [String, nil]
+    attr_reader :stagename
 
-    # @return [String, NilClass]
-    attr_reader :doctype, :stagename
+    # @!attribute [r] subdoctype
+    #  @return [RelatonIsoBib::DocumentType]
 
     # @return [Boolean, nil]
     attr_reader :horizontal
@@ -64,18 +58,13 @@ module RelatonIsoBib
     # @param classification [RelatonBib::Classification, NilClass]
     # @param validity [RelatonBib:Validity, NilClass]
     # @param docid [Array<RelatonBib::DocumentIdentifier>]
-    # @param doctype [String, nil]
+    # @param doctype [RelatonIsoBib::DocumentType]
     # @param subdoctype [String, nil]
     # @param horizontal [Boolean, nil]
     # @param structuredidentifier [RelatonIsoBib::StructuredIdentifier]
     # @param stagename [String, NilClass]
     #
-    # @param title [Array<Hash>]
-    # @option title [String] :title_intro
-    # @option title [String] :title_main
-    # @option title [String] :title_part
-    # @option title [String] :language
-    # @option title [String] :script
+    # @param title [Array<Hash, RelatonBib::TypedTitleString>, RelatonBib::TypedTitleStringCollection]
     #
     # @param editorialgroup [Hash, RelatonIsoBib::EditorialGroup]
     # @option workgrpup [String] :name
@@ -128,8 +117,6 @@ module RelatonIsoBib
     #
     # @raise [ArgumentError]
     def initialize(**args)
-      check_doctype args[:doctype]
-
       args[:type] ||= "standard"
       arg_names = %i[
         id title docnumber language script docstatus date abstract contributor
@@ -183,7 +170,7 @@ module RelatonIsoBib
         if block_given? then yield b
         elsif opts[:bibdata] && has_ext_attrs?
           ext = b.ext do
-            b.doctype doctype if doctype
+            doctype.to_xml b if doctype
             b.subdoctype subdoctype if subdoctype
             b.horizontal horizontal unless horizontal.nil?
             editorialgroup&.to_xml b
@@ -224,15 +211,6 @@ module RelatonIsoBib
 
     private
 
-    # @param doctype [String]
-    # @raise ArgumentError
-    def check_doctype(doctype)
-      if doctype && !self.class::DOCTYPES.include?(doctype)
-        Util.warn "WARNING: invalid doctype: #{doctype}"
-        Util.warn "Allowed doctypes are: #{self.class::DOCTYPES.join(', ')}"
-      end
-    end
-
     def makeid(id, attribute, _delim = "") # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity,Metrics/AbcSize
       return nil if attribute && !@id_attribute
 

data/lib/relaton_iso_bib/version.rb

@@ -1,3 +1,3 @@
 module RelatonIsoBib
-  VERSION = "1.16.2".freeze
+  VERSION = "1.18.0".freeze
 end

data/lib/relaton_iso_bib.rb

@@ -4,6 +4,7 @@ require "relaton_bib"
 require "relaton_iso_bib/version"
 require "relaton_iso_bib/config"
 require "relaton_iso_bib/util"
+require "relaton_iso_bib/document_type"
 require "relaton_iso_bib/iso_bibliographic_item"
 require "digest/md5"
 

data/relaton_iso_bib.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "isoics", "~> 0.1.6"
-  spec.add_dependency "relaton-bib", "~> 1.16.0"
+  spec.add_dependency "relaton-bib", "~> 1.18.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iso-bib
 version: !ruby/object:Gem::Version
-  version: 1.16.2
+  version: 1.18.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2024-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: isoics
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.18.0
 description: 'RelatonIsoBib: Ruby ISOXMLDOC impementation.'
 email:
 - open.source@ribose.com
@@ -64,6 +64,7 @@ files:
 - grammars/relaton-iso.rng
 - lib/relaton_iso_bib.rb
 - lib/relaton_iso_bib/config.rb
+- lib/relaton_iso_bib/document_type.rb
 - lib/relaton_iso_bib/editorial_group.rb
 - lib/relaton_iso_bib/hash_converter.rb
 - lib/relaton_iso_bib/ics.rb