rubocop-minitest 0.20.1 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d780d9c08b215f247a19ffc039d8385b58f63037585c882e3b760cdbe511ae14
-  data.tar.gz: 1ea02089d0b9a3511cbc19a3222f3c55e86a3c17d05bdc05291281df8115500a
+  metadata.gz: 1026c124f46d1dc887ec84cc1a0bf3b246afee76f0201c3d96bbd0895f3045e9
+  data.tar.gz: 2a66060a132b7235c2bbe77747df17fdb47bcf0011b0f03467612f514c7454de
 SHA512:
-  metadata.gz: 241d069163e52ba35fc4edb2c96d3f7fca6a32fa84ced1feee2abf777d42561503b309371444b81da318c3f07bce469a89e12fc2f6d0295372c3249c41db1ff1
-  data.tar.gz: 76ec782b3a226848f6676266dfbd1f06dc0cf2bbd999f01f9c46096def25cfe188c7dddb95ca93ab737812ef6eae81fd8401872b8a243344e1903c50143a699c
+  metadata.gz: dd56df2ffbf84f91e18af928f18d66decae8879a030db57f1833f1c4811aaf670c367067e42304b6ba94a38cbb7a13aeb55706d02f8495d25e4b5a1a66930c38
+  data.tar.gz: bf2460fca6fe8af2921a84e8b9f6c2fd6e34528a01f9c3c4b781dac4946fe7b042943977baf2c6d9dee7e83f4cf1a8573db492b06b6f63dff559320ccf5e733e

data/.rubocop.yml

@@ -31,6 +31,12 @@ Naming/InclusiveLanguage:
   Enabled: true
   CheckStrings: true
   FlaggedTerms:
+    auto-correct:
+      Suggestions:
+        - autocorrect
+    auto_correct:
+      Suggestions:
+        - autocorrect
     behaviour:
       Suggestions:
         - behavior
@@ -68,6 +74,9 @@ Layout/ClassStructure:
     - protected_methods
     - private_methods
 
+Layout/RedundantLineBreak:
+  Enabled: true
+
 # Trailing white space is meaningful in code examples
 Layout/TrailingWhitespace:
   AllowInHeredoc: true

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master (unreleased)
 
