rubocop-packs 0.0.32 → 0.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cadc62e9996e91134e81886144560c53c85f6c306488cd46a75d883880e3197e
-  data.tar.gz: d51bc13e465a947526f78dfa7a10e71b5530f27a3137ccc34dfa2ca2b032588b
+  metadata.gz: e56f9a941b630002bfb4af833716b2cc58a3d2a3f21fbb673f86b04cf0eab0eb
+  data.tar.gz: abd74e0ecf25630da93a7ddff425060373787e33c209e0ce850599675ee6b842
 SHA512:
-  metadata.gz: 9da2d636a1324191200eb3bdb45ba169b05f5478136399b0a26eb2af7c9bf3849517ac860a8926038530fb64278642d690c193c24f363ccfc573efbc9772fea8
-  data.tar.gz: a7d0a3d5ca6133dba028c9c88713aed448f49ecb5e221ef219d85b6230d688399759dccf57334a513c1674582c09e38384b8e7a15e0f0df1a9c198325abac0fa
+  metadata.gz: c45aa69414bc48fe5e0874defaee69dee2ddfc5372f4683ce9644c70aace411e64c46ef3630513d4e6660868116116ef2dc4d03363865e7f39059ffa5630e007
+  data.tar.gz: 794ffd4ad403ca046bac4b22e21d419207fe9bb49215ef8b56f3b5f3b3ef7ced9e8cbd33c331a7b13f9d8e0aebb986d9c512d14b880af757bb6e52cc0ba8b1b0

data/lib/rubocop/cop/packs/documented_public_apis.rb

@@ -14,10 +14,19 @@ module RuboCop
       #     def bar; end
       #   end
       #
+      #   # good
       #   # packs/foo/app/public/foo.rb
       #   class Foo
       #     # This is a documentation comment.
-      #     # It can live below or below a sorbet type signature.
+      #     def bar; end
+      #   end
+      #
+      #   # good
+      #   # packs/foo/app/public/foo.rb
+      #   class Foo
+      #     # This is a documentation comment.
+      #     # It should appear above a sorbet type signature
+      #     sig { void }
       #     def bar; end
       #   end
       #

data/lib/rubocop/cop/packs/root_namespace_is_pack_name/desired_zeitwerk_api.rb

@@ -28,7 +28,7 @@ module RuboCop
           # Likely this means that our own cop should determine the desired namespace and pass that in
           # and this can determine actual namespace and how to get to expected.
           #
-          sig { params(relative_filename: String, package_for_path: ParsePackwerk::Package).returns(T.nilable(NamespaceContext)) }
+          sig { params(relative_filename: String, package_for_path: ::Packs::Pack).returns(T.nilable(NamespaceContext)) }
           def for_file(relative_filename, package_for_path)
             package_name = package_for_path.name
 
@@ -68,7 +68,7 @@ module RuboCop
               package_name,
               T.must(app_or_lib),
               T.must(autoload_folder_name),
-              get_package_last_name(package_for_path),
+              package_for_path.last_name,
               remaining_file_path
             )
 
@@ -82,9 +82,9 @@ module RuboCop
             )
           end
 
-          sig { params(pack: ParsePackwerk::Package).returns(String) }
+          sig { params(pack: ::Packs::Pack).returns(String) }
           def get_pack_based_namespace(pack)
-            get_package_last_name(pack).camelize
+            pack.last_name.camelize
           end
 
           private
@@ -94,11 +94,6 @@ module RuboCop
             Pathname.pwd
           end
 
-          sig { params(pack: ParsePackwerk::Package).returns(String) }
-          def get_package_last_name(pack)
-            T.must(pack.name.split('/').last)
-          end
-
           sig { params(remaining_file_path: String, package_name: String).returns(String) }
           def get_actual_namespace(remaining_file_path, package_name)
             # If the remaining file path is a ruby file (not a directory), then it establishes a global namespace

data/lib/rubocop/cop/packs/root_namespace_is_pack_name.rb

@@ -38,9 +38,7 @@ module RuboCop
           return if !relative_filename.include?('app/') || relative_filepath.extname != '.rb'
 
           relative_filename = relative_filepath.to_s
-          package_for_path = ParsePackwerk.package_from_path(relative_filename)
-          # If a pack is using automatic pack namespaces, this protection is a no-op since zeitwerk will enforce single namespaces in that case.
-          return if package_for_path.metadata['automatic_pack_namespace']
+          package_for_path = ::Packs.for_file(relative_filename)
 
           return if package_for_path.nil?
 

data/lib/rubocop/cop/packwerk_lite/constant_resolver.rb

@@ -27,8 +27,9 @@ module RuboCop
 
           sig { returns(T::Boolean) }
           def public_api?
-            # ParsePackwerk::Package should have a method to take in a path and determine if the file is public.
+            # PackwerkExtensions should have a method to take in a path and determine if the file is public.
             # For now we put it here and only support the public folder (and not specific private constants).
+            # However if we declare that dependency we may want to extract this into `rubocop-packwerk_lite` or something liek that!
             constant_definition_location.to_s.include?('/public/')
           end
 
