stepmod-utils 0.3.19 → 0.3.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4541a1fb0b4b3671d2aadf8cb833e93ca8b45f0c591b0da2df55e4614c2bcbf4
-  data.tar.gz: dbf98829e92bfcd54b468691011ab0de3781cf515b4d4b511ec394846f556ac6
+  metadata.gz: fc9977f6a7248164968637abc31b264b928a1b6de459e62a25fc9a95a250ec10
+  data.tar.gz: 030aa9b15094edaa59fbde8ff7948ff7d05dc96b73130495cedcb5f3e52c3b4d
 SHA512:
-  metadata.gz: 8410dd3702701b592aa67af784813058dcf2299ffe9dd60d45cab59b7035952111e17144b3b3b446e03135ae84a2a7ac5467f155b92ff768aa155d96437f0387
-  data.tar.gz: ea2fb98127cb384a70bd5aaf5febab17a92460170c820b250c52c0dca884bdc8d298f5ecdcf54f52ded4d1d22e75cbbce0fc65582499a04413e5e95cc8eb6b85
+  metadata.gz: dca1f9e90a28a17c3cbc6082fb115a705bafe55871256bd2f9112fbd4879c02335a04767d60e3d6e5aaa3a935bf738b9a003542741587b8b4537c8328fe8c17c
+  data.tar.gz: 625b2542ab86f94f54829e750d8297307dfc47dadf740c3d96d65cff611478d04d1d267eb6b3e71abffebad876bbdfd982f50e09e2081ff1feb505fdd3f20f97

data/lib/stepmod/utils/concept.rb

@@ -10,6 +10,8 @@ module Stepmod
         file_path
       )
 
+      # TODO: converted_definition is not supposed to be an attribute, it is
+      # supposed to be a method!
       class << self
         def parse(definition_xml, reference_anchor:, reference_clause:, file_path:, language_code: "en")
           converted_definition = Stepmod::Utils::StepmodDefinitionConverter.convert(
@@ -35,6 +37,8 @@ module Stepmod
             ).strip
           end
 
+          # TODO: `designations:` should include the `alt:[...]` terms here,
+          # they are now only included in definition_xml_converted_definition.
           new(
             designations: [designation],
             definition: definition,

data/lib/stepmod/utils/terms_extractor.rb

@@ -26,7 +26,8 @@ module Stepmod
                   :part_concepts,
                   :part_resources,
                   :part_modules,
-                  :stdout
+                  :stdout,
+                  :git_rev
 
       def self.call(stepmod_dir, index_path, stdout = $stdout)
         new(stepmod_dir, index_path, stdout).call
@@ -65,6 +66,12 @@ module Stepmod
         log "INFO: STEPmod directory set to #{stepmod_dir}."
         log "INFO: Detecting paths..."
 
+        # Run `cvs status` to find out version
+        log "INFO: Detecting Git SHA..."
+        Dir.chdir(stepmod_path) do
+          @git_rev = `git rev-parse HEAD` || nil
+        end
+
         repo_index = Nokogiri::XML(File.read(@index_path)).root
 
         files = []
@@ -145,23 +152,9 @@ module Stepmod
             next
           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
-
           # read definitions
           current_part_concepts = Glossarist::Collection.new
-          definition_index = 0
-          current_document.xpath("//definition").each do |definition|
-            definition_index += 1
+          current_document.xpath("//definition").each.with_index(1) do |definition, definition_index|
             term_id = definition["id"]
             unless term_id.nil?
               if encountered_terms[term_id]
@@ -178,7 +171,7 @@ module Stepmod
               definition,
               reference_anchor: bibdata.anchor,
               reference_clause: ref_clause,
-              file_path: fpath + revision_string,
+              file_path: fpath,
             )
             next unless concept
 
@@ -197,7 +190,7 @@ module Stepmod
           current_part_modules_arm = {}
           current_part_modules_mim = {}
 
-          log "INFO: FILE PATH IS #{file_path}"
+          # log "INFO: FILE PATH IS #{file_path}"
           case file_path.to_s
           when /resource.xml$/
             log "INFO: Processing resource.xml for #{fpath}"
@@ -272,93 +265,27 @@ module Stepmod
               parsed_schema_names[schema_name] = file_path
             end
 
