metanorma-standoc 1.9.0 → 1.10.0

data/lib/asciidoctor/standoc/cleanup_section_names.rb

@@ -0,0 +1,75 @@
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      def get_or_make_title(node)
+        unless node.at("./title")
+          if node.children.empty?
+            node << "<title/>"
+          else
+            node.children.first.previous = "<title/>"
+          end
+        end
+        node.at("./title")
+      end
+
+      def replace_title(doc, xpath, text, first = false)
+        return unless text
+
+        doc.xpath(xpath).each_with_index do |node, i|
+          next if first && !i.zero?
+
+          title = get_or_make_title(node)
+          fn = title.xpath("./fn")
+          fn.each(&:remove)
+          title.content = text
+          fn.each { |n| title << n }
+        end
+      end
+
+      def sections_names_cleanup(xml)
+        replace_title(xml, "//clause[@type = 'scope']", @i18n&.scope)
+        replace_title(xml, "//preface//abstract", @i18n&.abstract)
+        replace_title(xml, "//foreword", @i18n&.foreword)
+        replace_title(xml, "//introduction", @i18n&.introduction)
+        replace_title(xml, "//acknowledgements", @i18n&.acknowledgements)
+        section_names_refs_cleanup(xml)
+        section_names_terms_cleanup(xml)
+      end
+
+      def section_names_refs_cleanup(xml)
+        replace_title(xml, "//references[@normative = 'true']",
+                      @i18n&.normref, true)
+        replace_title(xml, "//references[@normative = 'false']",
+                      @i18n&.bibliography, true)
+      end
+
+      NO_SYMABBR = "[.//definitions[not(@type)]]".freeze
+      SYMABBR = "[.//definitions[@type = 'symbols']]"\
+        "[.//definitions[@type = 'abbreviated_terms']]".freeze
+      SYMnoABBR = "[.//definitions[@type = 'symbols']]"\
+        "[not(.//definitions[@type = 'abbreviated_terms'])]".freeze
+      ABBRnoSYM = "[.//definitions[@type = 'abbreviated_terms']]"\
+        "[not(.//definitions[@type = 'symbols'])]".freeze
+
+      def section_names_terms_cleanup(x)
+        replace_title(x, "//definitions[@type = 'symbols']", @i18n&.symbols)
+        replace_title(x, "//definitions[@type = 'abbreviated_terms']",
+                      @i18n&.abbrev)
+        replace_title(x, "//definitions[not(@type)]", @i18n&.symbolsabbrev)
+        replace_title(x, "//terms#{SYMnoABBR} | //clause[.//terms]#{SYMnoABBR}",
+                      @i18n&.termsdefsymbols, true)
+        replace_title(x, "//terms#{ABBRnoSYM} | //clause[.//terms]#{ABBRnoSYM}",
+                      @i18n&.termsdefabbrev, true)
+        replace_title(x, "//terms#{SYMABBR} | //clause[.//terms]#{SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(x, "//terms#{NO_SYMABBR} | //clause[.//terms]#{NO_SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(
+          x,
+          "//terms[not(.//definitions)] | //clause[.//terms][not(.//definitions)]",
+          @i18n&.termsdef, true
+        )
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/cleanup_terms.rb

@@ -60,15 +60,15 @@ module Asciidoctor
 
       def term_children_cleanup(xmldoc)
         xmldoc.xpath("//term").each do |t|
-          t.xpath("./termnote").each { |n| t << n.remove }
-          t.xpath("./termexample").each { |n| t << n.remove }
-          t.xpath("./termsource").each { |n| t << n.remove }
+          %w(termnote termexample termsource).each do |w|
+            t.xpath("./#{w}").each { |n| t << n.remove }
+          end
         end
-      end 
+      end
 
       def termdef_from_termbase(xmldoc)
         xmldoc.xpath("//term").each do |x|
-          if c = x.at("./origin/termref") and !x.at("./definition")
+          if (c = x.at("./origin/termref")) && !x.at("./definition")
             x.at("./origin").previous = fetch_termbase(c["base"], c.text)
           end
         end
@@ -93,33 +93,34 @@ module Asciidoctor
         termdomain1_cleanup(xmldoc)
         termnote_example_cleanup(xmldoc)
         termdef_subclause_cleanup(xmldoc)
-        term_children_cleanup(xmldoc) 
+        term_children_cleanup(xmldoc)
         termdocsource_cleanup(xmldoc)
-      end   
+      end
 
       # Indices sort after letter but before any following
       # letter (x, x_m, x_1, xa); we use colon to force that sort order.
       # Numbers sort *after* letters; we use thorn to force that sort order.
-      def symbol_key(x)
-        key = x.dup
+      def symbol_key(sym)
+        key = sym.dup
         key.traverse do |n|
           next unless n.name == "math"
+
           n.replace(grkletters(MathML2AsciiMath.m2a(n.to_xml)))
         end
         ret = Nokogiri::XML(key.to_xml)
-        HTMLEntities.new.decode(ret.text.downcase).
-          gsub(/[\[\]\{\}<>\(\)]/, "").gsub(/\s/m, "").
-          gsub(/[[:punct:]]|[_^]/, ":\\0").gsub(/`/, "").
-          gsub(/[0-9]+/, "þ\\0")
+        HTMLEntities.new.decode(ret.text.downcase)
+          .gsub(/[\[\]{}<>()]/, "").gsub(/\s/m, "")
+          .gsub(/[[:punct:]]|[_^]/, ":\\0").gsub(/`/, "")
+          .gsub(/[0-9]+/, "þ\\0")
       end
-        
+
       def grkletters(x)
         x.gsub(/\b(alpha|beta|gamma|delta|epsilon|zeta|eta|theta|iota|kappa|lambda|mu|nu|xi|omicron|pi|rho|sigma|tau|upsilon|phi|chi|psi|omega)\b/i, "&\\1;")
       end
 
-      def extract_symbols_list(dl)
+      def extract_symbols_list(dlist)
         dl_out = []
-        dl.xpath("./dt | ./dd").each do |dtd|
+        dlist.xpath("./dt | ./dd").each do |dtd|
           if dtd.name == "dt"
             dl_out << { dt: dtd.remove, key: symbol_key(dtd) }
           else
@@ -128,7 +129,7 @@ module Asciidoctor
         end
         dl_out
       end
-          
+
       def symbols_cleanup(docxml)
         docxml.xpath("//definitions/dl").each do |dl|
           dl_out = extract_symbols_list(dl)
@@ -136,7 +137,7 @@ module Asciidoctor
           dl.children = dl_out.map { |d| d[:dt].to_s + d[:dd].to_s }.join("\n")
         end
         docxml
-      end 
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/converter.rb

@@ -41,6 +41,11 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::IndexRangeInlineMacro
         inline_macro Asciidoctor::Standoc::AddMacro
         inline_macro Asciidoctor::Standoc::DelMacro
+        inline_macro Asciidoctor::Standoc::FormInputMacro
+        inline_macro Asciidoctor::Standoc::FormLabelMacro
+        inline_macro Asciidoctor::Standoc::FormTextareaMacro
+        inline_macro Asciidoctor::Standoc::FormSelectMacro
+        inline_macro Asciidoctor::Standoc::FormOptionMacro
         block Asciidoctor::Standoc::ToDoAdmonitionBlock
         treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
         block Asciidoctor::Standoc::PlantUMLBlockMacro
@@ -78,8 +83,8 @@ module Asciidoctor
         attr_accessor :_file
       end
 
-      def self.inherited(k)
-        k._file = caller_locations.first.absolute_path
+      def self.inherited(konv) # rubocop:disable Lint/MissingSuper
+        konv._file = caller_locations(1..1).first.absolute_path
       end
 
       # path to isodoc assets in child gems

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'erb'
+require "erb"
 
 module Asciidoctor
   module Datamodel
     class PlantumlRenderer
-      TEMPLATES_PATH = File.expand_path('../views/datamodel', __dir__).freeze
+      TEMPLATES_PATH = File.expand_path("../views/datamodel", __dir__).freeze
 
       attr_reader :yml, :plantuml_path
 
@@ -15,23 +15,23 @@ module Asciidoctor
       end
 
       def join_as_plantuml(*ary)
