parse_packwerk 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64542153d7eb3eb07ddd1328a7c312028485b962980122465b370a38407b6e60
-  data.tar.gz: b65eb3d71a0a1d1132cb53e4544bad7cfb62849655a9aa4e3d3b7914af1a1c85
+  metadata.gz: fbe9403aa70147a34d5eff8474bfa6d85d7ce224744adf7f0c9fb8fcbe38031c
+  data.tar.gz: 1eaa3eeed901bb517330f75ac2d9b12c4244410f7037d0c4095df218bb4d1cb1
 SHA512:
-  metadata.gz: e25be516533a00d4b2d673b1bede6ca828caa2088239fa40267649790bb92eda13865df8fae1d8146176684fb02625ae682e85d5c728bc29b5262b1d7fd44237
-  data.tar.gz: fc59491a8e19d6470a144d6d8c29f7c379d3a127f3578c01b6d49b23ff0635968315f1cfa976c593f3d6e0dbe96c36addf089b5b85bb28fe6b65e171f1069895
+  metadata.gz: fbc31cab6491b2f2d620c4529f9517446a0a180fe07c1cdc4eb5195b16bc3ce986f63f359421c5460742b49026daa64535c051679a6860b912f509fd65cc7b5f
+  data.tar.gz: ce9ffabcfc52bd3a98eabaf94b7130f1cb8d4f55faa797241a7029efcd143a6e3a2b082fc90017a07ab23bb57190366f425e61a2dd091579db272903d1788e2b

data/README.md

@@ -10,15 +10,15 @@ packages = ParsePackwerk.all
 # Get a single package with a given ame
 package = ParsePackwerk.find('packs/my_pack')
 
-# Get a structured `deprecated_references.yml` object a single package
-deprecated_references = ParsePackwerk::DeprecatedReferences.for(package)
+# Get a structured `package_todo.yml` object a single package
+package_todo = ParsePackwerk::PackageTodo.for(package)
 
 # Count violations of a particular type for a package
-deprecated_references.violations.count(&:privacy?)
-deprecated_references.violations.count(&:dependency?)
+package_todo.violations.count(&:privacy?)
+package_todo.violations.count(&:dependency?)
 
 # Get the number of files a particular constant is violated in
-deprecated_references.violations.select { |v| v.class_name == 'SomeConstant' }.sum { |v| v.files.count }
+package_todo.violations.select { |v| v.class_name == 'SomeConstant' }.sum { |v| v.files.count }
 ```
 
 # Why does this gem exist?

data/lib/parse_packwerk/constants.rb

@@ -4,9 +4,11 @@ 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)
-  DEPRECATED_REFERENCES_YML_NAME = T.let('deprecated_references.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)
+  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)

data/lib/parse_packwerk/package.rb

@@ -53,7 +53,7 @@ module ParsePackwerk
 
     sig { returns(T::Array[Violation]) }
     def violations
-      DeprecatedReferences.for(self).violations
+      PackageTodo.for(self).violations
     end
   end
 end

data/lib/parse_packwerk/package_todo.rb

@@ -0,0 +1,46 @@
+# typed: strict
+
+module ParsePackwerk
+  class PackageTodo < T::Struct
+    extend T::Sig
+
+    const :pathname, Pathname
+    const :violations, T::Array[Violation]
+
+    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)
+    end
+
+    sig { params(pathname: Pathname).returns(PackageTodo) }
+    def self.from(pathname)
+      if !pathname.exist?
+        new(
+          pathname: pathname.cleanpath,
+          violations: []
+        )
+      else
+        package_todo_loaded_yml = YAML.load_file(pathname)
+
+        all_violations = []
+        package_todo_loaded_yml&.each_key do |to_package_name|
+          package_todo_per_package = package_todo_loaded_yml[to_package_name]
+          package_todo_per_package.each_key do |class_name|
+            symbol_usage = package_todo_per_package[class_name]
+            files = symbol_usage['files']
+            violations = symbol_usage['violations']
+            violations.uniq.each do |violation_type|
+              all_violations << Violation.new(type: violation_type, to_package_name: to_package_name, class_name: class_name, files: files)
+            end
+          end
+        end
+
+        new(
+          pathname: pathname.cleanpath,
+          violations: all_violations
+        )
+      end
+    end
+  end
+end

data/lib/parse_packwerk.rb

@@ -5,7 +5,7 @@ require 'yaml'
 require 'pathname'
 require 'parse_packwerk/constants'
 require 'parse_packwerk/violation'
-require 'parse_packwerk/deprecated_references'
+require 'parse_packwerk/package_todo'
 require 'parse_packwerk/package'
 require 'parse_packwerk/configuration'
 require 'parse_packwerk/package_set'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parse_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -133,9 +133,9 @@ files:
 - lib/parse_packwerk.rb
 - lib/parse_packwerk/configuration.rb
 - lib/parse_packwerk/constants.rb
-- lib/parse_packwerk/deprecated_references.rb
 - lib/parse_packwerk/package.rb
 - lib/parse_packwerk/package_set.rb
+- lib/parse_packwerk/package_todo.rb
 - lib/parse_packwerk/violation.rb
 - sorbet/config
 - sorbet/rbi/gems/hashdiff@1.0.1.rbi

data/lib/parse_packwerk/deprecated_references.rb

@@ -1,50 +0,0 @@
-# typed: strict
-
-module ParsePackwerk
-  class DeprecatedReferences < T::Struct
-    extend T::Sig
-
-    const :pathname, Pathname
-    const :violations, T::Array[Violation]
-
-    sig { params(package: Package).returns(DeprecatedReferences) }
-    def self.for(package)
-      deprecated_references_yml_pathname = package.directory.join(DEPRECATED_REFERENCES_YML_NAME)
-      DeprecatedReferences.from(deprecated_references_yml_pathname)
-    end
-
-    sig { params(pathname: Pathname).returns(DeprecatedReferences) }
-    def self.from(pathname)
-      if !pathname.exist?
-        new(
-          pathname: pathname.cleanpath,
-          violations: []
-        )
-      else
-        deprecated_references_loaded_yml = YAML.load_file(pathname)
-
-        all_violations = []
-        deprecated_references_loaded_yml&.each_key do |to_package_name|
-          deprecated_references_per_package = deprecated_references_loaded_yml[to_package_name]
-          deprecated_references_per_package.each_key do |class_name|
-            symbol_usage = deprecated_references_per_package[class_name]
-            files = symbol_usage['files']
-            violations = symbol_usage['violations']
-            if violations.include? 'dependency'
-              all_violations << Violation.new(type: 'dependency', to_package_name: to_package_name, class_name: class_name, files: files)
-            end
-
-            if violations.include? 'privacy'
-              all_violations << Violation.new(type: 'privacy', to_package_name: to_package_name, class_name: class_name, files: files)
-            end
-          end
-        end
-
-        new(
-          pathname: pathname.cleanpath,
-          violations: all_violations
-        )
-      end
-    end
-  end
-end