stepmod-utils 0.4.10 → 0.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1342ffe0c2b8463d7563761080df38410a31f68ced0ad56e032beb1b3f1bfd6a
-  data.tar.gz: 5324d7df8dc68fd682e1b9b6947fb10cc26f294c852621433bec30875f31edd0
+  metadata.gz: 277e199cae63ff4916555e4d208672a1d561809e7abb921eff70e022e781e5c1
+  data.tar.gz: c4762ca7dc28641cbca3c1eebcc393940963d702acd83ef183ad42bf44fb6944
 SHA512:
-  metadata.gz: edca6ad9e40f5b3eeea360ee18b99732dc9f9c0e6d8875144bdbb2f085fc5bafb877629f1b5876e60415d44af92cbbbd4ccfa40805bfa62e6a9f3f4957dcf35c
-  data.tar.gz: 52690eb5dc833108259a41c6d5493b31330665b852e9b027c5a1a7d436c5119f1dcf588d7031e3096357cfd969f434a4d67009bbaeebc0c11eb5f78eba7d62f4
+  metadata.gz: 8999ccb49cae3922ed4c8ef8cdeece7f80ede6501dfe75219d6e6ba0749013850ccfcd6a0d55ecb479441e3210e5a1064a17cbfff9d0348c273b5e999670ae05
+  data.tar.gz: '039013eaddf84f1afc779b4311c254ace92513a0652418b1648d8da0dbbdb7cc86cad0efb4ba11670a5d5df4b8b56889e788cc73f4a98098e8b27857e74b9e6b'

data/.gitignore

@@ -13,3 +13,5 @@
 Gemfile.lock
 
 .rubocop-https*
+
+stepmod-utils.log.txt

data/exe/stepmod-annotate-all

@@ -40,6 +40,14 @@ OptionParser.new do |opts|
     options[:srl_output_docs_dir] = path
   end
 
+  opts.on(
+    "--eqn-log LOG_FILE_DIR",
+    String,
+    "Path to the directory for log file for equations",
+  ) do |path|
+    options[:eqn_log_dir] = path
+  end
+
   opts.on_tail("-h", "--help", "Show this message") do
     puts opts
     exit
@@ -67,6 +75,9 @@ unless File.exist?(srl_output_docs_dir) && File.directory?(srl_output_docs_dir)
   raise StandardError.new("--documents directory for SRL documents (generated by stepmod2mn) does not exist yet, please run stepmod2mn")
 end
 
+eqn_log_dir = File.expand_path(options[:eqn_log_dir] || ".")
+Stepmod::Utils.eqn_log_dir = eqn_log_dir
+
 def all_express_files(stepmod_dir)
   index_file = File.read(File.join(stepmod_dir, "repository_index.xml"))
   index = Nokogiri::XML(index_file).root

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

@@ -18,7 +18,9 @@ module Stepmod
             treat(equation, state.merge(equation: true, already_italic: true))
           end
 
-          content = if content.strip.empty? || state[:already_italic] || state[:equation]
+          content = if state[:equation] && state[:convert_bold_and_italics]
+            "ii(#{content.strip})"
+          elsif content.strip.empty? || state[:already_italic] || state[:equation]
             content
           else
             "#{content[/^\s*/]}_#{content.strip}_#{content[/\s*$/]}"

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "stepmod/utils/html_to_asciimath"
+require "stepmod/utils/equation_logger"
 
 module Stepmod
   module Utils
@@ -14,7 +15,11 @@ module Stepmod
             return definition_converted(cloned_node, state)
           end
 
-          stem_converted(cloned_node, state)
+          equation_converted = stem_converted(cloned_node, state)
+
+          log_equation(node, state, equation_converted)
+
+          equation_converted
         end
 
         private
@@ -50,11 +55,11 @@ module Stepmod
         end
 
         def stem_converted(cloned_node, state)
-          remove_tags_not_in_context(cloned_node)
+          remove_tags_not_in_context(cloned_node) unless state[:convert_bold_and_italics]
           internal_content = treat_children(cloned_node, state.merge(equation: true))
           content = Stepmod::Utils::HtmlToAsciimath.new.call(internal_content)
           res = <<~TEMPLATE
-
+            #{source_type_comment(cloned_node)}
             [stem]
             ++++
             #{remove_trash_symbols(content.strip)}
@@ -66,6 +71,10 @@ module Stepmod
           res
         end
 
+        def source_type_comment(node)
+          "\n// source type is bigeqn\n" if node.name == "bigeqn"
+        end
+
         def remove_trash_symbols(content)
           content
             .gsub(/ /, "")
@@ -92,9 +101,28 @@ module Stepmod
               end
           end
         end
+
+        def equation_logger
+          @equation_logger ||= Stepmod::Utils::EquationLogger.new
+        end
+
+        def log_equation(node, state, equation_converted)
+          equation_converted_with_bold_and_italics = stem_converted(node.clone, state.merge(convert_bold_and_italics: true))
+
+          return if equation_converted_with_bold_and_italics == equation_converted
+
+          equation_logger.anchor = state[:schema_and_entity] || state[:schema_name]
+          equation_logger.document = state[:descriptions_file]
+          equation_logger.equation = node.to_s
+          equation_logger.equation_converted = equation_converted
+          equation_logger.equation_converted_with_bold_and_italics = equation_converted_with_bold_and_italics
+
+          equation_logger.log
+        end
       end
 
       ReverseAdoc::Converters.register :eqn, Eqn.new
+      ReverseAdoc::Converters.register :bigeqn, Eqn.new
     end
   end
 end

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

@@ -20,7 +20,9 @@ module Stepmod
             treat(equation, state.merge(equation: true, already_strong: true))
           end
 
-          content = if content.strip.empty? || state[:already_strong] || state[:equation]
+          content = if state[:equation] && state[:convert_bold_and_italics]
+            "bb(#{content.strip})"
+          elsif content.strip.empty? || state[:already_strong] || state[:equation]
             content
           else
             strong_tag = state[:non_flanking_whitesapce] ? '**' : '*'

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

@@ -4,7 +4,6 @@ module Stepmod
   module Utils
     module Converters
       class Table < Stepmod::Utils::Converters::Base
-
         def self.pattern(state, id)
           if state[:schema_and_entity].nil?
             raise StandardError.new("[table]: no state given, #{id}")
@@ -23,8 +22,14 @@ module Stepmod
           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"
+
+          <<~TABLE
+
+
+            #{anchor}#{attrs}#{title}|===
+            #{treat_children(node, state.merge(inside_table: true))}
+            |===
+          TABLE
         end
 
         def frame(node)

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

@@ -8,7 +8,7 @@ module Stepmod
           if node.text.strip.empty?
             treat_empty(node, state)
           else
-            treat_text(node)
+            treat_text(node, state)
           end
         end
 
@@ -27,21 +27,25 @@ module Stepmod
           end
         end
 
-        def treat_text(node)
+        def treat_text(node, state)
           text = node.text
           text = preserve_nbsp(text)
           text = remove_inner_newlines(text)
           text = remove_border_newlines(text)
 
           text = preserve_keychars_within_backticks(text)
-          preserve_tags(text)
+
+          text = preserve_pipes_within_tables(text, state)
+          preserve_tags(text, state)
         end
 
         def preserve_nbsp(text)
           text.gsub(/\u00A0/, " ")
         end
 
-        def preserve_tags(text)
+        def preserve_tags(text, state)
+          return text if state[:inside_table]
+
           text.gsub(/[<>]/, ">" => '\>', "<" => '\<')
         end
 
@@ -58,6 +62,12 @@ module Stepmod
             match.gsub('\_', "_").gsub('\*', "*")
           end
         end
+
+        def preserve_pipes_within_tables(text, state)
+          return text unless state[:inside_table]
+
+          text.gsub("|", "\\|")
+        end
       end
 
       ReverseAdoc::Converters.register :text, Text.new

data/lib/stepmod/utils/equation_logger.rb

@@ -0,0 +1,67 @@
+require "plurimath"
+require "stepmod/utils"
+
+module Stepmod
+  module Utils
+    class EquationLogger
+      attr_accessor :anchor,
+                    :document,
+                    :equation,
+                    :equation_converted,
+                    :equation_converted_with_bold_and_italics
+
+      def initialize
+        @logger = Logger.new(logger_file_path)
+      end
+
+      def log
+        Stepmod::Utils.increment_eqn_counter
+        @logger.info do
+          <<~MESSAGE
+
+            =================== Equation #{Stepmod::Utils.eqn_counter} Start ===================
+            Document: #{document}
+            Nearest Anchor: #{anchor}
+
+            Formula (original):
+            #{equation}
+
+            ------------------
+
+            Status: #{valid_asciimath?(equation_converted)}
+            Formula (asciimath):
+            #{equation_converted}
+
+            ------------------
+
+            Status: #{valid_asciimath?(equation_converted_with_bold_and_italics)}
+            Formula (asciimath with bold and italics included):
+            #{equation_converted_with_bold_and_italics}
+
+            =================== Equation #{Stepmod::Utils.eqn_counter} End ===================
+
+
+          MESSAGE
+        end
+      end
+
+      private
+
+      def logger_file_path
+        File.join(Stepmod::Utils.eqn_log_dir, "stepmod-utils.log.txt")
+      end
+
+      def valid_asciimath?(equation)
+        extracted_equation = extract_equation_from_stem(equation)
+        Plurimath::Math.parse(extracted_equation, :asciimath).to_mathml
+        "valid"
+      rescue StandardError
+        "invalid"
+      end
+
+      def extract_equation_from_stem(stem)
+        stem.gsub(/\[stem\]|\+\+\+\+/, "").strip
+      end
+    end
+  end
+end

data/lib/stepmod/utils/stepmod_file_annotator.rb

@@ -166,7 +166,7 @@ module Stepmod
 
           converted_description = <<~DESCRIPTION
 
-            #{Stepmod::Utils::SmrlDescriptionConverter.convert(wrapper, no_notes_examples: true)}
+            #{Stepmod::Utils::SmrlDescriptionConverter.convert(wrapper, no_notes_examples: true, descriptions_file: descriptions_file)}
           DESCRIPTION
 
           if description["linkend"].nil?
@@ -176,25 +176,25 @@ module Stepmod
           converted_figures = figures.map do |figure|
             Stepmod::Utils::Converters::ExpressFigure
               .new
-              .convert(figure, schema_and_entity: description["linkend"])
+              .convert(figure, schema_and_entity: description["linkend"], descriptions_file: descriptions_file)
           end.join
 
           converted_tables = tables.map do |table|
             Stepmod::Utils::Converters::ExpressTable
               .new
-              .convert(table, schema_and_entity: description["linkend"])
+              .convert(table, schema_and_entity: description["linkend"], descriptions_file: descriptions_file)
           end.join
 
           converted_notes = notes.map do |note|
             Stepmod::Utils::Converters::ExpressNote
               .new
-              .convert(note, schema_and_entity: description["linkend"])
+              .convert(note, schema_and_entity: description["linkend"], descriptions_file: descriptions_file)
           end.join
 
           converted_examples = examples.map do |example|
             Stepmod::Utils::Converters::ExpressExample
               .new
-              .convert(example, schema_and_entity: description["linkend"])
+              .convert(example, schema_and_entity: description["linkend"], descriptions_file: descriptions_file)
           end.join
 
           [
@@ -358,6 +358,7 @@ module Stepmod
             {
               no_notes_examples: false,
               schema_and_entity: linked,
+              descriptions_file: descriptions_file,
             },
           )
         end

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.4.10".freeze
+    VERSION = "0.4.12".freeze
   end
 end

data/lib/stepmod/utils.rb

@@ -3,6 +3,28 @@ require "stepmod/utils/version"
 module Stepmod
   module Utils
     class Error < StandardError; end
-    # Your code goes here...
+
+    @@eqn_log_dir = "."
+    @@eqn_counter = 0
+
+    def self.root
+      File.expand_path("../..", __dir__)
+    end
+
+    def self.eqn_log_dir=(eqn_log_dir)
+      @@eqn_log_dir = eqn_log_dir
+    end
+
+    def self.eqn_log_dir
+      @@eqn_log_dir
+    end
+
+    def self.eqn_counter
+      @@eqn_counter
+    end
+
+    def self.increment_eqn_counter
+      @@eqn_counter += 1
+    end
   end
 end

data/stepmod-utils.gemspec

@@ -35,12 +35,14 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "expressir"
   spec.add_runtime_dependency "glossarist", "~> 2.0"
   spec.add_runtime_dependency "indefinite_article"
+  spec.add_runtime_dependency "plurimath"
   spec.add_runtime_dependency "ptools"
   spec.add_runtime_dependency "pubid-iso"
   spec.add_runtime_dependency "octokit"
   spec.add_runtime_dependency "down"
   spec.add_runtime_dependency "reverse_adoc", ">= 0.3"
   spec.add_runtime_dependency "thor", ">= 0.20"
+  spec.add_runtime_dependency "unitsml"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "rubocop-rails"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 0.4.12
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-22 00:00:00.000000000 Z
+date: 2024-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: plurimath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ptools
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: unitsml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -293,6 +321,7 @@ files:
 - lib/stepmod/utils/converters/term.rb
 - lib/stepmod/utils/converters/text.rb
 - lib/stepmod/utils/converters/uof.rb
+- lib/stepmod/utils/equation_logger.rb
 - lib/stepmod/utils/express_bibdata.rb
 - lib/stepmod/utils/html_to_asciimath.rb
 - lib/stepmod/utils/smrl_description_converter.rb