rubocop-packs 0.0.26 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b087fdd5a5ae2a9a51a04d24966313c19a2892153d656beac60bdb15e959726e
-  data.tar.gz: e4ff803bc9a2a37dd68867da260df1f68c7d8adc666a9cb141dcc95a6ac1e448
+  metadata.gz: e4888c0b36e59d1da1aaa62d1390da897fce811909d99c5e1189bca0efd36050
+  data.tar.gz: 7d1957e8c598a6acbcfa3b0b8f49578dcb3424d01c20178c2045459654a2478f
 SHA512:
-  metadata.gz: 234d22b504eb15892fd02bdab4783e475ab12ec0b6024f5d36519aca0efc1feaa5ac8616f8ba8f242086e5ac100d76edd282c282045136df26b5035954f6306d
-  data.tar.gz: 56056baf7a26ab3c2bc21038de1f34e418d01d2f0851fe1eb1234d7ec63e069a930505cf8e858fe6ac913ba5556b8ec230a024efbd7e97b0743756f3fac90c3f
+  metadata.gz: b55558140df2b0d0e68f64668a94e814c30a6ac42b144d0dc7fbc7118bdf982fb87b45085592ca219946ae6a2df73bb22562a83ae888fb021343ec0cea7c685c
+  data.tar.gz: fa54dc58358e0f32104c2acfa0536ff6239430c287a75e5ad0a346ae9979360f59a67037a34599e98a1df525cbe6c31c7350af95b6c33dba1dcdacb02cbdfe88

data/config/default.yml

@@ -5,6 +5,7 @@ Packs/ClassMethodsAsPublicApis:
     - T::Struct
     - Struct
     - OpenStruct
+  AcceptableMixins: []
   FailureMode: default
 
 Packs/RootNamespaceIsPackName:

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

@@ -10,6 +10,7 @@ module RuboCop
       # 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)
+      # * `AcceptableMixins`: A list of modules that, if included, non-class methods are permitted
       #
       # @example
       #
@@ -47,11 +48,14 @@ module RuboCop
 
           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
 
+          is_sorbet_interface_or_abstract_class = !module_node.nil? && module_node.descendants.any? { |d| d.is_a?(RuboCop::AST::SendNode) && (d.method_name == :interface! || d.method_name == :abstract!) }
+          return if is_sorbet_interface_or_abstract_class
+          return if node_includes_acceptable_mixin?(class_node || module_node)
+
           add_offense(
             node.source_range,
             message: format(
@@ -59,6 +63,22 @@ module RuboCop
             )
           )
         end
+
+        private
+
+        sig { params(node: T.untyped).returns(T::Boolean) }
+        def node_includes_acceptable_mixin?(node)
+          acceptable_mixins = cop_config['AcceptableMixins'] || []
+          return false if node.nil?
+
+          node.descendants.any? do |d|
+            d.is_a?(RuboCop::AST::SendNode) &&
+              d.method_name == :include &&
+              d.arguments.count == 1 &&
+              d.arguments.first.is_a?(RuboCop::AST::ConstNode) &&
+              acceptable_mixins.include?(d.arguments.first.const_name)
+          end
+        end
       end
     end
   end

data/lib/rubocop/packs/private.rb

@@ -148,20 +148,22 @@ module RuboCop
         errors
       end
 
-      sig { params(args: T.untyped).returns(String) }
+      sig { params(args: T.untyped).void }
       def self.execute_rubocop(args)
-        with_captured_stdout do
-          RuboCop::CLI.new.run(args)
-        end
+        RuboCop::CLI.new.run(args)
       end
 
       sig { params(paths: T::Array[String], cop_names: T::Array[String]).returns(T::Array[Offense]) }
       def self.offenses_for(paths:, cop_names:)
         cop_arguments = cop_names.join(',')
         # I think we can potentially use `RuboCop::CLI.new(args)` for this to avoid shelling out and starting another process that needs to reload the bundle
-        args = [*paths, "--only=#{cop_arguments}", '--format=json']
+        args = [*paths, "--only=#{cop_arguments}", '--format=json', '--out=tmp/rubocop-output']
+        FileUtils.mkdir_p('tmp')
         puts "Executing: bundle exec rubocop #{args.join(' ')}"
-        json = JSON.parse(Private.execute_rubocop(args))
+        Private.execute_rubocop(args)
+        output = Pathname.new('tmp/rubocop-output')
+        json = JSON.parse(Pathname.new('tmp/rubocop-output').read)
+        output.delete
         offenses = T.let([], T::Array[Offense])
         json['files'].each do |file_hash|
           filepath = file_hash['path']
@@ -175,16 +177,6 @@ module RuboCop
 
         offenses
       end
-
-      sig { params(block: T.untyped).returns(String) }
-      def self.with_captured_stdout(&block)
-        original_stdout = $stdout  # capture previous value of $stdout
-        $stdout = StringIO.new     # assign a string buffer to $stdout
-        yield                      # perform the body of the user code
-        $stdout.string             # return the contents of the string buffer
-      ensure
-        $stdout = original_stdout  # restore $stdout to its previous value
-      end
     end
 
     private_constant :Private

data/lib/rubocop/packs.rb

@@ -28,6 +28,12 @@ module RuboCop
     #
     sig { params(packs: T::Array[ParsePackwerk::Package], 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.delete if rubocop_todo_yml.exist?
+      end
+
       paths = packs.empty? ? files : packs.map(&:name).reject { |name| name == ParsePackwerk::ROOT_PACKAGE_NAME }
       offenses = Private.offenses_for(
         paths: paths,
@@ -39,19 +45,17 @@ module RuboCop
         next if !pack.directory.join(PACK_LEVEL_RUBOCOP_YML).exist?
 
         rubocop_todo_yml = pack.directory.join(PACK_LEVEL_RUBOCOP_TODO_YML)
-        # If the user is passing in packs, then regenerate from scratch.
-        if packs.any? && rubocop_todo_yml.exist?
-          rubocop_todo_yml.delete
-          rubocop_todo = {}
-        elsif rubocop_todo_yml.exist?
+        if rubocop_todo_yml.exist?
           rubocop_todo = YAML.load_file(rubocop_todo_yml)
         else
           rubocop_todo = {}
         end
 
-        offenses_for_pack.each do |offense|
-          rubocop_todo[offense.cop_name] ||= { 'Exclude' => [] }
-          rubocop_todo[offense.cop_name]['Exclude'] << offense.filepath
+        offenses_for_pack.group_by(&:filepath).each do |filepath, offenses_by_filepath|
+          offenses_by_filepath.map(&:cop_name).uniq.each do |cop_name|
+            rubocop_todo[cop_name] ||= { 'Exclude' => [] }
+            rubocop_todo[cop_name]['Exclude'] << filepath
+          end
         end
 
         next if rubocop_todo.empty?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packs
 version: !ruby/object:Gem::Version
-  version: 0.0.26
+  version: 0.0.28
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-19 00:00:00.000000000 Z
+date: 2022-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -178,7 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Fill this out!
+description: A collection of Rubocop rules for gradually modularizing a ruby codebase
 email:
 - dev@gusto.com
 executables: []
@@ -230,5 +230,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Fill this out!
+summary: A collection of Rubocop rules for gradually modularizing a ruby codebase
 test_files: []