stepmod-utils 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 880200eb71c0f0fea4fd506d07736dfa24a8097c576ad9d114ae31bbc643b761
-  data.tar.gz: b722f8e73182c0d2e7a333711b6b0d63c9bee6a9bd4c8f8bd4ad35c76fb34c59
+  metadata.gz: 7d3544c6e6b2eca6cab5ab08050b9985b80f62d597604d6961cbb388a712160a
+  data.tar.gz: 6afde6fbd52b996a37a6d8bc88607adf97b760c0835d7eae5cee849a8911d8cb
 SHA512:
-  metadata.gz: 83e7020b06805b67cef6181534b2c77554a0320b8d7ef53e31795214f6d03dc0f9b300269f2a88c4d167072597c879b217c338a3d11564ed2ae737ffe2c9c89f
-  data.tar.gz: 4ac53f1c23a263c9078461570ba315be2d20f90229fbe109c4cc15d9d806cab6524daed10ee89de0dd85d194c2c27d0598fec0ec58893dc00c1ceb57fc14e755
+  metadata.gz: c5631d5e7587e4d26d62425f623433147ad372f4f53ebc5d9f2e0c1414d0b84599b6655d242028fbc4df872637b2db2a23df31b905ddd48136a9add7de4d0a9b
+  data.tar.gz: d48868104b0fd44e74ec8459f9d45e1ed51b835b749bc3986c185c376d798ecb28da0d2a1813ebeb9faacc9e1432a0117adaa5101ade901e965424a101903bcc

data/.github/workflows/rake.yml

@@ -30,7 +30,9 @@ jobs:
             os: 'macos-latest'
             experimental: true
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - uses: ruby/setup-ruby@v1
         with:
@@ -38,14 +40,3 @@ jobs:
           bundler-cache: true
 
       - run: bundle exec rake
-
-  tests-passed:
-    needs: rake
-    runs-on: ubuntu-latest
-    steps:
-      - uses: peter-evans/repository-dispatch@v1
-        with:
-          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
-          repository: ${{ github.repository }}
-          event-type: notify
-          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.github/workflows/release.yml

@@ -1,3 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 name: release
 
 on:
@@ -8,6 +10,8 @@ on:
           Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
         required: true
         default: 'patch'
+  push:
+    tags: [ v* ]
 
 jobs:
   release:
@@ -19,9 +23,10 @@ jobs:
         with:
           ruby-version: '2.6'
 
-      - run: gem install gem-release    
+      - run: gem install gem-release
 
-      - run: |
+      - if: ${{ github.event_name == 'workflow_dispatch' }}
+        run: |
           git config user.name github-actions
           git config user.email github-actions@github.com
           gem bump --version ${{ github.event.inputs.next_version }} --tag --push

data/Makefile

@@ -1,2 +1,5 @@
 convert_stepmod_repo:
-	bundle exec ./exe/stepmod-annotate-all ../iso-10303-stepmod
+	bundle exec ./exe/stepmod-annotate-all $(10303_stepmod_path)
+
+create_svgs:
+	java -jar $(stepmod2mn_jar_path) $(10303_stepmod_path) -svg

data/exe/stepmod-annotate-all

@@ -24,12 +24,12 @@ files.each_slice(MAX_QUEUE_SIZE) do |batch|
   puts("Queueing next batch")
   batch.each do |file|
     pool.post do
-      puts("Queued processing #{file}")
+      puts("#{Thread.current.object_id}: Queued processing #{file}")
       annotated = Stepmod::Utils::StepmodFileAnnotator.new(express_file: file, resource_docs_cache_file: resource_docs_cache_file, stepmod_dir: stepmod_dir).call
       File.open(File.join(File.dirname(file), "#{File.basename(file, '.exp')}_annotated.exp"), 'w') do |file|
         file.puts(annotated)
       end
-      puts("Done processing #{file}")
+      puts("#{Thread.current.object_id}: Done processing #{file}")
     end
   end
   pool.shutdown

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

@@ -44,7 +44,7 @@ module Stepmod
           first_strong_node.next.content = first_strong_node.next.content.gsub(/\s?:/, '')
           term = first_strong_node.text.strip
           first_strong_node.remove
-          "#{term}:: #{treat_children(cloned_node, state)}"
+          "\n\n#{term}:: #{remove_trash_symbols(treat_children(cloned_node, state))}\n"
         end
 
         def stem_converted(cloned_node, state)
@@ -69,6 +69,7 @@ module Stepmod
             .strip
             .gsub(/\(\d\)$/, '')
             .gsub(/\b(\w*?[_]+\w+)\b/, '"\1"')
+            .gsub(/([^\s])\s+_{/, '\1_{')
             .strip
         end
 
@@ -79,14 +80,14 @@ module Stepmod
           TAGS_NOT_IN_CONTEXT.each do |tag_name|
             node
               .children
-              .xpath("./#{tag_name}")
-              .map do |n|
-                n.tap{ |n| n.add_previous_sibling(n.children) }.remove
+              .each do |n|
+                remove_tags_not_in_context(n) if n.children.length > 0
+                next if n.name != tag_name
+
+                n.add_previous_sibling(n.children)
+                n.unlink
               end
           end
-          node.traverse do |descendant|
-            descendant.content = descendant.content.gsub('#8195;', '')
-          end
         end
       end
 

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

@@ -8,18 +8,21 @@ module Stepmod
           node.children.map do |child|
             next unless child.name == 'imgfile'
 
-            parse_to_svg_reference(child['file'])
+            parse_to_svg_reference(child['file'], state)
           end.join("\n")
         end
 
         private
 
-        def parse_to_svg_reference(file)
+        def parse_to_svg_reference(file, state)
           return '' unless File.file?(file)
 
           image_document = Nokogiri::XML(File.read(file))
           svg_path = File.basename(image_document.xpath('//img').first['src'], '.*')
           <<~SVGMAP
+            *)
+
+            (*"#{state.fetch(:schema_name)}.__expressg"
             [.svgmap]
             ====
             image::#{svg_path}.svg[]

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

@@ -3,6 +3,7 @@ module Stepmod
     module Converters
       class ExtDescription < ReverseAdoc::Converters::Base
         def convert(node, state = {})
+          state = state.merge(schema_name: node['linkend'])
           <<~TEMPLATE
             (*"#{node['linkend']}"
             #{treat_children(node, state).strip}

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

@@ -5,7 +5,13 @@ module Stepmod
     module Converters
       class FundCons < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          "\n\n== Fundamental concerns\n\n#{treat_children(node, state).strip}\n\n"
+          <<~TEXT
+            *)
+
+            (*"#{state.fetch(:schema_name)}.__fund_cons"
+
+            #{treat_children(node, state).strip}
+          TEXT
         end
       end
 

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

@@ -5,7 +5,7 @@ module Stepmod
     module Converters
       class Introduction < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          "\n\n== Introduction\n\n#{treat_children(node, state).strip}\n\n"
+          treat_children(node, state)
         end
       end
 

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

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

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

@@ -5,6 +5,7 @@ module Stepmod
     module Converters
       class Schema < ReverseAdoc::Converters::Base
         def convert(node, state = {})
+          state = state.merge(schema_name: node['name'])
           <<~TEMPLATE
             (*"#{node['name']}"
             #{treat_children(node, state).strip}

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

@@ -4,13 +4,33 @@ module Stepmod
   module Utils
     module Converters
       class Strong < ReverseAdoc::Converters::Base
+        BLANK_CHARS = "{blank}".freeze
+
         def convert(node, state = {})
           content = treat_children(node, state.merge(already_strong: true))
           if content.strip.empty? || state[:already_strong]
             content
           else
-            "#{content[/^\s*/]}*#{content.strip}*#{content[/\s*$/]}"
+            handle_express_escape_seq(node, "#{content[/^\s*/]}*#{content.strip}*#{content[/\s*$/]}")
+          end
+        end
+
+        private
+
+        def handle_express_escape_seq(node, content)
+          res = content
+          if braces_sibling?(node.previous, true)
+            res = "#{BLANK_CHARS}#{res}"
+          end
+          if braces_sibling?(node.next)
+            res = "#{res}#{BLANK_CHARS}"
           end
+          res
+        end
+
+        def braces_sibling?(sibling, end_of_text = false)
+          match = end_of_text ? /\($/ : /^\)/
+          sibling && sibling.text? && sibling.text =~ match
         end
       end
 

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

@@ -6,8 +6,16 @@ module Stepmod
       class Sub < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           content = treat_children(node, state)
+          return stem_notation(content) if node.parent.name == 'eqn'
+
           "#{content[/^\s*/]}~#{content.strip}~#{content[/\s*$/]}"
         end
+
+        private
+
+        def stem_notation(content)
+          "_{#{content}}"
+        end
       end
 
       ReverseAdoc::Converters.register :sub, Sub.new

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

@@ -6,8 +6,14 @@ module Stepmod
       class Sup < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           content = treat_children(node, state)
+          return stem_notation(content) if node.parent.name == 'eqn'
+
           "#{content[/^\s*/]}^#{content.strip}^#{content[/\s*$/]}"
         end
+
+        def stem_notation(content)
+          "^{#{content}}"
+        end
       end
 
       ReverseAdoc::Converters.register :sup, Sup.new

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Stepmod
+  module Utils
+    module Converters
+      class Table < ReverseAdoc::Converters::Base
+        def convert(node, state = {})
+          id = node['id']
+          anchor = id ? "[[#{id}]]\n" : ""
+          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"
+        end
+
+        def frame(node)
+          case node["frame"]
+          when "void"
+            "frame=none"
+          when "hsides"
+            "frame=topbot"
+          when "vsides"
+            "frame=sides"
+          when "box", "border"
+            "frame=all"
+          else
+            nil
+          end
+        end
+
+        def rules(node)
+          case node["rules"]
+          when "all"
+            "rules=all"
+          when "rows"
+            "rules=rows"
+          when "cols"
+            "rules=cols"
+          when "none"
+            "rules=none"
+          else
+            nil
+          end
+        end
+
+        def style(node)
+          width = "width=#{node['width']}" if node['width']
+          attrs = []
+          frame_attr = frame(node)
+          rules_attr = rules(node)
+          attrs += width if width
+          attrs += frame_attr if frame_attr
+          attrs += rules_attr if rules_attr
+          return "" if attrs.empty?
+          "[#{attrs.join(',')}]\n"
+        end
+      end
+
+      ReverseAdoc::Converters.register :table, Table.new
+    end
+  end
+end

data/lib/stepmod/utils/smrl_resource_converter.rb

@@ -32,13 +32,13 @@ 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/table'
 require 'reverse_adoc/converters/tr'
 require 'reverse_adoc/converters/td'
 require 'reverse_adoc/converters/th'

data/lib/stepmod/utils/stepmod_file_annotator.rb

@@ -24,31 +24,55 @@ module Stepmod
 
         if File.exists?(descriptions_file)
           descriptions = Nokogiri::XML(File.read(descriptions_file)).root
+          added_resource_descriptions = {}
           descriptions.xpath('ext_description').each do |description|
-            unless description.text.strip.empty? then
-              Dir.chdir(File.dirname(descriptions_file)) do
-                wrapper = "<ext_descriptions>#{description.to_s}</ext_descriptions>"
-                output_express << "\n" + Stepmod::Utils::SmrlDescriptionConverter.convert(wrapper)
-              end
-            else
-              # remark is empty, fallback to resource_docs_cache
-              resource_docs_dir = resource_docs_cache[description['linkend']]
-              if resource_docs_dir
-                resource_docs_file = File.join(stepmod_dir, 'data/resource_docs', resource_docs_dir, 'resource.xml')
-                resource_docs = Nokogiri::XML(File.read(resource_docs_file)).root
-                schema = resource_docs.xpath("schema[@name='#{description['linkend']}']")
-
-                Dir.chdir(File.dirname(descriptions_file)) do
-                  wrapper = "<resource>#{schema.to_s}</resource>"
-                  output_express << "\n" + Stepmod::Utils::SmrlResourceConverter.convert(wrapper)
-                end
+            # Add base resource from linked path if exists, eg "language_schema.language.wr:WR1" -> "language_schema"
+            base_linked = description['linkend'].to_s.split('.').first
+            if added_resource_descriptions[base_linked].nil?
+              base_reource_doc_dir = resource_docs_cache[description['linkend'].to_s.split('.').first]
+              if base_reource_doc_dir
+                output_express << convert_from_resource_file(base_reource_doc_dir, stepmod_dir, base_linked, descriptions_file)
               end
+              added_resource_descriptions[base_linked] = true
+            end
+            resource_docs_dir = resource_docs_cache[description['linkend']]
+            # Convert content description
+            # when a schema description is available from resource.xml and also descriptions.xml, the description from resource.xml is only used.
+            # https://github.com/metanorma/annotated-express/issues/32#issuecomment-792609078
+            if description.text.strip.length.positive? && resource_docs_dir.nil?
+              output_express << convert_from_description_text(descriptions_file, description)
+            end
+            # Add converted description from exact linked path
+            if resource_docs_dir && added_resource_descriptions[description['linkend']].nil?
+              output_express << convert_from_resource_file(resource_docs_dir, stepmod_dir, description['linkend'], descriptions_file)
+              added_resource_descriptions[description['linkend']] = true
             end
           end
         end
 
         output_express
       end
+
+      private
+
+      def convert_from_description_text(descriptions_file, description)
+        Dir.chdir(File.dirname(descriptions_file)) do
+          wrapper = "<ext_descriptions>#{description.to_s}</ext_descriptions>"
+          "\n" + Stepmod::Utils::SmrlDescriptionConverter.convert(wrapper)
+        end
+      end
+
+      def convert_from_resource_file(resource_docs_dir, stepmod_dir, linked, descriptions_file)
+        resource_docs_file = File.join(stepmod_dir, 'data/resource_docs', resource_docs_dir, 'resource.xml')
+        puts(resource_docs_file)
+        resource_docs = Nokogiri::XML(File.read(resource_docs_file)).root
+        schema = resource_docs.xpath("schema[@name='#{linked}']")
+
+        Dir.chdir(File.dirname(descriptions_file)) do
+          wrapper = "<resource>#{schema.to_s}</resource>"
+          "\n" + Stepmod::Utils::SmrlResourceConverter.convert(wrapper)
+        end
+      end
     end
   end
 end

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.2.4"
+    VERSION = "0.2.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -82,11 +82,10 @@ dependencies:
         version: '11.1'
 description: 'Stepmod-utils is a toolkit that works on STEPmod data.
 
-'
+  '
 email:
 - open.source@ribose.com
 executables:
-- stepmod-annotate
 - stepmod-annotate-all
 - stepmod-build-resource-docs-cache
 - stepmod-convert-express-description
@@ -107,7 +106,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- exe/stepmod-annotate
 - exe/stepmod-annotate-all
 - exe/stepmod-build-resource-docs-cache
 - exe/stepmod-convert-express-description
@@ -159,6 +157,7 @@ files:
 - lib/stepmod/utils/converters/sub.rb
 - lib/stepmod/utils/converters/sup.rb
 - lib/stepmod/utils/converters/synonym.rb
+- lib/stepmod/utils/converters/table.rb
 - lib/stepmod/utils/converters/term.rb
 - lib/stepmod/utils/converters/text.rb
 - lib/stepmod/utils/html_to_asciimath.rb
@@ -174,7 +173,7 @@ homepage: https://github.com/metanorma/stepmod-utils
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -189,8 +188,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Stepmod-utils is a toolkit that works on STEPmod data.
 test_files: []

data/exe/stepmod-annotate

@@ -1,44 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'json'
-require 'stepmod/utils/smrl_description_converter'
-require 'stepmod/utils/smrl_resource_converter'
-
-express_file = ARGV.shift
-resource_docs_cache_file = ARGV.shift # output of ./stepmod-build-resource-docs-cache
-stepmod_dir = ARGV.first || Dir.pwd
-
-match = File.basename(express_file).match('^(arm|mim|bom)\.exp$')
-descriptions_base = match ? "#{match.captures[0]}_descriptions.xml" : 'descriptions.xml'
-descriptions_file = File.join(File.dirname(express_file), descriptions_base)
-
-output_express = File.read(express_file)
-
-resource_docs_cache = JSON.parse(File.read(resource_docs_cache_file))
-
-if File.exists?(descriptions_file)
-  descriptions = Nokogiri::XML(File.read(descriptions_file)).root
-  descriptions.xpath('ext_description').each do |description|
-    unless description.text.strip.empty? then
-      Dir.chdir(File.dirname(descriptions_file)) do
-        wrapper = "<ext_descriptions>#{description.to_s}</ext_descriptions>"
-        output_express << "\n" + Stepmod::Utils::SmrlDescriptionConverter.convert(wrapper)
-      end
-    else
-      # remark is empty, fallback to resource_docs_cache
-      resource_docs_dir = resource_docs_cache[description['linkend']]
-      if resource_docs_dir
-        resource_docs_file = File.join(stepmod_dir, 'data/resource_docs', resource_docs_dir, 'resource.xml')
-        resource_docs = Nokogiri::XML(File.read(resource_docs_file)).root
-        schema = resource_docs.xpath("schema[@name='#{description['linkend']}']")
-
-        Dir.chdir(File.dirname(descriptions_file)) do
-          wrapper = "<resource>#{schema.to_s}</resource>"
-          output_express << "\n" + Stepmod::Utils::SmrlResourceConverter.convert(wrapper)
-        end
-      end
-    end
-  end
-end
-
-puts output_express