stepmod-utils 0.3.15 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0fb38c39db845a0b6ff3358d7dea3b0b5f687c50109ee6318438a7787453e5e
-  data.tar.gz: 7ac3bdf768eeac0805f19fd41703632ed12460c4216b98c5a4b689dc99491033
+  metadata.gz: e40fc2ba271e4bd8e0859cb307831ead927b7bc12154b5845f528694ad18c8f8
+  data.tar.gz: e1b6f691a70d1e6531a7f841b5a998d49d6c376a84a9da340246b2920bd8459d
 SHA512:
-  metadata.gz: 799b824cd2eec2efe7d3c5a7972ac21ead6af9b493e13e7ec78a3cfb6417e3576835e5aead8ac07ca264ae3513758cb212259d7ed0e0cb9713acb025393c26e6
-  data.tar.gz: 2b95f4f76fb19b09695d6cceddce5d854a4843bdfab62d645363b9fa379ad8616c8e1c361802264703c00684b9a3f7242c0aa22b6448ec8cc2e555cea85e797e
+  metadata.gz: e5e62c15d95982deb33e03af65b9720cdb34746adfa36bf5945a2823fb0be9800beff3e8cf4b3e4acd34ebf940bacb0ff2b4a83b31af27e8d01cba2599fcc537
+  data.tar.gz: c9efdfa5eed962291c9454227e8d2c7c22b4ba665c88745d059f77cdfb5ae2bdb414d32d7c1ee957aec10db634c1f0fbc388851360ae4edb9bf9d721f740dca3

data/.github/workflows/rake.yml

@@ -10,23 +10,6 @@ on:
 
 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: [ '3.0', '2.7', '2.6', '2.5' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ false ]
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - run: bundle exec rake
+    uses: metanorma/metanorma-build-scripts/.github/workflows/generic-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -15,32 +15,10 @@ on:
 
 jobs:
   release:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
+    uses: metanorma/metanorma-build-scripts/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+      event_name: ${{ github.event_name }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
 
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '2.6'
-          bundler-cache: true
-
-      - run: gem install gem-release
-
-      - run: |
-          git config user.name github-actions
-          git config user.email github-actions@github.com
-
-      - 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
-          envsubst << 'EOF' > ~/.gem/credentials
-          ---
-          :rubygems_api_key: ${RUBYGEMS_API_KEY}
-          EOF
-          chmod 0600 ~/.gem/credentials
-          gem release

data/README.adoc

@@ -14,11 +14,6 @@ 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]
@@ -116,48 +111,15 @@ expg_image:contract_schemaexpg1.xml[]
 expg_image:contract_schemaexpg2.xml[]
 ----
 
+== Git repository
 
-== CVS revision detection
-
-If the STEPmod repository is a CVS repository, it will display the
-working and repository revisions as comments.
-
-WARNING: CVS revision detection can be *slow*! Be patient.
-
-Sample output:
-
-[source,sh]
-----
-[stepmod-utils] INFO: STEPmod directory set to ../x/stepmod/.
-[stepmod-utils] INFO: STEPmod directory is a CVS repository and will detect revisions.
-[stepmod-utils] INFO: [CVS] Detecting file revisions can be slow, please be patient!
-[stepmod-utils] INFO: Detecting paths...
-[stepmod-utils] INFO: Processing XML file data/business_object_models/managed_model_based_3d_engineering/business_object_model.xml
-[stepmod-utils] INFO: Detecting CVS revision...
-[stepmod-utils] INFO: CVS working rev (1.148), repo rev (1.148)
-[stepmod-utils] INFO: Completed processing XML file data/business_object_models/managed_model_based_3d_engineering/business_object_model.xml
-[stepmod-utils] INFO: Processing XML file data/business_object_models/managed_model_based_3d_engineering_domain/business_object_model.xml
-[stepmod-utils] INFO: Detecting CVS revision...
-[stepmod-utils] INFO: CVS working rev (1.31), repo rev (1.31)
-[stepmod-utils] INFO: Completed processing XML file data/business_object_models/managed_model_based_3d_engineering_domain/business_object_model.xml
-...
- stepmod/data/business_object_models/managed_model_based_3d_engineering_domain/business_object_model.xml
-[stepmod-utils] INFO: written to: 031-generated-terms.adoc
-[stepmod-utils] INFO: written to: 991-generated-bibliography.adoc
-----
-
-
-== Non-CVS repository
-
-If the STEPmod repository is not a CVS repository, or if the `cvs` executable
-cannot be found, term extract will still work.
+If the STEPmod repository is a Git repository, term extract will work.
 
 Sample output:
 
 [source,sh]
 ----
 [stepmod-utils] INFO: STEPmod directory set to ../iso-10303-stepmod.
-[stepmod-utils] INFO: STEPmod directory is not a CVS repository, skipping revision detection.
 [stepmod-utils] INFO: Detecting paths...
 [stepmod-utils] INFO: Processing XML file data/application_protocols/boundary_representation_for_iso_14306_open_jt/application_protocol.xml
 [stepmod-utils] INFO: skipped ISO/CD 10303-243 as it is not IS, DIS or TS

