rubocop-minitest 0.7.0 → 0.10.1

data/lib/rubocop/cop/minitest_cops.rb

@@ -1,22 +1,37 @@
 # frozen_string_literal: true
 
 require_relative 'mixin/argument_range_helper'
+require_relative 'mixin/in_delta_mixin'
 require_relative 'mixin/minitest_cop_rule'
+require_relative 'mixin/minitest_exploration_helpers'
 require_relative 'minitest/assert_empty'
 require_relative 'minitest/assert_empty_literal'
 require_relative 'minitest/assert_equal'
+require_relative 'minitest/assert_in_delta'
+require_relative 'minitest/assertion_in_lifecycle_hook'
+require_relative 'minitest/assert_kind_of'
 require_relative 'minitest/assert_nil'
 require_relative 'minitest/assert_includes'
 require_relative 'minitest/assert_instance_of'
 require_relative 'minitest/assert_match'
+require_relative 'minitest/assert_output'
+require_relative 'minitest/assert_path_exists'
 require_relative 'minitest/assert_respond_to'
+require_relative 'minitest/assert_silent'
 require_relative 'minitest/assert_truthy'
 require_relative 'minitest/global_expectations'
+require_relative 'minitest/literal_as_actual_argument'
+require_relative 'minitest/multiple_assertions'
 require_relative 'minitest/refute_empty'
 require_relative 'minitest/refute_false'
 require_relative 'minitest/refute_equal'
+require_relative 'minitest/refute_in_delta'
+require_relative 'minitest/refute_kind_of'
 require_relative 'minitest/refute_nil'
 require_relative 'minitest/refute_includes'
 require_relative 'minitest/refute_match'
 require_relative 'minitest/refute_instance_of'
+require_relative 'minitest/refute_path_exists'
 require_relative 'minitest/refute_respond_to'
+require_relative 'minitest/test_method_name'
+require_relative 'minitest/unspecified_exception'

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

@@ -26,6 +26,16 @@ module RuboCop
           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
+        )
+      end
     end
   end
 end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Common functionality for `AssertInDelta` and `RefuteInDelta` cops.
+    module InDeltaMixin
+      MSG = 'Prefer using `%<good_method>s` over `%<bad_method>s`.'
+
+      def on_send(node)
+        equal_floats_call(node) do |expected, actual, message|
+          message = message.first
+
+          if expected.float_type? || actual.float_type?
+            message = format(MSG,
+                             good_method: build_good_method(expected, actual, message),
+                             bad_method: node.source)
+
+            add_offense(node, message: message)
+          end
+        end
+      end
+
+      def autocorrect(node)
+        equal_floats_call(node) do |expected, actual, message|
+          message = message.first
+          replacement = build_good_method(expected, actual, message)
+
+          lambda do |corrector|
+            corrector.replace(node, replacement)
+          end
+        end
+      end
+
+      private
+
+      def build_good_method(expected, actual, message)
+        if message
+          "#{assertion_method}_in_delta(#{expected.source}, #{actual.source}, 0.001, #{message.source})"
+        else
+          "#{assertion_method}_in_delta(#{expected.source}, #{actual.source})"
+        end
+      end
+
+      def assertion_method
+        class_name = self.class.name.split('::').last
+        class_name[/\A[[:upper:]][[:lower:]]+/].downcase
+      end
+    end
+  end
+end

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

@@ -22,9 +22,7 @@ module RuboCop
       # @param inverse [Boolean] An optional param. Order of arguments replaced by auto-correction.
       #
       def define_rule(assertion_method, target_method:, preferred_method: nil, inverse: false)
-        if preferred_method.nil?
-          preferred_method = "#{assertion_method}_#{target_method.to_s.delete('?')}"
-        end
+        preferred_method = "#{assertion_method}_#{target_method.to_s.delete('?')}" if preferred_method.nil?
 
         class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
           include ArgumentRangeHelper

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module RuboCop
+  module Cop
+    # Helper methods for different explorations against test files and test cases.
+    module MinitestExplorationHelpers
+      extend NodePattern::Macros
+
+      ASSERTION_PREFIXES = %w[assert refute].freeze
+
+      LIFECYCLE_HOOK_METHODS = %i[
+        before_setup
+        setup
+        after_setup
+        before_teardown
+        teardown
+        after_teardown
+      ].to_set.freeze
+
+      private
+
+      def test_class?(class_node)
+        class_node.parent_class && class_node.identifier.source.end_with?('Test')
+      end
+
+      def test_case?(node)
+        return false unless node&.def_type? && test_case_name?(node.method_name)
+
+        class_ancestor = node.each_ancestor(:class).first
+        test_class?(class_ancestor)
+      end
+
+      def test_cases(class_node)
+        class_def_nodes(class_node)
+          .select { |def_node| test_case_name?(def_node.method_name) }
+      end
+
+      def lifecycle_hooks(class_node)
+        class_def_nodes(class_node)
+          .select { |def_node| lifecycle_hook_method?(def_node) }
+      end
+
+      def class_def_nodes(class_node)
+        class_def = class_node.body
+        return [] unless class_def
+
+        if class_def.def_type?
+          [class_def]
+        else
+          class_def.each_child_node(:def).to_a
+        end
+      end
+
+      def test_case_name?(name)
+        name.to_s.start_with?('test_')
+      end
+
+      def assertions(def_node)
+        method_def = def_node.body
+        return [] unless method_def
+
+        send_nodes =
+          if method_def.send_type?
+            [method_def]
+          else
+            method_def.each_child_node(:send)
+          end
+
+        send_nodes.select { |send_node| assertion?(send_node) }
+      end
+
+      def assertion?(node)
+        node.send_type? &&
+          ASSERTION_PREFIXES.any? { |prefix| node.method_name.to_s.start_with?(prefix) }
+      end
+
+      def lifecycle_hook_method?(node)
+        node.def_type? && LIFECYCLE_HOOK_METHODS.include?(node.method_name)
+      end
+    end
+  end
+end

data/lib/rubocop/minitest/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Minitest
-    VERSION = '0.7.0'
+    VERSION = '0.10.1'
   end
 end

data/mkdocs.yml

@@ -1,8 +1,8 @@
 site_name: "A RuboCop extension focused on enforcing Minitest best practices and coding conventions."
 repo_url: https://github.com/rubocop-hq/rubocop-minitest
-edit_uri: edit/master/manual/
+edit_uri: edit/master/legacy-docs/
 copyright: "Copyright © 2019 Bozhidar Batsov, Jonas Arvidsson, Koichi ITO, and RuboCop contributors"
-docs_dir: manual
+docs_dir: legacy-docs
 pages:
 - Home: index.md
 - Installation: installation.md

data/relnotes/v0.10.0.md

@@ -0,0 +1,21 @@
+### New features
+
+* [#92](https://github.com/rubocop-hq/rubocop-minitest/pull/92): Add new `Minitest/LiteralAsActualArgument` cop. ([@fatkodima][], [@tsmmark][])
+* [#95](https://github.com/rubocop-hq/rubocop-minitest/pull/95): Add new `Minitest/AssertionInLifecycleHook` cop. ([@fatkodima][])
+* [#91](https://github.com/rubocop-hq/rubocop-minitest/pull/91): Add new `Minitest/AssertInDelta` and `Minitest/RefuteInDelta` cops. ([@fatkodima][])
+* [#89](https://github.com/rubocop-hq/rubocop-minitest/pull/89): Add new `Minitest/TestMethodName` cop. ([@fatkodima][])
+* [#83](https://github.com/rubocop-hq/rubocop-minitest/pull/83): New cops `AssertPathExists` and `RefutePathExists` check for use of `assert_path_exists`/`refute_path_exists` instead of `assert(File.exist?(path))`/`refute(File.exist?(path))`. ([@fatkodima][])
+* [#88](https://github.com/rubocop-hq/rubocop-minitest/pull/88): Add new `Minitest/MultipleAssertions` cop. ([@fatkodima][])
+* [#87](https://github.com/rubocop-hq/rubocop-minitest/pull/87): Add new `Minitest/AssertSilent` cop. ([@fatkodima][])
+* [#96](https://github.com/rubocop-hq/rubocop-minitest/pull/96): Add new `Minitest/UnspecifiedException` cop. ([@fatkodima][])
+* [#98](https://github.com/rubocop-hq/rubocop-minitest/pull/98): Add new `Minitest/AssertOutput` cop. ([@fatkodima][])
+* [#84](https://github.com/rubocop-hq/rubocop-minitest/pull/84): New cops `AssertKindOf` and `RefuteKindOf` check for use of `assert_kind_of`/`refute_kind_of` instead of `assert(foo.kind_of?(Class))`/`refute(foo.kind_of?(Class))`. ([@fatkodima][])
+* [#85](https://github.com/rubocop-hq/rubocop-minitest/pull/85): Add autocorrect to `Rails/AssertEmptyLiteral` cop. ([@fatkodima][])
+
+### Changes
+
+* [#104](https://github.com/rubocop-hq/rubocop-minitest/pull/104): Require RuboCop 0.87 or higher. ([@koic][])
+
+[@fatkodima]: https://github.com/fatkodima
+[@tsmmark]: https://github.com/tsmmark
+[@koic]: https://github.com/koic

data/relnotes/v0.10.1.md

@@ -0,0 +1,5 @@
+### Bug fixes
+
+* [#106](https://github.com/rubocop-hq/rubocop-minitest/issues/106): Fix an error for `Minitest/AssertOutput` when using gvar at top level. ([@koic][])
+
+[@koic]: https://github.com/koic

data/relnotes/v0.8.0.md

@@ -0,0 +1,12 @@
+### New features
+
+* [#66](https://github.com/rubocop-hq/rubocop-minitest/issues/66): Support all expectations of `Minitest::Expectations` for `Minitest/GlobalExpectations` cop. ([@koic][])
+
+### Bug fixes
+
+* [#60](https://github.com/rubocop-hq/rubocop-minitest/issues/60): Fix `Minitest/GlobalExpectations` autocorrection for chained methods. ([@tejasbubane][])
+* [#69](https://github.com/rubocop-hq/rubocop-minitest/pull/69): Fix a false negative for `Minitest/GlobalExpectations` cop when using a variable or a hash index for receiver. ([@koic][])
+* [#71](https://github.com/rubocop-hq/rubocop-minitest/pull/71): Fix a false negative for `Minitest/AssertEqual` when an argument is enclosed in redundant parentheses. ([@koic][])
+
+[@koic]: https://github.com/koic
+[@tejasbubane]: https://github.com/tejasbubane

data/relnotes/v0.8.1.md

@@ -0,0 +1,5 @@
+### Bug fixes
+
+* [#72](https://github.com/rubocop-hq/rubocop-minitest/pull/72): Fix some false negatives for `Minitest/GlobalExpectations`. ([@andrykonchin][])
+
+[@andrykonchin]: https://github.com/andrykonchin

data/relnotes/v0.9.0.md

@@ -0,0 +1,10 @@
+### Bug fixes
+
+* [#75](https://github.com/rubocop-hq/rubocop-minitest/issues/75): Fix a false negative for `Minitest/GlobalExpectations` when using global expectation methods with no arguments. ([@koic][])
+
+### Changes
+
+* [#73](https://github.com/rubocop-hq/rubocop-minitest/issues/73): The Minitest department works on file names end with `_test.rb` by default. ([@koic][])
+* [#77](https://github.com/rubocop-hq/rubocop-minitest/pull/77): **(BREAKING)** Drop support for Ruby 2.3. ([@koic][])
+
+[@koic]: https://github.com/koic

data/rubocop-minitest.gemspec

@@ -16,12 +16,12 @@ Gem::Specification.new do |spec|
   DESCRIPTION
   spec.license = 'MIT'
 
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '>= 2.4.0'
   spec.metadata = {
-    'homepage_uri' => 'https://docs.rubocop.org/projects/minitest/',
+    'homepage_uri' => 'https://docs.rubocop.org/rubocop-minitest/',
     'changelog_uri' => 'https://github.com/rubocop-hq/rubocop-minitest/blob/master/CHANGELOG.md',
     'source_code_uri' => 'https://github.com/rubocop-hq/rubocop-minitest',
-    'documentation_uri' => 'https://docs.rubocop.org/projects/minitest/',
+    'documentation_uri' => 'https://docs.rubocop.org/rubocop-minitest/',
     'bug_tracker_uri' => 'https://github.com/rubocop-hq/rubocop-minitest/issues'
   }
 
@@ -34,6 +34,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rubocop', '>= 0.74'
+  spec.add_runtime_dependency 'rubocop', '>= 0.87'
   spec.add_development_dependency 'minitest', '~> 5.11'
 end

data/tasks/cops_documentation.rake

@@ -17,7 +17,8 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
   def cops_body(config, cop, description, examples_objects, pars)
     content = h2(cop.cop_name)
-    content << properties(config, cop)
+    content << required_ruby_version(cop)
+    content << properties(cop.new(config))
     content << "#{description}\n"
     content << examples(examples_objects) if examples_objects.count.positive?
     content << configurations(pars)
@@ -27,60 +28,66 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
   def examples(examples_object)
     examples_object.each_with_object(h3('Examples').dup) do |example, content|
+      content << "\n" unless content.end_with?("\n\n")
       content << h4(example.name) unless example.name == ''
       content << code_example(example)
     end
   end
 
+  def required_ruby_version(cop)
+    return '' unless cop.respond_to?(:required_minimum_ruby_version)
+
+    "NOTE: Required Ruby version: #{cop.required_minimum_ruby_version}\n\n"
+  end
+
   # rubocop:disable Metrics/MethodLength
-  def properties(config, cop)
+  def properties(cop_instance)
     header = [
       'Enabled by default', 'Safe', 'Supports autocorrection', 'VersionAdded',
       'VersionChanged'
     ]
-    config = config.for_cop(cop)
-    safe_auto_correct = config.fetch('SafeAutoCorrect', true)
-    autocorrect = if cop.new.support_autocorrect?
-                    "Yes #{'(Unsafe)' unless safe_auto_correct}"
+    autocorrect = if cop_instance.support_autocorrect?
+                    "Yes#{' (Unsafe)' unless cop_instance.safe_autocorrect?}"
                   else
                     'No'
                   end
+    cop_config = cop_instance.cop_config
     content = [[
-      config.fetch('Enabled') ? 'Enabled' : 'Disabled',
-      config.fetch('Safe', true) ? 'Yes' : 'No',
+      cop_status(cop_config.fetch('Enabled')),
+      cop_config.fetch('Safe', true) ? 'Yes' : 'No',
       autocorrect,
-      config.fetch('VersionAdded', '-'),
-      config.fetch('VersionChanged', '-')
+      cop_config.fetch('VersionAdded', '-'),
+      cop_config.fetch('VersionChanged', '-')
     ]]
-    to_table(header, content) + "\n"
+    "#{to_table(header, content)}\n"
   end
   # rubocop:enable Metrics/MethodLength
 
   def h2(title)
     content = +"\n"
-    content << "## #{title}\n"
+    content << "== #{title}\n"
     content << "\n"
     content
   end
 
   def h3(title)
     content = +"\n"
-    content << "### #{title}\n"
+    content << "=== #{title}\n"
     content << "\n"
     content
   end
 
   def h4(title)
-    content = +"#### #{title}\n"
+    content = +"==== #{title}\n"
     content << "\n"
     content
   end
 
   def code_example(ruby_code)
-    content = +"```ruby\n"
-    content << ruby_code.text
-                        .gsub('@good', '# good').gsub('@bad', '# bad').strip
-    content << "\n```\n"
+    content = +"[source,ruby]\n----\n"
+    content << ruby_code.text.gsub('@good', '# good')
+                        .gsub('@bad', '# bad').strip
+    content << "\n----\n"
     content
   end
 
@@ -88,7 +95,10 @@ task generate_cops_documentation: :yard_for_generate_documentation do
     return '' if pars.empty?
 
     header = ['Name', 'Default value', 'Configurable values']
-    configs = pars.each_key.reject { |key| key.start_with?('Supported') }
+    configs = pars
+              .each_key
+              .reject { |key| key.start_with?('Supported') }
+              .reject { |key| key.start_with?('AllowMultipleStyles') }
     content = configs.map do |name|
       configurable = configurable_values(pars, name)
       default = format_table_value(pars[name])
@@ -106,8 +116,6 @@ task generate_cops_documentation: :yard_for_generate_documentation do
       format_table_value(pars[supported_style_name])
     when 'IndentationWidth'
       'Integer'
-    when 'Database'
-      format_table_value(pars['SupportedDatabases'])
     else
       case pars[name]
       when String
@@ -129,11 +137,14 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
   def to_table(header, content)
     table = [
-      header.join(' | '),
-      Array.new(header.size, '---').join(' | ')
-    ]
-    table.concat(content.map { |c| c.join(' | ') })
-    table.join("\n") + "\n"
+      '|===',
+      "| #{header.join(' | ')}\n\n"
+    ].join("\n")
+    marked_contents = content.map do |plain_content|
+      plain_content.map { |c| "| #{c}" }.join("\n")
+    end
+    table << marked_contents.join("\n\n")
+    table << "\n|===\n"
   end
 
   def format_table_value(val)
@@ -146,11 +157,20 @@ task generate_cops_documentation: :yard_for_generate_documentation do
           val.map { |config| format_table_value(config) }.join(', ')
         end
       else
-        "`#{val.nil? ? '<none>' : val}`"
+        wrap_backtick(val.nil? ? '<none>' : val)
       end
     value.gsub("#{Dir.pwd}/", '').rstrip
   end
 
+  def wrap_backtick(value)
+    if value.is_a?(String)
+      # Use `+` to prevent text like `**/*.gemspec` from being bold.
+      value.start_with?('*') ? "`+#{value}+`" : "`#{value}`"
+    else
+      "`#{value}`"
+    end
+  end
+
   def references(config, cop)
     cop_config = config.for_cop(cop)
     urls = RuboCop::Cop::MessageAnnotator.new(
@@ -159,7 +179,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
     return '' if urls.empty?
 
     content = h3('References')
-    content << urls.map { |url| "* [#{url}](#{url})" }.join("\n")
+    content << urls.map { |url| "* #{url}" }.join("\n")
     content << "\n"
     content
   end
@@ -170,14 +190,15 @@ task generate_cops_documentation: :yard_for_generate_documentation do
     end
     return if selected_cops.empty?
 
-    content = +"# #{department}\n"
+    selected_cops = cops_of_department(cops, department)
+    content = +"= #{department}\n"
     selected_cops.each do |cop|
       content << print_cop_with_doc(cop, config)
     end
-    file_name = "#{Dir.pwd}/manual/cops_#{department.downcase}.md"
+    file_name = "#{Dir.pwd}/docs/modules/ROOT/pages/cops_#{department.downcase}.adoc"
     File.open(file_name, 'w') do |file|
       puts "* generated #{file_name}"
-      file.write(content.strip + "\n")
+      file.write("#{content.strip}\n")
     end
   end
 
@@ -190,15 +211,21 @@ task generate_cops_documentation: :yard_for_generate_documentation do
     pars = t.reject { |k| non_display_keys.include? k }
     description = 'No documentation'
     examples_object = []
-    YARD::Registry.all(:class).detect do |code_object|
-      next unless RuboCop::Cop::Badge.for(code_object.to_s) == cop.badge
-
+    cop_code(cop) do |code_object|
       description = code_object.docstring unless code_object.docstring.blank?
       examples_object = code_object.tags('example')
     end
     cops_body(config, cop, description, examples_object, pars)
   end
 
+  def cop_code(cop)
+    YARD::Registry.all(:class).detect do |code_object|
+      next unless RuboCop::Cop::Badge.for(code_object.to_s) == cop.badge
+
+      yield code_object
+    end
+  end
+
   # rubocop:disable Metrics/AbcSize
   def table_of_content_for_department(cops, department)
     selected_cops = cops_of_department(cops, department.to_sym).select do |cop|
@@ -207,11 +234,11 @@ task generate_cops_documentation: :yard_for_generate_documentation do
     return if selected_cops.empty?
 
     type_title = department[0].upcase + department[1..-1]
-    filename = "cops_#{department.downcase}.md"
-    content = +"#### Department [#{type_title}](#{filename})\n\n"
-    selected_cops.each do |cop|
+    filename = "cops_#{department.downcase}.adoc"
+    content = +"= Department xref:#{filename}[#{type_title}]\n\n"
+    cops_of_department(cops, department.to_sym).each do |cop|
       anchor = cop.cop_name.sub('/', '').downcase
-      content << "* [#{cop.cop_name}](#{filename}##{anchor})\n"
+      content << "* xref:#{filename}##{anchor}[#{cop.cop_name}]\n"
     end
 
     content
@@ -219,21 +246,17 @@ task generate_cops_documentation: :yard_for_generate_documentation do
   # rubocop:enable Metrics/AbcSize
 
   def print_table_of_contents(cops)
-    path = "#{Dir.pwd}/manual/cops.md"
+    path = "#{Dir.pwd}/docs/modules/ROOT/pages/cops.adoc"
     original = File.read(path)
-    content = +"<!-- START_COP_LIST -->\n"
+    content = +"// START_COP_LIST\n\n"
 
     content << table_contents(cops)
 
-    content << "\n<!-- END_COP_LIST -->"
+    content << "\n// END_COP_LIST"
 
-    content = if original.empty?
-                content
-              else
-                original.sub(
-                  /<!-- START_COP_LIST -->.+<!-- END_COP_LIST -->/m, content
-                )
-              end
+    content = original.sub(
+      %r{// START_COP_LIST.+// END_COP_LIST}m, content
+    )
     File.write(path, content)
   end
 
@@ -243,19 +266,25 @@ task generate_cops_documentation: :yard_for_generate_documentation do
       .map(&:to_s)
       .sort
       .map { |department| table_of_content_for_department(cops, department) }
-      .reject(&:nil?)
+      .compact
       .join("\n")
   end
 
-  def assert_manual_synchronized
+  def cop_status(status)
+    return 'Disabled' unless status
+
+    status == 'pending' ? 'Pending' : 'Enabled'
+  end
+
+  def assert_docs_synchronized
     # Do not print diff and yield whether exit code was zero
-    sh('git diff --quiet manual') do |outcome, _|
+    sh('git diff --quiet docs') do |outcome, _|
       return if outcome
 
       # Output diff before raising error
-      sh('GIT_PAGER=cat git diff manual')
+      sh('GIT_PAGER=cat git diff docs')
 
-      warn 'The manual directory is out of sync. ' \
+      warn 'The docs directory is out of sync. ' \
         'Run `rake generate_cops_documentation` and commit the results.'
       exit!
     end
@@ -272,7 +301,7 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
     print_table_of_contents(cops)
 
-    assert_manual_synchronized if ENV['CI'] == 'true'
+    assert_docs_synchronized if ENV['CI'] == 'true'
   ensure
     RuboCop::ConfigLoader.default_configuration = nil
   end