suma 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52836adb9e003f9d760a6c015207379be88b8821855d64388a5f30d09474de7e
-  data.tar.gz: d7427de3e6dc21291671122bd07bc23c739e4f59f031e3b02988f89254767d00
+  metadata.gz: 955161f5bfcd18f46e1fcafafdc05bea5a7310eaa8899b03552e7d22f6f41795
+  data.tar.gz: ff06abeaf766ce76d814079ef718c6deb45e1dd0cae5d89e9d03d203e3a5635d
 SHA512:
-  metadata.gz: c0de4abdc501a6dba9b716e7ad9a15f66985bec98b2978c9f1b25ed0f069d02d8a172f8b78c442e8f90e32098ad1622a3ba16a890c2ed57d896c4c2b427c5c3e
-  data.tar.gz: ed0f32387285db507797e7b34962a20e4dc6174e7389ffa2488afb8724668c11d1e0089e9e2b62a958875e0e2bb9d7f4976d5d0ef887cd83604acb4939d25b7a
+  metadata.gz: 2568587bc47fe2eb892fc7e9f8f4981aceaa06eef4b27ad54cb427e9082cc23571a2c26f8ae9380dfcd52fbb40f38a77ad0d2282e7ada54d8744e3e21edcd301
+  data.tar.gz: 4b8505d33b3eef150aeb76f23548f5983740d1940488a0ee1c7d6e515cd249e5fa74fbdadb72543a91104ca9ce609eb0f374dd01c033db8eee2bb7585525b09f

data/.gitignore

@@ -9,3 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
+.rubocop_todo.yml
+.rubocop-https---*-yml
+.ruby-version
+Gemfile.lock

data/lib/suma/cli/extract_terms.rb

@@ -12,6 +12,17 @@ module Suma
     # ExtractTerms command using Expressir to extract terms into the
     # Glossarist v2 format
     class ExtractTerms < Thor
+      # Matches patterns like "A thing is a type of {{entity}}." or
+      # "An object is a type of a {{entity}}"
+      REDUNDANT_NOTE_REGEX =
+        %r{
+          ^An?                   # Starts with "A" or "An"
+          \s.*?\sis\sa\stype\sof # Text followed by "is a type of"
+          (\sa|\san)?            # Optional " a" or " an"
+          \s\{\{[^\}]*\}\}       # Text in double curly braces
+          \s*?\.?$               # Optional whitespace and period at the end
+        }x
+
       desc "extract_terms SCHEMA_MANIFEST_FILE GLOSSARIST_OUTPUT_PATH",
            "Extract terms from SCHEMA_MANIFEST_FILE into " \
            "Glossarist v2 format"
@@ -129,11 +140,12 @@ module Suma
           data.sources = [source_ref] if source_ref
 
           # Only assign optional fields if they have content
-          notes = get_entity_notes(entity, schema_domain)
+          notes = get_entity_notes(entity, schema_domain, data.definition)
           data.notes = notes if notes && !notes.empty?
 
-          examples = get_entity_examples(entity, schema_domain)
-          data.examples = examples if examples && !examples.empty?
+          # examples = get_entity_examples(entity, schema_domain)
+          # data.examples = examples if examples && !examples.empty?
+          data.examples = []
         end
 
         Glossarist::LocalizedConcept.new.tap do |concept|
@@ -245,9 +257,20 @@ module Suma
         [Glossarist::DetailedDefinition.new(content: definition)]
       end
 
-      def get_entity_notes(entity, schema_domain)
+      def get_entity_notes(entity, schema_domain, definitions)
+        puts "Extracting notes for entity: #{entity.id}"
         notes = []
 
+        notes = add_entity_notes(entity, schema_domain, notes)
+        # notes = add_other_notes(entity, schema_domain, notes)
+        notes = only_keep_first_sentence(notes)
+        notes = remove_see_content(notes)
+        notes = remove_redundant_note(notes)
+        notes = remove_invalid_references(notes)
+        compare_with_definitions(notes, definitions)
+      end
+
+      def add_entity_notes(entity, schema_domain, notes)
         # Add trimmed definition from entity description as first note
         if entity.remarks && !entity.remarks.empty?
           trimmed_def = trim_definition(entity.remarks)
@@ -258,7 +281,11 @@ module Suma
           end
         end
 
-        # Add other notes
+        notes.compact
+      end
+
+      def add_other_notes(entity, schema_domain, notes)
+        # Add other notes from entity remarks
         other_notes = [
           entity.remark_items&.select do |ri|
             ri.id == "__note"
@@ -274,6 +301,67 @@ module Suma
         notes
       end
 
+      # https://github.com/metanorma/iso-10303/issues/621
+      # 1. First sentence in first paragraph of the entity description
+      # (in EXPRESS remark) becomes NOTE 1 in ISO 10303-2 of the entity.
+      def only_keep_first_sentence(notes)
+        notes.each do |note|
+          # Split by period and take the first sentence
+          # Avoid splitting by pattern like "abc.def"
+          if note&.content
+            new_content = note.content
+              .split(".\n").first.strip
+              .split(". ").first.strip
+            note.content = if new_content.end_with?(".")
+                             new_content
+                           else
+                             "#{new_content}."
+                           end
+          end
+        end
+      end
+
+      # https://github.com/metanorma/iso-10303/issues/621
+      # 2. If this first sentence matches the 7-word magic sentence
+      # (2-3 forms of that), it is discarded so there will not be a NOTE 1.
+      def compare_with_definitions(notes, definitions)
+        if notes&.first&.content == definitions&.first&.content
+          # Discarding first note as it matches the definition
+          return []
+        end
+
+        notes
+      end
+
+      # https://github.com/metanorma/iso-10303/issues/621
+      # 3. No reference to any types or attribute or figures allowed in first
+      # sentence. Entity references “{{…}}” are allowed.
+      def remove_invalid_references(notes)
+        notes.reject do |note|
+          note.content.include?("image::") ||
+            note.content.match?(/<<(.*?){1,999}>>/)
+        end
+      end
+
+      # https://github.com/metanorma/iso-10303/issues/621
+      # 4. Entity notes and examples in EXPRESS remarks are NOT represented in
+      # part 2.
+      def remove_redundant_note(notes)
+        notes.reject do |note|
+          note.content.match?(REDUNDANT_NOTE_REGEX) &&
+            !note.content.include?("\n")
+        end
+      end
+
+      # https://github.com/metanorma/iso-10303/issues/621
+      # 5. If the sentence contains “\s+(see …)”, the contents including the
+      # parentheses are removed.
+      def remove_see_content(notes)
+        notes.each do |note|
+          note.content = note.content.gsub(/\s+\(see(.*?){1,999}\)/, "")
+        end
+      end
+
       def get_entity_examples(entity, schema_domain)
         examples = entity.remark_items&.select do |ri|
           ri.id == "__example"
@@ -382,13 +470,18 @@ module Suma
       end
       # rubocop:enable Metrics/MethodLength
 
-      # Replace `<<express:{schema}.{entity},{render}>>` with {{entity,render}}
+      # Replace `<<express:{schema}.{entity}>>` with {{entity}}
+      # and `<<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
+        description
+          .gsub(/<<express:([^,]+)>>/) do |_match|
+            "{{#{Regexp.last_match[1].split('.').last}}}"
+          end.gsub(/<<express:([^,]+),([^>]+)>>/) do |_match|
+            "{{#{Regexp.last_match[1].split('.').last}," \
+              "#{Regexp.last_match[2]}}}"
+          end
       end
 
       def entity_name_to_text(entity_id)

data/lib/suma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Suma
-  VERSION = "0.1.15"
+  VERSION = "0.1.16"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suma
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-07 00:00:00.000000000 Z
+date: 2025-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: expressir