stepmod-utils 0.6.7 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc2de5e456094259eac1cbcad35b4de207a2aad873277c41cc056020257e5fd6
-  data.tar.gz: dd5edacfb209ca881dec21936611a7151c63313a2c4d3ce74e85a0d8ff8b036c
+  metadata.gz: f1ca04eb804cf7cb565a9b06ad4fbe5ff0296ff98efbc67dc743c2b6880f483f
+  data.tar.gz: c41e79f4e23ead8b393262fc27314834c54648f9e9e94b876528792746b5347a
 SHA512:
-  metadata.gz: c3ade34b7762f2bdba70b0d5019cdbd1213cbadc32514057d4f621b0b403a70baf46e2e7830c2bbb472d33d284491f3dfb460d3e0da6895aa3dc619609f51a83
-  data.tar.gz: d0447346235cb6a8688a1ef25d027e58305661715f2540cb8a011441fb62fc62e6905dce7f26f5aff8479c4e44932645c70725d264cb6503c200e07f1371cdf0
+  metadata.gz: c668c4ed4ac6cee1ed1b9a496b6cd0d5a4db58110500fa2250f9adf7b6c6a655a22ee9a449ccf0fd8b99e425203a9ab208b2e4808d68d84a9d010c6dfc95f53f
+  data.tar.gz: c629c54854070a73b5766105efab6d737752b19ba3123b9e514f575124de7ff2561151a8c727650c8324aec2a018fa5c5820681cd829e28ffd9e647e48a711bc

data/exe/stepmod-convert-express-description

@@ -11,7 +11,7 @@ $:.unshift File.expand_path("../../lib", bin_file)
 require "bundler/setup"
 require "stepmod/utils/smrl_description_converter"
 
-ReverseAdoc.config.unknown_tags = :bypass
+Coradoc::Input::HTML.config.unknown_tags = :bypass
 
 input_content = ARGF.read
 

data/exe/stepmod-convert-express-resource

@@ -11,7 +11,7 @@ $:.unshift File.expand_path("../../lib", bin_file)
 require "bundler/setup"
 require "stepmod/utils/smrl_resource_converter"
 
-ReverseAdoc.config.unknown_tags = :bypass
+Coradoc::Input::HTML.config.unknown_tags = :bypass
 
 input_content = ARGF.read
 

data/lib/stepmod/utils/cleaner.rb

@@ -1,13 +1,41 @@
-require "reverse_adoc/cleaner"
+require "coradoc/input/html/cleaner"
 
 module Stepmod
   module Utils
-    class Cleaner < ReverseAdoc::Cleaner
+    class Cleaner < Coradoc::Input::HTML::Cleaner
       def tidy(string)
         super
           .gsub(/^ +/, "")
           .gsub(/\*\s([,.])/, '*\1') # remove space between * and comma or dot.
       end
+  
+      # Find non-asterisk content that is enclosed by two or
+      # more asterisks. Ensure that only one whitespace occurs
+      # in the border area.
+      # Same for underscores and brackets.
+      def clean_tag_borders(string)
+        patterns = {
+          /\s?\*{2,}.*?\*{2,}\s?/ => "**",
+          /\s?_{2,}.*?_{2,}\s?/   => "__",
+          /\s?~{2,}.*?~{2,}\s?/   => "~~",
+        }
+
+        result = string.dup
+        patterns.each do |pattern, value|
+          result = result.gsub(pattern) do |match|
+            preserve_border_whitespaces(match, default_border: Coradoc::Input::HTML.config.tag_border) do
+              match.strip.sub(" #{value}", value).sub("#{value} ", value)
+            end
+          end
+        end
+
+        result = result.gsub(/\s?\[.*?\]\s?/) do |match|
+          preserve_border_whitespaces(match) do
+            match.strip.sub("[ ", "[").sub(" ]", "[")
+          end
+        end
+        result
+      end
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class A < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           name  = treat_children(node, state)
           href  = node["href"]
           title = extract_title(node)
@@ -41,7 +41,7 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :a, A.new
+      Coradoc::Input::HTML::Converters.register :a, A.new
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Arm < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           treat_children(node, state)
         end
 
@@ -16,7 +16,7 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :arm, Arm.new
+      Coradoc::Input::HTML::Converters.register :arm, Arm.new
     end
   end
 end

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

@@ -1,30 +1,10 @@
-require "reverse_adoc"
+require 'coradoc'
+require 'coradoc/input/html'
 
 module Stepmod
   module Utils
     module Converters
-      class Base < ReverseAdoc::Converters::Base
-        PREFIXES_REGEX = /([Ff]ormula|[Ff]igure|[Tt]able)\s*/.freeze
-
-        def treat_children(node, state)
-          updated_node = remove_prefixes(node)
-
-          updated_node.children.inject("") do |memo, child|
-            memo << treat(child, state)
-          end
-        end
-
-        private
-
-        def remove_prefixes(node)
-          node.children.each_with_index do |child, index|
-            if child.text.match(PREFIXES_REGEX) && node.children[index + 1]&.name == "a"
-              child.content = child.content.gsub(PREFIXES_REGEX, "")
-            end
-          end
-
-          node
-        end
+      class Base < Coradoc::Input::HTML::Converters::Base
       end
     end
   end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class ClauseRef < Stepmod::Utils::Converters::Base
-        def convert(node, _state = {})
+        def to_coradoc(node, _state = {})
           " {{#{normalized_ref(node['linkend'])}}} "
         end
 
@@ -16,7 +16,7 @@ module Stepmod
           ref.to_s.split(":").last.squeeze(" ").strip
         end
       end
-      ReverseAdoc::Converters.register :clause_ref, ClauseRef.new
+      Coradoc::Input::HTML::Converters.register :clause_ref, ClauseRef.new
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Comment < Stepmod::Utils::Converters::Base
-        def convert(node, _state = {})
+        def to_coradoc(node, _state = {})
           comment = node.text.strip.split("\n").map do |line|
             "\n// #{line}"
           end.join("\n")
@@ -12,7 +12,7 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :comment, Comment.new
+      Coradoc::Input::HTML::Converters.register :comment, Comment.new
     end
   end
 end

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

@@ -4,11 +4,11 @@ module Stepmod
   module Utils
     module Converters
       class Dd < Stepmod::Utils::Converters::Base
-        def convert(node, _state = {})
+        def to_coradoc(node, _state = {})
           "#{node.text}\n"
         end
 
-        ReverseAdoc::Converters.register :dd, Dd.new
+        Coradoc::Input::HTML::Converters.register :dd, Dd.new
       end
     end
   end

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

@@ -2,7 +2,7 @@ module Stepmod
   module Utils
     module Converters
       class Def < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           node = node.dup
           "#{additional_block(node)}#{treat_children(node, state)}"
         end
@@ -78,8 +78,8 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :def, Def.new
-      ReverseAdoc::Converters.register :description, Def.new
+      Coradoc::Input::HTML::Converters.register :def, Def.new
+      Coradoc::Input::HTML::Converters.register :description, Def.new
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Definition < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           treat_children(node, state)
         end
 
@@ -16,7 +16,7 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :definition, Definition.new
+      Coradoc::Input::HTML::Converters.register :definition, Definition.new
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Description < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           treat_children(node, state)
         end
 
@@ -16,7 +16,7 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :description, Description.new
+      Coradoc::Input::HTML::Converters.register :description, Description.new
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Dl < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           cleaned_node = cleanup_trash_tags(node.clone)
           treat_children(cleaned_node, state)
         end
@@ -24,7 +24,7 @@ module Stepmod
           node
         end
 
-        ReverseAdoc::Converters.register :dl, Dl.new
+        Coradoc::Input::HTML::Converters.register :dl, Dl.new
       end
     end
   end

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

@@ -4,13 +4,13 @@ module Stepmod
   module Utils
     module Converters
       class Dt < Stepmod::Utils::Converters::Base
-        def convert(node, _state = {})
+        def to_coradoc(node, _state = {})
           return "\n\n{blank}::" if node.text.strip.empty?
 
           "\n\n#{node.text}:: "
         end
 
-        ReverseAdoc::Converters.register :dt, Dt.new
+        Coradoc::Input::HTML::Converters.register :dt, Dt.new
       end
     end
   end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Em < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           content = treat_children(node, state.merge(already_italic: true))
           if content.strip.empty? || state[:already_italic]
             content
@@ -14,8 +14,8 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :em, Em.new
-      ReverseAdoc::Converters.register :cite, Em.new
+      Coradoc::Input::HTML::Converters.register :em, Em.new
+      Coradoc::Input::HTML::Converters.register :cite, Em.new
     end
   end
 end

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

@@ -44,9 +44,7 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :em, Em.new
-      ReverseAdoc::Converters.register :i,  Em.new
-      ReverseAdoc::Converters.register :cite, Em.new
+      Coradoc::Input::HTML::Converters.register :i,  Em.new
     end
   end
 end

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

@@ -9,7 +9,7 @@ module Stepmod
       class Eqn < Stepmod::Utils::Converters::Base
         TAGS_NOT_IN_CONTEXT = %w[b i].freeze
 
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           cloned_node = node.clone
           if definition_node?(cloned_node)
             return definition_converted(cloned_node, state)
@@ -123,8 +123,8 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :eqn, Eqn.new
-      ReverseAdoc::Converters.register :bigeqn, Eqn.new
+      Coradoc::Input::HTML::Converters.register :eqn, Eqn.new
+      Coradoc::Input::HTML::Converters.register :bigeqn, Eqn.new
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class Example < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           # If we want to skip this node
           return "" if state[:no_notes_examples]
 
@@ -19,7 +19,7 @@ module Stepmod
           TEMPLATE
         end
       end
-      ReverseAdoc::Converters.register :example, Example.new
+      Coradoc::Input::HTML::Converters.register :example, Example.new
     end
   end
 end

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

@@ -12,8 +12,6 @@ module Stepmod
           TEMPLATE
         end
       end
-
-      ReverseAdoc::Converters.register :express_example, ExpressExample.new
     end
   end
 end

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

@@ -10,7 +10,7 @@ module Stepmod
         #   "figure-exp-#{id}"
         # end
 
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           <<~TEMPLATE
             (*"#{state[:schema_and_entity]}.__figure"
             #{super(node, state.merge(no_notes_examples: nil)).strip}
@@ -19,7 +19,7 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :express_figure, ExpressFigure.new
+      Coradoc::Input::HTML::Converters.register :express_figure, ExpressFigure.new
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class ExpressG < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           node.children.map do |child|
             next unless child.name == "imgfile"
 
@@ -29,7 +29,7 @@ module Stepmod
             ====
             image::#{svg_filename}.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
@@ -49,7 +49,7 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register "express-g", ExpressG.new
+      Coradoc::Input::HTML::Converters.register "express-g", ExpressG.new
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class ExpressNote < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           <<~TEMPLATE
 
             (*"#{state[:schema_and_entity]}.__note"
@@ -14,7 +14,7 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :express_note, ExpressNote.new
+      Coradoc::Input::HTML::Converters.register :express_note, ExpressNote.new
     end
   end
 end

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

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

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

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

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

@@ -10,7 +10,7 @@ module Stepmod
         #   "table-exp-#{id}"
         # end
 
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           <<~TEMPLATE
             (*"#{state[:schema_and_entity]}.__table"
             #{super(node, state.merge(no_notes_examples: nil)).strip}
@@ -19,7 +19,6 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :express_table, ExpressTable.new
     end
   end
 end

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

@@ -2,7 +2,7 @@ module Stepmod
   module Utils
     module Converters
       class ExtDescription < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           state = state.merge(schema_name: node["linkend"],
                               non_flanking_whitesapce: true)
           child_text = treat_children(node, state).strip
@@ -14,7 +14,7 @@ module Stepmod
           TEMPLATE
         end
       end
-      ReverseAdoc::Converters.register :ext_description, ExtDescription.new
+      Coradoc::Input::HTML::Converters.register :ext_description, ExtDescription.new
     end
   end
 end

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

@@ -4,11 +4,11 @@ module Stepmod
   module Utils
     module Converters
       class ExtDescriptions < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           treat_children(node, state)
         end
       end
-      ReverseAdoc::Converters.register :ext_descriptions, ExtDescriptions.new
+      Coradoc::Input::HTML::Converters.register :ext_descriptions, ExtDescriptions.new
     end
   end
 end

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "reverse_adoc/converters/figure"
+require "coradoc/input/html/converters/figure"
 
 module Stepmod
   module Utils
     module Converters
-      class Figure < ReverseAdoc::Converters::Figure
+      class Figure < Coradoc::Input::HTML::Converters::Figure
         def self.pattern(state, id)
           if state[:schema_and_entity].nil?
             raise StandardError.new("[figure]: no state given, #{id}")
@@ -15,7 +15,7 @@ module Stepmod
           "figure-#{schema}-#{id}"
         end
 
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           # If we want to skip this node
           return "" if state[:no_notes_examples]
 
@@ -26,7 +26,12 @@ module Stepmod
                          self.class.pattern(state, node["number"])
                        end
 
-          super(node, state)
+          result = super(node, state)
+          id = result.id
+          anchor = "[[#{id}]]\n" if id
+          padding = "\n====\n"
+          child_content = treat_children(node, state).strip
+          "\n\n#{anchor}.#{result.title}#{padding}#{child_content}#{padding}"
         end
 
         def extract_title(node)
@@ -38,7 +43,7 @@ module Stepmod
       end
 
       # This replaces the converter
-      ReverseAdoc::Converters.register :figure, Figure.new
+      Coradoc::Input::HTML::Converters.register :figure, Figure.new
     end
   end
 end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class FundCons < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           <<~TEXT
 
             *)
@@ -15,7 +15,7 @@ module Stepmod
         end
       end
 
-      ReverseAdoc::Converters.register :fund_cons, FundCons.new
+      Coradoc::Input::HTML::Converters.register :fund_cons, FundCons.new
     end
   end
 end

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

@@ -4,12 +4,12 @@ module Stepmod
   module Utils
     module Converters
       class Introduction < Stepmod::Utils::Converters::Base
-        def convert(node, state = {})
+        def to_coradoc(node, state = {})
           treat_children(node, state)
         end
       end
 
-      ReverseAdoc::Converters.register :introduction, Introduction.new
+      Coradoc::Input::HTML::Converters.register :introduction, Introduction.new
     end
   end
 end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Stepmod
+  module Utils
+    module Converters
+      class Li < Coradoc::Input::HTML::Converters::Li
+        def to_coradoc(node, state = {})
+          li = super
+          li.content = li.content.map do |content|
+            parsed_content = Coradoc::Generator.gen_adoc(content)
+            parsed_content[0] == " " ? parsed_content : parsed_content.lstrip
+          end
+          li
+        end
+      end
+
+      Coradoc::Input::HTML::Converters.register :li, Li.new
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ module Stepmod
   module Utils
     module Converters
       class ModuleRef < Stepmod::Utils::Converters::Base
-        def convert(node, _state = {})
+        def to_coradoc(node, _state = {})
           link_end = node["linkend"].to_s.split(":")
           ref_id = link_end.last
           text = node.text.gsub(/\s/, " ").squeeze(" ").strip
@@ -86,7 +86,7 @@ module Stepmod
           /.*?\s*\(?\d+\)?/.match(text)
         end
       end
-      ReverseAdoc::Converters.register :module_ref, ModuleRef.new
+      Coradoc::Input::HTML::Converters.register :module_ref, ModuleRef.new
     end
   end
 end

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

@@ -5,7 +5,7 @@ module Stepmod
   module Utils
     module Converters
       class ModuleRefExpressDescription < Stepmod::Utils::Converters::Base
-        def convert(node, _state = {})
+        def to_coradoc(node, _state = {})
           link_end = node["linkend"].to_s.split(":")
           text = node.text.gsub(/\s/, " ").squeeze(" ").strip
 
@@ -45,7 +45,7 @@ module Stepmod
           # puts "[module_ref] #{result}"
         end
       end
-      ReverseAdoc::Converters.register :module_ref,
+      Coradoc::Input::HTML::Converters.register :module_ref,
                                        ModuleRefExpressDescription.new
     end
   end