-            exp_annotated_path =
-              "#{stepmod_path}/modules/#{schema_name}/arm_annotated.exp"
-
-            log "INFO: Processing modules schema #{exp_annotated_path}"
-
-            if File.exists?(exp_annotated_path)
-              repo = Expressir::Express::Parser.from_file(exp_annotated_path)
-
-              repo.schemas.each do |schema|
-                schema.entities.each do |entity|
-                  old_definition = entity.remarks.first
-
-                  # See: metanorma/iso-10303-2#90
-                  domain = "application object: #{schema.id}"
-                  entity_definition = generate_entity_definition(entity, domain, old_definition)
-
-                  reference_anchor = bibdata.anchor
-                  reference_clause = nil
-
-                  concept = Stepmod::Utils::Concept.new(
-                    designations: [entity.id],
-                    definition: old_definition,
-                    converted_definition: entity_definition,
-                    id: "#{reference_anchor}.#{reference_clause}",
-                    reference_anchor: reference_anchor,
-                    reference_clause: reference_clause,
-                    file_path: Pathname.new(exp_annotated_path)
-                                .relative_path_from(stepmod_path),
-                    language_code: "en",
-                  )
-
-                  next unless concept
+            arm_schema, arm_concepts = parse_annotated_module(
+              type: :arm,
+              stepmod_path: stepmod_path,
+              path: "modules/#{schema_name}/arm_annotated.exp",
+              bibdata: bibdata
+            )
 
-                  current_part_modules_arm[schema.id] ||=
-                    Glossarist::Collection.new
-                  find_or_initialize_concept(
-                    current_part_modules_arm[schema.id], concept
-                  )
+            mim_schema, mim_concepts = parse_annotated_module(
+              type: :mim,
+              stepmod_path: stepmod_path,
+              path: "modules/#{schema_name}/mim_annotated.exp",
+              bibdata: bibdata
+            )
 
-                  # puts part_modules_arm.inspect
-                  parsed_bibliography << bibdata
-                end
-              end
+            if arm_concepts.to_a.size > 0
+              current_part_modules_arm[arm_schema] = arm_concepts
             end
 
-            mim_exp_annotated_path = "#{stepmod_path}/modules/#{schema_name}/mim_annotated.exp"
-
-            log "INFO: Processing modules schema #{mim_exp_annotated_path}"
-
-            if File.exists?(mim_exp_annotated_path)
-              repo = Expressir::Express::Parser.from_file(mim_exp_annotated_path)
-
-              repo.schemas.each do |schema|
-                schema.entities.each do |entity|
-                  old_definition = entity.remarks.first
-
-                  domain = "application module: #{schema.id}"
-                  definition = generate_entity_definition(entity, domain, old_definition)
-
-                  reference_anchor = bibdata.anchor
-                  reference_clause = nil
-
-                  concept = Stepmod::Utils::Concept.new(
-                    designations: [entity.id],
-                    definition: old_definition,
-                    converted_definition: definition,
-                    id: "#{reference_anchor}.#{reference_clause}",
-                    reference_anchor: reference_anchor,
-                    reference_clause: reference_clause,
-                    file_path: Pathname.new(exp_annotated_path)
-                                .relative_path_from(stepmod_path),
-                    language_code: "en",
-                  )
-
-                  next unless concept
-
-                  current_part_modules_mim[schema.id] ||=
-                    Glossarist::Collection.new
-                  find_or_initialize_concept(
-                    current_part_modules_mim[schema.id], concept
-                  )
-
-                  parsed_bibliography << bibdata
-                end
-              end
+            if mim_concepts.to_a.size > 0
+              current_part_modules_mim[mim_schema] = mim_concepts
             end
-
           end
 
           log "INFO: Completed processing XML file #{fpath}"
@@ -386,13 +313,74 @@ module Stepmod
 
           if (current_part_modules_arm.to_a.size +
               current_part_modules_mim.to_a.size).positive?
+
             part_modules << [bibdata, current_part_modules_arm,
                              current_part_modules_mim]
+            parsed_bibliography << bibdata
           end
 
         end
       end
 
+      def parse_annotated_module(type:, stepmod_path:, path:, bibdata:)
+        log "INFO: parse_annotated_module: Processing modules schema #{path}"
+
+        fpath = File.join(stepmod_path, path)
+
+        unless File.exists?(fpath)
+          log "ERROR: parse_annotated_module: No module schema exists at #{fpath}."
+          return
+        end
+
+        repo = Expressir::Express::Parser.from_file(fpath)
+
+        unless repo
+          log "ERROR: parse_annotated_module: failed to parse EXPRESS file at #{path}."
+          return
+        end
+
+        # See: metanorma/iso-10303-2#90
+        domain_prefix = case type
+        when :mim
+          "application module"
+        when :arm
+          "application object"
+        end
+
+        if repo.schemas.length > 1
+          raise StandardError.new(
+            "ERROR: FATAL: #{fpath} contains more than one schema:" +
+            "#{repo.schemas.map(&:id).join(", ")} (not supposed to happen!!)"
+          )
+        end
+
+        schema = repo.schemas.first
+        collection = Glossarist::Collection.new
+        domain = "#{domain_prefix}: #{schema.id}"
+
+        schema.entities.each do |entity|
+          old_definition = entity.remarks.first
+          new_definition = generate_entity_definition(entity, domain, old_definition)
+
+          concept = Stepmod::Utils::Concept.new(
+            designations: [entity.id],
+            definition: old_definition,
+            converted_definition: new_definition,
+            # TODO: Find a proper ID for this
+            id: "#{bibdata.anchor}.",
+            reference_anchor: bibdata.anchor,
+            reference_clause: nil,
+            file_path: path,
+            language_code: "en",
+          )
+
+          next unless concept
+          find_or_initialize_concept(collection, concept)
+        end
+
+        [schema.id, collection]
+      end
+
       def find_or_initialize_concept(collection, localized_concept)
         concept = collection
           .store(Glossarist::Concept.new(id: SecureRandom.uuid))
