relaton-iec 1.7.7 → 1.10.0

data/grammars/isostandard.rng

@@ -38,6 +38,12 @@
     </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
+      <optional>
+        <ref name="docsubtype"/>
+      </optional>
+      <optional>
+        <ref name="horizontal"/>
+      </optional>
       <ref name="editorialgroup"/>
       <zeroOrMore>
         <ref name="ics"/>
@@ -76,19 +82,6 @@
         </choice>
       </element>
     </define>
-    <define name="ul">
-      <element name="ul">
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-        <oneOrMore>
-          <ref name="ul_li"/>
-        </oneOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </element>
-    </define>
     <define name="sections">
       <element name="sections">
         <zeroOrMore>
@@ -108,7 +101,11 @@
           <ref name="definitions"/>
         </optional>
         <oneOrMore>
-          <ref name="clause"/>
+          <choice>
+            <ref name="clause"/>
+            <ref name="term-clause"/>
+            <ref name="terms"/>
+          </choice>
         </oneOrMore>
       </element>
     </define>
@@ -137,18 +134,19 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <ref name="section-title"/>
       </optional>
       <choice>
-        <group>
+        <choice>
           <oneOrMore>
             <ref name="BasicBlock"/>
           </oneOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
+          <ref name="amend"/>
+        </choice>
         <oneOrMore>
           <ref name="clause-subsection"/>
         </oneOrMore>
@@ -161,6 +159,20 @@
             <data type="ID"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="language"/>
+        </optional>
+        <optional>
+          <attribute name="script"/>
+        </optional>
+        <optional>
+          <attribute name="tag"/>
+        </optional>
+        <optional>
+          <attribute name="multilingual-rendering">
+            <ref name="MultilingualRenderingType"/>
+          </attribute>
+        </optional>
         <ref name="preferred"/>
         <zeroOrMore>
           <ref name="admitted"/>
@@ -171,7 +183,7 @@
         <optional>
           <ref name="termdomain"/>
         </optional>
-        <ref name="definition"/>
+        <ref name="termdefinition"/>
         <zeroOrMore>
           <ref name="termnote"/>
         </zeroOrMore>
@@ -181,17 +193,9 @@
         <zeroOrMore>
           <ref name="termsource"/>
         </zeroOrMore>
-      </element>
-    </define>
-    <define name="definition">
-      <element name="definition">
-        <oneOrMore>
-          <choice>
-            <ref name="paragraph"/>
-            <ref name="figure"/>
-            <ref name="formula"/>
-          </choice>
-        </oneOrMore>
+        <zeroOrMore>
+          <ref name="term"/>
+        </zeroOrMore>
       </element>
     </define>
     <define name="annex">
@@ -230,9 +234,6 @@
           -->
           <ref name="BasicBlock"/>
         </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
         <zeroOrMore>
           <ref name="clause-hanging-paragraph-with-footnote"/>
         </zeroOrMore>
@@ -271,6 +272,15 @@
         <value>guide</value>
         <value>amendment</value>
         <value>technical-corrigendum</value>
+        <value>directive</value>
+      </choice>
+    </define>
+    <define name="DocumentSubtype">
+      <choice>
+        <value>specification</value>
+        <value>method-of-test</value>
+        <value>vocabulary</value>
+        <value>code-of-practice</value>
       </choice>
     </define>
     <define name="structuredidentifier">
@@ -324,6 +334,11 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="inline-header">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -332,71 +347,24 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <ref name="section-title"/>
       </optional>
       <choice>
-        <group>
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
         <oneOrMore>
           <ref name="content-subsection"/>
         </oneOrMore>
       </choice>
     </define>
