rubocop-minitest 0.8.0 → 0.10.2

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
@@ -59,7 +57,7 @@ module RuboCop
           private
 
           def peel_redundant_parentheses_from(arguments)
-            return arguments unless arguments.first.begin_type?
+            return arguments unless arguments.first&.begin_type?
 
             peel_redundant_parentheses_from(arguments.first.children)
           end

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,13 @@
 
 module RuboCop
   module Minitest
-    VERSION = '0.8.0'
+    # This module holds the RuboCop Minitest version information.
+    module Version
+      STRING = '0.10.2'
+
+      def self.document_version
+        STRING.match('\d+\.\d+').to_s
+      end
+    end
   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.10.2.md

@@ -0,0 +1,5 @@
+### Bug fixes
+
+* [#113](https://github.com/rubocop-hq/rubocop-minitest/issues/113): This PR fixes an error for `Minitest/AssertEqual` and some cops when using `assert` with block argument. ([@koic][])
+
+[@koic]: https://github.com/koic

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

@@ -6,7 +6,7 @@ require 'rubocop/minitest/version'
 
 Gem::Specification.new do |spec|
   spec.name = 'rubocop-minitest'
-  spec.version = RuboCop::Minitest::VERSION
+  spec.version = RuboCop::Minitest::Version::STRING
   spec.authors = ['Bozhidar Batsov', 'Jonas Arvidsson', 'Koichi ITO']
 
   spec.summary = 'Automatic Minitest code style checking tool.'
@@ -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/#{RuboCop::Minitest::Version.document_version}",
     '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', '< 2.0'
   spec.add_development_dependency 'minitest', '~> 5.11'
 end

data/tasks/cops_documentation.rake

@@ -3,6 +3,7 @@
 require 'yard'
 require 'rubocop'
 require 'rubocop-minitest'
+require 'rubocop/cops_documentation_generator'
 
 YARD::Rake::YardocTask.new(:yard_for_generate_documentation) do |task|
   task.files = ['lib/rubocop/cop/**/*.rb']
@@ -11,273 +12,23 @@ end
 
 desc 'Generate docs of all cops departments'
 task generate_cops_documentation: :yard_for_generate_documentation do
-  def cops_of_department(cops, department)
-    cops.with_department(department).sort!
-  end
-
-  def cops_body(config, cop, description, examples_objects, pars)
-    content = h2(cop.cop_name)
-    content << properties(config, cop)
-    content << "#{description}\n"
-    content << examples(examples_objects) if examples_objects.count.positive?
-    content << configurations(pars)
-    content << references(config, cop)
-    content
-  end
-
-  def examples(examples_object)
-    examples_object.each_with_object(h3('Examples').dup) do |example, content|
-      content << h4(example.name) unless example.name == ''
-      content << code_example(example)
-    end
-  end
-
-  # rubocop:disable Metrics/MethodLength
-  def properties(config, cop)
-    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}"
-                  else
-                    'No'
-                  end
-    content = [[
-      config.fetch('Enabled') ? 'Enabled' : 'Disabled',
-      config.fetch('Safe', true) ? 'Yes' : 'No',
-      autocorrect,
-      config.fetch('VersionAdded', '-'),
-      config.fetch('VersionChanged', '-')
-    ]]
-    to_table(header, content) + "\n"
-  end
-  # rubocop:enable Metrics/MethodLength
-
-  def h2(title)
-    content = +"\n"
-    content << "## #{title}\n"
-    content << "\n"
-    content
-  end
-
-  def h3(title)
-    content = +"\n"
-    content << "### #{title}\n"
-    content << "\n"
-    content
-  end
-
-  def h4(title)
-    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
-  end
-
-  def configurations(pars)
-    return '' if pars.empty?
-
-    header = ['Name', 'Default value', 'Configurable values']
-    configs = pars.each_key.reject { |key| key.start_with?('Supported') }
-    content = configs.map do |name|
-      configurable = configurable_values(pars, name)
-      default = format_table_value(pars[name])
-      [name, default, configurable]
-    end
-
-    h3('Configurable attributes') + to_table(header, content)
-  end
-
-  # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength
-  def configurable_values(pars, name)
-    case name
-    when /^Enforced/
-      supported_style_name = RuboCop::Cop::Util.to_supported_styles(name)
-      format_table_value(pars[supported_style_name])
-    when 'IndentationWidth'
-      'Integer'
-    when 'Database'
-      format_table_value(pars['SupportedDatabases'])
-    else
-      case pars[name]
-      when String
-        'String'
-      when Integer
-        'Integer'
-      when Float
-        'Float'
-      when true, false
-        'Boolean'
-      when Array
-        'Array'
-      else
-        ''
-      end
-    end
-  end
-  # rubocop:enable Metrics/CyclomaticComplexity,Metrics/MethodLength
-
-  def to_table(header, content)
-    table = [
-      header.join(' | '),
-      Array.new(header.size, '---').join(' | ')
-    ]
-    table.concat(content.map { |c| c.join(' | ') })
-    table.join("\n") + "\n"
-  end
-
-  def format_table_value(val)
-    value =
-      case val
-      when Array
-        if val.empty?
-          '`[]`'
-        else
-          val.map { |config| format_table_value(config) }.join(', ')
-        end
-      else
-        "`#{val.nil? ? '<none>' : val}`"
-      end
-    value.gsub("#{Dir.pwd}/", '').rstrip
-  end
-
-  def references(config, cop)
-    cop_config = config.for_cop(cop)
-    urls = RuboCop::Cop::MessageAnnotator.new(
-      config, cop.name, cop_config, {}
-    ).urls
-    return '' if urls.empty?
-
-    content = h3('References')
-    content << urls.map { |url| "* [#{url}](#{url})" }.join("\n")
-    content << "\n"
-    content
-  end
-
-  def print_cops_of_department(cops, department, config)
-    selected_cops = cops_of_department(cops, department).select do |cop|
-      cop.to_s.start_with?('RuboCop::Cop::Minitest')
-    end
-    return if selected_cops.empty?
-
-    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.open(file_name, 'w') do |file|
-      puts "* generated #{file_name}"
-      file.write(content.strip + "\n")
-    end
-  end
-
-  def print_cop_with_doc(cop, config)
-    t = config.for_cop(cop)
-    non_display_keys = %w[
-      Description Enabled StyleGuide Reference Safe SafeAutoCorrect VersionAdded
-      VersionChanged
-    ]
-    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
-
-      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
-
-  # rubocop:disable Metrics/AbcSize
-  def table_of_content_for_department(cops, department)
-    selected_cops = cops_of_department(cops, department.to_sym).select do |cop|
-      cop.to_s.start_with?('RuboCop::Cop::Minitest')
-    end
-    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|
-      anchor = cop.cop_name.sub('/', '').downcase
-      content << "* [#{cop.cop_name}](#{filename}##{anchor})\n"
-    end
-
-    content
-  end
-  # rubocop:enable Metrics/AbcSize
-
-  def print_table_of_contents(cops)
-    path = "#{Dir.pwd}/manual/cops.md"
-    original = File.read(path)
-    content = +"<!-- START_COP_LIST -->\n"
-
-    content << table_contents(cops)
-
-    content << "\n<!-- END_COP_LIST -->"
-
-    content = if original.empty?
-                content
-              else
-                original.sub(
-                  /<!-- START_COP_LIST -->.+<!-- END_COP_LIST -->/m, content
-                )
-              end
-    File.write(path, content)
-  end
-
-  def table_contents(cops)
-    cops
-      .departments
-      .map(&:to_s)
-      .sort
-      .map { |department| table_of_content_for_department(cops, department) }
-      .reject(&:nil?)
-      .join("\n")
-  end
-
-  def assert_manual_synchronized
-    # Do not print diff and yield whether exit code was zero
-    sh('git diff --quiet manual') do |outcome, _|
-      return if outcome
-
-      # Output diff before raising error
-      sh('GIT_PAGER=cat git diff manual')
-
-      warn 'The manual directory is out of sync. ' \
-        'Run `rake generate_cops_documentation` and commit the results.'
-      exit!
-    end
-  end
-
-  def main
-    cops   = RuboCop::Cop::Cop.registry
-    config = RuboCop::ConfigLoader.load_file('config/default.yml')
+  deps = ['Minitest']
+  CopsDocumentationGenerator.new(departments: deps).call
+end
 
-    YARD::Registry.load!
-    cops.departments.sort!.each do |department|
-      print_cops_of_department(cops, department, config)
-    end
+desc 'Verify that documentation is up to date'
+task verify_cops_documentation: :generate_cops_documentation do
+  # Do not print diff and yield whether exit code was zero
+  sh('git diff --quiet docs') do |outcome, _|
+    exit if outcome
 
-    print_table_of_contents(cops)
+    # Output diff before raising error
+    sh('GIT_PAGER=cat git diff docs')
 
-    assert_manual_synchronized if ENV['CI'] == 'true'
-  ensure
-    RuboCop::ConfigLoader.default_configuration = nil
+    warn 'The docs directory is out of sync. ' \
+      'Run `rake generate_cops_documentation` and commit the results.'
+    exit!
   end
-
-  main
 end
 
 desc 'Syntax check for the documentation comments'
@@ -286,7 +37,7 @@ task documentation_syntax_check: :yard_for_generate_documentation do
 
   ok = true
   YARD::Registry.load!
-  cops = RuboCop::Cop::Cop.registry
+  cops = RuboCop::Cop::Registry.global
   cops.each do |cop|
     examples = YARD::Registry.all(:class).find do |code_object|
       next unless RuboCop::Cop::Badge.for(code_object.to_s) == cop.badge