parse_packwerk 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb8eaf8cf0d7746244d7eb4ac00cf61c194d6b676e0abe2d7b1abc87ebb17cad
-  data.tar.gz: bbebdb76de0afa935b311783d33f4aa4f3a70dfc390f6f2004f16644b8e365da
+  metadata.gz: 307906041051ec00eb3cc2647b0e04be2ac81d03f4ee0ebce51450b42a6eca55
+  data.tar.gz: 886374546d1cbb7d8562850d541c7fd77c3089f935138ab399c3c5df632ab396
 SHA512:
-  metadata.gz: cd3ce9a3d6377d2263cc783389d7c0323fd05fb83b54cb74ae6df5e6e93ce82cc83e0f7892d2b2ccf2de85d0147900f72ac163297d6277cb58c3da9c06eafaee
-  data.tar.gz: 96d3ac65cd313847f836ad14878702bf7f944d6a949bd077b650fcca2f39857bb1b4ec869e385c988c781c99058c4761481e85867b06e1697373c5e6b6ac533d
+  metadata.gz: 76eff55192a47f33bf95cf267ed7517d143bec88ef403a36fc88b896254ef7278bfc4cc5d7a279aaa39f82d028b6db2d8ac64ee6840080c6da7cc39f5d1ce81d
+  data.tar.gz: 97ae51ba0bb3694e382f367deecf65ecda486679412c80c970fae1560de8253f30fcbe4eb30502cd2438e75d3cf9224a4ac4637ea91e38a2b0d2afef2d5021fd

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,7 +4,7 @@ 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)
   PUBLIC_PATH = T.let('public_path'.freeze, String)

data/lib/parse_packwerk/package.rb

@@ -50,5 +50,10 @@ 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/{deprecated_references.rb → package_todo.rb}

@@ -1,19 +1,19 @@
 # typed: strict
 
 module ParsePackwerk
-  class DeprecatedReferences < T::Struct
+  class PackageTodo < T::Struct
     extend T::Sig
 
     const :pathname, Pathname
     const :violations, T::Array[Violation]
 
-    sig { params(package: Package).returns(DeprecatedReferences) }
+    sig { params(package: Package).returns(PackageTodo) }
     def self.for(package)
-      deprecated_references_yml_pathname = package.directory.join(DEPRECATED_REFERENCES_YML_NAME)
-      DeprecatedReferences.from(deprecated_references_yml_pathname)
+      package_todo_yml_pathname = package.directory.join(PACKAGE_TODO_YML_NAME)
+      PackageTodo.from(package_todo_yml_pathname)
     end
 
-    sig { params(pathname: Pathname).returns(DeprecatedReferences) }
+    sig { params(pathname: Pathname).returns(PackageTodo) }
     def self.from(pathname)
       if !pathname.exist?
         new(
@@ -21,13 +21,13 @@ module ParsePackwerk
           violations: []
         )
       else
-        deprecated_references_loaded_yml = YAML.load_file(pathname)
+        package_todo_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]
+        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']
             if violations.include? 'dependency'

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.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-13 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
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A low-dependency gem for parsing and writing packwerk YML files