stepmod-utils 0.3.5 → 0.3.10

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

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

@@ -6,19 +6,20 @@ module Stepmod
       class ExpressG < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           node.children.map do |child|
-            next unless child.name == 'imgfile'
+            next unless child.name == "imgfile"
 
-            parse_to_svg_reference(child['file'], state)
+            parse_to_svg_reference(child["file"], state)
           end.join("\n")
         end
 
         private
 
         def parse_to_svg_reference(file, state)
-          return '' unless File.file?(file)
+          return "" unless File.file?(file)
 
           image_document = Nokogiri::XML(File.read(file))
-          svg_path = File.basename(image_document.xpath('//img').first['src'], '.*')
+          svg_path = File.basename(image_document.xpath("//img").first["src"],
+                                   ".*")
           <<~SVGMAP
 
             *)
@@ -27,23 +28,23 @@ module Stepmod
             ====
             image::#{svg_path}.svg[]
 
-            #{image_document.xpath('//img.area').map.with_index(1) {|n, i| schema_reference(n['href'], i) }.join("\n")}
+            #{image_document.xpath('//img.area').map.with_index(1) { |n, i| schema_reference(n['href'], i) }.join("\n")}
             ====
           SVGMAP
         end
 
         def schema_reference(xml_path, index)
-          if xml_path =~ /#/
-            _,express_path_part = xml_path.split('#')
+          if /#/.match?(xml_path)
+            _, express_path_part = xml_path.split("#")
             "* <<express:#{express_path_part.strip}>>; #{index}"
           else
-            schema_name = File.basename(xml_path, '.*')
+            schema_name = File.basename(xml_path, ".*")
             "* <<express:#{schema_name.strip}>>; #{index}"
           end
         end
       end
 
-      ReverseAdoc::Converters.register 'express-g', ExpressG.new
+      ReverseAdoc::Converters.register "express-g", ExpressG.new
     end
   end
 end

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

@@ -5,10 +5,10 @@ module Stepmod
     module Converters
       class ExpressRef < ReverseAdoc::Converters::Base
         def convert(node, _state = {})
-          "*#{node['linkend'].to_s.split('.').last}*"
+          " *#{node['linkend'].to_s.split('.').last}* "
         end
       end
       ReverseAdoc::Converters.register :express_ref, ExpressRef.new
     end
   end
-end
+end

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

@@ -3,11 +3,12 @@ module Stepmod
     module Converters
       class ExpressRefExpressDescription < ReverseAdoc::Converters::Base
         def convert(node, _state = {})
-          parts = node['linkend'].to_s.split(':').last.split('.')
+          parts = node["linkend"].to_s.split(":").last.split(".")
           "<<express:#{parts.join('.').strip},#{parts.last.strip}>>"
         end
       end
-      ReverseAdoc::Converters.register :express_ref, ExpressRefExpressDescription.new
+      ReverseAdoc::Converters.register :express_ref,
+                                       ExpressRefExpressDescription.new
     end
   end
 end

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

@@ -3,7 +3,7 @@ module Stepmod
     module Converters
       class ExtDescription < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          state = state.merge(schema_name: node['linkend'])
+          state = state.merge(schema_name: node["linkend"])
           child_text = treat_children(node, state).strip
 
           <<~TEMPLATE

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'reverse_adoc/converters/figure'
+
+require "reverse_adoc/converters/figure"
 
 module Stepmod
   module Utils
@@ -7,7 +8,7 @@ module Stepmod
       class Figure < ReverseAdoc::Converters::Figure
         def convert(node, state = {})
           # If we want to skip this node
-          return '' if state[:no_notes_examples]
+          return "" if state[:no_notes_examples]
 
           super
         end
@@ -17,4 +18,3 @@ module Stepmod
     end
   end
 end
-

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

@@ -18,4 +18,4 @@ module Stepmod
       ReverseAdoc::Converters.register :fund_cons, FundCons.new
     end
   end
-end
+end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Head < ReverseAdoc::Converters::Base
-        def convert(node, state = {})
+        def convert(node, _state = {})
           title = extract_title(node)
           "= #{title}\n:stem:\n\n"
         end
@@ -12,6 +12,7 @@ module Stepmod
         def extract_title(node)
           title = node.at("./title")
           return "(???)" if title.nil?
+
           title.text
         end
       end
@@ -19,4 +20,4 @@ module Stepmod
       ReverseAdoc::Converters.register :head, Head.new
     end
   end
-end
+end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Hr < ReverseAdoc::Converters::Base
-        def convert(node, state = {})
+        def convert(_node, _state = {})
           "\n* * *\n"
         end
       end
@@ -12,4 +12,4 @@ module Stepmod
       ReverseAdoc::Converters.register :hr, Hr.new
     end
   end
-end
+end

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

@@ -4,8 +4,8 @@ module Stepmod
   module Utils
     module Converters
       class Ignore < ReverseAdoc::Converters::Base
-        def convert(node, state = {})
-          '' # noop
+        def convert(_node, _state = {})
+          "" # noop
         end
       end
 
@@ -13,4 +13,4 @@ module Stepmod
       ReverseAdoc::Converters.register :col,      Ignore.new
     end
   end
-end
+end

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

@@ -12,4 +12,4 @@ module Stepmod
       ReverseAdoc::Converters.register :introduction, Introduction.new
     end
   end
-end
+end

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

@@ -5,21 +5,21 @@ module Stepmod
     module Converters
       class ModuleRef < ReverseAdoc::Converters::Base
         def convert(node, _state = {})
-          ref = node['linkend']
+          ref = node["linkend"]
           # #23:
           # In this case when we see this:
 
           # <module_ref linkend="product_as_individual:3_definition">individual products</module_ref>
           # We take the text value of the element and convert to this:
 
-          # term:[individual products]
+          # {{individual products}}
 
           ref = node.text.strip
           if !ref.empty?
-            " term:[#{normalized_ref(ref)}] "
+            " {{#{normalized_ref(ref)}}} "
           elsif
-            ref = node['linkend'].split(':').first
-            " *#{ref}*"
+            ref = node["linkend"].split(":").first
+            " *#{ref}* "
           end
         end
 
@@ -28,10 +28,10 @@ module Stepmod
         def normalized_ref(ref)
           return unless ref || ref.empty?
 
-          ref.squeeze(' ').strip
+          ref.squeeze(" ").strip
         end
       end
       ReverseAdoc::Converters.register :module_ref, ModuleRef.new
     end
   end
-end
+end

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

@@ -5,16 +5,15 @@ module Stepmod
     module Converters
       class Note < 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
 
-          [NOTE]
-          --
-          #{treat_children(node, state).strip}
-          --
+            [NOTE]
+            --
+            #{treat_children(node, state).strip}
+            --
 
           TEMPLATE
         end

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

@@ -5,14 +5,18 @@ module Stepmod
     module Converters
       class Ol < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          id = node['id']
+          id = node["id"]
           anchor = id ? "[[#{id}]]\n" : ""
           ol_count = state.fetch(:ol_count, 0) + 1
           attrs = ol_attrs(node)
-          res = "\n\n#{anchor}#{attrs}#{treat_children(node, state.merge(ol_count: ol_count, tdsinglepara: true))}\n"
+          children_s = treat_children(node, state.merge(
+                                              ol_count: ol_count,
+                                              tdsinglepara: true,
+                                            ))
+
+          "\n\n#{anchor}#{attrs}#{children_s}\n"
           # Why do we add this?
           # res = "\n" + res if node.parent && node.parent.name == 'note'
-          res
         end
 
         def number_style(node)
@@ -22,8 +26,6 @@ module Stepmod
                   when "a" then "loweralpha"
                   when "I" then "upperroman"
                   when "i" then "lowerroman"
-                  else
-                    nil
                   end
         end
 

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

@@ -5,7 +5,7 @@ module Stepmod
     module Converters
       class P < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          id = node['id']
+          id = node["id"]
           anchor = id ? "[[#{id}]]\n" : ""
           if state[:tdsinglepara]
             "#{anchor}#{treat_children(node, state).strip}"
@@ -18,4 +18,4 @@ module Stepmod
       ReverseAdoc::Converters.register :p, P.new
     end
   end
-end
+end

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

@@ -4,10 +4,10 @@ module Stepmod
   module Utils
     module Converters
       class PassThrough < ReverseAdoc::Converters::Base
-        def convert(node, state = {})
+        def convert(node, _state = {})
           node.to_s
         end
       end
     end
   end
-end
+end

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

@@ -13,4 +13,4 @@ module Stepmod
       ReverseAdoc::Converters.register :q, Q.new
     end
   end
-end
+end

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

@@ -5,7 +5,7 @@ module Stepmod
     module Converters
       class Schema < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          state = state.merge(schema_name: node['name'])
