stepmod-utils 0.3.4 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 887612180cfe004fb244d41e7c553858ed441d5e4c60c8d27d06fb7ec3219cd2
-  data.tar.gz: f7f25caa5652593b6eafcb792206614f2b053e56a0dd05801018e2217533b636
+  metadata.gz: 8838f07a6b887ff87b6067b7a82b02e605bfc97c81ed345642b68c9d8d4e6a5b
+  data.tar.gz: 213824aa6f2b832d941d6575005f7c43c60f5332a1c285f973efa05d52090b86
 SHA512:
-  metadata.gz: 41057b14b1c6ab326dff8e402be3a74737e9479212a76577a9ef81738da9f542ab6cbd892723949b004a2a6ff6058525aed5de47b1fbe3859ac139a724028608
-  data.tar.gz: 519d9daa5451c17f60e6e2e764405908bf7e3c9f6b7279dcef9ee2bb554c63a0535b1e63c3aaed178549413a2253e24a3687c86d1ad60c8fa569c65aed756647
+  metadata.gz: '088fe0671024dd6e5fb69960c379d52e25345546ba5f87b8167d37e26fd8315074ba7b7028757d610a1c18fffe560485cc65937157cad72a32445dfef836a415'
+  data.tar.gz: 176cde1360b6f3a229c05eb50fe606892d106101dab6e3e7c1aafb15467602d9650107151a58eb9f3ac56a2f93411ccd3131e749a3974c247f6c4cdc76f5e414

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,12 +12,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/terms_extractor'
+require "bundler/setup"
+require "stepmod/utils/terms_extractor"
 
 stepmod_dir = ARGV.first || Dir.pwd
 
@@ -31,7 +33,7 @@ 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
@@ -39,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
@@ -51,37 +53,59 @@ def part_to_title(bibdata)
   end
 end
 
-def log message
+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]'
+}
+
+def replace_images(content)
+  IMAGE_REPLACEMENTS.each_pair do |k, v|
+    content.gsub!(k, v)
+  end
+
+  content
+end
+
+def log(message)
   puts "[stepmod-utils] #{message}"
 end
 
 part_concepts.each do |(bibdata, current_part_concepts)|
+  current_part_concepts = current_part_concepts.to_a.map do |n|
+    n.localizations["en"]
+  end
   fn = "03x-stepmod-#{bibdata.part}.adoc"
-  File.open(fn, 'w') { |file|
+  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"))
-  }
+    file.puts(replace_images(current_part_concepts.map(&:to_mn_adoc).join("\n")))
+  end
   log "INFO: written to: #{fn}"
 end
 
-
 part_resources.each do |(bibdata, current_part_resources)|
+  current_part_resources = current_part_resources.to_a.map do |n|
+    n.localizations["en"]
+  end
   fn = "04x-stepmod-entities-resources-#{bibdata.part}.adoc"
-  File.open(fn, 'w') { |file|
+  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"))
-  }
+    file.puts(replace_images(current_part_resources.map(&:to_mn_adoc).join("\n")))
+  end
   log "INFO: written to: #{fn}"
 end
 
-
 part_modules.each do |(bibdata, part_modules_arm, part_modules_mim)|
   fn = "05x-stepmod-entities-modules-#{bibdata.part}.adoc"
-  File.open(fn, 'w') { |file|
+  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
+      concepts = part_modules_arm.first.last.to_a.map do |n|
+        n.localizations["en"]
+      end
 
       # puts "SCHEMA NAME ARM: #{schema_name}"
       file.puts("== #{schema_name}\n\n")
@@ -94,26 +118,40 @@ part_modules.each do |(bibdata, part_modules_arm, part_modules_mim)|
       schema_name = part_modules_mim.first.first
 
       # puts "SCHEMA NAME MIM: #{schema_name}"
-      concepts = part_modules_mim.first.last
+      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"))
+      file.puts(replace_images(concepts.map(&:to_mn_adoc).join("\n")))
     end
-
-  }
+  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("031-stepmod-general.adoc", "w") do |file|
+  file.puts(
+    replace_images(
+      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('041-stepmod-entities-resources.adoc', 'w') { |file|
-  file.puts(resource_concepts.map(&:to_mn_adoc).join("\n"))
-}
+File.open("041-stepmod-entities-resources.adoc", "w") do |file|
+  file.puts(
+    replace_images(
+      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') { |file|
+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

data/lib/stepmod/utils/bibdata.rb

@@ -1,8 +1,6 @@
 module Stepmod
   module Utils
-
     class Bibdata
-
       DOCNUMBER = 10303
 
       attr_accessor *%w(
@@ -15,23 +13,25 @@ module Stepmod
         # module, resource, application_protocol, business_object_model
         @type = document.name
 
-        raise 'UnknownFileError' unless %w(module resource application_protocol business_object_model).include?(@type)
+        raise "UnknownFileError" unless %w(module resource
+                                           application_protocol business_object_model).include?(@type)
 
-        @doctype = document['status']
-        @part = document['part']
-        @title_en = document['title'] ||
-          document['name'].gsub('_', ' ').capitalize.gsub('2d','2D').gsub('3d','3D')
-        @title_fr = document['name.french']
-        @version = document['version']
-        @language = document['language']
+        @doctype = document["status"]
+        @part = document["part"]
+        @title_en = document["title"] ||
+          document["name"].gsub("_", " ").capitalize.gsub("2d", "2D").gsub("3d",
+                                                                           "3D")
+        @title_fr = document["name.french"]
+        @version = document["version"]
+        @language = document["language"]
 
         # Some publication.year contains month...
-        @pub_year = document['publication.year'].split('-').first
-        @pub_date = document['publication.date']
+        @pub_year = document["publication.year"].split("-").first
+        @pub_date = document["publication.date"]
 
         # puts to_mn_adoc
 
-        return self
+        self
         # <module
         #    name="security_classification"
         #    name.french="Classification des s&#233;curit&#233;s"
@@ -54,28 +54,27 @@ module Stepmod
         #    rcs.revision="$Revision: 1.26 $"
         #   development.folder="dvlp"
         # >
-
       end
 
       def docid
         no_date = case doctype
-        when "IS"
-          "ISO #{DOCNUMBER}-#{part}"
-        when "WD"
-          "ISO/WD #{DOCNUMBER}-#{part}"
-        when "CD"
-          "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"
-          "ISO/CD TS #{DOCNUMBER}-#{part}"
-        else
-          "UNKNOWN DOCTYPE: (#{doctype})"
-        end
+                  when "IS"
+                    "ISO #{DOCNUMBER}-#{part}"
+                  when "WD"
+                    "ISO/WD #{DOCNUMBER}-#{part}"
+                  when "CD"
+                    "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"
+                    "ISO/CD TS #{DOCNUMBER}-#{part}"
+                  else
+                    "UNKNOWN DOCTYPE: (#{doctype})"
+                  end
 
         if pub_year
           "#{no_date}:#{pub_year}"
@@ -106,7 +105,7 @@ module Stepmod
       end
 
       def anchor
-        docid.gsub('/', '-').gsub(' ', '_').gsub(':', '_')
+        docid.gsub("/", "-").gsub(" ", "_").gsub(":", "_")
       end
 
       def to_mn_adoc
@@ -116,9 +115,6 @@ module Stepmod
           "* [[[#{anchor},#{docid}]]]"
         end
       end
-
     end
-
   end
 end
-

data/lib/stepmod/utils/cleaner.rb

@@ -1,11 +1,11 @@
-require 'reverse_adoc/cleaner'
+require "reverse_adoc/cleaner"
 
 module Stepmod
   module Utils
     class Cleaner < ReverseAdoc::Cleaner
       def tidy(string)
-        super.gsub(/^ +/, '')
+        super.gsub(/^ +/, "")
       end
     end
   end
-end
+end