-    <define name="table">
-      <element name="table">
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-        <optional>
-          <attribute name="width"/>
-        </optional>
-        <optional>
-          <attribute name="unnumbered">
-            <data type="boolean"/>
-          </attribute>
-        </optional>
-        <optional>
-          <attribute name="number"/>
-        </optional>
-        <optional>
-          <attribute name="subsequence"/>
-        </optional>
-        <optional>
-          <attribute name="alt"/>
-        </optional>
-        <optional>
-          <attribute name="summary"/>
-        </optional>
-        <optional>
-          <attribute name="uri">
-            <data type="anyURI"/>
-          </attribute>
-        </optional>
-        <optional>
-          <ref name="tname"/>
-        </optional>
-        <optional>
-          <ref name="thead"/>
-        </optional>
-        <ref name="tbody"/>
-        <optional>
-          <ref name="tfoot"/>
-        </optional>
-        <zeroOrMore>
-          <ref name="table-note"/>
-        </zeroOrMore>
-        <optional>
-          <ref name="dl"/>
-        </optional>
-      </element>
-    </define>
   </include>
   <!-- end overrides -->
   <!--
@@ -416,6 +384,9 @@
       <zeroOrMore>
         <ref name="termdocsource"/>
       </zeroOrMore>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -427,6 +398,14 @@
         <ref name="annex"/>
       </zeroOrMore>
       <ref name="bibliography"/>
+      <zeroOrMore>
+        <ref name="indexsect"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="horizontal">
+    <element name="horizontal">
+      <data type="boolean"/>
     </element>
   </define>
   <define name="documentnumber">
@@ -497,9 +476,6 @@
         <!-- allow hanging paragraphs in annexes: they introduce lists -->
         <ref name="BasicBlock"/>
       </zeroOrMore>
-      <zeroOrMore>
-        <ref name="note"/>
-      </zeroOrMore>
       <zeroOrMore>
         <ref name="clause-hanging-paragraph-with-footnote"/>
       </zeroOrMore>
@@ -510,28 +486,6 @@
       <ref name="Clause-Section"/>
     </element>
   </define>
-  <define name="ul_li">
-    <element name="li">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="uncheckedcheckbox">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="checkedcheckbox">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <oneOrMore>
-        <ref name="BasicBlock"/>
-      </oneOrMore>
-    </element>
-  </define>
   <define name="stagename">
     <element name="stagename">
       <text/>

data/grammars/reqt.rng

@@ -30,9 +30,22 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="subsequence"/>
     </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <attribute name="id">
       <data type="ID"/>
     </attribute>
@@ -40,17 +53,31 @@
       <attribute name="filename"/>
     </optional>
     <optional>
-      <ref name="reqtitle"/>
+      <attribute name="model"/>
     </optional>
     <optional>
-      <ref name="label"/>
+      <attribute name="type"/>
     </optional>
     <optional>
-      <ref name="subject"/>
+      <attribute name="tag"/>
     </optional>
     <optional>
-      <ref name="reqinherit"/>
+      <attribute name="multilingual-rendering">
+        <ref name="MultilingualRenderingType"/>
+      </attribute>
     </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="subject"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="reqinherit"/>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="classification"/>
     </zeroOrMore>
@@ -61,6 +88,7 @@
         <ref name="verification"/>
         <ref name="import"/>
         <ref name="description"/>
+        <ref name="component"/>
       </choice>
     </zeroOrMore>
     <optional>
@@ -81,17 +109,23 @@
   </define>
   <define name="label">
     <element name="label">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="subject">
     <element name="subject">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="reqinherit">
     <element name="inherit">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="measurementtarget">
@@ -119,6 +153,12 @@
       <ref name="RequirementSubpart"/>
     </element>
   </define>
+  <define name="component">
+    <element name="component">
+      <attribute name="class"/>
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
   <define name="reqt_references">
     <element name="references">
       <oneOrMore>
@@ -135,6 +175,24 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="tag"/>
+    </optional>
+    <optional>
+      <attribute name="multilingual-rendering">
+        <ref name="MultilingualRenderingType"/>
+      </attribute>
+    </optional>
     <oneOrMore>
       <ref name="BasicBlock"/>
     </oneOrMore>

data/lib/relaton_iec/basic_block/alignment.rb

@@ -0,0 +1,30 @@
+module BasicBlock
+  class Alignment
+    ALIGNS = %w[left right center justified].freeze
+
+    #
+    # @param [String] content
+    #
+    def initialize(content)
+      unless ALIGNS.include?(content)
+        warn "[basic-block] WARNING: invalid alignment \"#{content}\""
+        warn "[basic-block] alloved aligments are: #{ALIGNS.join ', '}"
+      end
+      @content = content
+    end
+
+    #
+    # @return [String]
+    #
+    def to_s
+      @content
+    end
+
+    #
+    # @return [String]
+    #
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/relaton_iec/basic_block/basic_block.rb

@@ -0,0 +1,15 @@
+require_relative "alignment"
+require_relative "citation_type"
+require_relative "dl"
+require_relative "eref_type"
+require_relative "eref"
+require_relative "formula"
+require_relative "image"
+require_relative "index_xref"
+require_relative "index"
+require_relative "note"
+require_relative "paragraph_with_footnote"
+require_relative "paragraph"
+require_relative "reference_format"
+require_relative "stem"
+require_relative "text_element"

data/lib/relaton_iec/basic_block/citation_type.rb

@@ -0,0 +1,32 @@
+module RelatonIec
+  class CitationType
+    # @return [String]
+    attr_reader :bibitemid
+
+    # @return [Array<elatonBib::Locality, RelatonBib::LocalityStack>]
+    attr_reader :locality
+
+    # @return [String, nil]
+    attr_reader :date
+
+    #
+    # @param [String] bibitemid
+    # @param [Array<RelatonBib::Locality, RelatonBib::LocalityStack>] locality
+    # @param [String, nil] date
+    #
+    def initialize(bibitemid:, locality:, date: nil)
+      @bibitemid = bibitemid
+      @locality = locality
+      @date = date
+    end
+
+    #
+    # @param [Nokogiri::XML::Builder] builder
+    #
+    def to_xml(builder)
+      builder.parent[:bibitemid] = bibitemid
+      locality.each { |l| l.to_xml builder }
+      builder.date date if date
+    end
+  end
+end

data/lib/relaton_iec/basic_block/dl.rb

@@ -0,0 +1,60 @@
+module BasicBlock
+  class Dl
+    #
+    # @param [String] id
+    # @param [Array<BasicBlock::Dl::Dt, BasicBlock::Dl::Dd>] content
+    # @param [Array<BasicBlock::Note>] note
+    #
+    def initialize(id:, content:, note:)
+      @id = id
+      @content = content
+      @note = note
+    end
+
+    #
+    # @param [Nokogiri::XML::Builder] builder
+    #
+    def to_xml(builder)
+      builder.dl id: @id do |b|
+        @content.each { |c| c.to_xml b }
+        @note.each { |n| n.to_xml b }
+      end
+    end
+
+    class Dt
+      #
+      # @param [Array<BasicBlock::TextElement>] content
+      #
+      def initialize(content)
+        @content = content
+      end
+
+      #
+      # @param [Nokogiri::XML::Builder] builder
+      #
+      def to_xml(builder)
+        builder.dt do |b|
+          @content.each { |c| c.to_xml b }
+        end
+      end
+    end
+
+    class Dd
+      #
+      # @param [Array<BasicBlock::ParagraphWithFootnote>] content
+      #
+      def initialize(content)
+        @content = content
+      end
+
+      #
+      # @param [Nokogiri::XML::Builder] builder
+      #
+      def to_xml(builder)
+        builder.dd do |b|
+          @content.each { |c| c.to_xml b }
+        end
+      end
+    end
+  end
+end

data/lib/relaton_iec/basic_block/eref.rb

@@ -0,0 +1,10 @@
+module RelatonIec
+  class Eref < RelatonIec::ErefType
+    #
+    # @param [Nokogiri::XML::Builder] builder
+    #
+    def to_xml(builder)
+      builder.eref { super }
+    end
+  end
+end

data/lib/relaton_iec/basic_block/eref_type.rb

