rubocop 0.3.1 → 0.3.2

data/lib/rubocop/report/plain_text.rb

@@ -6,7 +6,7 @@ module Rubocop
     class PlainText < Report
       # Generates a string representation of the report
       def generate
-        report = "== #{filename} ==\n"
+        report = "== #{filename} ==\n".yellow
         report << entries.join("\n")
       end
 

data/lib/rubocop/report/report.rb

@@ -16,8 +16,7 @@ module Rubocop
     module_function :create
 
     class Report
-      attr_accessor :entries
-      attr_accessor :filename
+      attr_reader :filename
 
       # @param [String] the filename for this report
       def initialize(filename)
@@ -33,6 +32,10 @@ module Rubocop
         end
       end
 
+      def entries
+        @entries.sort_by(&:line_number)
+      end
+
       def empty?
         entries.empty?
       end

data/rubocop.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rubocop"
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bozhidar Batsov"]
-  s.date = "2013-02-28"
+  s.date = "2013-04-06"
   s.description = "Automatic Ruby code style checking tool. Aims to enforce the community-driven Ruby Style Guide."
   s.email = "bozhidar@batsov.com"
   s.executables = ["rubocop"]
@@ -19,10 +19,8 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
-    ".rbenv-version",
     ".rspec",
     ".rubocop.yml",
-    ".rvmrc",
     ".travis.yml",
     "CONTRIBUTING.md",
     "Gemfile",
@@ -40,20 +38,25 @@ Gem::Specification.new do |s|
     "lib/rubocop/cop/align_parameters.rb",
     "lib/rubocop/cop/ampersands_pipes_vs_and_or.rb",
     "lib/rubocop/cop/blocks.rb",
+    "lib/rubocop/cop/class_and_module_camel_case.rb",
     "lib/rubocop/cop/cop.rb",
     "lib/rubocop/cop/def_parentheses.rb",
     "lib/rubocop/cop/empty_lines.rb",
     "lib/rubocop/cop/encoding.rb",
     "lib/rubocop/cop/end_of_line.rb",
     "lib/rubocop/cop/favor_modifier.rb",
+    "lib/rubocop/cop/favor_unless_over_negated_if.rb",
     "lib/rubocop/cop/grammar.rb",
     "lib/rubocop/cop/hash_syntax.rb",
     "lib/rubocop/cop/if_then_else.rb",
     "lib/rubocop/cop/indentation.rb",
     "lib/rubocop/cop/line_length.rb",
+    "lib/rubocop/cop/method_and_variable_snake_case.rb",
+    "lib/rubocop/cop/new_lambda_literal.rb",
     "lib/rubocop/cop/numeric_literals.rb",
     "lib/rubocop/cop/offence.rb",
     "lib/rubocop/cop/parameter_lists.rb",
+    "lib/rubocop/cop/parentheses_around_condition.rb",
     "lib/rubocop/cop/space_after_comma_etc.rb",
     "lib/rubocop/cop/string_literals.rb",
     "lib/rubocop/cop/surrounding_space.rb",
@@ -70,6 +73,7 @@ Gem::Specification.new do |s|
     "spec/rubocop/cli_spec.rb",
     "spec/rubocop/cops/align_parameters_spec.rb",
     "spec/rubocop/cops/ampersands_pipes_vs_and_or_spec.rb",
+    "spec/rubocop/cops/class_and_module_camel_case_spec.rb",
     "spec/rubocop/cops/cop_spec.rb",
     "spec/rubocop/cops/def_with_parentheses_spec.rb",
     "spec/rubocop/cops/def_without_parentheses_spec.rb",
@@ -77,22 +81,28 @@ Gem::Specification.new do |s|
     "spec/rubocop/cops/encoding_spec.rb",
     "spec/rubocop/cops/end_of_line_spec.rb",
     "spec/rubocop/cops/favor_modifier_spec.rb",
