rubocop-minitest 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae51cf25ec8713911a7b48130c68450d8cb983cbf280757d65fbad039deb9005
-  data.tar.gz: 15ade21076b9c6f31ae2336b1d0dabd7f626aa334a3f36d4fb007021121d73fa
+  metadata.gz: f04d27399103835be508a28975344afe09018c9f480217824f65c0c43be34b3d
+  data.tar.gz: 3021b9fa8b826d056b69d2c91b6d447dc66a3acecc82bf439a2931e6f25ea9f6
 SHA512:
-  metadata.gz: 8e2735ab5ec9466052e86755ab05eb739039a4eaf4c3aa25cf22beed6f292251f845561ed7cdb5596094b15835ff67d2f66acb18c5c99ddd66c6ebd23ce83291
-  data.tar.gz: 9c352bf7cbd8dc650a57591c9add7d3b11f1cd0f87ec5c3e629befa1149e05987640d50e5f0301b957c308e1bbf43524785e6ed4993c3caf25bdd0b78279958e
+  metadata.gz: 61ae0ab74e4a736221044989b3ef08e5c743b6cd43024c6ed236e276a4fefb0ec6c3fd23232f401ef205d0db5e8575c8cb1b85b31186a8e26c7be031e65f9772
+  data.tar.gz: a574a9d994741b69bf4280b91ef7321498aeeaec391cdfee7784230baf55a0d45bf4013a8395418b96b442a39fb13b5a33fa23b8bb03d2cce92bb77c040317c9

data/.circleci/config.yml

@@ -30,9 +30,6 @@ jobs:
       - run:
           name: Check documentation syntax
           command: bundle exec rake documentation_syntax_check
-      - run:
-          name: Build documentation and verify that doc files are in sync
-          command: bundle exec rake verify_cops_documentation
 
 workflows:
   build:

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master (unreleased)
 
+## 0.17.0 (2021-11-23)
+
+### New features
+
+* [#155](https://github.com/rubocop/rubocop-minitest/issues/155): Provide `assert_offense`, `assert_correction`, and `assert_no_offenses` testing APIs for custom Minitest cop development. ([@koic][])
+
 ## 0.16.0 (2021-11-14)
 
 ### New features

data/Rakefile

@@ -30,7 +30,6 @@ RuboCop::RakeTask.new(:internal_investigation)
 
 task default: %i[
   documentation_syntax_check
-  generate_cops_documentation
   test
   internal_investigation
 ]

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.16'
+version: '0.17'
 nav:
 - modules/ROOT/nav.adoc

data/lib/rubocop/minitest/assert_offense.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+# Laziness copied from rubocop source code
+require 'rubocop/rspec/expect_offense'
+require 'rubocop/cop/legacy/corrector'
+
+module RuboCop
+  module Minitest
+    # Mixin for `assert_offense` and `assert_no_offenses`
+    #
+    # This mixin makes it easier to specify strict offense assertions
+    # in a declarative and visual fashion. Just type out the code that
+    # should generate a offense, annotate code by writing '^'s
+    # underneath each character that should be highlighted, and follow
+    # the carets with a string (separated by a space) that is the
+    # message of the offense. You can include multiple offenses in
+    # one code snippet.
+    #
+    # @example Usage
+    #
+    #   assert_offense(<<~RUBY)
+    #     class FooTest < Minitest::Test
+    #       def test_do_something
+    #         assert_equal(nil, somestuff)
+    #         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `assert_nil(somestuff)` over `assert_equal(nil, somestuff)`.
+    #       end
+    #     end
+    #   RUBY
+    #
+    # Auto-correction can be tested using `assert_correction` after
+    # `assert_offense`.
+    #
+    # @example `assert_offense` and `assert_correction`
+    #
+    #   assert_offense(<<~RUBY)
+    #     class FooTest < Minitest::Test
+    #       def test_do_something
+    #         assert_equal(nil, somestuff)
+    #         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `assert_nil(somestuff)` over `assert_equal(nil, somestuff)`.
+    #       end
+    #     end
+    #   RUBY
+    #
+    #   assert_correction(<<~RUBY)
+    #     class FooTest < Minitest::Test
+    #       def test_do_something
+    #         assert_nil(somestuff)
+    #       end
+    #     end
+    #   RUBY
+    #
+    # If you do not want to specify an offense then use the
+    # companion method `assert_no_offenses`. This method is a much
+    # simpler assertion since it just inspects the source and checks
+    # that there were no offenses. The `assert_offense` method has
+    # to do more work by parsing out lines that contain carets.
+    #
+    # If the code produces an offense that could not be auto-corrected, you can
+    # use `assert_no_corrections` after `assert_offense`.
+    #
+    # @example `assert_offense` and `assert_no_corrections`
+    #
+    #   assert_offense(<<~RUBY)
+    #     class FooTest < Minitest::Test
+    #       def test_do_something
+    #         assert_equal(nil, somestuff)
+    #         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `assert_nil(somestuff)` over `assert_equal(nil, somestuff)`.
+    #       end
+    #     end
+    #   RUBY
+    #
+    #   assert_no_corrections
+    module AssertOffense
+      private
+
+      def setup
+        cop_name = self.class.to_s.delete_suffix('Test')
+
+        @cop = RuboCop::Cop::Minitest.const_get(cop_name).new
+      end
+
+      def assert_no_offenses(source, file = nil)
+        setup_assertion
+
+        offenses = inspect_source(source, @cop, file)
+
+        expected_annotations = RuboCop::RSpec::ExpectOffense::AnnotatedSource.parse(source)
+        actual_annotations = expected_annotations.with_offense_annotations(offenses)
+
+        assert_equal(source, actual_annotations.to_s)
+      end
+
+      def assert_offense(source, file = nil)
+        setup_assertion
+
+        @cop.instance_variable_get(:@options)[:auto_correct] = true
+
+        expected_annotations = RuboCop::RSpec::ExpectOffense::AnnotatedSource.parse(source)
+        if expected_annotations.plain_source == source
+          raise 'Use `assert_no_offenses` to assert that no offenses are found'
+        end
+
+        @processed_source = parse_source!(expected_annotations.plain_source, file)
+
+        offenses = _investigate(@cop, @processed_source)
+
+        actual_annotations = expected_annotations.with_offense_annotations(offenses)
+
+        assert_equal(expected_annotations.to_s, actual_annotations.to_s)
+      end
+
+      def _investigate(cop, processed_source)
+        team = RuboCop::Cop::Team.new([cop], nil, raise_error: true)
+        report = team.investigate(processed_source)
+        @last_corrector = report.correctors.first || RuboCop::Cop::Corrector.new(processed_source)
+        report.offenses
+      end
+
+      def assert_correction(correction, loop: true)
+        raise '`assert_correction` must follow `assert_offense`' unless @processed_source
+
+        iteration = 0
+        new_source = loop do
+          iteration += 1
+
+          corrected_source = @last_corrector.rewrite
+
+          break corrected_source unless loop
+          break corrected_source if @last_corrector.empty? || corrected_source == @processed_source.buffer.source
+
+          if iteration > RuboCop::Runner::MAX_ITERATIONS
+            raise RuboCop::Runner::InfiniteCorrectionLoop.new(@processed_source.path, [])
+          end
+
+          # Prepare for next loop
+          @processed_source = parse_source!(corrected_source, @processed_source.path)
+
+          _investigate(@cop, @processed_source)
+        end
+
+        assert_equal(correction, new_source)
+      end
+
+      def setup_assertion
+        RuboCop::Formatter::DisabledConfigFormatter.config_to_allow_offenses = {}
+        RuboCop::Formatter::DisabledConfigFormatter.detected_styles = {}
+      end
+
+      def inspect_source(source, cop, file = nil)
+        processed_source = parse_source!(source, file)
+        raise 'Error parsing example code' unless processed_source.valid_syntax?
+
+        _investigate(cop, processed_source)
+      end
+
+      def investigate(cop, processed_source)
+        needed = Hash.new { |h, k| h[k] = [] }
+        Array(cop.class.joining_forces).each { |force| needed[force] << cop }
+        forces = needed.map do |force_class, joining_cops|
+          force_class.new(joining_cops)
+        end
+
+        commissioner = RuboCop::Cop::Commissioner.new([cop], forces, raise_error: true)
+        commissioner.investigate(processed_source)
+        commissioner
+      end
+
+      def parse_source!(source, file = nil)
+        if file.respond_to?(:write)
+          file.write(source)
+          file.rewind
+          file = file.path
+        end
+
+        RuboCop::ProcessedSource.new(source, ruby_version, file)
+      end
+
+      def ruby_version
+        2.5
+      end
+    end
+  end
+end

data/lib/rubocop/minitest/support.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Require this file to load code that supports testing using Minitest.
+
+require 'rubocop'
+require 'minitest/autorun'
+require 'minitest/pride'
+require_relative 'assert_offense'
+
+Minitest::Test.include RuboCop::Minitest::AssertOffense

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.16.0'
+      STRING = '0.17.0'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

data/relnotes/v0.17.0.md

@@ -0,0 +1,5 @@
+### New features
+
+* [#155](https://github.com/rubocop/rubocop-minitest/issues/155): Provide `assert_offense`, `assert_correction`, and `assert_no_offenses` testing APIs for custom Minitest cop development. ([@koic][])
+
+[@koic]: https://github.com/koic

data/tasks/cops_documentation.rake

@@ -10,24 +10,14 @@ YARD::Rake::YardocTask.new(:yard_for_generate_documentation) do |task|
   task.options = ['--no-output']
 end
 
-desc 'Generate docs of all cops departments'
-task generate_cops_documentation: :yard_for_generate_documentation do
+task update_cops_documentation: :yard_for_generate_documentation do
   deps = ['Minitest']
   CopsDocumentationGenerator.new(departments: deps).call
 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
-
-    # Output diff before raising error
-    sh('GIT_PAGER=cat git diff docs')
-
-    warn 'The docs directory is out of sync. Run `rake generate_cops_documentation` and commit the results.'
-    exit!
-  end
+desc 'Generate docs of all cops departments (obsolete)'
+task :generate_cops_documentation do
+  puts 'Updating the documentation is now done automatically!'
 end
 
 desc 'Syntax check for the documentation comments'

data/tasks/cut_release.rake

@@ -49,12 +49,25 @@ namespace :cut_release do
     version.split('.').take(2).join('.')
   end
 
+  # 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)}'")
+    end
+  end
+
   def new_version_changes
     changelog = File.read('CHANGELOG.md')
     _, _, new_changes, _older_changes = changelog.split(/^## .*$/, 4)
     new_changes
   end
 
+  def update_file(path)
+    content = File.read(path)
+    File.write(path, yield(content))
+  end
+
   def user_links(text)
     names = text.scan(/\[@(\S+)\]\[\]/).map(&:first).uniq
     names.map { |name| "[@#{name}]: https://github.com/#{name}" }
@@ -66,6 +79,9 @@ namespace :cut_release do
     Bump::Bump.run(release_type, commit: false, bundle: false, tag: false)
     new_version = Bump::Bump.current
 
+    update_cop_versions(old_version, new_version)
+    Rake::Task['update_cops_documentation'].invoke
+
     add_header_to_changelog(new_version)
     create_release_notes(new_version)
     update_antora_yml(new_version)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-minitest
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-14 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -130,7 +130,9 @@ files:
 - lib/rubocop/cop/mixin/minitest_exploration_helpers.rb
 - lib/rubocop/cop/mixin/nil_assertion_handleable.rb
 - lib/rubocop/minitest.rb
+- lib/rubocop/minitest/assert_offense.rb
 - lib/rubocop/minitest/inject.rb
+- lib/rubocop/minitest/support.rb
 - lib/rubocop/minitest/version.rb
 - mkdocs.yml
 - readthedocs.yml
@@ -149,6 +151,7 @@ files:
 - relnotes/v0.15.1.md
 - relnotes/v0.15.2.md
 - relnotes/v0.16.0.md
+- relnotes/v0.17.0.md
 - relnotes/v0.2.0.md
 - relnotes/v0.2.1.md
 - relnotes/v0.3.0.md
@@ -175,7 +178,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.16
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.17
   bug_tracker_uri: https://github.com/rubocop/rubocop-minitest/issues
   rubygems_mfa_required: 'true'
 post_install_message: