stepmod-utils 0.6.7 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc2de5e456094259eac1cbcad35b4de207a2aad873277c41cc056020257e5fd6
-  data.tar.gz: dd5edacfb209ca881dec21936611a7151c63313a2c4d3ce74e85a0d8ff8b036c
+  metadata.gz: 3b84fbdfaf0322f4f207043d9f7f8034a58539f33c030846c593f6c3cac8b7c8
+  data.tar.gz: 8689dceb2e71c4401732e5e5e1c522be9bca434de6014f2054e54ef85e3e9845
 SHA512:
-  metadata.gz: c3ade34b7762f2bdba70b0d5019cdbd1213cbadc32514057d4f621b0b403a70baf46e2e7830c2bbb472d33d284491f3dfb460d3e0da6895aa3dc619609f51a83
-  data.tar.gz: d0447346235cb6a8688a1ef25d027e58305661715f2540cb8a011441fb62fc62e6905dce7f26f5aff8479c4e44932645c70725d264cb6503c200e07f1371cdf0
+  metadata.gz: ebc46e61ce576382b898913fc348ba473e52fb23a7fb65677ac6436a93d5bfcf1a9208e64f3d25c38a0e57eac7718384589dabfebac2925deb3fb6e39ba4d529
+  data.tar.gz: d075afeb2933647f9b6fc2fe32a32f2dcf49f4a7dc0ed12fa750f4ae4f02aac115a5e08581bacd68869a14c3c02fc3a4c794e0676bd6dc2dae02411398fd385c

data/.rubocop.yml

@@ -10,4 +10,4 @@ Style/MultilineMethodCallIndentation:
   EnforcedStyle: aligned
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.1

data/Gemfile

@@ -5,7 +5,10 @@ source "https://rubygems.org"
 gemspec
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem "concurrent-ruby", "~> 1.1"
+gem "concurrent-ruby"
 gem "pry"
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rails"

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,42 @@
-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/concept.rb

@@ -3,16 +3,17 @@ require "glossarist"
 module Stepmod
   module Utils
     class Concept < Glossarist::LocalizedConcept
-      attr_accessor *%w(
+      CUSTOM_ATTRIBUTES = %w(
         reference_clause
         reference_anchor
         converted_definition
         file_path
         schema
         part
-        domain
         document
-      )
+      ).freeze
+
+      attr_accessor(*CUSTOM_ATTRIBUTES)
 
       # TODO: converted_definition is not supposed to be an attribute, it is
       # supposed to be a method!
@@ -45,14 +46,20 @@ file_path:, language_code: "eng")
           # TODO: `designations:` should include the `alt:[...]` terms here,
           # they are now only included in definition_xml_converted_definition.
           new(
-            designations: designation,
-            definition: [definition],
+            data: Glossarist::ConceptData.new(
+              {
+                terms: designation,
+                definition: [
+                  Glossarist::DetailedDefinition.new({ content: definition }),
+                ],
+                language_code: language_code,
+              },
+            ),
             converted_definition: converted_definition,
             id: "#{reference_anchor}.#{reference_clause}",
             reference_anchor: reference_anchor,
             reference_clause: reference_clause,
             file_path: file_path,
-            language_code: language_code,
           )
         end
 
@@ -80,7 +87,9 @@ file_path:, language_code: "eng")
             designations << { "designation" => alt, "type" => "expression" }
           end
 
-          designations
+          designations.map do |des|
+            Glossarist::Designation::Base.from_yaml(des.to_yaml)
+          end
         end
 
         def definition_xml_definition(definition_xml, reference_anchor)
@@ -106,24 +115,19 @@ file_path:, language_code: "eng")
         end
 
         def definition_xml_converted_definition(designation, definition)
-          accepted_designation = designation.select do |des|
-            des["normative_status"] == "preferred"
-          end
-
-          alt_designations = designation.reject do |des|
-            des["normative_status"] == "preferred"
-          end
+          accepted_designation = designation.select(&:preferred?)
+          alt_designations = designation.reject(&:preferred?)
 
           if alt_designations.length.positive?
             alt_designations_text = alt_designations.map do |d|
-              d["designation"].strip
+              d.designation.strip
             end.join(",")
 
             alt_notation = "alt:[#{alt_designations_text}]"
           end
 
           result = <<~TEXT
-            === #{accepted_designation.map { |d| d['designation'].strip }.join(',')}
+            === #{accepted_designation.map { |d| d.designation.strip }.join(',')}
           TEXT
 
           if alt_notation
@@ -140,6 +144,14 @@ file_path:, language_code: "eng")
         end
       end
 
+      def initialize(hash = {})
+        super(hash)
+
+        CUSTOM_ATTRIBUTES.each do |attr|
+          public_send("#{attr}=", hash[attr] || hash[attr.to_sym])
+        end
+      end
+
       def to_h
         super.merge({
           "domain" => domain,
@@ -149,9 +161,13 @@ file_path:, language_code: "eng")
         }.compact)
       end
 
+      def domain
+        data.domain
+      end
+
       def to_mn_adoc
         <<~TEXT
-          // STEPmod path:#{file_path.empty? ? '' : " #{file_path}"}
+          // STEPmod path:#{file_path.to_s.empty? ? '' : " #{file_path}"}
           #{converted_definition}
 
           [.source]

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

@@ -8,6 +8,10 @@ module Stepmod
           italic_converted(node, state)
         end
 
+        def to_coradoc(node, state = {})
+          italic_converted(node, state)
+        end
+
         private
 
         def italic_converted(node, state)
@@ -44,9 +48,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,8 @@ 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,13 @@ 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,8 @@ module Stepmod
           TEMPLATE
         end
       end
-      ReverseAdoc::Converters.register :ext_description, ExtDescription.new
+      Coradoc::Input::Html::Converters.register :ext_description,
+                                                ExtDescription.new
     end
   end
 end