stepmod-utils 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5dc18c380e823b42d5e958c7c83008805c7ae44966481bd892ebe8e7119df9b
-  data.tar.gz: 83e1abb4edb5a8c9b585fca855024fb4cabc689a3223b858dd4b4d7c6f449897
+  metadata.gz: f618abd79f952547eed2824f74873d2082d40803479f02a129974150305aa37e
+  data.tar.gz: c10d4c33ec8df86673f94402cddd84776cd3915f7230c3d931655c29c67ca144
 SHA512:
-  metadata.gz: b55e1bce8655edcc98ded98f9bd1658ecedafb15c413e123f9de6d5aecfe079f9ed929417683ad54b17e0586b55354baf4a798a94fc4a0908b825b58ca973209
-  data.tar.gz: 9dd2822119df10d4c6e1f66b5a49329e093c8c1a8b2bfcf05609f67660b3a5b5e0aff62fc86e8b116eb3c7da0721088d1aee91df2d9879b42da243897c10e4ba
+  metadata.gz: 4da2323b7b031f79c5e48e4421846dfaae68bccd3bd2b7549534b8ee251642099d7d28645e351c4a20ed6a8242741e341adc5b72b7871eeadafa1451ada3c72a
+  data.tar.gz: d3546c0c7f062bcfc5b0793c164f16f348ed90e86668bef426d6125bfb3e0a220f334b07e54225d62fede2bf41bba754cec2f369b3e5790d931d848129814f3a

data/exe/stepmod-annotate-all

@@ -124,6 +124,8 @@ def all_express_files(stepmod_dir)
   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"
+    files << "#{stepmod_dir}/data/modules/#{item['name']}/arm_lf.exp"
+    files << "#{stepmod_dir}/data/modules/#{item['name']}/mim_lf.exp"
   end
 
   # Skip resource schemas

data/exe/stepmod-srl-migrate

@@ -169,6 +169,13 @@ log "SRL output documents directory path: `#{srl_output_docs_dir}`"
 log("*" * 30)
 log("[SRL MIGRATION] Migration starts!")
 
+# Excludes migration of originally detached documents
+# See https://github.com/metanorma/iso-10303-srl/issues/67
+STEPMOD2MN_ARGS_EXCLUDE_PARTS = %w(
+  49 50 52 55 104 108 109 110 111 112
+  501 502 505 507 508 509 510 511 512 513 514 519
+).join(" ")
+
 log("*" * 30)
 log("[SRL MIGRATION: stepmod2mn.jar] START SVG generation.")
 log("*" * 30)
@@ -180,7 +187,7 @@ log("[SRL MIGRATION: stepmod2mn.jar] COMPLETE SVG generation.")
 log("*" * 30)
 log("[SRL MIGRATION: stepmod2mn.jar] START document migration and SVG generation.")
 log("*" * 30)
-system "java -Xss5m -jar #{stepmod2mn_path} #{stepmod_dir} --output-documents #{srl_output_docs_dir} --output-schemas #{srl_output_schemas_dir}"
+system "java -Xss5m -jar #{stepmod2mn_path} #{stepmod_dir} --output-documents #{srl_output_docs_dir} --output-schemas #{srl_output_schemas_dir} --exclude '#{STEPMOD2MN_ARGS_EXCLUDE_PARTS}'"
 log("*" * 30)
 log("[SRL MIGRATION: stepmod2mn.jar] COMPLETE document migration and SVG generation.")
 

data/lib/stepmod/utils/stepmod_file_annotator.rb

@@ -12,7 +12,7 @@ require "pubid-iso"
 module Stepmod
   module Utils
     class StepmodFileAnnotator
-      attr_reader :express_file, :resource_docs_cache, :stepmod_dir
+      attr_reader :express_file, :resource_docs_cache, :stepmod_dir, :schema_name
 
       # @param express_file [String] path to the exp file needed to annotate
       # @param resource_docs_cache [String] output of ./stepmod-build-resource-docs-cache
@@ -27,6 +27,65 @@ module Stepmod
                                                  .schemas
                                                  .first
                                                  .id
