expressir 2.1.29 → 2.1.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbc607242e5dfe5db0276c14d37cdc1d38fc07e4f0014134b20105e443a3b96c
-  data.tar.gz: 32ba2fe11da1f6439b7a97e30215df127aa6826ae6199f205fa4376c7624a4d2
+  metadata.gz: 8b14a8f31cc94d89bc7229adf4ceb23a0180bc9bdf36e01024b7f1b27b638a9f
+  data.tar.gz: 249f65e92a803eac2a10a9c0717104e4e194d19b7fe30374f733e48b8807ab01
 SHA512:
-  metadata.gz: 06e09081cbb49ef2d4656e8f9104c830edf8fc0427ffbcef0f6fa686884468e561370656d74b3c0f893b1786e0e9d4d4d8f335d297e9e3ddb8211d9bc26bbfd1
-  data.tar.gz: 15350b06e45e272b7b7dbaee29c5030b794e67a30544344bf534ec2b86c89998fcb1123c1352201d4d41f217f8e11c3054f5e0ef3f94fccb96b3daa42aacda82
+  metadata.gz: 7dbf61a6903ef0317b98fcbfd3b5056258b263001e81cf9150aa52a3712e7b040e2289fb8b779d1843428617f5b29002de4deb79775aa0e28182488d14ca8f2f
+  data.tar.gz: c1c6057d4618d4caf1c6af8ad39cf3c165e3ecbebc6894ffc98b47c777ec19b3a0c6c91798fcb055be3a8cc6d1e46bc69e128de87db1a512f9069d6281e3c19f

data/.rubocop_todo.yml

@@ -1,57 +1,18 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-10-15 09:12:23 UTC using RuboCop version 1.81.1.
+# on 2025-10-16 03:45:37 UTC using RuboCop version 1.81.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: with_first_argument, with_fixed_indentation
-Layout/ArgumentAlignment:
-  Exclude:
-    - 'lib/expressir/commands/changes_import_eengine.rb'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleAlignWith.
-# SupportedStylesAlignWith: either, start_of_block, start_of_line
-Layout/BlockAlignment:
-  Exclude:
-    - 'lib/expressir/commands/changes_import_eengine.rb'
-    - 'spec/expressir/commands/changes_import_eengine_spec.rb'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-Layout/BlockEndNewline:
-  Exclude:
-    - 'lib/expressir/commands/changes_import_eengine.rb'
-    - 'spec/expressir/commands/changes_import_eengine_spec.rb'
-
-# Offense count: 8
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Width, AllowedPatterns.
-Layout/IndentationWidth:
-  Exclude:
-    - 'lib/expressir/commands/changes_import_eengine.rb'
-    - 'spec/expressir/commands/changes_import_eengine_spec.rb'
-
-# Offense count: 569
+# Offense count: 562
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
 Layout/LineLength:
   Enabled: false
 
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowInHeredoc.
-Layout/TrailingWhitespace:
-  Exclude:
-    - 'lib/expressir/commands/changes_import_eengine.rb'
-
 # Offense count: 1
 # Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
 Lint/DuplicateBranch:
@@ -67,7 +28,7 @@ Lint/UnusedMethodArgument:
     - 'lib/expressir/express/cache.rb'
     - 'lib/expressir/express/parser.rb'
 
-# Offense count: 83
+# Offense count: 84
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Enabled: false
@@ -96,7 +57,7 @@ Metrics/CyclomaticComplexity:
     - 'lib/expressir/model/model_element.rb'
     - 'spec/support/model_element_helper.rb'
 
-# Offense count: 113
+# Offense count: 114
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 106
@@ -172,18 +133,6 @@ RSpec/RepeatedExample:
   Exclude:
     - 'spec/expressir/model/data_types/logical_spec.rb'
 
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
-# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
-# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
-# FunctionalMethods: let, let!, subject, watch
-# AllowedMethods: lambda, proc, it
-Style/BlockDelimiters:
-  Exclude:
-    - 'lib/expressir/commands/changes_import_eengine.rb'
-    - 'spec/expressir/commands/changes_import_eengine_spec.rb'
-
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, AllowComments.

data/README.adoc

@@ -745,8 +745,8 @@ The import command:
 
 When the output file already exists:
 
-* **Same version**: Replaces the existing edition with that version
-* **New version**: Adds a new edition to the file
+* **Same version**: Replaces the existing version with that version
+* **New version**: Adds a new version to the file
 
 This allows you to build up a complete change history incrementally across
 multiple schema versions.
@@ -816,14 +816,14 @@ This creates a single YAML file tracking changes across all three versions:
 [source,yaml]
 ----
 schema: action_schema
-editions:
-- version: '2'
+versions:
+- version: 2
   description: Changes from eengine comparison
   additions: [...]
-- version: '3'
+- version: 3
   description: Changes from eengine comparison
   additions: [...]
-- version: '4'
+- version: 4
   description: Changes from eengine comparison
   additions: [...]
 ----
@@ -1236,7 +1236,7 @@ The Changes module enables:
 
 * Loading and saving schema change records from/to YAML files
 * Programmatic creation and manipulation of change records
-* Smart edition handling (replace same version, add new version)
+* Smart version handling (replace same version, add new version)
 * Support for all change types: additions, modifications, deletions
 * Support for mapping changes in ARM/MIM schemas
 * Programmatic import from Express Engine comparison XML files
@@ -1278,7 +1278,7 @@ change_schema = Expressir::Commands::ChangesImportEengine.from_xml(
 )
 
 # Use the SchemaChange object
-change_schema.editions.first.additions.each do |item|
+change_schema.versions.first.additions.each do |item|
   puts "#{item.type}: #{item.name}"
   puts "  interfaced_items: #{item.interfaced_items}" if item.interfaced_items
 end
@@ -1392,8 +1392,8 @@ This will be converted to EXPRESS Changes YAML as:
 [source,yaml]
 ----
 schema: aic_csg
-editions:
-- version: '2'
+versions:
+- version: 2
   description: Changes from eengine comparison
   additions:
   - type: USE_FROM
@@ -1453,14 +1453,14 @@ change_schema = Expressir::Changes::SchemaChange.from_file("schema.changes.yaml"
 # Access schema name
 puts "Schema: #{change_schema.schema}"
 
-# Iterate through change editions
-change_schema.editions.each do |edition|
-  puts "Version #{edition.version}: #{edition.description}"
+# Iterate through change versions
+change_schema.versions.each do |version|
+  puts "Version #{version.version}: #{version.description}"
 
   # Access changes by type
-  puts "  Additions: #{edition.additions.size}" if edition.additions
-  puts "  Modifications: #{edition.modifications.size}" if edition.modifications
-  puts "  Deletions: #{edition.deletions.size}" if edition.deletions
+  puts "  Additions: #{version.additions.size}" if version.additions
+  puts "  Modifications: #{version.modifications.size}" if version.modifications
+  puts "  Deletions: #{version.deletions.size}" if version.deletions
 end
 ----
 
@@ -1485,14 +1485,14 @@ modified_function = Expressir::Changes::ItemChange.new(
   description: "Updated parameters"
 )
 
-# Add a change edition
+# Add a change version
 changes = {
   additions: [new_entity],
   modifications: [modified_function],
   deletions: []
 }
 
-change_schema.add_or_update_edition(
+change_schema.add_or_update_version(
   "2",
   "Added new entity and modified function",
   changes
@@ -1504,10 +1504,10 @@ change_schema.to_file("my_schema.changes.yaml")
 
 === Updating existing change files
 
-The `add_or_update_edition` method provides smart handling:
+The `add_or_update_version` method provides smart handling:
 
-* **Same version**: Replaces the existing edition
-* **Different version**: Adds a new edition
+* **Same version**: Replaces the existing version
+* **Different version**: Adds a new version
 
 [source,ruby]
 ----
@@ -1520,10 +1520,10 @@ changes = {
     Expressir::Changes::ItemChange.new(type: "TYPE", name: "updated_type")
   ]
 }
-change_schema.add_or_update_edition("3", "Modified type definition", changes)
+change_schema.add_or_update_version("3", "Modified type definition", changes)
 
 # Or replace existing version
-change_schema.add_or_update_edition("2", "Revised description", changes)
+change_schema.add_or_update_version("2", "Revised description", changes)
 
 # Save changes
 change_schema.to_file("schema.changes.yaml")
@@ -1547,9 +1547,9 @@ item = Expressir::Changes::ItemChange.new(
 )
 ----
 
-=== Change edition fields
+=== Change version fields
 
-Change editions support categorizing changes into:
+Change versions support categorizing changes into:
 
 `additions`:: New elements added to the schema
 `modifications`:: Existing elements that were modified
@@ -1559,7 +1559,7 @@ Change editions support categorizing changes into:
 
 [source,ruby]
 ----
-edition = Expressir::Changes::EditionChange.new(
+version = Expressir::Changes::VersionChange.new(
   version: "2",
   description: "Added support for new functionality",
   additions: [item1, item2],
@@ -1586,8 +1586,8 @@ mapping_change = Expressir::Changes::MappingChange.new(
 ----
 ---
 schema: support_resource_schema
-editions:
-- version: '2'
+versions:
+- version: 2
   description: |-
     The definitions of the following EXPRESS entity data types were modified:
 
@@ -1600,7 +1600,7 @@ editions:
   modifications:
   - type: FUNCTION
     name: bag_to_set
-- version: '4'
+- version: 4
   description: |-
     Added support for external element references.
   additions:

data/lib/expressir/changes/schema_change.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 require "lutaml/model"
-require_relative "edition_change"
+require_relative "version_change"
 
 module Expressir
   module Changes
     # Represents changes to an EXPRESS schema across multiple versions
     class SchemaChange < Lutaml::Model::Serializable
       attribute :schema, :string
-      attribute :editions, EditionChange, collection: true
+      attribute :versions, VersionChange, collection: true
 
       yaml do
         map "schema", to: :schema
-        map "editions", to: :editions
+        map "versions", to: :versions
       end
 
       class << self
@@ -23,32 +23,40 @@ module Expressir
         def from_file(path)
           content = File.read(path)
           # Handle empty or minimal YAML files
+          # Skip leading comments and empty lines
+          lines = content.lines
+          yaml_start_index = lines.find_index do |line|
+            !line.strip.start_with?("#") && !line.strip.empty?
+          end
+
+          if yaml_start_index
+            content = lines[yaml_start_index..].join
+          end
+
           return new if content.strip == "---" || content.strip.empty?
 
           from_yaml(content)
         end
       end
 
-      # Add or update a change edition in this schema
+      # Add or update a change version in this schema
       #
       # @param version [String] Version number
       # @param description [String] Description of changes
       # @param changes [Hash] Hash with :additions, :modifications, :deletions
-      # @return [EditionChange] The added or updated edition
-      def add_or_update_edition(version, description, changes)
-        version_str = version.to_s
-
-        # Initialize editions array if nil
-        self.editions ||= []
+      # @return [VersionChange] The added or updated version
+      def add_or_update_version(version, description, changes)
+        # Initialize versions array if nil
+        self.versions ||= []
 
-        # Find existing edition with this version
-        existing_index = editions.find_index do |ed|
-          ed.version == version_str
+        # Find existing version with this version
+        existing_index = versions.find_index do |ed|
+          ed.version == version
         end
 
-        # Create new edition
-        edition = EditionChange.new(
-          version: version_str,
+        # Create new version
+        version = VersionChange.new(
+          version: version,
           description: description,
           additions: changes[:additions] || [],
           modifications: changes[:modifications] || [],
@@ -56,14 +64,14 @@ module Expressir
         )
 
         if existing_index
-          # Replace existing edition with same version
-          editions[existing_index] = edition
+          # Replace existing version with same version
+          versions[existing_index] = version
         else
-          # Add new edition
-          editions << edition
+          # Add new version
+          versions << version
         end
 
-        edition
+        version
       end
 
       # Save this SchemaChange to a YAML file
@@ -71,7 +79,9 @@ module Expressir
       # @param path [String] Path where to save the file
       # @return [Integer] Number of bytes written
       def to_file(path)
-        File.write(path, to_yaml)
+        # Add schema hint for editor support
+        content = "# yaml-language-server: $schema=https://www.expresslang.org/schemas/changes/v1/schema_changes.yaml\n#{to_yaml}"
+        File.write(path, content)
       end
     end
   end

data/lib/expressir/changes/{edition_change.rb → version_change.rb}

@@ -6,9 +6,9 @@ require_relative "mapping_change"
 
 module Expressir
   module Changes
-    # Represents a version edition of schema changes
-    class EditionChange < Lutaml::Model::Serializable
-      attribute :version, :string
+    # Represents a version version of schema changes
+    class VersionChange < Lutaml::Model::Serializable
+      attribute :version, :integer
       attribute :description, :string
       attribute :additions, ItemChange, collection: true
       attribute :modifications, ItemChange, collection: true

data/lib/expressir/commands/changes_import_eengine.rb

@@ -70,8 +70,8 @@ module Expressir
           change_schema = options[:existing_schema] ||
             Expressir::Changes::SchemaChange.new(schema: schema_name)
 
-          # No edition-level description from eengine (only item-level)
-          change_schema.add_or_update_edition(version, nil, changes)
+          # No version-level description from eengine (only item-level)
+          change_schema.add_or_update_version(version, nil, changes)
 
           change_schema
         end

data/lib/expressir/commands/changes_validate.rb

@@ -31,7 +31,7 @@ module Expressir
 
           say "✓ File is valid" if options[:verbose]
           say "  Schema: #{schema_change.schema}" if options[:verbose]
-          say "  Editions: #{schema_change.editions.length}" if options[:verbose]
+          say "  Versions: #{schema_change.versions.length}" if options[:verbose]
 
           # Normalize if requested
           if options[:normalize]

data/lib/expressir/version.rb

@@ -1,3 +1,3 @@
 module Expressir
-  VERSION = "2.1.29".freeze
+  VERSION = "2.1.30".freeze
 end

data/lib/expressir.rb

@@ -180,7 +180,7 @@ module Expressir
   # Autoload for Changes module classes
   module Changes
     autoload :SchemaChange, "expressir/changes/schema_change"
-    autoload :EditionChange, "expressir/changes/edition_change"
+    autoload :VersionChange, "expressir/changes/version_change"
     autoload :ItemChange, "expressir/changes/item_change"
     autoload :MappingChange, "expressir/changes/mapping_change"
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expressir
 version: !ruby/object:Gem::Version
-  version: 2.1.29
+  version: 2.1.30
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-15 00:00:00.000000000 Z
+date: 2025-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -184,10 +184,10 @@ files:
 - lib/expressir.rb
 - lib/expressir/benchmark.rb
 - lib/expressir/changes.rb
-- lib/expressir/changes/edition_change.rb
 - lib/expressir/changes/item_change.rb
 - lib/expressir/changes/mapping_change.rb
 - lib/expressir/changes/schema_change.rb
+- lib/expressir/changes/version_change.rb
 - lib/expressir/cli.rb
 - lib/expressir/commands/base.rb
 - lib/expressir/commands/benchmark.rb