data/exe/stepmod-extract-terms

@@ -30,7 +30,7 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: #{$0} [options]"
 
-  opts.on("-p", "--path STEPMOD_DATA_PATH", String, "Path to STEPmod CVS data directory") do |path|
+  opts.on("-p", "--path STEPMOD_DATA_PATH", String, "Path to STEPmod data directory") do |path|
     options[:stepmod_dir] = path
   end
 

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

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "stepmod/utils/converters/synonym"
+require "stepmod/utils/term"
+require "glossarist"
 
 module Stepmod
   module Utils
@@ -22,22 +24,20 @@ module Stepmod
           unless first_child &&
               node.text.split(";").length == 2 &&
               defined?(Stepmod::Utils::Converters::Synonym)
-            return "=== #{treat_acronym(treat_children(node, state).strip)}"
+
+            return Stepmod::Utils::Term.from_h(
+              "definition" => treat_children(node, state).strip,
+            ).to_mn_adoc
           end
 
           term_def, alt = node.text.split(";")
           alt_xml = Nokogiri::XML::Text.new(alt, Nokogiri::XML::Document.new)
           converted_alt = Stepmod::Utils::Converters::Synonym.new.convert(alt_xml)
-          "=== #{treat_acronym(term_def)}\n\n#{converted_alt}"
-        end
-
-        private
-
-        def treat_acronym(term_def)
-          return term_def.strip if term_def !~ /.+\(.+?\)$/
 
-          _, term_text, term_acronym = term_def.match(/(.+?)(\(.+\))$/).to_a
-          "#{term_text.strip}\nalt:[#{term_acronym.gsub(/\(|\)/, '')}]"
+          Stepmod::Utils::Term.from_h(
+            "definition" => term_def,
+            "synonyms" => [converted_alt],
+          ).to_mn_adoc
         end
       end
 

data/lib/stepmod/utils/term.rb

@@ -0,0 +1,38 @@
+require "glossarist"
+
+module Stepmod
+  module Utils
+    class Term < Glossarist::LocalizedConcept
+      # Term acronym
+      attr_accessor :acronym
+
+      def to_mn_adoc
+        mn_adoc = ["=== #{definition}"]
+        mn_adoc << "\nalt:[#{acronym}]" if acronym
+        mn_adoc << "\n\n#{designations.join(", ")}" if designations&.any?
+
+        mn_adoc.join
+      end
+
+      class << self
+        def from_h(hash)
+          _, definition, acronym = treat_acronym(hash["definition"])
+
+          hash["definition"] = definition
+          hash["acronym"] = acronym.gsub(/\(|\)/, "") if acronym
+          hash["designations"] = hash["synonyms"]
+
+          super(hash.reject { |k, _| k == "synonyms" })
+        end
+
+        private
+
+        def treat_acronym(term_def)
+          return [nil, term_def.strip, nil] unless term_def.match?(/.+\(.+?\)$/)
+
+          term_def.match(/(.+?)(\(.+\))$/).to_a
+        end
+      end
+    end
+  end
+end

data/lib/stepmod/utils/terms_extractor.rb

@@ -20,7 +20,6 @@ module Stepmod
                   :resource_concepts,
                   :parsed_bibliography,
                   :encountered_terms,
-                  :cvs_mode,
                   :part_concepts,
                   :part_resources,
                   :part_modules,
@@ -60,25 +59,7 @@ module Stepmod
       end
 
       def call
-        # If we are using the stepmod CVS repository, provide the revision number per file
-        @cvs_mode = if Dir.exists?(stepmod_path.join("CVS"))
-                      require "ptools"
-                      # ptools provides File.which
-                      File.which("cvs")
-                    end
-
         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."
-        end
-
         log "INFO: Detecting paths..."
 
         repo_index = Nokogiri::XML(File.read(@index_path)).root
@@ -161,24 +142,15 @@ module Stepmod
             next
           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
+          revision_string = ""
+
+          # Run `cvs status` to find out version
+          log "INFO: Detecting Git SHA..."
+          Dir.chdir(stepmod_path) do
+            git_sha = `git rev-parse HEAD`
+
+            unless git_sha.empty?
+              revision_string = "\n// Git: SHA #{git_sha}"
             end
           end
 

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.3.15".freeze
+    VERSION = "0.3.16".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.15
+  version: 0.3.16
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2022-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -213,6 +213,7 @@ files:
 - lib/stepmod/utils/smrl_resource_converter.rb
 - lib/stepmod/utils/stepmod_definition_converter.rb
 - lib/stepmod/utils/stepmod_file_annotator.rb
+- lib/stepmod/utils/term.rb
 - lib/stepmod/utils/terms_extractor.rb
 - lib/stepmod/utils/version.rb
 - resource_example.xml