parse_packwerk 0.26.1 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8a164633cf3c023e6e03baf4c10b26d90e2a3368608634f3fcf6461c0481c03
-  data.tar.gz: 0665b72ca8fb6b2fe68260237fa538e51e6438c088fcd6f27effca17f9f8893e
+  metadata.gz: c4fc93d51bdc321a094c0bf2b0bd7f3f062321e111533162e72281cb328286cd
+  data.tar.gz: 04aeeefa87b28e5052dce0af43cae614a31c5395981b86cc2f23454b81fe133c
 SHA512:
-  metadata.gz: c296d5665936ab7c1a1ecbdfe227c08eeb1beccb5ee404fc6e484bc4e0e52f28c5e07a9ab83f60ee652c1adab3a3aca2de42eb01551f6633b07a8a22e2778b25
-  data.tar.gz: f2e03bb5dceb25ee141dc31985f4adcc58f93110bf3ae44e0e46e4e9c9531e06fb39b50a85e838e981ce5716d7094ede734179a1f1851d6c3baff4b89506721d
+  metadata.gz: ba7306916ccb40c76681157deec579b2f9f3c911e41811c83e509620b29b504525a15183e3b4a20a2233dfe5e4f9f36a5e2b55f50c4188606d9129339143a09d
+  data.tar.gz: 588d4b9695c2726f617197e10b8ba9315e74192debf423840dfbda942e023bfdb9ec50a74db85cd5cfadb585acce5a0ff306515a8a5395e6d1fbb2a1c40cf215

data/lib/parse_packwerk/configuration.rb

@@ -1,4 +1,5 @@
 # typed: strict
+# frozen_string_literal: true
 
 module ParsePackwerk
   class Configuration < T::Struct

data/lib/parse_packwerk/constants.rb

@@ -1,18 +1,20 @@
 # typed: strict
+# frozen_string_literal: true
 
 module ParsePackwerk
-  ROOT_PACKAGE_NAME = T.let('.'.freeze, String)
-  PACKAGE_YML_NAME = T.let('package.yml'.freeze, String)
-  PACKWERK_YML_NAME = T.let('packwerk.yml'.freeze, String)
-  PACKAGE_TODO_YML_NAME = T.let('package_todo.yml'.freeze, String)
-  ENFORCE_DEPENDENCIES = T.let('enforce_dependencies'.freeze, String)
-  ENFORCE_PRIVACY = T.let('enforce_privacy'.freeze, String)
-  ENFORCE_LAYERS = T.let('enforce_layers'.freeze, String)
-  DEPENDENCY_VIOLATION_TYPE = T.let('dependency'.freeze, String)
-  PRIVACY_VIOLATION_TYPE = T.let('privacy'.freeze, String)
-  PUBLIC_PATH = T.let('public_path'.freeze, String)
-  METADATA = T.let('metadata'.freeze, String)
-  DEPENDENCIES = T.let('dependencies'.freeze, String)
+  ROOT_PACKAGE_NAME = T.let('.', String)
+  PACKAGE_YML_NAME = T.let('package.yml', String)
+  PACKWERK_YML_NAME = T.let('packwerk.yml', String)
+  PACKAGE_TODO_YML_NAME = T.let('package_todo.yml', String)
+  ENFORCE_DEPENDENCIES = T.let('enforce_dependencies', String)
+  ENFORCE_PRIVACY = T.let('enforce_privacy', String)
+  ENFORCE_LAYERS = T.let('enforce_layers', String)
+  DEPENDENCY_VIOLATION_TYPE = T.let('dependency', String)
+  PRIVACY_VIOLATION_TYPE = T.let('privacy', String)
+  PUBLIC_PATH = T.let('public_path', String)
+  OWNER = T.let('owner', String)
+  METADATA = T.let('metadata', String)
+  DEPENDENCIES = T.let('dependencies', String)
 
   # Since this metadata is unstructured YAML, it could be any type. We leave it to clients of `ParsePackwerk::Package`
   # to add types based on their known usage of metadata.

data/lib/parse_packwerk/extensions.rb

@@ -1,4 +1,5 @@
 # typed: strict
+# frozen_string_literal: true
 
 module ParsePackwerk
   module Extensions

data/lib/parse_packwerk/package.rb

@@ -1,4 +1,5 @@
 # typed: strict
+# frozen_string_literal: true
 
 module ParsePackwerk
   class Package < T::Struct
@@ -13,11 +14,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 +33,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
 
@@ -66,5 +72,29 @@ module ParsePackwerk
     def enforces_layers?
       enforce_layers
     end
+
+    # `owner` is read from `config` rather than stored as a prop, so edits through `config` and `with(owner:)` can't disagree.
+    # Only the top-level key is read. Unlike `CodeOwnership.for_package`, this doesn't fall back to `metadata.owner`.
+    sig { returns(T.nilable(String)) }
+    def owner
+      owner = config[OWNER]
+      owner if owner.is_a?(String)
+    end
+
+    sig { params(changed_props: T::Hash[Symbol, T.untyped]).returns(Package) }
+    def with(changed_props)
+      return super unless changed_props.key?(:owner)
+
+      changes = changed_props.dup
+      new_owner = T.let(changes.delete(:owner), T.nilable(String))
+      # Edit the copy `super` returns rather than passing `config:` to it, which would stringify every nested key in the file.
+      super(changes).tap do |package|
+        if new_owner.nil?
+          package.config.delete(OWNER)
+        else
+          package.config[OWNER] = new_owner
+        end
+      end
+    end
   end
 end

data/lib/parse_packwerk/package_todo.rb

@@ -1,4 +1,5 @@
 # typed: strict
+# frozen_string_literal: true
 
 module ParsePackwerk
   class PackageTodo < T::Struct

data/lib/parse_packwerk/violation.rb

@@ -1,4 +1,5 @@
 # typed: strict
+# frozen_string_literal: true
 
 module ParsePackwerk
   class Violation < T::Struct

data/lib/parse_packwerk.rb

@@ -1,4 +1,5 @@
 # typed: strict
+# frozen_string_literal: true
 
 require 'sorbet-runtime'
 require 'yaml'
@@ -31,6 +32,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 +104,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 +112,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parse_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.26.1
+  version: 0.28.0
 platform: ruby
 authors:
 - Gusto Engineers
@@ -194,14 +194,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A low-dependency gem for parsing and writing packwerk YML files
 test_files: []