Skip to content

Commit

Permalink
[Fix rubocop#2173] Style/AlignParameters also checks parameters on …
Browse files Browse the repository at this point in the history 
…method definitions

The same 2 styles which AlignParameters already supports are applied in just the same
way to method definitions as to calls.
  • Loading branch information
@alexdowad
alexdowad committed Nov 2, 2015
1 parent d196236 commit b5776f7
Show file tree
Hide file tree
Showing 3 changed files with 196 additions and 7 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
* Added ability to download shared rubocop config files from remote urls. ([@ptrippett][])
* [#1601](https://github.com/bbatsov/rubocop/issues/1601): Add `IgnoreEmptyMethods` config parameter for `Lint/UnusedMethodArgument` and `IgnoreEmptyBlocks` config parameter for `Lint/UnusedBlockArgument` cops. ([@alexdowad][])
* [#1729](https://github.com/bbatsov/rubocop/issues/1729): `Style/MethodDefParentheses` supports new 'require_no_parentheses_except_multiline' style. ([@alexdowad][])
* [#2173](https://github.com/bbatsov/rubocop/issues/2173): `Style/AlignParameters` also checks parameter alignment for method definitions. ([@alexdowad][])

### Bug Fixes

Expand Down
26 changes: 19 additions & 7 deletions lib/rubocop/cop/style/align_parameters.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,33 @@
module RuboCop
module Cop
module Style
# Here we check if the parameters on a multi-line method call are
# aligned.
# Here we check if the parameters on a multi-line method call or
# definition are aligned.
class AlignParameters < Cop
include AutocorrectAlignment

MSG = 'Align the parameters of a method call if they span ' \
'more than one line.'
include OnMethodDef

def on_send(node)
_receiver, method, *args = *node

return if method == :[]=
return if args.size <= 1
return if args.size < 2

check_alignment(args, base_column(node, args))
end

def on_method_def(node, _method_name, args, _body)
args = args.children
return if args.size < 2
check_alignment(args, base_column(node, args))
end

def message(node)
type = node.parent.send_type? ? 'call' : 'definition'
"Align the parameters of a method #{type} if they span " \
'more than one line.'
end

private

def fixed_indentation?
Expand All @@ -38,7 +48,9 @@ def base_column(node, args)
end

def target_method_lineno(node)
if node.loc.selector
if node.def_type? || node.defs_type?
node.loc.keyword.line
elsif node.loc.selector
node.loc.selector.line
else
# l.(1) has no selector, so we use the opening parenthesis instead
Expand Down
176 changes: 176 additions & 0 deletions spec/rubocop/cop/style/align_parameters_spec.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,94 @@
expect(cop.offenses).to be_empty
end

context 'method definitions' do
it 'registers an offense for parameters with single indent' do
inspect_source(cop, ['def method(a,',
' b)',
'end'])
expect(cop.offenses.size).to eq 1
expect(cop.offenses.first.to_s).to match(/method definition/)
end

it 'registers an offense for parameters with double indent' do
inspect_source(cop, ['def method(a,',
' b)',
'end'])
expect(cop.offenses.size).to eq 1
end

it 'accepts parameter lists on a single line' do
inspect_source(cop, ['def method(a, b)',
'end'])
expect(cop.offenses).to be_empty
end

it 'accepts proper indentation' do
inspect_source(cop, ['def method(a,',
' b)',
'end'])
expect(cop.offenses).to be_empty
end

it 'accepts the first parameter being on a new row' do
inspect_source(cop, ['def method(',
' a,',
' b)',
'end'])
expect(cop.offenses).to be_empty
end

it 'accepts a method definition without parameters' do
inspect_source(cop, ['def method',
'end'])
expect(cop.offenses).to be_empty
end

it "doesn't get confused by splat" do
inspect_source(cop, ['def func2(a,',
' *b,',
' c)',
'end'])
expect(cop.offenses.size).to eq 1
expect(cop.highlights).to eq(['*b'])
end

it 'auto-corrects alignment' do
new_source = autocorrect_source(cop, ['def method(a,',
' b)',
'end'])
expect(new_source).to eq(['def method(a,',
' b)',
'end'].join("\n"))
end

context 'defining self.method' do
it 'registers an offense for parameters with single indent' do
inspect_source(cop, ['def self.method(a,',
' b)',
'end'])
expect(cop.offenses.size).to eq 1
expect(cop.offenses.first.to_s).to match(/method definition/)
end

it 'accepts proper indentation' do
inspect_source(cop, ['def self.method(a,',
' b)',
'end'])
expect(cop.offenses).to be_empty
end

it 'auto-corrects alignment' do
new_source = autocorrect_source(cop, ['def self.method(a,',
' b)',
'end'])
expect(new_source).to eq(['def self.method(a,',
' b)',
'end'].join("\n"))
end
end
end

context 'assigned methods' do
it 'accepts the first parameter being on a new row' do
inspect_source(cop, [' assigned_value = match(',
Expand Down Expand Up @@ -388,6 +476,94 @@
end
end

context 'method definitions' do
it 'registers an offense for parameters aligned to first param' do
inspect_source(cop, ['def method(a,',
' b)',
'end'])
expect(cop.offenses.size).to eq 1
expect(cop.offenses.first.to_s).to match(/method definition/)
end

it 'registers an offense for parameters with double indent' do
inspect_source(cop, ['def method(a,',
' b)',
'end'])
expect(cop.offenses.size).to eq 1
end

it 'accepts parameter lists on a single line' do
inspect_source(cop, ['def method(a, b)',
'end'])
expect(cop.offenses).to be_empty
end

it 'accepts proper indentation' do
inspect_source(cop, ['def method(a,',
' b)',
'end'])
expect(cop.offenses).to be_empty
end

it 'accepts the first parameter being on a new row' do
inspect_source(cop, ['def method(',
' a,',
' b)',
'end'])
expect(cop.offenses).to be_empty
end

it 'accepts a method definition without parameters' do
inspect_source(cop, ['def method',
'end'])
expect(cop.offenses).to be_empty
end

it "doesn't get confused by splat" do
inspect_source(cop, ['def func2(a,',
' *b,',
' c)',
'end'])
expect(cop.offenses).not_to be_empty
expect(cop.highlights).to include '*b'
end

it 'auto-corrects alignment' do
new_source = autocorrect_source(cop, ['def method(a,',
' b)',
'end'])
expect(new_source).to eq(['def method(a,',
' b)',
'end'].join("\n"))
end

context 'defining self.method' do
it 'registers an offense for parameters aligned to first param' do
inspect_source(cop, ['def self.method(a,',
' b)',
'end'])
expect(cop.offenses.size).to eq 1
expect(cop.offenses.first.to_s).to match(/method definition/)
end

it 'accepts proper indentation' do
inspect_source(cop, ['def self.method(a,',
' b)',
'end'])
expect(cop.offenses).to be_empty
end

it 'auto-corrects alignment' do
new_source = autocorrect_source(cop, ['def self.method(a,',
' b)',
'end'])
expect(new_source).to eq(['def self.method(a,',
' b)',
'end'].join("\n"))
end
end
end

context 'assigned methods' do
context 'with IndentationWidth:Width set to 4' do
let(:indentation_width) { 4 }
Expand Down

0 comments on commit b5776f7

Please sign in to comment.