-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add auto correct multiple expectations #74
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
91c8838
WIP
Bhacaz 6bdaab7
Merge branch 'main' into add_auto_correct_multiple_expectations
Bhacaz 75ac7a7
Specs works
Bhacaz f604a46
include_context for all rspec cops
Bhacaz b264997
use module prepend
Bhacaz 1650af8
use module + prepend
Bhacaz dd482af
type rspec_cops
Bhacaz 635f98f
Merge branch 'main' into add_auto_correct_multiple_expectations
Bhacaz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
lib/rubocop/cop/rspec/multiple_expectations_auto_correct.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# frozen_string_literal: true | ||
|
||
require 'rubocop-rspec' | ||
|
||
module RuboCop | ||
module Cop | ||
module RSpec | ||
module MultipleExpectationsAutoCorrect | ||
def self.prepended(base) | ||
base.extend(AutoCorrector) | ||
end | ||
|
||
private | ||
|
||
def flag_example(node, expectation_count:) | ||
add_offense( | ||
node.send_node, | ||
message: format( | ||
MultipleExpectations::MSG, | ||
total: expectation_count, | ||
max: max_expectations | ||
) | ||
) do |corrector| | ||
autocorrect(node, corrector) | ||
end | ||
end | ||
|
||
def autocorrect(node, corrector) | ||
if (args = node.children.first.arguments.first) | ||
corrector.insert_after(args, ', :aggregate_failures') | ||
else | ||
corrector.insert_after(node.children.first, ' :aggregate_failures') | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end | ||
|
||
RuboCop::Cop::RSpec::MultipleExpectations | ||
.prepend(RuboCop::Cop::RSpec::MultipleExpectationsAutoCorrect) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
# frozen_string_literal: true | ||
|
||
# Test the cop directly | ||
RSpec.describe RuboCop::Cop::RSpec::MultipleExpectations, :config do | ||
it 'autocorrects multiple expectations with aggregate_failures' do | ||
expect_offense(<<~RUBY) | ||
describe Foo do | ||
it 'uses expect twice' do | ||
^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1]. | ||
expect(foo).to eq(bar) | ||
expect(baz).to eq(bar) | ||
end | ||
end | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
describe Foo do | ||
it 'uses expect twice', :aggregate_failures do | ||
expect(foo).to eq(bar) | ||
expect(baz).to eq(bar) | ||
end | ||
end | ||
RUBY | ||
|
||
expect_offense(<<~RUBY) | ||
describe Foo do | ||
it do | ||
^^ Example has too many expectations [2/1]. | ||
expect(foo).to eq(bar) | ||
expect(baz).to eq(bar) | ||
end | ||
end | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
describe Foo do | ||
it :aggregate_failures do | ||
expect(foo).to eq(bar) | ||
expect(baz).to eq(bar) | ||
end | ||
end | ||
RUBY | ||
|
||
expect_offense(<<~RUBY) | ||
describe Foo do | ||
it('uses expect twice') do | ||
^^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1]. | ||
expect(foo).to eq(bar) | ||
expect(baz).to eq(bar) | ||
end | ||
end | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
describe Foo do | ||
it('uses expect twice', :aggregate_failures) do | ||
expect(foo).to eq(bar) | ||
expect(baz).to eq(bar) | ||
end | ||
end | ||
RUBY | ||
|
||
expect_offense(<<~RUBY) | ||
describe Foo do | ||
it 'uses expect twice', timecop: true do | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1]. | ||
expect(foo).to eq(bar) | ||
expect(baz).to eq(bar) | ||
end | ||
end | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
describe Foo do | ||
it 'uses expect twice', :aggregate_failures, timecop: true do | ||
expect(foo).to eq(bar) | ||
expect(baz).to eq(bar) | ||
end | ||
end | ||
RUBY | ||
|
||
expect_offense(<<~RUBY) | ||
describe Foo do | ||
it('uses expect twice', timecop: true) do | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1]. | ||
expect(foo).to eq(bar) | ||
expect(baz).to eq(bar) | ||
end | ||
end | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
describe Foo do | ||
it('uses expect twice', :aggregate_failures, timecop: true) do | ||
expect(foo).to eq(bar) | ||
expect(baz).to eq(bar) | ||
end | ||
end | ||
RUBY | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bien pensé 💡