parse_packwerk 0.19.2 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83b58f930302d8a8c665a0308ab701ead4df9c44746dd5beda267e1c3ee7f8f8
-  data.tar.gz: 2151555e3ff73a42c1945cfcb08528ce312479129b4d19602d2e8c90523f58c6
+  metadata.gz: 54e72896efeae11785e34d5c4445255a7418499095d6f8f10443047437e49ad4
+  data.tar.gz: e722da109f4ef007f2b017d2fdbc4aba4cc6b09d94d8efb031cb7f4f7a1dae40
 SHA512:
-  metadata.gz: 6c1750166fa4c3e6676b295a3e31de05bcac13647b3cbcdfd90501124db728047723d9eb6fe44c65a1a338503d5219129fc6c2c849a24bbe6538821baaecdcc4
-  data.tar.gz: 2935097a35a353f7a57e4a7e09c27f337967a28cf6d9b06d4c5a21abdd5b7e8274724370a1e79ce965d9626d73104067a8f585aa0892874f88e9ac1ad66c8646
+  metadata.gz: 993a09365ac56439efba8c66c0892275a184969be156e9b33cd7e8d218ab00222f55f7488d888348bb73805b91b7b3a223d46e58236695c567628a175fbe4508
+  data.tar.gz: 7d7b919458f16a8c53038405a3e777552a92e1660a23312a288d4b0653ba59648314fd861be63b4c27f89b50975cb4bf24756538e40cadfbe803e5160c72f5d2

data/lib/parse_packwerk/configuration.rb

@@ -7,6 +7,7 @@ module ParsePackwerk
     const :exclude, T::Array[String]
     const :package_paths, T::Array[String]
     const :requires, T::Array[String]
+    const :raw, T::Hash[String, T.untyped]
 
     sig { returns(Configuration) }
     def self.fetch
@@ -22,7 +23,8 @@ module ParsePackwerk
       Configuration.new(
         exclude: excludes(raw_packwerk_config),
         package_paths: package_paths(raw_packwerk_config),
-        requires: raw_packwerk_config['require'] || []
+        requires: raw_packwerk_config['require'] || [],
+        raw: raw_packwerk_config
       )
     end
 

data/lib/parse_packwerk/package.rb

@@ -11,6 +11,7 @@ module ParsePackwerk
     const :metadata, MetadataYmlType
     const :dependencies, T::Array[String]
     const :config, T::Hash[T.untyped, T.untyped]
+    const :violations, T.nilable(T::Array[Violation])
 
     sig { params(pathname: Pathname).returns(Package) }
     def self.from(pathname)
@@ -29,9 +30,15 @@ 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
       )
     end
 
+    sig { params(package_name: String).returns(::Pathname) }
+    def self.directory(package_name)
+      Pathname.new(package_name).cleanpath
+    end
+
     sig { returns(Pathname) }
     def yml
       Pathname.new(name).join(PACKAGE_YML_NAME).cleanpath
@@ -39,7 +46,7 @@ module ParsePackwerk
 
     sig { returns(Pathname) }
     def directory
-      Pathname.new(name).cleanpath
+      self.class.directory(self.name)
     end
 
     sig { returns(Pathname) }
@@ -56,10 +63,5 @@ module ParsePackwerk
     def enforces_privacy?
       enforce_privacy
     end
-
-    sig { returns(T::Array[Violation]) }
-    def violations
-      PackageTodo.for(self).violations
-    end
   end
 end

data/lib/parse_packwerk/package_todo.rb

@@ -9,8 +9,7 @@ module ParsePackwerk
 
     sig { params(package: Package).returns(PackageTodo) }
     def self.for(package)
-      package_todo_yml_pathname = package.directory.join(PACKAGE_TODO_YML_NAME)
-      PackageTodo.from(package_todo_yml_pathname)
+      PackageTodo.from(self.yml(package.directory))
     end
 
     sig { params(pathname: Pathname).returns(PackageTodo) }
@@ -42,5 +41,10 @@ module ParsePackwerk
         )
       end
     end
+    
+    sig { params(dirname: Pathname).returns(Pathname) }
+    def self.yml(dirname)
+      dirname.join(PACKAGE_TODO_YML_NAME).cleanpath
+    end
   end
 end

data/lib/parse_packwerk.rb

@@ -72,17 +72,6 @@ module ParsePackwerk
         merged_config.merge!('enforce_privacy' => package.enforce_privacy)
       end
 
-      # We want checkers of the form `enforce_xyz` to be at the top
-      merged_config_arr = merged_config.sort_by do |k, v|
-        if k.include?('enforce')
-          0
-        else
-          1
-        end
-      end
-
-      merged_config = merged_config_arr.to_h
-
       unless package.public_path == DEFAULT_PUBLIC_PATH
         merged_config.merge!('public_path' => package.public_path)
       end
@@ -96,6 +85,10 @@ module ParsePackwerk
       if package.metadata.any?
         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
+
       raw_yaml = YAML.dump(merged_config)
       # Add indentation for dependencies
       raw_yaml.gsub!(/^- /,"  - ")
@@ -104,6 +97,23 @@ module ParsePackwerk
     end
   end
 
+  sig { returns(T::Array[String]) }
+  def self.key_sort_order
+    %w(
+      enforce_dependencies
+      enforce_privacy
+      enforce_visibility
+      enforce_architecture
+      public_path
+      owner
+      layer
+      dependencies
+      ignored_dependencies
+      visible_to
+      metadata
+    )
+  end
+
   # We memoize packages_by_name for fast lookup.
   # Since Graph is an immutable value object, we can create indexes and general caching mechanisms safely.
   sig { returns(T::Hash[String, Package]) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.20.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2023-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.16
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.16
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement