stepmod-utils 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c00a03398de66038bd621bb8d91dde41c8dcf03e8d5d44f26b74a52ffaa43bd7
-  data.tar.gz: 9ab6ec5882eb08dbb46716e5511b7c4c2f06437bb9867a27c1ad007ad7abcdb3
+  metadata.gz: 83672fac3acf9ef0d9a2ab17fffab1204b326c7d41018675c2cc819976ac8b40
+  data.tar.gz: 2a59c155d059ca7b73e48ebf5ddedac314e998dbb92eb301a55c460d8ac44e79
 SHA512:
-  metadata.gz: f62e009dcef4d9f3f4f8a1cf4ab3ef28e694ca34cd6315ac461c256a49aaeccc89491f11456a2cd3a6ab8b12a2727a9a6dffdfcb6690d87ee6262566f0ad86eb
-  data.tar.gz: 2af7d3aaca7c67d593f9ad54b47fa474d99d399d7c5c09cb83cd1f9631f746283820fb6ec288715fd6723385110d67f67f13c4b57bc0bb9cc62f5a0f3ed71fdb
+  metadata.gz: ca130bac46780aeef8434443d68e02a83cfc2d17a5dd1634c13c6448fd33c1861e85cc3173303db64449e7da3465b1953ed344690894e09cd5698304c4b129eb
+  data.tar.gz: f4d94ac262f4c98ca810a1002c0bdc22d67cc3bd771521f4700e512386f226156d442de3c3f826c0aa7757bbc7d41a78dd42c22b166eca6a032b9b1177511424

data/Gemfile

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

data/README.adoc

@@ -10,7 +10,7 @@ image:https://img.shields.io/github/commits-since/metanorma/stepmod-utils/latest
 
 == Purpose
 
-The stepmod-utils Ruby gem provides a number of tools to work with the STEPmod repository/
+The `stepmod-utils` Ruby gem provides a number of tools to work with the STEPmod repository.
 
 == Installation
 
@@ -38,3 +38,56 @@ Then these files will be created:
 * `991-generated-bibliography.adoc` all bibliographic sources where the terms come from
 
 
+== 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.
+
+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
+[stepmod-utils] INFO: Processing XML file data/application_protocols/configuration_control_3d_design_ed2/application_protocol.xml
+[stepmod-utils] INFO: Completed processing XML file data/application_protocols/configuration_control_3d_design_ed2/application_protocol.xml
+[stepmod-utils] INFO: Processing XML file data/application_protocols/electronic_assembly_interconnect_and_packaging_design/application_protocol.xml
+[stepmod-utils] INFO: skipped ISO/CD 10303-210:2019 as it is not IS, DIS or TS
+[stepmod-utils] INFO: Processing XML file data/application_protocols/functional_data_and_their_schematic_representation_for_process_plant/application_protocol.xml
+[stepmod-utils] INFO: Completed processing XML file data/application_protocols/functional_data_and_their_schematic_representation_for_process_plant/application_protocol.xml
+...
+----
+

data/exe/stepmod-extract-terms

@@ -1,8 +1,7 @@
-#!/usr/bin/env ruby
-
 #!/usr/bin/env ruby
 # encoding: UTF-8
 
+require 'pry'
 # resolve bin path, ignoring symlinks
 require "pathname"
 bin_file = Pathname.new(__FILE__).realpath
@@ -21,6 +20,7 @@ require 'bundler/setup'
 require 'stepmod/utils/stepmod_definition_converter'
 require 'stepmod/utils/bibdata'
 require 'stepmod/utils/concept'
+require 'ptools'
 
 ReverseAdoc.config.unknown_tags = :bypass
 
@@ -34,7 +34,22 @@ def log message
   puts "[stepmod-utils] #{message}"
 end
 
-log "STEPmod directory set to #{stepmod_dir}. Detecting paths..."
+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."
+end
+
+log "INFO: Detecting paths..."
 
 files = %w(
   resource.xml
@@ -46,25 +61,48 @@ files = %w(
 end.flatten.sort.uniq
 
 files.each do |file_path|
-  log "Processing XML file #{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 #{file_path}, skipped"
+    log "WARNING: Unknown file #{fpath}, skipped"
     next
   end
 
   # TODO: we may want a command line option to override this in the future
   unless %w(IS DIS TS).include? bibdata.doctype
-    log "WARNING: skipping #{bibdata.docid} as it is not IS, DIS or TS"
+    log "INFO: skipped #{bibdata.docid} as it is not IS, DIS or TS"
     next
   end
 
   if bibdata.part.to_s.empty?
-    log "FATAL: missing `part` attribute: #{file_path}"
+    log "FATAL: missing `part` attribute: #{fpath}"
+    log "INFO: skipped #{bibdata.docid} as it is missing `part` attribute."
+    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
+    end
   end
 
   # read definitions
@@ -73,24 +111,28 @@ files.each do |file_path|
     term_id = definition['id']
     unless term_id.nil?
       if encountered_terms[term_id]
-        log "FATAL: Duplicated term with id: #{term_id}, #{file_path}"
+        log "FATAL: Duplicated term with id: #{term_id}, #{fpath}"
       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,
-      # Assume that definition is located in clause 3 of the ISO document
-      # in order. We really don't have a good reference here.
-      reference_clause: "3.#{index}",
-      file_path: Pathname.new(file_path).relative_path_from(Pathname.new(stepmod_dir))
+      reference_clause: ref_clause,
+      file_path: fpath + revision_string
     )
 
     parsed_terms << concept
     parsed_bibliography << bibdata
   end
 
+  log "INFO: Completed processing XML file #{fpath}"
+
 end
 
 parsed_bibliography.uniq!
@@ -99,10 +141,10 @@ File.open('031-generated-terms.adoc', 'w') { |file|
   file.puts(parsed_terms.map(&:to_mn_adoc).join("\n"))
 }
 
-log "written to: 031-generated-terms.adoc"
+log "INFO: written to: 031-generated-terms.adoc"
 
 File.open('991-generated-bibliography.adoc', 'w') { |file|
   file.puts(parsed_bibliography.map(&:to_mn_adoc).join("\n"))
 }
 
-log "written to: 991-generated-bibliography.adoc"
+log "INFO: written to: 991-generated-bibliography.adoc"

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.1.8"
+    VERSION = "0.2.0"
   end
 end

data/stepmod-utils.gemspec

@@ -31,5 +31,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "thor", ">= 0.20.3"
   spec.add_runtime_dependency "reverse_adoc", ">= 0.2.9"
+  spec.add_runtime_dependency "ptools", '~> 1.3'
   spec.add_development_dependency "byebug", "~> 11.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.9
+- !ruby/object:Gem::Dependency
+  name: ptools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement