stepmod-utils 0.3.8 → 0.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6201c720f31faffdd6646d74a3c150733f3219bd756d9ba9743e5a27c1db4495
-  data.tar.gz: b1bafce759e91f5923d030fe0b5b0f74f2b719a832d53ac300db6b38e3e221d0
+  metadata.gz: cede4c978acf6fd33ac7bae2dd5a0020e8f0e9f5ac06e1562f089dd2aa702ee5
+  data.tar.gz: d4cdb2bf5abe663d7089c6d74a939fab72b698ef64a3029695cfd467a423f74d
 SHA512:
-  metadata.gz: 206becea0d17c930418426618aa5234e420a4aba77e63a9448890245dd637ca044ad5540073e509ca8d672a701bc31b1b9576ad671f21a0da7f620f917c83b68
-  data.tar.gz: 4f564a4b188082f6a20e41bb424c50950a2efce588fd1c48adaceb3a1068c7b4d5fa2388c758491f1d8814cceaefaee8f842337ae57d49873cb4e2bcb43933b1
+  metadata.gz: 9f9db582dd4c85836ed96c8916024d9cf75c8019a512305634df73af0be3dbe9faf53ea2e8b516afe7417f0c68a50f5b27303d5034cf627fcdbacf4e05a3f1c5
+  data.tar.gz: 52cd06f6cd0a044d4e904a6daa85d2802a9731b1b2aa13643087b71c60f3c106f67623dca248a00c970f48875faf415776b3f48de74bf51539b6a3c94b9f57f2

data/exe/stepmod-extract-terms

@@ -53,6 +53,22 @@ def part_to_title(bibdata)
   end
 end
 
+IMAGE_REPLACEMENTS = {
+  'image::eq01.gif[]' => 'stem:[H(A,B) = max {h(A, B), h(B,A)}]',
+  'image::eq02.gif[]' => 'stem:[max_{a in A} { min_{b in B} d(a,b) }]',
+  'image::vector_z_c.gif[]' => 'stem:[bar z_{c}]',
+  'image::one_direction_repeat_factor_expression.gif[]' => 'stem:[I + k cdot R;  k = -1, 1]',
+  'image::two_direction_repeat_factor_expression.gif[]' => 'stem:[I + k_1 cdot R_1 + k_2 cdot R_2;  k_1, k_2 = -1, 0, 1, k^2_1 + k^2_2 != 0]'
+}
+
+def replace_images(content)
+  IMAGE_REPLACEMENTS.each_pair do |k, v|
+    content.gsub!(k, v)
+  end
+
+  content
+end
+
 def log(message)
   puts "[stepmod-utils] #{message}"
 end
@@ -64,23 +80,45 @@ part_concepts.each do |(bibdata, current_part_concepts)|
   fn = "03x-stepmod-#{bibdata.part}.adoc"
   File.open(fn, "w") do |file|
     file.puts("== #{part_to_title(bibdata)}\n\n")
-    file.puts(current_part_concepts.map(&:to_mn_adoc).join("\n"))
+    file.puts(replace_images(current_part_concepts.map(&:to_mn_adoc).join("\n")))
   end
   log "INFO: written to: #{fn}"
 end
 
+File.open("03x-stepmod.adoc", "w") do |file|
+  part_concepts.sort_by do |(bibdata, current_part_concepts)|
+    bibdata.part.to_i
+  end.each do |(bibdata, current_part_concepts)|
+    fn = "03x-stepmod-#{bibdata.part}.adoc"
+    file.puts("\ninclude::#{fn}[]\n")
+  end
+end
+
+log "INFO: written summary file to: 03x-stepmod.adoc"
+
 part_resources.each do |(bibdata, current_part_resources)|
   current_part_resources = current_part_resources.to_a.map do |n|
     n.localizations["en"]
   end
   fn = "04x-stepmod-entities-resources-#{bibdata.part}.adoc"
   File.open(fn, "w") do |file|
-    file.puts("== #{part_to_title(bibdata)}\n\n")
-    file.puts(current_part_resources.map(&:to_mn_adoc).join("\n"))
+    # file.puts("== #{part_to_title(bibdata)}\n\n")
+    file.puts(replace_images(current_part_resources.map(&:to_mn_adoc).join("\n")))
   end
   log "INFO: written to: #{fn}"
 end
 
+File.open("04x-stepmod-entities-resources.adoc", "w") do |file|
+  part_resources.sort_by do |(bibdata, current_part_resources)|
+    bibdata.part.to_i
+  end.each do |(bibdata, current_part_resources)|
+    fn = "04x-stepmod-entities-resources-#{bibdata.part}.adoc"
+    file.puts("\ninclude::#{fn}[]\n")
+  end
+end
+
+log "INFO: written summary file to: 04x-stepmod-entities-resources.adoc"
+
 part_modules.each do |(bibdata, part_modules_arm, part_modules_mim)|
   fn = "05x-stepmod-entities-modules-#{bibdata.part}.adoc"
   File.open(fn, "w") do |file|
@@ -106,23 +144,43 @@ part_modules.each do |(bibdata, part_modules_arm, part_modules_mim)|
         n.localizations["en"]
       end
       file.puts("== #{schema_name}\n\n")
-      file.puts(concepts.map(&:to_mn_adoc).join("\n"))
+      file.puts(replace_images(concepts.map(&:to_mn_adoc).join("\n")))
     end
   end
   log "INFO: written to: #{fn}"
 end
 
+File.open("05x-stepmod-entities-modules.adoc", "w") do |file|
+  part_modules.sort_by do |(bibdata, part_modules_arm, part_modules_mim)|
+    bibdata.part.to_i
+  end.each do |(bibdata, part_modules_arm, part_modules_mim)|
+    fn = "05x-stepmod-entities-modules-#{bibdata.part}.adoc"
+    file.puts("\ninclude::#{fn}[]\n")
+  end
+end
+
+log "INFO: written summary file to: 05x-stepmod-entities-modules.adoc"
+
 File.open("031-stepmod-general.adoc", "w") do |file|
-  file.puts(general_concepts.to_a.map do |n|
-              n.localizations["en"]
-            end.map(&:to_mn_adoc).join("\n"))
+  file.puts(
+    replace_images(
+      general_concepts.to_a.map do |n|
+        n.localizations["en"]
+      end.map(&:to_mn_adoc).join("\n")
+    )
+  )
 end
+
 log "INFO: written to: 031-stepmod-general.adoc"
 
 File.open("041-stepmod-entities-resources.adoc", "w") do |file|
-  file.puts(resource_concepts.to_a.map do |n|
-              n.localizations["en"]
-            end.map(&:to_mn_adoc).join("\n"))
+  file.puts(
+    replace_images(
+      resource_concepts.to_a.map do |n|
+        n.localizations["en"]
+      end.map(&:to_mn_adoc).join("\n")
+    )
+  )
 end
 log "INFO: written to: 041-stepmod-entities-resources.adoc"
 

data/lib/stepmod/utils/concept.rb

@@ -31,7 +31,10 @@ module Stepmod
               Reference <<#{reference_anchor}>> for the complete definition.
             TEXT
           end
+
           # https://github.com/metanorma/stepmod-utils/issues/86
+
+          # TODO: This portion DOES NOT HANDLE the <synonym> element. WTF??
           if definition_xml.name == "definition"
             designation = definition_designation(definition_xml)
             definition = definition_xml_definition(definition_xml,
@@ -40,6 +43,7 @@ module Stepmod
               designation, definition
             ).strip
           end
+
           new(
             designations: [designation],
             definition: definition,
@@ -53,20 +57,36 @@ module Stepmod
         end
 
         def definition_designation(definition_xml)
-          alts = definition_xml.xpath(".//def/p").map(&:text)
+          # We take the <p> that is an alternative term (length<=20).
+          # Add in the <synonym> elements.
+          alts = definition_xml.xpath(".//synonym").map(&:text) +
+            definition_xml.xpath(".//def/p").map(&:text).reject do |text|
+              text.length > 20
+            end
+
+          term = Stepmod::Utils::Converters::Term
+            .new
+            .convert(
+              definition_xml.xpath(".//term").first
+            )
+
           {
-            accepted: definition_xml.xpath(".//term").first&.text,
+            # [4..-1] because we want to skip the initial `=== {title}`
+            accepted: term[4..-1],
             alt: alts,
           }
         end
 
         def definition_xml_definition(definition_xml, reference_anchor)
+          # We reject the <p> that was considered an alternative term (length<=20)
           text_nodes = definition_xml
             .xpath(".//def")
             .first
             .children
-            .reject { |n| n.name == "p" }
+            .reject { |n| n.name == "p" && n.text.length <= 20 }
+
           wrapper = "<def>#{text_nodes.map(&:to_s).join}</def>"
+
           Stepmod::Utils::Converters::Def
             .new
             .convert(
@@ -83,15 +103,18 @@ module Stepmod
           if designation[:alt].length.positive?
             alt_notation = "alt:[#{designation[:alt].map(&:strip).join(',')}]"
           end
+
           result = <<~TEXT
-            === #{designation[:accepted]}
+            === #{designation[:accepted].strip}
           TEXT
+
           if alt_notation
             result += <<~TEXT
 
               #{alt_notation}
             TEXT
           end
+
           <<~TEXT
             #{result}
             #{definition}

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "uri"
-
 module Stepmod
   module Utils
     module Converters
@@ -31,9 +29,7 @@ module Stepmod
             name = title if name.empty?
             href = "link:#{href}" unless href.to_s&.match?(URI::DEFAULT_PARSER.make_regexp)
             link = "#{href}[#{name}]"
-            # link.prepend(' ')
             " #{link}"
-
           end
         end
       end

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

@@ -5,7 +5,7 @@ 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

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

@@ -19,7 +19,7 @@ module Stepmod
             " {{#{normalized_ref(ref)}}} "
           elsif
             ref = node["linkend"].split(":").first
-            " *#{ref}*"
+            " *#{ref}* "
           end
         end
 

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

@@ -9,10 +9,12 @@ module Stepmod
           anchor = id ? "[[#{id}]]\n" : ""
           ol_count = state.fetch(:ol_count, 0) + 1
           attrs = ol_attrs(node)
-          "\n\n#{anchor}#{attrs}#{treat_children(node,
-                                                 state.merge(
-                                                   ol_count: ol_count, tdsinglepara: true,
-                                                 ))}\n"
+          children_s = treat_children(node, state.merge(
+                                              ol_count: ol_count,
+                                              tdsinglepara: true,
+                                            ))
+
+          "\n\n#{anchor}#{attrs}#{children_s}\n"
           # Why do we add this?
           # res = "\n" + res if node.parent && node.parent.name == 'note'
         end

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

@@ -13,8 +13,28 @@ module Stepmod
           child_text = treat_children(node, state).strip
           return nil if child_text.empty?
 
-          # Only taking the first paragraph of the definition
-          child_text = child_text.split("\n").first
+          # Unless the first paragraph ends with "between" and is followed by a
+          # list, don't split
+          first_child = child_text.split("\n").first
+
+          unless (
+            first_child =~ /between:?\s*\Z/ ||
+            first_child =~ /include:?\s*\Z/ ||
+            first_child =~ /of:?\s*\Z/ ||
+            first_child =~ /[:;]\s*\Z/
+            ) &&
+            child_text =~ /\n\n\*/
+
+            # Only taking the first paragraph of the definition
+            child_text = first_child
+          end
+
+          # TEMP: Remove any whitespace (" ", not newlines) after an immediate
+          # newline due to:
+          # https://github.com/metanorma/iso-10303-2/issues/71
+          if child_text =~ /\n\ +/
+            child_text = child_text.gsub(/\n\ +/, "\n")
+          end
 
           # # Only taking the first sentence
           # if child_text.contains?(".")

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

@@ -11,8 +11,10 @@ module Stepmod
           if content.strip.empty? || state[:already_strong]
             content
           else
-            handle_express_escape_seq(node,
-                                      "#{content[/^\s*/]}*#{content.strip}*#{content[/\s*$/]}")
+            handle_express_escape_seq(
+              node,
+              "#{content[/^\s*/]}*#{content.strip}*#{content[/\s*$/]}"
+            )
           end
         end
 

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

@@ -6,10 +6,19 @@ module Stepmod
   module Utils
     module Converters
       class Term < ReverseAdoc::Converters::Base
+
+        # We strip all the children in the case for "stem:[d]-manifold"
+        # vs "stem:[d] -manifold"
+        def treat_children(node, state)
+          res = node.children.map { |child| treat(child, state) }
+          res.map(&:strip).reject(&:empty?).join("")
+        end
+
         def convert(node, state = {})
           first_child = node.children.find do |child|
             child.name == "text" && !child.text.to_s.strip.empty?
           end
+
           unless first_child &&
               node.text.split(";").length == 2 &&
               defined?(Stepmod::Utils::Converters::Synonym)
@@ -25,10 +34,10 @@ module Stepmod
         private
 
         def treat_acronym(term_def)
-          return term_def if term_def !~ /.+\(.+?\)$/
+          return term_def.strip if term_def !~ /.+\(.+?\)$/
 
           _, term_text, term_acronym = term_def.match(/(.+?)(\(.+\))$/).to_a
-          "#{term_text}\nalt:[#{term_acronym.gsub(/\(|\)/, '')}]"
+          "#{term_text.strip}\nalt:[#{term_acronym.gsub(/\(|\)/, '')}]"
         end
       end
 

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.3.8".freeze
+    VERSION = "0.3.12".freeze
   end
 end

data/stepmod-utils.gemspec

@@ -34,10 +34,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "concurrent-ruby"
   spec.add_runtime_dependency "glossarist", "~> 0.1.0"
   spec.add_runtime_dependency "ptools"
-  spec.add_runtime_dependency "reverse_adoc", ">= 0.2.9"
+  spec.add_runtime_dependency "reverse_adoc", ">= 0.3.5"
   spec.add_runtime_dependency "thor", ">= 0.20.3"
-  spec.add_development_dependency "byebug", "~> 11.1"
-  spec.add_development_dependency "rubocop", "1.12"
+  spec.add_development_dependency "rubocop"
   spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "rubocop-rails"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.12
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.9
+        version: 0.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.9
+        version: 0.3.5
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -80,34 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.20.3
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -236,7 +222,7 @@ homepage: https://github.com/metanorma/stepmod-utils
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -251,8 +237,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Stepmod-utils is a toolkit that works on STEPmod data.
 test_files: []