rubocop-packs 0.0.16 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82853530c4d01d7eb8f804f48eeb8b9558eb5d0fb006d5841c2c22f6265d5a38
-  data.tar.gz: 55fdebf202b61a5c09b6f2e125fe2821c756f0c7aa7f4b03e383750992c62764
+  metadata.gz: ad176fde4b980a18810e2563daf9c097bf4569d83a713e7d0efab4a7118e32c8
+  data.tar.gz: cd71dc7323afd1bf9c4dea9818cc6e177cacce44e94337c0746c6db01bb69a1b
 SHA512:
-  metadata.gz: 350a4b8cff981e078f6c87e3fece33ba40c678be475f305702398033b3856817ac7eb60e98268f8f10e58b7098f05bb622f77089cca1d20ce64d1faba37db663
-  data.tar.gz: bbc768b93c9f41cc886cdb8b1514d41cf8688a622ec4d6d4573eff06ef347eaf602751afc5ca6de663ff0564c33e263778b2eeae3933142b5831027518e8c776
+  metadata.gz: b19478228beb486ac967de7479048a6f01ffd0ba2cb608ce9a5e6c5ad6966f2431fb5df38636cdc079e7e89e8e574ddd126f5be28d307209430b9e3389596ec5
+  data.tar.gz: a5b7ea366640f39b2631b02d2d8fe59997c1449e57e6b9c3f7da7a58acc4fe471627c9bdf55734ef085e4b6de5bd562979833793e121a4532c3c52fee29d0b18

data/README.md

@@ -36,7 +36,7 @@ All cops are located under [`lib/rubocop/cop/packs`](lib/rubocop/cop/packs), and
 In your `.rubocop.yml`, you may treat the Packs cops just like any other cop. For example:
 
 ```yaml
-Packs/NamespaceConvention:
+Packs/RootNamespaceIsPackName:
   Exclude:
     - lib/example.rb
 ```
@@ -52,9 +52,9 @@ To add a per-pack `.rubocop.yml`, you just need to create a `packs/your_pack/.ru
 inherit_from: '../../.rubocop.yml'
 ```
 
-Note though that inherited paths are relative to your pack-level `.rubocop.yml`. To avoid that, you can rename your `.rubocop.yml` to `.inherited_rubocop.yml`, set `.rubocop.yml` to:
+Note though that inherited paths are relative to your pack-level `.rubocop.yml`. To avoid that, you can rename your `.rubocop.yml` to `.base_rubocop.yml`, set `.rubocop.yml` to:
 ```
-inherit_from: '.inherited_rubocop.yml'
+inherit_from: '.base_rubocop.yml'
 ```
 And then similarly change the `inherit_from` in `packs/your_pack/.rubocop.yml`.
 
@@ -70,8 +70,8 @@ To use per-pack `.rubocop.yml` and `.rubocop_todo.yml` files, you need to config
 ```ruby
 # config/rubocop_packs.rb
 RuboCop::Packs.configure do |config|
-  config.permitted_pack_level_cops = ['Packs/NamespaceConvention']
-  config.required_pack_level_cops = ['Packs/NamespaceConvention']
+  config.permitted_pack_level_cops = ['Packs/RootNamespaceIsPackName']
+  config.required_pack_level_cops = ['Packs/RootNamespaceIsPackName']
 end
 ```
 

data/config/default.yml

@@ -8,13 +8,13 @@ Packs/ClassMethodsAsPublicApis:
     - Struct
     - OpenStruct
 
-Packs/NamespaceConvention:
+Packs/RootNamespaceIsPackName:
   Enabled: true
 
-Packs/TypedPublicApi:
+Packs/TypedPublicApis:
   Enabled: true
 
-Packs/RequireDocumentedPublicApis:
+Packs/DocumentedPublicApis:
   Enabled: true
 
 PackwerkLite/Privacy:

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

@@ -55,7 +55,7 @@ module RuboCop
           add_offense(
             node.source_range,
             message: format(
-              'Top-level files in the public/ folder may only define class methods.'
+              "Public API method must be a class method (e.g. `self.#{node.method_name}(...)`)"
             )
           )
         end

data/lib/rubocop/cop/packs/{require_documented_public_apis.rb → documented_public_apis.rb}

@@ -21,7 +21,7 @@ module RuboCop
       #     def bar; end
       #   end
       #
-      class RequireDocumentedPublicApis < Style::DocumentationMethod
+      class DocumentedPublicApis < Style::DocumentationMethod
         # This cop does two things:
         # 1) It only activates for things in the public folder
         # 2) It allows `Style/DocumentationMethod` to work with sigs as expected.

data/lib/rubocop/cop/packs/{namespace_convention → root_namespace_is_pack_name}/desired_zeitwerk_api.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Packs
-      class NamespaceConvention < Base
+      class RootNamespaceIsPackName < Base
         #
         # This is a private class that represents API that we would prefer to be available somehow in Zeitwerk.
         # However, the boundaries between systems (packwerk/zeitwerk, rubocop/zeitwerk) are poor in this class, so

data/lib/rubocop/cop/packs/{namespace_convention.rb → root_namespace_is_pack_name.rb}

@@ -2,7 +2,7 @@
 
 # For String#camelize
 require 'active_support/core_ext/string/inflections'
-require 'rubocop/cop/packs/namespace_convention/desired_zeitwerk_api'
+require 'rubocop/cop/packs/root_namespace_is_pack_name/desired_zeitwerk_api'
 
 module RuboCop
   module Cop
@@ -23,7 +23,7 @@ module RuboCop
       #   # packs/foo/app/services/foo/blah/bar.rb
       #   class Foo::Blah::Bar; end
       #
-      class NamespaceConvention < Base
+      class RootNamespaceIsPackName < Base
         extend T::Sig
 
         include RangeHelp

data/lib/rubocop/cop/packs/{typed_public_api.rb → typed_public_apis.rb}

@@ -19,7 +19,7 @@ module RuboCop
       #   # typed: strict
       #   module Foo; end
       #
-      class TypedPublicApi < Sorbet::StrictSigil
+      class TypedPublicApis < Sorbet::StrictSigil
         #
         # This inherits from `Sorbet::StrictSigil` and doesn't change any behavior of it.
         # The only reason we do this is so that configuration for this cop can live under a different cop namespace.

data/lib/rubocop/packs.rb

@@ -64,6 +64,31 @@ module RuboCop
       end
     end
 
+    #
+    # Ideally, this is API that is available to us via `rubocop` itself.
+    # 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 }
+    def self.set_default_rubocop_yml(packs:)
+      packs.each do |pack|
+        rubocop_yml = Pathname.new(pack.directory.join('.rubocop.yml'))
+        rubocop_yml_hash = {}
+        rubocop_yml_hash['inherit_from'] = '../../.base_rubocop.yml'
+        config.required_pack_level_cops.each do |cop|
+          rubocop_yml_hash[cop] = { 'Enabled' => true }
+        end
+
+        formatted_yml = YAML.dump(rubocop_yml_hash).
+          # Remove the `---` header at the top of the file
+          gsub("---\n", '').
+          # Find lines of the form \nCopDepartment/CopName: and add a new line before it.
+          gsub(%r{^(\w+/\w+:)}, "\n\\1")
+
+        rubocop_yml.write(formatted_yml)
+      end
+    end
+
     sig { params(root_pathname: String).returns(String) }
     # It would be great if rubocop (upstream) could take in a glob for `inherit_from`, which
     # would allow us to delete this method and this additional complexity.

data/lib/rubocop-packs.rb

@@ -8,9 +8,9 @@ require_relative 'rubocop/packs'
 require_relative 'rubocop/packs/inject'
 require_relative 'rubocop/packwerk_lite'
 
-require 'rubocop/cop/packs/namespace_convention'
-require 'rubocop/cop/packs/typed_public_api'
+require 'rubocop/cop/packs/root_namespace_is_pack_name'
+require 'rubocop/cop/packs/typed_public_apis'
 require 'rubocop/cop/packs/class_methods_as_public_apis'
-require 'rubocop/cop/packs/require_documented_public_apis'
+require 'rubocop/cop/packs/documented_public_apis'
 
 RuboCop::Packs::Inject.defaults!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packs
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-08 00:00:00.000000000 Z
+date: 2022-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -190,10 +190,10 @@ files:
 - config/pack_config.yml
 - lib/rubocop-packs.rb
 - lib/rubocop/cop/packs/class_methods_as_public_apis.rb
-- lib/rubocop/cop/packs/namespace_convention.rb
-- lib/rubocop/cop/packs/namespace_convention/desired_zeitwerk_api.rb
-- lib/rubocop/cop/packs/require_documented_public_apis.rb
-- lib/rubocop/cop/packs/typed_public_api.rb
+- lib/rubocop/cop/packs/documented_public_apis.rb
+- lib/rubocop/cop/packs/root_namespace_is_pack_name.rb
+- lib/rubocop/cop/packs/root_namespace_is_pack_name/desired_zeitwerk_api.rb
+- lib/rubocop/cop/packs/typed_public_apis.rb
 - lib/rubocop/cop/packwerk_lite/constant_resolver.rb
 - lib/rubocop/cop/packwerk_lite/dependency_checker.rb
 - lib/rubocop/cop/packwerk_lite/privacy_checker.rb