stepmod-utils 0.3.1 → 0.3.7

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

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'stepmod/utils/converters/synonym'
+require "stepmod/utils/converters/synonym"
 
 module Stepmod
   module Utils
@@ -8,22 +8,31 @@ module Stepmod
       class Term < ReverseAdoc::Converters::Base
         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 if term_def !~ /.+\(.+?\)$/
+
+          _, term_text, term_acronym = term_def.match(/(.+?)(\(.+\))$/).to_a
+          "#{term_text}\nalt:[#{term_acronym.gsub(/\(|\)/, '')}]"
         end
       end
 
       ReverseAdoc::Converters.register :term, Term.new
     end
   end
-end
+end