rubocop 0.18.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 449eac86969013808cd868da4a3f30a19ed9fee4
-  data.tar.gz: e90bbbb51afe783b1e6cbaaee26776b215c37b0a
+  metadata.gz: 9ea14f3e307dd68df2a7359211b40d0b7bcf4993
+  data.tar.gz: a7c9a1f47f05baf47d33ccc0a814d759f2da54c0
 SHA512:
-  metadata.gz: 0cbce187b2372414f314b7c79a1046a3951aa32d6056bd0324ee48b85bb3a7f85b48745cb3937d5f52a43b032def66e1b8d8c5c31847ec078b88b8b65ad8bae3
-  data.tar.gz: 94d82a1c2921ba2dbb630cb0a1a2d69b2df8ad32b9410580c6a61d86868e48b05bd83cba89e3ab8a47c773a4255e22397d985c380c9980708ddbb1883c0eeff5
+  metadata.gz: 18b74d226546c2306d3450acc0c3a09e8cef00900b4699b578de51512e7a6f85cb73544dec43882646eb3e8ca8e5ba312f1cea8b9d5e2543238084c556c1b1f9
+  data.tar.gz: e4b061fc7821f68ac1ee1f6556c4fb871dea79ad6f32a551d6fad683271b3c44549c6fd7d845e897e9b2015d46ec247bc7348dd8bd62013d46d4d2fabfbc69e3

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## master (unreleased)
 
+## 0.18.1 (02/02/2014)
+
+### Bugs fixed
+
+* Remove double reporting in `EmptyLinesAroundBody` of empty line inside otherwise empty class/module/method that caused crash in autocorrect. ([@jonas054][])
+* [#779](https://github.com/bbatsov/rubocop/issues/779): Fix a false positive in `LineEndConcatenation`. ([@bbatsov][])
+* [#751](https://github.com/bbatsov/rubocop/issues/751): Fix `Documentation` cop so that a comment followed by an empty line and then a class definition is not considered to be class documentation. ([@jonas054][])
+* [#783](https://github.com/bbatsov/rubocop/issues/783): Fix a false positive in `ParethesesAroundCondition` when the parentheses are actually required. ([@bbatsov][])
+* [#781](https://github.com/bbatsov/rubocop/issues/781): Fix problem with back-and-forth auto-correction in `AccessModifierIndentation`. ([@jonas054][])
+* [#785](https://github.com/bbatsov/rubocop/issues/785): Fix false positive on `%w` arrays in `TrailingComma`. ([@jonas054][])
+* [#782](https://github.com/bbatsov/rubocop/issues/782): Fix false positive in `AlignHash` for single line hashes. ([@jonas054][])
+
 ## 0.18.0 (30/01/2014)
 
 ### New features

data/lib/rubocop.rb

@@ -30,6 +30,7 @@ require 'rubocop/cop/variable_inspector/reference'
 require 'rubocop/cop/variable_inspector/scope'
 require 'rubocop/cop/variable_inspector/variable_table'
 
+require 'rubocop/cop/mixin/annotation_comment'
 require 'rubocop/cop/mixin/array_syntax'
 require 'rubocop/cop/mixin/autocorrect_alignment'
 require 'rubocop/cop/mixin/check_assignment'

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

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module Style
+      # Common functionality related to annotation comments.
+      module AnnotationComment
+        private
+
+        def annotation?(comment)
+          _margin, first_word, colon, space, note = split_comment(comment)
+          keyword_appearance?(first_word, colon, space) &&
+            !just_first_word_of_sentence?(first_word, colon, space, note)
+        end
+
+        def split_comment(comment)
+          match = comment.text.match(/^(# ?)([A-Za-z]+)(\s*:)?(\s+)?(\S+)?/)
+          return false unless match
+          margin, first_word, colon, space, note = *match.captures
+          [margin, first_word, colon, space, note]
+        end
+
+        def keyword_appearance?(first_word, colon, space)
+          first_word && keyword?(first_word.upcase) && (colon || space)
+        end
+
+        def just_first_word_of_sentence?(first_word, colon, space, note)
+          first_word == first_word.capitalize && !colon && space && note
+        end
+
+        def keyword?(word)
+          config.for_cop('CommentAnnotation')['Keywords'].include?(word)
+        end
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module Rubocop
     # syntax.
     module ArraySyntax
       def array_of?(element_type, node)
-        return false unless node.loc.begin && node.loc.begin.is?('[')
+        return false unless square_brackets?(node)
 
         array_elems = node.children
 
@@ -15,6 +15,10 @@ module Rubocop
 
         array_elems.all? { |e| e.type == element_type }
       end
+
+      def square_brackets?(node)
+        node.loc.begin && node.loc.begin.is?('[')
+      end
     end
   end
 end

data/lib/rubocop/cop/style/access_modifier_indentation.rb

@@ -3,9 +3,8 @@
 module Rubocop
   module Cop
     module Style
-      # A couple of checks related to the use method visibility modifiers.
-      # Modifiers should be indented as deeps are method definitions and
-      # surrounded by blank lines.
+      # Modifiers should be indented as deep as method definitions, or as deep
+      # as the class/module keyword, depending on configuration.
       class AccessModifierIndentation < Cop
         include AutocorrectAlignment
         include ConfigurableEnforcedStyle
@@ -16,26 +15,24 @@ module Rubocop
         PROTECTED_NODE = s(:send, nil, :protected)
         PUBLIC_NODE = s(:send, nil, :public)
 
-        def investigate(processed_source)
-          ast = processed_source.ast
-          return unless ast
-          on_node([:class, :module, :sclass, :block], ast) do |class_node|
-            if class_node.type == :block && !class_constructor?(class_node)
-              next
-            end
+        def on_class(node)
+          _name, _base_class, body = *node
+          check_body(body, node)
+        end
 
-            class_start_col = class_node.loc.expression.column
+        def on_sclass(node)
+          _name, body = *node
+          check_body(body, node)
+        end
 
-            # we'll have to walk all class children nodes
-            # except other class/module nodes
-            class_node.children.compact.each do |node|
-              on_node(:send, node, [:class, :module, :sclass]) do |send_node|
-                if self.class.modifier_node?(send_node)
-                  check(send_node, class_start_col)
-                end
-              end
-            end
-          end
+        def on_module(node)
+          _name, body = *node
+          check_body(body, node)
+        end
+
+        def on_block(node)
+          _method, _args, body = *node
+          check_body(body, node) if class_constructor?(node)
         end
 
         def self.modifier_node?(node)
@@ -44,7 +41,16 @@ module Rubocop
 
         private
 
-        def check(send_node, class_start_col)
+        def check_body(body, node)
+          return if body.nil? # Empty class etc.
+
+          modifiers = body.children.select { |c| self.class.modifier_node?(c) }
+          class_column = node.loc.expression.column
+
+          modifiers.each { |modifier| check_modifier(modifier, class_column) }
+        end
+
+        def check_modifier(send_node, class_start_col)
           access_modifier_start_col = send_node.loc.expression.column
           offset = access_modifier_start_col - class_start_col
 

data/lib/rubocop/cop/style/align_hash.rb

@@ -142,10 +142,11 @@ module Rubocop
         end
 
         MSG = 'Align the elements of a hash literal if they span more than ' \
-          'one line.'
+              'one line.'
 
         def on_hash(node)
           return if node.children.empty?
+          return unless multiline?(node)
 
           @alignment_for_hash_rockets ||=
             new_alignment('EnforcedHashRocketStyle')
@@ -171,6 +172,10 @@ module Rubocop
 
         private
 
+        def multiline?(node)
+          node.loc.expression.source.include?("\n")
+        end
+
         def alignment_for(pair)
           if pair.loc.operator.is?('=>')
             @alignment_for_hash_rockets

data/lib/rubocop/cop/style/comment_annotation.rb

@@ -6,53 +6,31 @@ module Rubocop
       # This cop checks that comment annotation keywords are written according
       # to guidelines.
       class CommentAnnotation < Cop
+        include AnnotationComment
+
         MSG = 'Annotation keywords should be all upper case, followed by a ' \
               'colon and a space, then a note describing the problem.'
 
         def investigate(processed_source)
           processed_source.comments.each do |comment|
-            match = comment.text.match(/^(# ?)([A-Za-z]+)(\s*:)?(\s+)?(\S+)?/)
-            if match
-              margin, first_word, colon, space, note = *match.captures
-              if annotation?(first_word, colon, space, note) &&
-                  !correct_annotation?(first_word, colon, space, note)
-                start = comment.loc.expression.begin_pos + margin.length
-                length = first_word.length + (colon || '').length
-                range = Parser::Source::Range.new(processed_source.buffer,
-                                                  start,
-                                                  start + length)
-                add_offence(nil, range)
-              end
+            margin, first_word, colon, space, note = split_comment(comment)
+            if annotation?(comment) && !correct_annotation?(first_word, colon,
+                                                            space, note)
+              start = comment.loc.expression.begin_pos + margin.length
+              length = first_word.length + (colon || '').length
+              range = Parser::Source::Range.new(processed_source.buffer,
+                                                start,
+                                                start + length)
+              add_offence(nil, range)
             end
           end
         end
 
-        def keywords
-          cop_config['Keywords']
-        end
-
         private
 
-        def annotation?(first_word, colon, space, note)
-          keyword_appearance?(first_word, colon, space) &&
-            !just_first_word_of_sentence?(first_word, colon, space, note)
-        end
-
-        def keyword_appearance?(first_word, colon, space)
-          keyword?(first_word.upcase) && (colon || space)
-        end
-
-        def just_first_word_of_sentence?(first_word, colon, space, note)
-          first_word == first_word.capitalize && !colon && space && note
-        end
-
         def correct_annotation?(first_word, colon, space, note)
           keyword?(first_word) && (colon && space && note || !colon && !note)
         end
-
-        def keyword?(word)
-          keywords.include?(word)
-        end
       end
     end
   end

data/lib/rubocop/cop/style/documentation.rb

@@ -8,6 +8,8 @@ module Rubocop
       # check and so are namespace modules - modules that have nothing in
       # their bodies except classes or other other modules.
       class Documentation < Cop
+        include AnnotationComment
+
         MSG = 'Missing top-level %s documentation comment.'
 
         def investigate(processed_source)
@@ -35,7 +37,7 @@ module Rubocop
 
             next if node.type == :class && !body
             next if namespace?(body)
-            next unless ast_with_comments[node].empty?
+            next if associated_comment?(node, ast_with_comments)
             add_offence(node, :keyword, format(MSG, node.type.to_s))
           end
         end
@@ -54,6 +56,18 @@ module Rubocop
             false
           end
         end
+
+        # Returns true if the node has a comment on the line above it that
+        # isn't an annotation.
+        def associated_comment?(node, ast_with_comments)
+          return false if ast_with_comments[node].empty?
+
+          preceding_comment = ast_with_comments[node].last
+          distance = node.loc.keyword.line - preceding_comment.loc.line
+          return false if distance > 1
+
+          !annotation?(preceding_comment)
+        end
       end
     end
   end

data/lib/rubocop/cop/style/empty_lines_around_body.rb

@@ -55,20 +55,17 @@ module Rubocop
         end
 
         def check_source(start_line, end_line)
-          if processed_source.lines[start_line].empty?
-            range = source_range(processed_source.buffer,
-                                 processed_source[0...start_line],
-                                 0,
-                                 1)
-            add_offence(range, range, MSG_BEG)
-          end
+          check_line(start_line, MSG_BEG)
+          check_line(end_line - 2, MSG_END) unless end_line - 2 == start_line
+        end
 
-          if processed_source.lines[end_line - 2].empty?
+        def check_line(line, msg)
+          if processed_source.lines[line].empty?
             range = source_range(processed_source.buffer,
-                                 processed_source[0...(end_line - 2)],
+                                 processed_source[0...line],
                                  0,
                                  1)
-            add_offence(range, range, MSG_END)
+            add_offence(range, range, msg)
           end
         end
       end

data/lib/rubocop/cop/style/line_end_concatenation.rb

@@ -42,10 +42,12 @@ module Rubocop
 
           return false unless arg.type == :str
 
-          receiver_line = receiver.loc.expression.line
-          arg_line = arg.loc.expression.line
+          plus_at_line_end?(node.loc.expression.source)
+        end
 
-          receiver_line != arg_line
+        def plus_at_line_end?(expression)
+          # check if the first line of the expression ends with a +
+          expression =~ /.+\+\s*$/
         end
       end
     end

data/lib/rubocop/cop/style/parentheses_around_condition.rb

@@ -28,6 +28,7 @@ module Rubocop
           cond, _body = *node
 
           if cond.type == :begin
+            return if parens_required?(node)
             # allow safe assignment
             return if safe_assignment?(cond) && safe_assignment_allowed?
 
@@ -35,6 +36,13 @@ module Rubocop
           end
         end
 
+        def parens_required?(node)
+          expr = node.loc.expression.source
+          keyword = node.loc.keyword.source
+
+          expr.start_with?("#{keyword}(")
+        end
+
         def message(node)
           kw = node.loc.keyword.source
           article = kw == 'while' ? 'a' : 'an'

data/lib/rubocop/cop/style/trailing_comma.rb

@@ -5,12 +5,13 @@ module Rubocop
     module Style
       # This cop checks for trailing comma in parameter lists and literals.
       class TrailingComma < Cop
+        include ArraySyntax
         include ConfigurableEnforcedStyle
 
         MSG = '%s comma after the last %s.'
 
         def on_array(node)
-          check_literal(node, 'item of %s array')
+          check_literal(node, 'item of %s array') if square_brackets?(node)
         end
 
         def on_hash(node)

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module Rubocop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.18.0'
+    STRING = '0.18.1'
 
     MSG = '%s (using Parser %s, running on %s %s %s)'
 

data/spec/rubocop/cop/style/access_modifier_indentation_spec.rb

@@ -144,6 +144,13 @@ describe Rubocop::Cop::Style::AccessModifierIndentation, :config do
       expect(cop.offences).to be_empty
     end
 
+    it 'accepts an empty class' do
+      inspect_source(cop,
+                     ['class Test',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
     it 'handles properly nested classes' do
       inspect_source(cop,
                      ['class Test',
@@ -315,5 +322,40 @@ describe Rubocop::Cop::Style::AccessModifierIndentation, :config do
                                '  end',
                                'end'].join("\n"))
     end
+
+    it 'auto-corrects private in complicated case' do
+      corrected = autocorrect_source(cop, ['class Hello',
+                                           '  def foo',
+                                           "    'hi'",
+                                           '  end',
+                                           '',
+                                           '  def bar',
+                                           '    Module.new do',
+                                           '',
+                                           '     private',
+                                           '',
+                                           '      def hi',
+                                           "        'bye'",
+                                           '      end',
+                                           '    end',
+                                           '  end',
+                                           'end'])
+      expect(corrected).to eq(['class Hello',
+                               '  def foo',
+                               "    'hi'",
+                               '  end',
+                               '',
+                               '  def bar',
+                               '    Module.new do',
+                               '',
+                               '    private',
+                               '',
+                               '      def hi',
+                               "        'bye'",
+                               '      end',
+                               '    end',
+                               '  end',
+                               'end'].join("\n"))
+    end
   end
 end

data/spec/rubocop/cop/style/align_hash_spec.rb

@@ -136,6 +136,18 @@ describe Rubocop::Cop::Style::AlignHash, :config do
       expect(cop.offences).to be_empty
     end
 
+    it 'accepts a multiline array of single line hashes' do
+      inspect_source(cop, ['def self.scenarios_order',
+                           '    [',
+                           '      { before:   %w( l k ) },',
+                           '      { ending:   %w( m l ) },',
+                           '      { starting: %w( m n ) },',
+                           '      { after:    %w( n o ) }',
+                           '    ]',
+                           '  end'])
+      expect(cop.offences).to be_empty
+    end
+
     it 'registers an offence for misaligned hash values' do
       inspect_source(cop, ['hash1 = {',
                            "  'a'   =>  0,",

data/spec/rubocop/cop/style/documentation_spec.rb

@@ -3,7 +3,13 @@
 require 'spec_helper'
 
 describe Rubocop::Cop::Style::Documentation do
-  subject(:cop) { described_class.new }
+
+  subject(:cop) { described_class.new(config) }
+  let(:config) do
+    Rubocop::Config.new('CommentAnnotation' => {
+                          'Keywords' => %w(TODO FIXME OPTIMIZE HACK REVIEW)
+                        })
+  end
 
   it 'registers an offence for non-empty class' do
     inspect_source(cop,
@@ -14,6 +20,19 @@ describe Rubocop::Cop::Style::Documentation do
     expect(cop.offences.size).to eq(1)
   end
 
+  it 'does not consider comment followed by empty line to be class ' \
+     'documentation' do
+    inspect_source(cop,
+                   ['# Copyright 2014',
+                    '# Some company',
+                    '',
+                    'class My_Class',
+                    '  TEST = 20',
+                    'end'
+                   ])
+    expect(cop.offences.size).to eq(1)
+  end
+
   it 'registers an offence for non-namespace' do
     inspect_source(cop,
                    ['module My_Class',
@@ -43,6 +62,16 @@ describe Rubocop::Cop::Style::Documentation do
     expect(cop.offences).to be_empty
   end
 
+  it 'registers an offence for non-empty class with annotation comment' do
+    inspect_source(cop,
+                   ['# OPTIMIZE: Make this faster.',
+                    'class My_Class',
+                    '  TEST = 20',
+                    'end'
+                   ])
+    expect(cop.offences.size).to eq(1)
+  end
+
   it 'accepts non-empty module with documentation' do
     inspect_source(cop,
                    ['# class comment',

data/spec/rubocop/cop/style/empty_lines_around_body_spec.rb

@@ -85,6 +85,15 @@ describe Rubocop::Cop::Style::EmptyLinesAroundBody do
     expect(cop.offences.size).to eq(1)
   end
 
+  it 'autocorrects class body containing only a blank' do
+    corrected = autocorrect_source(cop,
+                                   ['class SomeClass',
+                                    '',
+                                    'end'])
+    expect(corrected).to eq ['class SomeClass',
+                             'end'].join("\n")
+  end
+
   it 'registers an offence for module body starting with a blank' do
     inspect_source(cop,
                    ['module SomeModule',

data/spec/rubocop/cop/style/line_end_concatenation_spec.rb

@@ -18,6 +18,13 @@ describe Rubocop::Cop::Style::LineEndConcatenation do
     expect(cop.offences).to be_empty
   end
 
+  it 'accepts string concat at line end when followed by comment' do
+    inspect_source(cop,
+                   ['top = "test" + # something',
+                    '"top"'])
+    expect(cop.offences).to be_empty
+  end
+
   it 'autocorrects by replacing + with \\' do
     corrected = autocorrect_source(cop,
                                    ['top = "test" +',

data/spec/rubocop/cop/style/parentheses_around_condition_spec.rb

@@ -28,6 +28,11 @@ describe Rubocop::Cop::Style::ParenthesesAroundCondition, :config do
       .to eq("Don't use parentheses around the condition of a while.")
   end
 
+  it 'accepts parentheses if there is no space between the keyword and (.' do
+    inspect_source(cop, ['if(x > 5) then something end'])
+    expect(cop.offences).to be_empty
+  end
+
   it 'auto-corrects parentheses around condition' do
     corrected = autocorrect_source(cop, ['if (x > 10)',
                                          'elsif (x < 3)',

data/spec/rubocop/cop/style/trailing_comma_spec.rb

@@ -206,6 +206,15 @@ describe Rubocop::Cop::Style::TrailingComma, :config do
         expect(cop.offences).to be_empty
       end
 
+      it 'accepts a multiline word array' do
+        inspect_source(cop, ['ingredients = %w(',
+                             '  sausage',
+                             '  anchovies',
+                             '  olives',
+                             ')'])
+        expect(cop.offences).to be_empty
+      end
+
       it 'accepts missing comma after a heredoc' do
         # A heredoc that's the last item in a literal or parameter list can not
         # have a trailing comma. It's a syntax error.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.1
 platform: ruby
 authors:
 - Bozhidar Batsov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -210,6 +210,7 @@ files:
 - lib/rubocop/cop/lint/useless_else_without_rescue.rb
 - lib/rubocop/cop/lint/useless_setter_call.rb
 - lib/rubocop/cop/lint/void.rb
+- lib/rubocop/cop/mixin/annotation_comment.rb
 - lib/rubocop/cop/mixin/array_syntax.rb
 - lib/rubocop/cop/mixin/autocorrect_alignment.rb
 - lib/rubocop/cop/mixin/check_assignment.rb