[Fix #155] Provide assert_offense and assert_no_offenses for custom cop development
#156
Conversation
…or custom cop development Resolves rubocop#155. This PR provides `assert_offense`, `assert_correction`, and `assert_no_offenses` testing APIs for custom Minitest cop development. Developers can use these APIs by requesting the following in custom Minitest cop test code: ```ruby require 'rubocop/minitest/support' ```
koic
force-pushed
the
provide_assertion_apis
branch
from
443ef48
to
abbfd58
Compare
|
Thank you very much! |
|
@alex4787 Yeah, I've just released 0.17.0 :-) |
|
@koic Thanks, appreciate the quick addition! And sorry to tack on another thing, but we were wondering if this could also be included in the main RuboCop gem as well, to provide a Minitest testing option (in addition to the RSpec testing API currently there) for any custom cop development, not only specific to Minitest-related cops. |
|
Thank you for sharing your ideas. However, the APIs started with RuboCop Minitest's dogfooding. It wasn't essentially intended to have in the RuboCop core. TBH, it would be undesirable to provide APIs for multiple testing frameworks in the RuboCop core. So, this API focuses on custom RuboCop Minitest development. Thank you. |
|
Got it, thanks for the context here. 😄 |
Follow up rubocop/rubocop#10987. ```console % bundle exec rake (snip) NoMethodError: undefined method `disabled' for nil:NilClass registry.disabled(config).each do |cop| ^^^^^^^^^ /Users/koic/.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/bundler/gems/rubocop-479e588e16cd/lib/rubocop/comment_config.rb:94:in `inject_disabled_cops_directives' /Users/koic/.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/bundler/gems/rubocop-479e588e16cd/lib/rubocop/comment_config.rb:78:in `analyze' /Users/koic/.rbenv/versions/3.1.2/lib/ruby/gems/3.1.0/bundler/gems/rubocop-479e588e16cd/lib/rubocop/comment_config.rb:45:in `cop_disabled_line_ranges' ``` It supports multiple RuboCop core versions for compatibility with rubocop#156.
Resolves #155.
This PR provides
assert_offense,assert_correction, andassert_no_offensesfor custom Minitest cop development.Developers can use these APIs by requesting the following in custom Minitest cop test code:
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.and description in grammatically correct, complete sentences.
bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.