+        @schema_name = normalize_schema_name(@schema_name)
+        self
+      end
+
+      # Needed to fix scheme casing issues, e.g. xxx_LF => xxx_lf
+      def normalize_schema_name(name)
+        case name.downcase
+        # module schemas have first letter capitalized, rest in lowercase
+        when /_arm_lf\Z/i, /_mim_lf\Z/i, /_arm\Z/i, /_mim\Z/i
+          name.downcase.capitalize
+        # resource schemas are all in lowercase
+        else
+          name.downcase
+        end
+      end
+
+      SCHEMA_VERSION_MATCH_REGEX = /^SCHEMA [0-9a-zA-Z_]+;\s*$/
+      def is_missing_version(schema_content)
+        m = schema_content.match(SCHEMA_VERSION_MATCH_REGEX)
+        if m.nil?
+          false
+        elsif m[0] # match
+          true
+        else
+          false
+        end
+      end
+
+      def build_schema_string_with_version
+        # Geometric_tolerance_arm => geometric-tolarance-arm
+        name_in_asn1 = @schema_name.downcase.gsub("_", "-")
+        schema_type, type_number = case @schema_name.downcase
+        when /_arm\Z/i
+          [:module, 1]
+        when /_mim\Z/i
+          [:module, 2]
+        when /_arm_lf\Z/i
+          [:module, 3]
+        when /_mim_lf\Z/i
+          [:module, @module_has_arm_lf ? 4 : 3]
+        else # any resource schema without version strings
+          puts "[annotator-WARNING] this resource schema is missing a version string: #{@schema_name}"
+          [:resource, 1]
+        end
+
+        # TODO there are schemas with only arm, arm_lf:
+        # schemas/modules/reference_schema_for_sysml_mapping/arm_lf.exp
+        # TODO there are schemas with only arm, mim, mim_lf:
+        # schemas/modules/limited_length_or_area_indicator_assignment/mim_lf.exp
+        part = @identifier.part
+        edition = @identifier.edition
+        schema_or_object = (schema_type == :module) ? "schema" : "object"
+
+        "SCHEMA #{@schema_name} '{ " \
+          "iso standard 10303 part(#{part}) " \
+          "version(#{edition}) " \
+          "#{schema_or_object}(1) " \
+          "#{name_in_asn1}(#{type_number}) " \
+        "}';\n"
       end
 
       def resource_docs_schemas(stepmod_dir)
@@ -48,7 +107,7 @@ module Stepmod
       end
 
       def call
-        match = File.basename(express_file).match('^(arm|mim|bom)\.exp$')
+        match = File.basename(express_file).match('^(arm|mim|bom|arm_lf|mim_lf|DomainModel)\.exp$')
         descriptions_base = match ? "#{match.captures[0]}_descriptions.xml" : "descriptions.xml"
 
         descriptions_file = File.join(File.dirname(express_file),
@@ -107,8 +166,13 @@ module Stepmod
                      resource_docs_file_path(stepmod_dir, bib_file_name)
                    end
 
-        output_express << if bib_file && File.exist?(bib_file)
-                            prepend_bibdata(
+        unless bib_file && File.exist?(bib_file)
+          raise StandardError.new(
+            "bib_file for #{schema_name} does not exist: #{bib_file}"
+          )
+        end
+
+        output_express << prepend_bibdata(
                               converted_description || "",
                               # bib_file will not be present for resouces
                               # that are not in resource_docs cache.
@@ -117,9 +181,16 @@ module Stepmod
                               @schema_name,
                               match,
                             )
-                          else
-                            converted_description
-                          end
+
+        if is_missing_version(output_express)
+          puts "[annotator-WARNING] schema (#{@schema_name}) missing version string. "\
+            "Adding: `#{build_schema_string_with_version}` to schema."
+
+          output_express.gsub!(
+            SCHEMA_VERSION_MATCH_REGEX,
+            build_schema_string_with_version
+          )
+        end
 
         {
           annotated_text: sanitize(output_express),
@@ -171,7 +242,11 @@ processed_images_cache)
 
           converted_description = <<~DESCRIPTION
 
-            #{Stepmod::Utils::SmrlDescriptionConverter.convert(wrapper, no_notes_examples: true, descriptions_file: descriptions_file)}
+            #{Stepmod::Utils::SmrlDescriptionConverter.convert(
+              wrapper,
+              no_notes_examples: true,
+              descriptions_file: descriptions_file
+            )}
           DESCRIPTION
 
           if description["linkend"].nil?
@@ -216,12 +291,15 @@ processed_images_cache)
         bib = Nokogiri::XML(File.read(bibdata_file)).root
         bibdata = extract_bib_data(match, bib, schema_and_entity)
 
+        # for schema version string generation
+        @identifier = bibdata[:identifier]
+
         return description.to_s if @added_bibdata[schema_and_entity]
 
         published_in = <<~PUBLISHED_IN
 
           (*"#{schema_and_entity}.__published_in"
-          #{bibdata[:identifier]}
+          #{bibdata[:identifier].to_s(with_edition: true)}
           *)
         PUBLISHED_IN
 
@@ -269,17 +347,17 @@ processed_images_cache)
       end
 
       def module?(match)
-        match && %w[arm mim].include?(match.captures[0])
+        match && %w[arm mim arm_lf mim_lf].include?(match.captures[0])
       end
 
       def bom?(match)
-        match && %w[bom].include?(match.captures[0])
+        match && %w[bom DomainModel].include?(match.captures[0])
       end
 
       def extract_bib_file_name(match, default_file_name = "")
         return default_file_name || "" unless match
 
-        if %w[arm mim].include?(match.captures[0])
+        if %w[arm mim arm_lf mim_lf].include?(match.captures[0])
           "module.xml"
         else
           "business_object_model.xml"
@@ -287,9 +365,21 @@ processed_images_cache)
       end
 
       def extract_bib_data(match, bib, schema_and_entity)
+        # for schema version string generation
+        @identifier = identifier(bib)
+
         return resource_bib_data(bib, schema_and_entity) unless match
 
         if module?(match)
+          @module_has_arm = !bib.xpath("arm").first.nil?
+          @module_has_mim = !bib.xpath("mim").first.nil?
+          @module_has_arm_lf = !bib.xpath("arm_lf").first.nil?
+          @module_has_mim_lf = !bib.xpath("mim_lf").first.nil?
+
+          puts "[annotator] module has schemas: " \
+            "ARM(#{@module_has_arm}) MIM(#{@module_has_mim}) " \
+            "ARM_LF(#{@module_has_arm_lf}) MIM_LF(#{@module_has_mim_lf})"
+
           module_bib_data(bib, match.captures[0])
         elsif bom?(match)
           bom_bib_data(bib)
@@ -314,7 +404,7 @@ processed_images_cache)
         pubid.year = year.split("-").first if year && !year.empty?
         pubid.edition = edition if edition && !edition.empty?
 
-        pubid.to_s(with_edition: true)
+        pubid
       end
 
       def resource_bib_data(bib, schema_and_entity)
@@ -322,6 +412,7 @@ processed_images_cache)
 
         {
           identifier: identifier(bib),
+          edition: bib.attributes["version"],
           number: schema.attributes["number"],
           supersedes_concept: schema.attributes["number.supersedes"],
           status: bib.attributes["status"],
@@ -332,6 +423,7 @@ processed_images_cache)
       def module_bib_data(bib, type)
         {
           identifier: identifier(bib),
+          edition: bib.attributes["version"],
           number: bib.attributes["wg.number.#{type}"],
           supersedes_concept: bib.attributes["wg.number.#{type}.supersedes"],
           status: bib.attributes["status"],
@@ -342,6 +434,7 @@ processed_images_cache)
       def bom_bib_data(bib)
         {
           identifier: identifier(bib),
+          edition: bib.attributes["version"],
           number: bib.attributes["wg.number.bom.exp"],
           supersedes_concept: bib.attributes["wg.number.bom.supersedes"],
           status: bib.attributes["status"],

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.6.0".freeze
+    VERSION = "0.6.1".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-19 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby