stepmod-utils 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe9caf0ee63e637eb1a73289d7394a495b5f8a313c6ee3d69aff2bdcc150e57f
-  data.tar.gz: 791c199203956d117839a900869fd61362ead66703f6723cd4b5c0c8d871ccc4
+  metadata.gz: 1006db3b3828bc38932f36a4f410cf6f8a0d5669bf0c3357c7a204c84e587a44
+  data.tar.gz: 7fa819c6ee34eef23ad8ab20fd3a833296a36bf99ca48cb624a81a04049871ff
 SHA512:
-  metadata.gz: 1910feb532333a698daa864f4387ccefdbcdeb6ccbcf3a962d3e7ec5dfa0a0c0f17643e8eba22ed625aa2a308595b0c30ea7d49ce5bed2de0a8c638cb1e2e00d
-  data.tar.gz: 19757106a503652a64052eb823750bb5a618750b68bf42abdc3833dde6be9d3345dbc80c5051d37cea2507fe07c87b0669cf3af60c66cf6579ace1cd02f9bf96
+  metadata.gz: 40f09784e7aeac5e8e35c24079e84c5119dc9cd00f9555a4c24c1ce389e4b28bb32e0f6ec8c4408b3a1fea0445cfa16ca3700a263517b28c935c9ddca7de8cbb
+  data.tar.gz: dd35cce57f836527e31a6bd36576f6966494f558d1a0cc87486632c3149b1eecf66f37493f188f0a1ff685b804ddedb33bc13c1c6d45e5142335710ea7dea88c

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 FDIS 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]
@@ -127,24 +171,107 @@ files.each do |file_path|
       file_path: fpath + revision_string
     )
 
-    parsed_terms << 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
+
+    max_encountered_refs_indexes[bibdata.anchor] = index + 1
     parsed_bibliography << bibdata
   end
 
+  current_document.xpath('//arm').each do |arm_node|
+    index = max_encountered_refs_indexes[bibdata.anchor] || 1
+
+    concept = Stepmod::Utils::Concept.parse(
+      arm_node,
+      reference_anchor: bibdata.anchor,
+      reference_clause: nil,
+      file_path: fpath + revision_string
+    )
+
+    module_concepts << 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
+
+    max_encountered_refs_indexes[bibdata.anchor] = index + 1
+    parsed_bibliography << bibdata
+  end
+
+  current_document.xpath('//schema').each do |schema_node|
+    Dir["#{stepmod_dir}/**/#{schema_node['name']}/descriptions.xml"].each do |description|
+      description_document = Nokogiri::XML(File.read(description)).root
+      description_document.xpath('//ext_description').each do |ext_description|
+        index = max_encountered_refs_indexes[bibdata.anchor] || 1
+
+        concept = Stepmod::Utils::Concept.parse(
+          ext_description,
+          reference_anchor: bibdata.anchor,
+          reference_clause: nil,
+          file_path: fpath + revision_string
+        )
+
+        resource_concepts << 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
+
+        max_encountered_refs_indexes[bibdata.anchor] = index + 1
+        parsed_bibliography << bibdata
+      end
+    end
+  end
+
   log "INFO: Completed processing XML file #{fpath}"
 
+  if part_concepts.length == 0
+    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
+
 end
 
-parsed_bibliography
+File.open('031-stepmod-general.adoc', 'w') { |file|
+  file.puts(general_concepts.map(&:to_mn_adoc).join("\n"))
+}
+
+File.open('04-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('05-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).uniq.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,18 @@ 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 })
+        if definition_xml.name == 'arm' || 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 +45,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/stepmod_ext_description.rb

@@ -0,0 +1,17 @@
+module Stepmod
+  module Utils
+    module Converters
+      class StepmodExtDescription < ReverseAdoc::Converters::Base
+        def convert(node, state = {})
+          state = state.merge(schema_name: node['linkend'])
+          <<~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'

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.2.7"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-04 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