stepmod-utils 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83672fac3acf9ef0d9a2ab17fffab1204b326c7d41018675c2cc819976ac8b40
-  data.tar.gz: 2a59c155d059ca7b73e48ebf5ddedac314e998dbb92eb301a55c460d8ac44e79
+  metadata.gz: 30293492d1d3224173ac5070db26552c4cb1df8d6d56059e8180a461e85b6fed
+  data.tar.gz: b784155408f9c0cef9ad0c3665bfe5defa35a3458ad5b9ffda75ca0aa612476a
 SHA512:
-  metadata.gz: ca130bac46780aeef8434443d68e02a83cfc2d17a5dd1634c13c6448fd33c1861e85cc3173303db64449e7da3465b1953ed344690894e09cd5698304c4b129eb
-  data.tar.gz: f4d94ac262f4c98ca810a1002c0bdc22d67cc3bd771521f4700e512386f226156d442de3c3f826c0aa7757bbc7d41a78dd42c22b166eca6a032b9b1177511424
+  metadata.gz: adb0dd04f01590a002552dedb5975d07bcb0897c1c2fe443e5d3ff865ab7c7c1ebc774e1414febabd2305c24abef5560ad4f1b24034aeba05fe0f89f956a9c36
+  data.tar.gz: 48dca001c264cc71a3c415ad255f7c7161cebfb4f3cb91990a2b4e538cb72b404d8e12fa3f1f046c65b8538a32cbca0004846ac0f517c3756f47bfaee9a127fa

data/.github/workflows/rake.yml

@@ -0,0 +1,51 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        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@master
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    steps:
+      - uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          event-type: notify
+          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.github/workflows/release.yml

@@ -1,41 +1,39 @@
 name: release
 
 on:
-  push:
-    tags:
-      - '*'
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'patch'
 
 jobs:
   release:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - name: Use Ruby
-        uses: actions/setup-ruby@v1
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: '2.6'
-          architecture: 'x64'
-      - name: Update gems
-        run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
-      - name: Update stepmod-utils.jar
-        run: |
-          rm -f bin/stepmod-utils.jar
-          rake bin/stepmod-utils.jar
-      - name: Run specs
-        run: |
-          bundle exec rake
-      - name: Publish to rubygems.org
+
+      - run: gem install gem-release    
+
+      - 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
+
+      - name: publish to rubygems.org
         env:
           RUBYGEMS_API_KEY: ${{secrets.METANORMA_CI_RUBYGEMS_API_KEY}}
         run: |
           gem install gem-release
-          touch ~/.gem/credentials
           cat > ~/.gem/credentials << EOF
           ---
           :rubygems_api_key: ${RUBYGEMS_API_KEY}
           EOF
           chmod 0600 ~/.gem/credentials
-          git status
           gem release

data/Gemfile

@@ -7,4 +7,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
-gem "pry"
+gem "pry"
+gem "concurrent-ruby", "~> 1.1"

data/Makefile

@@ -0,0 +1,2 @@
+convert_stepmod_repo:
+	bundle exec ./exe/stepmod-annotate-all ../iso-10303-stepmod

data/README.adoc

@@ -1,4 +1,4 @@
-= stepmod-utils Ruby gem
+= STEPmod utilities
 
 image:https://img.shields.io/gem/v/metanorma.svg["Gem Version", link="https://rubygems.org/gems/metanorma"]
 image:https://github.com/metanorma/stepmod-utils/workflows/ubuntu/badge.svg["Ubuntu Build Status", link="https://github.com/metanorma/stepmod-utils/actions?query=workflow%3Aubuntu"]
@@ -12,6 +12,12 @@ image:https://img.shields.io/github/commits-since/metanorma/stepmod-utils/latest
 
 The `stepmod-utils` Ruby gem provides a number of tools to work with the STEPmod repository.
 
+
+== CVS to Git migration procedures
+
+include::migrating_from_cvs.adoc[]
+
+
 == Installation
 
 [source,ruby]
@@ -37,6 +43,81 @@ Then these files will be created:
 * `031-generated-terms.adoc` all terms extracted
 * `991-generated-bibliography.adoc` all bibliographic sources where the terms come from
 
+== Conversion of STEPmod descriptions.xml into adoc
+
+[source,sh]
+----
+$ stepmod-convert-express-description /path/to/the/stepmod/descriptions.xml
+----
+
+Example output:
+[source,adoc]
+-----
+(*"application_context_schema"
+
+*)
+(*"application_context_schema.exchange_identification_context_select"
+ The *exchange\_identification\_context\_select* type allows for the designation of the data types express_ref:[management_resources_schema:ir_express:management_resources_schema.identification_assignment] and express_ref:[person_organization_schema:ir_express:person_organization_schema.organization] .
+*)
+(*"application_context_schema.application_context"
+ An *application\_context*, as defined in ISO 10303-1, is a context in which product data is defined and has meaning. An *application\_context* represents various types of information that relate to product data and may affect the meaning and usage of that data.
+*)
+(*"application_context_schema.application_context.application"
+
+the express_ref:[support_resource_schema:ir_express:support_resource_schema.label] by which the *application\_context* is known.
+
+[NOTE]
+--
+The meaning of this attribute can be defined in the annotated EXPRESS schemas that use or specialize this entity, or in an agreement of common understanding between the partners sharing this information.
+--
+
+*)
+-----
+
+
+== Conversion of STEPmod resource.xml into adoc
+
+Given resource.xml file contents:
+
+[source,xml]
+----
+<schema name="contract_schema" number="8369" version="3">
+  <introduction>
+    The subject of the <b>contract_schema</b> is the description of contract agreements.
+  </introduction>
+  <fund_cons>
+    Contract information may be attached to any aspect of a product data.
+  </fund_cons>
+  <express-g>
+    <imgfile file="contract_schemaexpg1.xml"/>
+    <imgfile file="contract_schemaexpg2.xml"/>
+  </express-g>
+</schema>
+----
+
+Command:
+
+[source,sh]
+----
+$ stepmod-convert-express-resource resource.xml
+----
+
+Will give output:
+
+[source,adoc]
+----
+== Introduction
+
+The subject of the *contract_schema* is the description of contract agreements.
+
+== Fundamental concerns
+
+Contract information may be attached to any aspect of a product data.
+
+expg_image:contract_schemaexpg1.xml[]
+expg_image:contract_schemaexpg2.xml[]
+----
+
 
 == CVS revision detection
 

data/exe/stepmod-annotate

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'json'
+require 'stepmod/utils/smrl_description_converter'
+require 'stepmod/utils/smrl_resource_converter'
+
+express_file = ARGV.shift
+resource_docs_cache_file = ARGV.shift # output of ./stepmod-build-resource-docs-cache
+stepmod_dir = ARGV.first || Dir.pwd
+
+match = File.basename(express_file).match('^(arm|mim|bom)\.exp$')
+descriptions_base = match ? "#{match.captures[0]}_descriptions.xml" : 'descriptions.xml'
+descriptions_file = File.join(File.dirname(express_file), descriptions_base)
+
+output_express = File.read(express_file)
+
+resource_docs_cache = JSON.parse(File.read(resource_docs_cache_file))
+
+if File.exists?(descriptions_file)
+  descriptions = Nokogiri::XML(File.read(descriptions_file)).root
+  descriptions.xpath('ext_description').each do |description|
+    unless description.text.strip.empty? then
+      Dir.chdir(File.dirname(descriptions_file)) do
+        wrapper = "<ext_descriptions>#{description.to_s}</ext_descriptions>"
+        output_express << "\n" + Stepmod::Utils::SmrlDescriptionConverter.convert(wrapper)
+      end
+    else
+      # remark is empty, fallback to resource_docs_cache
+      resource_docs_dir = resource_docs_cache[description['linkend']]
+      if resource_docs_dir
+        resource_docs_file = File.join(stepmod_dir, 'data/resource_docs', resource_docs_dir, 'resource.xml')
+        resource_docs = Nokogiri::XML(File.read(resource_docs_file)).root
+        schema = resource_docs.xpath("schema[@name='#{description['linkend']}']")
+
+        Dir.chdir(File.dirname(descriptions_file)) do
+          wrapper = "<resource>#{schema.to_s}</resource>"
+          output_express << "\n" + Stepmod::Utils::SmrlResourceConverter.convert(wrapper)
+        end
+      end
+    end
+  end
+end
+
+puts output_express

data/exe/stepmod-annotate-all

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+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}"`
+
+# 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_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
+)
+files.each_slice(MAX_QUEUE_SIZE) do |batch|
+  puts("Queueing next batch")
+  batch.each do |file|
+    pool.post do
+      puts("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|
+        file.puts(annotated)
+      end
+      puts("Done processing #{file}")
+    end
+  end
+  pool.shutdown
+end
+
+# cleanup
+`rm "#{resource_docs_cache_file}"`

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

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+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')
+  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
+  end
+end
+
+puts JSON.pretty_generate(schemas)

data/exe/stepmod-convert-express-description

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# 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"
+
+class Gem::Specification
+  def this; self; end
+end
+
+require 'bundler/setup'
+require 'stepmod/utils/smrl_description_converter'
+
+ReverseAdoc.config.unknown_tags = :bypass
+
+input_content = ARGF.read
+
+result = Stepmod::Utils::SmrlDescriptionConverter.convert(input_content, {})
+result.split("\n").each do |line|
+  begin
+    $stdout.puts(line)
+    $stdout.flush
+  rescue Errno::EPIPE
+    exit(74)
+  end
+end

data/exe/stepmod-convert-express-resource

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# 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"
+
+class Gem::Specification
+  def this; self; end
+end
+
+require 'bundler/setup'
+require 'stepmod/utils/smrl_resource_converter'
+
+ReverseAdoc.config.unknown_tags = :bypass
+
+input_content = ARGF.read
+
+result = Stepmod::Utils::SmrlResourceConverter.convert(input_content, {})
+result.split("\n").each do |line|
+  begin
+    $stdout.puts(line)
+    $stdout.flush
+  rescue Errno::EPIPE
+    exit(74)
+  end
+end

data/exe/stepmod-find-express-files

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'nokogiri'
+
+stepmod_dir = ARGV.first || Dir.pwd
+
+index = Nokogiri::XML(File.read(File.join(stepmod_dir, 'repository_index.xml'))).root
+
+files = []
+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|
+  files << "#{stepmod_dir}/data/resources/#{item['name']}/#{item['name']}.exp"
+end
+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

data/lib/stepmod/utils/cleaner.rb

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