rubocop 0.3.1 → 0.3.2

data/.rubocop.yml

@@ -100,3 +100,24 @@ IfUnlessModifier:
 
 WhileUntilModifier:
   Enabled: true
+
+FavorUnlessOverNegatedIf:
+  Enabled: true
+
+FavorUntilOverNegatedWhile:
+  Enabled: true
+
+SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+NewLambdaLiteral:
+  Enabled: true
+
+ParenthesesAroundCondition:
+  Enabled: true
+
+MethodAndVariableSnakeCase:
+  Enabled: true
+
+ClassAndModuleCamelCase:
+  Enabled: true

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
 script: bundle exec rspec

data/Gemfile

@@ -1,15 +1,12 @@
 source 'http://rubygems.org'
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
+gem 'term-ansicolor'
+
 group :development do
-  gem 'rake', '~> 10.0.0'
-  gem 'rspec', '~> 2.12.0'
-  gem 'yard', '~> 0.8.0'
-  gem 'bundler', '~> 1.2.0'
-  gem 'jeweler', '~> 1.8.3'
+  gem 'rake'
+  gem 'rspec'
+  gem 'yard'
+  gem 'bundler'
+  gem 'jeweler'
   gem 'simplecov'
 end

data/Gemfile.lock

@@ -1,39 +1,41 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
+    diff-lcs (1.2.2)
     git (1.2.5)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.7.6)
-    multi_json (1.5.0)
-    rake (10.0.3)
-    rdoc (3.12)
+    json (1.7.7)
+    multi_json (1.7.2)
+    rake (10.0.4)
+    rdoc (4.0.1)
       json (~> 1.4)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.1)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
-    yard (0.8.3)
+    term-ansicolor (1.1.4)
+    yard (0.8.5.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.2.0)
-  jeweler (~> 1.8.3)
-  rake (~> 10.0.0)
-  rspec (~> 2.12.0)
+  bundler
+  jeweler
+  rake
+  rspec
   simplecov
-  yard (~> 0.8.0)
+  term-ansicolor
+  yard

data/README.md

@@ -1,9 +1,16 @@
+[![Gem Version](https://badge.fury.io/rb/rubocop.png)](http://badge.fury.io/rb/rubocop)
 [![Build Status](https://travis-ci.org/bbatsov/rubocop.png?branch=master)](https://travis-ci.org/bbatsov/rubocop)
 
 # rubocop
 
 Ruby code style checker based on the [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide).
 
+## Installation
+
+```bash
+$ gem install rubocop
+```
+
 ## Basic Usage
 
 Running `rubocop` with no arguments will check all Ruby source files in the current folder:
@@ -18,8 +25,46 @@ Alternatively you can `rubocop` a list of files and folders to check:
 $ rubocop app spec lib/something.rb
 ```
 
+For more details check the available command-line options:
+
+```bash
+$ rubocop -h
+```
+
+## Configuration
+
+The behavior of `rubocop` can be controlled via the
+[.rubocop.yml](https://github.com/bbatsov/rubocop/blob/master/.rubocop.yml)
+configuration file. The file can be placed either in your home folder
+or in some project folder.
+
+`rubocop` will start looking for the configuration file in the directory
+it was started in and continue its way up to the home folder.
+
+The file has the following format:
+
+```yml
+Encoding:
+  Enabled: true
+
+LineLength:
+  Enabled: true
+  Max: 79
+```
+
+It allows to enable/disable certain cops (checks) and to alter their
+behavior if they accept any parameters.
+
+## Compatibility
+
+Unfortunately every major Ruby implementation has its own code
+analysis tooling, which makes the development of a portable code
+analyzer a daunting task.
+
+`rubocop` currently supports MRI 1.9 and MRI 2.0. Support for JRuby and
+Rubinius is not planned at this point.
+
 ## Copyright
 
-Copyright (c) 2012-2013 Bozhidar Batsov. See LICENSE.txt for
+Copyright (c) 2012-2013 Bozhidar Batsov. See [LICENSE.txt](LICENSE.txt) for
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/rubocop.rb

@@ -1,6 +1,11 @@
 # encoding: utf-8
 
 require 'ripper'
+require 'term/ansicolor'
+
+class String
+  include Term::ANSIColor
+end
 
 require 'rubocop/cop/offence'
 require 'rubocop/cop/cop'
@@ -26,6 +31,11 @@ require 'rubocop/cop/unless_else'
 require 'rubocop/cop/ampersands_pipes_vs_and_or'
 require 'rubocop/cop/when_then'
 require 'rubocop/cop/favor_modifier'
+require 'rubocop/cop/favor_unless_over_negated_if'
+require 'rubocop/cop/new_lambda_literal'
+require 'rubocop/cop/parentheses_around_condition'
+require 'rubocop/cop/method_and_variable_snake_case'
+require 'rubocop/cop/class_and_module_camel_case'
 
 require 'rubocop/report/report'
 require 'rubocop/report/plain_text'

data/lib/rubocop/cli.rb

@@ -2,6 +2,7 @@
 
 require 'optparse'
 require 'yaml'
+require_relative 'cop/grammar'
 
 module Rubocop
   # The CLI is a class responsible of handling all the command line interface
@@ -64,6 +65,7 @@ module Rubocop
       unless $options[:silent]
         print "\n#{target_files(args).count} files inspected, "
         puts "#{total_offences} offences detected"
+          .send(total_offences.zero? ? :green : :red)
       end
 
       return total_offences == 0 ? 0 : 1

data/lib/rubocop/cop/class_and_module_camel_case.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class ClassAndModuleCamelCase < Cop
+      ERROR_MESSAGE = 'Use CamelCase for classes and modules.'
+
+      def inspect(file, source, tokens, sexp)
+        [:class, :module].each do |keyword|
+          each(keyword, sexp) do |s|
+            if s[1][0] == :const_ref && s[1][1][0] == :@const &&
+                s[1][1][1] =~ /_/
+              add_offence(:convention, s[1][1][2].lineno, ERROR_MESSAGE)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/favor_unless_over_negated_if.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module FavorOtherKeywordOverNegation
+      private
+      def check(grammar_part, sexp)
+        each(grammar_part, sexp) do |s|
+          # Don't complain about negative if/else. We don't want unless/else.
+          next if s[3] && [:else, :elsif].include?(s[3][0])
+
+          condition = s[1]
+          condition = condition[1][0] while condition[0] == :paren
+
+          if condition[0] == :unary && [:!, :not].include?(condition[1])
+            add_offence(:convention, all_positions(s).first.lineno,
+                        error_message)
+          end
+        end
+      end
+    end
+
+    class FavorUnlessOverNegatedIf < Cop
+      include FavorOtherKeywordOverNegation
+
+      def error_message
+        'Favor unless (or control flow or) over if for negative conditions.'
+      end
+
+      def inspect(file, source, tokens, sexp)
+        [:if, :if_mod].each { |grammar_part| check(grammar_part, sexp) }
+      end
+    end
+
+    class FavorUntilOverNegatedWhile < Cop
+      include FavorOtherKeywordOverNegation
+
+      def error_message
+        'Favor until over while for negative conditions.'
+      end
+
+      def inspect(file, source, tokens, sexp)
+        [:while, :while_mod].each { |grammar_part| check(grammar_part, sexp) }
+      end
+    end
+  end
+end

data/lib/rubocop/cop/grammar.rb

@@ -90,8 +90,9 @@ module Rubocop
             find(path, sexp, [:on_op, '|'])
           end
           path += [sexp[0]] if Symbol === sexp[0]
-          # Compensate for reverse order of if modifier
-          children = (sexp[0] == :if_mod) ? sexp.reverse : sexp
+          # Compensate for reverse order of if/unless/while/until modifier.
+          modifiers = [:if_mod, :unless_mod, :while_mod, :until_mod]
+          children = modifiers.include?(sexp[0]) ? sexp.reverse : sexp
 
           children.each do |elem|
             case elem

data/lib/rubocop/cop/method_and_variable_snake_case.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class MethodAndVariableSnakeCase < Cop
+      ERROR_MESSAGE = 'Use snake_case for methods and variables.'
+      SNAKE_CASE = /^@?[\da-z_]+[!?=]?$/
+
+      def inspect(file, source, tokens, sexp)
+        each(:def, sexp) { |s| check(s[1]) }
+
+        each(:assign, sexp) do |s|
+          case s[1][0]
+          when :var_field
+            check(s[1][1])
+          when :field
+            if s[1][1][0] == :var_ref && s[1][1][1][0..1] == [:@kw, 'self']
+              check(s[1][3])
+            end
+          end
+        end
+      end
+
+      def check(sexp)
+        if [:@ivar, :@ident].include?(sexp[0]) && sexp[1] !~ SNAKE_CASE
+          add_offence(:convention, sexp[2].lineno, ERROR_MESSAGE)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/new_lambda_literal.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class NewLambdaLiteral < Cop
+      ERROR_MESSAGE = 'The new lambda literal syntax is preferred in Ruby 1.9.'
+
+      def inspect(file, source, tokens, sexp)
+        each(:fcall, sexp) do |s|
+          if s[1][0..1] == [:@ident, 'lambda']
+            add_offence(:convention, s[1][-1].lineno, ERROR_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/parentheses_around_condition.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class ParenthesesAroundCondition < Cop
+      ERROR_MESSAGE = "Don't use parentheses around the condition of an " +
+        'if/unless/while/until, unless the condition contains an assignment.'
+
+      def inspect(file, source, tokens, sexp)
+        [:if, :elsif, :unless, :while, :until,
+         :if_mod, :unless_mod, :while_mod, :until_mod].each do |keyword|
+          each(keyword, sexp) do |s|
+            if s[1][0] == :paren && s[1][1][0][0] != :assign
+              positions = all_positions(s[1])
+              if positions.first.lineno == positions.last.lineno
+                add_offence(:convention, positions.first.lineno, ERROR_MESSAGE)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/surrounding_space.rb

@@ -1,37 +1,26 @@
 # encoding: utf-8
 
-require_relative 'grammar'
-
 module Rubocop
   module Cop
     module SurroundingSpace
       def inspect(file, source, tokens, sexp)
         @correlations.sort.each do |ix, grammar_path|
-          check_missing(tokens, ix, grammar_path)
+          check_missing_space(tokens, ix, grammar_path)
         end
-        tokens.each_index { |ix| check_extra(tokens, ix) }
+        tokens.each_index { |ix| check_unwanted_space(tokens, ix) }
       end
 
       private
 
-      def tokens_on_same_row?(t1, t2)
-        t1.pos.lineno == t2.pos.lineno
-      end
-
       def previous_non_space(tokens, ix)
-        (ix - 1).downto(0) do |i|
-          t = tokens[i]
-          return t unless whitespace?(t)
-        end
-        nil
+        tokens[0...ix].reverse.find { |t| not whitespace?(t) }
       end
 
       def ok_without_spaces?(grammar_path)
         parent, child = grammar_path.values_at(-2, -1)
         return true if [:unary, :symbol, :defs, :def, :call].include?(parent)
         return true if [:**, :block_var].include?(child)
-        return true if parent == :command_call && child == :'::'
-        false
+        parent == :command_call && child == :'::'
       end
 
       def surrounded_by_whitespace?(nearby_tokens)
@@ -40,7 +29,7 @@ module Rubocop
       end
 
       # Default implementation for classes that don't need it.
-      def check_missing(tokens, ix, grammar_path)
+      def check_missing_space(tokens, ix, grammar_path)
       end
     end
 
@@ -48,7 +37,7 @@ module Rubocop
       include SurroundingSpace
       ERROR_MESSAGE = 'Surrounding space missing for operator '
 
-      def check_missing(tokens, ix, grammar_path)
+      def check_missing_space(tokens, ix, grammar_path)
         t = tokens[ix]
         if t.type == :on_op
           unless surrounded_by_whitespace?(tokens[ix - 1, 3])
@@ -60,7 +49,7 @@ module Rubocop
         end
       end
 
-      def check_extra(tokens, ix)
+      def check_unwanted_space(tokens, ix)
         prev, t, nxt = tokens.values_at(ix - 1, ix, ix + 1)
         if t.type == :on_op && t.text == '**' &&
             (whitespace?(prev) || whitespace?(nxt))
@@ -73,10 +62,10 @@ module Rubocop
     class SpaceAroundBraces < Cop
       include SurroundingSpace
 
-      def check_extra(tokens, ix)
+      def check_unwanted_space(tokens, ix)
       end
 
-      def check_missing(tokens, ix, grammar_path)
+      def check_missing_space(tokens, ix, grammar_path)
         t = tokens[ix]
         case t.type
         when :on_lbrace
@@ -93,48 +82,60 @@ module Rubocop
       end
     end
 
-    class SpaceInsideParens < Cop
+    module SpaceInside
       include SurroundingSpace
-      def check_extra(tokens, ix)
+
+      Paren = Struct.new :left, :right, :kind
+
+      def check_unwanted_space(tokens, ix)
+        paren = get_paren
         prev, t, nxt = tokens.values_at(ix - 1, ix, ix + 1)
         offence_detected = case t.type
-                           when :on_lparen
+                           when paren.left
                              nxt.type == :on_sp
-                           when :on_rparen
+                           when paren.right
                              if prev.type == :on_sp
                                prev_ns = previous_non_space(tokens, ix)
-                               prev_ns && tokens_on_same_row?(prev_ns,
-                                                              tokens[ix]) &&
-                                 # Avoid double repoting of ( )
-                                 prev_ns.type != :on_lparen
+                               prev_ns &&
+                                 prev_ns.pos.lineno == tokens[ix].pos.lineno &&
+                                 # Avoid double reporting
+                                 prev_ns.type != paren.left
                              end
                            end
         if offence_detected
           add_offence(:convention, t.pos.lineno,
-                      'Space inside parentheses detected.')
+                      "Space inside #{paren.kind} detected.")
         end
       end
     end
 
+    class SpaceInsideParens < Cop
+      include SpaceInside
+      def get_paren
+        Paren.new(:on_lparen, :on_rparen, 'parentheses')
+      end
+    end
+
     class SpaceInsideBrackets < Cop
-      include SurroundingSpace
-      def check_extra(tokens, ix)
-        prev, t, nxt = tokens.values_at(ix - 1, ix, ix + 1)
-        offence_detected = case t.type
-                           when :on_lbracket
-                             nxt.type == :on_sp
-                           when :on_rbracket
-                             if prev.type == :on_sp
-                               prev_ns = previous_non_space(tokens, ix)
-                               prev_ns && tokens_on_same_row?(prev_ns,
-                                                              tokens[ix]) &&
-                                 # Avoid double repoting of [ ] and ( )
-                                 prev_ns.type != :on_lbracket
-                             end
-                           end
-        if offence_detected
-          add_offence(:convention, t.pos.lineno,
-                      'Space inside square brackets detected.')
+      include SpaceInside
+      def get_paren
+        Paren.new(:on_lbracket, :on_rbracket, 'square brackets')
+      end
+    end
+
+    class SpaceAroundEqualsInParameterDefault < Cop
+      def inspect(file, source, tokens, sexp)
+        each(:params, sexp) do |s|
+          (s[2] || []).each do |param, value|
+            value_pos = all_positions(value).first or next
+            if param[-1].lineno == value_pos.lineno
+              if value_pos.column - (param[-1].column + param[1].length) <= 2
+                add_offence(:convention, param[-1].lineno,
+                            'Surrounding space missing in default value ' +
+                            'assignment.')
+              end
+            end
+          end
         end
       end
     end