stepmod-utils 0.3.22 → 0.3.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc9977f6a7248164968637abc31b264b928a1b6de459e62a25fc9a95a250ec10
-  data.tar.gz: 030aa9b15094edaa59fbde8ff7948ff7d05dc96b73130495cedcb5f3e52c3b4d
+  metadata.gz: 92d04b3c30620d813fbff40cfa84ed809f0129440dd1f6be45c4206aaa44a12e
+  data.tar.gz: 54289d1067ccba3a61cd0ca07bd5455081efe70aae946811cf8028f6e77afb9a
 SHA512:
-  metadata.gz: dca1f9e90a28a17c3cbc6082fb115a705bafe55871256bd2f9112fbd4879c02335a04767d60e3d6e5aaa3a935bf738b9a003542741587b8b4537c8328fe8c17c
-  data.tar.gz: 625b2542ab86f94f54829e750d8297307dfc47dadf740c3d96d65cff611478d04d1d267eb6b3e71abffebad876bbdfd982f50e09e2081ff1feb505fdd3f20f97
+  metadata.gz: e83145314175c1797f8de0fe08bdbf3ba95e06346b49f80beb3cdadb31d1b2423cb60230d869b91850de3685b0fb6c805a2b4ddebbfd72ff2b55ffde234f4d9f
+  data.tar.gz: 309a341bead6e54225f14101c3bea989f2f7873409c4d8e1fedbc6e8b2144d3e21ed2034c5ebcfd76279d73234a84e8d0d67c86fb77e1e1b715f6f1ba2ad661b

data/.rubocop.yml

@@ -6,5 +6,8 @@ inherit_from:
 # local repo-specific modifications
 # ...
 
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: aligned
+
 AllCops:
   TargetRubyVersion: 2.5

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/exe/stepmod-extract-yaml-terms

@@ -0,0 +1,149 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require "pry"
+# resolve bin path, ignoring symlinks
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+
+# add self to libpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+# Fixes https://github.com/rubygems/rubygems/issues/1420
+require "rubygems/specification"
+
+module Gem
+  class Specification
+    def this; self; end
+  end
+end
+
+require "bundler/setup"
+require_relative "../lib/stepmod/utils/terms_extractor"
+require "optparse"
+
+def log(message)
+  puts "[stepmod-utils] #{message}"
+end
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options]"
+
+  opts.on(
+    "-p",
+    "--path STEPMOD_DATA_PATH",
+    String,
+    "Path to STEPmod data directory",
+  ) do |path|
+    options[:stepmod_dir] = path
+  end
+
+  opts.on(
+    "-i",
+    "--index INDEX_PATH",
+    String,
+    "Path to repository_index.xml",
+  ) do |path|
+    unless path.nil?
+      options[:index_path] = Pathname.new(path).to_s
+    end
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+stepmod_dir = options[:stepmod_dir]
+if stepmod_dir.nil?
+  raise StandardError.new(
+    "STEPmod data path not set, set with the `-p` option.",
+  )
+else
+  log "STEPmod data path: `#{stepmod_dir}`"
+end
+
+default_index_path = File.join(stepmod_dir, "repository_index.xml")
+index_path = options[:index_path] || default_index_path
+if File.exists?(index_path)
+  log "Repository index path: `#{index_path}`"
+else
+  raise StandardError.new(
+    "Index file not present at #{index_path}, set with the `-i` option.",
+  )
+end
+
+_general_concepts,
+resource_concepts,
+_parsed_bibliography,
+_part_concepts,
+part_resources,
+part_modules = Stepmod::Utils::TermsExtractor.call(stepmod_dir, index_path)
+
+def part_to_title(bibdata)
+  {
+    41 => "Fundamentals of product description and support",
+    42 => "Geometric and topological representation",
+    43 => "Foundation representation",
+    44 => "Product structure, concept and configuration",
+    45 => "Material and other engineering properties",
+    46 => "Visual presentation",
+    47 => "Shape tolerance",
+    51 => "Mathematical representation",
+  }[bibdata.part.to_i] || bibdata.title_en
+end
+
+# rubocop:disable Layout/LineLength
+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]",
+}.freeze
+
+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>)' => "",
+}.freeze
+# rubocop:enable Layout/LineLength
+
+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
+
+part_resources.each do |(_bibdata, current_part_resources)|
+  current_part_resources.save_to_files("./")
+end
+log "INFO: part_resources written to yaml files"
+
+
+log "INFO: written summary file to: 04x-stepmod-entities-resources.adoc"
+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)|
+  unless part_modules_arm.empty?
+    part_modules_arm.values.map do |managed_concept|
+      managed_concept.save_to_files("./")
+    end
+  end
+
+  unless part_modules_mim.empty?
+    part_modules_mim.values.map do |managed_concept|
+      managed_concept.save_to_files("./")
+    end
+  end
+end
+log "INFO: part_modules written to yaml files"
+
+resource_concepts.save_to_files("./")
+log "INFO: resource_concepts written to yaml files"

data/lib/stepmod/utils/concept.rb

@@ -8,6 +8,10 @@ module Stepmod
         reference_anchor
         converted_definition
         file_path
+        schema
+        part
+        domain
+        document
       )
 
       # TODO: converted_definition is not supposed to be an attribute, it is
@@ -17,7 +21,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,
             },
@@ -40,8 +44,8 @@ module Stepmod
           # TODO: `designations:` should include the `alt:[...]` terms here,
           # they are now only included in definition_xml_converted_definition.
           new(
-            designations: [designation],
-            definition: definition,
+            designations: designation,
+            definition: [definition],
             converted_definition: converted_definition,
             id: "#{reference_anchor}.#{reference_clause}",
             reference_anchor: reference_anchor,
@@ -65,11 +69,16 @@ module Stepmod
               definition_xml.xpath(".//term").first
             )
 
-          {
-            # [4..-1] because we want to skip the initial `=== {title}`
-            accepted: term[4..-1],
-            alt: alts,
-          }
+          # [4..-1] because we want to skip the initial `=== {title}`
+          designations = [
+            { "designation" => term[4..-1], "type" => "expression", "normative_status" => "preferred" },
+          ]
+
+          alts.each do |alt|
+            designations << { "designation" => alt, "type" => "expression" }
+          end
+
+          designations
         end
 
         def definition_xml_definition(definition_xml, reference_anchor)
@@ -87,7 +96,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,
               },
@@ -95,12 +104,24 @@ module Stepmod
         end
 
         def definition_xml_converted_definition(designation, definition)
-          if designation[:alt].length.positive?
-            alt_notation = "alt:[#{designation[:alt].map(&:strip).join(',')}]"
+          accepted_designation = designation.select do |des|
+            des["normative_status"] == "preferred"
+          end
+
+          alt_designations = designation.reject do |des|
+            des["normative_status"] == "preferred"
+          end
+
+          if alt_designations.length.positive?
+            alt_designations_text = alt_designations.map do |d|
+              d["designation"].strip
+            end.join(",")
+
+            alt_notation = "alt:[#{alt_designations_text}]"
           end
 
           result = <<~TEXT
-            === #{designation[:accepted].strip}
+            === #{accepted_designation.map { |d| d['designation'].strip }.join(',')}
           TEXT
 
           if alt_notation
@@ -117,6 +138,15 @@ module Stepmod
         end
       end
 
+      def to_h
+        super.merge({
+          "domain" => domain,
+          "part" => part,
+          "schema" => schema,
+          "document" => document,
+        }.compact)
+      end
+
       def to_mn_adoc
         <<~TEXT
           // STEPmod path:#{file_path.empty? ? '' : " #{file_path}"}

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)