parse_packwerk 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae2ad46b918aca49713753383cc986754ae3e79d2be225e42659bca350b0a477
-  data.tar.gz: 9417fe06abcdd4bac2582c1b54950ae7653430d2a7a42fe761070b156d2c32c0
+  metadata.gz: 79acc78d3ab0fa35846a31222d63c225666c0114d5de463e2ba70305a557c278
+  data.tar.gz: 2e1449c7de0b3eed8ff8cae6c84f35cf9bdea252aa3f337c6021c1b3b5601a15
 SHA512:
-  metadata.gz: 13670c835593d15f5666a401af9d1100ab964029f8403654b59d7943416b1750f468459184f37a512c31c8cc0fc7870c251ea79c75e63eca924b293831e5c78c
-  data.tar.gz: 440a9a96e979537efd13fe8f3bb0f3f2d749c290c7d5e26cbfc476030891aa9f62c33a6d89fd678bce0699c300c1b0d1f9ba7051b08b7f3bc2526917867a0c7c
+  metadata.gz: f4dc8dbaff0b08207a38057713426707f9207175b73b1452346fb4fe4e8d504baf1baf87b19c840ef1e947314bce2bf5577e36a5b69e93621e5064497af2ac35
+  data.tar.gz: 826653675547ea46c3743e005f5025b41012f4e065e1ff2f68f52181705e6785585d44af0c4468ca81dffb1b6344e88291f02e745e15091df74e4fde185dd941

data/lib/parse_packwerk/configuration.rb

@@ -37,7 +37,13 @@ module ParsePackwerk
                    Array(specified_exclude)
                  end
 
-      excludes.push Bundler.bundle_path.join('**').to_s
+      begin
+        excludes.push Bundler.bundle_path.join('**').to_s
+      rescue Bundler::GemfileNotFound
+        # Optionally, add bundle to the path. Skip when there isn't a Gemfile.
+      end
+
+      excludes
     end
 
     sig { params(config_hash: T::Hash[T.untyped, T.untyped]).returns(T::Array[String]) }

data/lib/parse_packwerk/package.rb

@@ -13,11 +13,15 @@ module ParsePackwerk
     const :dependencies, T::Array[String]
     const :config, T::Hash[T.untyped, T.untyped]
     const :violations, T::Array[Violation]
+    # Stores the original key order from the YAML file for preserving order on write
+    const :original_key_order, T::Array[String], default: []
 
     sig { params(pathname: Pathname).returns(Package) }
     def self.from(pathname)
       package_loaded_yml = YAML.load_file(pathname) || {}
       package_name = pathname.dirname.cleanpath.to_s
+      # Capture the original key order from the YAML file
+      original_keys = package_loaded_yml.is_a?(Hash) ? package_loaded_yml.keys : []
 
       new(
         name: package_name,
@@ -28,7 +32,8 @@ module ParsePackwerk
         metadata: package_loaded_yml[METADATA] || {},
         dependencies: package_loaded_yml[DEPENDENCIES] || [],
         config: package_loaded_yml,
-        violations: PackageTodo.from(PackageTodo.yml(directory(package_name))).violations
+        violations: PackageTodo.from(PackageTodo.yml(directory(package_name))).violations,
+        original_key_order: original_keys
       )
     end
 

data/lib/parse_packwerk.rb

@@ -31,6 +31,19 @@ module ParsePackwerk
 
   extend T::Sig
 
+  # Configuration option to preserve the original key order when writing package.yml files.
+  # When true, keys will be written in their original order from the file rather than
+  # being sorted according to key_sort_order. This reduces diff churn when tools modify packages.
+  # Defaults to false for backwards compatibility.
+  @preserve_key_order = T.let(false, T::Boolean)
+
+  class << self
+    extend T::Sig
+
+    sig { returns(T::Boolean) }
+    attr_accessor :preserve_key_order
+  end
+
   sig do
     returns(T::Array[Package])
   end
@@ -90,8 +103,7 @@ module ParsePackwerk
         merged_config.merge!('metadata' => package.metadata)
       end
 
-      sorted_keys = key_sort_order
-      merged_config = merged_config.to_a.sort_by { |key, _value| T.unsafe(sorted_keys).index(key) || 1000 }.to_h
+      merged_config = sort_keys(merged_config, package.original_key_order)
 
       raw_yaml = YAML.dump(merged_config)
       stylized_yaml = raw_yaml.gsub("---\n", '')
@@ -99,6 +111,23 @@ module ParsePackwerk
     end
   end
 
+  sig { params(config: T::Hash[T.untyped, T.untyped], original_key_order: T::Array[String]).returns(T::Hash[T.untyped, T.untyped]) }
+  def self.sort_keys(config, original_key_order)
+    if preserve_key_order && original_key_order.any?
+      # Preserve original key order: existing keys stay in their original position,
+      # new keys are appended in the default sort order
+      existing_keys = original_key_order & config.keys
+      new_keys = config.keys - original_key_order
+      sorted_new_keys = new_keys.sort_by { |key| key_sort_order.index(key) || 1000 }
+
+      ordered_keys = existing_keys + sorted_new_keys
+      ordered_keys.each_with_object({}) { |key, hash| hash[key] = config[key] if config.key?(key) }
+    else
+      # Default behavior: sort by canonical key order
+      config.to_a.sort_by { |key, _value| T.unsafe(key_sort_order).index(key) || 1000 }.to_h
+    end
+  end
+
   sig { returns(T::Array[String]) }
   def self.key_sort_order
     %w[

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: parse_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Gusto Engineers
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -188,7 +187,6 @@ metadata:
   source_code_uri: https://github.com/rubyatscale/parse_packwerk
   changelog_uri: https://github.com/rubyatscale/parse_packwerk/releases
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,8 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A low-dependency gem for parsing and writing packwerk YML files
 test_files: []