rubocop-minitest 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b6cb0236ad583a81b4b3d12fdf4bf9d83cb53cfb565973fd54e5ae8a9dbd487
-  data.tar.gz: 6e41c1f11d6e20f29fbff140a71bf44c6e67db274b6cc30531220839e9c903b7
+  metadata.gz: 2ad49b7b1f0f0d916cb20400f58ea616d13663e99a57719d9b4a8a373a859a5d
+  data.tar.gz: c69990256d72a503f7bf072273fe077f7c2eea32fd6c7f13b2f2fe83f18c8780
 SHA512:
-  metadata.gz: 2ea2746f324798c678144e938f35e392dc9062d4ccdbd184726d0dd122ddd564c993db2ab20c7d45f989f542adca8e692e40f6d2edeef1201e7415ab2c78b625
-  data.tar.gz: 8448666265020b303754a109336f055402bdd375b020261a6d46f61d682c979e1e42edff409124bb9ee2cbc43744383f260c6b5908f55737c7b2fdefdf4856de
+  metadata.gz: c6899f78263d3d2728d5f0074d36c6813b8392d910524193f871ef1313af59fc78270ddb7ffa8b5b11c83c6c6f9bc6f0a8e57203dd54ffb3d81f1b036b025913
+  data.tar.gz: c402e470711d7432317c48c19c64e3b27c701855ceea1557abcf8418e6dd5ecfa33b0433372f9a73fa58ab956989aed7fbdb6b8f227e16b32272d9813d29c5d3

data/.circleci/config.yml

@@ -20,9 +20,24 @@ jobs:
       - run: bundle install
       - run: bundle exec rake
 
+  # Miscellaneous tasks
+  documentation-checks:
+    docker:
+      - image: circleci/ruby
+    steps:
+      - checkout
+      - run: bundle install
+      - 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:
     jobs:
+      - documentation-checks
       - rake_default:
           name: Ruby 2.4
           image: circleci/ruby:2.4

data/.rubocop.yml

@@ -10,6 +10,7 @@ require:
 AllCops:
   NewCops: enable
   TargetRubyVersion: 2.4
+  SuggestExtensions: false
 
 Naming/PredicateName:
   # Method define macros for dynamically generated method.

data/.rubocop_todo.yml

@@ -1,16 +1,17 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-12-21 01:15:41 +0900 using RuboCop version 0.78.0.
+# on 2020-10-29 02:01:16 UTC using RuboCop version 1.0.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: 19
-# Configuration parameters: CountComments, ExcludedMethods.
+# Offense count: 22
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
 Metrics/MethodLength:
   Max: 14
+
+# Offense count: 1
+Style/DocumentDynamicEvalDefinition:
+  Exclude:
+    - 'lib/rubocop/cop/mixin/minitest_cop_rule.rb'

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## master (unreleased)
 
+## 0.10.2 (2020-12-27)
+
+### 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][])
+
 ## 0.10.1 (2020-07-25)
 
 ### Bug fixes

data/Gemfile

@@ -9,5 +9,5 @@ gemspec
 gem 'bump', require: false
 gem 'rake'
 gem 'rubocop', github: 'rubocop-hq/rubocop'
-gem 'rubocop-performance', '~> 1.6.0'
+gem 'rubocop-performance', '~> 1.9.0'
 gem 'yard', '~> 0.9'

data/README.md

@@ -77,6 +77,22 @@ Minitest/AssertNil:
 
 You can read a lot more about RuboCop Minitest in its [official docs](https://docs.rubocop.org/rubocop-minitest/).
 
+## Readme Badge
+
+If you use RuboCop Minitest in your project, you can include one of these badges in your readme to let people know that your code is written following the community Minitest Style Guide.
+
+[![Minitest Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop-minitest)
+
+[![Minitest Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://minitest.rubystyle.guide)
+
+Here are the Markdown snippets for the two badges:
+
+``` markdown
+[![Minitest Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop-minitest)
+
+[![Minitest Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://minitest.rubystyle.guide)
+```
+
 ## Contributing
 
 Checkout the [contribution guidelines](CONTRIBUTING.md).

data/docs/modules/ROOT/pages/cops.adoc

@@ -1,6 +1,17 @@
+= Cops
+
+In RuboCop lingo the various checks performed on the code are called cops.
+Each cop is responsible for detecting one particular offense.
+RuboCop Minitest has only one Minitest department.
+
+== Minitest
+
+Minitest cops check for Minitest best practices and coding conventions. Many of the them are
+based on the https://minitest.rubystyle.guide/[Minitest Style Guide].
+
 // START_COP_LIST
 
-= Department xref:cops_minitest.adoc[Minitest]
+=== Department xref:cops_minitest.adoc[Minitest]
 
 * xref:cops_minitest.adoc#minitestassertempty[Minitest/AssertEmpty]
 * xref:cops_minitest.adoc#minitestassertemptyliteral[Minitest/AssertEmptyLiteral]

data/docs/modules/ROOT/pages/cops_minitest.adoc

@@ -638,7 +638,7 @@ refute_empty(object, 'message')
 |===
 
 This cop enforces the use of `refute_equal(expected, object)`
-over `assert_equal(expected != actual)` or `assert(! expected == actual)`.
+over `assert(expected != actual)` or `assert(! expected == actual)`.
 
 === Examples
 

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

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Minitest
       # This cop enforces the use of `refute_equal(expected, object)`
-      # over `assert_equal(expected != actual)` or `assert(! expected == actual)`.
+      # over `assert(expected != actual)` or `assert(! expected == actual)`.
       #
       # @example
       #   # bad

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

@@ -57,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/minitest/version.rb

@@ -2,6 +2,13 @@
 
 module RuboCop
   module Minitest
-    VERSION = '0.10.1'
+    # 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/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/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.'
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
     '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/rubocop-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.87'
+  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,302 +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 << required_ruby_version(cop)
-    content << properties(cop.new(config))
-    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 << "\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(cop_instance)
-    header = [
-      'Enabled by default', 'Safe', 'Supports autocorrection', 'VersionAdded',
-      'VersionChanged'
-    ]
-    autocorrect = if cop_instance.support_autocorrect?
-                    "Yes#{' (Unsafe)' unless cop_instance.safe_autocorrect?}"
-                  else
-                    'No'
-                  end
-    cop_config = cop_instance.cop_config
-    content = [[
-      cop_status(cop_config.fetch('Enabled')),
-      cop_config.fetch('Safe', true) ? 'Yes' : 'No',
-      autocorrect,
-      cop_config.fetch('VersionAdded', '-'),
-      cop_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 = +"[source,ruby]\n----\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') }
-              .reject { |key| key.start_with?('AllowMultipleStyles') }
-    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'
-    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(' | ')}\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)
-    value =
-      case val
-      when Array
-        if val.empty?
-          '`[]`'
-        else
-          val.map { |config| format_table_value(config) }.join(', ')
-        end
-      else
-        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(
-      config, cop.name, cop_config, {}
-    ).urls
-    return '' if urls.empty?
-
-    content = h3('References')
-    content << urls.map { |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?
-
-    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}/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
-
-  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 = []
-    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|
-      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}.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 << "* xref:#{filename}##{anchor}[#{cop.cop_name}]\n"
-    end
-
-    content
-  end
-  # rubocop:enable Metrics/AbcSize
-
-  def print_table_of_contents(cops)
-    path = "#{Dir.pwd}/docs/modules/ROOT/pages/cops.adoc"
-    original = File.read(path)
-    content = +"// START_COP_LIST\n\n"
-
-    content << table_contents(cops)
-
-    content << "\n// END_COP_LIST"
-
-    content = original.sub(
-      %r{// START_COP_LIST.+// END_COP_LIST}m, content
-    )
-    File.write(path, content)
-  end
-
-  def table_contents(cops)
-    cops
-      .departments
-      .map(&:to_s)
-      .sort
-      .map { |department| table_of_content_for_department(cops, department) }
-      .compact
-      .join("\n")
-  end
-
-  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 docs') do |outcome, _|
-      return 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
-  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_docs_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'
@@ -315,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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-minitest
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Bozhidar Batsov
 - Jonas Arvidsson
 - Koichi ITO
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2020-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -19,6 +19,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.87'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,6 +29,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.87'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -43,7 +49,7 @@ dependencies:
 description: |
   Automatic Minitest code style checking tool.
   A RuboCop extension focused on enforcing Minitest best practices and coding conventions.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -124,6 +130,7 @@ files:
 - relnotes/v0.1.0.md
 - relnotes/v0.10.0.md
 - relnotes/v0.10.1.md
+- relnotes/v0.10.2.md
 - relnotes/v0.2.0.md
 - relnotes/v0.2.1.md
 - relnotes/v0.3.0.md
@@ -141,16 +148,16 @@ files:
 - rubocop-minitest.gemspec
 - tasks/cops_documentation.rake
 - tasks/cut_release.rake
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata:
   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/rubocop-minitest/
+  documentation_uri: https://docs.rubocop.org/rubocop-minitest/0.10
   bug_tracker_uri: https://github.com/rubocop-hq/rubocop-minitest/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,8 +172,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Automatic Minitest code style checking tool.
 test_files: []