+    "spec/rubocop/cops/favor_unless_over_negated_if_spec.rb",
+    "spec/rubocop/cops/favor_until_over_negated_while_spec.rb",
     "spec/rubocop/cops/grammar_spec.rb",
     "spec/rubocop/cops/hash_syntax_spec.rb",
     "spec/rubocop/cops/if_with_semicolon_spec.rb",
     "spec/rubocop/cops/indentation_spec.rb",
     "spec/rubocop/cops/line_length_spec.rb",
+    "spec/rubocop/cops/method_and_variable_snake_case_spec.rb",
     "spec/rubocop/cops/multiline_blocks_spec.rb",
     "spec/rubocop/cops/multiline_if_then_spec.rb",
+    "spec/rubocop/cops/new_lambda_literal_spec.rb",
     "spec/rubocop/cops/numeric_literals_spec.rb",
     "spec/rubocop/cops/offence_spec.rb",
     "spec/rubocop/cops/one_line_conditional_spec.rb",
     "spec/rubocop/cops/parameter_lists_spec.rb",
+    "spec/rubocop/cops/parentheses_around_condition_spec.rb",
     "spec/rubocop/cops/single_line_blocks_spec.rb",
     "spec/rubocop/cops/space_after_colon_spec.rb",
     "spec/rubocop/cops/space_after_comma_spec.rb",
     "spec/rubocop/cops/space_after_semicolon_spec.rb",
     "spec/rubocop/cops/space_around_braces_spec.rb",
+    "spec/rubocop/cops/space_around_equals_in_default_parameter_spec.rb",
     "spec/rubocop/cops/space_around_operators_spec.rb",
     "spec/rubocop/cops/space_inside_brackets_spec.rb",
     "spec/rubocop/cops/space_inside_parens_spec.rb",
@@ -116,26 +126,29 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rake>, ["~> 10.0.0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.12.0"])
-      s.add_development_dependency(%q<yard>, ["~> 0.8.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.2.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_runtime_dependency(%q<term-ansicolor>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
     else
-      s.add_dependency(%q<rake>, ["~> 10.0.0"])
-      s.add_dependency(%q<rspec>, ["~> 2.12.0"])
-      s.add_dependency(%q<yard>, ["~> 0.8.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.2.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<term-ansicolor>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<simplecov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rake>, ["~> 10.0.0"])
-    s.add_dependency(%q<rspec>, ["~> 2.12.0"])
-    s.add_dependency(%q<yard>, ["~> 0.8.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.2.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<term-ansicolor>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<simplecov>, [">= 0"])
   end
 end

data/spec/rubocop/cli_spec.rb

@@ -10,8 +10,8 @@ module Rubocop
       after(:each) { $stdout = STDOUT }
 
       it 'exits cleanly when -h is used' do
-        lambda { cli.run ['-h'] }.should exit_with_code(0)
-        lambda { cli.run ['--help'] }.should exit_with_code(0)
+        -> { cli.run ['-h'] }.should exit_with_code(0)
+        -> { cli.run ['--help'] }.should exit_with_code(0)
         message = ['Usage: rubocop [options] [file1, file2, ...]',
                    '    -v, --[no-]verbose               Run verbosely',
                    '    -e, --emacs                      Emacs style output',
@@ -27,7 +27,8 @@ module Rubocop
         end
         begin
           cli.run(['example.rb']).should == 0
-          $stdout.string.should == "\n1 files inspected, 0 offences detected\n"
+          $stdout.string.uncolored.should ==
+            "\n1 files inspected, 0 offences detected\n"
         ensure
           File.delete 'example.rb'
         end
@@ -40,28 +41,31 @@ module Rubocop
         end
         begin
           cli.run(['example.rb']).should == 1
-          $stdout.string.should == ['== example.rb ==',
-                                    'C:  2: Trailing whitespace detected.',
-                                    '',
-                                    '1 files inspected, 1 offences detected',
-                                    ''].join("\n")
+          $stdout.string.uncolored.should ==
+            ['== example.rb ==',
+             'C:  2: Trailing whitespace detected.',
+             '',
+             '1 files inspected, 1 offences detected',
+             ''].join("\n")
         ensure
           File.delete 'example.rb'
         end
       end
 
       it 'can report in emacs style' do
-        File.open('example1.rb', 'w') { |f| f.puts 'x = 0 ' }
+        File.open('example1.rb', 'w') { |f| f.puts 'x= 0 ', 'y ' }
         File.open('example2.rb', 'w') { |f| f.puts "\tx = 0" }
         begin
           cli.run(['--emacs', 'example1.rb', 'example2.rb']).should == 1
-          $stdout.string.should ==
+          $stdout.string.uncolored.should ==
             ['example1.rb:1: C: Missing encoding comment.',
              'example1.rb:1: C: Trailing whitespace detected.',
+             "example1.rb:1: C: Surrounding space missing for operator '='.",
+             'example1.rb:2: C: Trailing whitespace detected.',
              'example2.rb:1: C: Missing encoding comment.',
              'example2.rb:1: C: Tab detected.',
              '',
-             '2 files inspected, 4 offences detected',
+             '2 files inspected, 6 offences detected',
              ''].join("\n")
         ensure
           File.delete 'example1.rb'
@@ -100,7 +104,7 @@ module Rubocop
         end
         begin
           return_code = cli.run(['-c', 'rubocop.yml', 'example1.rb'])
-          $stdout.string.should ==
+          $stdout.string.uncolored.should ==
             ['== example1.rb ==',
              'C:  1: Trailing whitespace detected.',
              '',
@@ -125,7 +129,7 @@ module Rubocop
         end
         begin
           return_code = cli.run(['example_src/example1.rb'])
-          $stdout.string.should ==
+          $stdout.string.uncolored.should ==
             ['== example_src/example1.rb ==',
              'C:  1: Trailing whitespace detected.',
              '',
@@ -147,7 +151,7 @@ module Rubocop
         end
         begin
           return_code = cli.run(['example_src/example1.rb'])
-          $stdout.string.should ==
+          $stdout.string.uncolored.should ==
             ['== example_src/example1.rb ==',
              'C:  1: Missing encoding comment.',
              '',
@@ -161,7 +165,8 @@ module Rubocop
 
       it 'finds no violations when checking the rubocop source code' do
         cli.run
-        $stdout.string.should =~ /files inspected, 0 offences detected\n/
+        $stdout.string.uncolored.should =~
+          /files inspected, 0 offences detected\n/
       end
 
       it 'can process a file with an invalide UTF-8 byte sequence' do

data/spec/rubocop/cops/class_and_module_camel_case_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe ClassAndModuleCamelCase do
+      let (:camel_case) { ClassAndModuleCamelCase.new }
+
+      it 'registers an offence for underscore in class and module name' do
+        inspect_source(camel_case, 'file.rb',
+                       ['class My_Class',
+                        'end',
+                        '',
+                        'module My_Module',
+                        'end',
+                       ])
+        camel_case.offences.map(&:message).should ==
+          ['Use CamelCase for classes and modules.'] * 2
+      end
+
+      it 'accepts CamelCase names' do
+        inspect_source(camel_case, 'file.rb',
+                       ['class MyClass',
+                        'end',
+                        '',
+                        'module Mine',
+                        'end',
+                       ])
+        camel_case.offences.map(&:message).should == []
+      end
+    end
+  end
+end

data/spec/rubocop/cops/favor_unless_over_negated_if_spec.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe FavorUnlessOverNegatedIf do
+      let (:fav_unless) { FavorUnlessOverNegatedIf.new }
+
+      it 'registers an offence for if with exclamation point condition' do
+        inspect_source(fav_unless, 'file.rb',
+                       ['if !a_condition',
+                        '  some_method',
+                        'end',
+                        'some_method if !a_condition',
+                       ])
+        fav_unless.offences.map(&:message).should ==
+          ['Favor unless (or control flow or) over if for negative ' +
+           'conditions.'] * 2
+      end
+
+      it 'registers an offence for if with "not" condition' do
+        inspect_source(fav_unless, 'file.rb',
+                       ['if not a_condition',
+                        '  some_method',
+                        'end',
+                        'some_method if not a_condition'])
+        fav_unless.offences.map(&:message).should ==
+          ['Favor unless (or control flow or) over if for negative ' +
+           'conditions.'] * 2
+        fav_unless.offences.map(&:line_number).should == [1, 4]
+      end
+
+      it 'accepts an if/else with negative condition' do
+        inspect_source(fav_unless, 'file.rb',
+                       ['if !a_condition',
+                        '  some_method',
+                        'else',
+                        '  something_else',
+                        'end',
+                        'if not a_condition',
+                        '  some_method',
+                        'elsif other_condition',
+                        '  something_else',
+                        'end'])
+        fav_unless.offences.map(&:message).should == []
+      end
+
+      it 'accepts an if where only part of the contition is negated' do
+        inspect_source(fav_unless, 'file.rb',
+                       ['if !a_condition && another_condition',
+                        '  some_method',
+                        'end',
+                        'if not a_condition or another_condition',
+                        '  some_method',
+                        'end',
+                        'some_method if not a_condition or another_condition'])
+        fav_unless.offences.map(&:message).should == []
+      end
+    end
+  end
+end

data/spec/rubocop/cops/favor_until_over_negated_while_spec.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe FavorUntilOverNegatedWhile do
+      let (:fav_until) { FavorUntilOverNegatedWhile.new }
+
+      it 'registers an offence for while with exclamation point condition' do
+        inspect_source(fav_until, 'file.rb',
+                       ['while !a_condition',
+                        '  some_method',
+                        'end',
+                        'some_method while !a_condition',
+                       ])
+        fav_until.offences.map(&:message).should ==
+          ['Favor until over while for negative conditions.'] * 2
+      end
+
+      it 'registers an offence for while with "not" condition' do
+        inspect_source(fav_until, 'file.rb',
+                       ['while (not a_condition)',
+                        '  some_method',
+                        'end',
+                        'some_method while not a_condition'])
+        fav_until.offences.map(&:message).should ==
+          ['Favor until over while for negative conditions.'] * 2
+        fav_until.offences.map(&:line_number).should == [1, 4]
+      end
+
+      it 'accepts an while where only part of the contition is negated' do
+        inspect_source(fav_until, 'file.rb',
+                       ['while !a_condition && another_condition',
+                        '  some_method',
+                        'end',
+                        'while not a_condition or another_condition',
+                        '  some_method',
+                        'end',
+                        'some_method while not a_condition or other_cond'])
+        fav_until.offences.map(&:message).should == []
+      end
+    end
+  end
+end

data/spec/rubocop/cops/method_and_variable_snake_case_spec.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe MethodAndVariableSnakeCase do
+      let (:snake_case) { MethodAndVariableSnakeCase.new }
+
+      it 'registers an offence for camel case in names' do
+        inspect_source(snake_case, 'file.rb',
+                       ['def myMethod',
+                        '  myLocal = 1',
+                        '  self.mySetter = 2',
+                        '  @myAttribute = 3',
+                        'end',
+                       ])
+        snake_case.offences.map(&:message).should ==
+          ['Use snake_case for methods and variables.'] * 4
+      end
+
+      it 'accepts snake case in names' do
+        inspect_source(snake_case, 'file.rb',
+                       ['def my_method',
+                        '  my_local_html = 1',
+                        '  self.my_setter = 2',
+                        '  @my_attribute = 3',
+                        'end',
+                       ])
+        snake_case.offences.map(&:message).should == []
+      end
+
+      it 'registers an offence for mixed snake case and camel case' do
+        inspect_source(snake_case, 'file.rb',
+                       ['def visit_Arel_Nodes_SelectStatement',
+                        'end'])
+        snake_case.offences.map(&:message).should ==
+          ['Use snake_case for methods and variables.']
+      end
+
+      it 'accepts screaming snake case globals' do
+        inspect_source(snake_case, 'file.rb', ['$MY_GLOBAL = 0'])
+        snake_case.offences.map(&:message).should == []
+      end
+    end
+  end
+end