-        ary.compact.join("\n").sub(/\s+\Z/, '')
+        ary.compact.join("\n").sub(/\s+\Z/, "")
       end
 
       def render
         ERB.new(
           File.read(
-            File.join(TEMPLATES_PATH, 'plantuml_representation.adoc.erb')
+            File.join(TEMPLATES_PATH, "plantuml_representation.adoc.erb")
           )
         ).result(binding)
       end
 
       def diagram_caption
-        yml['caption']
+        yml["caption"]
       end
 
       def imports_yml_to_plantuml
-        return if empty?(yml, 'imports')
+        return if empty?(yml, "imports")
 
         <<~TEMPLATE
           '******* IMPORTS ******************************************************
@@ -40,7 +40,7 @@ module Asciidoctor
       end
 
       def class_defs_yml_to_plantuml
-        return if empty?(yml, 'classes') && empty?(yml, 'enums')
+        return if empty?(yml, "classes") && empty?(yml, "enums")
 
         <<~TEMPLATE
           '******* CLASS DEFINITIONS ********************************************
@@ -52,7 +52,7 @@ module Asciidoctor
       end
 
       def class_groups_yml_to_plantuml
-        return if empty?(yml, 'groups')
+        return if empty?(yml, "groups")
 
         <<~TEMPLATE
           '******* CLASS GROUPS *************************************************
@@ -63,7 +63,7 @@ module Asciidoctor
       end
 
       def class_relations_yml_to_plantuml
-        return if empty?(yml, 'classes') && empty?(yml, 'relations')
+        return if empty?(yml, "classes") && empty?(yml, "relations")
 
         <<~TEMPLATE
           '******* CLASS RELATIONS **********************************************
@@ -75,7 +75,7 @@ module Asciidoctor
       end
 
       def diagram_options_yml_to_plantuml
-        return if empty?(yml, 'diagram_options')
+        return if empty?(yml, "diagram_options")
 
         <<~TEMPLATE
           '******* DIAGRAM SPECIFIC CONFIG **************************************
@@ -86,7 +86,7 @@ module Asciidoctor
       end
 
       def bottom_yml_to_plantuml
-        return if empty?(yml, 'bottom')
+        return if empty?(yml, "bottom")
 
         <<~TEMPLATE
           '******* BOTTOM OVERRIDE CONFIG **************************************
@@ -95,7 +95,7 @@ module Asciidoctor
       end
 
       def fidelity_yml_to_plantuml
-        return if empty?(yml, 'fidelity')
+        return if empty?(yml, "fidelity")
 
         <<~TEMPLATE
           '******* FIDELITY *****************************************************
@@ -133,7 +133,7 @@ module Asciidoctor
 
         attributes.map do |(attr_name, attr_hash)|
           attribute_to_plantuml(attr_name, attr_hash)
-        end.join('').sub(/\n\Z/, '')
+        end.join("").sub(/\n\Z/, "")
       end
 
       def attribute_to_plantuml(attr_name, attr_hash)
@@ -143,9 +143,10 @@ module Asciidoctor
       end
 
       def attribute_cardinality_plantuml(cardinality, with_bracket = true)
-        return '' if cardinality.nil? ||
-                     (cardinality['min'] == cardinality['max'] &&
-                       cardinality['min'] == 1)
+        return "" if cardinality.nil? ||
+          (cardinality["min"] == cardinality["max"] &&
+            cardinality["min"] == 1)
+
         card = "#{cardinality['min']}..#{cardinality['max']}"
         return card unless with_bracket
 
@@ -172,7 +173,7 @@ module Asciidoctor
       def classes_to_relations_plantuml(classes)
         output_ary = classes.map do |(class_name, class_hash)|
           class_hash ||= {}
-          relations = class_hash['relations']
+          relations = class_hash["relations"]
           relations_to_plantuml(class_name, relations)
         end
 
@@ -183,9 +184,9 @@ module Asciidoctor
         return unless relations
 
         output_ary = relations.map do |relation|
-          source = class_name || relation['source']
+          source = class_name || relation["source"]
           relation_to_plantuml(source,
-                               relation['target'],
+                               relation["target"],
                                relation)
         end
 
@@ -194,41 +195,41 @@ module Asciidoctor
 
       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('-')
+          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
+        return "" unless action
 
-        case action['direction']
-        when 'source'
+        case action["direction"]
+        when "source"
           " : < #{action['verb']}"
-        when 'target'
+        when "target"
           " : #{action['verb']} >"
         else
