metanorma-standoc 3.1.4 → 3.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07dd4263f3139ccb6d6f742e52e7ccf48a4d5f585dc442fd4fe22019f68a2173
-  data.tar.gz: 013cd7e28bb591c2b09b138de8debe85831bc30460ed6192aae2dd9d4434de89
+  metadata.gz: 101539eb3a9ab93dced9b971970f3ff3901d7d85de59be1cac19e92495b0e9d3
+  data.tar.gz: f628e233575e4b13e92aeb6980fd42c9b97e05256f8e859f892fbb71643247f1
 SHA512:
-  metadata.gz: 4a856c20cb73fb75982c1e473d5d959e1aeed8cd1354eb53af33d612d8769e03b4f85229bfd93adaafb0840e1a4071eca7c99e49e4ed5ae0dd2211e55d6ec8fa
-  data.tar.gz: bcc1fa89fe0ddd3b33c0bf9d0bd7696a1668a9d123b289aff61d4f82969bcdc54c7dc0088e7debb3d3256221eefbc5609b8e0ac3d074c62dfcbde826e5b995e7
+  metadata.gz: '0943020cfe1c2a7a7947f470c0443ff200cbb5ca894b8268dda16e66e8e310f810cb0c0dc64d495b544c987d14995bd5e57d69ac25e61432a3b563bf1b8f2036'
+  data.tar.gz: 1d68cd3ebd13e2681442a65975201ce39bdcf84eaa6f7b299345716e0b091129babaea12eb6faf5af207415af45a5d4a39cf59c362659156fcdf635f8f9b86f4

data/lib/metanorma/standoc/cleanup_section_names.rb

@@ -51,9 +51,9 @@ module Metanorma
       NO_SYMABBR = "[.//definitions[not(@type)]]".freeze
       SYMABBR = "[.//definitions[@type = 'symbols']]" \
                 "[.//definitions[@type = 'abbreviated_terms']]".freeze
-      SYMnoABBR = "[.//definitions[@type = 'symbols']]" \
+      SYM_NO_ABBR = "[.//definitions[@type = 'symbols']]" \
                   "[not(.//definitions[@type = 'abbreviated_terms'])]".freeze
-      ABBRnoSYM = "[.//definitions[@type = 'abbreviated_terms']]" \
+      ABBR_NO_SYM = "[.//definitions[@type = 'abbreviated_terms']]" \
                   "[not(.//definitions[@type = 'symbols'])]".freeze
 
       def section_names_terms_cleanup(xml)
@@ -81,9 +81,9 @@ module Metanorma
 
       def section_names_terms1_cleanup(xml)
         auto_name_terms(xml) or return
-        replace_title(xml, "//terms#{SYMnoABBR} | //clause[@type = 'terms']#{SYMnoABBR}",
+        replace_title(xml, "//terms#{SYM_NO_ABBR} | //clause[@type = 'terms']#{SYM_NO_ABBR}",
                       @i18n&.termsdefsymbols, true)
-        replace_title(xml, "//terms#{ABBRnoSYM} | //clause[@type = 'terms']#{ABBRnoSYM}",
+        replace_title(xml, "//terms#{ABBR_NO_SYM} | //clause[@type = 'terms']#{ABBR_NO_SYM}",
                       @i18n&.termsdefabbrev, true)
         replace_title(xml, "//terms#{SYMABBR} | //clause[@type = 'terms']#{SYMABBR}",
                       @i18n&.termsdefsymbolsabbrev, true)
@@ -124,12 +124,12 @@ module Metanorma
                 unless acc[:parent] == :term # don't count Term > Term twice
                   :term
                 end
-              elsif hasterm && node.at("./self::*#{SYMnoABBR}") then :tsna
-              elsif hasterm && node.at("./self::*#{ABBRnoSYM}") then :tans
+              elsif hasterm && node.at("./self::*#{SYM_NO_ABBR}") then :tsna
+              elsif hasterm && node.at("./self::*#{ABBR_NO_SYM}") then :tans
               elsif hasterm && node.at("./self::*#{SYMABBR}") then :tsa
               elsif hasterm && node.at("./self::*#{NO_SYMABBR}") then :tnsa
-              elsif node.at("./self::*#{SYMnoABBR}") then :sna
-              elsif node.at("./self::*#{ABBRnoSYM}") then :ans
+              elsif node.at("./self::*#{SYM_NO_ABBR}") then :sna
+              elsif node.at("./self::*#{ABBR_NO_SYM}") then :ans
               elsif node.at("./self::*#{SYMABBR}") then :sa
               elsif node.at("./self::*#{NO_SYMABBR}") then :nsa
               elsif node.name == "definitions" # ignore

data/lib/metanorma/standoc/converter.rb

@@ -34,11 +34,10 @@ module Metanorma
         block Metanorma::Plugin::Lutaml::LutamlGmlDictionaryBlock
         block_macro Metanorma::Plugin::Lutaml::LutamlKlassTableBlockMacro
         block_macro Metanorma::Plugin::Lutaml::LutamlEnumTableBlockMacro
+        block Metanorma::Plugin::Plantuml::BlockProcessor
         preprocessor Metanorma::Standoc::EmbedIncludeProcessor
         preprocessor Metanorma::Standoc::LinkProtectPreprocessor
         preprocessor Metanorma::Standoc::PassProtectPreprocessor
-        preprocessor Metanorma::Standoc::Datamodel::AttributesTablePreprocessor
-        preprocessor Metanorma::Standoc::Datamodel::DiagramPreprocessor
         preprocessor Metanorma::Plugin::Lutaml::Json2TextPreprocessor
         preprocessor Metanorma::Plugin::Lutaml::Yaml2TextPreprocessor
         preprocessor Metanorma::Plugin::Lutaml::Data2TextPreprocessor
@@ -81,7 +80,6 @@ module Metanorma
         inline_macro Metanorma::Standoc::SourceIncludeInlineMacro
         block Metanorma::Standoc::ToDoAdmonitionBlock
         block Metanorma::Standoc::EditorAdmonitionBlock
-        block Metanorma::Standoc::PlantUMLBlockMacro
         block Metanorma::Standoc::PseudocodeBlockMacro
         block_macro Metanorma::Standoc::ColumnBreakBlockMacro
       end

data/lib/metanorma/standoc/front_committee.rb

@@ -90,11 +90,13 @@ module Metanorma
                   agency_abbrev: opts.dig(:agency_abbrev, i), abbr: opts[:abbr],
                   committee: opts[:committee], default_org: opts[:default_org])
         end
-        org_attrs_add_committees(node, ret, opts, opts_orig)
+        if !opts_orig[:groups] || opts_orig[:groups].empty? then ret.first
+        else org_attrs_add_committees(node, ret, opts, opts_orig)
+        end
       end
 
       def org_attrs_add_committees(node, ret, opts, opts_orig)
-        opts_orig[:groups]&.each_with_index do |g, i|
+        opts_orig[:groups].each_with_index do |g, i|
           i.zero? and next
           contributors_committees_pad_multiples(ret.first, node, g)
           opts = committee_contrib_org_prep(node, g, nil, opts_orig)

data/lib/metanorma/standoc/front_contributor.rb

@@ -5,13 +5,22 @@ module Metanorma
   module Standoc
     module Front
       def metadata_author(node, xml)
-        org_contributor(node, xml,
-                        { source: ["publisher", "pub"], role: "author",
-                          default: default_publisher })
+        org_author(node, xml)
         personal_author(node, xml)
         committee_contributors(node, xml, default_publisher, {})
       end
 
+      def org_author(node, xml)
+        if node.attr("corporate-author")
+          org_contributor(node, xml, { source: ["corporate-author"],
+                                       role: "author" })
+        else
+          org_contributor(node, xml,
+                          { source: ["publisher", "pub"], role: "author",
+                            default: default_publisher })
+        end
+      end
+
       def personal_author(node, xml)
         (node.attr("fullname") || node.attr("surname")) and
           personal_author1(node, xml, "")

data/lib/metanorma/standoc/isodoc.rng

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
-<!-- VERSION v2.1.1 -->
+<!-- VERSION v2.1.2 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -123,6 +123,10 @@ the type attribute defaults to `review` for reviews</a:documentation>
           <a:documentation>Notes whose scope is the current block</a:documentation>
         </ref>
       </zeroOrMore>
+      <ref name="BlockSource">
+        <a:documentation>Bibliographic source for the information in the list.
+Sources are currently only rendered in metanorma-plateau</a:documentation>
+      </ref>
     </define>
     <define name="OlBody">
       <optional>
@@ -140,6 +144,10 @@ the type attribute defaults to `review` for reviews</a:documentation>
           <a:documentation>Notes whose scope is the current block</a:documentation>
         </ref>
       </zeroOrMore>
+      <ref name="BlockSource">
+        <a:documentation>Bibliographic source for the information in the list.
+Sources are currently only rendered in metanorma-plateau</a:documentation>
+      </ref>
     </define>
     <define name="OlAttributes">
       <a:documentation>NOTE: `start` attribute is not included by default, because of problems it raises with DOC output</a:documentation>
@@ -188,6 +196,10 @@ the type attribute defaults to `review` for reviews</a:documentation>
           <a:documentation>Notes whose scope is the current block</a:documentation>
         </ref>
       </zeroOrMore>
+      <ref name="BlockSource">
+        <a:documentation>Bibliographic source for the information in the list.
+Sources are currently only rendered in metanorma-plateau</a:documentation>
+      </ref>
     </define>
     <define name="dt">
       <element name="dt">
@@ -871,6 +883,12 @@ titlecase, or lowercase</a:documentation>
       </oneOrMore>
     </element>
   </define>
+  <define name="ParagraphFnBody" combine="interleave">
+    <ref name="BlockSource">
+      <a:documentation>Bibliographic source for the information in the paragraph
+parargaph sources are currently only rendered in metanorma-plateau</a:documentation>
+    </ref>
+  </define>
   <define name="BasicBlock" combine="choice">
     <ref name="columnbreak"/>
   </define>

data/lib/metanorma/standoc/macros.rb

@@ -2,16 +2,14 @@ require "uuidtools"
 require "yaml"
 require "csv"
 require_relative "macros_inline"
-require_relative "macros_plantuml"
 require_relative "macros_terms"
 require_relative "macros_form"
 require_relative "macros_note"
 require_relative "macros_embed"
 require_relative "macros_link"
-require_relative "datamodel/attributes_table_preprocessor"
-require_relative "datamodel/diagram_preprocessor"
 require "metanorma-plugin-glossarist"
 require "metanorma-plugin-lutaml"
+require "metanorma-plugin-plantuml"
 
 module Metanorma
   module Standoc

data/lib/metanorma/standoc/utils.rb

@@ -154,7 +154,17 @@ module Metanorma
           #{text}
         ADOC
         c = Asciidoctor.convert(doc, backend: flavour, header_footer: true)
-        Nokogiri::XML(c).at("//xmlns:sections")
+        ret = Nokogiri::XML(c).at("//xmlns:sections")
+        separate_numbering_footnotes(ret)
+      end
+
+      # separate numbering of externally sourced footnotes
+      # from that of current doc
+      def separate_numbering_footnotes(docxml)
+        docxml.xpath("//xmlns:fn").each do |f|
+          f["reference"] = "_#{UUIDTools::UUID.random_create}_#{f['reference']}"
+        end
+        docxml
       end
 
       def asciimath_key(sym)

data/lib/metanorma/standoc/validate.rb

@@ -28,7 +28,7 @@ module Metanorma
         math_validate(doc)
         fatalerrors = @log.abort_messages
         fatalerrors.empty? or
-          clean_abort("\n\nFATAL ERRROS:\n\n#{fatalerrors.join("\n\n")}", doc)
+          clean_abort("\n\nFATAL ERRORS:\n\n#{fatalerrors.join("\n\n")}", doc)
       end
 
       MATHML_NS = "http://www.w3.org/1998/Math/MathML".freeze

data/lib/metanorma/standoc/validate_section.rb

@@ -31,11 +31,21 @@ module Metanorma
         @log.add("Style", node, w)
       end
 
+      def reject_metanorma_extension
+        ->(node) {
+          node.ancestors.detect do |x|
+            x.name == "metanorma-extension"
+          end
+        }
+      end
+
       def asset_title_style(root)
-        root.xpath("//figure[image][not(name)]").each do |node|
+        root.xpath("//figure[image][not(name)]")
+          .reject(&reject_metanorma_extension).each do |node|
           style_warning(node, "Figure should have title", nil)
         end
-        root.xpath("//table[not(name)]").each do |node|
+        root.xpath("//table[not(name)]")
+          .reject(&reject_metanorma_extension).each do |node|
           style_warning(node, "Table should have title", nil)
         end
       end

data/lib/metanorma/standoc/validate_table.rb

@@ -15,7 +15,8 @@ module Metanorma
       end
 
       def empty_table_validate(doc)
-        doc.xpath("//table[not(.//tr)]").each do |t|
+        doc.xpath("//table[not(.//tr)]").reject(&reject_metanorma_extension)
+          .each do |t|
           @log.add("Table", t, "Empty table", severity: 0)
         end
       end
@@ -30,6 +31,7 @@ module Metanorma
       end
 
       def maxrowcols_validate(table, maxcols, mode: "row_cols")
+        reject_metanorma_extension.call(table) and return
         case mode
         when "row_cols"
           maxrowcols_validate0(table, maxcols, "*", mode)

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "3.1.4".freeze
+    VERSION = "3.1.5".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "metanorma", ">= 1.6.0"
   spec.add_dependency "metanorma-plugin-glossarist", "~> 0.2.3"
   spec.add_dependency "metanorma-plugin-lutaml", "~> 0.7.31"
+  spec.add_dependency "metanorma-plugin-plantuml", "~> 1.0.0"
   spec.add_dependency "metanorma-utils", "~> 1.11.0"
   spec.add_dependency "ruby-jing"
   # relaton-cli not just relaton, to avoid circular reference in metanorma

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 3.1.4
+  version: 3.1.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-18 00:00:00.000000000 Z
+date: 2025-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.31
+- !ruby/object:Gem::Dependency
+  name: metanorma-plugin-plantuml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: metanorma-utils
   requirement: !ruby/object:Gem::Requirement
@@ -447,9 +461,6 @@ files:
 - lib/asciidoctor/standoc/cleanup_toc.rb
 - lib/asciidoctor/standoc/cleanup_xref.rb
 - lib/asciidoctor/standoc/converter.rb
-- lib/asciidoctor/standoc/datamodel/attributes_table_preprocessor.rb
-- lib/asciidoctor/standoc/datamodel/diagram_preprocessor.rb
-- lib/asciidoctor/standoc/datamodel/plantuml_renderer.rb
 - lib/asciidoctor/standoc/deprecated.rb
 - lib/asciidoctor/standoc/front.rb
 - lib/asciidoctor/standoc/front_contributor.rb
@@ -458,7 +469,6 @@ files:
 - lib/asciidoctor/standoc/macros.rb
 - lib/asciidoctor/standoc/macros_form.rb
 - lib/asciidoctor/standoc/macros_note.rb
-- lib/asciidoctor/standoc/macros_plantuml.rb
 - lib/asciidoctor/standoc/macros_terms.rb
 - lib/asciidoctor/standoc/ref.rb
 - lib/asciidoctor/standoc/ref_sect.rb
@@ -515,9 +525,6 @@ files:
 - lib/metanorma/standoc/cleanup_toc.rb
 - lib/metanorma/standoc/cleanup_xref.rb
 - lib/metanorma/standoc/converter.rb
-- lib/metanorma/standoc/datamodel/attributes_table_preprocessor.rb
-- lib/metanorma/standoc/datamodel/diagram_preprocessor.rb
-- lib/metanorma/standoc/datamodel/plantuml_renderer.rb
 - lib/metanorma/standoc/front.rb
 - lib/metanorma/standoc/front_committee.rb
 - lib/metanorma/standoc/front_contributor.rb
@@ -534,7 +541,6 @@ files:
 - lib/metanorma/standoc/macros_inline.rb
 - lib/metanorma/standoc/macros_link.rb
 - lib/metanorma/standoc/macros_note.rb
-- lib/metanorma/standoc/macros_plantuml.rb
 - lib/metanorma/standoc/macros_terms.rb
 - lib/metanorma/standoc/merge_bibitems.rb
 - lib/metanorma/standoc/processor.rb
@@ -561,8 +567,6 @@ files:
 - lib/metanorma/standoc/validate_table.rb
 - lib/metanorma/standoc/validate_term.rb
 - lib/metanorma/standoc/version.rb
-- lib/metanorma/standoc/views/datamodel/model_representation.adoc.erb
-- lib/metanorma/standoc/views/datamodel/plantuml_representation.adoc.erb
 - metanorma-standoc.gemspec
 homepage: https://github.com/metanorma/metanorma-standoc
 licenses:

data/lib/asciidoctor/standoc/datamodel/attributes_table_preprocessor.rb

@@ -1,3 +0,0 @@
-require "asciidoctor/standoc/deprecated"
-require "metanorma/standoc/datamodel/attributes_table_preprocessor"
-

data/lib/asciidoctor/standoc/datamodel/diagram_preprocessor.rb

@@ -1,3 +0,0 @@
-require "asciidoctor/standoc/deprecated"
-require "metanorma/standoc/datamodel/diagram_preprocessor"
-

data/lib/asciidoctor/standoc/datamodel/plantuml_renderer.rb

@@ -1,8 +0,0 @@
-require "asciidoctor/standoc/deprecated"
-require "metanorma/standoc/datamodel/plantuml_renderer"
-
-module Asciidoctor
-  module Datamodel
-    PlantumlRenderer = Metanorma::Datamodel::PlantumlRenderer
-  end
-end

data/lib/asciidoctor/standoc/macros_plantuml.rb

@@ -1,2 +0,0 @@
-require "asciidoctor/standoc/deprecated"
-require "metanorma/standoc/macros_plantuml"

data/lib/metanorma/standoc/datamodel/attributes_table_preprocessor.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require "erb"
-
-module Metanorma
-  module Standoc
-    module Datamodel
-      class AttributesTablePreprocessor < Asciidoctor::Extensions::Preprocessor
-        BLOCK_START_REGEXP = /\{(.+?)\.\*,(.+),(.+)\}/
-        BLOCK_END_REGEXP = /\A\{[A-Z]+\}\z/
-        MARCO_REGEXP = /\[datamodel_attributes_table,([^,]+),?(.+)?\]/
-        TEMPLATES_PATH = File.expand_path("../views/datamodel", __dir__).freeze
-        # search document for block `datamodel_attributes_table`
-        #  read include derectives that goes after that in block and transform
-        #  into yaml2text blocks
-        def process(document, reader)
-          input_lines = reader.lines.to_enum
-          Asciidoctor::PreprocessorReader.new(document, processed_lines(document, input_lines))
-        end
-
-        private
-
-        def processed_lines(document, input_lines)
-          input_lines.each_with_object([]) do |line, result|
-            if match = line.match(MARCO_REGEXP)
-              yaml_path = match[1]
-              result.push(*parse_marco(yaml_path, document))
-            else
-              result.push(line)
-            end
-          end
-        end
-
-        def parse_marco(yaml_path, document)
-          model_representation(yaml_relative_path(yaml_path, document))
-            .split("\n")
-        end
-
-        def model_representation(model_path)
-          template = File.read(File.join(
-                                 TEMPLATES_PATH,
-                                 "model_representation.adoc.erb",
-                               ))
-          file_name = File.basename(model_path).gsub(/\.ya?ml/, "")
-          ERB
-            .new(template)
-            .result(binding)
-        end
-
-        def yaml_relative_path(file_path, document)
-          directory = File.dirname(document.attributes["docfile"] || ".")
-          document.path_resolver.system_path(file_path, directory)
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standoc/datamodel/diagram_preprocessor.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-require "erb"
-require "metanorma/standoc/datamodel/plantuml_renderer"
-
-module Metanorma
-  module Standoc
-    module Datamodel
-      class DiagramPreprocessor < Asciidoctor::Extensions::Preprocessor
-        BLOCK_START_REGEXP = /\{(.+?)\.\*,(.+),(.+)\}/.freeze
-        BLOCK_END_REGEXP = /\A\{[A-Z]+\}\z/.freeze
-        MARCO_REGEXP = /\[datamodel_diagram,([^,]+),?(.+)?\]/.freeze
-        TEMPLATES_PATH = File.expand_path("../views/datamodel", __dir__).freeze
-        # search document for block `datamodel_diagram`
-        #  read include derectives that goes after that in block and transform
-        #  into plantuml block
-        def process(document, reader)
-          input_lines = reader.lines.to_enum
-          Asciidoctor::PreprocessorReader.new(document, processed_lines(document, input_lines))
-        end
-
-        private
-
-        def processed_lines(document, input_lines)
-          input_lines.each_with_object([]) do |line, result|
-            if match = line.match(MARCO_REGEXP)
-              result
-                .push(*parse_datamodel_marco(match[1], match[2], document))
-            else
-              result.push(line)
-            end
-          end
-        end
-
-        def parse_datamodel_marco(yaml_path, include_path, document)
-          include_path ||= File.join(File.dirname(yaml_path), "..", "models")
-          include_path = yaml_relative_path(include_path, document)
-          yaml_relative_to_doc_path = yaml_relative_path(yaml_path, document)
-          view_hash = YAML.safe_load(File.read(yaml_relative_to_doc_path))
-          plantuml_representations(view_hash,
-                                   yaml_relative_to_doc_path,
-                                   include_path)
-        end
-
-        def yaml_relative_path(file_path, document)
-          docfile = document.attributes["docfile"] || "."
-          docfile_directory = File.dirname(docfile)
-          document.path_resolver.system_path(file_path, docfile_directory)
-        end
-
-        def import_format(include_path, import_name, values)
-          include_content = File.read(File.join(
-                                        include_path,
-                                        "#{import_name}.yml",
-                                      ))
-          content = YAML.safe_load(include_content)
-          if values
-            content["skipSection"] = values["skipSection"]
-          end
-          content
-        end
-
-        def format_import_directives(imports, include_path)
-          imports
-            .each_with_object({}) do |(import_name, values), res|
-              full_model_name = import_name.split("/").join
-              content = import_format(include_path, import_name, values)
-              res[content["name"] || full_model_name] = content
-            end.compact
-        end
-
-        def prepare_view_hash(view_hash, all_imports)
-          view_hash.merge!(
-            "classes" => model_type(all_imports, "class"),
-            "enums" => model_type(all_imports, "enum"),
-            "relations" => view_hash["relations"] || [],
-            "fidelity" => (view_hash["fidelity"] || {})
-                          .merge!("classes" => model_type(all_imports,
-                                                          "class")),
-          )
-        end
-
-        def model_type(imports, type)
-          imports
-            .select do |_name, elem|
-              elem["modelType"] == type
-            end
-        end
-
-        def plantuml_representations(view_hash, view_path, include_path)
-          yaml_directory = File.dirname(view_path)
-          all_imports = format_import_directives(view_hash["imports"],
-                                                 include_path)
-          prepare_view_hash(view_hash, all_imports)
-          Metanorma::Datamodel::PlantumlRenderer
-            .new(view_hash, File.join(yaml_directory, ".."))
-            .render
-            .split("\n")
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standoc/datamodel/plantuml_renderer.rb

@@ -1,409 +0,0 @@
-# frozen_string_literal: true
-
-require "erb"
-
-module Metanorma
-  module Datamodel
-    class PlantumlRenderer
-      TEMPLATES_PATH = File.expand_path("../views/datamodel", __dir__).freeze
-
-      attr_reader :yml, :plantuml_path
-
-      def initialize(yml, plantuml_path)
-        @yml = yml
-        @plantuml_path = plantuml_path
-      end
-
-      def join_as_plantuml(*ary)
-        ary.compact.join("\n").sub(/(?<!\s)\s+\Z/, "")
-      end
-
-      def render
-        ERB.new(
-          File.read(
-            File.join(TEMPLATES_PATH, "plantuml_representation.adoc.erb"),
-          ),
-        ).result(binding)
-      end
-
-      def diagram_caption
-        yml["caption"]
-      end
-
-      def imports_yml_to_plantuml
-        return if empty?(yml, "imports")
-
-        <<~TEMPLATE
-          '******* IMPORTS ******************************************************
-          !include #{plantuml_path}/style.uml.inc
-        TEMPLATE
-      end
-
-      def class_defs_yml_to_plantuml
-        return if empty?(yml, "classes") && empty?(yml, "enums")
-
-        <<~TEMPLATE
-          '******* CLASS DEFINITIONS ********************************************
-          #{join_as_plantuml(
-            classes_to_classes_plantuml(yml['classes']),
-            enums_to_enums_plantuml(yml['enums']),
-          )}
-        TEMPLATE
-      end
-
-      def class_groups_yml_to_plantuml
-        return if empty?(yml, "groups")
-
-        <<~TEMPLATE
-          '******* CLASS GROUPS *************************************************
-          #{join_as_plantuml(
-            groups_to_plantuml(yml['groups']),
-          )}
-        TEMPLATE
-      end
-
-      def class_relations_yml_to_plantuml
-        return if empty?(yml, "classes") && empty?(yml, "relations")
-
-        <<~TEMPLATE
-          '******* CLASS RELATIONS **********************************************
-          #{join_as_plantuml(
-            classes_to_relations_plantuml(yml['classes']),
-            relations_to_plantuml(nil, yml['relations']),
-          )}
-        TEMPLATE
-      end
-
-      def diagram_options_yml_to_plantuml
-        return if empty?(yml, "diagram_options")
-
-        <<~TEMPLATE
-          '******* DIAGRAM SPECIFIC CONFIG **************************************
-          #{join_as_plantuml(
-            diagram_options_to_plantuml(yml['diagram_options']),
-          )}
-        TEMPLATE
-      end
-
-      def bottom_yml_to_plantuml
-        return if empty?(yml, "bottom")
-
-        <<~TEMPLATE
-          '******* BOTTOM OVERRIDE CONFIG **************************************
-          #{join_as_plantuml(bottom_to_plantuml(yml['bottom']))}
-        TEMPLATE
-      end
-
-      def fidelity_yml_to_plantuml
-        return if empty?(yml, "fidelity")
-
-        <<~TEMPLATE
-          '******* FIDELITY *****************************************************
-          #{join_as_plantuml(fidelity_to_plantuml(yml['fidelity']))}
-        TEMPLATE
-      end
-
-      def classes_to_classes_plantuml(classes)
-        classes ||= {}
-
-        return if classes.empty?
-
-        classes.map do |(class_name, class_hash)|
-          class_to_plantuml(class_name, class_hash)
-        end.join("\n")
-      end
-
-      def class_to_plantuml(class_name, class_hash)
-        return unless class_name
-
-        class_hash ||= {}
-
-        <<~TEMPLATE
-          class #{class_name}#{model_stereotype_to_plantuml(class_hash['type'])} {
-          #{join_as_plantuml(
-            attributes_to_plantuml(class_hash['attributes']),
-            constraints_to_plantuml(class_hash['constraints']),
-          )}
-          }
-        TEMPLATE
-      end
-
-      def attributes_to_plantuml(attributes)
-        return unless attributes
-
-        attributes.map do |(attr_name, attr_hash)|
-          attribute_to_plantuml(attr_name, attr_hash)
-        end.join("").sub(/\n\Z/, "")
-      end
-
-      def attribute_to_plantuml(attr_name, attr_hash)
-        <<~TEMPLATE
-          +#{attr_name}: #{attr_hash['type']}#{attribute_cardinality_plantuml(attr_hash['cardinality'])}
-        TEMPLATE
-      end
-
-      def attribute_cardinality_plantuml(cardinality, with_bracket = true)
-        return "" if cardinality.nil? ||
-          (cardinality["min"] == cardinality["max"] &&
-            cardinality["min"] == 1)
-
-        card = "#{cardinality['min']}..#{cardinality['max']}"
-        return card unless with_bracket
-
-        "[#{card}]"
-      end
-
-      def constraints_to_plantuml(constraints)
-        constraints ||= []
-
-        return if constraints.empty?
-
-        constraints_output = constraints.map do |constraint|
-          "  {#{constraint}}"
-        end
-
-        <<~TEMPLATE
-            __ constraints __
-          #{join_as_plantuml(
-            *constraints_output,
-          )}
-        TEMPLATE
-      end
-
-      def classes_to_relations_plantuml(classes)
-        output_ary = classes.map do |(class_name, class_hash)|
-          class_hash ||= {}
-          relations = class_hash["relations"]
-          relations_to_plantuml(class_name, relations)
-        end
-
-        join_as_plantuml(*output_ary)
-      end
-
-      def relations_to_plantuml(class_name, relations)
-        return unless relations
-
-        output_ary = relations.map do |relation|
-          source = class_name || relation["source"]
-          relation_to_plantuml(source,
-                               relation["target"],
-                               relation)
-        end
-
-        join_as_plantuml(*output_ary)
-      end
-
-      def relation_arrow(relationship, relation)
-        [
-          relationship_type_to_plantuml("source",
-                                        relationship["source"]["type"]),
-          (relation["direction"]).to_s,
-          relationship_type_to_plantuml("target",
-                                        relationship["target"]["type"]),
-        ].compact.join("-")
-      end
-
-      def relation_label(action)
-        return "" unless action
-
-        case action["direction"]
-        when "source"
-          " : < #{action['verb']}"
-        when "target"
-          " : #{action['verb']} >"
-        else
-          ""
-        end
-      end
-
-      def source_arrow_end(source, relationship)
-        source_attribute = relationship_cardinality_to_plantuml(
-          relationship["source"]["attribute"],
-        )
-        [source, source_attribute].join(" ")
-      end
-
-      def target_arrow_end(target, relationship, action)
-        target_attribute = relationship_cardinality_to_plantuml(
-          relationship["target"]["attribute"],
-        )
-        [
-          [target_attribute, target].join(" "),
-          relation_label(action),
-        ].join
-      end
-
-      def relation_association(source, target, association)
-        return unless association
-
-        "\n(#{source}, #{target}) . #{association}"
-      end
-
-      def relation_to_plantuml(source, target, relation)
-        relationship = relation["relationship"] || {}
-        relationship["source"] ||= {}
-        relationship["target"] ||= {}
-        relation_output_lines(source, target, relation, relationship)
-      end
-
-      def relation_output_lines(source, target, relation, relationship)
-        output_lines = [
-          source_arrow_end(source, relationship),
-          relation_arrow(relationship, relation),
-          target_arrow_end(target, relationship, relation["action"]),
-          relation_association(source, target, relationship["association"]),
-        ].join(" ")
-
-        join_as_plantuml(*output_lines)
-      end
-
-      def relationship_type_to_plantuml(relation_end, relationship_type)
-        is_source = (relation_end == "source")
-        mappings = {
-          "direct" => is_source ? "<" : ">",
-          "inheritance" => is_source ? "<|" : "|>",
-          "composition" => "*",
-          "aggregation" => "o",
-        }
-        mappings.fetch(relationship_type, "")
-      end
-
-      def relationship_cardinality_to_plantuml(attribute)
-        attribute_name = (attribute || {}).keys.first
-
-        return unless attribute_name
-
-        attribute_hash = attribute[attribute_name] || {}
-        card = attribute_cardinality(attribute_hash["cardinality"])
-        "\"+#{attribute_name}#{card}\""
-      end
-
-      def attribute_cardinality(attribute_cardinality)
-        cardinality = ""
-        if attribute_cardinality
-          cardinality = attribute_cardinality_plantuml(
-            attribute_cardinality,
-            false,
-          )
-          cardinality = " #{cardinality}"
-        end
-        cardinality
-      end
-
-      def enums_to_enums_plantuml(enums)
-        enums ||= {}
-
-        enums.map do |(enum_name, enum_hash)|
-          enum_to_plantuml(enum_name, enum_hash)
-        end.join("\n\n")
-      end
-
-      def enum_to_plantuml(enum_name, enum_hash)
-        enum_hash ||= {}
-
-        <<~TEMPLATE
-          enum #{enum_name}#{model_stereotype_to_plantuml(enum_hash['type'])} {
-          #{join_as_plantuml(enum_values_to_plantuml(enum_hash['values']))}
-          }
-        TEMPLATE
-      end
-
-      def model_stereotype_to_plantuml(model_stereotype)
-        return "" unless model_stereotype
-
-        " <<#{model_stereotype}>>"
-      end
-
-      def enum_values_to_plantuml(enum_values)
-        output_ary = enum_values.map do |(enum_value, _enum_value_hash)|
-          "  #{enum_value}"
-        end
-
-        join_as_plantuml(*output_ary)
-      end
-
-      def groups_to_plantuml(groups)
-        groups ||= []
-        return if groups.empty?
-
-        groups.reduce("") do |output, group|
-          output += "\ntogether {\n"
-          group.each do |class_name|
-            output += "\nclass #{class_name}\n"
-          end
-          output += "\n}\n"
-          output
-        end
-      end
-
-      def diagram_options_to_plantuml(diagram_options)
-        diagram_options ||= []
-        return if diagram_options.empty?
-
-        "#{diagram_options.join("\n")}\n"
-      end
-
-      def bottom_to_plantuml(bottom)
-        bottom ||= []
-        return if bottom.empty?
-
-        "#{bottom.join("\n")}\n"
-      end
-
-      def format_hidden_class(accum, fidelity_classes, class_hash)
-        return accum if class_hash["relations"].nil?
-
-        class_hash["relations"].each_with_object(accum) do |relation, acc|
-          format_source_target_relation(relation, fidelity_classes, acc)
-          format_association_relation(relation, fidelity_classes, acc)
-        end
-      end
-
-      def format_source_target_relation(relation, fidelity_classes, acc)
-        %w[source target].each do |type|
-          next unless relation[type] && !fidelity_classes.key?(relation[type])
-
-          acc.merge!(relation[type] => true)
-        end
-      end
-
-      def format_association_relation(relation, fidelity_classes, acc)
-        return unless relation["relationship"] &&
-          relation["relationship"]["association"]
-
-        association = relation["relationship"]["association"]
-        return unless association && !fidelity_classes.key?(association)
-
-        acc.merge!(association => true)
-      end
-
-      def hide_other_classes(fidelity)
-        return "" if fidelity.nil? || fidelity["classes"].nil?
-
-        output = ""
-        hidden_classes = fidelity["classes"]
-          .reduce({}) do |acc, (_class_name, class_hash)|
-          format_hidden_class(acc, fidelity["classes"], class_hash)
-        end
-
-        hidden_classes.each_key do |hidden_class_name|
-          output += "\nhide #{hidden_class_name}\n"
-        end
-        output
-      end
-
-      def fidelity_to_plantuml(fidelity)
-        return "" if fidelity.nil?
-
-        output = ""
-        output += hide_other_classes(fidelity) if fidelity["hideOtherClasses"]
-        output += "\nhide members\n" if fidelity["hideMembers"]
-        output
-      end
-
-      def empty?(yml, prop)
-        yml[prop].nil? || yml[prop].length.zero?
-      end
-    end
-  end
-end

