rubocop-minitest 0.9.0 → 0.10.0

data/lib/rubocop/minitest/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Minitest
-    VERSION = '0.9.0'
+    VERSION = '0.10.0'
   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/rubocop-minitest.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
 
   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,30 +28,36 @@ 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"
   end
@@ -58,29 +65,29 @@ task generate_cops_documentation: :yard_for_generate_documentation do
 
   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,27 +179,30 @@ 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
 
+  # rubocop:disable Metrics/AbcSize
   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 = 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")
     end
   end
+  # rubocop:enable Metrics/AbcSize
 
   def print_cop_with_doc(cop, config)
     t = config.for_cop(cop)
@@ -190,15 +213,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 +236,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 +248,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 +268,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 +303,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

data/tasks/cut_release.rake

@@ -35,6 +35,21 @@ namespace :cut_release do
     end
   end
 
+  def update_antora_yml(new_version)
+    antora_metadata = File.read('docs/antora.yml')
+
+    File.open('docs/antora.yml', 'w') do |f|
+      f << antora_metadata.sub(
+        'version: master',
+        "version: #{version_sans_patch(new_version)}"
+      )
+    end
+  end
+
+  def version_sans_patch(version)
+    version.split('.').take(2).join('.')
+  end
+
   def new_version_changes
     changelog = File.read('CHANGELOG.md')
     _, _, new_changes, _older_changes = changelog.split(/^## .*$/, 4)
@@ -54,6 +69,7 @@ namespace :cut_release do
 
     add_header_to_changelog(new_version)
     create_release_notes(new_version)
+    update_antora_yml(new_version)
 
     puts "Changed version from #{old_version} to #{new_version}."
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-minitest
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-13 00:00:00.000000000 Z
+date: 2020-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '0.87'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '0.87'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,39 +66,63 @@ files:
 - bin/console
 - bin/setup
 - config/default.yml
+- docs/antora.yml
+- docs/modules/ROOT/nav.adoc
+- docs/modules/ROOT/pages/cops.adoc
+- docs/modules/ROOT/pages/cops_minitest.adoc
+- docs/modules/ROOT/pages/index.adoc
+- docs/modules/ROOT/pages/installation.adoc
+- docs/modules/ROOT/pages/usage.adoc
+- legacy-docs/cops.md
+- legacy-docs/cops_minitest.md
+- legacy-docs/index.md
+- legacy-docs/installation.md
+- legacy-docs/usage.md
 - lib/rubocop-minitest.rb
+- lib/rubocop/cop/generator.rb
 - lib/rubocop/cop/minitest/assert_empty.rb
 - lib/rubocop/cop/minitest/assert_empty_literal.rb
 - lib/rubocop/cop/minitest/assert_equal.rb
+- lib/rubocop/cop/minitest/assert_in_delta.rb
 - lib/rubocop/cop/minitest/assert_includes.rb
 - lib/rubocop/cop/minitest/assert_instance_of.rb
+- lib/rubocop/cop/minitest/assert_kind_of.rb
 - lib/rubocop/cop/minitest/assert_match.rb
 - lib/rubocop/cop/minitest/assert_nil.rb
+- lib/rubocop/cop/minitest/assert_output.rb
+- lib/rubocop/cop/minitest/assert_path_exists.rb
 - lib/rubocop/cop/minitest/assert_respond_to.rb
+- lib/rubocop/cop/minitest/assert_silent.rb
 - lib/rubocop/cop/minitest/assert_truthy.rb
+- lib/rubocop/cop/minitest/assertion_in_lifecycle_hook.rb
 - lib/rubocop/cop/minitest/global_expectations.rb
+- lib/rubocop/cop/minitest/literal_as_actual_argument.rb
+- lib/rubocop/cop/minitest/multiple_assertions.rb
 - lib/rubocop/cop/minitest/refute_empty.rb
 - lib/rubocop/cop/minitest/refute_equal.rb
 - lib/rubocop/cop/minitest/refute_false.rb
+- lib/rubocop/cop/minitest/refute_in_delta.rb
 - lib/rubocop/cop/minitest/refute_includes.rb
 - lib/rubocop/cop/minitest/refute_instance_of.rb
+- lib/rubocop/cop/minitest/refute_kind_of.rb
 - lib/rubocop/cop/minitest/refute_match.rb
 - lib/rubocop/cop/minitest/refute_nil.rb
+- lib/rubocop/cop/minitest/refute_path_exists.rb
 - lib/rubocop/cop/minitest/refute_respond_to.rb
+- lib/rubocop/cop/minitest/test_method_name.rb
+- lib/rubocop/cop/minitest/unspecified_exception.rb
 - lib/rubocop/cop/minitest_cops.rb
 - lib/rubocop/cop/mixin/argument_range_helper.rb
+- lib/rubocop/cop/mixin/in_delta_mixin.rb
 - lib/rubocop/cop/mixin/minitest_cop_rule.rb
+- lib/rubocop/cop/mixin/minitest_exploration_helpers.rb
 - lib/rubocop/minitest.rb
 - lib/rubocop/minitest/inject.rb
 - lib/rubocop/minitest/version.rb
-- manual/cops.md
-- manual/cops_minitest.md
-- manual/index.md
-- manual/installation.md
-- manual/usage.md
 - mkdocs.yml
 - readthedocs.yml
 - relnotes/v0.1.0.md
+- relnotes/v0.10.0.md
 - relnotes/v0.2.0.md
 - relnotes/v0.2.1.md
 - relnotes/v0.3.0.md
@@ -120,10 +144,10 @@ homepage:
 licenses:
 - MIT
 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
 post_install_message: 
 rdoc_options: []