stepmod-utils 0.3.21 → 0.3.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d50ed47ffc263b007aa9f2bda3bf5535d9cf84dbc56f1fc87c63d4255ed3f02
-  data.tar.gz: 3572d73a116953f337ac8add7bb47133f33ab3244daa6f3ee58e9901f26cb5f1
+  metadata.gz: 96740d6528de476007a4f312fa8889887e77a27d4a693924531813188a3cd60b
+  data.tar.gz: 867240182ffe77c721fe7ffa8ee53b77383db9954cffa9c4de723e652ec90780
 SHA512:
-  metadata.gz: 5263394029779a53cca0c8f41171eb5bbc8e2490de14041c4e6ae56f8880a0f4eff49c1235d43d69f0d34501e5ae372a4c77bbfeb459147765fd87f81014d7dd
-  data.tar.gz: 6aab6c46a9023e194fe278cedd353807d070eba8c61949777af13ff63a26d3f652a304575cfc56873b54fd57187347a1321df40d7527905320689664da89991c
+  metadata.gz: 6e5b71123d326d72e7f6f64269238e2c0db08cec4033794a1a104088d8ae3c0b7e9b005b2551bb2541b06d676fb6959120a7bd1aac30c3cc63068e581206d8c3
+  data.tar.gz: 9aba582cd94d7c7b85fd9bc8ad2e718c0bf23f6609a86de46393c55a85bda496fecbe9f8c847fd073a5aa1ca351148917520a490d695769fde21d118428fbe98

data/exe/stepmod-annotate-all

@@ -13,7 +13,7 @@ resource_docs_cache_file = `mktemp`
 # annotate each file
 files = `"#{File.join(__dir__,
                       "stepmod-find-express-files")}" "#{stepmod_dir}"`.strip.split("\n")
-MAX_THREADS = [2, Concurrent.processor_count].max * 2
+MAX_THREADS = 1 #[2, Concurrent.processor_count].max * 2
 MAX_QUEUE_SIZE = MAX_THREADS * 4
 # https://github.com/ruby-concurrency/concurrent-ruby/blob/master/docs-source/thread_pools.md
 pool = Concurrent::ThreadPoolExecutor.new(

data/exe/stepmod-extract-terms

@@ -94,14 +94,22 @@ 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]'
+  '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)
+TEXT_REPLACEMENTS = {
+  ' (see <module_ref linkend="ply_orientation_specification:4_entities:figure:f2"> Figure 2</module_ref>)' => '',
+  ' (see <module_ref linkend="ply_orientation_specification:4_entities:figure:f3"> Figure 3</module_ref>)' => ''
+}
+
+def replace_content(content)
   IMAGE_REPLACEMENTS.each_pair do |k, v|
     content.gsub!(k, v)
   end
+  TEXT_REPLACEMENTS.each_pair do |k, v|
+    content.gsub!(k, v)
+  end
 
   content
 end
@@ -137,7 +145,7 @@ part_resources.each do |(bibdata, current_part_resources)|
   fn = "04x-stepmod-entities-resources-#{bibdata.part}.adoc"
   File.open(fn, "w") do |file|
     # file.puts("== #{part_to_title(bibdata)}\n\n")
-    file.puts(replace_images(current_part_resources.map(&:to_mn_adoc).join("\n")))
+    file.puts(replace_content(current_part_resources.map(&:to_mn_adoc).join("\n")))
   end
   log "INFO: written to: #{fn}"
 end
@@ -181,7 +189,7 @@ end.each do |(bibdata, part_modules_arm, part_modules_mim)|
         n.localizations["en"]
       end
       file.puts("== #{schema_name}\n\n")
-      file.puts(replace_images(concepts.map(&:to_mn_adoc).join("\n")))
+      file.puts(replace_content(concepts.map(&:to_mn_adoc).join("\n")))
     end
   end
 
@@ -214,7 +222,7 @@ log "INFO: written summary file to: 05x-stepmod-entities-modules.adoc"
 
 File.open("041-stepmod-entities-resources.adoc", "w") do |file|
   file.puts(
-    replace_images(
+    replace_content(
       resource_concepts.to_a.map do |n|
         n.localizations["en"]
       end.map(&:to_mn_adoc).join("\n")

data/lib/stepmod/utils/concept.rb

@@ -17,7 +17,7 @@ module Stepmod
           converted_definition = Stepmod::Utils::StepmodDefinitionConverter.convert(
             definition_xml,
             {
-              # We don't want examples and notes
+              # We don't want examples, notes, figures and tables
               no_notes_examples: true,
               reference_anchor: reference_anchor,
             },
@@ -87,7 +87,7 @@ module Stepmod
             .convert(
               Nokogiri::XML(wrapper).root,
               {
-                # We don't want examples and notes
+                # We don't want examples, notes, figures and tables
                 no_notes_examples: true,
                 reference_anchor: reference_anchor,
               },

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require_relative "./figure"
+
+module Stepmod
+  module Utils
+    module Converters
+      class ExpressFigure < Stepmod::Utils::Converters::Figure
+
+        # def self.pattern(state, id)
+        #   "figure-exp-#{id}"
+        # end
+
+        def convert(node, state = {})
+          <<~TEMPLATE
+            (*"#{state[:schema_and_entity]}.__figure"
+            #{super(node, state.merge(no_notes_examples: nil)).strip}
+            *)
+          TEMPLATE
+        end
+      end
+
+      ReverseAdoc::Converters.register :express_figure, ExpressFigure.new
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require_relative "./table"
+
+module Stepmod
+  module Utils
+    module Converters
+      class ExpressTable < Stepmod::Utils::Converters::Table
+
+        # def self.pattern(id)
+        #   "table-exp-#{id}"
+        # end
+
+        def convert(node, state = {})
+          <<~TEMPLATE
+            (*"#{state[:schema_and_entity]}.__table"
+            #{super(node, state.merge(no_notes_examples: nil)).strip}
+            *)
+          TEMPLATE
+        end
+      end
+
+      ReverseAdoc::Converters.register :express_table, ExpressTable.new
+    end
+  end
+end

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

@@ -6,13 +6,31 @@ module Stepmod
   module Utils
     module Converters
       class Figure < ReverseAdoc::Converters::Figure
+
+        def self.pattern(state, id)
+          if state[:schema_and_entity].nil?
+            raise StandardError.new("[figure]: no state given, #{id}")
+          end
+
+          schema = state[:schema_and_entity].split(".").first
+          "figure-#{schema}-#{id}"
+        end
+
         def convert(node, state = {})
           # If we want to skip this node
           return "" if state[:no_notes_examples]
 
-          super
+          # Set ID to "figure-id" in case of conflicts
+          node['id'] = if node['id']
+            self.class.pattern(state, node['id'])
+          else
+            self.class.pattern(state, node['number'])
+          end
+
+          super(node, state)
         end
       end
+
       # This replaces the converter
       ReverseAdoc::Converters.register :figure, Figure.new
     end

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

@@ -5,31 +5,69 @@ module Stepmod
     module Converters
       class ModuleRef < ReverseAdoc::Converters::Base
         def convert(node, _state = {})
-          ref = node["linkend"]
-          # #23:
-          # In this case when we see this:
+          link_end = node["linkend"].to_s.split(":")
+          ref_id = link_end.last
+          parts = link_end.last.split(".")
+          text = node.text.gsub(/\s/, " ").squeeze(" ").strip
+          schema = link_end.first
 
-          # <module_ref linkend="product_as_individual:3_definition">individual products</module_ref>
-          # We take the text value of the element and convert to this:
+          if _state[:schema_and_entity].nil?
+            # puts "[module_ref] setting node state #{link_end.inspect}"
+            _state[:schema_and_entity] = schema
+          end
+
+          result = case link_end[1]
+          when "1_scope", "introduction"
+            # When we see this:
+            # <module_ref linkend="functional_usage_view:1_scope">Functional usage view</module_ref>
+            # <module_ref linkend="part_definition_relationship:introduction"> Part definition relationship</module_ref>
+            # We convert into:
+            # <<express:functional_usage_view>>
+            # <<express:part_definition_relationship>>
+
+            "<<express:#{schema}>>"
+
+          when "3_definition"
+            # #23:
+            # When we see this:
+            # <module_ref linkend="product_as_individual:3_definition">individual products</module_ref>
+            # We convert to this:
+            # {{individual products}}
 
-          # {{individual products}}
+            "{{#{text}}}"
 
-          ref = node.text.strip
-          if !ref.empty?
-            " {{#{normalized_ref(ref)}}} "
-          elsif
-            ref = node["linkend"].split(":").first
-            " *#{ref}* "
+          when "4_types"
+            # When we see this:
+            # <module_ref linkend="activity_method_assignment:4_types">activity_method_item</module_ref>
+            # We convert to this:
+            # <<express:activity_method_assignment.activity_method_item>>
+            "<<express:#{[schema, text].join('.')},#{text}>>"
+          when "4_entities", "f_usage_guide"
+            case link_end[2]
+            when "figure"
+              # When we see this:
+              # <module_ref linkend="assembly_module_design:4_entities:figure:pudv">Figure 1</module_ref>
+              # We convert to this:
+              # <<figure-pudv,Figure 1>>
+              "<<#{Figure.pattern(_state,ref_id)},#{text}>>"
+            when "table"
+              # When we see this:
+              # <module_ref linkend="independent_property_definition:4_entities:table:T1">Table 1</module_ref>
+              # We convert to this:
+              # <<table-T1,Table 1>>
+              "<<#{Table.pattern(_state,ref_id)},#{text}>>"
+            end
+          else
+            puts "[module_ref]: encountered unknown <module_ref> tag, #{link_end.join(":")}"
+            raise StandardError.new("[module_ref]: encountered unknown <module_ref> tag, #{link_end.join(":")}")
           end
+
+          # puts "[module_ref] #{result}"
+          result
         end
 
         private
 
-        def normalized_ref(ref)
-          return unless ref || ref.empty?
-
-          ref.squeeze(" ").strip
-        end
       end
       ReverseAdoc::Converters.register :module_ref, ModuleRef.new
     end

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

@@ -1,10 +1,52 @@
+
+require "stepmod/utils/converters/figure"
+require "stepmod/utils/converters/table"
+
 module Stepmod
   module Utils
     module Converters
       class ModuleRefExpressDescription < ReverseAdoc::Converters::Base
         def convert(node, _state = {})
-          parts = node["linkend"].to_s.split(":").last.split(".")
-          "<<express:#{parts.join('.').strip},#{parts.last.strip}>>"
+          link_end = node["linkend"].to_s.split(":")
+          ref_id = link_end.last
+          parts = link_end.last.split(".")
+          text = node.text.gsub(/\s/, " ").squeeze(" ").strip
+
+          # puts "linkend #{node["linkend"]}"
+
+          result = case link_end[1]
+          when "1_scope", "introduction"
+            # When we see this:
+            # <module_ref linkend="functional_usage_view:1_scope">Functional usage view</module_ref>
+            # <module_ref linkend="part_definition_relationship:introduction"> Part definition relationship</module_ref>
+            # We convert into:
+            # <<express:functional_usage_view>>
+            # <<express:part_definition_relationship>>
+
+            "<<express:#{link_end.first}>>"
+
+          when "3_definition"
+            # #23:
+            # When we see this:
+            # <module_ref linkend="product_as_individual:3_definition">individual products</module_ref>
+            # We convert to this:
+            # {{individual products}}
+
+            "{{#{text}}}"
+
+          when "4_types"
+            # ISO 10303-2 does not contain TYPEs, ignore
+            ""
+          when "4_entities", "f_usage_guide"
+            # ISO 10303-2 does not contain figures and tables, ignore
+            ""
+          else
+            puts "[module_ref_express_description]: encountered unknown <module_ref> tag, #{link_end.join(":")}"
+            raise StandardError.new("[module_ref_express_description]: encountered unknown <module_ref> tag, #{link_end.join(":")}")
+          end
+
+          # puts "[module_ref] #{result}"
+          result
         end
       end
       ReverseAdoc::Converters.register :module_ref,

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

@@ -4,9 +4,22 @@ module Stepmod
   module Utils
     module Converters
       class Table < ReverseAdoc::Converters::Base
+
+        def self.pattern(state, id)
+          if state[:schema_and_entity].nil?
+            raise StandardError.new("[table]: no state given, #{id}")
+          end
+
+          schema = state[:schema_and_entity].split(".").first
+          "table-#{schema}-#{id}"
+        end
+
         def convert(node, state = {})
+          # If we want to skip this node
+          return "" if state[:no_notes_examples]
+
           id = node["id"]
-          anchor = id ? "[[#{id}]]\n" : ""
+          anchor = id ? "[[table-#{self.class.pattern(state, id)}]]\n" : ""
           title = node["caption"].to_s
           title = ".#{title}\n" unless title.empty?
           attrs = style(node)

data/lib/stepmod/utils/smrl_description_converter.rb

@@ -15,6 +15,7 @@ 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/module_ref_express_description"
 require "stepmod/utils/converters/note"
 require "stepmod/utils/converters/p"
 require "stepmod/utils/converters/pass_through"

data/lib/stepmod/utils/smrl_resource_converter.rb

@@ -15,6 +15,7 @@ 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/figure"
 require "stepmod/utils/converters/fund_cons"
 require "stepmod/utils/converters/eqn"
 require "stepmod/utils/converters/head"
@@ -25,6 +26,7 @@ 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/module_ref"
 require "stepmod/utils/converters/q"
 require "stepmod/utils/converters/resource"
 require "stepmod/utils/converters/schema_diag"
@@ -36,7 +38,6 @@ 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"

data/lib/stepmod/utils/stepmod_definition_converter.rb

@@ -17,6 +17,7 @@ require "stepmod/utils/converters/term"
 require "stepmod/utils/converters/synonym"
 require "stepmod/utils/converters/uof"
 require "stepmod/utils/converters/figure"
+require "stepmod/utils/converters/table"
 require "stepmod/utils/cleaner"
 
 require "reverse_adoc/converters/a"

data/lib/stepmod/utils/stepmod_file_annotator.rb

@@ -3,6 +3,8 @@ require "stepmod/utils/smrl_description_converter"
 require "stepmod/utils/smrl_resource_converter"
 require "stepmod/utils/converters/express_note"
 require "stepmod/utils/converters/express_example"
+require "stepmod/utils/converters/express_figure"
+require "stepmod/utils/converters/express_table"
 
 module Stepmod
   module Utils
@@ -59,6 +61,9 @@ module Stepmod
         end
 
         output_express
+      rescue StandardError => e
+        puts "[ERROR]!!! #{e.message}"
+        puts e.backtrace
       end
 
       private
@@ -68,16 +73,28 @@ module Stepmod
           wrapper = "<ext_descriptions>#{description}</ext_descriptions>"
           notes = description.xpath("note")
           examples = description.xpath("example")
+          figures = description.xpath("figure")
+          tables = description.xpath("table")
 
           converted_description = <<~DESCRIPTION
 
             #{Stepmod::Utils::SmrlDescriptionConverter.convert(wrapper, no_notes_examples: true)}
           DESCRIPTION
 
-          converted_examples = examples.map do |example|
-            Stepmod::Utils::Converters::ExpressExample
+          if description["linkend"].nil?
+            raise StandardError.new("[stepmod-file-annotator] ERROR: no linkend for #{descriptions_file}!")
+          end
+
+          converted_figures = figures.map do |figure|
+            Stepmod::Utils::Converters::ExpressFigure
               .new
-              .convert(example, schema_and_entity: description["linkend"])
+              .convert(figure, schema_and_entity: description["linkend"])
+          end.join
+
+          converted_tables = tables.map do |table|
+            Stepmod::Utils::Converters::ExpressTable
+              .new
+              .convert(table, schema_and_entity: description["linkend"])
           end.join
 
           converted_notes = notes.map do |note|
@@ -86,20 +103,39 @@ module Stepmod
               .convert(note, schema_and_entity: description["linkend"])
           end.join
 
-          "#{converted_description}#{converted_examples}#{converted_notes}"
+          converted_examples = examples.map do |example|
+            Stepmod::Utils::Converters::ExpressExample
+              .new
+              .convert(example, schema_and_entity: description["linkend"])
+          end.join
+
+          [
+            converted_description,
+            converted_figures,
+            converted_tables,
+            converted_examples,
+            converted_notes,
+          ].join("")
         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)
+        # 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}</resource>"
-          "\n#{Stepmod::Utils::SmrlResourceConverter.convert(wrapper, no_notes_examples: true)}"
+
+          "\n" + Stepmod::Utils::SmrlResourceConverter.convert(
+            wrapper,
+            {
+              no_notes_examples: false,
+              schema_and_entity: linked
+            }
+          )
         end
       end
     end

data/lib/stepmod/utils/terms_extractor.rb

@@ -476,44 +476,36 @@ module Stepmod
         entity_id.downcase.gsub(/_/, " ")
       end
 
+      # No longer used
+      # def entity_ref(entity_id)
+      #   if entity_id == entity_name_to_text(entity_id)
+      #     "{{#{entity_id}}}"
+      #   else
+      #     "{{#{entity_id},#{entity_name_to_text(entity_id)}}}"
+      #   end
+      # end
+
       # rubocop:disable Layout/LineLength
       def generate_entity_definition(entity, domain, old_definition)
         return "" if entity.nil?
 
         # See: metanorma/iso-10303-2#90
-        # TODO: This is not DRY in case we have to further customize
-        entity_text = if domain_type = domain.match(/\A(application object):/)
-
-          entity_ref = if entity.id == entity_name_to_text(entity.id)
-            "{{#{entity.id}}}"
-          else
-            "{{#{entity.id},#{entity_name_to_text(entity.id)}}}"
-          end
-
-          if entity.subtype_of.size.zero?
-            "#{domain_type[1]} that represents the " + entity_ref + " entity"
-          else
-            entity_subtypes = entity.subtype_of.map do |e|
-              "{{#{e.id},#{entity_name_to_text(e.id)}}}"
-            end
-            "#{domain_type[1]} that is a type of " +
-            "#{entity_subtypes.join(' and ')} that represents the " +
-            entity_ref + " entity"
-          end
-
+        entity_type = if domain_type = domain.match(/\A(application object):/)
+          "{{#{domain_type[1]}}}"
         else
+          "{{entity data type}}"
+        end
 
-          # Not "application object"
-          if entity.subtype_of.size.zero?
-            "entity data type that represents the {{#{entity.id}}} entity"
-          else
-            entity_subtypes = entity.subtype_of.map do |e|
-              "{{#{e.id}}}"
-            end
-            "entity data type that is a type of " +
-            "#{entity_subtypes.join(' and ')} that represents the " +
-            "{{#{entity.id}}} entity"
+        entity_text = if entity.subtype_of.size.zero?
+          "#{entity_type} " +
+          "that represents the " + entity_name_to_text(entity.id) + " {{entity}}"
+        else
+          entity_subtypes = entity.subtype_of.map do |e|
+            "{{#{e.id}}}"
           end
+          "#{entity_type} that is a type of " +
+          "#{entity_subtypes.join(' and ')} " +
+          "that represents the " + entity_name_to_text(entity.id) + " {{entity}}"
         end
 
         definition = <<~DEFINITION

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.3.21".freeze
+    VERSION = "0.3.23".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.21
+  version: 0.3.23
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-12 00:00:00.000000000 Z
+date: 2022-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -207,10 +207,12 @@ files:
 - lib/stepmod/utils/converters/eqn.rb
 - lib/stepmod/utils/converters/example.rb
 - lib/stepmod/utils/converters/express_example.rb
+- lib/stepmod/utils/converters/express_figure.rb
 - lib/stepmod/utils/converters/express_g.rb
 - lib/stepmod/utils/converters/express_note.rb
 - lib/stepmod/utils/converters/express_ref.rb
 - lib/stepmod/utils/converters/express_ref_express_description.rb
+- lib/stepmod/utils/converters/express_table.rb
 - lib/stepmod/utils/converters/ext_description.rb
 - lib/stepmod/utils/converters/ext_descriptions.rb
 - lib/stepmod/utils/converters/figure.rb