metanorma-generic 1.11.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0f723b5f6592e4b954120f9dfbd3da6853cdf357a9361bb4e3514fc2a76a0e7
-  data.tar.gz: f4fa24394f18ed2826e038a83b90d9c67684c005e7be75eb9a35cd0b49a349bb
+  metadata.gz: 91c4626d9d39c2843137aa04fa40e29b206aad99af497bd4557db2904b6a0333
+  data.tar.gz: 3e17cf92b1ad8a9c6af1d72f74206b1f01399a1676806642cc7e78bb34110dde
 SHA512:
-  metadata.gz: 1f3a5df30ebbd0bc6de1a4099d8fe4cc2c90c8ddfed32d171ce2ad2de2ce8e0f37d23bc1d689519a6d791914e281d0c6de81b7d48c43e2870a68a49f0aaccf37
-  data.tar.gz: 7e4cb9673702cb3a1da9cbb4bd6f7acf6827cac3889f0a0fc2477ed6c35cd78ed4a4bfcd4aebf1d2138781898eba3b7a6d4b80affc1639ccb1b46699f214e9ba
+  metadata.gz: 53c631bd4b142112021e756af04905964939d6ec3e8536df15660f0738ddc632640fde87a6059f67db7c78da520d1eb74931eb2ccf76e1adb7a471d3ab4f6fbe
+  data.tar.gz: 4dc996318a1ed6e42db1ef3532f980de7f3462c087b064f084b2eaa15759456dc02dfc6da6676dcc708a1180e053c1b68ae7bce4d21d459d4ab4ea7c92be97a5

data/.github/workflows/rake.yml

@@ -9,35 +9,7 @@ on:
   pull_request:
 
 jobs:
-  rake:
-    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ false ]
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - run: bundle exec rake
-
-  tests-passed:
-    needs: rake
-    runs-on: ubuntu-latest
-    steps:
-      - uses: peter-evans/repository-dispatch@v1
-        with:
-          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
-          repository: ${{ github.repository }}
-          event-type: tests-passed
-          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
+  notify:
+    uses: metanorma/metanorma-build-scripts/.github/workflows/mn-processor-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.gitignore

@@ -1,3 +1,13 @@
 .DS_Store
 
 .rubocop-https--*
+
+/.rspec_status
+/Gemfile.devel
+/Gemfile.lock
+/coverage/
+/test.doc
+/test.err
+/test.html
+/test.pdf
+/test.presentation.xml

data/README.adoc

@@ -31,7 +31,7 @@ Metanorma::Generic.configure do |config|
   config.document_namespace = 'https://open.ribose.com/standards/mine'
   config.xml_root_tag = 'mine-standard'
   config.logo_path = '/metanorma-mine/lib/isodoc/mine/html/logo.jpg'
-  config.validate_rng_file = '/metanorma-mine/lib/asciidoctor/mine/mine.rng'
+  config.validate_rng_file = '/metanorma-mine/lib/metanorma/mine/mine.rng'
   config.htmlcoverpage = '/metanorma-mine/lib/isodoc/mine/html/html_mine_titlepage.html'
   config.htmlintropage = '/metanorma-mine/lib/isodoc/mine/html/html_mine_intro.html'
   config.htmlstylesheet = '/metanorma-mine/lib/isodoc/mine/html/htmlstyle.scss'

data/lib/asciidoctor/generic/converter.rb

@@ -1,183 +1,3 @@
-require "asciidoctor"
-require "asciidoctor/standoc/converter"
-require "fileutils"
-require_relative "front"
+require "asciidoctor/generic/deprecated"
+require "metanorma/generic/converter"
 
-module Asciidoctor
-  module Generic
-    class Converter < Standoc::Converter
-      XML_ROOT_TAG = "generic-standard".freeze
-      XML_NAMESPACE = "https://www.metanorma.org/ns/generic".freeze
-
-      register_for "generic"
-
-      def xml_root_tag
-        configuration.xml_root_tag || XML_ROOT_TAG
-      end
-
-      def xml_namespace
-        configuration.document_namespace || XML_NAMESPACE
-      end
-
-      def baselocation(loc)
-        return nil if loc.nil?
-
-        return loc
-        File.expand_path(File.join(File.dirname(
-                                     self.class::_file || __FILE__,
-                                   ), "..", "..", "..", loc))
-      end
-
-      def docidentifier_cleanup(xmldoc)
-        template = configuration.docid_template ||
-          "{{ organization_name_short }} {{ docnumeric }}"
-        docid = xmldoc.at("//bibdata/docidentifier")
-        id = boilerplate_isodoc(xmldoc).populate_template(template, nil)
-        id.empty? and docid.remove or docid.children = id
-      end
-
-      def doctype(node)
-        d = super
-        configuration.doctypes or return d == "article" ?
-          (configuration.default_doctype || "standard") : d
-        type = configuration.default_doctype ||
-          configuration.doctypes.keys.dig(0) || "standard"
-        unless configuration.doctypes.keys.include? d
-          @log.add("Document Attributes", nil,
-                   "#{d} is not a legal document type: reverting to '#{type}'")
-          d = type
-        end
-        d
-      end
-
-      def read_config_file(path_to_config_file)
-        Metanorma::Generic.configuration
-          .set_default_values_from_yaml_file(path_to_config_file)
-      end
-
-      def sectiontype_streamline(ret)
-        if configuration&.termsdefs_titles&.map(&:downcase)&.include? ret
-          "terms and definitions"
-        elsif configuration&.symbols_titles&.map(&:downcase)&.include? ret
-          "symbols and abbreviated terms"
-        elsif configuration&.normref_titles&.map(&:downcase)&.include? ret
-          "normative references"
-        elsif configuration&.bibliography_titles&.map(&:downcase)&.include? ret
-          "bibliography"
-        else
-          ret
-        end
-      end
-
-      def document(node)
-        read_config_file(node.attr("customize")) if node.attr("customize")
-        super
-      end
-
-      def outputs(node, ret)
-        File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
-        presentation_xml_converter(node)&.convert("#{@filename}.xml")
-        html_converter(node)&.convert("#{@filename}.presentation.xml",
-                                      nil, false, "#{@filename}.html")
-        doc_converter(node)&.convert("#{@filename}.presentation.xml",
-                                     nil, false, "#{@filename}.doc")
-        pdf_converter(node)&.convert("#{@filename}.presentation.xml",
-                                     nil, false, "#{@filename}.pdf")
-      end
-
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        baselocation(configuration.validate_rng_file) ||
-                        File.join(File.dirname(__FILE__), "generic.rng"))
-      end
-
-      def content_validate(doc)
-        super
-        bibdata_validate(doc.root)
-      end
-
-      def bibdata_validate(doc)
-        stage_validate(doc)
-        committee_validate(doc)
-      end
-
-      def stage_validate(xmldoc)
-        stages = configuration&.stage_abbreviations&.keys || return
-        stages.empty? and return
-        stage = xmldoc&.at("//bibdata/status/stage")&.text
-        stages.include? stage or
-          @log.add("Document Attributes", nil,
-                   "#{stage} is not a recognised status")
-      end
-
-      def committee_validate(xmldoc)
-        committees = Array(configuration&.committees) || return
-        committees.empty? and return
-        xmldoc.xpath("//bibdata/ext/editorialgroup/committee").each do |c|
-          committees.include? c.text or
-            @log.add("Document Attributes", nil,
-                     "#{c.text} is not a recognised committee")
-        end
-      end
-
-      def sections_cleanup(xml)
-        super
-        xml.xpath("//*[@inline-header]").each do |h|
-          h.delete("inline-header")
-        end
-      end
-
-      def blank_method(*args); end
-
-      def html_converter(node)
-        IsoDoc::Generic::HtmlConvert.new(html_extract_attributes(node))
-      end
-
-      def presentation_xml_converter(node)
-        IsoDoc::Generic::PresentationXMLConvert
-          .new(html_extract_attributes(node))
-      end
-
-      alias_method :pdf_converter, :html_converter
-      alias_method :style, :blank_method
-      alias_method :title_validate, :blank_method
-
-      def doc_converter(node)
-        IsoDoc::Generic::WordConvert.new(doc_extract_attributes(node))
-      end
-
-      def configuration
-        Metanorma::Generic.configuration
-      end
-
-      def boilerplate_isodoc(xmldoc)
-        conv = super
-        Metanorma::Generic::Configuration::CONFIG_ATTRS.each do |a|
-          conv.meta.set(a, configuration.send(a))
-        end
-        conv
-      end
-
-      def boilerplate_file(xmldoc)
-        f = configuration.boilerplate
-        f.nil? and return super
-        f.is_a? String and return baselocation(f)
-        f.is_a? Hash and f[@lang] and return baselocation(f[@lang])
-        super
-      end
-
-      def cleanup(xmldoc)
-        super
-        empty_metadata_cleanup(xmldoc)
-        xmldoc
-      end
-
-      def empty_metadata_cleanup(xmldoc)
-        xmldoc.xpath("//bibdata/ext//*").each do |x|
-          x.remove if x.children.empty?
-        end
-      end
-    end
-  end
-end

data/lib/asciidoctor/generic/deprecated.rb

@@ -0,0 +1,5 @@
+warn "Please replace your references to Asciidoctor::Generic with Metanorma::Generic and your instances of require 'asciidoctor/generic' with require 'metanorma/generic'"
+
+exit 127 if ENV['METANORMA_DEPRECATION_FAIL']
+
+Asciidoctor::Generic = Metanorma::Generic unless defined? Asciidoctor::Generic

data/lib/asciidoctor/generic/front.rb

@@ -1,108 +1,3 @@
-module Asciidoctor
-  module Generic
-    class Converter < Standoc::Converter
-      def default_publisher
-        configuration.organization_name_long
-      end
+require "asciidoctor/generic/deprecated"
+require "metanorma/generic/front"
 
-      def org_abbrev
-        if !configuration.organization_name_long.empty? &&
-            !configuration.organization_name_short.empty? &&
-            configuration.organization_name_long !=
-            configuration.organization_name_short
-          { configuration.organization_name_long =>
-            configuration.organization_name_short }
-        else
-          super
-        end
-      end
-
-      def relaton_relations
-        Array(configuration.relations) || []
-      end
-
-      def metadata_committee(node, xml)
-        return unless node.attr("committee")
-        xml.editorialgroup do |a|
-          a.committee node.attr("committee"),
-            **attr_code(type: node.attr("committee-type"))
-          i = 2
-          while node.attr("committee_#{i}") do
-            a.committee node.attr("committee_#{i}"),
-              **attr_code(type: node.attr("committee-type_#{i}"))
-            i += 1
-          end
-        end
-      end
-
-      def metadata_status(node, xml)
-        xml.status do |s|
-          s.stage ( node.attr("status") || node.attr("docstage") ||
-                   configuration.default_stage || "published" )
-          x = node.attr("substage") and s.substage x
-          x = node.attr("iteration") and s.iteration x
-        end
-      end
-
-      def metadata_id(node, xml)
-        xml.docidentifier **{ type:
-                              configuration.organization_name_short } do |i|
-          i << "DUMMY"
-        end
-        xml.docnumber { |i| i << node.attr("docnumber") }
-      end
-
-      def metadata_ext(node, ext)
-        super
-        if configuration.metadata_extensions.is_a? Hash
-          metadata_ext_hash(node, ext, configuration.metadata_extensions)
-        else
-          Array(configuration.metadata_extensions).each do |e|
-            a = node.attr(e) and ext.send e, a
-          end
-        end
-      end
-
-      def metadata_doctype(node, xml)
-        d = doctype(node)
-        xml.doctype d, attr_code(abbreviation: configuration&.doctypes&.dig(d))
-      end
-
-      EXT_STRUCT = %w(_output _attribute _list).freeze
-
-      def metadata_ext_hash(node, ext, hash)
-        hash.each do |k, v|
-          next if EXT_STRUCT.include?(k) || !v&.is_a?(Hash) && !node.attr(k)
-          if v&.is_a?(Hash) && v["_list"]
-            csv_split(node.attr(k), ",").each do |val|
-              metadata_ext_hash1(k, val, ext, v, node)
-            end
-          else
-            metadata_ext_hash1(k, node.attr(k), ext, v, node)
-          end
-        end
-      end
-
-      def metadata_ext_hash1(key, value, ext, hash, node)
-        return if hash&.is_a?(Hash) && hash["_attribute"]
-        is_hash = hash&.is_a?(Hash) &&
-            !hash.keys.reject { |n| EXT_STRUCT.include?(n) }.empty?
-        return if !is_hash && (value.nil? || value.empty?)
-        name = hash&.is_a?(Hash) ? (hash["_output"] || key) : key
-        ext.send name, **attr_code(metadata_ext_attrs(hash, node)) do |e|
-            is_hash ? metadata_ext_hash(node, e, hash) : (e << value)
-        end
-      end
-
-      def metadata_ext_attrs(hash, node)
-        return {} unless hash.is_a?(Hash)
-        ret = {}
-        hash.each do |k, v|
-          next unless v.is_a?(Hash) && v["_attribute"]
-          ret[(v["_output"] || k).to_sym] = node.attr(k)
-        end
-        ret
-      end
-    end
-  end
-end

data/lib/asciidoctor/generic.rb

@@ -1,7 +1,3 @@
-require "asciidoctor/generic/converter"
+require "asciidoctor/generic/deprecated"
+require "metanorma/generic"
 
-module Asciidoctor
-  module Generic
-
-  end
-end

data/lib/isodoc/generic/base_convert.rb

@@ -12,14 +12,15 @@ module IsoDoc
       def term_cleanup(docxml)
         docxml.xpath("//p[@class = 'Terms']").each do |d|
           h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")
-          h2.add_child(" ")
-          h2.add_child(d.remove)
+          d["id"] = h2["id"]
+          d.children.first.previous =
+            "<strong>#{h2.remove.children.to_xml}</strong>&nbsp;"
         end
         docxml
       end
 
       def make_body(xml, docxml)
-        body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72", 
+        body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72",
                       "xml:lang": "EN-US", class: "container" }
         xml.body **body_attr do |body|
           make_body1(body, docxml)

data/lib/isodoc/generic/html/generic.scss

@@ -296,7 +296,6 @@ p.Terms, li.Terms, div.Terms
         mso-fareast-font-family:$headerfont;
         mso-bidi-font-family:$headerfont;
         mso-ansi-language:EN-GB;
-        font-weight:bold;
         mso-bidi-font-weight:normal;}
 p.AltTerms, li.AltTerms, div.AltTerms
         {mso-style-name:"AltTerm\(s\)";

data/lib/isodoc/generic/html/htmlstyle.scss

@@ -186,7 +186,7 @@ p.document-stage {
     3.1 Titles
 */
 
-h1,h2,h3,h4,h5,h6 {
+h1,h2,h3,h4,h5,h6,.h1,.h2,.h3,.h4,.h5,.h6 {
   font-family: $headerfont;
   color: #1661AD;
   font-weight: 300;
@@ -194,31 +194,34 @@ h1,h2,h3,h4,h5,h6 {
   margin-bottom: 0.3em;
 }
 
-h1 {
+h1,.h1 {
   font-size: 1.6em;
   text-transform: uppercase;
   margin-top: 2em;
 }
 
-h1#content {
+h1#content, .h1#content {
     margin-top: 2em;
 }
 
-h2 {
+h2,.h2 {
   margin-top: 1.3em;
   font-size: 1.3em;
   font-weight: 400;
 }
 
-h3 {
+h3,.h3 {
   margin-top: 1.1em;
   font-size: 1.1em;
   font-weight: 100;
 }
 
+.TermNum {
+  font-weight: 100;
+}
+
 .TermNum, .Terms, .AltTerms {
   color: #1661AD;
-  font-weight: 100;
 }
 
 h2.TermNum {
@@ -637,7 +640,7 @@ To top button
     page-break-after: always;
   }
 
-  h1, h2, h3, h4 {
+  h1, h2, h3, h4, .h1, .h2, .h3, .h4 {
     page-break-after: avoid;
     margin-top: 1.2em;
   }
@@ -672,21 +675,21 @@ To top button
       padding-left: 0;
   }
 
-    h1.content {
+    h1.content, .h1.content {
       margin-top: 2em;
       line-height: 2.5em;
     }
 
-    h1 {
+    h1,.h1 {
       font-size: 1.5em;
       line-height: 1.5;
     }
 
-    h2 {
+    h2,.h2 {
       font-size: 1.2em
     }
 
-    h3 {
+    h3,.h3 {
       font-size: 1em;
     }
 

data/lib/isodoc/generic/html/scripts.html

@@ -16,7 +16,6 @@ $('#toggle').on('click', function(){
     else {
         $('nav').show();
         $('nav').animate({ 'left': '0px' }, 'slow');
-        $('.container').animate({ 'padding-left': '360px' }, 'slow');
     }
 });
 </script>

data/lib/isodoc/generic/html/wordstyle.scss

@@ -338,7 +338,7 @@ div.figure, p.figure
         {text-align: center;}
 
 
-h1
+h1,.h1
 	{mso-style-priority:1;
 	mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -352,8 +352,6 @@ h1
 	line-height:13.5pt;
 	mso-pagination:widow-orphan;
 	page-break-after:avoid;
-	mso-outline-level:1;
-	mso-list:l1 level1 lfo6;
 	mso-hyphenate:none;
 	tab-stops:20.0pt list 21.6pt left 28.0pt;
 	font-size:13.0pt;
@@ -365,6 +363,10 @@ h1
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
 	mso-bidi-font-weight:normal;}
+h1 {
+	mso-outline-level:1;
+	mso-list:l1 level1 lfo6;
+}
 h1.Annex
 	{mso-style-priority:1;
 	mso-style-unhide:no;
@@ -421,7 +423,7 @@ h1.Annex
         mso-ansi-language:EN-GB;
         mso-fareast-language:JA;
         mso-bidi-font-weight:normal;}
-h2
+h2, .h2
 	{mso-style-priority:2;
 	mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -436,8 +438,6 @@ h2
 	line-height:12.5pt;
 	mso-pagination:widow-orphan;
 	page-break-after:avoid;
-	mso-outline-level:2;
-	mso-list:l1 level2 lfo6;
 	mso-hyphenate:none;
 	tab-stops:27.0pt 35.0pt;
 	font-size:12.0pt;
@@ -448,7 +448,11 @@ h2
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
 	mso-bidi-font-weight:normal;}
-h3
+h2 {
+	mso-outline-level:2;
+	mso-list:l1 level2 lfo6;
+}
+h3, .h3
 	{mso-style-priority:3;
 	mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -463,8 +467,6 @@ h3
 	line-height:12.0pt;
 	mso-pagination:widow-orphan;
 	page-break-after:avoid;
-	mso-outline-level:3;
-	mso-list:l1 level3 lfo6;
 	mso-hyphenate:none;
 	tab-stops:list 36.0pt left 44.0pt;
 	font-size:11.0pt;
@@ -474,7 +476,11 @@ h3
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
 	mso-bidi-font-weight:normal;}
-h4
+h3 {
+	mso-outline-level:3;
+	mso-list:l1 level3 lfo6;
+}
+h4, .h4
 	{mso-style-priority:4;
 	mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -489,8 +495,6 @@ h4
 	line-height:12.0pt;
 	mso-pagination:widow-orphan;
 	page-break-after:avoid;
-	mso-outline-level:4;
-	mso-list:l1 level4 lfo6;
 	mso-hyphenate:none;
 	tab-stops:51.05pt 57.0pt 68.0pt;
 	font-size:11.0pt;
@@ -500,7 +504,11 @@ h4
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
 	mso-bidi-font-weight:normal;}
-h5
+h4 {
+	mso-outline-level:4;
+	mso-list:l1 level4 lfo6;
+}
+h5, .h5
 	{mso-style-priority:5;
 	mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -515,8 +523,6 @@ h5
 	line-height:12.0pt;
 	mso-pagination:widow-orphan;
 	page-break-after:avoid;
-	mso-outline-level:5;
-	mso-list:l1 level5 lfo6;
 	mso-hyphenate:none;
 	tab-stops:51.05pt list 54.0pt;
 	font-size:11.0pt;
@@ -526,7 +532,11 @@ h5
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
 	mso-bidi-font-weight:normal;}
-h6
+h5 {
+	mso-outline-level:5;
+	mso-list:l1 level5 lfo6;
+}
+h6, .h6
 	{mso-style-priority:6;
 	mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -541,8 +551,6 @@ h6
 	line-height:12.0pt;
 	mso-pagination:widow-orphan;
 	page-break-after:avoid;
-	mso-outline-level:6;
-	mso-list:l1 level6 lfo6;
 	mso-hyphenate:none;
 	tab-stops:51.05pt list 72.0pt;
 	font-size:11.0pt;
@@ -552,6 +560,10 @@ h6
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
 	mso-bidi-font-weight:normal;}
+h6 {
+	mso-outline-level:6;
+	mso-list:l1 level6 lfo6;
+}
 p.MsoToc1, li.MsoToc1, div.MsoToc1
 	{mso-style-priority:39;
 	mso-style-unhide:no;