stepmod-utils 0.3.2 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcb84433f081424b5227cdb8c9c6b7d7342d31089e176f8f333817c4533c721d
-  data.tar.gz: 82fee2a54cc8d818587c2c9b08e955d1328497f05362307f528b968f1a576f61
+  metadata.gz: 6201c720f31faffdd6646d74a3c150733f3219bd756d9ba9743e5a27c1db4495
+  data.tar.gz: b1bafce759e91f5923d030fe0b5b0f74f2b719a832d53ac300db6b38e3e221d0
 SHA512:
-  metadata.gz: 4840fc050b58a4eda03c0c7106d7af524c7d3f863d5a40907facf6e6393ddf26d60a00852478df1ccadc2568b20616139251bb5fd4f4fcdb37296a8bfc5a94cb
-  data.tar.gz: f3a7b2d85581e1f5db195bef23b28422a82dd8588b66c66df2147700ccebc6b15c96b3b2b696cfb0435e2a6cdedf02579b542bd1af77efd6c1afd608a61593ca
+  metadata.gz: 206becea0d17c930418426618aa5234e420a4aba77e63a9448890245dd637ca044ad5540073e509ca8d672a701bc31b1b9576ad671f21a0da7f620f917c83b68
+  data.tar.gz: 4f564a4b188082f6a20e41bb424c50950a2efce588fd1c48adaceb3a1068c7b4d5fa2388c758491f1d8814cceaefaee8f842337ae57d49873cb4e2bcb43933b1

data/.github/workflows/rake.yml

@@ -16,19 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
     steps:
       - uses: actions/checkout@v2
         with:

data/.github/workflows/release.yml

@@ -9,7 +9,7 @@ on:
         description: |
           Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
         required: true
-        default: 'patch'
+        default: 'skip'
   push:
     tags: [ v* ]
 
@@ -22,21 +22,23 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: '2.6'
+          bundler-cache: true
 
       - run: gem install gem-release
 
-      - if: ${{ github.event_name == 'workflow_dispatch' }}
-        run: |
+      - 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
+
+      - if: github.event_name == 'workflow_dispatch' && github.event.inputs.next_version != 'skip'
+        run: gem bump --version ${{ github.event.inputs.next_version }} --tag --push
 
       - name: publish to rubygems.org
         env:
           RUBYGEMS_API_KEY: ${{secrets.METANORMA_CI_RUBYGEMS_API_KEY}}
         run: |
           gem install gem-release
-          cat > ~/.gem/credentials << EOF
+          envsubst << 'EOF' > ~/.gem/credentials
           ---
           :rubygems_api_key: ${RUBYGEMS_API_KEY}
           EOF

data/.hound.yml

@@ -0,0 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  TargetRubyVersion: 2.5

data/Gemfile

@@ -3,9 +3,9 @@
 source "https://rubygems.org"
 
 gemspec
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
+gem "concurrent-ruby", "~> 1.1"
+gem "pry"
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
-gem "pry"
-gem "concurrent-ruby", "~> 1.1"

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/exe/stepmod-annotate-all

@@ -1,32 +1,38 @@
 #!/usr/bin/env ruby
 
-require 'concurrent'
-require 'stepmod/utils/stepmod_file_annotator'
+require "concurrent"
+require "stepmod/utils/stepmod_file_annotator"
 
 stepmod_dir = ARGV.first || Dir.pwd
 
 # build resource_docs cache
 resource_docs_cache_file = `mktemp`
-`"#{File.join(__dir__, 'stepmod-build-resource-docs-cache')}" "#{stepmod_dir}" > "#{resource_docs_cache_file}"`
+`"#{File.join(__dir__,
+              "stepmod-build-resource-docs-cache")}" "#{stepmod_dir}" > "#{resource_docs_cache_file}"`
 
 # annotate each file
-files = `"#{File.join(__dir__, 'stepmod-find-express-files')}" "#{stepmod_dir}"`.strip.split("\n")
+files = `"#{File.join(__dir__,
+                      "stepmod-find-express-files")}" "#{stepmod_dir}"`.strip.split("\n")
 MAX_THREADS = [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(
-  :min_threads => MAX_THREADS,
-  :max_threads => MAX_THREADS,
-  :max_queue   => MAX_QUEUE_SIZE,
-  :fallback_policy => :caller_runs
+  min_threads: MAX_THREADS,
+  max_threads: MAX_THREADS,
+  max_queue: MAX_QUEUE_SIZE,
+  fallback_policy: :caller_runs,
 )
 files.each_slice(MAX_QUEUE_SIZE) do |batch|
   puts("Queueing next batch")
   batch.each do |file|
     pool.post do
       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|
+      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("#{Thread.current.object_id}: Done processing #{file}")
@@ -36,4 +42,4 @@ files.each_slice(MAX_QUEUE_SIZE) do |batch|
 end
 
 # cleanup
-`rm "#{resource_docs_cache_file}"`
+`rm "#{resource_docs_cache_file}"`

data/exe/stepmod-build-resource-docs-cache

@@ -1,19 +1,20 @@
 #!/usr/bin/env ruby
 
-require 'nokogiri'
-require 'json'
+require "nokogiri"
+require "json"
 
 stepmod_dir = ARGV.first || Dir.pwd
 
 schemas = {}
-Dir.glob(File.join(stepmod_dir, 'data/resource_docs/*/resource.xml')).each do |resource_docs_file|
-  match = resource_docs_file.match('data/resource_docs/([^/]+)/resource.xml')
+Dir.glob(File.join(stepmod_dir,
+                   "data/resource_docs/*/resource.xml")).each do |resource_docs_file|
+  match = resource_docs_file.match("data/resource_docs/([^/]+)/resource.xml")
   resource_docs_dir = match.captures[0]
 
   resource_docs = Nokogiri::XML(File.read(resource_docs_file)).root
-  resource_docs.xpath('schema').each do |schema|
-    schemas[schema['name']] = resource_docs_dir
+  resource_docs.xpath("schema").each do |schema|
+    schemas[schema["name"]] = resource_docs_dir
   end
 end
 
-puts JSON.pretty_generate(schemas)
+puts JSON.pretty_generate(schemas)

data/exe/stepmod-convert-express-description

@@ -11,12 +11,14 @@ $:.unshift File.expand_path("../../lib", bin_file)
 # Fixes https://github.com/rubygems/rubygems/issues/1420
 require "rubygems/specification"
 
-class Gem::Specification
-  def this; self; end
+module Gem
+  class Specification
+    def this; self; end
+  end
 end
 
-require 'bundler/setup'
-require 'stepmod/utils/smrl_description_converter'
+require "bundler/setup"
+require "stepmod/utils/smrl_description_converter"
 
 ReverseAdoc.config.unknown_tags = :bypass
 

data/exe/stepmod-convert-express-resource

@@ -11,12 +11,14 @@ $:.unshift File.expand_path("../../lib", bin_file)
 # Fixes https://github.com/rubygems/rubygems/issues/1420
 require "rubygems/specification"
 
-class Gem::Specification
-  def this; self; end
+module Gem
+  class Specification
+    def this; self; end
+  end
 end
 
-require 'bundler/setup'
-require 'stepmod/utils/smrl_resource_converter'
+require "bundler/setup"
+require "stepmod/utils/smrl_resource_converter"
 
 ReverseAdoc.config.unknown_tags = :bypass
 

data/exe/stepmod-extract-terms

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # encoding: UTF-8
 
-require 'pry'
+require "pry"
 # resolve bin path, ignoring symlinks
 require "pathname"
 bin_file = Pathname.new(__FILE__).realpath
@@ -12,48 +12,28 @@ $:.unshift File.expand_path("../../lib", bin_file)
 # Fixes https://github.com/rubygems/rubygems/issues/1420
 require "rubygems/specification"
 
-class Gem::Specification
-  def this; self; end
+module Gem
+  class Specification
+    def this; self; end
+  end
 end
 
-require 'bundler/setup'
-require 'stepmod/utils/stepmod_definition_converter'
-require 'stepmod/utils/bibdata'
-require 'stepmod/utils/concept'
-require 'ptools'
-
-ReverseAdoc.config.unknown_tags = :bypass
-
-# 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 = {}
+require "bundler/setup"
+require "stepmod/utils/terms_extractor"
 
 stepmod_dir = ARGV.first || Dir.pwd
 
-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
+general_concepts,
+resource_concepts,
+parsed_bibliography,
+part_concepts,
+part_resources,
+part_modules = Stepmod::Utils::TermsExtractor.call(stepmod_dir)
 
 def part_to_title(bibdata)
   case bibdata.part.to_i
   when 41
-    "Part 41"
+    "Fundamentals of product description and support"
   when 42
     "Geometric and topological representation"
   when 43
@@ -61,7 +41,7 @@ def part_to_title(bibdata)
   when 44
     "Product structure, concept and configuration"
   when 45
-    "Part 45"
+    "Material and other engineering properties"
   when 46
     "Visual presentation"
   when 47
@@ -73,227 +53,80 @@ def part_to_title(bibdata)
   end
 end
 
-stepmod_path = Pathname.new(stepmod_dir).realpath
-
-# If we are using the stepmod CVS repository, provide the revision number per file
-has_cvs = File.which("cvs")
-cvs_mode = has_cvs && Dir.exists?(stepmod_path.join('CVS'))
-
-log "INFO: STEPmod directory set to #{stepmod_dir}."
-
-if cvs_mode
-  log "INFO: STEPmod directory is a CVS repository and will detect revisions."
-  log "INFO: [CVS] Detecting file revisions can be slow, please be patient!"
-else
-  log "INFO: STEPmod directory is not a CVS repository, skipping revision detection."
+def log(message)
+  puts "[stepmod-utils] #{message}"
 end
 
-log "INFO: Detecting paths..."
-
-files = %w(
-  resource.xml
-  application_protocol.xml
-  business_object_model.xml
-  module.xml
-  ).inject([]) do |acc, 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)
-
-  log "INFO: Processing XML file #{fpath}"
-  current_document = Nokogiri::XML(File.read(file_path)).root
-
-  bibdata = nil
-  begin
-    bibdata = Stepmod::Utils::Bibdata.new(document: current_document)
-  rescue
-    log "WARNING: Unknown file #{fpath}, skipped"
-    next
+part_concepts.each do |(bibdata, current_part_concepts)|
+  current_part_concepts = current_part_concepts.to_a.map do |n|
+    n.localizations["en"]
   end
-
-  unless ACCEPTED_STAGES.include? bibdata.doctype
-    log "INFO: skipped #{bibdata.docid} as it is not one of (#{ACCEPTED_STAGES.join(", ")})."
-    next
+  fn = "03x-stepmod-#{bibdata.part}.adoc"
+  File.open(fn, "w") do |file|
+    file.puts("== #{part_to_title(bibdata)}\n\n")
+    file.puts(current_part_concepts.map(&:to_mn_adoc).join("\n"))
   end
+  log "INFO: written to: #{fn}"
+end
 
-  if bibdata.part.to_s.empty?
-    log "FATAL: missing `part` attribute: #{fpath}"
-    log "INFO: skipped #{bibdata.docid} as it is missing `part` attribute."
-    next
+part_resources.each do |(bibdata, current_part_resources)|
+  current_part_resources = current_part_resources.to_a.map do |n|
+    n.localizations["en"]
   end
-
-  revision_string = "\n// CVS: revision not detected"
-  if cvs_mode
-    # Run `cvs status` to find out version
-
-    log "INFO: Detecting CVS revision..."
-    Dir.chdir(stepmod_path) do
-      status = `cvs status #{fpath}`
-
-      unless status.empty?
-        working_rev = status.split(/\n/).grep(/Working revision:/).first.match(/revision:\s+(.+)$/)[1]
-        repo_rev = status.split(/\n/).grep(/Repository revision:/).first.match(/revision:\t(.+)\t/)[1]
-        log "INFO: CVS working rev (#{working_rev}), repo rev (#{repo_rev})"
-        revision_string = "\n// CVS working rev: (#{working_rev}), repo rev (#{repo_rev})\n" +
-          "// CVS: revision #{working_rev == repo_rev ? 'up to date' : 'differs'}"
-      end
-    end
+  fn = "04x-stepmod-entities-resources-#{bibdata.part}.adoc"
+  File.open(fn, "w") do |file|
+    file.puts("== #{part_to_title(bibdata)}\n\n")
+    file.puts(current_part_resources.map(&:to_mn_adoc).join("\n"))
   end
+  log "INFO: written to: #{fn}"
+end
 
-  # read definitions
-  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]
-        log "FATAL: Duplicated term with id: #{term_id}, #{fpath}"
+part_modules.each do |(bibdata, part_modules_arm, part_modules_mim)|
+  fn = "05x-stepmod-entities-modules-#{bibdata.part}.adoc"
+  File.open(fn, "w") do |file|
+    file.puts("")
+    unless part_modules_arm.empty?
+      schema_name = part_modules_arm.first.first
+      concepts = part_modules_arm.first.last.to_a.map do |n|
+        n.localizations["en"]
       end
-      encountered_terms[term_id] = true
-    end
 
-    # Assume that definition is located in clause 3 of the ISO document
-    # in order. We really don't have a good reference here.
-    ref_clause = "3.#{index}"
-
-    concept = Stepmod::Utils::Concept.parse(
-      definition,
-      reference_anchor: bibdata.anchor,
-      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
-
-    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
+      # puts "SCHEMA NAME ARM: #{schema_name}"
+      file.puts("== #{schema_name}\n\n")
+      file.puts(concepts.map(&:to_mn_adoc).join("\n"))
     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
+    file.puts("")
 
-        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
+    unless part_modules_mim.empty?
+      schema_name = part_modules_mim.first.first
 
-        parsed_bibliography << bibdata
+      # puts "SCHEMA NAME MIM: #{schema_name}"
+      concepts = part_modules_mim.first.last.to_a.map do |n|
+        n.localizations["en"]
       end
+      file.puts("== #{schema_name}\n\n")
+      file.puts(concepts.map(&:to_mn_adoc).join("\n"))
     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
-
+  log "INFO: written to: #{fn}"
 end
 
-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('051-stepmod-entities-modules.adoc', 'w') { |file|
-  file.puts(module_concepts.map(&:to_mn_adoc).join("\n"))
-}
-
+File.open("031-stepmod-general.adoc", "w") do |file|
+  file.puts(general_concepts.to_a.map do |n|
+              n.localizations["en"]
+            end.map(&:to_mn_adoc).join("\n"))
+end
 log "INFO: written to: 031-stepmod-general.adoc"
 
-File.open('991-generated-bibliography.adoc', 'w') { |file|
-  file.puts(parsed_bibliography.map(&:to_mn_adoc).sort.uniq.join("\n"))
-}
+File.open("041-stepmod-entities-resources.adoc", "w") do |file|
+  file.puts(resource_concepts.to_a.map do |n|
+              n.localizations["en"]
+            end.map(&:to_mn_adoc).join("\n"))
+end
+log "INFO: written to: 041-stepmod-entities-resources.adoc"
 
+File.open("991-generated-bibliography.adoc", "w") do |file|
+  file.puts(parsed_bibliography.map(&:to_mn_adoc).sort.uniq.join("\n"))
+end
 log "INFO: written to: 991-generated-bibliography.adoc"

data/exe/stepmod-find-express-files

@@ -1,23 +1,24 @@
 #!/usr/bin/env ruby
 
-require 'nokogiri'
+require "nokogiri"
 
 stepmod_dir = ARGV.first || Dir.pwd
 
-index = Nokogiri::XML(File.read(File.join(stepmod_dir, 'repository_index.xml'))).root
+index = Nokogiri::XML(File.read(File.join(stepmod_dir,
+                                          "repository_index.xml"))).root
 
 files = []
-index.xpath('modules/module').each do |item|
+index.xpath("modules/module").each do |item|
   files << "#{stepmod_dir}/data/modules/#{item['name']}/arm.exp"
   files << "#{stepmod_dir}/data/modules/#{item['name']}/mim.exp"
 end
-index.xpath('resources/resource').each do |item|
+index.xpath("resources/resource").each do |item|
   files << "#{stepmod_dir}/data/resources/#{item['name']}/#{item['name']}.exp"
 end
-index.xpath('business_object_models/business_object_model').each do |item|
+index.xpath("business_object_models/business_object_model").each do |item|
   files << "#{stepmod_dir}/data/business_object_models/#{item['name']}/bom.exp"
   files << "#{stepmod_dir}/data/business_object_models/#{item['name']}/DomainModel.exp"
 end
 
-existing_files = files.filter{|file| File.exists?(file)}
-puts existing_files
+existing_files = files.filter { |file| File.exists?(file) }
+puts existing_files