stepmod-utils 0.3.1 → 0.3.7

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,24 +11,30 @@ module Stepmod
 
         def treat_children(node, state)
           converted = node.children.each_with_object({}) do |child, res|
-                        content = treat(child, state).strip
-                        next if content.empty?
+            content = treat(child, state)
+            next if content.strip.empty?
 
-                        res[child] = content
-                      end
+            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.strip
         end
 
@@ -39,31 +44,34 @@ 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
-                    .new
-                    .convert(first_child_tag)
+            .new
+            .convert(first_child_tag)
+
           first_child_tag.remove
           "#{result}\n\n"
         end
 
         # 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,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