@@ -0,0 +1,39 @@
+module RelatonIec
+  class ErefType < RelatonIec::CitationType
+    # @return [String]
+    attr_reader :citeas
+
+    # @return [RelatonIec::ReferenceFormat]
+    attr_reader :type
+
+    # @return [Boolean, nil]
+    attr_reader :normative
+
+    # @return [String, nil]
+    attr_reader :alt
+
+    # @param [String] citeas
+    # @param [RelatonIec::ReferenceFormat] type
+    # @param [Hash] args
+    # @option args [Boolean, nil] :normative
+    # @option args [String, nil] :alt
+    def initialize(citeas:, type:, bibitemid:, locality:, **args)
+      super bibitemid, locality, args[:date]
+      @citeas = citeas
+      @type = type
+      @normative = args[:normative]
+      @alt = args[:alt]
+    end
+
+    #
+    # @param [Nokogiri::XML::Builder] builder <description>
+    #
+    def to_xml(builder) # rubocop:disable Metrics/AbcSize
+      builder.parent[:normative] = normative unless normative.nil?
+      builder.parent[:citeas] = citeas
+      builder.parent[:type] = type
+      builder.parent[:alt] = alt if alt
+      super
+    end
+  end
+end

data/lib/relaton_iec/basic_block/formula.rb

@@ -0,0 +1,34 @@
+module BasicBlock
+  class Formula
+    #
+    # @param [String] id
+    # @param [BasicBlock::Stem] content
+    # @param [Array<BasicBlock::Note>] note
+    # @param [Hash] args
+    # @option args [Boolean, nil] :unnumbered
+    # @option args [String, nil] :subsequence
+    # @option args [Boolean, nil] :inequality
+    # @option args [BasicBlock::Dl, nil] :dl
+    #
+    def initialize(id:, content:, note:, **args)
+      @id = id
+      @content = content
+      @note = note
+      @unnumbered = args[:unnumbered]
+    end
+
+    #
+    # @param [Builder] builder
+    #
+    def to_xml(builder) # rubocop:disable Metrics/CyclomaticComplexity
+      f = builder.formula id: @id do |b|
+        @content.to_xml b
+        @dl&.each { |d| d.to_xml b }
+        @note.each { |n| n.to_xml b }
+      end
+      f[:unnumbered] = @unnumbered if @unnumbered
+      f[:subsequence] = @subsequence if @subsequence
+      f[:inequality] = @inequality if @ineainequality
+    end
+  end
+end

data/lib/relaton_iec/basic_block/image.rb

@@ -0,0 +1,41 @@
+module BasicBlock
+  class Image
+    #
+    # @param [String] id
+    # @param [String] src
+    # @param [String] mimetype
+    # @param [Hash] args
+    # @option args [String] :filename
+    #
+    def initialize(id:, src:, mimetype:, **args) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength
+      @id = id
+      @src = src
+      @mimetype = mimetype
+      @filename = args[:filename]
+      if args[:width] && !args[:width].is_a?(Integer) && args[:width] != "auto"
+        warn "[basic-block] WARNING: invalid image width attribute \"#{args[:width]}"
+        warn "[basic-block] image width should be integer or \"auto\""
+      end
+      if args[:height] && !args[:height].is_a?(Integer) && args[:height] != "auto"
+        warn "[basic-block] WARNING: invalid image height attribute \"#{args[:height]}"
+        warn "[basic-block] image height should be integer or \"auto\""
+      end
+      @width = args[:width]
+      @height = args[:height]
+      @alt = args[:alt]
+      @title = args[:title]
+      @longdesc = args[:longdesc]
+    end
+
+    # @param [Nokogiri::XML::Builder]
+    def to_xml(builder) # rubocop:disable Metrics/CyclomaticComplexity
+      img = builder.image id: @id, src: @src, mimetype: @mimetype
+      img[:filename] = @filename if @filename
+      img[:width] = @width if @width
+      img[:height] = @height if @height
+      img[:alt] = @alt if @alt
+      img[:title] = @title if @title
+      img[:longdesc] = @longdesc if @longdesc
+    end
+  end
+end