metanorma-standoc 2.1.5 → 2.2.0

data/lib/metanorma/standoc/macros.rb

@@ -3,6 +3,7 @@ require "fileutils"
 require "uuidtools"
 require "yaml"
 require "csv"
+require_relative "./macros_inline"
 require_relative "./macros_plantuml"
 require_relative "./macros_terms"
 require_relative "./macros_form"
@@ -15,54 +16,6 @@ require "metanorma-plugin-lutaml"
 
 module Metanorma
   module Standoc
-    class InheritInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :inherit
-      parse_content_as :text
-      using_format :short
-
-      def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<inherit>#{out}</inherit>}
-      end
-    end
-
-    class IndexXrefInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :index
-
-      def preprocess_attrs(attrs)
-        return unless attrs.size > 1 && attrs.size < 5
-
-        ret = { primary: attrs[1], target: attrs[attrs.size] }
-        ret[:secondary] = attrs[2] if attrs.size > 2
-        ret[:tertiary] = attrs[3] if attrs.size > 3
-        ret
-      end
-
-      def process(_parent, target, attr)
-        args = preprocess_attrs(attr) or return
-        ret = "<index-xref also='#{target == 'also'}'>"\
-              "<primary>#{args[:primary]}</primary>"
-        ret += "<secondary>#{args[:secondary]}</secondary>" if args[:secondary]
-        ret += "<tertiary>#{args[:tertiary]}</tertiary>" if args[:tertiary]
-        ret + "<target>#{args[:target]}</target></index-xref>"
-      end
-    end
-
-    class IndexRangeInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :"index-range"
-      parse_content_as :text
-
-      def process(parent, target, attr)
-        text = attr["text"]
-        text = "((#{text}))" unless /^\(\(.+\)\)$/.match?(text)
-        out = parent.sub_macros(text)
-        out.sub(/<index>/, "<index to='#{target}'>")
-      end
-    end
-
     class PseudocodeBlockMacro < Asciidoctor::Extensions::BlockProcessor
       use_dsl
       named :pseudocode
@@ -97,138 +50,6 @@ module Metanorma
       end
     end
 
-    class HTML5RubyMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :ruby
-      parse_content_as :text
-      option :pos_attrs, %w(rpbegin rt rpend)
-
-      # for example, html5ruby:楽聖少女[がくせいしょうじょ]
-      def process(_parent, target, attributes)
-        rpbegin = "("
-        rpend = ")"
-        if (attributes.size == 1) && attributes.key?("text")
-          rt = attributes["text"]
-        elsif (attributes.size == 2) && attributes.key?(1) &&
-            attributes.key?("rpbegin")
-          rt = attributes[1] || ""
-        else
-          rpbegin = attributes["rpbegin"]
-          rt = attributes["rt"]
-          rpend = attributes["rpend"]
-        end
-
-        "<ruby>#{target}<rp>#{rpbegin}</rp><rt>#{rt}</rt>"\
-          "<rp>#{rpend}</rp></ruby>"
-      end
-    end
-
-    class AutonumberInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :autonumber
-      parse_content_as :text
-
-      def process(parent, target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<autonumber type='#{target}'>#{out}</autonumber>}
-      end
-    end
-
-    class VariantInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :lang
-      parse_content_as :text
-
-      def process(parent, target, attrs)
-        /^(?<lang>[^-]*)(?:-(?<script>.*))?$/ =~ target
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        if script
-          %{<variant lang='#{lang}' script='#{script}'>#{out}</variant>}
-        else
-          %{<variant lang='#{lang}'>#{out}</variant>}
-        end
-      end
-    end
-
-    class AddMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :add
-      parse_content_as :text
-      using_format :short
-
-      def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<add>#{out}</add>}
-      end
-    end
-
-    class DelMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :del
-      parse_content_as :text
-      using_format :short
-
-      def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<del>#{out}</del>}
-      end
-    end
-
-    class ToCInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :toc
-      parse_content_as :text
-      using_format :short
-
-      def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        content = CSV.parse_line(out).map do |x|
-          x.sub!(/^(["'])(.+)\1/, "\\2")
-          m = /^(.*?)(:\d+)?$/.match(x)
-          %{<toc-xpath depth='#{m[2]&.sub(/:/, '') || 1}'>#{m[1]}</toc-xpath>}
-        end.join
-        "<toc>#{content}</toc>"
-      end
-    end
-
-    # inject ZWNJ to prevent Asciidoctor from attempting regex substitutions
-    class PassInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :"pass-format"
-
-      def process(parent, target, attrs)
-        format = target || "metanorma"
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs[1]).convert
-          .gsub(/((?![<>&])[[:punct:]])/, "\\1&#x200c;")
-        %{<passthrough-inline formats="#{format}">#{out}</passthrough-inline>}
-      end
-    end
-
-    class IdentifierInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :identifier
-      parse_content_as :raw
-      using_format :short
-
-      def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-          .gsub(/((?![<>&])[[:punct:]])/, "\\1&#x200c;")
-        %{<identifier>#{out}</identifier>}
-      end
-    end
-
-    class StdLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :"std-link"
-      parse_content_as :text
-      using_format :short
-
-      def process(parent, _target, attrs)
-        create_anchor(parent, "hidden%#{attrs['text']}",
-                      type: :xref, target: "_#{UUIDTools::UUID.random_create}")
-      end
-    end
-
     class NamedEscapePreprocessor < Asciidoctor::Extensions::Preprocessor
       def process(_document, reader)
         c = HTMLEntities.new

data/lib/metanorma/standoc/macros_inline.rb

@@ -0,0 +1,194 @@
+module Metanorma
+  module Standoc
+    class InheritInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :inherit
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<inherit>#{out}</inherit>}
+      end
+    end
+
+    class IndexXrefInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :index
+
+      def preprocess_attrs(attrs)
+        return unless attrs.size > 1 && attrs.size < 5
+
+        ret = { primary: attrs[1], target: attrs[attrs.size] }
+        ret[:secondary] = attrs[2] if attrs.size > 2
+        ret[:tertiary] = attrs[3] if attrs.size > 3
+        ret
+      end
+
+      def process(_parent, target, attr)
+        args = preprocess_attrs(attr) or return
+        ret = "<index-xref also='#{target == 'also'}'>"\
+              "<primary>#{args[:primary]}</primary>"
+        ret += "<secondary>#{args[:secondary]}</secondary>" if args[:secondary]
+        ret += "<tertiary>#{args[:tertiary]}</tertiary>" if args[:tertiary]
+        ret + "<target>#{args[:target]}</target></index-xref>"
+      end
+    end
+
+    class IndexRangeInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :"index-range"
+      parse_content_as :text
+
+      def process(parent, target, attr)
+        text = attr["text"]
+        text = "((#{text}))" unless /^\(\(.+\)\)$/.match?(text)
+        out = parent.sub_macros(text)
+        out.sub(/<index>/, "<index to='#{target}'>")
+      end
+    end
+
+    class HTML5RubyMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :ruby
+      parse_content_as :text
+      option :pos_attrs, %w(rpbegin rt rpend)
+
+      # for example, html5ruby:楽聖少女[がくせいしょうじょ]
+      def process(_parent, target, attributes)
+        rpbegin = "("
+        rpend = ")"
+        if (attributes.size == 1) && attributes.key?("text")
+          rt = attributes["text"]
+        elsif (attributes.size == 2) && attributes.key?(1) &&
+            attributes.key?("rpbegin")
+          rt = attributes[1] || ""
+        else
+          rpbegin = attributes["rpbegin"]
+          rt = attributes["rt"]
+          rpend = attributes["rpend"]
+        end
+
+        "<ruby>#{target}<rp>#{rpbegin}</rp><rt>#{rt}</rt>"\
+          "<rp>#{rpend}</rp></ruby>"
+      end
+    end
+
+    class AutonumberInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :autonumber
+      parse_content_as :text
+
+      def process(parent, target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<autonumber type='#{target}'>#{out}</autonumber>}
+      end
+    end
+
+    class VariantInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :lang
+      parse_content_as :text
+
+      def process(parent, target, attrs)
+        /^(?<lang>[^-]*)(?:-(?<script>.*))?$/ =~ target
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        if script
+          %{<variant lang='#{lang}' script='#{script}'>#{out}</variant>}
+        else
+          %{<variant lang='#{lang}'>#{out}</variant>}
+        end
+      end
+    end
+
+    class AddMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :add
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<add>#{out}</add>}
+      end
+    end
+
+    class DelMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :del
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<del>#{out}</del>}
+      end
+    end
+
+    class ToCInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :toc
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        content = CSV.parse_line(out).map do |x|
+          x.sub!(/^(["'])(.+)\1/, "\\2")
+          m = /^(.*?)(:\d+)?$/.match(x)
+          %{<toc-xpath depth='#{m[2]&.sub(/:/, '') || 1}'>#{m[1]}</toc-xpath>}
+        end.join
+        "<toc>#{content}</toc>"
+      end
+    end
+
+    # inject ZWNJ to prevent Asciidoctor from attempting regex substitutions
+    class PassInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :"pass-format"
+
+      def process(parent, target, attrs)
+        format = target || "metanorma"
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs[1]).convert
+          .gsub(/((?![<>&])[[:punct:]])/, "\\1&#x200c;")
+        %{<passthrough-inline formats="#{format}">#{out}</passthrough-inline>}
+      end
+    end
+
+    class IdentifierInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :identifier
+      parse_content_as :raw
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+          .gsub(/((?![<>&])[[:punct:]])/, "\\1&#x200c;")
+        %{<identifier>#{out}</identifier>}
+      end
+    end
+
+    class StdLinkInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :"std-link"
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        create_anchor(parent, "hidden%#{attrs['text']}",
+                      type: :xref, target: "_#{UUIDTools::UUID.random_create}")
+      end
+    end
+
+    class SpanInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :s
+      parse_content_as :text
+
+      def process(parent, target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<span class="#{target}">#{out}</span>}
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/ref_sect.rb

@@ -84,7 +84,7 @@ module Metanorma
         if ref[:code].nil? || ref[:no_year] || @bibdb.nil?
           res << [ref, idx, nil]
         else
-          @bibdb.fetch_async(HTMLEntities.new.decode(ref[:code]),
+          @bibdb.fetch_async(@c.decode(ref[:code]),
                              ref[:year], ref) do |doc|
             res << [ref, idx, doc]
           end
@@ -131,7 +131,7 @@ module Metanorma
         global = !@no_isobib_cache && !node.attr("local-cache-only")
         local = node.attr("local-cache") || node.attr("local-cache-only")
         local = nil if @no_isobib_cache
-        @bibdb = Relaton::DbCache.init_bib_caches(
+        @bibdb = Relaton::Db.init_bib_caches(
           local_cache: local,
           flush_caches: node.attr("flush-caches"),
           global_cache: global,

data/lib/metanorma/standoc/ref_utility.rb

@@ -53,7 +53,7 @@ module Metanorma
 
       def docnumber(bib, code)
         bib.docnumber do |d|
-          d << HTMLEntities.new.decode(code).sub(/^[^\d]*/, "")
+          d << @c.decode(code).sub(/^[^\d]*/, "")
         end
       end
 

data/lib/metanorma/standoc/reqt.rb

@@ -7,7 +7,7 @@ module Metanorma
   module Standoc
     module Blocks
       def reqt_subpart(name)
-        %w(specification measurement-target verification import label title
+        %w(specification measurement-target verification import identifier title
            description component subject inherit classification).include? name
       end
 
@@ -30,7 +30,7 @@ module Metanorma
 
       def req_classif_parse(classif)
         ret = []
-        HTMLEntities.new.decode(classif).split(/;\s*/).each do |c|
+        @c.decode(classif).split(/;\s*/).each do |c|
           c1 = c.split(/:\s*/)
           next unless c1.size == 2
 
@@ -63,16 +63,16 @@ module Metanorma
 
       def requirement_elems(node, out)
         node.title and out.title { |t| t << node.title }
-        a = node.attr("label") and out.label do |l|
+        a = node.attr("identifier") and out.identifier do |l|
           l << out.text(a)
         end
         a = node.attr("subject") and csv_split(a)&.each do |subj|
           out.subject { |s| s << out.text(subj) }
         end
-        a = HTMLEntities.new.decode(node.attr("inherit")) and
+        a = @c.decode(node.attr("inherit")) and
           csv_split(a)&.each do |i|
             out.inherit do |inh|
-              inh << HTMLEntities.new.encode(i, :hexadecimal)
+              inh << @c.encode(i, :hexadecimal)
             end
           end
         classif = node.attr("classification") and

data/lib/metanorma/standoc/reqt.rng

@@ -108,7 +108,7 @@
     </element>
   </define>
   <define name="label">
-    <element name="label">
+    <element name="identifier">
       <oneOrMore>
         <ref name="TextElement"/>
       </oneOrMore>

data/lib/metanorma/standoc/version.rb

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

data/metanorma-standoc.gemspec

@@ -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"
@@ -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}

@@ -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]]], s:surname[Wozniak], s:initials[S.] & s:givenname[Steve] s:surname[Jobs]. s:pubyear[1996]. s:title[_Work_]. In s:surname.editor[Gates], s:initials.editor[W. H], Collected Essays. s:docid.ISO[ISO 1234]. s:pubplace[Geneva]: s:publisher[International Standardization Organization]. s:uri.citation[http://www.example.com]. s: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>
+                     <initial>S.</initial>
+                     <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>
+                     <initial>W. H</initial>
+                     <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