stepmod-utils 0.3.4 → 0.3.9

data/lib/stepmod/utils/concept.rb

@@ -1,64 +1,137 @@
+require "glossarist"
+
 module Stepmod
   module Utils
-
-    class Concept
+    class Concept < Glossarist::LocalizedConcept
       attr_accessor *%w(
-        designation
-        definition
-        reference_anchor
         reference_clause
-        examples
-        notes
-        synonym
+        reference_anchor
         converted_definition
         file_path
       )
 
-      def initialize(options)
-        options.each_pair do |k, v|
-          send("#{k}=", v)
+      class << self
+        def parse(definition_xml, reference_anchor:, reference_clause:, file_path:, language_code: "en")
+          converted_definition = Stepmod::Utils::StepmodDefinitionConverter.convert(
+            definition_xml,
+            {
+              # We don't want examples and notes
+              no_notes_examples: true,
+              reference_anchor: reference_anchor,
+            },
+          )
+
+          return nil if converted_definition.nil? || converted_definition.strip.empty?
+
+          if definition_xml.name == "ext_description"
+            converted_definition = <<~TEXT
+              #{converted_definition}
+
+              NOTE: This term is incompletely defined in this document.
+              Reference <<#{reference_anchor}>> for the complete definition.
+            TEXT
+          end
+
+          # https://github.com/metanorma/stepmod-utils/issues/86
+
+          # TODO: This portion DOES NOT HANDLE the <synonym> element. WTF??
+          if definition_xml.name == "definition"
+            designation = definition_designation(definition_xml)
+            definition = definition_xml_definition(definition_xml,
+                                                   reference_anchor)
+            converted_definition = definition_xml_converted_definition(
+              designation, definition
+            ).strip
+          end
+
+          new(
+            designations: [designation],
+            definition: definition,
+            converted_definition: converted_definition,
+            id: "#{reference_anchor}.#{reference_clause}",
+            reference_anchor: reference_anchor,
+            reference_clause: reference_clause,
+            file_path: file_path,
+            language_code: language_code,
+          )
         end
-      end
 
-      def self.parse(definition_xml, reference_anchor:, reference_clause:, file_path:)
-        converted_definition = Stepmod::Utils::StepmodDefinitionConverter.convert(
-          definition_xml,
+        def definition_designation(definition_xml)
+          # We take the <p> that is an alternative term (length<=20).
+          # Add in the <synonym> elements.
+          alts = definition_xml.xpath(".//synonym").map(&:text) +
+            definition_xml.xpath(".//def/p").map(&:text).reject do |text|
+              text.length > 20
+            end
+
+          term = Stepmod::Utils::Converters::Term
+            .new
+            .convert(
+              definition_xml.xpath(".//term").first
+            )
+
           {
-            # We don't want examples and notes
-            no_notes_examples: true,
-            reference_anchor: reference_anchor
+            # [4..-1] because we want to skip the initial `=== {title}`
+            accepted: term[4..-1],
+            alt: alts,
           }
-        )
+        end
 
-        return nil if converted_definition.nil? || converted_definition.strip.empty?
+        def definition_xml_definition(definition_xml, reference_anchor)
+          # We reject the <p> that was considered an alternative term (length<=20)
+          text_nodes = definition_xml
+            .xpath(".//def")
+            .first
+            .children
+            .reject { |n| n.name == "p" && n.text.length <= 20 }
+
+          wrapper = "<def>#{text_nodes.map(&:to_s).join}</def>"
+
+          Stepmod::Utils::Converters::Def
+            .new
+            .convert(
+              Nokogiri::XML(wrapper).root,
+              {
+                # We don't want examples and notes
+                no_notes_examples: true,
+                reference_anchor: reference_anchor,
+              },
+            )
+        end
 
-        if definition_xml.name == 'ext_description'
-          converted_definition = <<~TEXT
-            #{converted_definition}
+        def definition_xml_converted_definition(designation, definition)
+          if designation[:alt].length.positive?
+            alt_notation = "alt:[#{designation[:alt].map(&:strip).join(',')}]"
+          end
 
-            NOTE: This term is incompletely defined in this document.
-            Reference <<#{reference_anchor}>> for the complete definition.
+          result = <<~TEXT
+            === #{designation[:accepted].strip}
+          TEXT
+
+          if alt_notation
+            result += <<~TEXT
+
+              #{alt_notation}
+            TEXT
+          end
+
+          <<~TEXT
+            #{result}
+            #{definition}
           TEXT
         end
-        new(
-          converted_definition: converted_definition,
-          reference_anchor: reference_anchor,
-          reference_clause: reference_clause,
-          file_path: file_path
-        )
       end
 
       def to_mn_adoc
         <<~TEXT
-          // STEPmod path:#{!file_path.empty? ? " #{file_path}" : ""}
+          // STEPmod path:#{!file_path.empty? ? " #{file_path}" : ''}
           #{converted_definition}
 
           [.source]
-          <<#{reference_anchor}#{reference_clause ? ",clause=" + reference_clause : ""}>>
+          <<#{reference_anchor}#{reference_clause ? ",clause=#{reference_clause}" : ''}>>
 
         TEXT
       end
-
     end
   end
 end

data/lib/stepmod/utils/converters/a.rb

@@ -8,17 +8,17 @@ module Stepmod
       class A < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           name  = treat_children(node, state)
-          href  = node['href']
+          href  = node["href"]
           title = extract_title(node)
-          id = node['id'] || node['name']
+          id = node["id"] || node["name"]
 
           id = id&.gsub(/\s/, "")&.gsub(/__+/, "_")
 
-          if /^_Toc\d+$|^_GoBack$/.match id
+          if /^_Toc\d+$|^_GoBack$/.match? id
             ""
           elsif !id.nil? && !id.empty?
             "[[#{id}]]"