data/lib/metanorma/standoc/macros_plantuml.rb

@@ -1,143 +0,0 @@
-module Metanorma
-  module Standoc
-    class PlantUMLBlockMacroBackend
-      def self.plantuml_installed?
-        unless which("plantuml")
-          raise "PlantUML not installed"
-        end
-      end
-
-      def self.plantuml_bin
-        if Gem.win_platform? || which("plantumlc")
-          "plantumlc"
-        else
-          "plantuml"
-        end
-      end
-
-      def self.run(umlfile, outfile, fmt)
-        valid_formats = %w[png svg eps]
-        unless valid_formats.include?(fmt)
-          raise ArgumentError, "Invalid format: #{fmt}. Allowed formats are: #{valid_formats.join(', ')}"
-        end
-        system(plantuml_bin, umlfile.path, "-t#{fmt}") or
-          (warn $? and return false)
-        i = 0
-        until !Gem.win_platform? || File.exist?(outfile) || i == 15
-          sleep(1)
-          i += 1
-        end
-        File.exist?(outfile)
-      end
-
-      # if no :imagesdir: leave image file in plantuml
-      # sleep need for windows because dot works in separate process and
-      # plantuml process may finish earlier then dot, as result png file
-      # maybe not created yet after plantuml finish
-      #
-      # # Warning: metanorma/metanorma-standoc#187
-      # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
-      # This is why we need to copy and then unlink.
-      def self.generate_file(parent, reader)
-        ldir, imagesdir, fmt = generate_file_prep(parent)
-        umlfile, outfile = save_plantuml parent, reader, ldir, fmt
-        run(umlfile, outfile, fmt) or
-          raise "No image output from PlantUML (#{umlfile}, #{outfile})!"
-        umlfile.unlink
-        absolute_path, relative_path = path_prep(ldir, imagesdir)
-        filename = File.basename(outfile.to_s)
-        FileUtils.cp(outfile, absolute_path) and outfile.unlink
-        #imagesdir ? filename : File.join(path, filename)
-        File.join(relative_path, filename)
-      end
-
-      def self.generate_file_prep(parent)
-        ldir = localdir(parent)
-        imagesdir = parent.document.attr("imagesdir")
-        fmt = parent.document.attr("plantuml-image-format")&.strip&.downcase ||
-          "png"
-        [ldir, imagesdir, fmt]
-      end
-
-      def self.localdir(parent)
-        ret = Metanorma::Utils::localdir(parent.document)
-        File.writable?(ret) or
-          raise "Destination directory #{ret} not writable for PlantUML!"
-        ret
-      end
-
-      def self.path_prep(localdir, imagesdir)
-        #path = Pathname.new(localdir) + (imagesdir || "plantuml")
-        path = Pathname.new(File.join(localdir, "_plantuml_images"))
-        sourcepath = imagesdir ? File.join(localdir, imagesdir) : localdir
-        path.mkpath
-        File.writable?(path) or
-          raise "Destination path #{path} not writable for PlantUML!"
-        [path, Pathname.new(path).relative_path_from(Pathname.new(sourcepath)).to_s]
-      end
-
-      def self.save_plantuml(_parent, reader, _localdir, fmt)
-        src = prep_source(reader)
-        /^@startuml (?<fn>[^\n]+)\n/ =~ src
-        Tempfile.open(["plantuml", ".pml"], encoding: "utf-8") do |f|
-          f.write(src)
-          [f, File.join(File.dirname(f.path),
-                        "#{fn || File.basename(f.path, '.pml')}.#{fmt}")]
-        end
-      end
-
-      def self.prep_source(reader)
-        src = reader.source
-        reader.lines.first.sub(/(?<!\s)\s+$/, "").match /^@startuml($| )/ or
-          src = "@startuml\n#{src}\n@enduml\n"
-        %r{@enduml\s*$}m.match?(src) or
-          raise "@startuml without matching @enduml in PlantUML!"
-        src
-      end
-
-      def self.generate_attrs(attrs)
-        %w(id align float title role width height alt)
-          .inject({}) do |memo, key|
-          memo[key] = attrs[key] if attrs.has_key? key
-          memo
-        end
-      end
-
-      # https://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
-      def self.which(cmd)
-        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
-        ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
-          exts.each do |ext|
-            exe = File.join(path, "#{cmd}#{ext}")
-            return exe if File.executable?(exe) && !File.directory?(exe)
-          end
-        end
-        nil
-      end
-    end
-
-    class PlantUMLBlockMacro < Asciidoctor::Extensions::BlockProcessor
-      use_dsl
-      named :plantuml
-      on_context :literal
-      parse_content_as :raw
-
-      def abort(parent, reader, attrs, msg)
-        warn msg
-        attrs["language"] = "plantuml"
-        create_listing_block parent, reader.source,
-                             (attrs.reject { |k, _v| k == 1 })
-      end
-
-      def process(parent, reader, attrs)
-        PlantUMLBlockMacroBackend.plantuml_installed?
-        filename = PlantUMLBlockMacroBackend.generate_file(parent, reader)
-        through_attrs = PlantUMLBlockMacroBackend.generate_attrs attrs
-        through_attrs["target"] = filename
-        create_image_block parent, through_attrs
-      rescue StandardError => e
-        abort(parent, reader, attrs, e.message)
-      end
-    end
-  end
-end