@@ -40,7 +41,7 @@ module RuboCop
 
             expected_containing_pack_last_name = global_namespace.underscore
 
-            # We don't use ParsePackwerk.find(...) here because we want to look for nested packs, and this pack could be a child pack in a nested pack too.
+            # We don't use Packs.find(...) here because we want to look for nested packs, and this pack could be a child pack in a nested pack too.
             # In the future, we might want `find` to be able to take a glob or a regex to look for packs with a specific name structure.
             expected_containing_pack = ParsePackwerk.all.find { |p| p.name.include?("/#{expected_containing_pack_last_name}") }
             return if expected_containing_pack.nil?

data/lib/rubocop/packs/private/offense.rb

@@ -9,9 +9,9 @@ module RuboCop
         const :cop_name, String
         const :filepath, String
 
-        sig { returns(ParsePackwerk::Package) }
+        sig { returns(T.nilable(::Packs::Pack)) }
         def pack
-          ParsePackwerk.package_from_path(filepath)
+          ::Packs.for_file(filepath)
         end
       end
     end

data/lib/rubocop/packs/private.rb

@@ -36,10 +36,10 @@ module RuboCop
         end
       end
 
-      sig { params(package: ParsePackwerk::Package).returns(T::Array[String]) }
+      sig { params(package: ::Packs::Pack).returns(T::Array[String]) }
       def self.validate_rubocop_todo_yml(package)
         errors = []
-        rubocop_todo = package.directory.join(PACK_LEVEL_RUBOCOP_TODO_YML)
+        rubocop_todo = package.relative_path.join(PACK_LEVEL_RUBOCOP_TODO_YML)
         return errors unless rubocop_todo.exist?
 
         loaded_rubocop_todo = YAML.load_file(rubocop_todo)
@@ -57,7 +57,8 @@ module RuboCop
             ERROR_MESSAGE
           else
             loaded_rubocop_todo[key]['Exclude'].each do |filepath|
-              return [] unless ParsePackwerk.package_from_path(filepath).name != package.name
+              pack = ::Packs.for_file(filepath)
+              return [] unless pack && pack.name != package.name
 
               errors << <<~ERROR_MESSAGE
                 #{rubocop_todo} contains invalid configuration for #{key}.
@@ -71,10 +72,10 @@ module RuboCop
         errors
       end
 
-      sig { params(package: ParsePackwerk::Package).returns(T::Array[String]) }
+      sig { params(package: ::Packs::Pack).returns(T::Array[String]) }
       def self.validate_rubocop_yml(package)
         errors = []
-        rubocop_yml = package.directory.join(PACK_LEVEL_RUBOCOP_YML)
+        rubocop_yml = package.relative_path.join(PACK_LEVEL_RUBOCOP_YML)
         return errors unless rubocop_yml.exist?
 
         loaded_rubocop_yml = YAML.load_file(rubocop_yml)
@@ -122,14 +123,14 @@ module RuboCop
         excludes
       end
 
-      sig { params(package: ParsePackwerk::Package).returns(T::Array[String]) }
+      sig { params(package: ::Packs::Pack).returns(T::Array[String]) }
       def self.validate_failure_mode_strict(package)
         errors = T.let([], T::Array[String])
 
         Packs.config.permitted_pack_level_cops.each do |cop|
           excludes = exclude_for_rule(cop)
 
-          rubocop_yml = package.directory.join(PACK_LEVEL_RUBOCOP_YML)
+          rubocop_yml = package.relative_path.join(PACK_LEVEL_RUBOCOP_YML)
 
           next unless rubocop_yml.exist?
 
@@ -137,7 +138,8 @@ module RuboCop
           next unless loaded_rubocop_yml[cop] && loaded_rubocop_yml[cop]['FailureMode'] == 'strict'
 
           excludes_for_package = excludes.select do |exclude|
-            ParsePackwerk.package_from_path(exclude).name == package.name
+            pack = ::Packs.for_file(exclude)
+            pack && pack.name == package.name
           end
           next if excludes_for_package.empty?
 

data/lib/rubocop/packs.rb

@@ -26,15 +26,15 @@ module RuboCop
     # That is: the ability to preserve the location of `.rubocop_todo.yml` files and associate
     # exclusions with the closest ancestor `.rubocop_todo.yml`
     #
-    sig { params(packs: T::Array[ParsePackwerk::Package], files: T::Array[String]).void }
+    sig { params(packs: T::Array[::Packs::Pack], files: T::Array[String]).void }
     def self.regenerate_todo(packs: [], files: [])
       # Delete the old pack-level rubocop todo files so that we can regenerate the new one from scratch
       packs.each do |pack|
-        rubocop_todo_yml = pack.directory.join(PACK_LEVEL_RUBOCOP_TODO_YML)
+        rubocop_todo_yml = pack.relative_path.join(PACK_LEVEL_RUBOCOP_TODO_YML)
         rubocop_todo_yml.delete if rubocop_todo_yml.exist?
       end
 
