stepmod-utils 0.3.9 → 0.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8838f07a6b887ff87b6067b7a82b02e605bfc97c81ed345642b68c9d8d4e6a5b
-  data.tar.gz: 213824aa6f2b832d941d6575005f7c43c60f5332a1c285f973efa05d52090b86
+  metadata.gz: bb7bf9af17dc5e00cbaa48dbadcca9866867c666f27454fdcedd05cc10424e77
+  data.tar.gz: e082809ce1ba11806170e75ab9e35e4fb32dbf5062b0cc991c52a320adef12d0
 SHA512:
-  metadata.gz: '088fe0671024dd6e5fb69960c379d52e25345546ba5f87b8167d37e26fd8315074ba7b7028757d610a1c18fffe560485cc65937157cad72a32445dfef836a415'
-  data.tar.gz: 176cde1360b6f3a229c05eb50fe606892d106101dab6e3e7c1aafb15467602d9650107151a58eb9f3ac56a2f93411ccd3131e749a3974c247f6c4cdc76f5e414
+  metadata.gz: 8f181ca96460491b225d3f589092af504c18dc684d1d561556ab0504f148e01413566a05a17ccfe7f4de8fd8f6d0b154949d2e7fea3b21d9cd3bbdcf162285df
+  data.tar.gz: 6cfe79605d3aa7da7387caf85b1374dec3601eec9880f1740364976feb12b218908635dffc1bc446fc519458856e4a5e55e9fffaca677e3cdbf1c7d0c6b86b4e

data/exe/stepmod-extract-terms

@@ -85,18 +85,40 @@ part_concepts.each do |(bibdata, current_part_concepts)|
   log "INFO: written to: #{fn}"
 end
 
+File.open("03x-stepmod.adoc", "w") do |file|
+  part_concepts.sort_by do |(bibdata, current_part_concepts)|
+    bibdata.part.to_i
+  end.each do |(bibdata, current_part_concepts)|
+    fn = "03x-stepmod-#{bibdata.part}.adoc"
+    file.puts("\ninclude::#{fn}[]\n")
+  end
+end
+
+log "INFO: written summary file to: 03x-stepmod.adoc"
+
 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") do |file|
-    file.puts("== #{part_to_title(bibdata)}\n\n")
+    # file.puts("== #{part_to_title(bibdata)}\n\n")
     file.puts(replace_images(current_part_resources.map(&:to_mn_adoc).join("\n")))
   end
   log "INFO: written to: #{fn}"
 end
 
+File.open("04x-stepmod-entities-resources.adoc", "w") do |file|
+  part_resources.sort_by do |(bibdata, current_part_resources)|
+    bibdata.part.to_i
+  end.each do |(bibdata, current_part_resources)|
+    fn = "04x-stepmod-entities-resources-#{bibdata.part}.adoc"
+    file.puts("\ninclude::#{fn}[]\n")
+  end
+end
+
+log "INFO: written summary file to: 04x-stepmod-entities-resources.adoc"
+
 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|
@@ -128,6 +150,17 @@ part_modules.each do |(bibdata, part_modules_arm, part_modules_mim)|
   log "INFO: written to: #{fn}"
 end
 
+File.open("05x-stepmod-entities-modules.adoc", "w") do |file|
+  part_modules.sort_by do |(bibdata, part_modules_arm, part_modules_mim)|
+    bibdata.part.to_i
+  end.each do |(bibdata, part_modules_arm, part_modules_mim)|
+    fn = "05x-stepmod-entities-modules-#{bibdata.part}.adoc"
+    file.puts("\ninclude::#{fn}[]\n")
+  end
+end
+
+log "INFO: written summary file to: 05x-stepmod-entities-modules.adoc"
+
 File.open("031-stepmod-general.adoc", "w") do |file|
   file.puts(
     replace_images(

data/lib/stepmod/utils/cleaner.rb

@@ -4,7 +4,9 @@ module Stepmod
   module Utils
     class Cleaner < ReverseAdoc::Cleaner
       def tidy(string)
-        super.gsub(/^ +/, "")
+        super
+          .gsub(/^ +/, "")
+          .gsub(/\*\s([,.])/, '*\1') # remove space between * and comma or dot.
       end
     end
   end

data/lib/stepmod/utils/concept.rb

@@ -124,7 +124,7 @@ module Stepmod
 
       def to_mn_adoc
         <<~TEXT
-          // STEPmod path:#{!file_path.empty? ? " #{file_path}" : ''}
+          // STEPmod path:#{file_path.empty? ? '' : " #{file_path}"}
           #{converted_definition}
 
           [.source]

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "uri"
-
 module Stepmod
   module Utils
     module Converters
@@ -31,9 +29,7 @@ module Stepmod
             name = title if name.empty?
             href = "link:#{href}" unless href.to_s&.match?(URI::DEFAULT_PARSER.make_regexp)
             link = "#{href}[#{name}]"
-            # link.prepend(' ')
             " #{link}"
-
           end
         end
       end

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

@@ -3,7 +3,7 @@ module Stepmod
     module Converters
       class ExtDescription < ReverseAdoc::Converters::Base
         def convert(node, state = {})
-          state = state.merge(schema_name: node["linkend"])
+          state = state.merge(schema_name: node["linkend"], non_flanking_whitesapce: true)
           child_text = treat_children(node, state).strip
 
           <<~TEMPLATE

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

@@ -13,10 +13,27 @@ module Stepmod
           child_text = treat_children(node, state).strip
           return nil if child_text.empty?
 
-          # If it contains a list, don't split
-          unless child_text =~ /\n\* /
+          # Unless the first paragraph ends with "between" and is followed by a
+          # list, don't split
+          first_child = child_text.split("\n").first
+
+          unless (
+            first_child =~ /between:?\s*\Z/ ||
+            first_child =~ /include:?\s*\Z/ ||
+            first_child =~ /of:?\s*\Z/ ||
+            first_child =~ /[:;]\s*\Z/
+            ) &&
+            child_text =~ /\n\n\*/
+
             # Only taking the first paragraph of the definition
-            child_text = child_text.split("\n").first
+            child_text = first_child
+          end
+
+          # TEMP: Remove any whitespace (" ", not newlines) after an immediate
+          # newline due to:
+          # https://github.com/metanorma/iso-10303-2/issues/71
+          if child_text =~ /\n\ +/
+            child_text = child_text.gsub(/\n\ +/, "\n")
           end
 
           # # Only taking the first sentence
@@ -26,10 +43,10 @@ module Stepmod
 
           domain =  case linkend.first
                     when /_mim$/, /_arm$/
-                      "STEP module"
+                      "ISO 10303 application module"
                     # when /_schema$/
                     else
-                      "STEP resource"
+                      "ISO 10303 resource"
                     end
 
           <<~TEMPLATE

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

@@ -8,12 +8,13 @@ module Stepmod
 
         def convert(node, state = {})
           content = treat_children(node, state.merge(already_strong: true))
+          strong_tag = state[:non_flanking_whitesapce] ? '**' : '*'
           if content.strip.empty? || state[:already_strong]
             content
           else
             handle_express_escape_seq(
               node,
-              "#{content[/^\s*/]}*#{content.strip}*#{content[/\s*$/]}"
+              "#{content[/^\s*/]}#{strong_tag}#{content.strip}#{strong_tag}#{content[/\s*$/]}"
             )
           end
         end

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

@@ -14,7 +14,7 @@ module Stepmod
           # <<~TEXT
           # === #{node['name'].strip}
 
-          # <STEP module> #{treat_children(node, state).strip}
+          # <ISO 10303 application module> #{treat_children(node, state).strip}
           # TEXT
         end
       end

data/lib/stepmod/utils/stepmod_definition_converter.rb

@@ -17,6 +17,7 @@ require "stepmod/utils/converters/term"
 require "stepmod/utils/converters/synonym"
 require "stepmod/utils/converters/uof"
 require "stepmod/utils/converters/figure"
+require "stepmod/utils/cleaner"
 
 require "reverse_adoc/converters/a"
 require "reverse_adoc/converters/blockquote"
@@ -56,7 +57,7 @@ module Stepmod
                                                                      options)
           return "" unless result
 
-          ReverseAdoc.cleaner.tidy(result.dup)
+          Stepmod::Utils::Cleaner.new.tidy(result.dup)
         end
       end
     end

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.3.9".freeze
+    VERSION = "0.3.13".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.13
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -215,7 +215,6 @@ files:
 - lib/stepmod/utils/stepmod_file_annotator.rb
 - lib/stepmod/utils/terms_extractor.rb
 - lib/stepmod/utils/version.rb
-- migrating_from_cvs.adoc
 - resource_example.xml
 - stepmod-utils.gemspec
 homepage: https://github.com/metanorma/stepmod-utils

data/migrating_from_cvs.adoc

@@ -1,190 +0,0 @@
-= STEPmod CVS to Git import
-
-== Purpose
-
-The `cvs/` submodule is a CSV import of STEPmod files from the CVS server hosted at Boost Conseil.
-
-The goal is to import the CSV-managed files in a way useable via Git, with full history information.
-
-This guide is used as reference for the usage of `cvs-fast-import`:
-https://oitofelix.github.io/article-savannah-cvs-to-git-migration/
-
-
-== Strategy to import
-
-Cloning a remote CVS repository while importing is super slow,
-especially for a large repository like STEPmod.
-
-We have tested and settled on these steps:
-
-. Maintain a local `rsync` copy of the CVS repository.
-. Resolve all names from the CVS repository (CVS only stores UNIX usernames, in Git are names and emails) using `cvs-fast-import`.
-. Run `cvs-fast-import` to import the CVS repository into the `iso-10303-stepmod-cvs` Git repo.
-
-
-== Creating the `rsync` clone of the CVS repository
-
-[source,sh]
-----
-rsync -avrPz -e ssh ronald@cvs.boost-lab.net:/stepmod/ stepmod-rsync/
-----
-
-
-== Install cvs-fast-export
-
-`cvs-fast-export` only works on Linux.
-Run it on Ubuntu with the `rsync`'ed CVS directory.
-
-Install:
-[source,sh]
-----
-$ apt-get -y install cvs-fast-export
-----
-
-== Getting all users for email mapping
-
-Find all authors in the CVS repository using `cvs-fast-export -a`.
-It is much faster than using the equivalent CVS command to list all authors.
-
-[source,sh]
-----
-$ find stepmod-rsync -type f | cvs-fast-export -a
-----
-
-
-== Create fast-import file for Git
-
-After all authors are mapped, run `cvs-fast-export` to create
-the import file.
-
-[source,sh]
-----
-$ find stepmod-rsync -type f | cvs-fast-export -A author-map.txt > fast-import-file
-----
-
-== Perform the Git fast-import
-
-Once the fast-import file is created, we can perform the Git import.
-
-[source,sh]
-----
-$ cd iso-10303-stepmod-cvs
-$ git fast-import < ../fast-import-file
-----
-
-
-== Upload the new Git repo
-
-[source,sh]
-----
-git push --all && git push --tags
-----
-
-
-== DEPRECATED steps using `git cvsimport` (do not use, it won't work)
-
-=== General
-
-https://stackoverflow.com/questions/11362676/how-to-import-and-keep-updated-a-cvs-repository-in-git[This StackOverflow post]
-describes steps for using `git cvsimport`.
-
-Originally the `git cvsimport` tool was chosen since it is part of
-`git`. However, it utilizes a deprecated/unmaintained tool called
-`cvsps`. The latest `cvsps` is version 3, but only version 2 is
-compatible with `git cvsimport`.
-
-In addition, the `cvsps` tool is maintained by the maintainer
-of `cvs-fast-import`, and is no longer updated.
-Eventually `cvs-fast-import` is used instead.
-
-WARNING: This command completely fails
-on this repository because it is too large and complex.
-
-
-=== Setup
-
-On macOS, run the following commands to setup for running the import. The `git` executable must be installed.
-
-Install `cvsps` version 2.
-
-NOTE: The steps from the StackOverflow of installing `cvsps` no longer work.
-
-[source,sh]
-----
-$ brew tap Frizlab/Perso
-# ==> Tapping frizlab/perso
-# Cloning into '/usr/local/Homebrew/Library/Taps/frizlab/homebrew-perso'...
-# remote: Enumerating objects: 123, done.
-# remote: Total 123 (delta 0), reused 0 (delta 0), pack-reused 123
-# Receiving objects: 100% (123/123), 19.08 KiB | 91.00 KiB/s, done.
-# Resolving deltas: 100% (43/43), done.
-# Tapped 1 cask and 10 formulae (38 files, 60.5KB).
-
-$ brew install cvsps@2
-# ==> Installing cvsps@2 from frizlab/perso
-# Warning: A newer Command Line Tools release is available.
-# Update them from Software Update in System Preferences or
-# https://developer.apple.com/download/more/.
-# ==> Downloading https://deb.debian.org/debian/pool/main/c/cvsps/cvsps_2.1.orig.tar.gz
-######################################################################## 100.0%
-# ==> make all
-# ==> make install prefix=/usr/local/Cellar/cvsps@2/2.1
-# 🍺  /usr/local/Cellar/cvsps@2/2.1: 7 files, 124.6KB, built in 6 seconds
-----
-
-Verify it is installed:
-[source,sh]
-----
-$ cvsps -v
-# Can't open CVS/Root
-# cannot determine CVSROOT
-----
-
-////
-== Checkout the CVS repository
-
-First set the `CVSROOT` and `CVS_RSH` variables.
-
-[source,sh]
-----
-export CVSROOT=:ext:ronald@cvs.boost-lab.net:/stepmod
-export CVS_RSH=ssh
-cvs checkout stepmod
-# => stepmod/ is created in $PWD
-----
-////
-
-
-=== Run the import
-
-Run the import from CVS to Git.
-
-Go to the directory that will carry the target Git repository.
-
-Run `git cvsimport`.
-
-[source,sh]
-----
-# Importing from remote
-$ export CVSROOT=:ext:ronald@cvs.boost-lab.net:/stepmod
-$ export CVS_RSH=ssh
-$ git cvsimport -C iso-10303-stepmod-cvs -r cvs -k -v -d $CVSROOT stepmod
-
-# Importing from local rsync'ed copy
-$ export CVSROOT=$(pwd)/stepmod-rsync
-$ git cvsimport -C iso-10303-stepmod-cvs -r cvs -k -v -d $CVSROOT stepmod
-----
-
-WARNING: TLDR. Technically this should work, but I ran into a `cvsps cannot allocate memory` error with 64GB of RAM, and not even completing the clone after 24 hours. So I gave up and switched to local. And local still takes a long time with tons of error messages. `cvs-fast-import` only takes 5-10 minutes to import.
-
-
-=== Updating the CVS import
-
-Run `git cvsimport` to synchronize the Git repo using updated data from CVS.
-
-[source,sh]
-----
-$ git cvsimport
-----
-
-