rubocop 0.5.0 → 0.6.0

data/.rubocop.yml

@@ -10,6 +10,12 @@ LineLength:
   Enabled: true
   Max: 79
 
+# Avoid methods longer than 10 lines of code 
+MethodLength:
+  Enabled: true
+  CountComments: false  # count full line comments?
+  Max: 65
+
 # No hard tabs.
 Tab:
   Enabled: true
@@ -204,4 +210,56 @@ FavorSprintf:
 
 # Use alias_method instead of alias.
 Alias:
-  Enabled: true
+  Enabled: true
+
+# Avoid using rescue in its modifier form.
+RescueModifier:
+  Enabled: true
+
+# Avoid the use of %q, %Q, %s and %x.
+PercentLiterals:
+  Enabled: true
+
+# Prefer () as delimiters for all % literals.
+BraceAfterPercent:
+  Enabled: true
+
+# Never use return in an ensure block.
+EnsureReturn:
+  Enabled: true
+
+# Don't suppress exception.
+HandleExceptions:
+  Enabled: true
+
+# Use only ascii symbols in identifiers and comments.
+AsciiIdentifiersAndComments:
+  Enabled: true
+
+# Avoid rescuing the Exception class.
+RescueException:
+  Enabled: true
+
+# Prefer array literal to Array.new.
+ArrayLiteral:
+  Enabled: true
+
+# Prefer hash {} literail to Hash.new.
+HashLiteral:
+  Enabled: true
+
+# When defining binary operators, name the argument other.
+OpMethod:
+  Enabled: true
+
+# Name reduce arguments |a, e| (accumulator, element)
+ReduceArguments:
+  Enabled: true
+
+# Use %r only for regular expressions matching more than one '/' character.
+PercentR:
+  Enabled: true
+
+# Use %r for regular expressions matching more than one '/' character.
+FavorPercentR:
+  Enabled: true

data/CHANGELOG.md

@@ -6,6 +6,44 @@
 
 ### Bugs fixed
 
+## 0.6.0 (04/23/2013)
+
+### New features
+
+* New cop `ReduceArguments` tracks argument names in reduce calls
+* New cop `MethodLength` tracks number of LOC (lines of code) in methods
+* New cop `RescueModifier` tracks uses of `rescue` in modifier form.
+* New cop `PercentLiterals` tracks uses of `%q`, `%Q`, `%s` and `%x`.
+* New cop `BraceAfterPercent` tracks uses of % literals with
+  delimiters other than ().
+* Support for disabling cops locally in a file with rubocop:disable comments.
+* New cop `EnsureReturn` tracks usages of `return` in `ensure` blocks.
+* New cop `HandleExceptions` tracks suppressed exceptions.
+* New cop `AsciiIdentifiersAndComments` tracks uses of non-ascii
+  characters in identifiers and comments.
+* New cop `RescueException` tracks uses of rescuing the `Exception` class.
+* New cop `ArrayLiteral` tracks uses of Array.new.
+* New cop `HashLiteral` tracks uses of Hash.new.
+* New cop `OpMethod` tracks the argument name in operator methods.
+* New cop `PercentR` tracks uses of %r literals with zero or one slash in the regexp.
+* New cop `FavorPercentR` tracks uses of // literals with more than one slash in the regexp.
+
+### Bugs fixed
+
+* [#62](https://github.com/bbatsov/rubocop/issues/62) - Config files in ancestor directories are ignored if another exists in home directory
+* [#65](https://github.com/bbatsov/rubocop/issues/65) - Suggests to convert symbols :==, :<=> and the like to snake_case
+* [#66](https://github.com/bbatsov/rubocop/issues/66) - Does not crash on unreadable or unparseable files
+* [#70](https://github.com/bbatsov/rubocop/issues/70) - Support `alias` with bareword arguments
+* [#64](https://github.com/bbatsov/rubocop/issues/64) - Performance issue with Bundler
+* [#75](https://github.com/bbatsov/rubocop/issues/75) - Make it clear that some global variables require the use of the English library
+* [#79](https://github.com/bbatsov/rubocop/issues/79) - Ternary operator missing whitespace detection
+
+### Misc
+
+* Dropped Jeweler for gem release management since it's no longer
+  actively maintained.
+* Handle pluralization properly in the final summary.
+
 ## 0.5.0 (04/17/2013)
 
 ### New features

data/Gemfile

@@ -1,12 +1,3 @@
 source 'http://rubygems.org'
 
-gem 'term-ansicolor'
-
-group :development do
-  gem 'rake'
-  gem 'rspec'
-  gem 'yard'
-  gem 'bundler'
-  gem 'jeweler'
-  gem 'simplecov'
-end
+gemspec

data/README.md

@@ -3,6 +3,9 @@
 
 # RuboCop
 
+> Role models are important. <br/>
+> -- Officer Alex J. Murphy / RoboCop
+
 **RuboCop** is a Ruby code style checker based on the
 [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide).
 
@@ -23,7 +26,7 @@ in the current folder:
 $ rubocop
 ```
 
-Alternatively you can `rubocop` a list of files and folders to check:
+Alternatively you can pass `rubocop` a list of files and folders to check:
 
 ```bash
 $ rubocop app spec lib/something.rb
@@ -67,6 +70,30 @@ LineLength:
 It allows to enable/disable certain cops (checks) and to alter their
 behavior if they accept any parameters.
 
+One or more individual cops can be disabled locally in a section of a
+file by adding a comment such as
+
+```ruby
+# rubocop:disable LineLength, StringLiterals
+[...]
+# rubocop:enable LineLength, StringLiterals
+```
+
+You can also disable *all* cops with
+
+```ruby
+# rubocop:disable all
+[...]
+# rubocop:enable all
+```
+
+One or more cops can be disabled on a single line with an end-of-line
+comment.
+
+```ruby
+for x in (0..19) # rubocop:disable AvoidFor
+```
+
 ## Compatibility
 
 Unfortunately every major Ruby implementation has its own code

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'rubygems'
 require 'bundler'
+require 'bundler/gem_tasks'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -10,21 +11,6 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "rubocop"
-  gem.homepage = "http://github.com/bbatsov/rubocop"
-  gem.license = "MIT"
-  gem.summary = %Q{Automatic Ruby code style checking tool.}
-  gem.description = %Q{Automatic Ruby code style checking tool. Aims to enforce the community-driven Ruby Style Guide.}
-  gem.email = "bozhidar@batsov.com"
-  gem.authors = ["Bozhidar Batsov"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
 require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|

data/lib/rubocop.rb

@@ -47,6 +47,20 @@ require 'rubocop/cop/variable_interpolation'
 require 'rubocop/cop/semicolon'
 require 'rubocop/cop/favor_sprintf'
 require 'rubocop/cop/alias'
+require 'rubocop/cop/rescue_modifier'
+require 'rubocop/cop/percent_literals'
+require 'rubocop/cop/brace_after_percent'
+require 'rubocop/cop/ensure_return'
+require 'rubocop/cop/handle_exceptions'
+require 'rubocop/cop/rescue_exception'
+require 'rubocop/cop/ascii_identifiers_and_comments'
+require 'rubocop/cop/hash_literal'
+require 'rubocop/cop/array_literal'
+require 'rubocop/cop/method_length'
+require 'rubocop/cop/op_method'
+require 'rubocop/cop/reduce_arguments'
+require 'rubocop/cop/percent_r'
+require 'rubocop/cop/favor_percent_r'
 
 require 'rubocop/report/report'
 require 'rubocop/report/plain_text'

data/lib/rubocop/cli.rb

@@ -31,7 +31,7 @@ module Rubocop
           $options[:silent] = s
         end
         opts.on('-v', '--version', 'Display version') do
-          puts Rubocop::VERSION
+          puts Rubocop::Version::STRING
           exit(0)
         end
       end.parse!(args)
@@ -42,6 +42,8 @@ module Rubocop
       @configs = {}
 
       target_files(args).each do |file|
+        puts "Scanning #{file}" if $options[:debug]
+
         report = Report.create(file, $options[:mode])
         source = File.readlines(file).map do |line|
           get_rid_of_invalid_byte_sequences(line)
@@ -59,13 +61,16 @@ module Rubocop
         else
           tokens, sexp, correlations = CLI.rip_source(source)
           config = $options[:config] || config_from_dotfile(File.dirname(file))
+          disabled_lines = disabled_lines_in(source)
 
           cops.each do |cop_klass|
-            cop_config = config[cop_klass.name.split('::').last] if config
+            cop_name = cop_klass.name.split('::').last
+            cop_config = config[cop_name] if config
             if cop_config.nil? || cop_config['Enabled']
               cop_klass.config = cop_config
               cop = cop_klass.new
               cop.correlations = correlations
+              cop.disabled_lines = disabled_lines[cop_name]
               cop.inspect(file, source, tokens, sexp)
               total_offences += cop.offences.count
               report << cop if cop.has_report?
@@ -77,14 +82,58 @@ module Rubocop
       end
 
       unless $options[:silent]
-        print "\n#{target_files(args).count} files inspected, "
-        puts "#{total_offences} offences detected"
-          .send(total_offences.zero? ? :green : :red)
+        display_summary(target_files(args).count, total_offences)
       end
 
       return total_offences == 0 ? 0 : 1
     end
 
+    def display_summary(num_files, total_offences)
+      print "\n#{num_files} file#{num_files > 1 ? 's' : ''} inspected, "
+      offences_string = if total_offences.zero?
+                          'no offences'
+                        elsif total_offences == 1
+                          '1 offence'
+                        else
+                          "#{total_offences} offences"
+                        end
+      puts "#{offences_string} detected"
+        .send(total_offences.zero? ? :green : :red)
+    end
+
+    def disabled_lines_in(source)
+      disabled_lines = Hash.new([])
+      disabled_section = {}
+      regexp = '# rubocop : (%s)\b ((?:\w+,? )+)'.gsub(' ', '\s*')
+      section_regexp = '^\s*' + sprintf(regexp, '(?:dis|en)able')
+      single_line_regexp = '\S.*' + sprintf(regexp, 'disable')
+
+      source.each_with_index do |line, ix|
+        each_mentioned_cop(/#{section_regexp}/, line) do |cop_name, kind|
+          disabled_section[cop_name] = (kind == 'disable')
+        end
+        disabled_section.keys.each do |cop_name|
+          disabled_lines[cop_name] += [ix + 1] if disabled_section[cop_name]
+        end
+
+        each_mentioned_cop(/#{single_line_regexp}/, line) do |cop_name, kind|
+          disabled_lines[cop_name] += [ix + 1] if kind == 'disable'
+        end
+      end
+      disabled_lines
+    end
+
+    def each_mentioned_cop(regexp, line)
+      match = line.match(regexp)
+      if match
+        kind, cops = match.captures
+        if cops.include?('all')
+          cops = Cop::Cop.all.map { |c| c.name.split('::').last }.join(',')
+        end
+        cops.split(/,\s*/).each { |cop_name| yield cop_name, kind }
+      end
+    end
+
     def get_rid_of_invalid_byte_sequences(line)
       enc = line.encoding.name
       # UTF-16 works better in this algorithm but is not supported in 1.9.2.
@@ -116,7 +165,7 @@ module Rubocop
           path = File.join(dir, '.rubocop.yml')
           if File.exist?(path)
             @configs[target_file_dir] = YAML.load_file(path)
-            break
+            return @configs[target_file_dir]
           end
           dir = File.expand_path('..', dir)
         end
@@ -179,10 +228,24 @@ module Rubocop
       rb << files.select { |file| File.extname(file) == '.rb' }
       rb << files.select do |file|
         File.extname(file) == '' &&
-        File.open(file) { |f| f.readline } =~ /#!.*ruby/
+        begin
+          File.open(file) { |f| f.readline } =~ /#!.*ruby/
+        rescue EOFError, ArgumentError => e
+          log_error(e, "Unprocessable file #{file.inspect}: ")
+          false
+        end
       end
 
       rb.flatten
     end
+
+    private
+
+    def log_error(e, msg='')
+      if $options[:debug]
+        error_message = "#{e.class}, #{e.message}"
+        STDERR.puts "#{msg}\t#{error_message}"
+      end
+    end
   end
 end

data/lib/rubocop/cop/alias.rb

@@ -6,14 +6,11 @@ module Rubocop
       ERROR_MESSAGE = 'Use alias_method instead of alias.'
 
       def inspect(file, source, tokens, sexp)
-        each(:alias, sexp) do |s|
-          lineno = s[1][1][1][2].lineno
-
-          add_offence(
-            :convention,
-            lineno,
-            ERROR_MESSAGE
-          )
+        tokens.each_index do |ix|
+          t = tokens[ix]
+          if t.type == :on_kw && t.text == 'alias'
+            add_offence(:convention, t.pos.lineno, ERROR_MESSAGE)
+          end
         end
       end
     end

data/lib/rubocop/cop/array_literal.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class ArrayLiteral < Cop
+      ERROR_MESSAGE = 'Use array literal [] instead of Array.new.'
+
+      def inspect(file, source, tokens, sexp)
+        each(:method_add_arg, sexp) do |s|
+          potential_class = s[1][1][1]
+
+          if potential_class[1] == 'Array' && s[1][3][1] == 'new' &&
+              s[2] == [:arg_paren, nil]
+            add_offence(:convention,
+                        potential_class[2].lineno,
+                        ERROR_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/ascii_identifiers_and_comments.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class AsciiIdentifiersAndComments < Cop
+      ERROR_MESSAGE = 'Use only ascii symbols in identifiers and comments.'
+
+      def inspect(file, source, tokens, sexp)
+        tokens.each do |t|
+          if [:on_ident, :on_comment].include?(t.type) &&
+              t.text =~ /[^\x00-\x7f]/
+            add_offence(:convention, t.pos.lineno, ERROR_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/avoid_perlisms.rb

@@ -7,34 +7,25 @@ module Rubocop
         '$:' => '$LOAD_PATH',
         '$"' => '$LOADED_FEATURES',
         '$0' => '$PROGRAM_NAME',
-        '$1' => 'MatchData',
-        '$2' => 'MatchData',
-        '$3' => 'MatchData',
-        '$4' => 'MatchData',
-        '$5' => 'MatchData',
-        '$6' => 'MatchData',
-        '$7' => 'MatchData',
-        '$8' => 'MatchData',
-        '$9' => 'MatchData',
-        '$!' => '$ERROR_INFO',
-        '$@' => '$ERROR_POSITION',
-        '$;' => '$FIELD_SEPARATOR',
-        '$,' => '$OUTPUT_FIELD_SEPARATOR',
-        '$/' => '$INPUT_RECORD_SEPARATOR',
-        '$\\' => 'OUTPUT_RECORD_SEPARATOR',
-        '$.' => '$INPUT_LINE_NUMBER',
-        '$_' => '$LAST_READ_LINE',
-        '$>' => '$DEFAULT_OUTPUT',
-        '$<' => '$DEFAULT_INPUT',
-        '$$' => '$PROCESS_ID',
-        '$?' => '$CHILD_STATUS',
-        '$~' => '$LAST_MATCH_INFO',
-        '$=' => '$IGNORECASE',
-        '$*' => '$ARGV',
-        '$&' => '$MATCH',
-        '$`' => '$PREMATCH',
-        '$\'' => 'POSTMATCH',
-        '$+' => '$LAST_PAREN_MATCH'
+        '$!' => '$ERROR_INFO from English library',
+        '$@' => '$ERROR_POSITION from English library',
+        '$;' => '$FS or $FIELD_SEPARATOR from English library',
+        '$,' => '$OFS or $OUTPUT_FIELD_SEPARATOR from English library',
+        '$/' => '$RS or $INPUT_RECORD_SEPARATOR from English library',
+        '$\\' => '$ORS or $OUTPUT_RECORD_SEPARATOR from English library',
+        '$.' => '$NR or $INPUT_LINE_NUMBER from English library',
+        '$_' => '$LAST_READ_LINE from English library',
+        '$>' => '$DEFAULT_OUTPUT from English library',
+        '$<' => '$DEFAULT_INPUT from English library',
+        '$$' => '$PID or $PROCESS_ID from English library',
+        '$?' => '$CHILD_STATUS from English library',
+        '$~' => '$LAST_MATCH_INFO from English library',
+        '$=' => '$IGNORECASE from English library',
+        '$*' => '$ARGV from English library or ARGV constant',
+        '$&' => '$MATCH from English library',
+        '$`' => '$PREMATCH from English library',
+        '$\'' => '$POSTMATCH from English library',
+        '$+' => '$LAST_PAREN_MATCH from English library'
       }
 
       def inspect(file, source, tokens, sexp)