-      paths = packs.empty? ? files : packs.map(&:name).reject { |name| name == ParsePackwerk::ROOT_PACKAGE_NAME }
+      paths = packs.empty? ? files : packs.map(&:name)
 
       cop_names = config.permitted_pack_level_cops.select do |cop_name|
         YAML.load_file('.rubocop.yml').fetch(cop_name, {})['Enabled']
@@ -46,10 +46,10 @@ module RuboCop
       )
 
       offenses.group_by(&:pack).each do |pack, offenses_for_pack|
-        next if pack.name == ParsePackwerk::ROOT_PACKAGE_NAME
-        next if !pack.directory.join(PACK_LEVEL_RUBOCOP_YML).exist?
+        next if pack.nil?
+        next if !pack.relative_path.join(PACK_LEVEL_RUBOCOP_YML).exist?
 
-        rubocop_todo_yml = pack.directory.join(PACK_LEVEL_RUBOCOP_TODO_YML)
+        rubocop_todo_yml = pack.relative_path.join(PACK_LEVEL_RUBOCOP_TODO_YML)
         if rubocop_todo_yml.exist?
           rubocop_todo = YAML.load_file(rubocop_todo_yml)
         else
@@ -74,10 +74,10 @@ module RuboCop
     # That is: the ability to preserve the location of `.rubocop_todo.yml` files and associate
     # exclusions with the closest ancestor `.rubocop_todo.yml`
     #
-    sig { params(packs: T::Array[ParsePackwerk::Package]).void }
+    sig { params(packs: T::Array[::Packs::Pack]).void }
     def self.set_default_rubocop_yml(packs:)
       packs.each do |pack|
-        rubocop_yml = Pathname.new(pack.directory.join(PACK_LEVEL_RUBOCOP_YML))
+        rubocop_yml = pack.relative_path.join(PACK_LEVEL_RUBOCOP_YML)
         rubocop_yml_hash = {}
         config.required_pack_level_cops.each do |cop|
           rubocop_yml_hash[cop] = { 'Enabled' => true }
@@ -101,10 +101,8 @@ module RuboCop
       # We do this because when the ERB is evaluated Dir.pwd is at the directory containing the YML.
       # Ideally rubocop wouldn't change the PWD before invoking this method.
       Dir.chdir(root_pathname) do
-        ParsePackwerk.all.each do |package|
-          next if package.name == ParsePackwerk::ROOT_PACKAGE_NAME
-
-          rubocop_todo = package.directory.join(PACK_LEVEL_RUBOCOP_TODO_YML)
+        ::Packs.all.each do |package|
+          rubocop_todo = package.relative_path.join(PACK_LEVEL_RUBOCOP_TODO_YML)
           if rubocop_todo.exist?
             loaded_rubocop_todo = YAML.load_file(rubocop_todo)
             loaded_rubocop_todo.each do |cop_name, key_config|
@@ -114,7 +112,7 @@ module RuboCop
             end
           end
 
-          pack_rubocop = package.directory.join(PACK_LEVEL_RUBOCOP_YML)
+          pack_rubocop = package.relative_path.join(PACK_LEVEL_RUBOCOP_YML)
           next unless pack_rubocop.exist?
 
           loaded_pack_rubocop = YAML.load_file(pack_rubocop)
@@ -123,10 +121,10 @@ module RuboCop
 
             if key_config['Enabled']
               rubocop_config[cop_name]['Include'] ||= []
-              rubocop_config[cop_name]['Include'] << package.directory.join('**/*').to_s
+              rubocop_config[cop_name]['Include'] << package.relative_path.join('**/*').to_s
             else
               rubocop_config[cop_name]['Exclude'] ||= []
-              rubocop_config[cop_name]['Exclude'] << package.directory.join('**/*').to_s
+              rubocop_config[cop_name]['Exclude'] << package.relative_path.join('**/*').to_s
             end
           end
         end
@@ -167,9 +165,7 @@ module RuboCop
     sig { returns(T::Array[String]) }
     def self.validate
       errors = T.let([], T::Array[String])
-      ParsePackwerk.all.each do |package|
-        next if package.name == ParsePackwerk::ROOT_PACKAGE_NAME
-
+      ::Packs.all.each do |package|
         errors += Private.validate_rubocop_todo_yml(package)
         errors += Private.validate_rubocop_yml(package)
         errors += Private.validate_failure_mode_strict(package)

data/lib/rubocop/packwerk_lite.rb

@@ -1,6 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
+require 'parse_packwerk'
 require 'rubocop/cop/packwerk_lite/private'
 require 'rubocop/cop/packwerk_lite/constant_resolver'
 require 'rubocop/cop/packwerk_lite/privacy_checker'

data/lib/rubocop-packs.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'rubocop'
-require 'parse_packwerk'
+require 'packs'
 
 require_relative 'rubocop/packs'
 require_relative 'rubocop/packs/inject'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packs
 version: !ruby/object:Gem::Version
-  version: 0.0.32
+  version: 0.0.33
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-19 00:00:00.000000000 Z
+date: 2022-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: packs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: parse_packwerk
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +234,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="