-          elsif href.to_s.start_with?('#')
+          elsif href.to_s.start_with?("#")
             href = href.sub(/^#/, "").gsub(/\s/, "").gsub(/__+/, "_")
             if name.empty?
               "<<#{href}>>"
@@ -29,16 +29,13 @@ module Stepmod
             name
           else
             name = title if name.empty?
-            href = "link:#{href}" unless href.to_s =~ URI::DEFAULT_PARSER.make_regexp
+            href = "link:#{href}" unless href.to_s&.match?(URI::DEFAULT_PARSER.make_regexp)
             link = "#{href}[#{name}]"
             # link.prepend(' ')
-            link = " #{link}"
-            link
+            " #{link}"
+
           end
         end
-
-        private
-
       end
 
       ReverseAdoc::Converters.register :a, A.new

data/lib/stepmod/utils/converters/blockquote.rb

@@ -5,14 +5,14 @@ module Stepmod
     module Converters
       class Blockquote < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          id = node['id']
+          id = node["id"]
           anchor = id ? "[[#{id}]]\n" : ""
-          cite = node['cite']
+          cite = node["cite"]
           attrs = cite ? "[quote, #{cite}]\n" : ""
           content = treat_children(node, state).strip
           content = ReverseAdoc.cleaner.remove_newlines(content)
-          #"\n\n> " << content.lines.to_a.join('> ') << "\n\n"
-          "\n\n#{attrs}____\n" << content.lines.to_a.join('') << "\n____\n\n"
+          # "\n\n> " << content.lines.to_a.join('> ') << "\n\n"
+          "\n\n#{attrs}____\n" << content.lines.to_a.join("") << "\n____\n\n"
         end
       end
 

data/lib/stepmod/utils/converters/br.rb

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Br < ReverseAdoc::Converters::Base
-        def convert(node, state = {})
+        def convert(_node, _state = {})
           " +\n"
         end
       end

data/lib/stepmod/utils/converters/bypass.rb

@@ -16,66 +16,66 @@ module Stepmod
       ReverseAdoc::Converters.register :thead,    Bypass.new
       ReverseAdoc::Converters.register :tbody,    Bypass.new
       ReverseAdoc::Converters.register :tfoot,    Bypass.new
-      ReverseAdoc::Converters.register :abbr,    Bypass.new
+      ReverseAdoc::Converters.register :abbr, Bypass.new
       ReverseAdoc::Converters.register :acronym,    Bypass.new
       ReverseAdoc::Converters.register :address,    Bypass.new
-      ReverseAdoc::Converters.register :applet,    Bypass.new
-      ReverseAdoc::Converters.register :map,    Bypass.new
-      ReverseAdoc::Converters.register :area,    Bypass.new
+      ReverseAdoc::Converters.register :applet, Bypass.new
+      ReverseAdoc::Converters.register :map, Bypass.new
+      ReverseAdoc::Converters.register :area, Bypass.new
       ReverseAdoc::Converters.register :bdi,    Bypass.new
       ReverseAdoc::Converters.register :bdo,    Bypass.new
       ReverseAdoc::Converters.register :big,    Bypass.new
       ReverseAdoc::Converters.register :button,    Bypass.new
       ReverseAdoc::Converters.register :canvas,    Bypass.new
-      ReverseAdoc::Converters.register :data,    Bypass.new
-      ReverseAdoc::Converters.register :datalist,    Bypass.new
+      ReverseAdoc::Converters.register :data, Bypass.new
+      ReverseAdoc::Converters.register :datalist, Bypass.new
       ReverseAdoc::Converters.register :del,    Bypass.new
       ReverseAdoc::Converters.register :ins,    Bypass.new
       ReverseAdoc::Converters.register :dfn,    Bypass.new
-      ReverseAdoc::Converters.register :dialog,    Bypass.new
-      ReverseAdoc::Converters.register :embed,    Bypass.new
-      ReverseAdoc::Converters.register :fieldset,    Bypass.new
-      ReverseAdoc::Converters.register :font,    Bypass.new
-      ReverseAdoc::Converters.register :footer,    Bypass.new
-      ReverseAdoc::Converters.register :form,    Bypass.new
-      ReverseAdoc::Converters.register :frame,    Bypass.new
-      ReverseAdoc::Converters.register :frameset,    Bypass.new
+      ReverseAdoc::Converters.register :dialog, Bypass.new
+      ReverseAdoc::Converters.register :embed, Bypass.new
+      ReverseAdoc::Converters.register :fieldset, Bypass.new
+      ReverseAdoc::Converters.register :font, Bypass.new
+      ReverseAdoc::Converters.register :footer, Bypass.new
+      ReverseAdoc::Converters.register :form, Bypass.new
+      ReverseAdoc::Converters.register :frame, Bypass.new
+      ReverseAdoc::Converters.register :frameset, Bypass.new
       ReverseAdoc::Converters.register :header,    Bypass.new
       ReverseAdoc::Converters.register :iframe,    Bypass.new
       ReverseAdoc::Converters.register :input,    Bypass.new
       ReverseAdoc::Converters.register :label,    Bypass.new
-      ReverseAdoc::Converters.register :legend,    Bypass.new
+      ReverseAdoc::Converters.register :legend, Bypass.new
       ReverseAdoc::Converters.register :main,    Bypass.new
       ReverseAdoc::Converters.register :menu,    Bypass.new
-      ReverseAdoc::Converters.register :menulist,    Bypass.new
-      ReverseAdoc::Converters.register :meter,    Bypass.new
-      ReverseAdoc::Converters.register :nav,    Bypass.new
+      ReverseAdoc::Converters.register :menulist, Bypass.new
+      ReverseAdoc::Converters.register :meter, Bypass.new
+      ReverseAdoc::Converters.register :nav, Bypass.new
       ReverseAdoc::Converters.register :noframes,    Bypass.new
       ReverseAdoc::Converters.register :noscript,    Bypass.new
-      ReverseAdoc::Converters.register :object,    Bypass.new
-      ReverseAdoc::Converters.register :optgroup,    Bypass.new
+      ReverseAdoc::Converters.register :object, Bypass.new
+      ReverseAdoc::Converters.register :optgroup, Bypass.new
       ReverseAdoc::Converters.register :option,    Bypass.new
       ReverseAdoc::Converters.register :output,    Bypass.new
-      ReverseAdoc::Converters.register :param,    Bypass.new
-      ReverseAdoc::Converters.register :picture,    Bypass.new
-      ReverseAdoc::Converters.register :progress,    Bypass.new
-      ReverseAdoc::Converters.register :ruby,    Bypass.new
+      ReverseAdoc::Converters.register :param, Bypass.new
+      ReverseAdoc::Converters.register :picture, Bypass.new
+      ReverseAdoc::Converters.register :progress, Bypass.new
+      ReverseAdoc::Converters.register :ruby, Bypass.new
       ReverseAdoc::Converters.register :rt,    Bypass.new
       ReverseAdoc::Converters.register :rp,    Bypass.new
-      ReverseAdoc::Converters.register :s,    Bypass.new
-      ReverseAdoc::Converters.register :select,    Bypass.new
-      ReverseAdoc::Converters.register :small,    Bypass.new
-      ReverseAdoc::Converters.register :span,    Bypass.new
-      ReverseAdoc::Converters.register :strike,    Bypass.new
+      ReverseAdoc::Converters.register :s, Bypass.new
+      ReverseAdoc::Converters.register :select, Bypass.new
+      ReverseAdoc::Converters.register :small, Bypass.new
+      ReverseAdoc::Converters.register :span, Bypass.new
+      ReverseAdoc::Converters.register :strike, Bypass.new
       ReverseAdoc::Converters.register :details,    Bypass.new
       ReverseAdoc::Converters.register :section,    Bypass.new
       ReverseAdoc::Converters.register :summary,    Bypass.new
-      ReverseAdoc::Converters.register :svg,    Bypass.new
+      ReverseAdoc::Converters.register :svg, Bypass.new
       ReverseAdoc::Converters.register :template,    Bypass.new
       ReverseAdoc::Converters.register :textarea,    Bypass.new
-      ReverseAdoc::Converters.register :track,    Bypass.new
-      ReverseAdoc::Converters.register :u,    Bypass.new
-      ReverseAdoc::Converters.register :wbr,    Bypass.new
+      ReverseAdoc::Converters.register :track, Bypass.new
+      ReverseAdoc::Converters.register :u, Bypass.new
+      ReverseAdoc::Converters.register :wbr, Bypass.new
     end
   end
 end

data/lib/stepmod/utils/converters/clause_ref.rb

@@ -5,7 +5,7 @@ module Stepmod
     module Converters
       class ClauseRef < ReverseAdoc::Converters::Base
         def convert(node, _state = {})
-          " term:[#{normalized_ref(node['linkend'])}] "
+          " {{#{normalized_ref(node['linkend'])}}} "
         end
 
         private
@@ -13,10 +13,10 @@ module Stepmod
         def normalized_ref(ref)
           return unless ref || ref.empty?
 
-          ref.to_s.split(':').last.squeeze(' ').strip
+          ref.to_s.split(":").last.squeeze(" ").strip
         end
       end
       ReverseAdoc::Converters.register :clause_ref, ClauseRef.new
     end
   end
-end
+end

data/lib/stepmod/utils/converters/code.rb

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Code < ReverseAdoc::Converters::Base
-        def convert(node, state = {})
+        def convert(node, _state = {})
           "`#{node.text}`"
         end
       end

data/lib/stepmod/utils/converters/comment.rb

@@ -4,8 +4,10 @@ module Stepmod
   module Utils
     module Converters
       class Comment < ReverseAdoc::Converters::Base
-        def convert(node, state = {})
-          comment = node.text.strip.split("\n").map{|line| "// #{line}"}.join("\n")
+        def convert(node, _state = {})
+          comment = node.text.strip.split("\n").map do |line|
+            "\n// #{line}"
+          end.join("\n")
           "#{comment}\n"
         end
       end
@@ -13,4 +15,4 @@ module Stepmod
       ReverseAdoc::Converters.register :comment, Comment.new
     end
   end
-end
+end

data/lib/stepmod/utils/converters/dd.rb

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Dd < ReverseAdoc::Converters::Base
-        def convert(node, state = {})
+        def convert(node, _state = {})
           "#{node.text}\n"
         end
 
@@ -12,4 +12,4 @@ module Stepmod
       end
     end
   end
-end
+end

data/lib/stepmod/utils/converters/def.rb

@@ -1,4 +1,3 @@
-
 module Stepmod
   module Utils
     module Converters
@@ -12,30 +11,29 @@ module Stepmod
 
         def treat_children(node, state)
           converted = node.children.each_with_object({}) do |child, res|
-
             content = treat(child, state)
             next if content.strip.empty?
 
             res[child] = content
           end
           previous = nil
-          result = ''
-
-          converted.each.with_index do |(child, content), i|
-            if block_tag?(child, previous)
-              result += "\n\n"
-            elsif comment_tag?(child, previous)
-              result += "\n"
-            else
-              result += ' '
-            end
+          result = ""
+
+          converted.each.with_index do |(child, content), _i|
+            result += if block_tag?(child, previous)
+                        "\n\n"
+                      elsif comment_tag?(child, previous)
+                        "\n"
+                      else
+                        " "
+                      end
             result += content
             previous = child
           end
 
           # Remove double newlines for every line
           result = result.gsub(/\n\n+/, "\n\n")
-          result = result.squeeze(' ')
+          result = result.squeeze(" ")
 
           result.strip
         end
@@ -46,14 +44,14 @@ module Stepmod
         end
 
         def comment_tag?(child, previous)
-          child.name == 'comment' || (previous && previous.name === 'comment')
+          child.name == "comment" || (previous && previous.name === "comment")
         end
 
         def additional_block(node)
           # Treat first `p` tag as an `alt` block, metanorma/stepmod-utils#9
           first_child_tag = node
-                              .children
-                              .find { |n| n.is_a?(Nokogiri::XML::Element) }
+            .children
+            .find { |n| n.is_a?(Nokogiri::XML::Element) }
           return unless can_transform_to_alt?(first_child_tag)
 
           result = Stepmod::Utils::Converters::Synonym
@@ -66,12 +64,14 @@ module Stepmod
 
         # metanorma/stepmod-utils#18 when para is the only text doe snot transform it
         def can_transform_to_alt?(first_child_tag)
-          return false unless first_child_tag&.name == 'p' &&
-                                defined?(Stepmod::Utils::Converters::Synonym)
+          return false unless first_child_tag&.name == "p" &&
+            defined?(Stepmod::Utils::Converters::Synonym)
 
           next_sibling = first_child_tag.next
           while next_sibling
-            return true if !next_sibling.text.to_s.strip.empty? && %w[p text].include?(next_sibling.name)
+            return true if !next_sibling.text.to_s.strip.empty? && %w[p
+                                                                      text].include?(next_sibling.name)
+
             next_sibling = next_sibling.next
           end
           false

data/lib/stepmod/utils/converters/drop.rb

@@ -4,8 +4,8 @@ module Stepmod
   module Utils
     module Converters
       class Drop < ReverseAdoc::Converters::Base
-        def convert(node, state = {})
-          ''
+        def convert(_node, _state = {})
+          ""
         end
       end
 

data/lib/stepmod/utils/converters/dt.rb

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Dt < ReverseAdoc::Converters::Base
-        def convert(node, state = {})
+        def convert(node, _state = {})
           return "\n\n{blank}::" if node.text.strip.length.zero?
 
           "\n\n#{node.text}:: "
@@ -14,4 +14,4 @@ module Stepmod
       end
     end
   end
-end
+end

data/lib/stepmod/utils/converters/em.rb

@@ -15,7 +15,7 @@ module Stepmod
       end
 
       ReverseAdoc::Converters.register :em, Em.new
-      ReverseAdoc::Converters.register :cite,  Em.new
+      ReverseAdoc::Converters.register :cite, Em.new
     end
   end
 end

data/lib/stepmod/utils/converters/em_express_description.rb

@@ -16,7 +16,7 @@ module Stepmod
 
       ReverseAdoc::Converters.register :em, Em.new
       ReverseAdoc::Converters.register :i,  Em.new
-      ReverseAdoc::Converters.register :cite,  Em.new
+      ReverseAdoc::Converters.register :cite, Em.new
     end
   end
 end

data/lib/stepmod/utils/converters/eqn.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'stepmod/utils/html_to_asciimath'
+require "stepmod/utils/html_to_asciimath"
 
 module Stepmod
   module Utils
@@ -21,30 +21,32 @@ module Stepmod
 
         def definition_node?(node)
           first_strong_node = node
-                                .children
-                                .find do |n|
-                                  return false if !n.text? && n.name != 'b'
-
-                                  n.name == 'b'
-                                end
-          first_strong_node &&
-            first_strong_node.next &&
+            .children
+            .find do |n|
+            return false if !n.text? && n.name != "b"
+
+            n.name == "b"
+          end
+          first_strong_node&.next &&
             first_strong_node.next.text? &&
             first_strong_node.next.content =~ /\s+:/
         end
 
         def definition_converted(cloned_node, state)
           first_strong_node = cloned_node
-                                .children
-                                .find do |n|
-                                  return false if !n.text? && n.name != 'b'
+            .children
+            .find do |n|
+            return false if !n.text? && n.name != "b"
 
-                                  n.name == 'b'
-                                end
-          first_strong_node.next.content = first_strong_node.next.content.gsub(/\s?:/, '')
+            n.name == "b"
+          end
+          first_strong_node.next.content = first_strong_node.next.content.gsub(
+            /\s?:/, ""
+          )
           term = first_strong_node.text.strip
           first_strong_node.remove
-          "\n\n#{term}:: #{remove_trash_symbols(treat_children(cloned_node, state))}\n"
+          "\n\n#{term}:: #{remove_trash_symbols(treat_children(cloned_node,
+                                                               state))}\n"
         end
 
         def stem_converted(cloned_node, state)
