metanorma-standoc 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5ab9cbdae658ec4088c0670d2ce1a117799a9325dbb8b8aa24e59b44e94e24c
-  data.tar.gz: da30d4d7b276b67e2363643e8ae1296a352bc4acee0ef9f2727da00ad276b3cc
+  metadata.gz: d9031c28646f9cd9a481ad67911f2f0f7e5bd058368f80888a788753e5f63fa3
+  data.tar.gz: 25b16459f351f266f19b2f00d70b5bf7f6f5c95325a0d61d43fbe5f3fa518802
 SHA512:
-  metadata.gz: e8600c60d56d27820da72dbc7259db4e3a91a3e362a4cefa0a5497b545076dab93277e87c5a0368f3037249ed79b5421e92300a8847bcf7c5bdcaca2392a3eab
-  data.tar.gz: 216bdaa7621b5b722f65a7d86eabbeaf65788df7f135927d04044838c6db31d50999155de829df6e57f5563a4f201121f36cde9c9c023a9af546019ab65d848e
+  metadata.gz: 885e62405f3198482ffd7e152b25bef8ab09fc227a8107984297e8fa15b64552b2e745f4ce5e1d60dd37df6dc5cf5c505fb9acfeedd1bdc4ef77954e01218893
+  data.tar.gz: 69cac251a0696b46dd25f37fb23828780e1945e57464e829c91ab5d88ac481311d130c4ff0e670ee89d56fd998eff4ea48e3c5a0c4b24c514021431fb785d852

data/lib/metanorma/standoc/biblio.rng

@@ -401,9 +401,9 @@
       <choice>
         <!-- iso191606 TODO -->
         <group>
-          <oneOrMore>
+          <zeroOrMore>
             <ref name="street"/>
-          </oneOrMore>
+          </zeroOrMore>
           <ref name="city"/>
           <optional>
             <ref name="state"/>

data/lib/metanorma/standoc/cleanup_text.rb

@@ -28,28 +28,6 @@ module Metanorma
       end
 
       # "abc<tag/>", def => "abc",<tag/> def
-=begin
-      def uninterrupt_quotes_around_xml(xmldoc)
-        xmldoc.xpath("//*[following::text()[1]"\
-                     "[starts-with(., '\"') or starts-with(., \"'\")]]")
-          .each do |x|
-          next if !x.ancestors("pre, tt, sourcecode, stem, figure").empty?
-
-          uninterrupt_quotes_around_xml1(x)
-        end
-      end
-=end
-=begin
-      def uninterrupt_quotes_around_xml(xmldoc)
-        xmldoc.traverse do |n|
-          next unless n.element? && n&.next&.text? &&
-            n.ancestors("pre, tt, sourcecode, stem, figure").empty?
-          next unless /^['"]/.match?(n.next.text)
-
-          uninterrupt_quotes_around_xml1(n)
-        end
-      end
-=end
       def uninterrupt_quotes_around_xml(xmldoc)
         xmldoc.traverse do |n|
           next unless n.text? && n&.previous&.element?

data/lib/metanorma/standoc/converter.rb

@@ -61,6 +61,7 @@ module Metanorma
         block Metanorma::Standoc::PlantUMLBlockMacro
         block Metanorma::Plugin::Lutaml::LutamlDiagramBlock
         block Metanorma::Standoc::PseudocodeBlockMacro
+        preprocessor Metanorma::Standoc::EmbedIncludeProcessor
       end
 
       include ::Asciidoctor::Converter

data/lib/metanorma/standoc/isodoc.rng

@@ -32,6 +32,43 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="index">
+      <element name="index">
+        <optional>
+          <attribute name="to">
+            <data type="IDREF"/>
+          </attribute>
+        </optional>
+        <element name="primary">
+          <oneOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="stem"/>
+            </choice>
+          </oneOrMore>
+        </element>
+        <optional>
+          <element name="secondary">
+            <oneOrMore>
+              <choice>
+                <ref name="PureTextElement"/>
+                <ref name="stem"/>
+              </choice>
+            </oneOrMore>
+          </element>
+        </optional>
+        <optional>
+          <element name="tertiary">
+            <oneOrMore>
+              <choice>
+                <ref name="PureTextElement"/>
+                <ref name="stem"/>
+              </choice>
+            </oneOrMore>
+          </element>
+        </optional>
+      </element>
+    </define>
     <define name="bibitem">
       <element name="bibitem">
         <attribute name="id">
@@ -1027,6 +1064,26 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="sub">
+      <element name="sub">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="sup">
+      <element name="sup">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="pagebreak">
       <element name="pagebreak">
         <optional>
@@ -2216,7 +2273,18 @@
           <ref name="MultilingualRenderingType"/>
         </attribute>
       </optional>
-      <ref name="paragraph"/>
+      <oneOrMore>
+        <choice>
+          <ref name="formula"/>
+          <ref name="ul"/>
+          <ref name="ol"/>
+          <ref name="dl"/>
+          <ref name="quote"/>
+          <ref name="sourcecode"/>
+          <ref name="paragraph"/>
+          <ref name="figure"/>
+        </choice>
+      </oneOrMore>
     </element>
   </define>
   <define name="termsource">

data/lib/metanorma/standoc/macros.rb

@@ -7,6 +7,7 @@ require_relative "./macros_plantuml"
 require_relative "./macros_terms"
 require_relative "./macros_form"
 require_relative "./macros_note"
+require_relative "./macros_embed"
 require_relative "./datamodel/attributes_table_preprocessor"
 require_relative "./datamodel/diagram_preprocessor"
 require "metanorma-plugin-datastruct"

data/lib/metanorma/standoc/macros_embed.rb

@@ -0,0 +1,72 @@
+module Metanorma
+  module Standoc
+    class EmbedIncludeProcessor < Asciidoctor::Extensions::Preprocessor
+      def process(doc, reader)
+        return reader if reader.eof?
+
+        lines = reader.readlines
+        while !lines.grep(/^embed::/).empty?
+          headings = lines.grep(/^== /).map(&:strip)
+          lines = lines.map do |line|
+            /^embed::/.match?(line) ? embed(line, doc, reader, headings) : line
+          end.flatten
+        end
+        ::Asciidoctor::Reader.new lines
+      end
+
+      def filename(line, doc, reader)
+        m = /^embed::([^\[]+)\[/.match(line)
+        f = doc.normalize_system_path m[1], reader.dir, nil,
+                                      target_name: "include file"
+        File.exist?(f) ? f : nil
+      end
+
+      def readlines_safe(file)
+        if file.eof? then []
+        else file.readlines
+        end
+      end
+
+      def embed(line, doc, reader, headings)
+        inc_path = filename(line, doc, reader) or return line
+        lines = filter_sections(read(inc_path), headings)
+        doc = Asciidoctor::Document.new [], { safe: :safe }
+        reader = ::Asciidoctor::PreprocessorReader.new doc, lines
+        strip_header(reader.read_lines)
+      end
+
+      def read(inc_path)
+        ::File.open inc_path, "r" do |fd|
+          readlines_safe(fd).map(&:chomp)
+        end
+      end
+
+      def strip_header(lines)
+        return lines unless !lines.empty? && lines.first.start_with?("= ")
+
+        skip = true
+        lines.each_with_object([]) do |l, m|
+          m << l unless skip
+          skip = false if !/\S/.match?(l)
+        end
+      end
+
+      def filter_sections(lines, headings)
+        skip = false
+        lines.each_with_index.with_object([]) do |(l, i), m|
+          if headings.include?(l.strip)
+            skip = true
+            m.unshift while !m.empty? && /^\S/.match?(m[-1])
+          elsif skip && /^== |^embed::|^include::/.match?(l)
+            skip = false
+            j = i
+            j -= 1 while j >= 0 && /^\S/.match?(m[j])
+            lines[j..i].each { |n| m << n }
+          else
+            skip or m << l
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.0.1".freeze
+    VERSION = "2.0.2".freeze
   end
 end

data/spec/assets/a1.adoc

@@ -0,0 +1,8 @@
+= X
+A
+
+== Clause 1
+
+X
+
+embed::spec/assets/a2.adoc[]

data/spec/assets/a2.adoc

@@ -0,0 +1,8 @@
+= X
+A
+
+== Clause 2
+
+X
+
+embed::spec/assets/a3.adoc[]

data/spec/assets/a3.adoc

@@ -0,0 +1,9 @@
+= X
+A
+
+== Clause 3
+
+X
+
+include::spec/assets/a4.adoc[]
+

data/spec/assets/a4.adoc

@@ -0,0 +1,4 @@
+== Clause 4
+
+X
+

data/spec/metanorma/macros_spec.rb

@@ -1304,6 +1304,95 @@ RSpec.describe Metanorma::Standoc do
       .to be_equivalent_to xmlpp(output)
   end
 
+  it "processes embed macro" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      [[clause1]]
+      == Clause 1
+
+      embed::spec/assets/xref_error.adoc[]
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+        <sections>
+          <clause id='clause1' inline-header='false' obligation='normative'>
+            <title>Clause 1</title>
+          </clause>
+          <clause id='_' inline-header='false' obligation='normative'>
+            <title>Clause</title>
+            <p id='_'>
+              <xref target='a'>b</xref>
+            </p>
+          </clause>
+        </sections>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "processes embed macro with overwriting" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      [[clause1]]
+      == Clause
+
+      embed::spec/assets/xref_error.adoc[]
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+        <sections>
+          <clause id='clause1' inline-header='false' obligation='normative'>
+            <title>Clause</title>
+          </clause>
+        </sections>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+  it "processes recursive embed macro with includes" do
+    input = <<~INPUT
+      #{ASCIIDOC_BLANK_HDR}
+
+      [[clause1]]
+      == Clause
+
+      embed::spec/assets/a1.adoc[]
+    INPUT
+    output = <<~OUTPUT
+      #{BLANK_HDR}
+               <sections>
+           <clause id='clause1' inline-header='false' obligation='normative'>
+             <title>Clause</title>
+           </clause>
+           <clause id='_' inline-header='false' obligation='normative'>
+             <title>Clause 1</title>
+             <p id='_'>X</p>
+           </clause>
+           <clause id='_' inline-header='false' obligation='normative'>
+             <title>Clause 2</title>
+             <p id='_'>X</p>
+           </clause>
+           <clause id='_' inline-header='false' obligation='normative'>
+             <title>Clause 3</title>
+             <p id='_'>X</p>
+           </clause>
+           <clause id='_' inline-header='false' obligation='normative'>
+             <title>Clause 4</title>
+             <p id='_'>X</p>
+           </clause>
+         </sections>
+      </standard-document>
+    OUTPUT
+    expect(xmlpp(strip_guid(Asciidoctor.convert(input, *OPTIONS))))
+      .to be_equivalent_to xmlpp(output)
+  end
+
+
   describe "term inline macros" do
     subject(:convert) do
       xmlpp(

data/spec/metanorma/refs_spec.rb

@@ -1625,7 +1625,7 @@ RSpec.describe Metanorma::Standoc do
 
         * [[[iso124,BSI BS EN ISO 19011:2018]]] _Standard_
         * [[[iso123,BSI BS EN 16341]]] _Standard_
-        * [[[ref_2,BSI BS EN ISO 14044:2006+A1:2020]]], _Environmental management – Life cycle assessment – Requirements and guidelines_
+        * [[[ref_2,BSI BS EN ISO 14044:2006+A2:2020]]], _Environmental management – Life cycle assessment – Requirements and guidelines_
       INPUT
       output = Nokogiri::XML(Asciidoctor.convert(input, *OPTIONS))
         .xpath("//xmlns:docidentifier[@type = 'BSI']").map(&:text)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -492,6 +492,7 @@ files:
 - lib/metanorma/standoc/isodoc.rng
 - lib/metanorma/standoc/lists.rb
 - lib/metanorma/standoc/macros.rb
+- lib/metanorma/standoc/macros_embed.rb
 - lib/metanorma/standoc/macros_form.rb
 - lib/metanorma/standoc/macros_note.rb
 - lib/metanorma/standoc/macros_plantuml.rb
@@ -514,6 +515,10 @@ files:
 - lib/metanorma/standoc/views/datamodel/model_representation.adoc.erb
 - lib/metanorma/standoc/views/datamodel/plantuml_representation.adoc.erb
 - metanorma-standoc.gemspec
+- spec/assets/a1.adoc
+- spec/assets/a2.adoc
+- spec/assets/a3.adoc
+- spec/assets/a4.adoc
 - spec/assets/boilerplate.xml
 - spec/assets/codes.yml
 - spec/assets/header.html