data/lib/metanorma/standoc/views/datamodel/model_representation.adoc.erb

@@ -1,30 +0,0 @@
-
-[yaml2text,<%= model_path %>,definition]
-----
-
-=== {definition.name | default: "<%= file_name %>"}
-{definition.definition}
-
-{% if definition.attributes %}
-.{definition.name | default: "<%= file_name %>"} attributes
-|===
-|Name |Definition |Mandatory/ Optional/ Conditional |Max Occur |Data Type
-
-{definition.attributes.*,key,EOK}
-|{key} |{% if definition.attributes[key].definition %}{{ definition.attributes[key].definition }}{% else %}TODO: enum {{ key }}'s definition{% endif %} |{% if definition.attributes[key].cardinality.min == 0 %}O{% else %}M{% endif %} |{% if definition.attributes[key].cardinality.max == "*" %}N{% else %}1{% endif %} |{% if definition.attributes[key].origin %}<<{{ definition.attributes[key].origin }}>>{% endif %} `{definition.attributes[key].type}`
-{EOK}
-|===
-{% endif %}
-
-{% if definition['values'] %}
-.{definition.name | default: "<%= file_name %>"} values
-|===
-|Name |Definition
-
-{definition['values'].*,key,EOK}
-|{key} |{definition['values'][key].definition}
-{EOK}
-|===
-{% endif %}
-
-----

data/lib/metanorma/standoc/views/datamodel/plantuml_representation.adoc.erb

@@ -1,20 +0,0 @@
-[plantuml,title=<%= diagram_caption %>]
-....
-@startuml
-
-<%= diagram_options_yml_to_plantuml %>
-
-<%= class_groups_yml_to_plantuml %>
-
-<%= imports_yml_to_plantuml %>
-
-<%= class_defs_yml_to_plantuml %>
-
-<%= class_relations_yml_to_plantuml %>
-
-<%= fidelity_yml_to_plantuml %>
-
-<%= bottom_yml_to_plantuml %>
-
-@enduml
-....