metanorma-standoc 1.6.4 → 1.7.3

data/lib/asciidoctor/standoc/ref.rb

@@ -1,6 +1,6 @@
 module Asciidoctor
   module Standoc
-    module Lists
+    module Refs
       def iso_publisher(t, code)
         code.sub(/ .*$/, "").split(/\//).each do |abbrev|
           t.contributor do |c|
@@ -70,8 +70,7 @@ module Asciidoctor
 
       def isorefmatches(xml, m)
         yr = norm_year(m[:year])
-        ref = fetch_ref xml, m[:code], yr, title: m[:text], usrlbl: m[:usrlbl],
-          lang: (@lang || :all)
+        ref = fetch_ref xml, m[:code], yr, title: m[:text], usrlbl: m[:usrlbl], lang: (@lang || :all)
         return use_my_anchor(ref, m[:anchor]) if ref
         xml.bibitem **attr_code(ref_attributes(m)) do |t|
           isorefrender1(t, m, yr)
@@ -105,8 +104,7 @@ module Asciidoctor
       def conditional_date(t, m, noyr)
         m.names.include?("year") and !m[:year].nil? and
           t.date(**{ type: "published" }) do |d|
-          noyr and d.on "--" or
-            set_date_range(d, norm_year(m[:year]))
+          noyr and d.on "--" or set_date_range(d, norm_year(m[:year]))
         end
       end
 
@@ -114,8 +112,7 @@ module Asciidoctor
         yr = norm_year(m[:year])
         hasyr = !yr.nil? && yr != "--"
         ref = fetch_ref xml, m[:code], hasyr ? yr : nil, all_parts: true, 
-          no_year: yr == "--", text: m[:text], usrlbl: m[:usrlbl],
-          lang: (@lang || :all)
+          no_year: yr == "--", text: m[:text], usrlbl: m[:usrlbl], lang: (@lang || :all)
         return use_my_anchor(ref, m[:anchor]) if ref
         isorefmatches3_1(xml, m, yr, hasyr, ref)
       end
@@ -140,8 +137,7 @@ module Asciidoctor
         end
         docid(t, m[:usrlbl]) if m[:usrlbl]
         docid(t, /^\d+$/.match(code[:id]) ? "[#{code[:id]}]" : code[:id])
-        code[:type] == "repo" and
-          t.docidentifier code[:key], **{ type: "repository" }
+        code[:type] == "repo" and t.docidentifier code[:key], **{ type: "repository" }
       end
 
       def refitem_render(xml, m, code)
@@ -155,9 +151,8 @@ module Asciidoctor
       end
 
       MALFORMED_REF = "no anchor on reference, markup may be malformed: see "\
-        "https://www.metanorma.com/author/topics/document-format/"\
-        "bibliography/ , https://www.metanorma.com/author/iso/topics/markup/"\
-        "#bibliographies".freeze
+        "https://www.metanorma.com/author/topics/document-format/bibliography/ , "\
+        "https://www.metanorma.com/author/iso/topics/markup/#bibliographies".freeze
 
       def analyse_ref_nofetch(ret)
         return ret unless m = /^nofetch\((?<id>.+)\)$/.match(ret[:id])
@@ -165,9 +160,8 @@ module Asciidoctor
       end
 
       def analyse_ref_repo_path(ret)
-        return ret unless m =
-          /^(?<type>repo|path):\((?<key>[^,]+),?(?<id>.*)\)$/.match(ret[:id])
-        id = m[:id].empty? ? m[:key].sub(%r{^[^/]+/}, "")  : m[:id]
+        return ret unless m = /^(?<type>repo|path):\((?<key>[^,]+),?(?<id>.*)\)$/.match(ret[:id])
+        id = m[:id].empty? ? m[:key].sub(%r{^[^/]+/}, "") : m[:id]
         ret.merge(id: id, type: m[:type], key: m[:key], nofetch: true)
       end
 
@@ -194,8 +188,7 @@ module Asciidoctor
       def refitem1(xml, item, m)
         code = analyse_ref_code(m[:code])
         unless code[:id] && code[:numeric] || code[:nofetch]
-          ref = fetch_ref xml, code[:id],
-            m.names.include?("year") ? m[:year] : nil, title: m[:text],
+          ref = fetch_ref xml, code[:id], m.names.include?("year") ? m[:year] : nil, title: m[:text],
             usrlbl: m[:usrlbl], lang: (@lang || :all)
           return use_my_anchor(ref, m[:anchor]) if ref
         end
@@ -212,8 +205,7 @@ module Asciidoctor
 
       ISO_REF = %r{^<ref\sid="(?<anchor>[^"]+)">
       \[(?<usrlbl>\([^)]+\))?(?<code>(ISO|IEC)[^0-9]*\s[0-9-]+|IEV)
-      (:(?<year>[0-9][0-9-]+))?\]</ref>,?\s*
-        (?<text>.*)$}xm
+      (:(?<year>[0-9][0-9-]+))?\]</ref>,?\s*(?<text>.*)$}xm
 
         ISO_REF_NO_YEAR = %r{^<ref\sid="(?<anchor>[^"]+)">
       \[(?<usrlbl>\([^)]+\))?(?<code>(ISO|IEC)[^0-9]*\s[0-9-]+):
@@ -239,8 +231,7 @@ module Asciidoctor
 
         def reference1(node, item, xml)
           matched, matched2, matched3 = reference1_matches(item)
-          if matched3.nil? && matched2.nil? && matched.nil?
-            refitem(xml, item, node)
+          if matched3.nil? && matched2.nil? && matched.nil? then refitem(xml, item, node)
           elsif !matched.nil? then isorefmatches(xml, matched)
           elsif !matched2.nil? then isorefmatches2(xml, matched2)
           elsif !matched3.nil? then isorefmatches3(xml, matched3)

data/lib/asciidoctor/standoc/section.rb

@@ -14,8 +14,7 @@ module Asciidoctor
       end
 
       def sectiontype1(node)
-        node&.attr("heading")&.downcase ||
-          node.title.gsub(/<[^>]+>/, "").downcase
+        node&.attr("heading")&.downcase || node.title.gsub(/<[^>]+>/, "").downcase
       end
 
       def sectiontype(node, level = true)
@@ -47,15 +46,13 @@ module Asciidoctor
 
       def section_attributes(node)
         ret = { id: Utils::anchor_or_uuid(node),
-          language: node.attributes["language"],
-          script: node.attributes["script"],
-          annex: (
-            ((node.attr("style") == "appendix" || node.role == "appendix") && 
-             node.level == 1) ? true : nil
-          ),
-          preface: (
-            (node.role == "preface" || node.attr("style") == "preface") ?
-            true : nil) }
+                language: node.attributes["language"],
+                script: node.attributes["script"],
+                number: node.attributes["number"],
+                annex: ( ((node.attr("style") == "appendix" || node.role == "appendix") && 
+                          node.level == 1) ? true : nil),
+                         preface: (
+                           (node.role == "preface" || node.attr("style") == "preface") ?  true : nil) }
         return ret unless node.attributes["change"]
         ret.merge(change: node.attributes["change"],
                   path: node.attributes["path"],
@@ -105,9 +102,9 @@ module Asciidoctor
 
       def set_obligation(attrs, node)
         attrs[:obligation] = node.attributes.has_key?("obligation") ?
-                               node.attr("obligation") :
-                             node.parent.attributes.has_key?("obligation") ?
-                               node.parent.attr("obligation") : "normative"
+          node.attr("obligation") :
+          node.parent.attributes.has_key?("obligation") ?
+          node.parent.attr("obligation") : "normative"
       end
 
       def preamble(node)
@@ -187,18 +184,23 @@ module Asciidoctor
         @term_def = defs
       end
 
+      def terms_boilerplate_parse(attrs, xml, node)
+        defs = @term_def
+        @term_def = false
+        clause_parse(attrs.merge(type: "boilerplate"), xml, node)
+        @term_def = defs
+      end
+
       # subclause contains subclauses
       def term_def_subclause_parse(attrs, xml, node)
-        node.role == "nonterm"  and
-          return nonterm_term_def_subclause_parse(attrs, xml, node)
+        node.role == "nonterm"  and return nonterm_term_def_subclause_parse(attrs, xml, node)
+        node.role == "boilerplate"  and return terms_boilerplate_parse(attrs, xml, node)
         st = sectiontype(node, false)
         return symbols_parse(attrs, xml, node) if @definitions
         sub = node.find_by(context: :section) { |s| s.level == node.level + 1 }
         sub.empty? || (return term_def_parse(attrs, xml, node, false))
-        st == "symbols and abbreviated terms" and
-          (return symbols_parse(attrs, xml, node))
-        st == "terms and definitions" and
-          return clause_parse(attrs, xml, node)
+        st == "symbols and abbreviated terms" and (return symbols_parse(attrs, xml, node))
+        st == "terms and definitions" and return clause_parse(attrs, xml, node)
         term_def_subclause_parse1(attrs, xml, node)
       end
 

data/lib/asciidoctor/standoc/table.rb

@@ -17,6 +17,7 @@ module Asciidoctor
         @table_fn_number = "a"
         noko do |xml|
           xml.table **attr_code(table_attrs(node)) do |xml_table|
+            colgroup(node, xml_table)
             table_name(node, xml_table)
             %i(head body foot).reject do |tblsec|
               node.rows[tblsec].empty?
@@ -28,6 +29,17 @@ module Asciidoctor
 
       private
 
+      def colgroup(node, xml_table)
+        return if node.option? "autowidth"
+        cols = node&.attr("cols")&.split(/,/) or return
+        return unless cols.size > 1 and cols.all? { |c| /\d/.match(c) }
+        xml_table.colgroup do |cg|
+          node.columns.each do |col|
+            cg.col **{ width: "#{col.attr 'colpcwidth'}%" }
+          end
+        end
+      end
+
       def table_name(node, xml_table)
         if node.title?
           xml_table.name do |n|

data/lib/asciidoctor/standoc/term_lookup_cleanup.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true.
+
+module Asciidoctor
+  module Standoc
+    # Intelligent term lookup xml modifier
+    # Lookup all `term` and `calause` tags and replace `termxref` tags with
+    # `xref`:target tag
+    class TermLookupCleanup
+      AUTOMATIC_GENERATED_ID_REGEXP = /\A_/
+      EXISTING_TERM_REGEXP = /\Aterm-/
+
+      attr_reader :xmldoc, :termlookup, :log
+
+      def initialize(xmldoc, log)
+        @xmldoc = xmldoc
+        @log = log
+        @termlookup = {}
+      end
+
+      def call
+        @termlookup = replace_automatic_generated_ids_terms
+        set_termxref_tags_target
+      end
+
+      private
+
+      def set_termxref_tags_target
+        xmldoc.xpath('//termxref').each do |node|
+          target = normalize_ref_id(node.text)
+          if termlookup[target].nil?
+            remove_missing_ref(node, target)
+            next
+          end
+          modify_ref_node(node, target)
+        end
+      end
+
+      def remove_missing_ref(node, target)
+        log.add('AsciiDoc Input', node,
+                %(Error: Term reference in `term[#{target}]` missing: \
+                "#{target}" is not defined in document))
+        term_name_node = node.previous.previous
+        term_name_node.remove
+        term_name_node.name = "strong"
+        term_name_node.children.first.content =
+          %(term "#{term_name_node.text}" not resolved)
+        node.add_previous_sibling(term_name_node)
+        node.remove
+      end
+
+      def modify_ref_node(node, target)
+        node.name = 'xref'
+        node['target'] = termlookup[target]
+        node.children.remove
+        node.remove_attribute('defaultref')
+      end
+
+      def replace_automatic_generated_ids_terms
+        xmldoc.xpath('//term').each.with_object({}) do |term_node, res|
+          normalize_id_and_memorize(term_node, res, './preferred')
+        end
+      end
+
+      def normalize_id_and_memorize(term_node, res_table, text_selector)
+        term_text = normalize_ref_id(term_node.at(text_selector).text)
+                  unless AUTOMATIC_GENERATED_ID_REGEXP.match(term_node['id']).nil?
+        term_node['id'] = unique_text_id(term_text)
+                  end
+        res_table[term_text] = term_node['id']
+      end
+
+      def normalize_ref_id(text)
+        text.downcase.gsub(/[[:space:]]/, '-')
+      end
+
+      def unique_text_id(text)
+        return "term-#{text}" if xmldoc.at("//*[@id = 'term-#{text}']").nil?
+        (1..Float::INFINITY).lazy.each do |index|
+          if xmldoc.at("//*[@id = 'term-#{text}-#{index}']").nil?
+            break("term-#{text}-#{index}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/utils.rb

@@ -31,8 +31,10 @@ module Asciidoctor
           docfile.nil? ? './' : Pathname.new(docfile).parent.to_s + '/'
         end
 
+        # TODO needs internationalisation
         def smartformat(n)
           n.gsub(/ --? /, " — ").
+            gsub(/\'(\d\d)(?=[^\u2019\'\s<]+[’\'][\p{P}\p{Z}])([\p{P}\p{Z}])/, "\u2018\\1\\2").
             gsub(/--/, "&#8212;").smart_format.gsub(/</, "&lt;").gsub(/>/, "&gt;")
         end
 

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "1.6.4".freeze
+    VERSION = "1.7.3".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "ruby-jing"
-  spec.add_dependency "isodoc", "~> 1.3.0"
+  spec.add_dependency "isodoc", "~> 1.4.2"
   spec.add_dependency "iev", "~> 0.2.1"
   spec.add_dependency "metanorma-plugin-datastruct"
   spec.add_dependency "metanorma-plugin-lutaml", "~> 0.2.1"
@@ -41,7 +41,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mimemagic"
   spec.add_dependency "mathml2asciimath"
   spec.add_dependency "latexmath"
-  spec.add_dependency "fontist", "~> 1.5.0"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "sassc", "2.4.0"

data/spec/asciidoctor-standoc/base_spec.rb

@@ -40,7 +40,7 @@ RSpec.describe Asciidoctor::Standoc do
       :docfile: test.adoc
       :nodoc:
       :novalid:
-      :publisher: International Electrotechnical Commission,IETF,ISO
+      :publisher: International Electrotechnical Commission;IETF;ISO
 INPUT
 <standard-document xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Standoc::VERSION}'>
   <bibdata type='standard'>
@@ -91,7 +91,7 @@ INPUT
       <stage>published</stage>
     </status>
     <copyright>
-      <from>2020</from>
+      <from>#{Time.now.year}</from>
       <owner>
         <organization>
           <name>International Electrotechnical Commission</name>
@@ -100,7 +100,7 @@ INPUT
       </owner>
     </copyright>
     <copyright>
-      <from>2020</from>
+      <from>#{Time.now.year}</from>
       <owner>
         <organization>
           <name>IETF</name>
@@ -108,7 +108,7 @@ INPUT
       </owner>
     </copyright>
     <copyright>
-      <from>2020</from>
+      <from>#{Time.now.year}</from>
       <owner>
         <organization>
           <name>International Standards Organization</name>
@@ -181,6 +181,7 @@ OUTPUT
       :role: author
       :affiliation: Slate Rock and Gravel Company
       :affiliation_abbrev: SRG
+      :affiliation_subdiv: Hermeneutics Unit; Exegetical Subunit
       :address: 6 Rubble Way, Bedrock
       :contributor-uri: http://slate.example.com
       :phone: 123
@@ -191,13 +192,14 @@ OUTPUT
       :role_2: editor
       :affiliation_2: Rockhead and Quarry Cave Construction Company
       :affiliation_abbrev_2: RQCCC
+      :affiliation_subdiv_2: Hermeneutics Unit; Exegetical Subunit
       :address_2: 6A Rubble Way, + \\
       Bedrock
       :email_2: barney@rockhead.example.com
       :phone_2: 789
       :fax_2: 012
-      :publisher: "Hanna Barbera", "Cartoon Network", "Ribose, Inc."
-      :copyright-holder: "Ribose, Inc.", Hanna Barbera
+      :publisher: "Hanna Barbera"; "Cartoon Network"; "Ribose, Inc."
+      :copyright-holder: "Ribose, Inc."; Hanna Barbera
       :part-of: ABC
       :translated-from: DEF,GHI;JKL MNO,PQR
       :keywords: a, b, c
@@ -288,6 +290,8 @@ OUTPUT
    <organization>
      <name>Slate Rock and Gravel Company</name>
      <abbreviation>SRG</abbreviation>
+     <subdivision>Hermeneutics Unit</subdivision>
+<subdivision>Exegetical Subunit</subdivision>
   <address>
   <formattedAddress>
   6 Rubble Way, Bedrock
@@ -312,6 +316,8 @@ OUTPUT
   <organization>
     <name>Rockhead and Quarry Cave Construction Company</name>
     <abbreviation>RQCCC</abbreviation>
+    <subdivision>Hermeneutics Unit</subdivision>
+<subdivision>Exegetical Subunit</subdivision>
   <address>
     <formattedAddress>6A Rubble Way, <br/>Bedrock</formattedAddress>
   </address>
@@ -425,7 +431,7 @@ OUTPUT
       :tc-docnumber: 2000
       :language: el
       :script: Grek
-      :publisher: IEC,IETF,ISO
+      :publisher: IEC;IETF;ISO
       :uri: A
       :xml-uri: B
       :html-uri: C
@@ -623,7 +629,7 @@ OUTPUT
       <stage>published</stage>
     </status>
     <copyright>
-      <from>2020</from>
+      <from>#{Time.now.year}</from>
       <owner>
         <organization>
           <name>International Standards Organization</name>

data/spec/asciidoctor-standoc/blocks_spec.rb

@@ -318,7 +318,7 @@ RSpec.describe Asciidoctor::Standoc do
          <terms id="_" obligation="normative">
          <title>Terms and definitions</title>
          <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
-         <term id="_">
+         <term id="term-term1">
          <preferred>Term1</preferred>
          <termnote id="_">
          <p id="_">This is a note</p>
@@ -340,7 +340,9 @@ RSpec.describe Asciidoctor::Standoc do
 
       NOTE: This is not a termnote
 
-      EXAMPLE: This is not a termexample
+      ====
+      This is not a termexample
+      ====
 
       [.nonterm]
       === Term1
@@ -355,6 +357,9 @@ RSpec.describe Asciidoctor::Standoc do
          <note id='_'>
   <p id='_'>This is not a termnote</p>
 </note>
+  <example id='_'>
+  <p id='_'>This is not a termexample</p>
+</example>
   <clause id="_" inline-header="false" obligation="normative">
   <title>Term1</title>
   <note id="_">
@@ -383,7 +388,7 @@ RSpec.describe Asciidoctor::Standoc do
               <sections>
   <terms id="_" obligation="normative"><title>Terms, definitions and symbols</title>
 <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
-<term id="_">
+<term id="term-term1">
   <preferred>Term1</preferred>
 </term>
 <definitions id="_" obligation="normative" type="symbols">
@@ -528,7 +533,7 @@ RSpec.describe Asciidoctor::Standoc do
   <terms id="_" obligation="normative">
   <title>Terms and definitions</title>
 <p id="_">For the purposes of this document, the following terms and definitions apply.</p>
-  <term id="_">
+  <term id="term-term1">
   <preferred>Term1</preferred>
 
 <termexample id="ABC">
@@ -583,7 +588,7 @@ RSpec.describe Asciidoctor::Standoc do
               #{BLANK_HDR}
 <sections> 
   <terms id="_" obligation="normative"><title>Terms, definitions and symbols</title>
-<p id="_">For the purposes of this document, the following terms and definitions apply.</p><term id="_">   
+<p id="_">For the purposes of this document, the following terms and definitions apply.</p><term id="term-term1">   
   <preferred>Term1</preferred>   
 </term>  
 <definitions id="_" obligation="normative" type="symbols">   
@@ -972,7 +977,7 @@ RSpec.describe Asciidoctor::Standoc do
          <terms id="_" obligation="normative">
          <title>Terms and definitions</title><p id="_">For the purposes of this document,
        the following terms and definitions apply.</p>
-         <term id="_">
+         <term id="term-term1">
          <preferred>Term1</preferred>
          <termsource status="identical">
          <origin bibitemid="ISO2191" type="inline" citeas="">
@@ -982,7 +987,7 @@ RSpec.describe Asciidoctor::Standoc do
         </origin>
        </termsource>
        </term>
-       <term id='_'>
+       <term id='term-term2'>
   <preferred>Term2</preferred>
   <definition>
     <p id='_'>Definition</p>
@@ -1032,7 +1037,7 @@ RSpec.describe Asciidoctor::Standoc do
          <title>Terms and definitions</title>
          <p id="_">For the purposes of this document,
        the following terms and definitions apply.</p>
-         <term id="_">
+         <term id="term-term1">
          <preferred>Term1</preferred>
          <termsource status="modified">
          <origin bibitemid="ISO2191" type="inline" citeas="">
@@ -1045,7 +1050,7 @@ RSpec.describe Asciidoctor::Standoc do
          </modification>
        </termsource>
        </term>
-       <term id='_'>
+       <term id='term-term2'>
   <preferred>Term2</preferred>
   <definition>
     <p id='_'>Definition</p>