RubyGems - metanorma-standoc - Versions diffs - 2.1.5 → 2.2.1 - Mend

metanorma-standoc 2.1.5 → 2.2.1

Files changed (54) hide show

checksums.yaml +4 -4
data/lib/metanorma/standoc/base.rb +13 -0
data/lib/metanorma/standoc/blocks.rb +26 -17
data/lib/metanorma/standoc/cleanup.rb +1 -1
data/lib/metanorma/standoc/cleanup_biblio.rb +210 -0
data/lib/metanorma/standoc/cleanup_block.rb +6 -4
data/lib/metanorma/standoc/cleanup_maths.rb +2 -15
data/lib/metanorma/standoc/cleanup_ref.rb +22 -13
data/lib/metanorma/standoc/cleanup_reqt.rb +3 -103
data/lib/metanorma/standoc/cleanup_symbols.rb +1 -1
data/lib/metanorma/standoc/cleanup_text.rb +10 -8
data/lib/metanorma/standoc/cleanup_xref.rb +1 -2
data/lib/metanorma/standoc/converter.rb +2 -0
data/lib/metanorma/standoc/front.rb +1 -1
data/lib/metanorma/standoc/front_contributor.rb +0 -10
data/lib/metanorma/standoc/inline.rb +8 -4
data/lib/metanorma/standoc/isodoc.rng +6 -1
data/lib/metanorma/standoc/macros.rb +1 -180
data/lib/metanorma/standoc/macros_inline.rb +194 -0
data/lib/metanorma/standoc/ref_sect.rb +2 -2
data/lib/metanorma/standoc/ref_utility.rb +1 -1
data/lib/metanorma/standoc/reqt.rb +19 -75
data/lib/metanorma/standoc/reqt.rng +1 -1
data/lib/metanorma/standoc/section.rb +35 -3
data/lib/metanorma/standoc/utils.rb +9 -43
data/lib/metanorma/standoc/validate.rb +1 -69
data/lib/metanorma/standoc/validate_table.rb +91 -0
data/lib/metanorma/standoc/version.rb +1 -1
data/metanorma-standoc.gemspec +4 -5
data/spec/metanorma/{refs_dl_spec.rb → biblio_spec.rb} +90 -7
data/spec/metanorma/blocks_spec.rb +31 -267
data/spec/metanorma/cleanup_blocks_spec.rb +0 -171
data/spec/metanorma/inline_spec.rb +4 -0
data/spec/metanorma/macros_concept_spec.rb +1033 -0
data/spec/metanorma/macros_spec.rb +2 -1030
data/spec/metanorma/refs_spec.rb +0 -2
data/spec/metanorma/reqt_spec.rb +130 -0
data/spec/metanorma/section_spec.rb +5 -0
data/spec/metanorma/validate_spec.rb +46 -6
data/spec/vcr_cassettes/bsi16341.yml +80 -52
data/spec/vcr_cassettes/dated_iso_ref_joint_iso_iec.yml +94 -94
data/spec/vcr_cassettes/dated_iso_ref_joint_iso_iec1.yml +12 -12
data/spec/vcr_cassettes/hide_refs.yml +70 -70
data/spec/vcr_cassettes/isobib_get_123.yml +11 -11
data/spec/vcr_cassettes/isobib_get_123_1.yml +23 -23
data/spec/vcr_cassettes/isobib_get_123_1_fr.yml +35 -35
data/spec/vcr_cassettes/isobib_get_123_2.yml +22 -22
data/spec/vcr_cassettes/isobib_get_123_2001.yml +13 -13
data/spec/vcr_cassettes/isobib_get_124.yml +11 -11
data/spec/vcr_cassettes/rfcbib_get_rfc8341.yml +34 -64
data/spec/vcr_cassettes/separates_iev_citations_by_top_level_clause.yml +45 -45
data/spec/vcr_cassettes/std-link.yml +12 -12
metadata +15 -11
data/lib/metanorma/standoc/cleanup_ref_dl.rb +0 -113

data/lib/metanorma/standoc/section.rb CHANGED Viewed

@@ -10,19 +10,26 @@ module Metanorma
       @norm_ref = false
       def sectiontype1(node)
+        return "abstract" if node.attr("style") == "abstract"
         node&.attr("heading")&.downcase ||
-          node.title.gsub(%r{<index>.*?</index>}m, "").gsub(/<[^>]+>/, "")
+          node.title
+            .gsub(%r{<index>.*?</index>}m, "")
+            .gsub(%r{<fn[^>]*>.*?</fn>}m, "")
+            .gsub(/<[^>]+>/, "")
             .strip.downcase
