New cop DotPosition

Bozhidar Batsov · Bozhidar Batsov · commit e41175f8122e · 2013-06-28T13:12:38.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -28,6 +28,7 @@
 * New cop `LiteralInCondition` tracks uses of literals in the conditions of `if/while/until`.
 * New cop `BeginBlock` tracks uses of `BEGIN` blocks.
 * New cop `EndBlock` tracks uses of `END` blocks.
+* New cop `DotPosition` tracks the dot position in multi-line method calls.
 * Add support for auto-correction of some offences with `-a`/`--auto-correct`.
 
 ### Changes
diff --git a/config/enabled.yml b/config/enabled.yml
@@ -388,6 +388,10 @@ EndInMethod:
 LiteralInCondition:
   Enabled: true
 
+# Checks the position of the dot in multi-line method calls.
+DotPosition:
+  Enabled: true
+
 ## Rails
 
 # Use sexy validations.
diff --git a/lib/rubocop.rb b/lib/rubocop.rb
@@ -49,6 +49,7 @@
 require 'rubocop/cop/style/constant_name'
 require 'rubocop/cop/style/def_parentheses'
 require 'rubocop/cop/style/documentation'
+require 'rubocop/cop/style/dot_position'
 require 'rubocop/cop/style/empty_line_between_defs'
 require 'rubocop/cop/style/empty_lines'
 require 'rubocop/cop/style/empty_literal'
diff --git a/lib/rubocop/cop/style/dot_position.rb b/lib/rubocop/cop/style/dot_position.rb
@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module Style
+      # This cop checks the . position in multi-line method calls.
+      class DotPosition < Cop
+        MSG = 'Place the . on the next line, together with the method name.'
+
+        def on_send(node)
+          return unless node.loc.dot
+
+          dot_line = node.loc.dot.line
+          selector_line = node.loc.selector.line
+
+          if dot_line != selector_line
+            add_offence(:convention, node.loc.dot, MSG)
+          end
+
+          super
+        end
+      end
+    end
+  end
+end
diff --git a/spec/rubocop/config_store_spec.rb b/spec/rubocop/config_store_spec.rb
@@ -47,8 +47,8 @@ module Rubocop
           Config.should_receive(:configuration_file_for).once.with('dir/' +
                                                                    'subdir')
           # The stub returns the same config path for dir and dir/subdir.
-          Config.should_receive(:configuration_from_file).once.
-            with('dir/.rubocop.yml')
+          Config.should_receive(:configuration_from_file).once
+            .with('dir/.rubocop.yml')
 
           ConfigStore.for('dir/file2')
           ConfigStore.for('dir/file2')
diff --git a/spec/rubocop/cops/style/dot_position_spec.rb b/spec/rubocop/cops/style/dot_position_spec.rb
@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    module Style
+      describe DotPosition do
+        let(:cop) { DotPosition.new }
+
+        it 'registers an offence for trailing dot in multi-line method call' do
+          inspect_source(cop, ['something.',
+                               '  method_name'])
+          expect(cop.offences.size).to eq(1)
+        end
+
+        it 'accepts leading do in multi-line method call' do
+          inspect_source(cop, ['something',
+                               '  .method_name'])
+          expect(cop.offences).to be_empty
+        end
+
+        it 'does not err on method call with no dots' do
+          inspect_source(cop, ['puts something'])
+          expect(cop.offences).to be_empty
+        end
+      end
+    end
+  end
+end
