rubocop 0.5.0 → 0.6.0

data/lib/rubocop/cop/rescue_modifier.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class RescueModifier < Cop
+      ERROR_MESSAGE = 'Avoid using rescue in its modifier form.'
+
+      def inspect(file, source, tokens, sexp)
+        each(:rescue_mod, sexp) do |s|
+          ident = find_first(:@ident, s)
+          lineno = ident ? ident[2].lineno : nil
+
+          add_offence(:convention,
+                      lineno,
+                      ERROR_MESSAGE) if lineno
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/symbol_snake_case.rb

@@ -5,14 +5,14 @@ module Rubocop
     class SymbolSnakeCase < Cop
       ERROR_MESSAGE = 'Use snake_case for symbols.'
       SNAKE_CASE = /^@?[\da-z_]+[!?=]?$/
-      OPERATORS = %w(! + - % * ** [])
-
       def inspect(file, source, tokens, sexp)
         each(:symbol_literal, sexp) do |s|
-          symbol_ident = s[1][1][1]
+          symbol_type = s[1][1][0]
 
-          # handle a couple of special cases
-          next if OPERATORS.include?(symbol_ident)
+          # don't check operators
+          next if symbol_type == :@op
+
+          symbol_ident = s[1][1][1]
 
           unless symbol_ident =~ SNAKE_CASE
             line_no = s[1][1][2].lineno

data/lib/rubocop/cop/syntax.rb

@@ -6,8 +6,19 @@ module Rubocop
   module Cop
     class Syntax < Cop
       def inspect(file, source, tokens, sexp)
-        _, stderr, _ =
-          Open3.capture3('ruby -wc', stdin_data: source.join("\n"))
+        stderr = nil
+
+        # it's extremely important to run the syntax check in a
+        # clean environment - otherwise it will be extremely slow
+        if defined? Bundler
+          Bundler.with_clean_env do
+            _, stderr, _ =
+              Open3.capture3('ruby -wc', stdin_data: source.join("\n"))
+          end
+        else
+          _, stderr, _ =
+            Open3.capture3('ruby -wc', stdin_data: source.join("\n"))
+        end
 
         stderr.each_line do |line|
           # discard lines that are not containing relevant info

data/lib/rubocop/version.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
 module Rubocop
-  VERSION = IO.read(File.join(File.dirname(__FILE__), '../../VERSION'))
+  module Version
+    STRING = '0.6.0'
+  end
 end

data/rubocop.gemspec

@@ -1,175 +1,42 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'rubocop/version'
 
 Gem::Specification.new do |s|
-  s.name = "rubocop"
-  s.version = "0.5.0"
+  s.name = 'rubocop'
+  s.version = Rubocop::Version::STRING
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.9.2'
+  s.authors = ['Bozhidar Batsov']
+  s.date = '2013-04-17'
+  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']
+  s.extra_rdoc_files = ['LICENSE.txt', 'README.md']
+  s.files = ['.document',
+             '.rspec',
+             '.rubocop.yml',
+             '.travis.yml',
+             'CHANGELOG.md',
+             'CONTRIBUTING.md',
+             'Gemfile',
+             'LICENSE.txt',
+             'README.md',
+             'Rakefile',
+             'bin/rubocop',
+             'rubocop.gemspec'] + Dir['lib/**/*.rb']
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Bozhidar Batsov"]
-  s.date = "2013-04-17"
-  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"]
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    ".rubocop.yml",
-    ".travis.yml",
-    "CHANGELOG.md",
-    "CONTRIBUTING.md",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "bin/rubocop",
-    "lib/rubocop.rb",
-    "lib/rubocop/cli.rb",
-    "lib/rubocop/cop/alias.rb",
-    "lib/rubocop/cop/align_parameters.rb",
-    "lib/rubocop/cop/ampersands_pipes_vs_and_or.rb",
-    "lib/rubocop/cop/avoid_class_vars.rb",
-    "lib/rubocop/cop/avoid_for.rb",
-    "lib/rubocop/cop/avoid_perl_backrefs.rb",
-    "lib/rubocop/cop/avoid_perlisms.rb",
-    "lib/rubocop/cop/blocks.rb",
-    "lib/rubocop/cop/class_and_module_camel_case.rb",
-    "lib/rubocop/cop/collection_methods.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_sprintf.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/semicolon.rb",
-    "lib/rubocop/cop/space_after_comma_etc.rb",
-    "lib/rubocop/cop/string_literals.rb",
-    "lib/rubocop/cop/surrounding_space.rb",
-    "lib/rubocop/cop/symbol_snake_case.rb",
-    "lib/rubocop/cop/syntax.rb",
-    "lib/rubocop/cop/tab.rb",
-    "lib/rubocop/cop/ternary_operator.rb",
-    "lib/rubocop/cop/trailing_whitespace.rb",
-    "lib/rubocop/cop/unless_else.rb",
-    "lib/rubocop/cop/variable_interpolation.rb",
-    "lib/rubocop/cop/when_then.rb",
-    "lib/rubocop/report/emacs_style.rb",
-    "lib/rubocop/report/plain_text.rb",
-    "lib/rubocop/report/report.rb",
-    "lib/rubocop/version.rb",
-    "rubocop.gemspec",
-    "spec/rubocop/cli_spec.rb",
-    "spec/rubocop/cops/alias_spec.rb",
-    "spec/rubocop/cops/align_parameters_spec.rb",
-    "spec/rubocop/cops/ampersands_pipes_vs_and_or_spec.rb",
-    "spec/rubocop/cops/avoid_class_vars_spec.rb",
-    "spec/rubocop/cops/avoid_for_spec.rb",
-    "spec/rubocop/cops/avoid_perl_backrefs_spec.rb",
-    "spec/rubocop/cops/avoid_perlisms_spec.rb",
-    "spec/rubocop/cops/class_and_module_camel_case_spec.rb",
-    "spec/rubocop/cops/collection_methods_spec.rb",
-    "spec/rubocop/cops/cop_spec.rb",
-    "spec/rubocop/cops/def_with_parentheses_spec.rb",
-    "spec/rubocop/cops/def_without_parentheses_spec.rb",
-    "spec/rubocop/cops/empty_lines_spec.rb",
-    "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_sprintf_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/semicolon_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",
-    "spec/rubocop/cops/string_literals_spec.rb",
-    "spec/rubocop/cops/symbol_snake_case_spec.rb",
-    "spec/rubocop/cops/syntax_spec.rb",
-    "spec/rubocop/cops/tab_spec.rb",
-    "spec/rubocop/cops/ternary_operator_spec.rb",
-    "spec/rubocop/cops/trailing_whitespace_spec.rb",
-    "spec/rubocop/cops/unless_else_spec.rb",
-    "spec/rubocop/cops/variable_interpolation_spec.rb",
-    "spec/rubocop/cops/when_then_spec.rb",
-    "spec/rubocop/reports/emacs_style_spec.rb",
-    "spec/rubocop/reports/report_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/bbatsov/rubocop"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
-  s.summary = "Automatic Ruby code style checking tool."
+  s.test_files = Dir['spec/**/*.rb']
+  s.homepage = 'http://github.com/bbatsov/rubocop'
+  s.licenses = ['MIT']
+  s.require_paths = ['lib']
+  s.rubygems_version = '1.8.23'
+  s.summary = 'Automatic Ruby code style checking tool.'
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      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<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<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
+  s.add_runtime_dependency(%q<term-ansicolor>, '~> 1.1')
+  s.add_development_dependency(%q<rake>, '~> 10.0')
+  s.add_development_dependency(%q<rspec>, '~> 2.13')
+  s.add_development_dependency(%q<yard>, '~> 0.8')
+  s.add_development_dependency(%q<bundler>, '~> 1.3')
+  s.add_development_dependency(%q<simplecov>, '~> 0.7')
 end
-

data/spec/rubocop/cli_spec.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'fileutils'
+require 'tmpdir'
 require 'spec_helper'
 
 module Rubocop
@@ -25,7 +26,7 @@ module Rubocop
       it 'exits cleanly when -v is used' do
         expect { cli.run ['-v'] }.to exit_with_code(0)
         expect { cli.run ['--version'] }.to exit_with_code(0)
-        expect($stdout.string).to eq((Rubocop::VERSION + "\n") * 2)
+        expect($stdout.string).to eq((Rubocop::Version::STRING + "\n") * 2)
       end
 
       it 'checks a given correct file and returns 0' do
@@ -37,7 +38,7 @@ module Rubocop
         begin
           expect(cli.run(['example.rb'])).to eq(0)
           expect($stdout.string.uncolored)
-            .to eq("\n1 files inspected, 0 offences detected\n")
+            .to eq("\n1 file inspected, no offences detected\n")
         ensure
           File.delete 'example.rb'
         end
