rubocop-packs 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfc93294dd3f42e1dece0b632adba1a4a9ac811d0328c682dd121f2f11063d98
-  data.tar.gz: df7a631fa820a30b672461e106882e7221555ddd3f64ba690dd8f7407d172ca4
+  metadata.gz: 7e2e2567a37e676f5c1ebf7a890057a542e4a5bbd667ab537ab0f82b24151a38
+  data.tar.gz: d19311bdf95df46ce37b93fe7bb898791b0a63b7804e418d77b300206ca818ba
 SHA512:
-  metadata.gz: ff8d5fbd4ab6233223b705ab097bed58aa9e45139e148c084c071a299720a12759fe2173ba6f557d5794b7e097c5dbc0ef87db3744bd47903662721fb4a8831e
-  data.tar.gz: cf7e59a3a2aa75057cee35ed0d5938b0c3131eff0d5c9657d9705833f26bff636ebc2d2ecf21fe69d04a49121e4772fa32457fe70225345587b3baaca77e1350
+  metadata.gz: 35941a67c992fc6afa9959d11c1c9d4929d48cb110329bea2ad3810458a769aeedc295c4e96bc1314cbc5ab3d1619b033e2314b8559753ce28827cbf329ebeeb
+  data.tar.gz: 1240836b6a4e0dff104815f1b7871102a2224abb3c80b2e8efa616d2dd251124149bc8efa4fcad31f63d300715e5853472090daa097cbaaa756bc635166172c5

data/config/default.yml

@@ -6,11 +6,11 @@ Packs/ClassMethodsAsPublicApis:
     - Struct
     - OpenStruct
 
-Packs/NamespacedUnderPackageName:
-  Enabled: false
+Packs/NamespaceConvention:
+  Enabled: true
 
 Packs/TypedPublicApi:
-  Enabled: false
+  Enabled: true
 
 Packs/RequireDocumentedPublicApis:
-  Enabled: false
+  Enabled: true

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

@@ -7,6 +7,10 @@ module RuboCop
       # This cop states that public API should live on class methods, which are more easily statically analyzable,
       # searchable, and typically hold less state.
       #
+      # Options:
+      #
+      # * `AcceptableParentClasses`: A list of classes that, if inherited from, non-class methods are permitted (useful when value objects are a part of your public API)
+      #
       # @example
       #
       #   # bad
@@ -23,16 +27,6 @@ module RuboCop
       #     end
       #   end
       #
-      # @example AcceptableParentClasses: [T::Enum, T::Struct, Struct, OpenStruct] (default)
-      #   You can define `AcceptableParentClasses` which are a list of classes that, if inherited from, non-class methods are permitted.
-      #   This is useful when value objects are a part of your public API.
-      #
-      #   # good
-      #   # packs/foo/app/public/foo.rb
-      #   class Foo < T::Enum
-      #     const :blah
-      #   end
-      #
       class ClassMethodsAsPublicApis < Base
         extend T::Sig
 

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Packs
-      class NamespacedUnderPackageName < Base
+      class NamespaceConvention < Base
         #
         # This is a private class that represents API that we would prefer to be available somehow in Zeitwerk.
         #
@@ -12,6 +12,7 @@ module RuboCop
 
           class NamespaceContext < T::Struct
             const :current_namespace, String
+            const :current_fully_qualified_constant, String
             const :expected_namespace, String
             const :expected_filepath, String
           end
@@ -72,7 +73,8 @@ module RuboCop
             relative_desired_path = absolute_desired_path.relative_path_from(root_pathname)
 
             NamespaceContext.new(
-              current_namespace: actual_namespace,
+              current_namespace: T.must(actual_namespace.split('::').first),
+              current_fully_qualified_constant: actual_namespace,
               expected_namespace: get_pack_based_namespace(package_for_path),
               expected_filepath: relative_desired_path.to_s
             )
@@ -99,7 +101,7 @@ module RuboCop
           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
             # Otherwise, per Zeitwerk's conventions as listed above, its a directory that establishes another global namespace
-            T.must(remaining_file_path.split('/').first).gsub('.rb', '').camelize
+            remaining_file_path.split('/').map { |entry| entry.gsub('.rb', '').camelize }.join('::')
           end
         end
 

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

@@ -2,12 +2,14 @@
 
 # For String#camelize
 require 'active_support/core_ext/string/inflections'
-require 'rubocop/cop/packs/namespaced_under_package_name/desired_zeitwerk_api'
+require 'rubocop/cop/packs/namespace_convention/desired_zeitwerk_api'
 
 module RuboCop
   module Cop
     module Packs
       # This cop helps ensure that each pack exposes one namespace.
+      # Note that this cop doesn't necessarily expect you to be using stimpack (https://github.com/rubyatscale/stimpack),
+      # but it does expect packs to live in the organizational structure as described in the README.md of that gem.
       #
       # @example
       #
@@ -19,7 +21,7 @@ module RuboCop
       #   # packs/foo/app/services/foo/blah/bar.rb
       #   class Foo::Blah::Bar; end
       #
-      class NamespacedUnderPackageName < Base
+      class NamespaceConvention < Base
         extend T::Sig
 
         include RangeHelp
@@ -47,6 +49,7 @@ module RuboCop
 
           package_name = package_for_path.name
           actual_namespace = namespace_context.current_namespace
+          current_fully_qualified_constant = namespace_context.current_fully_qualified_constant
 
           if allowed_global_namespaces.include?(actual_namespace)
             # No problem!
@@ -60,21 +63,23 @@ module RuboCop
               add_offense(
                 source_range(processed_source.buffer, 1, 0),
                 message: format(
-                  '`%<package_name>s` prevents modules/classes that are not submodules of the package namespace. Should be namespaced under `%<expected_namespace>s` with path `%<expected_path>s`. See https://go/packwerk_cheatsheet_namespaces for more info.',
+                  'Based on the filepath, this file defines `%<current_fully_qualified_constant>s`, but it should be namespaced as `%<expected_namespace>s::%<current_fully_qualified_constant>s` with path `%<expected_path>s`.',
                   package_name: package_name,
                   expected_namespace: expected_namespace,
-                  expected_path: relative_desired_path
+                  expected_path: relative_desired_path,
+                  current_fully_qualified_constant: current_fully_qualified_constant
                 )
               )
             elsif pack_owning_this_namespace
               add_offense(
                 source_range(processed_source.buffer, 1, 0),
                 message: format(
-                  '`%<pack_owning_this_namespace>s` prevents other packs from sitting in the `%<actual_namespace>s` namespace. This should be namespaced under `%<expected_namespace>s` with path `%<expected_path>s`. See https://go/packwerk_cheatsheet_namespaces for more info.',
+                  'Based on the filepath, this file defines `%<current_fully_qualified_constant>s`. `%<pack_owning_this_namespace>s` prevents other packs from sitting in the `%<actual_namespace>s` namespace. This should be namespaced under `%<expected_namespace>s` with path `%<expected_path>s`.',
                   package_name: package_name,
                   pack_owning_this_namespace: pack_owning_this_namespace,
                   expected_namespace: expected_namespace,
                   actual_namespace: actual_namespace,
+                  current_fully_qualified_constant: current_fully_qualified_constant,
                   expected_path: relative_desired_path
                 )
               )

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

@@ -3,7 +3,35 @@
 module RuboCop
   module Cop
     module Packs
+      # This cop helps ensure that each pack has a documented public API
+      #
+      # @example
+      #
+      #   # bad
+      #   # packs/foo/app/public/foo.rb
+      #   class Foo
+      #     sig { void }
+      #     def bar
+      #   end
+      #
+      #   # packs/foo/app/public/foo.rb
+      #   class Foo
+      #     # This is a documentation comment.
+      #     # It can live below or below a sorbet type signature.
+      #     sig { void }
+      #     def bar
+      #   end
+      #
       class RequireDocumentedPublicApis < 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.
+        #
+        # An alternate approach would be to monkey patch the existing cop, as `rubocop-sorbet` did here:
+        # https://github.com/Shopify/rubocop-sorbet/blob/6634f033611604cd76eeb73eae6d8728ec82d504/lib/rubocop/cop/sorbet/mutable_constant_sorbet_aware_behaviour.rb
+        # This monkey-patched cop could/should probably be upstreamed to `rubocop-sorbet`, and then `config/default.yml` could simply set `packs/*/app/public/**/*`
+        # in the default include paths. However, that strategy has the downside of resulting in more configuration for the consumer if they only want to
+        # support this for some packs.
         extend T::Sig
 
         sig { returns(T::Boolean) }

data/lib/rubocop-packs.rb

@@ -7,7 +7,7 @@ require 'parse_packwerk'
 require_relative 'rubocop/packs'
 require_relative 'rubocop/packs/inject'
 
-require 'rubocop/cop/packs/namespaced_under_package_name'
+require 'rubocop/cop/packs/namespace_convention'
 require 'rubocop/cop/packs/typed_public_api'
 require 'rubocop/cop/packs/class_methods_as_public_apis'
 require 'rubocop/cop/packs/require_documented_public_apis'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packs
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Gusto Engineers
@@ -189,8 +189,8 @@ files:
 - config/default.yml
 - lib/rubocop-packs.rb
 - lib/rubocop/cop/packs/class_methods_as_public_apis.rb
-- lib/rubocop/cop/packs/namespaced_under_package_name.rb
-- lib/rubocop/cop/packs/namespaced_under_package_name/desired_zeitwerk_api.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/packs.rb