rubocop-modularization 0.0.3 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7be2735c3d928d9c4ccf2643f2d07c533926ded38120b0d50e825d021065d92
-  data.tar.gz: dc19628fa31d58ced5e4b93af213d31f475c23669da692722b41c3c12140fc71
+  metadata.gz: b05e1b9669412cab4e323d4495bb2c0bd928874432d80accb97f21ef664c4fe3
+  data.tar.gz: d899d18f541eab5ed57021a57b6807033551a01e38f9f693b2448e6c949a28a9
 SHA512:
-  metadata.gz: 55916f5fdcf893b864f41d69b69cb595f2b32427164e6cfd9f32cd2859d8ff6b2db012c7fc4a14a665b600efae8645a73bdab8f26f8b2455c0e4b461e21bcdb0
-  data.tar.gz: 5a558caa1855c9aeb2317c574d9c6983fe6ca35ef9a1fb34af4d285cc432810961273928cf628293452102dd1ba0d0c5d817ab6feb3fe6c833a49485fec1aa5f
+  metadata.gz: 43b17bd5a5254cb14d8506034abfdbf4edd9e84ad13fd8b4f45cfd4132a094974f54a023aaa0f706af2f4b00a3c52407d9aa349651c3c0fd96a45e617e9f58c2
+  data.tar.gz: bdb1bd61127bb3b904419d46588caade2af35e3ff8831e00b94c13b63fbb624d9c4628cc2b2b098ee578bba520d31c8106ecbe44c7c164224848a3cb4d57bdfc

data/README.md

@@ -1,6 +1,6 @@
 # rubocop-modularization
 
-A collection of Rubocop rules for modularization..
+A collection of Rubocop rules for modularization.
 
 ## Installation
 

data/config/default.yml

@@ -1,5 +1,16 @@
+Modularization/ClassMethodsAsPublicApis:
+  Enabled: true
+  AcceptableParentClasses:
+    - T::Enum
+    - T::Struct
+    - Struct
+    - OpenStruct
+
 Modularization/NamespacedUnderPackageName:
   Enabled: false
 
 Modularization/TypedPublicApi:
   Enabled: false
+
+RequireDocumentedPublicApis:
+  Enabled: false

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

@@ -0,0 +1,71 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Modularization
+      # This cop states that public API should live on class methods, which are more easily statically analyzable,
+      # searchable, and typically hold less state.
+      #
+      # @example
+      #
+      #   # bad
+      #   # packs/foo/app/public/foo.rb
+      #   module Foo
+      #     def blah
+      #     end
+      #   end
+      #
+      #   # good
+      #   # packs/foo/app/public/foo.rb
+      #   module Foo
+      #     def self.blah
+      #     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
+
+        sig { returns(T::Boolean) }
+        def support_autocorrect?
+          false
+        end
+
+        sig { params(node: T.untyped).void }
+        def on_def(node)
+          # This cop only applies for ruby files in `app/public`
+          return if !processed_source.file_path.include?('app/public')
+
+          # Looked at https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Lint/MissingSuper source code as inspiration for htis part.
+          class_node = node.each_ancestor(:class).first
+          module_node = node.each_ancestor(:module).first
+          parent_class = class_node&.parent_class || module_node&.parent
+
+          acceptable_parent_classes = cop_config['AcceptableParentClasses'] || []
+
+          # Used this PR as inspiration to check if we're within a `class << self` block
+          uses_implicit_static_methods = node.each_ancestor(:sclass).first&.identifier&.source == 'self'
+          class_is_allowed_to_have_instance_methods = acceptable_parent_classes.include?(parent_class&.const_name)
+          return if uses_implicit_static_methods || class_is_allowed_to_have_instance_methods
+
+          add_offense(
+            node.source_range,
+            message: format(
+              'Top-level files in the public/ folder may only define class methods.'
+            )
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# typed: strict
+
+module RuboCop
+  module Cop
+    module Modularization
+      class RequireDocumentedPublicApis < Style::DocumentationMethod
+        extend T::Sig
+
+        sig { returns(T::Boolean) }
+        def support_autocorrect?
+          false
+        end
+
+        sig { params(node: T.untyped).void }
+        def check(node)
+          # This cop only applies for ruby files in `app/public`
+          return if !processed_source.file_path.include?('app/public')
+          return if non_public?(node) && !require_for_non_public_methods?
+
+          left_sibling = node.left_sibling
+          left_sibling_is_sig = left_sibling && (left_sibling.source.include?('sig do') || left_sibling.source.include?('sig {'))
+          # Is there a better way to check if the left sibling is a sorbet signature? Probably!
+          if left_sibling_is_sig
+            return if documentation_comment?(node.left_sibling)
+          elsif documentation_comment?(node)
+            return
+          end
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop-modularization.rb

@@ -9,5 +9,7 @@ require_relative 'rubocop/modularization/inject'
 
 require 'rubocop/cop/modularization/namespaced_under_package_name'
 require 'rubocop/cop/modularization/typed_public_api'
+require 'rubocop/cop/modularization/class_methods_as_public_apis'
+require 'rubocop/cop/modularization/require_documented_public_apis'
 
 RuboCop::Modularization::Inject.defaults!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-modularization
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
 platform: ruby
 authors:
 - Gusto Engineers
@@ -188,10 +188,11 @@ files:
 - README.md
 - config/default.yml
 - lib/rubocop-modularization.rb
+- lib/rubocop/cop/modularization/class_methods_as_public_apis.rb
 - lib/rubocop/cop/modularization/namespaced_under_package_name.rb
 - lib/rubocop/cop/modularization/namespaced_under_package_name/desired_zeitwerk_api.rb
+- lib/rubocop/cop/modularization/require_documented_public_apis.rb
 - lib/rubocop/cop/modularization/typed_public_api.rb
-- lib/rubocop/cop/modularization_cops.rb
 - lib/rubocop/modularization.rb
 - lib/rubocop/modularization/inject.rb
 - lib/rubocop/modularization/private.rb

data/lib/rubocop/cop/modularization_cops.rb

@@ -1,2 +0,0 @@
-# typed: strict
-# frozen_string_literal: true