rubocop 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d32a48395898e975b6e30a1e0c135d327b637d5
-  data.tar.gz: 95923132f5031a94cea48306ba714e3510dd1f7a
+  metadata.gz: 43b3fd45d2ec7b330eca4a19651aa31157cef44a
+  data.tar.gz: d78bab05023a9fd28e0139d93e2f91be8b6bc972
 SHA512:
-  metadata.gz: 5c1d467dc759961b51256357d3e3ba49d1476cb1dc2ed8c69d4b755092e19b20c78746595fc0e532fee545646e36061fbaec8f5a597374be0085fc4dee600f1c
-  data.tar.gz: 51e01dbff570f1ffa8394a64cb7e2193f6717fad24fc5e6ce57468cb99c1385f8a8efc48433fbd25914dd6694bb978fca4edeed418e78738b7970a8536569972
+  metadata.gz: 35216ea2ef307f78e6867f982c09f66cb668777ddef1040fb18559053994cdbd9cbf05d5b45c2b98ae5467317d795e6c07be281a35dcc7b18cd49755cfda4a17
+  data.tar.gz: b6443382ef46eeea4490d1d74263b4d01b8afa671b56699373a61d627b17504887f1f36c7bfc526edd9048f0d4304621adb7b210dbdc3b59ce690b2eddfde3ba

data/CHANGELOG.md

@@ -4,10 +4,15 @@
 
 ### New features
 
+* New cop `BlockNesting` checks for excessive block nesting
+
 ### Changes
 
 ### Bug fixes
 
+* Correct calculation of whether a modifier version of a conditional statement will fit.
+* Fix an error in `MultilineIfThen` cop that occurred in some special cases.
+
 ## 0.8.1 (05/30/2013)
 
 ### New features

data/config/default.yml

@@ -44,3 +44,7 @@ SpaceInsideHashLiteralBraces:
 # Symbol literals should use snake_case.
 SymbolName:
   AllowCamelCase: true
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3

data/config/enabled.yml

@@ -323,4 +323,8 @@ AccessControl:
 
 # Use Kernel#loop with break rather than begin/end/until or begin/end/while for post-loop tests.
 Loop:
-  Enabled: true
+  Enabled: true
+
+# Avoid excessive block nesting
+BlockNesting:
+  Enabled: true

data/lib/rubocop.rb

@@ -77,6 +77,7 @@ require 'rubocop/cop/not'
 require 'rubocop/cop/eval'
 require 'rubocop/cop/access_control'
 require 'rubocop/cop/loop'
+require 'rubocop/cop/block_nesting'
 
 require 'rubocop/report/report'
 require 'rubocop/report/plain_text'

data/lib/rubocop/cli.rb

@@ -50,15 +50,15 @@ module Rubocop
         syntax_cop.debug = @options[:debug]
         syntax_cop.inspect_file(file)
 
-        if syntax_cop.offences.map(&:severity).include?(:error)
-          # In case of a syntax error we just report that error and do
-          # no more checking in the file.
-          report << syntax_cop
-          @total_offences += syntax_cop.offences.count
-        else
+        # In case of a syntax error we just report that error and do
+        # no more checking in the file.
+        unless syntax_cop.offences.map(&:severity).include?(:error)
           inspect_file(file, config, report)
         end
 
+        report << syntax_cop
+        @total_offences += syntax_cop.offences.count
+
         @processed_file_count += 1
         report.display unless report.empty?
       end

data/lib/rubocop/cop/ascii_comments.rb

@@ -5,8 +5,12 @@ module Rubocop
     class AsciiComments < Cop
       MSG = 'Use only ascii symbols in comments.'
 
-      def on_comment(c)
-        add_offence(:convention, c.loc.line, MSG) if c.text =~ /[^\x00-\x7f]/
+      def inspect(source, tokens, ast, comments)
+        comments.each do |comment|
+          if comment.text =~ /[^\x00-\x7f]/
+            add_offence(:convention, comment.loc.line, MSG)
+          end
+        end
       end
     end
   end

data/lib/rubocop/cop/block_comments.rb

@@ -5,9 +5,11 @@ module Rubocop
     class BlockComments < Cop
       MSG = 'Do not use block comments.'
 
-      def on_comment(comment)
-        if comment.text.start_with?('=begin')
-          add_offence(:convention, comment.loc.line, MSG)
+      def inspect(source, tokens, ast, comments)
+        comments.each do |comment|
+          if comment.text.start_with?('=begin')
+            add_offence(:convention, comment.loc.line, MSG)
+          end
         end
       end
     end

data/lib/rubocop/cop/block_nesting.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class BlockNesting < Cop
+      NESTING_BLOCKS = [:case, :if, :while, :until, :for, :resbody]
+
+      def inspect(source, tokens, ast, comments)
+        max = BlockNesting.config['Max']
+        check_nesting_level(ast, max, 0)
+      end
+
+      private
+
+      def check_nesting_level(node, max, current_level)
+        if NESTING_BLOCKS.include?(node.type)
+          current_level += 1
+          if current_level == max + 1
+            add_offence(:convention, node.location.line, message(max))
+            return
+          end
+        end
+        node.children.each do |child|
+          if child.is_a?(Parser::AST::Node)
+            check_nesting_level(child, max, current_level)
+          end
+        end
+      end
+
+      def message(max)
+        "Avoid more than #{max} levels of block nesting."
+      end
+    end
+  end
+end

data/lib/rubocop/cop/cop.rb

@@ -48,10 +48,6 @@ module Rubocop
 
       def inspect(source, tokens, ast, comments)
         process(ast)
-        comments.each { |c| on_comment(c) }
-      end
-
-      def on_comment(comment)
       end
 
       def ignore_node(node)
@@ -76,7 +72,7 @@ module Rubocop
         return if Array(excludes).include?(sexp.type)
 
         sexp.children.each do |elem|
-          if Parser::AST::Node === elem
+          if elem.is_a?(Parser::AST::Node)
             on_node(syms, elem, excludes) { |s| yield s }
           end
         end

data/lib/rubocop/cop/favor_modifier.rb

@@ -5,11 +5,6 @@ module Rubocop
     module FavorModifier
       # TODO extremely ugly solution that needs lots of polish
       def check(sexp)
-        # discard if/then/else
-        return false if sexp.loc.respond_to?(:else) && sexp.loc.else
-        # discard modifier while/until
-        return false if [:while, :until].include?(sexp.type) && !sexp.loc.end
-
         case sexp.loc.keyword.source
         when 'if'     then cond, body, _else = *sexp
         when 'unless' then cond, _else, body = *sexp
@@ -19,20 +14,22 @@ module Rubocop
         if length(sexp) > 3
           false
         else
+          indentation = sexp.loc.keyword.column
           cond_length = sexp.loc.keyword.size + cond.loc.expression.size + 1
           body_length = body_length(body)
 
-          body_length > 0 && (cond_length + body_length) <= LineLength.max
+          body_length > 0 &&
+            (indentation + cond_length + body_length) <= LineLength.max
         end
       end
 
       def length(sexp)
-        sexp.loc.expression.source.split("\n").size
+        sexp.loc.expression.source.lines.to_a.size
       end
 
       def body_length(body)
         if body && body.loc.expression
-          body.loc.expression.column + body.loc.expression.size
+          body.loc.expression.size
         else
           0
         end
@@ -48,14 +45,32 @@ module Rubocop
       end
 
       def on_if(node)
-        # discard ternary ops and modifier if/unless nodes
-        return unless node.loc.respond_to?(:keyword) &&
-          node.loc.respond_to?(:else)
+        # discard ternary ops, if/else and modifier if/unless nodes
+        return if ternary_op?(node)
+        return if modifier_if?(node)
+        return if elsif?(node)
+        return if if_else?(node)
 
         add_offence(:convention, node.loc.line, error_message) if check(node)
 
         super
       end
+
+      def ternary_op?(node)
+        node.loc.respond_to?(:question)
+      end
+
+      def modifier_if?(node)
+        node.loc.end.nil?
+      end
+
+      def elsif?(node)
+        node.loc.keyword.source == 'elsif'
+      end
+
+      def if_else?(node)
+        node.loc.respond_to?(:else) && node.loc.else
+      end
     end
 
     class WhileUntilModifier < Cop
@@ -66,6 +81,9 @@ module Rubocop
 
       def inspect(source, tokens, ast, comments)
         on_node([:while, :until], ast) do |node|
+          # discard modifier while/until
+          next unless node.loc.end
+
           add_offence(:convention, node.loc.line, MSG) if check(node)
         end
       end

data/lib/rubocop/cop/if_then_else.rb

@@ -40,8 +40,18 @@ module Rubocop
       include IfThenElse
 
       def offending_line(node)
-        if node.loc.expression.source =~ /\bthen\s*(#.*)?\s*$/
-          node.loc.begin.line
+        condition, body = *node
+        next_thing = if body && body.loc.expression
+                       body.loc.expression.begin
+                     else
+                       node.loc.end # No body, use "end".
+                     end
+        right_after_cond =
+          Parser::Source::Range.new(next_thing.source_buffer,
+                                    condition.loc.expression.end.end_pos,
+                                    next_thing.begin_pos)
+        if right_after_cond.source =~ /\A\s*then\s*(#.*)?\s*\n/
+          node.loc.expression.begin.line
         end
       end
 

data/lib/rubocop/cop/leading_comment_space.rb

@@ -5,10 +5,12 @@ module Rubocop
     class LeadingCommentSpace < Cop
       MSG = 'Missing space after #.'
 
-      def on_comment(c)
-        if c.text =~ /^#+[^#\s]/
-          unless c.text.start_with?('#!') && c.loc.line == 1
-            add_offence(:convention, c.loc.line, MSG)
+      def inspect(source, tokens, ast, comments)
+        comments.each do |comment|
+          if comment.text =~ /^#+[^#\s]/
+            unless comment.text.start_with?('#!') && comment.loc.line == 1
+              add_offence(:convention, comment.loc.line, MSG)
+            end
           end
         end
       end

data/lib/rubocop/cop/parentheses_around_condition.rb

@@ -4,7 +4,7 @@ module Rubocop
   module Cop
     class ParenthesesAroundCondition < Cop
       MSG = "Don't use parentheses around the condition of an " +
-        'if/unless/while/until, unless the condition contains an assignment.'
+        'if/unless/while/until'
 
       def on_if(node)
         process_control_op(node)

data/lib/rubocop/version.rb

@@ -2,6 +2,6 @@
 
 module Rubocop
   module Version
-    STRING = '0.8.1'
+    STRING = '0.8.2'
   end
 end

data/spec/rubocop/cops/block_nesting_spec.rb

@@ -0,0 +1,148 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe BlockNesting do
+      let(:block_nesting) { BlockNesting.new }
+      before { BlockNesting.config = { 'Max' => 2 } }
+
+      it 'accepts `Max` levels of nesting' do
+        source = ['if a',
+                  '  if b',
+                  '    puts b',
+                  '  end',
+                  'end']
+        expect_nesting_offences(source, [])
+      end
+
+      it 'registers an offence for `Max + 1` levels of `if` nesting' do
+        source = ['if a',
+                  '  if b',
+                  '    if c',
+                  '      puts c',
+                  '    end',
+                  '  end',
+                  'end']
+        expect_nesting_offences(source, [3])
+      end
+
+      it 'registers a single offence for `Max + 2` levels of `if` nesting' do
+        source = ['if a',
+                  '  if b',
+                  '    if c',
+                  '      if d',
+                  '        puts d',
+                  '      end',
+                  '    end',
+                  '  end',
+                  'end']
+        expect_nesting_offences(source, [3])
+      end
+
+      it 'registers 2 offences' do
+        source = ['if a',
+                  '  if b',
+                  '    if c',
+                  '      puts c',
+                  '    end',
+                  '  end',
+                  '  if d',
+                  '    if e',
+                  '      puts e',
+                  '    end',
+                  '  end',
+                  'end']
+        expect_nesting_offences(source, [3, 8])
+      end
+
+      it 'registers an offence for nested `case`' do
+        source = ['if a',
+                  '  if b',
+                  '    case c',
+                  '      when C',
+                  '        puts C',
+                  '    end',
+                  '  end',
+                  'end']
+        expect_nesting_offences(source, [3])
+      end
+
+      it 'registers an offence for nested `while`' do
+        source = ['if a',
+                  '  if b',
+                  '    while c',
+                  '      puts c',
+                  '    end',
+                  '  end',
+                  'end']
+        expect_nesting_offences(source, [3])
+      end
+
+      it 'registers an offence for nested modifier `while`' do
+        source = ['if a',
+                  '  if b',
+                  '    begin',
+                  '      puts c',
+                  '    end while c',
+                  '  end',
+                  'end']
+        expect_nesting_offences(source, [3])
+      end
+
+      it 'registers an offence for nested `until`' do
+        source = ['if a',
+                  '  if b',
+                  '    until c',
+                  '      puts c',
+                  '    end',
+                  '  end',
+                  'end']
+        expect_nesting_offences(source, [3])
+      end
+
+      it 'registers an offence for nested modifier `until`' do
+        source = ['if a',
+                  '  if b',
+                  '    begin',
+                  '      puts c',
+                  '    end until c',
+                  '  end',
+                  'end']
+        expect_nesting_offences(source, [3])
+      end
+
+      it 'registers an offence for nested `for`' do
+        source = ['if a',
+                  '  if b',
+                  '    for c in [1,2] do',
+                  '      puts c',
+                  '    end',
+                  '  end',
+                  'end']
+        expect_nesting_offences(source, [3])
+      end
+
+      it 'registers an offence for nested `rescue`' do
+        source = ['if a',
+                  '  if b',
+                  '    begin',
+                  '      puts c',
+                  '    rescue',
+                  '      puts x',
+                  '    end',
+                  '  end',
+                  'end']
+        expect_nesting_offences(source, [5])
+      end
+
+      def expect_nesting_offences(source, lines)
+        inspect_source(block_nesting, source)
+        expect(block_nesting.offences.map(&:line_number)).to eq(lines)
+        expect(block_nesting.messages).to eq(
+          ['Avoid more than 2 levels of block nesting.'] * lines.length)
+      end
+    end
+  end
+end

data/spec/rubocop/cops/favor_modifier_spec.rb

@@ -9,8 +9,7 @@ module Rubocop
       let(:while_until) { WhileUntilModifier.new }
       before { LineLength.config = { 'Max' => 79 } }
 
-      it 'registers an offence for multiline if that fits on one line',
-          broken: true do
+      it 'registers an offence for multiline if that fits on one line' do
         # This if statement fits exactly on one line if written as a modifier.
         inspect_source(if_unless,
                        ['if a_condition_that_is_just_short_enough',
@@ -92,6 +91,15 @@ module Rubocop
         check_empty(while_until, 'until')
       end
 
+      it 'accepts if/elsif' do
+        inspect_source(if_unless, ['if test',
+                                   '  something',
+                                   'elsif test2',
+                                   '  something_else',
+                                   'end'])
+        expect(if_unless.offences).to be_empty
+      end
+
       it 'accepts modifier while' do
         inspect_source(while_until, ['ala while bala'])
         expect(while_until.offences).to be_empty

data/spec/rubocop/cops/multiline_if_then_spec.rb

@@ -16,15 +16,18 @@ module Rubocop
                              'end',
                              'if cond then  ',
                              'end',
+                             'if cond',
+                             'then',
+                             'end',
                              'if cond then # bad',
                              'end'])
-        expect(mit.offences.map(&:line_number)).to eq([1, 3, 5, 7])
+        expect(mit.offences.map(&:line_number)).to eq([1, 3, 5, 7, 10])
       end
 
       it 'accepts multiline if without then' do
         inspect_source(mit, ['if cond',
                              'end'])
-        expect(mit.offences.map(&:message)).to be_empty
+        expect(mit.offences).to be_empty
       end
 
       it 'accepts table style if/then/elsif/ends' do
@@ -34,7 +37,27 @@ module Rubocop
                         'elsif @io == $stderr then str << "$stderr"',
                         'else                      str << @io.class.to_s',
                         'end'])
-        expect(mit.offences.map(&:message)).to be_empty
+        expect(mit.offences).to be_empty
+      end
+
+      it 'does not get confused by a then in a when' do
+        inspect_source(mit,
+                       ['if a',
+                        '  case b',
+                        '  when c then',
+                        '  end',
+                        'end'])
+        expect(mit.offences).to be_empty
+      end
+
+      it 'does not get confused by a commented-out then' do
+        inspect_source(mit,
+                       ['if a # then',
+                        '  b',
+                        'end',
+                        'if c # then',
+                        'end'])
+        expect(mit.offences).to be_empty
       end
 
       # unless
@@ -49,7 +72,7 @@ module Rubocop
       it 'accepts multiline unless without then' do
         inspect_source(mit, ['unless cond',
                              'end'])
-        expect(mit.offences.map(&:message)).to be_empty
+        expect(mit.offences).to be_empty
       end
     end
   end

data/spec/rubocop/cops/not_spec.rb

@@ -8,22 +8,17 @@ module Rubocop
       let(:a) { Not.new }
 
       it 'registers an offence for not' do
-        inspect_source(a,
-                       ['not test'])
+        inspect_source(a, ['not test'])
         expect(a.offences.size).to eq(1)
-        expect(a.offences.map(&:message))
-          .to eq([Not::MSG])
       end
 
       it 'does not register an offence for !' do
-        inspect_source(a,
-                       ['!test'])
+        inspect_source(a, ['!test'])
         expect(a.offences).to be_empty
       end
 
       it 'does not register an offence for :not' do
-        inspect_source(a,
-                       ['[:not, :if, :else]'])
+        inspect_source(a, ['[:not, :if, :else]'])
         expect(a.offences).to be_empty
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -155,6 +155,7 @@ files:
 - lib/rubocop/cop/avoid_perl_backrefs.rb
 - lib/rubocop/cop/avoid_perlisms.rb
 - lib/rubocop/cop/block_comments.rb
+- lib/rubocop/cop/block_nesting.rb
 - lib/rubocop/cop/blocks.rb
 - lib/rubocop/cop/case_indentation.rb
 - lib/rubocop/cop/class_and_module_camel_case.rb
@@ -236,6 +237,7 @@ files:
 - spec/rubocop/cops/avoid_perl_backrefs_spec.rb
 - spec/rubocop/cops/avoid_perlisms_spec.rb
 - spec/rubocop/cops/block_comments_spec.rb
+- spec/rubocop/cops/block_nesting_spec.rb
 - spec/rubocop/cops/blocks_spec.rb
 - spec/rubocop/cops/case_indentation_spec.rb
 - spec/rubocop/cops/class_and_module_camel_case_spec.rb
@@ -352,6 +354,7 @@ test_files:
 - spec/rubocop/cops/avoid_perl_backrefs_spec.rb
 - spec/rubocop/cops/avoid_perlisms_spec.rb
 - spec/rubocop/cops/block_comments_spec.rb
+- spec/rubocop/cops/block_nesting_spec.rb
 - spec/rubocop/cops/blocks_spec.rb
 - spec/rubocop/cops/case_indentation_spec.rb
 - spec/rubocop/cops/class_and_module_camel_case_spec.rb