metanorma-standoc 2.2.1.1 → 2.2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90287c74936b7e6fa5c54537833e425fdc78deb260ce3a9f083cc53530ad66fc
-  data.tar.gz: 273eb7dcaf62e8b9a8578f932b3ab45377bdf0b57ad254cab80b16b10e584586
+  metadata.gz: 99fc70f6e9b8781722b3deed8143fabbadf28dfdda77f88e4ae9f7bfc3b83faf
+  data.tar.gz: 51305f5baa732cbb3b9df0ed6640413df408930365ef3ce8f84c16cad3337288
 SHA512:
-  metadata.gz: 167db30a6cbf87a30f2e1d97eeaafffb63e94699a7f077556ec23604de443fcfabc1a1de091e7fbb93ddf528482e980e0b23c976abbf2e7aae8ebbfbddbb686c
-  data.tar.gz: 1925f23438f2cc30fcd898c4ceeb8aea39442a8b0575d2cf8fa91954e229a2384b954670e75a66fe052486ff12a6b3394512d49ae84d38ac5f5253cde3591715
+  metadata.gz: b757363df3d4c399b067478880534eb0fad2b8cd166e4e0d0e33c138bb599f8f7ac8d017bbbe7500d59ee5f161ff6e43b0205362a6fcb0ba6d0dfa7444dbf7bd
+  data.tar.gz: add6f5d5626ee90828655bdf4feeb47091e362982dfe39372d0c85ff33efa21482b0f79ee4613b19ab438aae260c334bb3e15a3f3bf3eff2f80ed5486e888345

data/.github/workflows/rake.yml

@@ -10,6 +10,6 @@ on:
 
 jobs:
   rake:
-    uses: metanorma/metanorma-build-scripts/.github/workflows/plantuml-rake.yml@main
+    uses: metanorma/ci/.github/workflows/plantuml-rake.yml@main
     secrets:
       pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'skip'
+  push:
+    tags: [ v* ]
+
+jobs:
+  release:
+    uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+

data/lib/metanorma/standoc/base.rb

@@ -71,7 +71,7 @@ module Metanorma
       def init_reqt(node)
         @default_requirement_model = (node.attr("requirements-model") ||
                                         default_requirement_model)
-        @reqt_models = Metanorma::Requirements
+        @reqt_models = requirements_processor
           .new({ default: @default_requirement_model })
       end
 
@@ -112,6 +112,10 @@ module Metanorma
         init_iev_caches(node)
       end
 
+      def requirements_processor
+        Metanorma::Requirements
+      end
+
       def document(node)
         ret = document1(node)
         clean_exit
@@ -156,8 +160,11 @@ module Metanorma
       end
 
       def clean_abort(msg, file = nil)
-        file and
-          File.open("#{@filename}.xml.abort", "w:UTF-8") { |f| f.write(file) }
+        if file
+          doc = file.to_xml(encoding: "UTF-8", indent: 2,
+                            save_with: Nokogiri::XML::Node::SaveOptions::AS_XML)
+          File.open("#{@filename}.xml.abort", "w:UTF-8") { |f| f.write(doc) }
+        end
         clean_exit
         abort(msg)
       end

data/lib/metanorma/standoc/biblio.rng

@@ -225,9 +225,9 @@
         <zeroOrMore>
           <ref name="forename"/>
         </zeroOrMore>
-        <zeroOrMore>
-          <ref name="initial"/>
-        </zeroOrMore>
+        <optional>
+          <ref name="formatted-initials"/>
+        </optional>
         <ref name="surname"/>
         <zeroOrMore>
           <ref name="addition"/>
@@ -247,8 +247,8 @@
       <ref name="LocalizedString"/>
     </element>
   </define>
-  <define name="initial">
-    <element name="initial">
+  <define name="formatted-initials">
+    <element name="formatted-initials">
       <ref name="LocalizedString"/>
     </element>
   </define>
@@ -264,6 +264,9 @@
   </define>
   <define name="forename">
     <element name="forename">
+      <optional>
+        <attribute name="initial"/>
+      </optional>
       <ref name="LocalizedString"/>
     </element>
   </define>

data/lib/metanorma/standoc/cleanup_biblio.rb

@@ -84,8 +84,8 @@ module Metanorma
         dl = clause.at("./dl") or return
         key = ""
         bib = dl.xpath("./dt | ./dd").each_with_object({}) do |dtd, m|