@@ -55,7 +56,7 @@ module Rubocop
             .to eq ['== example.rb ==',
                     'C:  2: Trailing whitespace detected.',
                     '',
-                    '1 files inspected, 1 offences detected',
+                    '1 file inspected, 1 offence detected',
                     ''].join("\n")
         ensure
           File.delete 'example.rb'
@@ -69,11 +70,11 @@ module Rubocop
           expect(cli.run(['--emacs', 'example1.rb', 'example2.rb'])).to eq(1)
           expect($stdout.string.uncolored)
             .to eq(
-            ['example1.rb:1: C: Missing encoding comment.',
+            ['example1.rb:1: C: Missing utf-8 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: Missing utf-8 encoding comment.',
              'example2.rb:1: C: Tab detected.',
              '',
              '2 files inspected, 6 offences detected',
@@ -113,9 +114,9 @@ module Rubocop
                           'example1.rb',
                           'example2.rb'])).to eq(1)
           expect($stdout.string).to eq(
-            ['example1.rb:1: C: Missing encoding comment.',
+            ['example1.rb:1: C: Missing utf-8 encoding comment.',
              'example1.rb:1: C: Trailing whitespace detected.',
-             'example2.rb:1: C: Missing encoding comment.',
+             'example2.rb:1: C: Missing utf-8 encoding comment.',
              'example2.rb:1: C: Tab detected.',
              ''].join("\n"))
         ensure
@@ -157,7 +158,7 @@ module Rubocop
             ['== example1.rb ==',
              'C:  1: Trailing whitespace detected.',
              '',
-             '1 files inspected, 1 offences detected',
+             '1 file inspected, 1 offence detected',
              ''].join("\n"))
         ensure
           File.delete 'example1.rb'
@@ -181,7 +182,7 @@ module Rubocop
             ['== example_src/example1.rb ==',
              'C:  1: Trailing whitespace detected.',
              '',
-             '1 files inspected, 1 offences detected',
+             '1 file inspected, 1 offence detected',
              ''].join("\n"))
         ensure
           FileUtils.rm_rf 'example_src'
@@ -202,7 +203,7 @@ module Rubocop
         begin
           expect(cli.run(['example_src/example1.rb'])).to eq(0)
           expect($stdout.string.uncolored).to eq(
-            ['', '1 files inspected, 0 offences detected',
+            ['', '1 file inspected, no offences detected',
              ''].join("\n"))
         ensure
           FileUtils.rm_rf 'example_src'
@@ -228,17 +229,50 @@ module Rubocop
             ['== example/lib/example1.rb ==',
              'C:  2: Line is too long. [90/79]',
              '',
-             '2 files inspected, 1 offences detected',
+             '2 files inspected, 1 offence detected',
              ''].join("\n"))
         ensure
           FileUtils.rm_rf 'example'
         end
       end
 
+      it 'prefers a config file in ancestor directory to another in home' do
+        FileUtils.mkdir 'example_src'
+        File.open('example_src/example1.rb', 'w') do |f|
+          f.puts '# encoding: utf-8'
+          f.puts '#' * 90
+        end
+        File.open('example_src/.rubocop.yml', 'w') do |f|
+          f.puts('LineLength:',
+                 '  Enabled: true',
+                 '  Max: 100')
+        end
+        Dir.mktmpdir do |tmpdir|
+          @original_home = ENV['HOME']
+          ENV['HOME'] = tmpdir
+          File.open("#{Dir.home}/.rubocop.yml", 'w') do |f|
+            f.puts('LineLength:',
+                   '  Enabled: true',
+                   '  Max: 80')
+          end
+          begin
+            expect(cli.run(['example_src/example1.rb'])).to eq(0)
+            expect($stdout.string.uncolored).to eq(
+              ['', '1 file inspected, no offences detected',
+               ''].join("\n"))
+          ensure
+            FileUtils.rm_rf 'example_src'
+            ENV['HOME'] = @original_home
+          end
+        end
+      end
+
       it 'finds no violations when checking the rubocop source code' do
-        cli.run
+        # Need to pass an empty array explicitly
+        # so that the CLI does not refer arguments of `rspec`
+        cli.run([])
         expect($stdout.string.uncolored).to match(
-          /files inspected, 0 offences detected\n/
+          /files inspected, no offences detected\n/
         )
       end
 
@@ -255,7 +289,7 @@ module Rubocop
             ["example.rb:3: E: Syntax error, unexpected #{unexpected_part}, " +
              'expecting keyword_end',
              '',
-             '1 files inspected, 1 offences detected',
+             '1 file inspected, 1 offence detected',
              ''].join("\n"))
         ensure
           File.delete 'example.rb'
@@ -281,6 +315,101 @@ module Rubocop
         expect(YAML.load_file('.rubocop.yml').keys.sort).to eq(cop_names.sort)
       end
 
+      it 'can have all cops disabled in a code section' do
+        File.open('example.rb', 'w') do |f|
+          f.puts '# encoding: utf-8'
+          f.puts '# rubocop:disable all'
+          f.puts '#' * 90
+          f.puts 'x(123456)'
+          f.puts 'y("123")'
+          f.puts 'def func'
+          f.puts '  # rubocop: enable LineLength, StringLiterals'
+          f.puts '  ' + '#' * 93
+          f.puts '  x(123456)'
+          f.puts '  y("123")'
+          f.puts 'end'
+        end
+        begin
+          expect(cli.run(['--emacs', 'example.rb'])).to eq(1)
+          # all cops were disabled, then 2 were enabled again, so we
+          # should get 2 offences reported.
+          expect($stdout.string.uncolored).to eq(
+            ['example.rb:8: C: Line is too long. [95/79]',
+             "example.rb:10: C: Prefer single-quoted strings when you don't " +
+             'need string interpolation or special symbols.',
+             '',
+             '1 file inspected, 2 offences detected',
+             ''].join("\n"))
+        ensure
+          File.delete 'example.rb'
+        end
+      end
+
+      it 'can have selected cops disabled in a code section' do
+        File.open('example.rb', 'w') do |f|
+          f.puts '# encoding: utf-8'
+          f.puts '# rubocop:disable LineLength,NumericLiterals,StringLiterals'
+          f.puts '#' * 90
+          f.puts 'x(123456)'
+          f.puts 'y("123")'
+          f.puts 'def func'
+          f.puts '  # rubocop: enable LineLength, StringLiterals'
+          f.puts '  ' + '#' * 93
+          f.puts '  x(123456)'
+          f.puts '  y("123")'
+          f.puts 'end'
+        end
+        begin
+          expect(cli.run(['--emacs', 'example.rb'])).to eq(1)
+          # 3 cops were disabled, then 2 were enabled again, so we
+          # should get 2 offences reported.
+          expect($stdout.string.uncolored).to eq(
+            ['example.rb:8: C: Line is too long. [95/79]',
+             "example.rb:10: C: Prefer single-quoted strings when you don't " +
+             'need string interpolation or special symbols.',
+             '',
+             '1 file inspected, 2 offences detected',
+             ''].join("\n"))
+        ensure
+          File.delete 'example.rb'
+        end
+      end
+
+      it 'can have all cops disabled on a single line' do
+        File.open('example.rb', 'w') do |f|
+          f.puts '# encoding: utf-8'
+          f.puts 'y("123", 123456) # rubocop:disable all'
+        end
+        begin
+          expect(cli.run(['--emacs', 'example.rb'])).to eq(0)
+          expect($stdout.string.uncolored).to eq(
+            ['',
+             '1 file inspected, no offences detected',
+             ''].join("\n"))
+        ensure
+          File.delete 'example.rb'
+        end
+      end
+
+      it 'can have selected cops disabled on a single line' do
+        File.open('example.rb', 'w') do |f|
+          f.puts '# encoding: utf-8'
+          f.puts '#' * 90 + ' # rubocop:disable LineLength'
+          f.puts '#' * 95
+          f.puts 'y("123") # rubocop:disable LineLength,StringLiterals'
+        end
+        begin
+          expect(cli.run(['--emacs', 'example.rb'])).to eq(1)
+          expect($stdout.string.uncolored).to eq(
+            ['example.rb:3: C: Line is too long. [95/79]',
+             '',
+             '1 file inspected, 1 offence detected',
+             ''].join("\n"))
+        ensure
+          File.delete 'example.rb'
+        end
+      end
+
       it 'finds a file with no .rb extension but has a shebang line' do
         FileUtils::mkdir 'test'
         File.open('test/example', 'w') do |f|
@@ -291,9 +420,11 @@ module Rubocop
         end
         begin
           FileUtils::cd 'test' do
+            # Need to pass an empty array explicitly
+            # so that the CLI does not refer arguments of `rspec`
             expect(cli.run([])).to eq(0)
             expect($stdout.string.uncolored).to eq(
-              ['', '1 files inspected, 0 offences detected',
+              ['', '1 file inspected, no offences detected',
                ''].join("\n"))
           end
         ensure