metanorma-standoc 1.6.5 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f510c7d84985eb301f3bfe71f4ebe89f39961a6b9ec113a9e019537056e3933
-  data.tar.gz: a0844efae9739bfd19ab8263dd9a5b1edff6883b443f5c7fb399a056cd528bfa
+  metadata.gz: d6af6d01c6514c3fbfe4a1bbe33b088f15eb78c7243db92fb36694d050a84635
+  data.tar.gz: 4dc1bdc07d11ce753ff4a26482cf5adba8f81153da808a9eb68a6b4cdda13a89
 SHA512:
-  metadata.gz: f9fa2f578c9b742860c5464141a2efbe1d565061148e0aa701520cfe8cfe0ef0828c46ffa21883d893190af37efc7c31a792d4a11a6c8775a43ca6bae6b08aa9
-  data.tar.gz: 63a79d788f62977472a2ff3c21d1926dfb52b43722092f82f721cbcfb8748caba1adec96fb3062c02dab8fb7d74b9dc691bcb70dca9f91121d778122444158bc
+  metadata.gz: dc0064271a3104f6e26cecdd33228befe52771b31aff7aa18e44325851ebaeb5d2bda60aca28fe5113d87097df945153723553526357e7d6225176a9dbc1067f
+  data.tar.gz: b5f306f4fbab92edefee5887fb3acaa22d31583d37d0de0ddb8d8c469a17ced57d8300ab6254e0c860e3aa7c6519e0ce5f77eaa7986e49bfb497672997c7c743

data/lib/asciidoctor/standoc/basicdoc.rng

@@ -729,12 +729,27 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
+      <attribute name="to">
+        <data type="IDREF"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
       <optional>
-        <attribute name="secondary"/>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
       <optional>
-        <attribute name="tertiary"/>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
     </element>
   </define>

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -3,14 +3,12 @@ module Asciidoctor
     module Cleanup
       def external_terms_boilerplate(sources)
         @i18n.l10n(
-          @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"),
-          @lang, @script)
+          @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"), @lang, @script)
       end
 
       def internal_external_terms_boilerplate(sources)
         @i18n.l10n(
-          @i18n.internal_external_terms_boilerplate.gsub(/%/, sources || "??"),
-          @lang, @script)
+          @i18n.internal_external_terms_boilerplate.gsub(/%/, sources || "??"), @lang, @script)
       end
 
       def term_defs_boilerplate(div, source, term, preface, isodoc)
@@ -19,11 +17,9 @@ module Asciidoctor
           @anchors[s["bibitemid"]] or
             @log.add("Crossreferences", nil, "term source #{s['bibitemid']} not referenced")
         end
-        if source.empty? && term.nil?
-          div.next = @i18n.no_terms_boilerplate
-        else
-          div.next = term_defs_boilerplate_cont(source, term, isodoc)
-        end
+        a = (source.empty? && term.nil?) ?  @i18n.no_terms_boilerplate :
+          term_defs_boilerplate_cont(source, term, isodoc)
+        a and div.next = a
       end
 
       def term_defs_boilerplate_cont(src, term, isodoc)
@@ -38,15 +34,14 @@ module Asciidoctor
       end
 
       def norm_ref_preface(f)
-      refs = f.elements.select do |e|
-        ["reference", "bibitem"].include? e.name
+        refs = f.elements.select do |e|
+          ["reference", "bibitem"].include? e.name
+        end
+        f.at("./title").next =
+          "<p>#{(refs.empty? ? @i18n.norm_empty_pref : @i18n.norm_with_refs_pref)}</p>"
       end
-      f.at("./title").next =
-        "<p>#{(refs.empty? ? @i18n.norm_empty_pref : @i18n.norm_with_refs_pref)}</p>"
-    end
 
-      TERM_CLAUSE = "//sections/terms | "\
-        "//sections/clause[descendant::terms]".freeze
+      TERM_CLAUSE = "//sections/terms | //sections/clause[descendant::terms]".freeze
 
       NORM_REF = "//bibliography/references[@normative = 'true']".freeze
 
@@ -59,15 +54,33 @@ module Asciidoctor
         @isodoc
       end
 
+      def termdef_boilerplate_cleanup(xmldoc)
+        #termdef_remove_initial_paras(xmldoc)
+      end
+
+      def termdef_remove_initial_paras(xmldoc)
+        xmldoc.xpath("//terms/p | //terms/ul").each(&:remove)
+      end
+
+      def termdef_unwrap_boilerplate_clauses(xmldoc)
+        xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
+          f.xpath(".//clause[@type = 'boilerplate']").each do |c|
+            c&.at("./title")&.remove
+            c.replace(c.children)
+          end
+        end
+      end
+
       def boilerplate_cleanup(xmldoc)
         isodoc = boilerplate_isodoc(xmldoc)
+        termdef_boilerplate_cleanup(xmldoc)
         xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
-          term_defs_boilerplate(f.at("./title"),
-                                xmldoc.xpath(".//termdocsource"),
+          next if f.at("./clause[@type = 'boilerplate']")
+          term_defs_boilerplate(f.at("./title"), xmldoc.xpath(".//termdocsource"),
                                 f.at(".//term"), f.at(".//p"), isodoc)
         end
-        f = xmldoc.at(self.class::NORM_REF) and
-          norm_ref_preface(f)
+        termdef_unwrap_boilerplate_clauses(xmldoc)
+        f = xmldoc.at(self.class::NORM_REF) and norm_ref_preface(f)
         initial_boilerplate(xmldoc, isodoc)
       end
 

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -125,7 +125,7 @@ module Asciidoctor
       def concept_termbase_cleanup(x)
         text = x&.children&.first&.remove&.text
         termbase, key = x["key"].split(/:/, 2)
-        x.add_child(%(<termref base="#{termbase}" target="#{key}">) + 
+        x.add_child(%(<termref base="#{termbase}" target="#{key}">) +
                     "#{text}</termref>")
       end
 
@@ -155,6 +155,8 @@ module Asciidoctor
         ret
       end
 
+      module_function :to_ncname
+
       def to_xreftarget(s)
         return to_ncname(s) unless /^[^#]+#.+$/.match(s)
           /^(?<pref>[^#]+)#(?<suff>.+)$/ =~ s

data/lib/asciidoctor/standoc/cleanup_terms.rb

@@ -47,10 +47,6 @@ module Asciidoctor
         end
       end
 
-      def termdef_boilerplate_cleanup(xmldoc)
-        xmldoc.xpath("//terms/p | //terms/ul").each(&:remove)
-      end
-
       def termdef_subclause_cleanup(xmldoc)
         xmldoc.xpath("//terms[terms]").each { |t| t.name = "clause" }
       end
@@ -83,7 +79,7 @@ module Asciidoctor
           x.name = "note"
         end
         xmldoc.xpath("//termexample[not(ancestor::term)]").each do |x|
-          x.name = "note"
+          x.name = "example"
         end
       end
 
@@ -96,7 +92,6 @@ module Asciidoctor
         termdefinition_cleanup(xmldoc)
         termdomain1_cleanup(xmldoc)
         termnote_example_cleanup(xmldoc)
-        termdef_boilerplate_cleanup(xmldoc)
         termdef_subclause_cleanup(xmldoc)
         term_children_cleanup(xmldoc) 
         termdocsource_cleanup(xmldoc)

data/lib/asciidoctor/standoc/converter.rb

@@ -40,7 +40,8 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::VariantInlineMacro
         inline_macro Asciidoctor::Standoc::FootnoteBlockInlineMacro
         inline_macro Asciidoctor::Standoc::TermRefInlineMacro
-        inline_macro Asciidoctor::Standoc::IndexInlineMacro
+        inline_macro Asciidoctor::Standoc::IndexXrefInlineMacro
+        inline_macro Asciidoctor::Standoc::IndexRangeInlineMacro
         block Asciidoctor::Standoc::ToDoAdmonitionBlock
         treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
         block Asciidoctor::Standoc::PlantUMLBlockMacro
@@ -90,11 +91,26 @@ module Asciidoctor
       end
 
       def flavor_name
-        self.class.name.split("::")&.[](-2).downcase
+        self.class.name.split("::")&.[](-2).downcase.to_sym
       end
 
       def fonts_manifest
-        File.expand_path(File.join(@libdir, "../../metanorma/", flavor_name, "fonts_manifest.yaml"))
+        flavor = flavor_name
+        registry = Metanorma::Registry.instance
+        processor = registry.find_processor(flavor)
+
+        if processor.nil?
+          Metanorma::Util.log("[fontist] #{flavor} processor not found. " \
+            "Please go to github.com/metanorma/metanorma/issues to report " \
+            "this issue.", :warn)
+          return nil
+        elsif !defined? processor.fonts_manifest
+          Metanorma::Util.log("[fontist] #{flavor} processor don't require " \
+            "specific fonts", :debug)
+          return nil
+        end
+
+        processor.fonts_manifest
       end
 
       def install_fonts(options={})
@@ -104,14 +120,11 @@ module Asciidoctor
           return
         end
 
-        if fonts_manifest.nil? || !File.exist?(fonts_manifest)
-          Metanorma::Util.log("[fontist] Skip font installation because" \
-            " font manifest file doesn't exists/defined", :debug)
-          return
-        end
+        manifest = fonts_manifest
+        return if manifest.nil?
 
         begin
-          Fontist::Manifest::Install.call(
+          Fontist::Manifest::Install.from_hash(
             fonts_manifest,
             confirmation: options[:agree_to_terms] ? "yes" : "no"
           )
@@ -127,9 +140,8 @@ module Asciidoctor
               " installed", :fatal)
           end
         rescue Fontist::Errors::NonSupportedFontError
-          flavor = flavor_name || "cli"
           Metanorma::Util.log("[fontist] '#{font}' font is not supported. " \
-            "Please go to github.com/metanorma/metanorma-#{flavor}/issues" \
+            "Please go to github.com/metanorma/metanorma-#{flavor_name}/issues" \
             " to report this issue.", :info)
         end
       end

data/lib/asciidoctor/standoc/front_contributor.rb

@@ -46,8 +46,9 @@ module Asciidoctor
 
       # , " => ," : CSV definition does not deal with space followed by quote
       # at start of field
-      def csv_split(s, delim = ",")
-        CSV.parse_line(s&.gsub(/, "(?!")/, ',"'),
+      def csv_split(s, delim = ";")
+        return if s.nil?
+        CSV.parse_line(s&.gsub(/#{delim} "(?!")/, "#{delim}\""),
                        liberal_parsing: true,
                        col_sep: delim)&.compact&.map { |x| x.strip }
       end
@@ -115,8 +116,11 @@ module Asciidoctor
         node.attr("affiliation#{suffix}") and p.affiliation do |a|
           a.organization do |o|
             o.name node.attr("affiliation#{suffix}")
-            abbr = node.attr("affiliation_abbrev#{suffix}") and
-              o.abbreviation abbr
+            a = node.attr("affiliation_subdiv#{suffix}")
+            abbr = node.attr("affiliation_abbrev#{suffix}") and o.abbreviation abbr
+            csv_split(node.attr("affiliation_subdiv#{suffix}"))&.each do |s|
+              o.subdivision s
+            end
             node.attr("address#{suffix}") and o.address do |ad|
               ad.formattedAddress do |f|
                 f << node.attr("address#{suffix}").gsub(/ \+\n/, "<br/>")

data/lib/asciidoctor/standoc/inline.rb

@@ -211,11 +211,12 @@ module Asciidoctor
       def inline_indexterm(node)
         noko do |xml|
           node.type == :visible and xml << node.text
-          terms = node.attr("terms") ||
-            [Nokogiri::XML("<a>#{node.text}</a>").xpath("//text()").text]
-          xml.index nil, **attr_code(primary: terms[0],
-                                     secondary: terms.dig(1),
-                                     tertiary: terms.dig(2))
+            terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
+          xml.index do |i|
+            i.primary { |x| x << terms[0] }
+            a = terms.dig(1) and i.secondary { |x| x << a }
+            a = terms.dig(2) and i.tertiary { |x| x << a }
+          end
         end.join
       end
     end

data/lib/asciidoctor/standoc/isodoc.rng

@@ -55,6 +55,13 @@
             <param name="pattern">\i\c*|\c+#\c+</param>
           </data>
         </attribute>
+        <optional>
+          <attribute name="to">
+            <data type="string">
+              <param name="pattern">\i\c*|\c+#\c+</param>
+            </data>
+          </attribute>
+        </optional>
         <optional>
           <attribute name="type">
             <ref name="ReferenceFormat"/>

data/lib/asciidoctor/standoc/macros.rb

@@ -23,7 +23,7 @@ module Asciidoctor
       end
     end
 
-    class IndexInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+    class IndexXrefInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :index
 
@@ -44,6 +44,19 @@ module Asciidoctor
       end
     end
 
+    class IndexRangeInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named "index-range".to_sym
+      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

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,12 @@ 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"],
+                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 +101,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 +183,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/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.5".freeze
+    VERSION = "1.7.0".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.0"
   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,7 @@ 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_dependency "fontist", "~> 1.7.3"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "sassc", "2.4.0"