+          state = state.merge(schema_name: node["name"])
           <<~TEMPLATE
             (*"#{node['name']}"
             #{treat_children(node, state).strip}

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'stepmod/utils/converters/em'
+require "stepmod/utils/converters/em"
 
 module Stepmod
   module Utils

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

@@ -3,8 +3,8 @@ module Stepmod
     module Converters
       class StepmodExtDescription < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          state = state.merge(schema_name: node['linkend'])
-          linkend = node['linkend'].split('.')
+          state = state.merge(schema_name: node["linkend"])
+          linkend = node["linkend"].split(".")
 
           # We only want ENTITY entries, not their attributes
           # https://github.com/metanorma/iso-10303-2/issues/36#issuecomment-841300092
@@ -13,8 +13,21 @@ module Stepmod
           child_text = treat_children(node, state).strip
           return nil if child_text.empty?
 
-          # Only taking the first paragraph of the definition
-          child_text = child_text.split("\n").first
+          # Unless the first paragraph ends with "between" and is followed by a
+          # list, don't split
+          first_child = child_text.split("\n").first
+
+          unless (
+            first_child =~ /between:?\s*\Z/ ||
+            first_child =~ /include:?\s*\Z/ ||
+            first_child =~ /of:?\s*\Z/ ||
+            first_child =~ /[:;]\s*\Z/
+            ) &&
+            child_text =~ /\n\n\*/
+
+            # Only taking the first paragraph of the definition
+            child_text = first_child
+          end
 
           # # Only taking the first sentence
           # if child_text.contains?(".")
@@ -32,13 +45,14 @@ module Stepmod
           <<~TEMPLATE
             === #{linkend.last}
 
-            #{domain ? "domain:[" + domain + "]" : ""}
+            #{domain ? "domain:[#{domain}]" : ''}
 
             #{child_text}
           TEMPLATE
         end
       end
-      ReverseAdoc::Converters.register :ext_description, StepmodExtDescription.new
+      ReverseAdoc::Converters.register :ext_description,
+                                       StepmodExtDescription.new
     end
   end
 end

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

@@ -4,14 +4,17 @@ module Stepmod
   module Utils
     module Converters
       class Strong < ReverseAdoc::Converters::Base
-        BLANK_CHARS = "{blank}".freeze
+        BLANK_CHARS = "{blank}"
 
         def convert(node, state = {})
           content = treat_children(node, state.merge(already_strong: true))
           if content.strip.empty? || state[:already_strong]
             content
           else
-            handle_express_escape_seq(node, "#{content[/^\s*/]}*#{content.strip}*#{content[/\s*$/]}")
+            handle_express_escape_seq(
+              node,
+              "#{content[/^\s*/]}*#{content.strip}*#{content[/\s*$/]}"
+            )
           end
         end
 
@@ -30,7 +33,7 @@ module Stepmod
 
         def braces_sibling?(sibling, end_of_text = false)
           match = end_of_text ? /\($/ : /^\)/
-          sibling && sibling.text? && sibling.text =~ match
+          sibling&.text? && sibling.text =~ match
         end
       end
 
@@ -38,4 +41,4 @@ module Stepmod
       ReverseAdoc::Converters.register :b,      Strong.new
     end
   end
-end
+end

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

@@ -6,7 +6,7 @@ module Stepmod
       class Sub < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           content = treat_children(node, state)
-          return stem_notation(content) if node.parent.name == 'eqn'
+          return stem_notation(content) if node.parent.name == "eqn"
 
           "#{content[/^\s*/]}~#{content.strip}~#{content[/\s*$/]}"
         end
@@ -21,4 +21,4 @@ module Stepmod
       ReverseAdoc::Converters.register :sub, Sub.new
     end
   end
-end
+end

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

@@ -6,7 +6,7 @@ module Stepmod
       class Sup < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           content = treat_children(node, state)
-          return stem_notation(content) if node.parent.name == 'eqn'
+          return stem_notation(content) if node.parent.name == "eqn"
 
           "#{content[/^\s*/]}^#{content.strip}^#{content[/\s*$/]}"
         end
@@ -19,4 +19,4 @@ module Stepmod
       ReverseAdoc::Converters.register :sup, Sup.new
     end
   end
-end
+end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Synonym < ReverseAdoc::Converters::Base
-        def convert(node, state = {})
+        def convert(node, _state = {})
           "alt:[#{node.text.strip}]"
         end
       end
@@ -12,4 +12,4 @@ module Stepmod
       ReverseAdoc::Converters.register :synonym, Synonym.new
     end
   end
-end
+end

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

@@ -5,12 +5,13 @@ module Stepmod
     module Converters
       class Table < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          id = node['id']
+          id = node["id"]
           anchor = id ? "[[#{id}]]\n" : ""
-          title = node['caption'].to_s
+          title = node["caption"].to_s
           title = ".#{title}\n" unless title.empty?
           attrs = style(node)
-          "\n\n#{anchor}#{attrs}#{title}|===\n#{treat_children(node, state)}\n|===\n"
+          "\n\n#{anchor}#{attrs}#{title}|===\n#{treat_children(node,
+                                                               state)}\n|===\n"
         end
 
         def frame(node)
@@ -23,8 +24,6 @@ module Stepmod
             "frame=sides"
           when "box", "border"
             "frame=all"
-          else
-            nil
           end
         end
 
@@ -38,13 +37,11 @@ module Stepmod
             "rules=cols"
           when "none"
             "rules=none"
-          else
-            nil
           end
         end
 
         def style(node)
-          width = "width=#{node['width']}" if node['width']
+          width = "width=#{node['width']}" if node["width"]
           attrs = []
           frame_attr = frame(node)
           rules_attr = rules(node)
@@ -52,6 +49,7 @@ module Stepmod
           attrs += frame_attr if frame_attr
           attrs += rules_attr if rules_attr
           return "" if attrs.empty?
+
           "[#{attrs.join(',')}]\n"
         end
       end
@@ -59,4 +57,4 @@ module Stepmod
       ReverseAdoc::Converters.register :table, Table.new
     end
   end
-end
+end

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

@@ -1,29 +1,47 @@
 # frozen_string_literal: true
 
-require 'stepmod/utils/converters/synonym'
+require "stepmod/utils/converters/synonym"
 
 module Stepmod
   module Utils
     module Converters
       class Term < ReverseAdoc::Converters::Base
+
+        # We strip all the children in the case for "stem:[d]-manifold"
+        # vs "stem:[d] -manifold"
+        def treat_children(node, state)
+          res = node.children.map { |child| treat(child, state) }
+          res.map(&:strip).reject(&:empty?).join("")
+        end
+
         def convert(node, state = {})
           first_child = node.children.find do |child|
-                          child.name == 'text' && !child.text.to_s.strip.empty?
-                        end
+            child.name == "text" && !child.text.to_s.strip.empty?
+          end
+
           unless first_child &&
-                  node.text.split(';').length == 2 &&
-                  defined?(Stepmod::Utils::Converters::Synonym)
-            return "=== #{treat_children(node, state).strip}"
+              node.text.split(";").length == 2 &&
+              defined?(Stepmod::Utils::Converters::Synonym)
+            return "=== #{treat_acronym(treat_children(node, state).strip)}"
           end
 
-          term_def, alt = node.text.split(';')
+          term_def, alt = node.text.split(";")
           alt_xml = Nokogiri::XML::Text.new(alt, Nokogiri::XML::Document.new)
           converted_alt = Stepmod::Utils::Converters::Synonym.new.convert(alt_xml)
-          "=== #{term_def}\n\n#{converted_alt}"
+          "=== #{treat_acronym(term_def)}\n\n#{converted_alt}"
+        end
+
+        private
+
+        def treat_acronym(term_def)
+          return term_def.strip if term_def !~ /.+\(.+?\)$/
+
+          _, term_text, term_acronym = term_def.match(/(.+?)(\(.+\))$/).to_a
+          "#{term_text.strip}\nalt:[#{term_acronym.gsub(/\(|\)/, '')}]"
         end
       end
 
       ReverseAdoc::Converters.register :term, Term.new
     end
   end
-end
+end

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

@@ -16,14 +16,14 @@ module Stepmod
 
         def treat_empty(node, state)
           parent = node.parent.name.to_sym
-          if [:ol, :ul].include?(parent)  # Otherwise the identation is broken
-            ''
+          if %i[ol ul].include?(parent) # Otherwise the identation is broken
+            ""
           elsif state[:tdsinglepara]
-            ''
-          elsif node.text == ' '          # Regular whitespace text node
-            ' '
+            ""
+          elsif node.text == " "          # Regular whitespace text node
+            " "
           else
-            ''
+            ""
           end
         end
 
@@ -34,9 +34,7 @@ module Stepmod
           text = remove_border_newlines(text)
 
           text = preserve_keychars_within_backticks(text)
-          text = preserve_tags(text)
-
-          text
+          preserve_tags(text)
         end
 
         def preserve_nbsp(text)
@@ -44,20 +42,20 @@ module Stepmod
         end
 
         def preserve_tags(text)
-          text.gsub(/[<>]/, '>' => '\>', '<' => '\<')
+          text.gsub(/[<>]/, ">" => '\>', "<" => '\<')
         end
 
         def remove_border_newlines(text)
-          text.gsub(/\A\n+/, '').gsub(/\n+\z/, '')
+          text.gsub(/\A\n+/, "").gsub(/\n+\z/, "")
         end
 
         def remove_inner_newlines(text)
-          text.tr("\n\t", ' ').squeeze(' ')
+          text.tr("\n\t", " ").squeeze(" ")
         end
 
         def preserve_keychars_within_backticks(text)
           text.gsub(/`.*?`/) do |match|
-            match.gsub('\_', '_').gsub('\*', '*')
+            match.gsub('\_', "_").gsub('\*', "*")
           end
         end
       end