stepmod-utils 0.3.2 → 0.3.8

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,10 +5,20 @@ module Stepmod
     module Converters
       class Example < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          "\n\n[example]\n====\n#{treat_children(node, state).strip}\n====\n\n"
+          # If we want to skip this node
+          return "" if state[:no_notes_examples]
+
+          <<~TEMPLATE
+
+            [example]
+            ====
+            #{treat_children(node, state).strip}
+            ====
+
+          TEMPLATE
         end
       end
       ReverseAdoc::Converters.register :example, Example.new
     end
   end
-end
+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,10 +3,12 @@ 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
             (*"#{node['linkend']}"
-            #{treat_children(node, state).strip}
+            #{child_text}
             *)
           TEMPLATE
         end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "reverse_adoc/converters/figure"
+
+module Stepmod
+  module Utils
+    module Converters
+      class Figure < ReverseAdoc::Converters::Figure
+        def convert(node, state = {})
+          # If we want to skip this node
+          return "" if state[:no_notes_examples]
+
+          super
+        end
+      end
+      # This replaces the converter
+      ReverseAdoc::Converters.register :figure, Figure.new
+    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,18 +5,22 @@ 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]
-          if node['linkend'].split(':').length > 1
-            ref = node.text
+          # {{individual products}}
+
+          ref = node.text.strip
+          if !ref.empty?
+            " {{#{normalized_ref(ref)}}} "
+          elsif
+            ref = node["linkend"].split(":").first
+            " *#{ref}*"
           end
-          " term:[#{normalized_ref(ref)}] "
         end
 
         private
@@ -24,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,10 +5,20 @@ module Stepmod
     module Converters
       class Note < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          "\n\n[NOTE]\n--\n#{treat_children(node, state).strip}\n--\n\n"
+          # If we want to skip this node
+          return "" if state[:no_notes_examples]
+
+          <<~TEMPLATE
+
+            [NOTE]
+            --
+            #{treat_children(node, state).strip}
+            --
+
+          TEMPLATE
         end
       end
       ReverseAdoc::Converters.register :note, Note.new
     end
   end
-end
+end

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

@@ -5,14 +5,16 @@ 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"
+          "\n\n#{anchor}#{attrs}#{treat_children(node,
+                                                 state.merge(
+                                                   ol_count: ol_count, tdsinglepara: true,
+                                                 ))}\n"
           # Why do we add this?
           # res = "\n" + res if node.parent && node.parent.name == 'note'
-          res
         end
 
         def number_style(node)
@@ -22,8 +24,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,20 +3,43 @@ 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 ignore all the WHERE and IP rules because those are not terms
-          return nil if linkend.last =~ /^wr/
+          # We only want ENTITY entries, not their attributes
+          # https://github.com/metanorma/iso-10303-2/issues/36#issuecomment-841300092
+          return nil if linkend.length != 2
+
+          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
+
+          # # Only taking the first sentence
+          # if child_text.contains?(".")
+          #   child_text = child_text.split(".").first
+          # end
+
+          domain =  case linkend.first
+                    when /_mim$/, /_arm$/
+                      "STEP module"
+                    # when /_schema$/
+                    else
+                      "STEP resource"
+                    end
 
           <<~TEMPLATE
-            === #{node['linkend'].split('.').last}
+            === #{linkend.last}
+
+            #{domain ? "domain:[#{domain}]" : ''}
 
-            <STEP resource> #{treat_children(node, state).strip}
+            #{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,15 @@ 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 +31,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 +39,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