+            .sub(/\.$/, "")
       end
       def sectiontype(node, level = true)
         ret = sectiontype1(node)
-        ret1 = sectiontype_streamline(ret)
+        ret1 = preface_main_filter(sectiontype_streamline(ret), node)
         return ret1 if ret1 == "symbols and abbreviated terms"
         return nil unless !level || node.level == 1
         return nil if @seen_headers.include? ret
-        @seen_headers << ret
+        @seen_headers << ret unless ret1.nil?
+        @seen_headers_canonical << ret1 unless ret1.nil?
         ret1
       end
@@ -45,6 +52,31 @@ module Metanorma
         end
       end
+      PREFACE_CLAUSE_NAMES = %w(abstract foreword introduction
+                                acknowledgements).freeze
+      MAIN_CLAUSE_NAMES =
+        ["normative references", "terms and definitions", "scope",
+         "symbols and abbreviated terms", "clause", "bibliography"].freeze
+      def start_main_section(ret, node)
+        @preface = false if MAIN_CLAUSE_NAMES.include?(ret) &&
+          node.role != "preface" && node.attr("style") != "preface"
+        @preface = false if (PREFACE_CLAUSE_NAMES)
+          .intersection(@seen_headers_canonical + [ret]).empty?
+      end
+      def preface_main_filter(ret, node)
+        start_main_section(ret, node)
+        if @preface
+          self.class::MAIN_CLAUSE_NAMES.include?(ret) and return nil
+        else
+          self.class::PREFACE_CLAUSE_NAMES.include?(ret) and return nil
+        end
+        ret
+      end
       def section_attributes(node)
         ret = { id: Metanorma::Utils::anchor_or_uuid(node),
                 language: node.attributes["language"],

data/lib/metanorma/standoc/utils.rb CHANGED Viewed

@@ -17,43 +17,20 @@ module Metanorma
         nil
       end
-      NOKOHEAD = <<~HERE.freeze
-        <!DOCTYPE html SYSTEM
-        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-        <html xmlns="http://www.w3.org/1999/xhtml">
-        <head> <title></title> <meta charset="UTF-8" /> </head>
-        <body> </body> </html>
-      HERE
-      # block for processing XML document fragments as XHTML,
-      # to allow for HTMLentities
-      # Unescape special chars used in Asciidoctor substitution processing
       def noko(&block)
-        doc = ::Nokogiri::XML.parse(NOKOHEAD)
-        fragment = doc.fragment("")
-        ::Nokogiri::XML::Builder.with fragment, &block
-        fragment.to_xml(encoding: "US-ASCII", indent: 0,
-                        save_with: Nokogiri::XML::Node::SaveOptions::AS_XML)
-          .lines.map do |l|
-          l.gsub(/>\n$/, ">").gsub(/\s*\n$/m, " ").gsub("&#150;", "\u0096")
-            .gsub("&#151;", "\u0097").gsub("&#x96;", "\u0096")
-            .gsub("&#x97;", "\u0097")
-        end
+        Metanorma::Utils::noko(&block)
       end
       def attr_code(attributes)
-        attributes.compact.transform_values do |v|
-          v.is_a?(String) ? HTMLEntities.new.decode(v) : v
-        end
+        Metanorma::Utils::attr_code(attributes)
+      end
+      def csv_split(text, delim = ";")
+        Metanorma::Utils::csv_split(text, delim)
       end
-      # if the contents of node are blocks, output them to out;
-      # else, wrap them in <p>
       def wrap_in_para(node, out)
-        if node.blocks? then out << node.content
-        else
-          out.p { |p| p << node.content }
-        end
+        Metanorma::Utils::wrap_in_para(node, out)
       end
       SUBCLAUSE_XPATH = "//clause[not(parent::sections)]"\
@@ -67,22 +44,11 @@ module Metanorma
       end
       def dl_to_attrs(elem, dlist, name)
-        e = dlist.at("./dt[text()='#{name}']") or return
-        val = e.at("./following::dd/p") || e.at("./following::dd") or return
-        elem[name] = val.text
+        Metanorma::Utils::dl_to_attrs(elem, dlist, name)
       end
       def dl_to_elems(ins, elem, dlist, name)
-        a = elem.at("./#{name}[last()]")
-        ins = a if a
-        dlist.xpath("./dt[text()='#{name}']").each do |e|
-          v = e.at("./following::dd")
-          e = v.elements and e.size == 1 && e.first.name == "p" and v = e.first
-          v.name = name
-          ins.next = v
-          ins = ins.next
-        end
-        ins
+        Metanorma::Utils::dl_to_elems(ins, elem, dlist, name)
       end
       def term_expr(elem)

data/lib/metanorma/standoc/validate.rb CHANGED Viewed

@@ -1,5 +1,6 @@
 require "metanorma/standoc/utils"
 require_relative "./validate_section"
+require_relative "./validate_table"
 require "nokogiri"
 require "jing"
 require "iev"
@@ -53,75 +54,6 @@ module Metanorma
         @fatalerror.empty? or clean_abort(@fatalerror.join("\n"), doc.to_xml)
       end
-      def table_validate(doc)
-        doc.xpath("//table[colgroup]").each do |t|
-          maxrowcols_validate(t, t.xpath("./colgroup/col").size)
-        end
-        doc.xpath("//table[.//*[@colspan] | .//*[@rowspan]]").each do |t|
-          maxrowcols_validate(t, max_td_count(t))
-        end
-      end
-      def max_td_count(table)
-        max = 0
-        table.xpath("./tr").each do |tr|
-          n = tr.xpath("./td | ./th").size
-          max < n and max = n
-        end
-        max
-      end
-      def maxrowcols_validate(table, maxcols)
-        cells2d = table.xpath("./*/tr").each_with_object([]) { |_r, m| m << {} }
-        table.xpath("./*/tr").each_with_index do |tr, r|
-          curr = 0
-          tr.xpath("./td | ./th").each do |td|
-            curr = maxcols_validate1(td, r, curr, cells2d, maxcols)
-          end
-        end
-        maxrows_validate(table, cells2d)
-      end
-      # code doesn't actually do anything, since Asciidoctor refuses to generate
-      # table with inconsistent column count
-      def maxcols_validate1(tcell, row, curr, cells2d, maxcols)
-        rs = tcell&.attr("rowspan")&.to_i || 1
-        cs = tcell&.attr("colspan")&.to_i || 1
-        curr = table_tracker_update(cells2d, row, curr, rs, cs)
-        maxcols_check(curr + cs - 1, maxcols, tcell)
-        curr + cs
-      end
-      def table_tracker_update(cells2d, row, curr, rowspan, colspan)
-        cells2d[row] ||= {}
-        while cells2d[row][curr]
-          curr += 1
-        end
-        (row..(row + rowspan - 1)).each do |y2|
-          cells2d[y2] ||= {}
-          (curr..(curr + colspan - 1)).each { |x2| cells2d[y2][x2] = 1 }
-        end
-        curr
-      end
-      def maxrows_validate(table, cells2d)
-        if cells2d.any? { |x| x.size != cells2d.first.size }
-          @log.add("Table", table,
-                   "Table rows in table are inconsistent: check rowspan")
-          @fatalerror << "Table rows in table are inconsistent: check rowspan"
-        end
-      end
-      # if maxcols or maxrows negative, do not check them
-      def maxcols_check(col, maxcols, tcell)
-        if maxcols.positive? && col > maxcols
-          @log.add("Table", tcell, "Table exceeds maximum number of columns "\
-                                   "defined (#{maxcols})")
-          @fatalerror << "Table exceeds maximum number of columns defined "\
-                         "(#{maxcols})"
-        end
-      end
       def norm_ref_validate(doc)
         found = false
         doc.xpath("//references[@normative = 'true']/bibitem").each do |b|

data/lib/metanorma/standoc/validate_table.rb ADDED Viewed

@@ -0,0 +1,91 @@
+module Metanorma
+  module Standoc
+    module Validate
+      def table_validate(doc)
+        doc.xpath("//table[colgroup]").each do |t|
+          maxrowcols_validate(t, t.xpath("./colgroup/col").size)
+        end
+        doc.xpath("//table[.//*[@colspan] | .//*[@rowspan]]").each do |t|
+          maxrowcols_validate(t, max_td_count(t), mode: "row_cols")
+        end
+        doc.xpath("//table[.//*[@rowspan]]").each do |t|
+          maxrowcols_validate(t, max_td_count(t), mode: "thead_row")
+        end
+      end
+      def max_td_count(table)
+        max = 0
+        table.xpath("./tr").each do |tr|
+          n = tr.xpath("./td | ./th").size
+          max < n and max = n
+        end
+        max
+      end
+      def maxrowcols_validate(table, maxcols, mode: "row_cols")
+        case mode
+        when "row_cols"
+          maxrowcols_validate0(table, maxcols, "*", mode)
+        when "thead_row"
+          %w{thead tbody tfoot}.each do |w|
+            maxrowcols_validate0(table, maxcols, w, mode)
+          end
+        end
+      end
+      def maxrowcols_validate0(table, maxcols, tablechild, mode)
+        cells2d = table.xpath("./#{tablechild}/tr")
+          .each_with_object([]) { |_r, m| m << {} }
+        table.xpath("./#{tablechild}/tr").each_with_index do |tr, r|
+          curr = 0
+          tr.xpath("./td | ./th").each do |td|
+            curr = maxcols_validate1(td, r, curr, cells2d, maxcols, mode)
+          end
+        end
+        maxrows_validate(table, cells2d, tablechild, mode)
+      end
+      # code doesn't actually do anything, since Asciidoctor refuses to generate
+      # table with inconsistent column count
+      def maxcols_validate1(tcell, row, curr, cells2d, maxcols, mode)
+        rs = tcell&.attr("rowspan")&.to_i || 1
+        cs = tcell&.attr("colspan")&.to_i || 1
+        curr = table_tracker_update(cells2d, row, curr, rs, cs)
+        maxcols_check(curr + cs - 1, maxcols, tcell) if mode == "row_cols"
+        curr + cs
+      end
+      def table_tracker_update(cells2d, row, curr, rowspan, colspan)
+        cells2d[row] ||= {}
+        while cells2d[row][curr]
+          curr += 1
+        end
+        (row..(row + rowspan - 1)).each do |y2|
+          cells2d[y2] ||= {}
+          (curr..(curr + colspan - 1)).each { |x2| cells2d[y2][x2] = 1 }
+        end
+        curr
+      end
+      def maxrows_validate(table, cells2d, tablechild, mode)
+        err = "are inconsistent"
+        mode == "thead_row" and err = "cannot go outside #{tablechild}"
+        err = "Table rows in table #{err}: check rowspan"
+        if cells2d.any? { |x| x.size != cells2d.first.size }
+          @log.add("Table", table, err)
+          @fatalerror << err
+        end
+      end
+      # if maxcols or maxrows negative, do not check them
+      def maxcols_check(col, maxcols, tcell)
+        if maxcols.positive? && col > maxcols
+          @log.add("Table", tcell, "Table exceeds maximum number of columns "\
+                                   "defined (#{maxcols})")
+          @fatalerror << "Table exceeds maximum number of columns defined "\
+                         "(#{maxcols})"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/version.rb CHANGED Viewed

@@ -19,6 +19,6 @@ module Metanorma
   end
   module Standoc
-    VERSION = "2.1.5".freeze
+    VERSION = "2.2.1".freeze
   end
 end

data/metanorma-standoc.gemspec CHANGED Viewed

@@ -23,12 +23,11 @@ Gem::Specification.new do |spec|
   spec.bindir        = "bin"
   spec.require_paths = ["lib"]
   spec.files         = `git ls-files`.split("\n")
-  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "iev", "~> 0.3.0"
-  spec.add_dependency "isodoc", "~> 2.1.0"
+  spec.add_dependency "isodoc", "~> 2.2.0"
   spec.add_dependency "metanorma-plugin-datastruct", "~> 0.2.0"
   spec.add_dependency "metanorma-plugin-lutaml"
   spec.add_dependency "ruby-jing"
@@ -37,8 +36,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "latexmath"
   spec.add_dependency "mathml2asciimath"
-  spec.add_dependency "metanorma-utils", "~> 1.2.8"
-  spec.add_dependency "relaton-cli", "~> 1.12.0"
+  spec.add_dependency "mn-requirements", "~> 0.0.1"
+  spec.add_dependency "relaton-cli", "~> 1.13.0"
   spec.add_dependency "relaton-iev", "~> 1.1.0"
   spec.add_dependency "unicode2latex", "~> 0.0.1"
@@ -55,5 +54,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "timecop", "~> 0.9"
   spec.add_development_dependency "vcr", "~> 6.1.0"
   spec.add_development_dependency "webmock"
-  #spec.metadata["rubygems_mfa_required"] = "true"
+  # spec.metadata["rubygems_mfa_required"] = "true"
 end

data/spec/metanorma/{refs_dl_spec.rb → biblio_spec.rb} RENAMED Viewed

@@ -235,7 +235,7 @@ RSpec.describe Metanorma::Standoc do
       person::
         name:::
           language:::: en
-          initial:::: A.
+          formatted_initials:::: A.
           surname:::: Bierman
         affiliation:::
       +
@@ -377,8 +377,8 @@ RSpec.describe Metanorma::Standoc do
           <role type="author"/>
           <person>
             <name>
-              <initial language="en">A.</initial>
-              <surname language="en">Bierman</surname>
+              <formatted-initials>A.</formatted-initials>
+              <surname>Bierman</surname>
             </name>
             <affiliation>
               <description language="en" script="Latn">Affiliation description</description>
@@ -590,7 +590,7 @@ RSpec.describe Metanorma::Standoc do
       contributor.role:: publisher
       contributor::
       contributor.person.name.language:: en
-      contributor.person.name.initial:: A.
+      contributor.person.name.formatted_initials:: A.
       contributor.person.name.surname:: Bierman
       contributor.person.affiliation.organization.name:: IETF
       contributor.person.affiliation.organization.abbreviation:: IETF
@@ -706,8 +706,8 @@ RSpec.describe Metanorma::Standoc do
           <role type="author"/>
           <person>
             <name>
-              <initial language="en">A.</initial>
-              <surname language="en">Bierman</surname>
+              <formatted-initials>A.</formatted-initials>
+              <surname>Bierman</surname>
             </name>
             <affiliation>
               <description language="en" script="Latn">Affiliation description</description>
@@ -840,7 +840,7 @@ RSpec.describe Metanorma::Standoc do
     INPUT
     output = <<~OUTPUT
-                #{BLANK_HDR}
+      #{BLANK_HDR}
            <sections>
          <clause id='_' inline-header='false' obligation='normative'>
            <title>Section</title>
@@ -888,4 +888,87 @@ RSpec.describe Metanorma::Standoc do
     expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
       .to be_equivalent_to xmlpp(output)
   end
+  it "processes microformatting of formatted references" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+      [bibliography]
+      === Normative References
+      * [[[A, B]]], span:surname[Wozniak], span:initials[S.] & span:givenname[Steve] span:surname[Jobs]. span:pubyear[1996]. span:title[_Work_]. In span:surname.editor[Gates], span:initials.editor[W. H], Collected Essays. span:docid.ISO[ISO 1234]. span:pubplace[Geneva]: span:publisher[International Standardization Organization]. span:uri.citation[http://www.example.com]. span:type[inbook]
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+         <sections> </sections>
+         <bibliography>
+           <references id='_' normative='true' obligation='informative'>
+             <title>Normative references</title>
+             <p id='_'>
+               The following documents are referred to in the text in such a way that
+               some or all of their content constitutes requirements of this document.
+               For dated references, only the edition cited applies. For undated
+               references, the latest edition of the referenced document (including any
+               amendments) applies.
+             </p>
+             <bibitem id='A' type="inbook">
+               <formattedref format='application/x-isodoc+xml'>
+                 Wozniak, S. &amp; Steve Jobs. 1996.
+                 <em>Work</em>
+                 . In Gates, W. H, Collected Essays. ISO 1234. Geneva: International
+                 Standardization Organization.
+                 <link target='http://www.example.com'/>
+                 .
+               </formattedref>
+               <title>
+                 <em>Work</em>
+               </title>
+               <uri type='citation'>
+                 <link target='http://www.example.com'/>
+               </uri>
+               <docidentifier>B</docidentifier>
+               <docidentifier type='ISO'>ISO 1234</docidentifier>
+               <date type='published'>1996</date>
+               <contributor>
+                 <role type='author'/>
+                 <person>
+                   <name>
+                     <formatted-initials>S.</formatted-initials>
+                     <surname>Wozniak</surname>
+                   </name>
+                 </person>
+               </contributor>
+               <contributor>
+                 <role type='author'/>
+                 <person>
+                   <name>
+                     <forename>Steve</forename>
+                     <surname>Jobs</surname>
+                   </name>
+                 </person>
+               </contributor>
+               <contributor>
+                 <role type='editor'/>
+                 <person>
+                   <name>
+                     <formatted-initials>W. H</formatted-initials>
+                     <surname>Gates</surname>
+                   </name>
+                 </person>
+               </contributor>
+               <contributor>
+                 <role type='publisher'/>
+                 <organization>
+                   <name>International Standardization Organization</name>
+                 </organization>
+               </contributor>
+               <place/>
+             </bibitem>
+           </references>
+         </bibliography>
+       </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
 end