@@ -53,22 +55,22 @@ module Stepmod
           content = Stepmod::Utils::HtmlToAsciimath.new.call(internal_content)
           res = <<~TEMPLATE
 
-                [stem]
-                ++++
-                #{remove_trash_symbols(content.strip)}
-                ++++
+            [stem]
+            ++++
+            #{remove_trash_symbols(content.strip)}
+            ++++
 
-                TEMPLATE
-          res = "[[#{cloned_node['id']}]]\n#{res}" if cloned_node['id'] && cloned_node['id'].length > 0
+          TEMPLATE
+          res = "[[#{cloned_node['id']}]]\n#{res}" if cloned_node["id"]&.length&.positive?
           res
         end
 
         def remove_trash_symbols(content)
           content
-            .gsub(/ /, '')
+            .gsub(/ /, "")
             .strip
-            .gsub(/\(\d\)$/, '')
-            .gsub(/\b(\w*?[_]+\w+)\b/, '"\1"')
+            .gsub(/\(\d\)$/, "")
+            .gsub(/\b(\w*?_+\w+)\b/, '"\1"')
             .gsub(/([^\s])\s+_{/, '\1_{')
             .strip
         end
@@ -81,7 +83,7 @@ module Stepmod
             node
               .children
               .each do |n|
-                remove_tags_not_in_context(n) if n.children.length > 0
+                remove_tags_not_in_context(n) if n.children.length.positive?
                 next if n.name != tag_name
 
                 n.add_previous_sibling(n.children)

data/lib/stepmod/utils/converters/example.rb

@@ -5,16 +5,15 @@ module Stepmod
     module Converters
       class Example < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-
           # If we want to skip this node
-          return '' if state[:no_notes_examples]
+          return "" if state[:no_notes_examples]
 
           <<~TEMPLATE
 
-          [example]
-          ====
-          #{treat_children(node, state).strip}
-          ====
+            [example]
+            ====
+            #{treat_children(node, state).strip}
+            ====
 
           TEMPLATE
         end