-          ''
+          ""
         end
       end
 
       def source_arrow_end(source, relationship)
         source_attribute = relationship_cardinality_to_plantuml(
-          relationship['source']['attribute']
+          relationship["source"]["attribute"]
         )
-        [source, source_attribute].join(' ')
+        [source, source_attribute].join(" ")
       end
 
       def target_arrow_end(target, relationship, action)
         target_attribute = relationship_cardinality_to_plantuml(
-          relationship['target']['attribute']
+          relationship["target"]["attribute"]
         )
         [
-          [target_attribute, target].join(' '),
-          relation_label(action)
+          [target_attribute, target].join(" "),
+          relation_label(action),
         ].join
       end
 
@@ -239,9 +240,9 @@ module Asciidoctor
       end
 
       def relation_to_plantuml(source, target, relation)
-        relationship = relation['relationship'] || {}
-        relationship['source'] ||= {}
-        relationship['target'] ||= {}
+        relationship = relation["relationship"] || {}
+        relationship["source"] ||= {}
+        relationship["target"] ||= {}
         relation_output_lines(source, target, relation, relationship)
       end
 
@@ -249,22 +250,22 @@ module Asciidoctor
         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(' ')
+          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')
+        is_source = (relation_end == "source")
         mappings = {
-          'direct' => is_source ? '<' : '>',
-          'inheritance' => is_source ? '<|' : '|>',
-          'composition' => '*',
-          'aggregation' => 'o'
+          "direct" => is_source ? "<" : ">",
+          "inheritance" => is_source ? "<|" : "|>",
+          "composition" => "*",
+          "aggregation" => "o",
         }
-        mappings.fetch(relationship_type, '')
+        mappings.fetch(relationship_type, "")
       end
 
       def relationship_cardinality_to_plantuml(attribute)
@@ -273,12 +274,12 @@ module Asciidoctor
         return unless attribute_name
 
         attribute_hash = attribute[attribute_name] || {}
-        card = attribute_cardinality(attribute_hash['cardinality'])
+        card = attribute_cardinality(attribute_hash["cardinality"])
         "\"+#{attribute_name}#{card}\""
       end
 
       def attribute_cardinality(attribute_cardinality)
-        cardinality = ''
+        cardinality = ""
         if attribute_cardinality
           cardinality = attribute_cardinality_plantuml(
             attribute_cardinality,
@@ -308,7 +309,7 @@ module Asciidoctor
       end
 
       def model_stereotype_to_plantuml(model_stereotype)
-        return '' unless model_stereotype
+        return "" unless model_stereotype
 
         " <<#{model_stereotype}>>"
       end
@@ -325,7 +326,7 @@ module Asciidoctor
         groups ||= []
         return if groups.empty?
 
-        groups.reduce('') do |output, group|
+        groups.reduce("") do |output, group|
           output += "\ntogether {\n"
           group.each do |class_name|
             output += "\nclass #{class_name}\n"
@@ -350,9 +351,9 @@ module Asciidoctor
       end
 
       def format_hidden_class(accum, fidelity_classes, class_hash)
-        return accum if class_hash['relations'].nil?
+        return accum if class_hash["relations"].nil?
 
-        class_hash['relations'].each_with_object(accum) do |relation, acc|
+        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
@@ -367,36 +368,36 @@ module Asciidoctor
       end
 
       def format_association_relation(relation, fidelity_classes, acc)
-        return unless relation['relationship'] &&
-                      relation['relationship']['association']
+        return unless relation["relationship"] &&
+          relation["relationship"]["association"]
 
-        association = 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?
+        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)
+        output = ""
+        hidden_classes = fidelity["classes"]
+          .reduce({}) do |acc, (_class_name, class_hash)|
+          format_hidden_class(acc, fidelity["classes"], class_hash)
         end
 
-        hidden_classes.keys.each do |hidden_class_name|
+        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?
+        return "" if fidelity.nil?
 
-        output = ''
-        output += hide_other_classes(fidelity) if fidelity['hideOtherClasses']
-        output += "\nhide members\n" if fidelity['hideMembers']
+        output = ""
+        output += hide_other_classes(fidelity) if fidelity["hideOtherClasses"]
+        output += "\nhide members\n" if fidelity["hideMembers"]
         output
       end