stepmod-utils 0.2.5 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d3544c6e6b2eca6cab5ab08050b9985b80f62d597604d6961cbb388a712160a
-  data.tar.gz: 6afde6fbd52b996a37a6d8bc88607adf97b760c0835d7eae5cee849a8911d8cb
+  metadata.gz: fcb84433f081424b5227cdb8c9c6b7d7342d31089e176f8f333817c4533c721d
+  data.tar.gz: 82fee2a54cc8d818587c2c9b08e955d1328497f05362307f528b968f1a576f61
 SHA512:
-  metadata.gz: c5631d5e7587e4d26d62425f623433147ad372f4f53ebc5d9f2e0c1414d0b84599b6655d242028fbc4df872637b2db2a23df31b905ddd48136a9add7de4d0a9b
-  data.tar.gz: d48868104b0fd44e74ec8459f9d45e1ed51b835b749bc3986c185c376d798ecb28da0d2a1813ebeb9faacc9e1432a0117adaa5101ade901e965424a101903bcc
+  metadata.gz: 4840fc050b58a4eda03c0c7106d7af524c7d3f863d5a40907facf6e6393ddf26d60a00852478df1ccadc2568b20616139251bb5fd4f4fcdb37296a8bfc5a94cb
+  data.tar.gz: f3a7b2d85581e1f5db195bef23b28422a82dd8588b66c66df2147700ccebc6b15c96b3b2b696cfb0435e2a6cdedf02579b542bd1af77efd6c1afd608a61593ca

data/exe/stepmod-extract-terms

@@ -24,7 +24,12 @@ require 'ptools'
 
 ReverseAdoc.config.unknown_tags = :bypass
 
-parsed_terms = []
+# TODO: we may want a command line option to override this in the future
+ACCEPTED_STAGES = %w(IS DIS FDIS TS)
+
+general_concepts = []
+resource_concepts = []
+module_concepts = []
 parsed_bibliography = []
 encountered_terms = {}
 
@@ -34,6 +39,40 @@ def log message
   puts "[stepmod-utils] #{message}"
 end
 
+def term_special_category(bibdata)
+  case bibdata.part.to_i
+  when 41,42,43,44,45,46,47,51
+    true
+  when [56..112]
+    true
+  else
+    false
+  end
+end
+
+def part_to_title(bibdata)
+  case bibdata.part.to_i
+  when 41
+    "Part 41"
+  when 42
+    "Geometric and topological representation"
+  when 43
+    "Foundation representation"
+  when 44
+    "Product structure, concept and configuration"
+  when 45
+    "Part 45"
+  when 46
+    "Visual presentation"
+  when 47
+    "Shape tolerance"
+  when 51
+    "Mathematical representation"
+  else
+    bibdata.title_en
+  end
+end
+
 stepmod_path = Pathname.new(stepmod_dir).realpath
 
 # If we are using the stepmod CVS repository, provide the revision number per file
@@ -57,9 +96,14 @@ files = %w(
   business_object_model.xml
   module.xml
   ).inject([]) do |acc, t|
-    acc << Dir["#{stepmod_dir}/**/#{t}"]
+
+    candidate_paths = Dir["#{stepmod_dir}/**/#{t}"]
+    acc << candidate_paths
+
 end.flatten.sort.uniq
 
+max_encountered_refs_indexes = {}
+
 files.each do |file_path|
   file_path = Pathname.new(file_path).realpath
   fpath = file_path.relative_path_from(stepmod_path)
@@ -75,9 +119,8 @@ files.each do |file_path|
     next
   end
 
-  # TODO: we may want a command line option to override this in the future
-  unless %w(IS DIS TS).include? bibdata.doctype
-    log "INFO: skipped #{bibdata.docid} as it is not IS, DIS or TS"
+  unless ACCEPTED_STAGES.include? bibdata.doctype
+    log "INFO: skipped #{bibdata.docid} as it is not one of (#{ACCEPTED_STAGES.join(", ")})."
     next
   end
 
@@ -106,8 +149,9 @@ files.each do |file_path|
   end
 
   # read definitions
-  current_document.xpath('//definition').each.with_index(1) do |definition, index|
-
+  part_concepts = []
+  current_document.xpath('//definition').each do |definition|
+    index = max_encountered_refs_indexes[bibdata.anchor] || 1
     term_id = definition['id']
     unless term_id.nil?
       if encountered_terms[term_id]
@@ -126,25 +170,130 @@ files.each do |file_path|
       reference_clause: ref_clause,
       file_path: fpath + revision_string
     )
+    next unless concept
+
+    unless term_special_category(bibdata)
+      # log "INFO: this part is generic"
+      general_concepts << concept
+    else
+      # log "INFO: this part is special"
+      part_concepts << concept
+    end
 
-    parsed_terms << concept
+    max_encountered_refs_indexes[bibdata.anchor] = index + 1
     parsed_bibliography << bibdata
   end
 
+  part_modules = []
+  current_document.xpath('//arm/uof').each do |uof_node|
+    concept = Stepmod::Utils::Concept.parse(
+      uof_node,
+      reference_anchor: bibdata.anchor,
+      reference_clause: nil,
+      file_path: fpath + revision_string
+    )
+    # puts concept.inspect
+
+    next unless concept
+
+    unless term_special_category(bibdata)
+      # log "INFO: this part is generic"
+      module_concepts << concept
+    else
+      # log "INFO: this part is special"
+      part_modules << concept
+    end
+
+    parsed_bibliography << bibdata
+  end
+
+  part_resources = []
+  # Assumption: every schema is only linked by a single resource_docs document.
+  current_document.xpath('//schema').each do |schema_node|
+    schema_name = schema_node['name']
+
+    Dir["#{stepmod_path}/*/#{schema_name}/descriptions.xml"].each do |description_xml_path|
+      log "INFO: Processing resources schema #{description_xml_path}"
+      description_document = Nokogiri::XML(File.read(description_xml_path)).root
+      description_document.xpath('//ext_description').each do |ext_description|
+
+        concept = Stepmod::Utils::Concept.parse(
+          ext_description,
+          reference_anchor: bibdata.anchor,
+          reference_clause: nil,
+          file_path: fpath + revision_string
+        )
+        next unless concept
+
+        unless term_special_category(bibdata)
+          # log "INFO: this part is generic"
+          resource_concepts << concept
+        else
+          # log "INFO: this part is special"
+          part_resources << concept
+        end
+
+        parsed_bibliography << bibdata
+      end
+    end
+  end
+
   log "INFO: Completed processing XML file #{fpath}"
 
+  if part_concepts.empty?
+    log "INFO: Skipping #{fpath} (#{bibdata.docid}) because it contains no concepts."
+    next
+  elsif part_concepts.length < 3
+    log "INFO: Skipping #{fpath} (#{bibdata.docid}) because it only has #{part_concepts.length} terms."
+
+    part_concepts.each do |x|
+      general_concepts << x
+    end
+  else
+    fn = "03x-stepmod-#{bibdata.part}.adoc"
+    File.open(fn, 'w') { |file|
+      file.puts("== #{part_to_title(bibdata)}\n\n")
+      file.puts(part_concepts.map(&:to_mn_adoc).join("\n"))
+    }
+    log "INFO: written to: #{fn}"
+  end
+
+  unless part_resources.empty?
+    fn = "04x-stepmod-entities-resources-#{bibdata.part}.adoc"
+    File.open(fn, 'w') { |file|
+      file.puts("== #{part_to_title(bibdata)}\n\n")
+      file.puts(part_resources.map(&:to_mn_adoc).join("\n"))
+    }
+    log "INFO: written to: #{fn}"
+  end
+
+  unless part_modules.empty?
+    fn = "04x-stepmod-entities-modules-#{bibdata.part}.adoc"
+    File.open(fn, 'w') { |file|
+      file.puts("== #{part_to_title(bibdata)}\n\n")
+      file.puts(part_modules.map(&:to_mn_adoc).join("\n"))
+    }
+    log "INFO: written to: #{fn}"
+  end
+
 end
 
-parsed_bibliography.uniq!
+File.open('031-stepmod-general.adoc', 'w') { |file|
+  file.puts(general_concepts.map(&:to_mn_adoc).join("\n"))
+}
+
+File.open('041-stepmod-entities-resources.adoc', 'w') { |file|
+  file.puts(resource_concepts.map(&:to_mn_adoc).join("\n"))
+}
 
-File.open('031-generated-terms.adoc', 'w') { |file|
-  file.puts(parsed_terms.map(&:to_mn_adoc).join("\n"))
+File.open('051-stepmod-entities-modules.adoc', 'w') { |file|
+  file.puts(module_concepts.map(&:to_mn_adoc).join("\n"))
 }
 
-log "INFO: written to: 031-generated-terms.adoc"
+log "INFO: written to: 031-stepmod-general.adoc"
 
 File.open('991-generated-bibliography.adoc', 'w') { |file|
-  file.puts(parsed_bibliography.map(&:to_mn_adoc).join("\n"))
+  file.puts(parsed_bibliography.map(&:to_mn_adoc).sort.uniq.join("\n"))
 }
 
 log "INFO: written to: 991-generated-bibliography.adoc"

data/lib/stepmod/utils/bibdata.rb

@@ -67,6 +67,8 @@ module Stepmod
           "ISO/CD #{DOCNUMBER}-#{part}"
         when "DIS"
           "ISO/DIS #{DOCNUMBER}-#{part}"
+        when "FDIS"
+          "ISO/FDIS #{DOCNUMBER}-#{part}"
         when "TS"
           "ISO/TS #{DOCNUMBER}-#{part}"
         when "CD-TS"

data/lib/stepmod/utils/concept.rb

@@ -21,8 +21,21 @@ module Stepmod
       end
 
       def self.parse(definition_xml, reference_anchor:, reference_clause:, file_path:)
+        converted_definition = Stepmod::Utils::StepmodDefinitionConverter
+                                  .convert(definition_xml, { reference_anchor: reference_anchor })
+
+        return nil if converted_definition.nil? || converted_definition.strip.empty?
+
+        if definition_xml.name == 'uof' || definition_xml.name == 'ext_description'
+          converted_definition = <<~TEXT
+            #{converted_definition.split("\n")[0..3].join("\n")}
+
+            NOTE: This term is incompletely defined in this document.
+            Reference <<#{reference_anchor}>> for the complete definition.
+          TEXT
+        end
         new(
-          converted_definition: Stepmod::Utils::StepmodDefinitionConverter.convert(definition_xml),
+          converted_definition: converted_definition,
           reference_anchor: reference_anchor,
           reference_clause: reference_clause,
           file_path: file_path
@@ -35,7 +48,7 @@ module Stepmod
           #{converted_definition}
 
           [.source]
-          <<#{reference_anchor},clause=#{reference_clause}>>
+          <<#{reference_anchor}#{reference_clause ? ",clause=" + reference_clause : ""}>>
 
         TEXT
       end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Stepmod
+  module Utils
+    module Converters
+      class Arm < ReverseAdoc::Converters::Base
+        def convert(node, state = {})
+          treat_children(node, state)
+        end
+
+        private
+
+        def treat_children(node, state)
+          res = node.children.map { |child| treat(child, state) }
+          res.map(&:strip).reject(&:empty?).join("\n\n")
+        end
+      end
+
+      ReverseAdoc::Converters.register :arm, Arm.new
+    end
+  end
+end

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

@@ -71,6 +71,7 @@ module Stepmod
       end
 
       ReverseAdoc::Converters.register :def, Def.new
+      ReverseAdoc::Converters.register :description, Def.new
     end
   end
 end

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

@@ -20,8 +20,8 @@ module Stepmod
           image_document = Nokogiri::XML(File.read(file))
           svg_path = File.basename(image_document.xpath('//img').first['src'], '.*')
           <<~SVGMAP
-            *)
 
+            *)
             (*"#{state.fetch(:schema_name)}.__expressg"
             [.svgmap]
             ====

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

@@ -6,8 +6,8 @@ module Stepmod
       class FundCons < ReverseAdoc::Converters::Base
         def convert(node, state = {})
           <<~TEXT
-            *)
 
+            *)
             (*"#{state.fetch(:schema_name)}.__fund_cons"
 
             #{treat_children(node, state).strip}

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

@@ -0,0 +1,22 @@
+module Stepmod
+  module Utils
+    module Converters
+      class StepmodExtDescription < ReverseAdoc::Converters::Base
+        def convert(node, state = {})
+          state = state.merge(schema_name: node['linkend'])
+          linkend = node['linkend'].split('.')
+
+          # We ignore all the WHERE and IP rules because those are not terms
+          return nil if linkend.last =~ /^wr/
+
+          <<~TEMPLATE
+            === #{node['linkend'].split('.').last}
+
+            <STEP resource> #{treat_children(node, state).strip}
+          TEMPLATE
+        end
+      end
+      ReverseAdoc::Converters.register :ext_description, StepmodExtDescription.new
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'stepmod/utils/converters/synonym'
+
+module Stepmod
+  module Utils
+    module Converters
+      class Uof < ReverseAdoc::Converters::Base
+        def convert(node, state = {})
+          <<~TEXT
+          === #{node['name'].strip}
+
+          <STEP module> #{treat_children(node, state).strip}
+          TEXT
+        end
+      end
+
+      ReverseAdoc::Converters.register :uof, Uof.new
+    end
+  end
+end

data/lib/stepmod/utils/stepmod_definition_converter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'reverse_adoc'
+require 'stepmod/utils/converters/arm'
 require 'stepmod/utils/converters/clause_ref'
 require 'stepmod/utils/converters/express_ref'
 require 'stepmod/utils/converters/module_ref'
@@ -11,8 +12,10 @@ require 'stepmod/utils/converters/example'
 require 'stepmod/utils/converters/note'
 require 'stepmod/utils/converters/ol'
 require 'stepmod/utils/converters/stem'
+require 'stepmod/utils/converters/stepmod_ext_description'
 require 'stepmod/utils/converters/term'
 require 'stepmod/utils/converters/synonym'
+require 'stepmod/utils/converters/uof'
 
 require 'reverse_adoc/converters/a'
 require 'reverse_adoc/converters/blockquote'
@@ -37,19 +40,21 @@ module Stepmod
   module Utils
     class StepmodDefinitionConverter
       def self.convert(input, options = {})
-        root = if input.is_a?(String)
-                  then Nokogiri::XML(input).root
-                elsif input.is_a?(Nokogiri::XML::Document)
-                  then input.root
-                elsif input.is_a?(Nokogiri::XML::Node)
-                  then input
-                end
+        root = case input
+               when String
+                 Nokogiri::XML(input).root
+               when Nokogiri::XML::Document
+                 input.root
+               when Nokogiri::XML::Node
+                 input
+               end
 
-        root || (return '')
+        return '' unless root
 
         ReverseAdoc.config.with(options) do
           result = ReverseAdoc::Converters.lookup(root.name).convert(root)
-          ReverseAdoc.cleaner.tidy(result)
+          return '' unless result
+          ReverseAdoc.cleaner.tidy(result.dup)
         end
       end
     end

data/lib/stepmod/utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-03 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -117,6 +117,7 @@ files:
 - lib/stepmod/utils/cleaner.rb
 - lib/stepmod/utils/concept.rb
 - lib/stepmod/utils/converters/a.rb
+- lib/stepmod/utils/converters/arm.rb
 - lib/stepmod/utils/converters/blockquote.rb
 - lib/stepmod/utils/converters/br.rb
 - lib/stepmod/utils/converters/bypass.rb
@@ -153,6 +154,7 @@ files:
 - lib/stepmod/utils/converters/schema.rb
 - lib/stepmod/utils/converters/schema_diag.rb
 - lib/stepmod/utils/converters/stem.rb
+- lib/stepmod/utils/converters/stepmod_ext_description.rb
 - lib/stepmod/utils/converters/strong.rb
 - lib/stepmod/utils/converters/sub.rb
 - lib/stepmod/utils/converters/sup.rb
@@ -160,6 +162,7 @@ files:
 - lib/stepmod/utils/converters/table.rb
 - lib/stepmod/utils/converters/term.rb
 - lib/stepmod/utils/converters/text.rb
+- lib/stepmod/utils/converters/uof.rb
 - lib/stepmod/utils/html_to_asciimath.rb
 - lib/stepmod/utils/smrl_description_converter.rb
 - lib/stepmod/utils/smrl_resource_converter.rb
@@ -188,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Stepmod-utils is a toolkit that works on STEPmod data.