+## 0.21.0 (2022-07-31)
+
+### New features
+
+* [#109](https://github.com/rubocop/rubocop-minitest/issues/109): Add new `Minitest/AssertRaisesCompoundBody` cop. ([@fatkodima][])
+
 ## 0.20.1 (2022-06-13)
 
 ### Bug fixes

data/Rakefile

@@ -28,18 +28,14 @@ end
 desc 'Run RuboCop over itself'
 RuboCop::RakeTask.new(:internal_investigation)
 
-task default: %i[
-  documentation_syntax_check
-  test
-  internal_investigation
-]
+task default: %i[documentation_syntax_check test internal_investigation]
 
 desc 'Generate a new cop template'
 task :new_cop, [:cop] do |_task, args|
   require 'rubocop'
 
   cop_name = args.fetch(:cop) do
-    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    warn "usage: bundle exec rake 'new_cop[Department/Name]'"
     exit!
   end
 

data/config/default.yml

@@ -76,6 +76,11 @@ Minitest/AssertPredicate:
   Enabled: pending
   VersionAdded: '0.18'
 
+Minitest/AssertRaisesCompoundBody:
+  Description: 'This cop enforces the block body of `assert_raises { ... }` to be reduced to only the raising code.'
+  Enabled: pending
+  VersionAdded: '0.21'
+
 Minitest/AssertRespondTo:
   Description: 'This cop enforces the test to use `assert_respond_to(object, :do_something)` over `assert(object.respond_to?(:do_something))`.'
   StyleGuide: 'https://minitest.rubystyle.guide#assert-responds-to-method'

data/docs/antora.yml

@@ -2,6 +2,6 @@ name: rubocop-minitest
 title: RuboCop Minitest
 # We always provide version without patch here (e.g. 1.1),
 # as patch versions should not appear in the docs.
-version: '0.20'
+version: '0.21'
 nav:
   - modules/ROOT/nav.adoc

data/docs/modules/ROOT/pages/cops.adoc

@@ -25,6 +25,7 @@ based on the https://minitest.rubystyle.guide/[Minitest Style Guide].
 * xref:cops_minitest.adoc#minitestassertoutput[Minitest/AssertOutput]
 * xref:cops_minitest.adoc#minitestassertpathexists[Minitest/AssertPathExists]
 * xref:cops_minitest.adoc#minitestassertpredicate[Minitest/AssertPredicate]
+* xref:cops_minitest.adoc#minitestassertraisescompoundbody[Minitest/AssertRaisesCompoundBody]
 * xref:cops_minitest.adoc#minitestassertrespondto[Minitest/AssertRespondTo]
 * xref:cops_minitest.adoc#minitestassertsilent[Minitest/AssertSilent]
 * xref:cops_minitest.adoc#minitestasserttruthy[Minitest/AssertTruthy]

data/docs/modules/ROOT/pages/cops_minitest.adoc

@@ -379,6 +379,44 @@ assert_predicate(obj, :one?, 'message')
 
 * https://minitest.rubystyle.guide/#assert-predicate
 
+== Minitest/AssertRaisesCompoundBody
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Pending
+| Yes
+| No
+| 0.21
+| -
+|===
+
+Enforces the block body of `assert_raises { ... }` to be reduced to only the raising code.
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+assert_raises(MyError) do
+  foo
+  bar
+end
+
+# good
+assert_raises(MyError) do
+  foo
+end
+
+# good
+assert_raises(MyError) do
+  foo do
+    bar
+    baz
+  end
+end
+----
+
 == Minitest/AssertRespondTo
 
 |===

data/lib/rubocop/cop/generator.rb

@@ -39,13 +39,7 @@ module RuboCop
       private
 
       def test_path
-        File.join(
-          'test',
-          'rubocop',
-          'cop',
-          'minitest',
-          "#{snake_case(badge.cop_name.to_s)}_test.rb"
-        )
+        File.join('test', 'rubocop', 'cop', 'minitest', "#{snake_case(badge.cop_name.to_s)}_test.rb")
       end
 
       def generated_test

data/lib/rubocop/cop/minitest/assert_in_delta.rb

@@ -19,7 +19,7 @@ module RuboCop
         include InDeltaMixin
         extend AutoCorrector
 
-        RESTRICT_ON_SEND = %i[assert_equal].freeze
+        RESTRICT_ON_SEND = %i[assert_equal].freeze # rubocop:disable InternalAffairs/UselessRestrictOnSend
 
         def_node_matcher :equal_floats_call, <<~PATTERN
           (send nil? :assert_equal $_ $_ $...)

data/lib/rubocop/cop/minitest/assert_predicate.rb

@@ -21,7 +21,7 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Prefer using `assert_predicate(%<new_arguments>s)`.'
-        RESTRICT_ON_SEND = %i[assert].freeze
+        RESTRICT_ON_SEND = %i[assert].freeze # rubocop:disable InternalAffairs/UselessRestrictOnSend
 
         private
 

data/lib/rubocop/cop/minitest/assert_raises_compound_body.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Enforces the block body of `assert_raises { ... }` to be reduced to only the raising code.
+      #
+      # @example
+      #   # bad
+      #   assert_raises(MyError) do
+      #     foo
+      #     bar
+      #   end
+      #
+      #   # good
+      #   assert_raises(MyError) do
+      #     foo
+      #   end
+      #
+      #   # good
+      #   assert_raises(MyError) do
+      #     foo do
+      #       bar
+      #       baz
+      #     end
+      #   end
+      #
+      class AssertRaisesCompoundBody < Base
+        MSG = 'Reduce `assert_raises` block body to contain only the raising code.'
+
+        def on_block(node)
+          return unless node.method?(:assert_raises) && multi_statement_begin?(node.body)
+
+          add_offense(node)
+        end
+
+        private
+
+        def multi_statement_begin?(node)
+          node.begin_type? && node.children.size > 1
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/minitest/refute_equal.rb

@@ -44,8 +44,7 @@ module RuboCop
         private
 
         def preferred_usage(first_arg, second_arg, custom_message = nil)
-          [first_arg, second_arg, custom_message]
-            .compact.map(&:source).join(', ')
+          [first_arg, second_arg, custom_message].compact.map(&:source).join(', ')
         end
 
         def original_usage(first_part, custom_message)

data/lib/rubocop/cop/minitest/refute_in_delta.rb

@@ -19,7 +19,7 @@ module RuboCop
         include InDeltaMixin
         extend AutoCorrector
 
-        RESTRICT_ON_SEND = %i[refute_equal].freeze
+        RESTRICT_ON_SEND = %i[refute_equal].freeze # rubocop:disable InternalAffairs/UselessRestrictOnSend
 
         def_node_matcher :equal_floats_call, <<~PATTERN
           (send nil? :refute_equal $_ $_ $...)

data/lib/rubocop/cop/minitest/refute_predicate.rb

@@ -21,7 +21,7 @@ module RuboCop
         extend AutoCorrector
 
         MSG = 'Prefer using `refute_predicate(%<new_arguments>s)`.'
-        RESTRICT_ON_SEND = %i[refute].freeze
+        RESTRICT_ON_SEND = %i[refute].freeze # rubocop:disable InternalAffairs/UselessRestrictOnSend
 
         private
 

data/lib/rubocop/cop/minitest_cops.rb

@@ -11,6 +11,7 @@ require_relative 'minitest/assert_empty_literal'
 require_relative 'minitest/assert_equal'
 require_relative 'minitest/assert_in_delta'
 require_relative 'minitest/assert_predicate'
+require_relative 'minitest/assert_raises_compound_body'
 require_relative 'minitest/assert_with_expected_argument'
 require_relative 'minitest/assertion_in_lifecycle_hook'
 require_relative 'minitest/assert_kind_of'

data/lib/rubocop/cop/mixin/argument_range_helper.rb

@@ -11,30 +11,21 @@ module RuboCop
       def first_argument_range(node)
         first_argument = node.first_argument
 
-        range_between(
-          first_argument.source_range.begin_pos,
-          first_argument.source_range.end_pos
-        )
+        range_between(first_argument.source_range.begin_pos, first_argument.source_range.end_pos)
       end
 
       def first_and_second_arguments_range(node)
         first_argument = node.first_argument
         second_argument = node.arguments[1]
 
-        range_between(
-          first_argument.source_range.begin_pos,
-          second_argument.source_range.end_pos
-        )
+        range_between(first_argument.source_range.begin_pos, second_argument.source_range.end_pos)
       end
 
       def all_arguments_range(node)
         first_argument = node.first_argument
         last_argument = node.arguments.last
 
-        range_between(
-          first_argument.source_range.begin_pos,
-          last_argument.source_range.end_pos
-        )
+        range_between(first_argument.source_range.begin_pos, last_argument.source_range.end_pos)
       end
     end
   end

data/lib/rubocop/cop/mixin/predicate_assertion_handleable.rb

@@ -6,7 +6,6 @@ module RuboCop
       # Common functionality for `Minitest/AssertPredicate` and `Minitest/RefutePredicate` cops.
       module PredicateAssertionHandleable
         MSG = 'Prefer using `%<assertion_type>s_predicate(%<new_arguments>s)`.'
-        RESTRICT_ON_SEND = %i[assert].freeze
 
         def on_send(node)
           return unless (arguments = peel_redundant_parentheses_from(node.arguments))
@@ -46,10 +45,7 @@ module RuboCop
         def offense_message(arguments)
           message_argument = arguments.last if arguments.first != arguments.last
 
-          new_arguments = [
-            new_arguments(arguments),
-            message_argument&.source
-          ].flatten.compact.join(', ')
+          new_arguments = [new_arguments(arguments), message_argument&.source].flatten.compact.join(', ')
 
           format(MSG, assertion_type: assertion_type, new_arguments: new_arguments)
         end

data/lib/rubocop/minitest/assert_offense.rb

@@ -27,7 +27,7 @@ module RuboCop
     #     end
     #   RUBY
     #
-    # Auto-correction can be tested using `assert_correction` after
+    # Autocorrection can be tested using `assert_correction` after
     # `assert_offense`.
     #
     # @example `assert_offense` and `assert_correction`

data/lib/rubocop/minitest/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Minitest
     # This module holds the RuboCop Minitest version information.
     module Version
-      STRING = '0.20.1'
+      STRING = '0.21.0'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

data/relnotes/v0.21.0.md

@@ -0,0 +1,5 @@
+### New features
+
+* [#109](https://github.com/rubocop/rubocop-minitest/issues/109): Add new `Minitest/AssertRaisesCompoundBody` cop. ([@fatkodima][])
+
+[@fatkodima]: https://github.com/fatkodima

data/tasks/changelog.rb

@@ -30,7 +30,7 @@ class Changelog
     end
 
     def write
-      Dir.mkdir(ENTRIES_PATH) unless Dir.exist?(ENTRIES_PATH)
+      FileUtils.mkdir_p(ENTRIES_PATH)
       File.write(path, content)
       path
     end

data/tasks/cops_documentation.rake

@@ -22,7 +22,7 @@ end
 
 desc 'Syntax check for the documentation comments'
 task documentation_syntax_check: :yard_for_generate_documentation do
-  require 'parser/ruby30'
+  require 'parser/ruby31'
 
   ok = true
   YARD::Registry.load!
@@ -37,7 +37,7 @@ task documentation_syntax_check: :yard_for_generate_documentation do
     examples.to_a.each do |example|
       buffer = Parser::Source::Buffer.new('<code>', 1)
       buffer.source = example.text
-      parser = Parser::Ruby30.new(RuboCop::AST::Builder.new)
+      parser = Parser::Ruby31.new(RuboCop::AST::Builder.new)
       parser.diagnostics.all_errors_are_fatal = true
       parser.parse(buffer)
     rescue Parser::SyntaxError => e

data/tasks/cut_release.rake

@@ -38,10 +38,7 @@ namespace :cut_release do
     antora_metadata = File.read('docs/antora.yml')
 
     File.open('docs/antora.yml', 'w') do |f|
-      f << antora_metadata.sub(
-        'version: ~',
-        "version: '#{version_sans_patch(new_version)}'"
-      )
+      f << antora_metadata.sub('version: ~', "version: '#{version_sans_patch(new_version)}'")
     end
   end
 
@@ -52,8 +49,7 @@ namespace :cut_release do
   # Replace `<<next>>` (and variations) with version being cut.
   def update_cop_versions(_old_version, new_version)
     update_file('config/default.yml') do |default|
-      default.gsub(/['"]?<<\s*next\s*>>['"]?/i,
-                   "'#{version_sans_patch(new_version)}'")
+      default.gsub(/['"]?<<\s*next\s*>>['"]?/i, "'#{version_sans_patch(new_version)}'")
     end
   end
 
@@ -70,8 +66,7 @@ namespace :cut_release do
 
   def user_links(text)
     names = text.scan(/\[@(\S+)\]\[\]/).map(&:first).uniq
-    names.map { |name| "[@#{name}]: https://github.com/#{name}" }
-         .join("\n")
+    names.map { |name| "[@#{name}]: https://github.com/#{name}" }.join("\n")
   end
 
   def run(release_type)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-minitest
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.21.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-13 00:00:00.000000000 Z
+date: 2022-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -103,6 +103,7 @@ files:
 - lib/rubocop/cop/minitest/assert_output.rb
 - lib/rubocop/cop/minitest/assert_path_exists.rb
 - lib/rubocop/cop/minitest/assert_predicate.rb
+- lib/rubocop/cop/minitest/assert_raises_compound_body.rb
 - lib/rubocop/cop/minitest/assert_respond_to.rb
 - lib/rubocop/cop/minitest/assert_silent.rb
 - lib/rubocop/cop/minitest/assert_truthy.rb
@@ -168,6 +169,7 @@ files:
 - relnotes/v0.2.1.md
 - relnotes/v0.20.0.md
 - relnotes/v0.20.1.md
+- relnotes/v0.21.0.md
 - relnotes/v0.3.0.md
 - relnotes/v0.4.0.md
 - relnotes/v0.4.1.md
@@ -192,7 +194,7 @@ metadata:
   homepage_uri: https://docs.rubocop.org/rubocop-minitest/
   changelog_uri: https://github.com/rubocop/rubocop-minitest/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop/rubocop-minitest
-  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.20
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.21
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
   rubygems_mfa_required: 'true'
 post_install_message: