rubocop-minitest 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c7ce50a5646f2bad96ee8d2b6c5e038493e7690d75c040f97598f4ea36c7617
-  data.tar.gz: e0de4fc4ec8b0bb2edcd30a9fd79dc47ffb0bbec832fd8f6b567657c080911a5
+  metadata.gz: ee9ffa711b1d8af3e0efded458b42333d3c297e9b2f65ec9dc311e5577398552
+  data.tar.gz: 801b3f7a5100a60528f8643ece061ad2dab145f0d52335a9cd7070190a03f2ff
 SHA512:
-  metadata.gz: fef612ef3f6893b6c1fb54a4f71a643dfc7cde7c8b980594b41635511fe7e2f83fa0775466006acab09f45f435024a8f6c001ebecb4c1f67d67357b0d3388fbf
-  data.tar.gz: 0725f8782b018823060f2b6192de3e2365b87dbb97997960410f2bb61d1c9a71a916fd5d2b0d537892f41114c2e2b38a217c71e686c87b1421abf300ce55edcb
+  metadata.gz: c9568032ba4258bd449864b1cc982d5e1f85b44e862e360b3ad9dcaa3b96ec9c497c51901632015d45b184611cbe4c376fe7786b77ded3197baa0b44e26c4a28
+  data.tar.gz: 810285b00445e4c90e576f5875d01f151a8d031ac6da3595087e1e6df958464e7d8add79a230a9dd2086c5fd030f5e99153b9011b868eadd4a9fd19c0ed87993

data/.circleci/config.yml

@@ -0,0 +1,43 @@
+version: 2.1
+
+jobs:
+  rake_default:
+    parameters:
+      image:
+        description: "Name of the Docker image."
+        type: string
+        default: "circleci/ruby"
+    docker:
+      - image: << parameters.image >>
+    environment:
+      # CircleCI container has two cores, but Ruby can see 32 cores. So we
+      # configure test-queue.
+      # See https://github.com/tmm1/test-queue#environment-variables
+      TEST_QUEUE_WORKERS: 2
+      JRUBY_OPTS: "--dev -J-Xmx1000M"
+    steps:
+      - checkout
+      - run: bundle install
+      - run: bundle exec rake
+
+workflows:
+  build:
+    jobs:
+      - rake_default:
+          name: Ruby 2.3
+          image: circleci/ruby:2.3
+      - rake_default:
+          name: Ruby 2.4
+          image: circleci/ruby:2.4
+      - rake_default:
+          name: Ruby 2.5
+          image: circleci/ruby:2.5
+      - rake_default:
+          name: Ruby 2.6
+          image: circleci/ruby:2.6
+      - rake_default:
+          name: Ruby HEAD
+          image: rubocophq/circleci-ruby-snapshot:latest # Nightly snapshot build
+      - rake_default:
+          name: JRuby 9.2
+          image: circleci/jruby:9.2

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: Bug Report
+about: Report an issue with RuboCop Minitest you've discovered.
+---
+
+*Be clear, concise and precise in your description of the problem.
+Open an issue with a descriptive title and a summary in grammatically correct,
+complete sentences.*
+
+*Use the template below when reporting bugs. Please, make sure that
+you're running the latest stable RuboCop and that the problem you're reporting
+hasn't been reported (and potentially fixed) already.*
+
+*Before filing the ticket you should replace all text above the horizontal
+rule with your own words.*
+
+--------
+
+## Expected behavior
+
+Describe here how you expected RuboCop Minitest to behave in this particular situation.
+
+## Actual behavior
+
+Describe here what actually happened.
+
+## Steps to reproduce the problem
+
+This is extremely important! Providing us with a reliable way to reproduce
+a problem will expedite its solution.
+
+## RuboCop version
+
+Include the output of `rubocop -V` or `bundle exec rubocop -V` if using Bundler. Here's an example:
+
+```
+$ [bundle exec] rubocop -V
+0.74.0 (using Parser 2.6.4.0, running on ruby 2.6.4 x86_64-darwin17)
+```

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature Request
+about: Suggest new RuboCop Rails features or improvements to existing features.
+---
+
+## Is your feature request related to a problem? Please describe.
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+## Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+## Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+**Replace this text with a summary of the changes in your PR.
+The more detailed you are, the better.**
+
+-----------------
+
+Before submitting the PR make sure the following are checked:
+
+* [ ] Wrote [good commit messages][1].
+* [ ] Commit message starts with `[Fix #issue-number]` (if the related issue exists).
+* [ ] Feature branch is up-to-date with `master` (if not - rebase it).
+* [ ] Squashed related commits together.
+* [ ] Added tests.
+* [ ] Added an entry to the [Changelog](https://github.com/rubocop-hq/rubocop-minitest/blob/master/CHANGELOG.md) if the new code introduces user-observable changes. See [changelog entry format](https://github.com/rubocop-hq/rubocop-minitest/blob/master/CONTRIBUTING.md#changelog-entry-format).
+* [ ] The PR relates to *only* one subject with a clear title
+  and description in grammatically correct, complete sentences.
+* [ ] Run `bundle exec rake default`. It executes all tests and RuboCop for itself, and generates the documentation.
+
+[1]: https://chris.beams.io/posts/git-commit/

data/.gitignore

@@ -1,11 +1,61 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+Gemfile.lock
+Gemfile.local
+
+# rbenv
+.ruby-version
+
+# rspec
+/spec/examples.txt
+/.test_queue_stats
+
+# jeweler generated
+pkg
+
+# etags
+TAGS
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rubocop.yml

@@ -0,0 +1,85 @@
+inherit_from: .rubocop_todo.yml
+
+# This is the configuration used to check the rubocop source code.
+
+require:
+  - rubocop/cop/internal_affairs
+  - rubocop-performance
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Naming/PredicateName:
+  # Method define macros for dynamically generated method.
+  MethodDefinitionMacros:
+    - define_method
+    - define_singleton_method
+    - def_node_matcher
+    - def_node_search
+
+Style/FormatStringToken:
+  # Because we parse a lot of source codes from strings. Percent arrays
+  # look like unannotated format string tokens to this cop.
+  Exclude:
+    - test/**/*
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+      - module_inclusion
+      - constants
+      - public_class_methods
+      - initializer
+      - instance_methods
+      - protected_methods
+      - private_methods
+
+# Trailing white space is meaningful in code examples
+Layout/TrailingWhitespace:
+  AllowInHeredoc: true
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'test/**/*.rb'
+
+Lint/InterpolationCheck:
+  Exclude:
+    - 'test/**/*.rb'
+
+Lint/UselessAccessModifier:
+  MethodCreatingMethods:
+    - 'def_matcher'
+    - 'def_node_matcher'
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'test/**/*.rb'
+
+Naming/FileName:
+  Exclude:
+    - lib/rubocop-minitest.rb
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'test/**/*.rb'
+
+Performance/ChainArrayAllocation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,23 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-08-07 15:41:02 +0900 using RuboCop version 0.74.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 17
+
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 87

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## master (unreleased)
+
+## 0.1.0 (2019-09-01)
+
+### New features
+
+* Create RuboCop Minitest gem. ([@koic][])
+* [#6](https://github.com/rubocop-hq/rubocop-minitest/pull/6): Add new `Minitest/AssertNil` cop. ([@duduribeiro ][])
+
+[@koic]: https://github.com/koic
+[@duduribeiro]: https://github.com/duduribeiro

data/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing
+
+If you discover issues, have ideas for improvements or new features,
+please report them to the [issue tracker][1] of the repository or
+submit a pull request. Please, try to follow these guidelines when you
+do so.
+
+## Issue reporting
+
+* Check that the issue has not already been reported.
+* Check that the issue has not already been fixed in the latest code
+  (a.k.a. `master`).
+* Be clear, concise and precise in your description of the problem.
+* Open an issue with a descriptive title and a summary in grammatically correct,
+  complete sentences.
+* Include the output of `rubocop -V`:
+
+```
+$ rubocop -V
+0.74.0 (using Parser 2.6.4.0, running on ruby 2.6.4 x86_64-darwin17)
+```
+
+* Include any relevant code to the issue summary.
+
+## Pull requests
+
+* Read [how to properly contribute to open source projects on GitHub][2].
+* Fork the project.
+* Use a topic/feature branch to easily amend a pull request later, if necessary.
+* Write [good commit messages][3].
+* Use the same coding conventions as the rest of the project.
+* Commit and push until you are happy with your contribution.
+* If your change has a corresponding open GitHub issue, prefix the commit message with `[Fix #github-issue-number]`.
+* Make sure to add tests for it. This is important so I don't break it
+  in a future version unintentionally.
+* Add an entry to the [Changelog](CHANGELOG.md) accordingly. See [changelog entry format](#changelog-entry-format).
+* Please try not to mess with the Rakefile, version, or history. If
+  you want to have your own version, or is otherwise necessary, that
+  is fine, but please isolate to its own commit so I can cherry-pick
+  around it.
+* Make sure the test suite is passing and the code you wrote doesn't produce
+  RuboCop offenses (usually this is as simple as running `bundle exec rake`).
+* [Squash related commits together][5].
+* Open a [pull request][4] that relates to *only* one subject with a clear title
+  and description in grammatically correct, complete sentences.
+
+### Changelog entry format
+
+Here are a few examples:
+
+```
+* [#716](https://github.com/rubocop-hq/rubocop-minitest/issues/716): Fixed a regression in the auto-correction logic of `MethodDefParentheses`. ([@bbatsov][])
+* New cop `ElseLayout` checks for odd arrangement of code in the `else` branch of a conditional expression. ([@bbatsov][])
+```
+
+* Mark it up in [Markdown syntax][6].
+* The entry line should start with `* ` (an asterisk and a space).
+* If the change has a related GitHub issue (e.g. a bug fix for a reported issue), put a link to the issue as `[#123](https://github.com/rubocop-hq/rubocop-minitest/issues/123): `.
+* Describe the brief of the change. The sentence should end with a punctuation.
+* At the end of the entry, add an implicit link to your GitHub user page as `([@username][])`.
+* If this is your first contribution to RuboCop project, add a link definition for the implicit link to the bottom of the changelog as `[@username]: https://github.com/username`.
+
+[1]: https://github.com/rubocop-hq/rubocop-minitest/issues
+[2]: https://www.gun.io/blog/how-to-github-fork-branch-and-pull-request
+[3]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[4]: https://help.github.com/articles/about-pull-requests
+[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
+[6]: https://daringfireball.net/projects/markdown/syntax

data/Gemfile

@@ -1,4 +1,12 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-# Specify your gem's dependencies in rubocop-minitest.gemspec
 gemspec
+
+gem 'rake'
+gem 'rubocop', github: 'rubocop-hq/rubocop'
+gem 'rubocop-performance', '~> 1.4.0'
+gem 'yard', '~> 0.9'

data/README.md

@@ -1,3 +1,79 @@
-# Rubocop minitest
+# RuboCop Minitest
 
-This is a repository reserved for minitest-specific analysis for your projects, as an extension to [RuboCop](https://github.com/rubocop-hq/rubocop).
+A [RuboCop](https://github.com/rubocop-hq/rubocop) extension focused on enforcing Minitest best practices and coding conventions.
+
+## Installation
+
+Just install the `rubocop-minitest` gem
+
+```bash
+gem install rubocop-minitest
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```
+gem 'rubocop-minitest'
+```
+
+## Usage
+
+You need to tell RuboCop to load the Minitest extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-minitest
+```
+
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rubocop-minitest
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Minitest
+cops together with the standard cops.
+
+### Command line
+
+```bash
+rubocop --require rubocop-minitest
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-minitest'
+end
+```
+
+## The Cops
+
+All cops are located under
+[`lib/rubocop/cop/minitest`](lib/rubocop/cop/minitest), and contain
+examples/documentation.
+
+In your `.rubocop.yml`, you may treat the Minitest cops just like any other
+cop. For example:
+
+```yaml
+Minitest/AssertNil:
+  Exclude:
+    - test/my_file_to_ignore_test.rb
+```
+
+## Contributing
+
+Checkout the [contribution guidelines](CONTRIBUTING.md).
+
+## License
+
+`rubocop-minitest` is MIT licensed. [See the accompanying file](LICENSE.txt) for
+the full text.

data/Rakefile

@@ -1,6 +1,38 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
-RSpec::Core::RakeTask.new(:spec)
+require 'bundler'
+require 'bundler/gem_tasks'
 
-task :default => :spec
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rubocop/rake_task'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc 'Run RuboCop over itself'
+RuboCop::RakeTask.new(:internal_investigation).tap do |task|
+  if RUBY_ENGINE == 'ruby' &&
+     RbConfig::CONFIG['host_os'] !~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+    task.options = %w[--parallel]
+  end
+end
+
+task default: %i[
+  documentation_syntax_check
+  generate_cops_documentation
+  test
+  internal_investigation
+]

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rubocop/minitest"
+require 'bundler/setup'
+require 'rubocop/minitest'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "rubocop/minitest"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/config/default.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Include:
+    - '**/test/**/*'
+
+Minitest/AssertNil:
+  Description: 'Check if your test uses `assert_nil` instead of `assert_equal(nil, something)`.'
+  StyleGuide: 'https://github.com/rubocop-hq/minitest-style-guide#assert-nil'
+  Enabled: true
+  VersionAdded: '0.1'

data/lib/rubocop-minitest.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'yaml'
+
+require 'rubocop'
+
+require_relative 'rubocop/minitest'
+require_relative 'rubocop/minitest/version'
+require_relative 'rubocop/minitest/inject'
+
+RuboCop::Minitest::Inject.defaults!
+
+require_relative 'rubocop/cop/minitest_cops'

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Minitest
+      # Check if your test uses `assert_nil` instead of `assert_equal(nil, something)`.
+      #
+      # @example
+      #   # bad
+      #   assert_equal(nil, actual)
+      #   assert_equal(nil, actual, 'the message')
+      #
+      #   # good
+      #   assert_nil(actual)
+      #   assert_nil(actual, 'the message')
+      #
+      class AssertNil < Cop
+        MSG = 'Prefer using `assert_nil(%<arguments>s)` over ' \
+              '`assert_equal(nil, %<arguments>s)`.'
+
+        def_node_matcher :assert_equal_with_nil, <<~PATTERN
+          (send nil? :assert_equal nil $_ $...)
+        PATTERN
+
+        def on_send(node)
+          assert_equal_with_nil(node) do |actual, message|
+            message = message.first
+
+            arguments = [actual.source, message&.source].compact.join(', ')
+
+            add_offense(node, message: format(MSG, arguments: arguments))
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            arguments = node.arguments.reject(&:nil_type?)
+            replacement = arguments.map(&:source).join(', ')
+            corrector.replace(node.loc.expression, "assert_nil(#{replacement})")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/minitest_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'minitest/assert_nil'

data/lib/rubocop/minitest.rb

@@ -1,8 +1,12 @@
-require "rubocop/minitest/version"
+# frozen_string_literal: true
 
-module Rubocop
+module RuboCop
+  # RuboCop minitest project namespace
   module Minitest
-    class Error < StandardError; end
-    # Your code goes here...
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
   end
 end

data/lib/rubocop/minitest/inject.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Minitest
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/minitest/version.rb

@@ -1,5 +1,7 @@
-module Rubocop
+# frozen_string_literal: true
+
+module RuboCop
   module Minitest
-    VERSION = "0.0.1"
+    VERSION = '0.1.0'
   end
 end

data/manual/cops.md

@@ -0,0 +1,6 @@
+<!-- START_COP_LIST -->
+#### Department [Minitest](cops_minitest.md)
+
+* [Minitest/AssertNil](cops_minitest.md#minitestassertnil)
+
+<!-- END_COP_LIST -->

data/manual/cops_minitest.md

@@ -0,0 +1,25 @@
+# Minitest
+
+## Minitest/AssertNil
+
+Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+--- | --- | --- | --- | ---
+Enabled | Yes | Yes  | 0.1 | -
+
+Check if your test uses `assert_nil` instead of `assert_equal(nil, something)`.
+
+### Examples
+
+```ruby
+# bad
+assert_equal(nil, actual)
+assert_equal(nil, actual, 'the message')
+
+# good
+assert_nil(actual)
+assert_nil(actual, 'the message')
+```
+
+### References
+
+* [https://github.com/rubocop-hq/minitest-style-guide#assert-nil](https://github.com/rubocop-hq/minitest-style-guide#assert-nil)

data/manual/index.md

@@ -0,0 +1 @@
+A [RuboCop](https://github.com/rubocop-hq/rubocop) extension focused on enforcing Minitest best practices and coding conventions.

data/manual/installation.md

@@ -0,0 +1,11 @@
+Just install the `rubocop-minitest` gem
+
+```sh
+gem install rubocop-minitest
+```
+
+or if you use bundler put this in your `Gemfile`
+
+```ruby
+gem 'rubocop-minitest'
+```

data/manual/usage.md

@@ -0,0 +1,27 @@
+You need to tell RuboCop to load the Minitest extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml`.
+
+```yaml
+require: rubocop-minitest
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Minitest
+cops together with the standard cops.
+
+### Command line
+
+```sh
+rubocop --require rubocop-minitest
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-minitest'
+end
+```

data/rubocop-minitest.gemspec

@@ -1,29 +1,39 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rubocop/minitest/version"
+require 'rubocop/minitest/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rubocop-minitest"
-  spec.version       = Rubocop::Minitest::VERSION
-  spec.authors       = ['Bozhidar Batsov', 'Jonas Arvidsson', 'Koichi ITO']
+  spec.name = 'rubocop-minitest'
+  spec.version = RuboCop::Minitest::VERSION
+  spec.authors = ['Bozhidar Batsov', 'Jonas Arvidsson', 'Koichi ITO']
 
-  spec.summary       = 'This namespace is reserved by RuboCop HQ.'
-  spec.description   = 'This namespace is reserved by RuboCop HQ.'
-  spec.license       = 'MIT'
+  spec.summary = 'Automatic Minitest code style checking tool.'
+  spec.description = <<~DESCRIPTION
+    Automatic Minitest code style checking tool.
+    A RuboCop extension focused on enforcing Minitest best practices and coding conventions.
+  DESCRIPTION
+  spec.license = 'MIT'
 
-  spec.metadata["homepage_uri"] =  'https://github.com/rubocop-hq/rubocop-minitest'
-  spec.metadata["source_code_uri"] = 'https://github.com/rubocop-hq/rubocop-minitest'
+  spec.required_ruby_version = '>= 2.3.0'
+  spec.metadata = {
+    'homepage_uri' => 'https://github.com/rubocop-hq/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://github.com/rubocop-hq/rubocop-minitest/manual',
+    'bug_tracker_uri' => 'https://github.com/rubocop-hq/rubocop-minitest/issues'
+  }
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency 'rubocop', '>= 0.74'
+  spec.add_development_dependency 'minitest', '~> 5.11'
 end

data/tasks/cops_documentation.rake

@@ -0,0 +1,312 @@
+# frozen_string_literal: true
+
+require 'yard'
+require 'rubocop'
+require 'rubocop-minitest'
+
+YARD::Rake::YardocTask.new(:yard_for_generate_documentation) do |task|
+  task.files = ['lib/rubocop/cop/**/*.rb']
+  task.options = ['--no-output']
+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')
+
+    YARD::Registry.load!
+    cops.departments.sort!.each do |department|
+      print_cops_of_department(cops, department, config)
+    end
+
+    print_table_of_contents(cops)
+
+    assert_manual_synchronized if ENV['CI'] == 'true'
+  ensure
+    RuboCop::ConfigLoader.default_configuration = nil
+  end
+
+  main
+end
+
+desc 'Syntax check for the documentation comments'
+task documentation_syntax_check: :yard_for_generate_documentation do
+  require 'parser/ruby25'
+
+  ok = true
+  YARD::Registry.load!
+  cops = RuboCop::Cop::Cop.registry
+  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
+
+      break code_object.tags('example')
+    end
+
+    examples.to_a.each do |example|
+      begin
+        buffer = Parser::Source::Buffer.new('<code>', 1)
+        buffer.source = example.text
+        parser = Parser::Ruby25.new(RuboCop::AST::Builder.new)
+        parser.diagnostics.all_errors_are_fatal = true
+        parser.parse(buffer)
+      rescue Parser::SyntaxError => e
+        path = example.object.file
+        puts "#{path}: Syntax Error in an example. #{e}"
+        ok = false
+      end
+    end
+  end
+  abort unless ok
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-minitest
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,74 +10,82 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2019-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '0.74'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.74'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-description: This namespace is reserved by RuboCop HQ.
+        version: '5.11'
+description: |
+  Automatic Minitest code style checking tool.
+  A RuboCop extension focused on enforcing Minitest best practices and coding conventions.
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- config/default.yml
+- lib/rubocop-minitest.rb
+- lib/rubocop/cop/minitest/assert_nil.rb
+- lib/rubocop/cop/minitest_cops.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
 - rubocop-minitest.gemspec
+- tasks/cops_documentation.rake
 homepage: 
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/rubocop-hq/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://github.com/rubocop-hq/rubocop-minitest/manual
+  bug_tracker_uri: https://github.com/rubocop-hq/rubocop-minitest/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -86,15 +94,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: This namespace is reserved by RuboCop HQ.
+summary: Automatic Minitest code style checking tool.
 test_files: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.0.2