metanorma-generic 1.11.0 → 2.0.0

data/lib/metanorma/generic/converter.rb

@@ -0,0 +1,183 @@
+require "asciidoctor"
+require "metanorma/standoc/converter"
+require "fileutils"
+require_relative "front"
+
+module Metanorma
+  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/metanorma/generic/front.rb

@@ -0,0 +1,108 @@
+module Metanorma
+  module Generic
+    class Converter < Standoc::Converter
+      def default_publisher
+        configuration.organization_name_long
+      end
+
+      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 → metanorma}/generic/isodoc.rng

@@ -32,6 +32,19 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="bibitem">
+      <element name="bibitem">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="hidden">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <ref name="BibliographicItem"/>
+      </element>
+    </define>
     <define name="section-title">
       <element name="title">
         <zeroOrMore>
@@ -58,7 +71,7 @@
           <attribute name="alt"/>
         </optional>
         <optional>
-          <attribute name="updatetype">
+          <attribute name="update-type">
             <data type="boolean"/>
           </attribute>
         </optional>
@@ -690,6 +703,7 @@
             <ref name="terms"/>
             <ref name="term-clause"/>
             <ref name="definitions"/>
+            <ref name="floating-title"/>
           </choice>
         </oneOrMore>
       </element>
@@ -1680,6 +1694,7 @@
           <ref name="clause-subsection"/>
           <ref name="terms"/>
           <ref name="definitions"/>
+          <ref name="floating-title"/>
         </choice>
       </oneOrMore>
     </choice>
@@ -1722,6 +1737,7 @@
           <ref name="terms"/>
           <ref name="definitions"/>
           <ref name="references"/>
+          <ref name="floating-title"/>
         </choice>
       </zeroOrMore>
     </group>
@@ -1796,6 +1812,20 @@
           <data type="ID"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="language"/>
+      </optional>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="tag"/>
+      </optional>
+      <optional>
+        <attribute name="multilingual-rendering">
+          <ref name="MultilingualRenderingType"/>
+        </attribute>
+      </optional>
       <oneOrMore>
         <ref name="preferred"/>
       </oneOrMore>
@@ -1814,9 +1844,6 @@
       <optional>
         <ref name="termsubject"/>
       </optional>
-      <optional>
-        <ref name="termusage"/>
-      </optional>
       <oneOrMore>
         <ref name="termdefinition"/>
       </oneOrMore>
@@ -1880,17 +1907,37 @@
       </attribute>
     </optional>
     <optional>
-      <attribute name="geographicArea"/>
+      <attribute name="geographic-area"/>
     </optional>
     <choice>
       <ref name="expression_designation"/>
       <ref name="letter_symbol_designation"/>
       <ref name="graphical_symbol_designation"/>
     </choice>
+    <optional>
+      <ref name="fieldofapplication"/>
+    </optional>
+    <optional>
+      <ref name="usageinfo"/>
+    </optional>
     <zeroOrMore>
       <ref name="termsource"/>
     </zeroOrMore>
   </define>
+  <define name="fieldofapplication">
+    <element name="field-of-application">
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="usageinfo">
+    <element name="usage-info">
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="letter_symbol_designation">
     <element name="letter-symbol">
       <optional>
@@ -1942,11 +1989,15 @@
       </optional>
       <element name="name">
         <zeroOrMore>
-          <ref name="PureTextElement"/>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
         </zeroOrMore>
       </element>
       <optional>
-        <element name="abbreviationType">
+        <element name="abbreviation-type">
           <ref name="AbbreviationType"/>
         </element>
       </optional>
@@ -1956,7 +2007,7 @@
         </element>
       </optional>
       <optional>
-        <element name="grammarInfo">
+        <element name="grammar">
           <ref name="Grammar"/>
         </element>
       </optional>
@@ -1983,6 +2034,11 @@
         <ref name="GrammarGender"/>
       </element>
     </zeroOrMore>
+    <zeroOrMore>
+      <element name="number">
+        <ref name="GrammarNumber"/>
+      </element>
+    </zeroOrMore>
     <optional>
       <element name="isPreposition">
         <data type="boolean"/>
@@ -2014,7 +2070,7 @@
       </element>
     </optional>
     <zeroOrMore>
-      <element name="grammarvalue">
+      <element name="grammar-value">
         <text/>
       </element>
     </zeroOrMore>
@@ -2027,6 +2083,13 @@
       <value>common</value>
     </choice>
   </define>
+  <define name="GrammarNumber">
+    <choice>
+      <value>singular</value>
+      <value>dual</value>
+      <value>plural</value>
+    </choice>
+  </define>
   <define name="termdomain">
     <element name="domain">
       <oneOrMore>
@@ -2041,13 +2104,6 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="termusage">
-    <element name="usageinfo">
-      <oneOrMore>
-        <ref name="BasicBlock"/>
-      </oneOrMore>
-    </element>
-  </define>
   <define name="termdefinition">
     <element name="definition">
       <choice>
@@ -2061,9 +2117,17 @@
     </element>
   </define>
   <define name="verbaldefinition">
-    <element name="verbaldefinition">
+    <element name="verbal-definition">
       <oneOrMore>
-        <ref name="paragraph"/>
+        <choice>
+          <ref name="paragraph"/>
+          <ref name="dl"/>
+          <ref name="ol"/>
+          <ref name="ul"/>
+          <ref name="table"/>
+          <ref name="figure"/>
+          <ref name="formula"/>
+        </choice>
       </oneOrMore>
       <zeroOrMore>
         <ref name="termsource"/>
@@ -2071,7 +2135,7 @@
     </element>
   </define>
   <define name="nonverbalrep">
-    <element name="nonverbalrepresentation">
+    <element name="non-verbal-representation">
       <oneOrMore>
         <choice>
           <ref name="table"/>
@@ -2163,6 +2227,12 @@
           <value>modified</value>
         </choice>
       </attribute>
+      <attribute name="type">
+        <choice>
+          <value>authoritative</value>
+          <value>lineage</value>
+        </choice>
+      </attribute>
       <ref name="origin"/>
       <optional>
         <ref name="modification"/>
@@ -2480,4 +2550,17 @@
       </oneOrMore>
     </element>
   </define>
+  <define name="floating-title">
+    <element name="floating-title">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <attribute name="depth">
+        <data type="int"/>
+      </attribute>
+      <zeroOrMore>
+        <ref name="TextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
 </grammar>

data/lib/metanorma/generic/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Generic
-    VERSION = "1.11.0".freeze
+    VERSION = "2.0.0".freeze
   end
 end

data/lib/metanorma/generic.rb

@@ -3,8 +3,9 @@ require "metanorma/generic/version"
 require "forwardable"
 require "yaml"
 
+
 module Metanorma
-  module Generic
+  module Generic # rubocop:disable Style/MutableConstant
     ORGANIZATION_NAME_SHORT = "Acme"
     ORGANIZATION_NAME_LONG = "Acme Corp."
     DOCUMENT_NAMESPACE = "https://www.metanorma.org/ns/generic"
@@ -63,23 +64,10 @@ module Metanorma
       ].freeze
 
       def filepath_attrs
-        %i[
-          i18nyaml
-          boilerplate
-          logo_path
-          logo_paths
-          header
-          htmlcoverpage
-          htmlintropage
-          htmlstylesheet
-          scripts
-          scripts_pdf
-          standardstylesheet
-          validate_rng_file
-          wordcoverpage
-          wordintropage
-          wordstylesheet
-        ]
+        %i[i18nyaml boilerplate logo_path logo_paths header
+           htmlcoverpage htmlintropage htmlstylesheet scripts scripts_pdf
+           standardstylesheet validate_rng_file wordcoverpage wordintropage
+           wordstylesheet]
       end
 
       attr_accessor(*CONFIG_ATTRS)
@@ -88,7 +76,7 @@ module Metanorma
         attr_accessor :_file
       end
 
-      def self.inherited(klass)
+      def self.inherited(klass) # rubocop:disable Lint/MissingSuper
         klass._file = caller_locations(1..1).first.absolute_path
       end
 
@@ -115,7 +103,8 @@ module Metanorma
 
       def set_default_values_from_yaml_file(config_file)
         root_path = File.dirname(self.class::_file || __FILE__)
-        default_config_options = YAML.load(File.read(config_file))
+        default_config_options =
+          YAML.safe_load(File.read(config_file, encoding: "UTF-8"))
         if default_config_options["doctypes"].is_a? Array
           default_config_options["doctypes"] =
             default_config_options["doctypes"].each_with_object({}) do |k, m|
@@ -133,7 +122,7 @@ module Metanorma
       end
 
       def blank?(val)
-        val.nil? || val.respond_to?(:empty?) && val.empty?
+        val.nil? || (val.respond_to?(:empty?) && val.empty?)
       end
 
       def absolute_path(value, root_path)

data/lib/metanorma-generic.rb

@@ -1,6 +1,6 @@
 require "metanorma/generic"
 require "asciidoctor"
-require "asciidoctor/generic"
+require "metanorma/generic/converter"
 require "isodoc/generic"
 
 if defined? Metanorma

data/metanorma-generic.gemspec

@@ -27,10 +27,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.add_dependency "htmlentities", "~> 4.3.4"
-  spec.add_dependency "metanorma-standoc", "~> 1.11.0"
+  spec.add_dependency "metanorma-standoc", "~> 2.0.0"
   spec.add_dependency "ruby-jing"
 
-  spec.add_development_dependency "byebug", "~> 9.1"
+  spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"

data/metanorma.yml.example

@@ -7,7 +7,7 @@ logo_path: /metanorma-mine/lib/isodoc/mine/html/logo.jpg
 logo_paths: 
   - /metanorma-mine/lib/isodoc/mine/html/logo1.jpg
   - /metanorma-mine/lib/isodoc/mine/html/logo2.jpg
-validate_rng_file: /metanorma-mine/lib/asciidoctor/mine/mine.rng
+validate_rng_file: /metanorma-mine/lib/metanorma/mine/mine.rng
 htmlcoverpage: /metanorma-mine/lib/isodoc/mine/html/html_mine_titlepage.html
 htmlintropage: /metanorma-mine/lib/isodoc/mine/html/html_mine_intro.html
 htmlstylesheet: /metanorma-mine/lib/isodoc/mine/html/htmlstyle.scss