@@ -456,7 +444,9 @@ module Stepmod
         combined.gsub!(/\n\/\/.*?\n/, "\n")
         combined.strip!
 
-        combined
+        express_reference_to_mention(combined)
+
+        # combined
         # # TODO: If the definition contains a list immediately after the first paragraph, don't split
         # return definition if definition =~ /\n\* /
 
@@ -473,44 +463,48 @@ module Stepmod
         # end
       end
 
+      # Replace `<<express:{schema}.{entity},{render}>>` with {{entity,render}}
+      def express_reference_to_mention(description)
+        # TODO: Use Expressir to check whether the "entity" is really an
+        # EXPRESS ENTITY. If not, skip the mention.
+        description.gsub(/<<express:([^,]+),([^>]+)>>/) do |match|
+          "{{#{Regexp.last_match[1].split('.').last},#{Regexp.last_match[2]}}}"
+        end
+      end
+
       def entity_name_to_text(entity_id)
         entity_id.downcase.gsub(/_/, " ")
       end
 
+      def entity_ref(entity_id)
+        if entity_id == entity_name_to_text(entity_id)
+          "{{#{entity_id}}}"
+        else
+          "{{#{entity_id},#{entity_name_to_text(entity_id)}}}"
+        end
+      end
+
       # rubocop:disable Layout/LineLength
       def generate_entity_definition(entity, domain, old_definition)
         return "" if entity.nil?
 
         # See: metanorma/iso-10303-2#90
-        # TODO: This is not DRY in case we have to further customize
-        entity_text = if domain =~ /\Aapplication object:/
-
-          if entity.subtype_of.size.zero?
-            "application object that represents the " +
-            "{{#{entity.id},#{entity_name_to_text(entity.id)}}} entity"
-          else
-            entity_subtypes = entity.subtype_of.map do |e|
-              "{{#{e.id},#{entity_name_to_text(e.id)}}}"
-            end
-            "application object that is a type of " +
-            "#{entity_subtypes.join(' and ')} that represents the " +
-            "{{#{entity.id},#{entity_name_to_text(entity.id)}}} entity"
-          end
-
+        entity_type = if domain_type = domain.match(/\A(application object):/)
+          domain_type[1]
         else
+          "entity data type"
+        end
 
-          # Not "application object"
-          if entity.subtype_of.size.zero?
-            "entity data type that represents " +
-            entity.id.indefinite_article + " {{#{entity.id}}} entity"
-          else
-            entity_subtypes = entity.subtype_of.map do |e|
-              "{{#{e.id}}}"
-            end
-            "entity data type that is a type of "+
-            "#{entity_subtypes.join(' and ')} that represents " +
-            entity.id.indefinite_article + " {{#{entity.id}}} entity"
+        entity_text = if entity.subtype_of.size.zero?
+          "#{entity_type} " +
+          "that represents the " + entity_ref(entity.id) + " entity"
+        else
+          entity_subtypes = entity.subtype_of.map do |e|
+            "{{#{e.id}}}"
           end
+          "#{entity_type} that is a type of " +
+          "#{entity_subtypes.join(' and ')} " +
+          "that represents the " + entity_ref(entity.id) + " entity"
         end
 
         definition = <<~DEFINITION
@@ -521,6 +515,7 @@ module Stepmod
 
         DEFINITION
 
+        # If there is a definition, we add it as the first NOTE
         unless old_definition.nil? || old_definition.blank?
           old_definition = trim_definition(old_definition)
 

data/lib/stepmod/utils/version.rb

@@ -1,5 +1,5 @@
 module Stepmod
   module Utils
-    VERSION = "0.3.19".freeze
+    VERSION = "0.3.22".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepmod-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.19
+  version: 0.3.22
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-10 00:00:00.000000000 Z
+date: 2022-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby