stepmod-utils 0.3.2 → 0.3.8

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

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

@@ -16,27 +16,25 @@ 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
 
         def treat_text(node)
           text = node.text
           text = preserve_nbsp(text)
-          # text = remove_border_newlines(text)
           text = remove_inner_newlines(text)
+          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

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

@@ -1,21 +1,25 @@
 # frozen_string_literal: true
 
-require 'stepmod/utils/converters/synonym'
+require "stepmod/utils/converters/synonym"
 
 module Stepmod
   module Utils
     module Converters
       class Uof < ReverseAdoc::Converters::Base
-        def convert(node, state = {})
-          <<~TEXT
-          === #{node['name'].strip}
+        def convert(_node, _state = {})
+          # WARNING: <uof> tag content is deprecated
+          ""
 
-          <STEP module> #{treat_children(node, state).strip}
-          TEXT
+          #
+          # <<~TEXT
+          # === #{node['name'].strip}
+
+          # <STEP module> #{treat_children(node, state).strip}
+          # TEXT
         end
       end
 
       ReverseAdoc::Converters.register :uof, Uof.new
     end
   end
-end
+end

data/lib/stepmod/utils/html_to_asciimath.rb

@@ -6,7 +6,7 @@ module Stepmod
 
         to_asciimath = Nokogiri::HTML.fragment(input, "UTF-8")
 
-        to_asciimath.css('i').each do |math_element|
+        to_asciimath.css("i").each do |math_element|
           # puts "HTML MATH!!  #{math_element.to_xml}"
           # puts "HTML MATH!!  #{math_element.text}"
           decoded = text_to_asciimath(math_element.text)
@@ -21,7 +21,7 @@ module Stepmod
           end
         end
 
-        to_asciimath.css('sub').each do |math_element|
+        to_asciimath.css("sub").each do |math_element|
           case math_element.text.length
           when 0
             math_element.remove
@@ -30,7 +30,7 @@ module Stepmod
           end
         end
 
-        to_asciimath.css('sup').each do |math_element|
+        to_asciimath.css("sup").each do |math_element|
           case math_element.text.length
           when 0
             math_element.remove
@@ -39,14 +39,14 @@ module Stepmod
           end
         end
 
-        to_asciimath.css('ol').each do |element|
-          element.css('li').each do |li|
+        to_asciimath.css("ol").each do |element|
+          element.css("li").each do |li|
             li.replace ". #{li.text}"
           end
         end
 
-        to_asciimath.css('ul').each do |element|
-          element.css('li').each do |li|
+        to_asciimath.css("ul").each do |element|
+          element.css("li").each do |li|
             li.replace "* #{li.text}"
           end
         end
@@ -57,7 +57,8 @@ module Stepmod
         end
 
         html_entities_to_stem(
-          to_asciimath.children.to_s.gsub(/\]stem:\[/, '').gsub(/<\/?[uo]l>/, '')
+          to_asciimath.children.to_s.gsub(/\]stem:\[/, "").gsub(/<\/?[uo]l>/,
+                                                                ""),
         )
       end
 
@@ -66,91 +67,91 @@ module Stepmod
       end
 
       def html_entities_to_asciimath(x)
-        x.gsub("&alpha;", "alpha").
-          gsub("&beta;", "beta").
-          gsub("&gamma;", "gamma").
-          gsub("&Gamma;", "Gamma").
-          gsub("&delta;", "delta").
-          gsub("&Delta;", "Delta").
-          gsub("&epsilon;", "epsilon").
-          gsub("&varepsilon;", "varepsilon").
-          gsub("&zeta;", "zeta").
-          gsub("&eta;", "eta").
-          gsub("&theta;", "theta").
-          gsub("&Theta;", "Theta").
-          gsub("&vartheta;", "vartheta").
-          gsub("&iota;", "iota").
-          gsub("&kappa;", "kappa").
-          gsub("&lambda;", "lambda").
-          gsub("&Lambda;", "Lambda").
-          gsub("&mu;", "mu").
-          gsub("&nu;", "nu").
-          gsub("&xi;", "xi").
-          gsub("&Xi;", "Xi").
-          gsub("&pi;", "pi").
-          gsub("&Pi;", "Pi").
-          gsub("&rho;", "rho").
-          gsub("&beta;", "beta").
-          gsub("&sigma;", "sigma").
-          gsub("&Sigma;", "Sigma").
-          gsub("&tau;", "tau").
-          gsub("&upsilon;", "upsilon").
-          gsub("&phi;", "phi").
-          gsub("&Phi;", "Phi").
-          gsub("&varphi;", "varphi").
-          gsub("&chi;", "chi").
-          gsub("&psi;", "psi").
-          gsub("&Psi;", "Psi").
-          gsub("&omega;", "omega")
-          gsub("&#967", "χ").
-          gsub("&#215", "×").
-          gsub("&#931", "Σ").
-          gsub("&#961", "ρ").
-          gsub("&#963", "σ").
-          gsub("&#955", "λ").
-          gsub("&#964", "τ").
-          gsub("&#8706", "∂").
-          gsub("&#8804", "≤").
-          gsub("&#8805", "≥")
+        x.gsub("&alpha;", "alpha")
+          .gsub("&beta;", "beta")
+          .gsub("&gamma;", "gamma")
+          .gsub("&Gamma;", "Gamma")
+          .gsub("&delta;", "delta")
+          .gsub("&Delta;", "Delta")
+          .gsub("&epsilon;", "epsilon")
+          .gsub("&varepsilon;", "varepsilon")
+          .gsub("&zeta;", "zeta")
+          .gsub("&eta;", "eta")
+          .gsub("&theta;", "theta")
+          .gsub("&Theta;", "Theta")
+          .gsub("&vartheta;", "vartheta")
+          .gsub("&iota;", "iota")
+          .gsub("&kappa;", "kappa")
+          .gsub("&lambda;", "lambda")
+          .gsub("&Lambda;", "Lambda")
+          .gsub("&mu;", "mu")
+          .gsub("&nu;", "nu")
+          .gsub("&xi;", "xi")
+          .gsub("&Xi;", "Xi")
+          .gsub("&pi;", "pi")
+          .gsub("&Pi;", "Pi")
+          .gsub("&rho;", "rho")
+          .gsub("&beta;", "beta")
+          .gsub("&sigma;", "sigma")
+          .gsub("&Sigma;", "Sigma")
+          .gsub("&tau;", "tau")
+          .gsub("&upsilon;", "upsilon")
+          .gsub("&phi;", "phi")
+          .gsub("&Phi;", "Phi")
+          .gsub("&varphi;", "varphi")
+          .gsub("&chi;", "chi")
+          .gsub("&psi;", "psi")
+          .gsub("&Psi;", "Psi")
+          .gsub("&omega;", "omega")
+          .gsub("&#967", "χ")
+          .gsub("&#215", "×")
+          .gsub("&#931", "Σ")
+          .gsub("&#961", "ρ")
+          .gsub("&#963", "σ")
+          .gsub("&#955", "λ")
+          .gsub("&#964", "τ")
+          .gsub("&#8706", "∂")
+          .gsub("&#8804", "≤")
+          .gsub("&#8805", "≥")
       end
 
       def html_entities_to_stem(x)
-        x.gsub("&alpha;", "stem:[alpha]").
-          gsub("&beta;", "stem:[beta]").
-          gsub("&gamma;", "stem:[gamma]").
-          gsub("&Gamma;", "stem:[Gamma]").
-          gsub("&delta;", "stem:[delta]").
-          gsub("&Delta;", "stem:[Delta]").
-          gsub("&epsilon;", "stem:[epsilon]").
-          gsub("&varepsilon;", "stem:[varepsilon]").
-          gsub("&zeta;", "stem:[zeta]").
-          gsub("&eta;", "stem:[eta]").
-          gsub("&theta;", "stem:[theta]").
-          gsub("&Theta;", "stem:[Theta]").
-          gsub("&vartheta;", "stem:[vartheta]").
-          gsub("&iota;", "stem:[iota]").
-          gsub("&kappa;", "stem:[kappa]").
-          gsub("&lambda;", "stem:[lambda]").
-          gsub("&Lambda;", "stem:[Lambda]").
-          gsub("&mu;", "stem:[mu]").
-          gsub("&nu;", "stem:[nu]").
-          gsub("&xi;", "stem:[xi]").
-          gsub("&Xi;", "stem:[Xi]").
-          gsub("&pi;", "stem:[pi]").
-          gsub("&Pi;", "stem:[Pi]").
-          gsub("&rho;", "stem:[rho]").
-          gsub("&beta;", "stem:[beta]").
-          gsub("&sigma;", "stem:[sigma]").
-          gsub("&Sigma;", "stem:[Sigma]").
-          gsub("&tau;", "stem:[tau]").
-          gsub("&upsilon;", "stem:[upsilon]").
-          gsub("&phi;", "stem:[phi]").
-          gsub("&Phi;", "stem:[Phi]").
-          gsub("&varphi;", "stem:[varphi]").
-          gsub("&chi;", "stem:[chi]").
-          gsub("&psi;", "stem:[psi]").
-          gsub("&Psi;", "stem:[Psi]").
-          gsub("&omega;", "stem:[omega]")
+        x.gsub("&alpha;", "stem:[alpha]")
+          .gsub("&beta;", "stem:[beta]")
+          .gsub("&gamma;", "stem:[gamma]")
+          .gsub("&Gamma;", "stem:[Gamma]")
+          .gsub("&delta;", "stem:[delta]")
+          .gsub("&Delta;", "stem:[Delta]")
+          .gsub("&epsilon;", "stem:[epsilon]")
+          .gsub("&varepsilon;", "stem:[varepsilon]")
+          .gsub("&zeta;", "stem:[zeta]")
+          .gsub("&eta;", "stem:[eta]")
+          .gsub("&theta;", "stem:[theta]")
+          .gsub("&Theta;", "stem:[Theta]")
+          .gsub("&vartheta;", "stem:[vartheta]")
+          .gsub("&iota;", "stem:[iota]")
+          .gsub("&kappa;", "stem:[kappa]")
+          .gsub("&lambda;", "stem:[lambda]")
+          .gsub("&Lambda;", "stem:[Lambda]")
+          .gsub("&mu;", "stem:[mu]")
+          .gsub("&nu;", "stem:[nu]")
+          .gsub("&xi;", "stem:[xi]")
+          .gsub("&Xi;", "stem:[Xi]")
+          .gsub("&pi;", "stem:[pi]")
+          .gsub("&Pi;", "stem:[Pi]")
+          .gsub("&rho;", "stem:[rho]")
+          .gsub("&beta;", "stem:[beta]")
+          .gsub("&sigma;", "stem:[sigma]")
+          .gsub("&Sigma;", "stem:[Sigma]")
+          .gsub("&tau;", "stem:[tau]")
+          .gsub("&upsilon;", "stem:[upsilon]")
+          .gsub("&phi;", "stem:[phi]")
+          .gsub("&Phi;", "stem:[Phi]")
+          .gsub("&varphi;", "stem:[varphi]")
+          .gsub("&chi;", "stem:[chi]")
+          .gsub("&psi;", "stem:[psi]")
+          .gsub("&Psi;", "stem:[Psi]")
+          .gsub("&omega;", "stem:[omega]")
       end
     end
   end

data/lib/stepmod/utils/smrl_description_converter.rb

@@ -1,43 +1,44 @@
 # frozen_string_literal: true
 
-require 'reverse_adoc'
-require 'stepmod/utils/converters/a'
-require 'stepmod/utils/converters/blockquote'
-require 'stepmod/utils/converters/br'
-require 'stepmod/utils/converters/bypass'
-require 'stepmod/utils/converters/code'
-require 'stepmod/utils/converters/drop'
-require 'stepmod/utils/converters/em_express_description'
-require 'stepmod/utils/converters/example'
-require 'stepmod/utils/converters/express_ref_express_description'
-require 'stepmod/utils/converters/ext_description'
-require 'stepmod/utils/converters/ext_descriptions'
-require 'stepmod/utils/converters/head'
-require 'stepmod/utils/converters/hr'
-require 'stepmod/utils/converters/ignore'
-require 'stepmod/utils/converters/note'
-require 'stepmod/utils/converters/p'
-require 'stepmod/utils/converters/pass_through'
-require 'stepmod/utils/converters/q'
-require 'stepmod/utils/converters/strong'
-require 'stepmod/utils/converters/sub'
-require 'stepmod/utils/converters/sup'
-require 'stepmod/utils/converters/text'
-require 'stepmod/utils/cleaner'
+require "reverse_adoc"
+require "stepmod/utils/converters/a"
+require "stepmod/utils/converters/blockquote"
+require "stepmod/utils/converters/br"
+require "stepmod/utils/converters/bypass"
+require "stepmod/utils/converters/code"
+require "stepmod/utils/converters/drop"
+require "stepmod/utils/converters/em_express_description"
+require "stepmod/utils/converters/example"
+require "stepmod/utils/converters/express_ref_express_description"
+require "stepmod/utils/converters/ext_description"
+require "stepmod/utils/converters/ext_descriptions"
+require "stepmod/utils/converters/head"
+require "stepmod/utils/converters/hr"
+require "stepmod/utils/converters/ignore"
+require "stepmod/utils/converters/note"
+require "stepmod/utils/converters/p"
+require "stepmod/utils/converters/pass_through"
+require "stepmod/utils/converters/q"
+require "stepmod/utils/converters/strong"
+require "stepmod/utils/converters/sub"
+require "stepmod/utils/converters/sup"
+require "stepmod/utils/converters/text"
+require "stepmod/utils/cleaner"
 
 module Stepmod
   module Utils
     class SmrlDescriptionConverter
       def self.convert(input, options = {})
-        root = if input.is_a?(String)
-                  then Nokogiri::XML(input).root
-                elsif input.is_a?(Nokogiri::XML::Document)
-                  then input.root
-                elsif input.is_a?(Nokogiri::XML::Node)
-                  then input
-                end
+        root = case input
+               when String
+                 Nokogiri::XML(input).root
+               when Nokogiri::XML::Document
+                 input.root
+               when Nokogiri::XML::Node
+                 input
+               end
 
-        root || (return '')
+        root || (return "")
 
         ReverseAdoc.config.with(options) do
           result = ReverseAdoc::Converters.lookup(root.name).convert(root)
@@ -46,4 +47,4 @@ module Stepmod
       end
     end
   end
-end
+end

data/lib/stepmod/utils/smrl_resource_converter.rb

@@ -1,61 +1,62 @@
 # frozen_string_literal: true
 
-require 'reverse_adoc'
-require 'reverse_adoc/converters/bypass'
-require 'reverse_adoc/converters/pass_through'
-require 'stepmod/utils/converters/a'
-require 'stepmod/utils/converters/blockquote'
-require 'stepmod/utils/converters/br'
-require 'stepmod/utils/converters/bypass'
-require 'stepmod/utils/converters/code'
-require 'stepmod/utils/converters/comment'
-require 'stepmod/utils/converters/dd'
-require 'stepmod/utils/converters/dl'
-require 'stepmod/utils/converters/dt'
-require 'stepmod/utils/converters/drop'
-require 'stepmod/utils/converters/example'
-require 'stepmod/utils/converters/express_g'
-require 'stepmod/utils/converters/fund_cons'
-require 'stepmod/utils/converters/eqn'
-require 'stepmod/utils/converters/head'
-require 'stepmod/utils/converters/hr'
-require 'stepmod/utils/converters/ignore'
-require 'stepmod/utils/converters/introduction'
-require 'stepmod/utils/converters/note'
-require 'stepmod/utils/converters/ol'
-require 'stepmod/utils/converters/p'
-require 'stepmod/utils/converters/pass_through'
-require 'stepmod/utils/converters/q'
-require 'stepmod/utils/converters/resource'
-require 'stepmod/utils/converters/schema_diag'
-require 'stepmod/utils/converters/schema'
-require 'stepmod/utils/converters/strong'
-require 'stepmod/utils/converters/sub'
-require 'stepmod/utils/converters/sup'
-require 'stepmod/utils/converters/table'
-require 'stepmod/utils/converters/text'
-require 'stepmod/utils/cleaner'
+require "reverse_adoc"
+require "reverse_adoc/converters/bypass"
+require "reverse_adoc/converters/pass_through"
+require "stepmod/utils/converters/a"
+require "stepmod/utils/converters/blockquote"
+require "stepmod/utils/converters/br"
+require "stepmod/utils/converters/bypass"
+require "stepmod/utils/converters/code"
+require "stepmod/utils/converters/comment"
+require "stepmod/utils/converters/dd"
+require "stepmod/utils/converters/dl"
+require "stepmod/utils/converters/dt"
+require "stepmod/utils/converters/drop"
+require "stepmod/utils/converters/example"
+require "stepmod/utils/converters/express_g"
+require "stepmod/utils/converters/fund_cons"
+require "stepmod/utils/converters/eqn"
+require "stepmod/utils/converters/head"
+require "stepmod/utils/converters/hr"
+require "stepmod/utils/converters/ignore"
+require "stepmod/utils/converters/introduction"
+require "stepmod/utils/converters/note"
+require "stepmod/utils/converters/ol"
+require "stepmod/utils/converters/p"
+require "stepmod/utils/converters/pass_through"
+require "stepmod/utils/converters/q"
+require "stepmod/utils/converters/resource"
+require "stepmod/utils/converters/schema_diag"
+require "stepmod/utils/converters/schema"
+require "stepmod/utils/converters/strong"
+require "stepmod/utils/converters/sub"
+require "stepmod/utils/converters/sup"
+require "stepmod/utils/converters/table"
+require "stepmod/utils/converters/text"
+require "stepmod/utils/cleaner"
 
-require 'reverse_adoc/converters/figure'
-require 'reverse_adoc/converters/img'
-require 'reverse_adoc/converters/li'
-require 'reverse_adoc/converters/tr'
-require 'reverse_adoc/converters/td'
-require 'reverse_adoc/converters/th'
+require "reverse_adoc/converters/figure"
+require "reverse_adoc/converters/img"
+require "reverse_adoc/converters/li"
+require "reverse_adoc/converters/tr"
+require "reverse_adoc/converters/td"
+require "reverse_adoc/converters/th"
 
 module Stepmod
   module Utils
     class SmrlResourceConverter
       def self.convert(input, options = {})
-        root = if input.is_a?(String)
-                  then Nokogiri::XML(input).root
-                elsif input.is_a?(Nokogiri::XML::Document)
-                  then input.root
-                elsif input.is_a?(Nokogiri::XML::Node)
-                  then input
-                end
+        root = case input
+               when String
+                 Nokogiri::XML(input).root
+               when Nokogiri::XML::Document
+                 input.root
+               when Nokogiri::XML::Node
+                 input
+               end
 
-        root || (return '')
+        root || (return "")
 
         ReverseAdoc.config.with(options) do
           result = ReverseAdoc::Converters.lookup(root.name).convert(root)
@@ -64,4 +65,4 @@ module Stepmod
       end
     end
   end
-end
+end