-          (dtd.name == "dt" and key = dtd.text.sub(/:+$/, "")) or
-            add_to_hash(m, key, dd_bib_extract(dtd))
+          (dtd.name == "dt" and key = dtd.text.sub(/:+$/, "")) and next
+          add_to_hash(m, key, dd_bib_extract(dtd))
         end
         clause.xpath("./clause").each do |c1|
           key = c1&.at("./title")&.text&.downcase&.strip

data/lib/metanorma/standoc/cleanup_reqt.rb

@@ -3,7 +3,7 @@ module Metanorma
     module Cleanup
       def requirement_cleanup(xmldoc)
         @reqt_models ||=
-          Metanorma::Requirements.new({ default: @default_requirement_model })
+          requirements_processor.new({ default: @default_requirement_model })
         @reqt_models.requirement_cleanup(xmldoc)
       end
     end

data/lib/metanorma/standoc/converter.rb

@@ -1,18 +1,17 @@
 require "asciidoctor"
-require "metanorma/util"
-require "metanorma/standoc/version"
-require "metanorma/standoc/base"
-require "metanorma/standoc/front"
-require "metanorma/standoc/lists"
-require "metanorma/standoc/ref"
-require "metanorma/standoc/inline"
-require "metanorma/standoc/blocks"
-require "metanorma/standoc/section"
-require "metanorma/standoc/table"
-require "metanorma/standoc/validate"
-require "metanorma/standoc/utils"
-require "metanorma/standoc/cleanup"
-require "metanorma/standoc/reqt"
+require_relative "version"
+require_relative "base"
+require_relative "front"
+require_relative "lists"
+require_relative "ref"
+require_relative "inline"
+require_relative "blocks"
+require_relative "section"
+require_relative "table"
+require_relative "validate"
+require_relative "utils"
+require_relative "cleanup"
+require_relative "reqt"
 require_relative "./macros"
 
 module Metanorma
@@ -25,9 +24,6 @@ module Metanorma
         preprocessor Metanorma::Standoc::Datamodel::DiagramPreprocessor
         preprocessor Metanorma::Plugin::Datastruct::Json2TextPreprocessor
         preprocessor Metanorma::Plugin::Datastruct::Yaml2TextPreprocessor
-        preprocessor Metanorma::Plugin::Lutaml::LutamlPreprocessor
-        preprocessor Metanorma::Plugin::Lutaml::LutamlUmlAttributesTablePreprocessor
-        preprocessor Metanorma::Plugin::Lutaml::LutamlUmlDatamodelDescriptionPreprocessor
         inline_macro Metanorma::Standoc::PreferredTermInlineMacro
         inline_macro Metanorma::Standoc::SpanInlineMacro
         inline_macro Metanorma::Standoc::AltTermInlineMacro
@@ -56,15 +52,11 @@ module Metanorma
         inline_macro Metanorma::Standoc::ToCInlineMacro
         inline_macro Metanorma::Standoc::PassInlineMacro
         inline_macro Metanorma::Standoc::StdLinkInlineMacro
-        inline_macro Metanorma::Plugin::Lutaml::LutamlFigureInlineMacro
-        inline_macro Metanorma::Plugin::Lutaml::LutamlTableInlineMacro
-        block_macro Metanorma::Plugin::Lutaml::LutamlDiagramBlockMacro
         block Metanorma::Standoc::ToDoAdmonitionBlock
         block Metanorma::Standoc::EditorAdmonitionBlock
         treeprocessor Metanorma::Standoc::EditorInlineAdmonitionBlock
         treeprocessor Metanorma::Standoc::ToDoInlineAdmonitionBlock
         block Metanorma::Standoc::PlantUMLBlockMacro
-        block Metanorma::Plugin::Lutaml::LutamlDiagramBlock
         block Metanorma::Standoc::PseudocodeBlockMacro
         preprocessor Metanorma::Standoc::EmbedIncludeProcessor
         preprocessor Metanorma::Standoc::NamedEscapePreprocessor

data/lib/metanorma/standoc/macros_terms.rb

@@ -103,16 +103,16 @@ module Metanorma
     class ConceptInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :concept
-      match /\{\{(?<content>|.*?[^\\])\}\}/
+      match /\{\{(?<content>|.*?[^\\])\}\}/m
       using_format :short
 
       def preprocess_attrs(target)
-        m = /^(?<id>&lt;&lt;.+?&gt;&gt;)?(?<rest>.*)$/.match(target)
+        m = /^(?<id>&lt;&lt;.+?&gt;&gt;)?(?<rest>.*)$/m.match(target)
         ret = { id: m[:id]&.sub(/^&lt;&lt;/, "")&.sub(/&gt;&gt;$/, "") }
-        if m2 = /^(?<rest>.*?)(?<opt>,opt(?:ion)?s=.+)$/
+        if m2 = /^(?<rest>.*?)(?<opt>,opt(?:ion)?s=.+)$/m
             .match(m[:rest].sub(/^,/, ""))
           ret[:opt] = CSV.parse_line(m2[:opt].sub(/^,opt(ion)?s=/, "")
-            .sub(/^"(.+)"$/, "\\1").sub(/^'(.+)'$/, "\\1"))
+            .sub(/^"(.+)"$/m, "\\1").sub(/^'(.+)'$/m, "\\1"))
           begin
             attrs = CSV.parse_line(m2[:rest]) || []
           rescue StandardError
@@ -125,6 +125,7 @@ module Metanorma
             raise "error processing #{m[:rest]} as CSV"
           end
         end
+        attrs.map! { |x| x.gsub(/\s+/, " ") }
         ret.merge(term: attrs[0], word: attrs[1] || attrs[0],
                   render: attrs[2])
       end

data/lib/metanorma/standoc/reqt.rb

@@ -31,6 +31,13 @@ module Metanorma
         @reqt_model = nil unless nested
         ret
       end
+
+      def requirement_validate(docxml)
+        docxml.xpath("//requirement | //recommendation | //permission")
+          .each do |r|
+          @reqt_models.model(r["model"]).validate(r, @log)
+        end
+      end
     end
   end
 end

data/lib/metanorma/standoc/terms.rb

@@ -56,17 +56,23 @@ module Metanorma
           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
+        @definitions and return symbols_parse(attrs, xml, node)
+        term_contains_subclauses(node) and
+          return term_def_parse(attrs, xml, node, false)
+        case sectiontype(node, false)
+        when "symbols and abbreviated terms"
           return symbols_parse(attrs, xml, node)
-        st == "terms and definitions" and return clause_parse(attrs, xml, node)
+        when "terms and definitions"
+          return clause_parse(attrs, xml, node)
+        end
         term_def_subclause_parse1(attrs, xml, node)
       end
 
+      def term_contains_subclauses(node)
+        sub = node.find_by(context: :section) { |s| s.level == node.level + 1 }
+        !sub.empty?
+      end
+
       def term_def_subclause_parse1(attrs, xml, node)
         xml.term **attr_code(attrs) do |xml_section|
           term_designation(xml_section, node, "preferred", node.title)

data/lib/metanorma/standoc/validate.rb

@@ -4,6 +4,8 @@ require_relative "./validate_table"
 require "nokogiri"
 require "jing"
 require "iev"
+require "pngcheck"
+require "png"
 
 module Metanorma
   module Standoc
@@ -51,7 +53,10 @@ module Metanorma
         concept_validate(doc, "concept", "refterm")
         concept_validate(doc, "related", "preferred//name")
         table_validate(doc)
-        @fatalerror.empty? or clean_abort(@fatalerror.join("\n"), doc.to_xml)
+        requirement_validate(doc)
+        image_validate(doc)
+        @fatalerror.empty? or
+          clean_abort(@fatalerror.join("\n"), doc)
       end
 
       def norm_ref_validate(doc)
@@ -104,7 +109,7 @@ module Metanorma
         Tempfile.open(["tmp", ".xml"], encoding: "UTF-8") do |f|
           schema_validate1(f, doc, schema)
         rescue Jing::Error => e
-          clean_abort("Jing failed with error: #{e}", doc.to_xml)
+          clean_abort("Jing failed with error: #{e}", doc)
         ensure
           f.close!
         end
@@ -154,6 +159,21 @@ module Metanorma
         end
       end
 
+      def image_validate(doc)
+        doc.xpath("//image[@mimetype = 'image/png']").each do |i|
+          d = Metanorma::Utils::datauri(i["src"], @localdir)
+          # d.chars.to_a.each_slice(80).to_a.map { |s| s.join }.each { |s| warn s }
+          png_validate1(i, Base64.strict_decode64(d.sub(/^.+?base64,/, "")))
+        end
+      end
+
+      def png_validate1(img, buffer)
+        PngCheck.check_buffer(buffer)
+      rescue PngCheck::CorruptPngError => e
+        @log.add("Images", img.parent, "Corrupt PNG image")
+        @fatalerror << "Exception #{e.message}"
+      end
+
       def validate(doc)
         content_validate(doc)
         schema_validate(formattedstr_strip(doc.dup),

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.2.1.1".freeze
+    VERSION = "2.2.2.2".freeze
   end
 end

data/lib/metanorma-standoc.rb

@@ -4,7 +4,7 @@ require_relative "metanorma/standoc/converter"
 require_relative "metanorma/standoc/version"
 require "asciidoctor/extensions"
 
-if defined? Metanorma
+if defined? Metanorma::Registry
   require_relative "metanorma/standoc"
   Metanorma::Registry.instance.register(Metanorma::Standoc::Processor)
 end

data/metanorma-standoc.gemspec

@@ -27,7 +27,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "iev", "~> 0.3.0"
-  spec.add_dependency "isodoc", "~> 2.2.0"
+  spec.add_dependency "isodoc", "~> 2.2.3"
+  spec.add_dependency "metanorma"
   spec.add_dependency "metanorma-plugin-datastruct", "~> 0.2.0"
   spec.add_dependency "metanorma-plugin-lutaml"
   spec.add_dependency "ruby-jing"
@@ -36,7 +37,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "concurrent-ruby"
   spec.add_dependency "latexmath"
   spec.add_dependency "mathml2asciimath"
-  spec.add_dependency "mn-requirements", "~> 0.0.1"
+  spec.add_dependency "mn-requirements", "~> 0.1.3"
+  spec.add_dependency "png"
+  spec.add_dependency "pngcheck"
   spec.add_dependency "relaton-cli", "~> 1.13.0"
   spec.add_dependency "relaton-iev", "~> 1.1.0"
   spec.add_dependency "unicode2latex", "~> 0.0.1"
@@ -45,7 +48,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"
-  spec.add_development_dependency "metanorma-iso", "~>2.1.2"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rubocop", "~> 1.5.2"

data/spec/metanorma/base_spec.rb

@@ -222,7 +222,7 @@ RSpec.describe Metanorma::Standoc do
       :iteration: 3
       :language: en
       :title: Main Title -- Title
-      :library-ics: 1,2,3
+      :library-ics: 01.040.11,11.060.01
       :fullname: Fred Flintstone
       :role: author
       :affiliation: Slate Rock and Gravel Company
@@ -509,14 +509,13 @@ RSpec.describe Metanorma::Standoc do
                <technical-committee number="1" type="A">TC</technical-committee>
                <technical-committee number="11" type="A1">TC1</technical-committee>
              </editorialgroup>
-             <ics>
-               <code>1</code>
-             </ics>
-             <ics>
-               <code>2</code>
+                             <ics>
+               <code>01.040.11</code>
+               <text>Health care technology (Vocabularies)</text>
              </ics>
              <ics>
-               <code>3</code>
+               <code>11.060.01</code>
+               <text>Dentistry in general</text>
              </ics>
              </ext>
            </bibdata>

data/spec/metanorma/macros_concept_spec.rb

@@ -6,6 +6,9 @@ RSpec.describe Metanorma::Standoc do
       #{ASCIIDOC_BLANK_HDR}
 
       {{clause1}}
+      {{clause two}}
+      {{clause
+      two}}
       term:[clause1]
       {{clause1,w\[o\]rd}}
       term:[clause1,w[o]rd]
@@ -39,6 +42,22 @@ RSpec.describe Metanorma::Standoc do
           <tt>clause1</tt>
         </strong>
           </concept>
+          <concept>
+          <strong>
+            term
+            <tt>clause two</tt>
+             not resolved via ID
+            <tt>clause-two</tt>
+          </strong>
+        </concept>
+        <concept>
+          <strong>
+            term
+            <tt>clause two</tt>
+             not resolved via ID
+            <tt>clause-two</tt>
+          </strong>
+        </concept>
           <concept>
           <strong>
           term

data/spec/metanorma/macros_spec.rb

@@ -933,102 +933,6 @@ RSpec.describe Metanorma::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
-  it "processes embed macro with document in a different flavour" do
-    require "metanorma-iso"
-    input = <<~INPUT
-      #{ASCIIDOC_BLANK_HDR}
-
-      [[clause1]]
-      == Clause 1
-
-      embed::spec/assets/iso.adoc[]
-    INPUT
-    output = <<~OUTPUT
-      <standard-document xmlns='https://www.metanorma.org/ns/standoc' type='semantic' version='#{Metanorma::Standoc::VERSION}'>
-       <bibdata type='standard'>
-         <title language='en' format='text/plain'>Document title</title>
-         <language>en</language>
-         <script>Latn</script>
-         <status>
-           <stage>published</stage>
-         </status>
-         <copyright>
-           <from>2022</from>
-         </copyright>
-         <ext>
-           <doctype>standard</doctype>
-         </ext>
-                    <relation type='derivedFrom'>
-             <bibitem>
-               <title language='en' format='text/plain' type='main'>
-                 Medical devices — Quality management systems — Requirements for
-                 regulatory purposes
-               </title>
-               <title language='en' format='text/plain' type='title-main'>
-                 Medical devices — Quality management systems — Requirements for
-                 regulatory purposes
-               </title>
-               <title language='fr' format='text/plain' type='main'>
-                 Dispositifs médicaux — Systèmes de management de la qualité —
-                 Exigences à des fins réglementaires
-               </title>
-               <title language='fr' format='text/plain' type='title-main'>
-                 Dispositifs médicaux — Systèmes de management de la qualité —
-                 Exigences à des fins réglementaires
-               </title>
-               <contributor>
-                 <role type='author'/>
-                 <organization>
-                   <name>International Organization for Standardization</name>
-                   <abbreviation>ISO</abbreviation>
-                 </organization>
-               </contributor>
-               <contributor>
-                 <role type='publisher'/>
-                 <organization>
-                   <name>International Organization for Standardization</name>
-                   <abbreviation>ISO</abbreviation>
-                 </organization>
-               </contributor>
-               <language>en</language>
-               <script>Latn</script>
-               <status>
-                 <stage abbreviation='IS'>60</stage>
-                 <substage>60</substage>
-               </status>
-               <copyright>
-                 <from>2022</from>
-                 <owner>
-                   <organization>
-                     <name>International Organization for Standardization</name>
-                     <abbreviation>ISO</abbreviation>
-                   </organization>
-                 </owner>
-               </copyright>
-               <ext>
-                 <doctype>standard</doctype>
-                 <editorialgroup>
-                   <agency>ISO</agency>
-                 </editorialgroup>
-                 <approvalgroup>
-           <agency>ISO</agency>
-         </approvalgroup>
-                 <stagename>International standard</stagename>
-               </ext>
-             </bibitem>
-           </relation>
-              </bibdata>
-              <sections>
-                <clause id='clause1' inline-header='false' obligation='normative'>
-                  <title>Clause 1</title>
-                </clause>
-              </sections>
-      </standard-document>
-    OUTPUT
-    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
-      .to be_equivalent_to xmlpp(output)
-  end
-
   it "processes std-link macro" do
     VCR.use_cassette("std-link", match_requests_on: %i[method uri body]) do
       input = <<~INPUT

data/spec/metanorma/validate_spec.rb

@@ -782,4 +782,53 @@ RSpec.describe Metanorma::Standoc do
     expect(File.read("test.err"))
       .not_to include "Symbol reference in `symbol[xyz]` missing:"
   end
+
+  it "warns and aborts if corrupt PNG" do
+    FileUtils.rm_f "test.xml"
+    FileUtils.rm_f "test.err"
+    begin
+      input = <<~INPUT
+        = Document title
+        Author
+        :docfile: test.adoc
+        :no-pdf:
+
+        == Clause
+        image::spec/assets/corrupt.png[]
+
+      INPUT
+      expect do
+        Asciidoctor.convert(input, *OPTIONS)
+      end.to raise_error(SystemExit)
+    rescue SystemExit, RuntimeError
+    end
+    warn File.read("test.err")
+    expect(File.read("test.err"))
+      .to include "Corrupt PNG image"
+    expect(File.exist?("test.xml")).to be false
+  end
+
+  it "does not warn and abort if not corrupt PNG" do
+    FileUtils.rm_f "test.xml"
+    FileUtils.rm_f "test.err"
+    begin
+      input = <<~INPUT
+        = Document title
+        Author
+        :docfile: test.adoc
+        :no-pdf:
+
+        == Clause
+        image::spec/assets/correct.png[]
+
+      INPUT
+      expect do
+        Asciidoctor.convert(input, *OPTIONS)
+      end.not_to raise_error
+    rescue SystemExit, RuntimeError
+    end
+    expect(File.read("test.err"))
+      .not_to include "Corrupt PNG image"
+    expect(File.exist?("test.xml")).to be true
+  end
 end