rubocop 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb18ed08073976272837da47ef0ba86606395c5b
-  data.tar.gz: f8c1cab8cf88ce7f1cbbb4815349e83cce88b5e3
+  metadata.gz: 8c61251297391f7ee7286eb0e4482e975a42122f
+  data.tar.gz: 4375f2e36ceaa75510f7e4cdece56d3f1e22700f
 SHA512:
-  metadata.gz: 19e21fa9f97a22498da1cf6fe7512e1fe64923ec9b87d10c4abcfbe7583acfc0f6f68bb32d6c4bf020425c20856c4fe9e323c7fda6e435f2dc694556111a819a
-  data.tar.gz: 4d9e3e6896f2a836d626ef81147288a5eec30bb084f22ad565de20805d52d3a5ee3f9c16cd96d833ae463beca321e6ba45e8dd9e216b5068cce6f549478db9e5
+  metadata.gz: 9a6ed60555b7fbc888b9a68190c79bb525ece1e3623e1025fe833016e13b635b947b0cf49fab267ab4bf886bb0c8438bea130011a8c9dd8efa3e6e863b218b8f
+  data.tar.gz: 2f4161c9a52973931d695f900045b46b55e56d62debac661ab25308b031e383906cf33b107f8cf8f6701dba4c251cf9bac7ae49f32550aaca278bae7d556d688

data/.travis.yml

@@ -2,4 +2,10 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-script: bundle exec rspec
+  - jruby-19mode
+  - rbx-19mode
+script: bundle exec rspec
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-19mode

data/CHANGELOG.md

@@ -4,6 +4,25 @@
 
 ### New features
 
+### Changes
+
+### Bugs fixed
+
+## 0.8.0 (05/28/2012)
+
+### Changes
+
+* Folded `ArrayLiteral` and `HashLiteral` into `EmptyLiteral` cop
+* The maximum number of params `ParameterLists` accepts in now configurable
+* Reworked `SymbolSnakeCase` into `SymbolName`, which has an option `AllowCamelCase` enabled by default.
+* Migrated from `Ripper` to the portable [Parser](https://github.com/whitequark/parser).
+
+### New features
+
+* New cop `ConstantName` checks for constant which are not using `SCREAMING_SNAKE_CASE`.
+* New cop `AccessControl` checks private/protected indentation and surrounding blank lines.
+* New cop `Loop` checks for `begin/end/while(until)` and suggests the use of `Kernel#loop`.
+
 ## 0.7.2 (05/13/2013)
 
 ### Bugs fixed

data/README.md

@@ -97,7 +97,7 @@ The file `config/default.yml` under the RuboCop home directory
 contains the default settings that all configurations inherit
 from. Project and personal `.rubocop.yml` files need only make
 settings that are different from the default ones. If there is no
-`.rubocop.yml` file in the project or home direcotry,
+`.rubocop.yml` file in the project or home directory,
 `config/default.yml` will be used.
 
 ### Disabling Cops within Source Code
@@ -132,7 +132,7 @@ RuboCop checks all files recursively within the directory it is run
 on.  However, it does not recognize some files as Ruby(only files
 ending with `.rb` or extensionless files with a `#!.*ruby` declaration
 are automatically detected) files, and if you'd like it to check these
-you'll need to manually pass them in.  Files and directories can be
+you'll need to manually pass them in.  Files and directories can
 also be ignored through `.rubocop.yml`.
 
 Here is an example that might be used for a Rails project:
@@ -155,12 +155,8 @@ Note: Files and directories are specified relative to the `.rubocop.yml` file.
 
 ## 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.
+RuboCop supported only MRI 1.9 & MRI 2.0 prior to version 0.8. After
+RuboCop 0.8, JRuby and Rubinius in 1.9 modes are also supported.
 
 ## Editor integration
 

data/bin/rubocop

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-if RUBY_ENGINE == 'ruby' && RUBY_VERSION >= '1.9.2'
+if RUBY_VERSION >= '1.9.2'
   $LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
 
   require 'rubocop'
@@ -17,6 +17,6 @@ if RUBY_ENGINE == 'ruby' && RUBY_VERSION >= '1.9.2'
   puts "Finished in #{time} seconds" if cli.options[:debug]
   exit result
 else
-  puts 'RuboCop supports only MRI 1.9.2+'
+  puts 'RuboCop supports only Ruby 1.9.2+'
   exit(-1)
 end

data/config/default.yml

@@ -22,6 +22,10 @@ MethodLength:
   CountComments: false  # count full line comments?
   Max: 10
 
+# Avoid parameter lists longer than four parameters.
+ParameterLists:
+  Max: 4
+
 # Don't use semicolons to terminate expressions.
 Semicolon:
   # For example; def area(height, width); height * width end
@@ -36,3 +40,7 @@ SingleLineMethods:
 # Use spaces inside hash literal braces - or don't.
 SpaceInsideHashLiteralBraces:
   EnforcedStyleIsWithSpaces: true
+
+# Symbol literals should use snake_case.
+SymbolName:
+  AllowCamelCase: true

data/config/enabled.yml

@@ -101,11 +101,8 @@ OneLineConditional:
   Enabled: true
 
 # Avoid using {...} for multi-line blocks (multiline chaining is always ugly).
-MultilineBlocks:
-  Enabled: true
-
 # Prefer {...} over do...end for single-line blocks.
-SingleLineBlocks:
+Blocks:
   Enabled: true
 
 # Avoid parameter lists longer than three or four parameters.
@@ -128,8 +125,8 @@ NestedTernaryOperator:
 UnlessElse:
   Enabled: true
 
-# Use &&/|| for boolean expressions, and/or for control flow.
-AmpersandsPipesVsAndOr:
+# Use &&/|| instead of and/or.
+AndOr:
   Enabled: true
 
 # Use when x then ... for one-line cases.
@@ -196,10 +193,6 @@ AvoidPerlBackrefs:
 AvoidClassVars:
   Enabled: true
 
-# Symbol literals should use snake_case.
-SymbolSnakeCase:
-  Enabled: true
-
 # Don't interpolate global, instance and class variables directly in strings.
 VariableInterpolation:
   Enabled: true
@@ -228,14 +221,6 @@ Not:
 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
@@ -260,12 +245,8 @@ BlockComments:
 RescueException:
   Enabled: true
 
-# Prefer array literal to Array.new.
-ArrayLiteral:
-  Enabled: true
-
-# Prefer hash {} literail to Hash.new.
-HashLiteral:
+# Prefer literals to Array.new/Hash.new/String.new.
+EmptyLiteral:
   Enabled: true
 
 # When defining binary operators, name the argument other.
@@ -323,3 +304,19 @@ AvoidGlobalVars:
 # The use of eval represents a serious security risk.
 Eval:
   Enabled: true
+
+# Symbol literals should use snake_case.
+SymbolName:
+  Enabled: true
+
+# Constants should use SCREAMING_SNAKE_CASE.
+ConstantName:
+  Enabled: true
+
+# Indent private/protected as deep as defs and keep blank lines around them.
+AccessControl:
+  Enabled: true
+
+# Use Kernel#loop with break rather than begin/end/until or begin/end/while for post-loop tests.
+Loop:
+  Enabled: true

data/lib/rubocop.rb

@@ -1,9 +1,11 @@
 # encoding: utf-8
 
-require 'ripper'
 require 'rainbow'
 require 'English'
+require 'parser/current'
+require 'ast/sexp'
 
+require 'rubocop/cop/util'
 require 'rubocop/cop/offence'
 require 'rubocop/cop/cop'
 require 'rubocop/cop/encoding'
@@ -29,7 +31,7 @@ require 'rubocop/cop/parameter_lists'
 require 'rubocop/cop/string_literals'
 require 'rubocop/cop/ternary_operator'
 require 'rubocop/cop/unless_else'
-require 'rubocop/cop/ampersands_pipes_vs_and_or'
+require 'rubocop/cop/and_or'
 require 'rubocop/cop/when_then'
 require 'rubocop/cop/favor_modifier'
 require 'rubocop/cop/favor_unless_over_negated_if'
@@ -43,23 +45,21 @@ require 'rubocop/cop/avoid_perlisms'
 require 'rubocop/cop/avoid_perl_backrefs'
 require 'rubocop/cop/avoid_global_vars'
 require 'rubocop/cop/avoid_class_vars'
-require 'rubocop/cop/symbol_snake_case'
+require 'rubocop/cop/symbol_name'
+require 'rubocop/cop/constant_name'
 require 'rubocop/cop/variable_interpolation'
 require 'rubocop/cop/semicolon'
 require 'rubocop/cop/favor_sprintf'
 require 'rubocop/cop/favor_join'
 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'
 require 'rubocop/cop/ascii_comments'
 require 'rubocop/cop/block_comments'
-require 'rubocop/cop/hash_literal'
-require 'rubocop/cop/array_literal'
+require 'rubocop/cop/empty_literal'
 require 'rubocop/cop/method_length'
 require 'rubocop/cop/op_method'
 require 'rubocop/cop/reduce_arguments'
@@ -74,6 +74,8 @@ require 'rubocop/cop/leading_comment_space'
 require 'rubocop/cop/colon_method_call'
 require 'rubocop/cop/not'
 require 'rubocop/cop/eval'
+require 'rubocop/cop/access_control'
+require 'rubocop/cop/loop'
 
 require 'rubocop/report/report'
 require 'rubocop/report/plain_text'

data/lib/rubocop/cli.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 require 'pathname'
 require 'optparse'
-require_relative 'cop/grammar'
 
 module Rubocop
   # The CLI is a class responsible of handling all the command line interface
@@ -33,7 +32,7 @@ module Rubocop
       parse_options(args)
 
       begin
-        handle_only_option if @options[:only]
+        validate_only_option if @options[:only]
       rescue ArgumentError => e
         puts e.message
         return 1
@@ -44,13 +43,12 @@ module Rubocop
 
         config = ConfigStore.for(file)
         report = Report.create(file, @options[:mode])
-        source = read_source(file)
 
         puts "Scanning #{file}" if @options[:debug]
 
         syntax_cop = Rubocop::Cop::Syntax.new
         syntax_cop.debug = @options[:debug]
-        syntax_cop.inspect(file, source, nil, nil)
+        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
@@ -58,7 +56,7 @@ module Rubocop
           report << syntax_cop
           @total_offences += syntax_cop.offences.count
         else
-          inspect_file(file, source, config, report)
+          inspect_file(file, config, report)
         end
 
         @processed_file_count += 1
@@ -72,41 +70,38 @@ module Rubocop
       (@total_offences == 0) && !wants_to_quit ? 0 : 1
     end
 
-    def handle_only_option
-      @cops = @cops.select { |c| c.cop_name == @options[:only] }
-      if @cops.empty?
+    def validate_only_option
+      if @cops.none? { |c| c.cop_name == @options[:only] }
         fail ArgumentError, "Unrecognized cop name: #{@options[:only]}."
       end
     end
 
-    def read_source(file)
-      get_rid_of_invalid_byte_sequences(File.read(file)).split($RS)
-    end
+    def inspect_file(file, config, report)
+      begin
+        ast, comments, tokens, source = CLI.parse(file) do |source_buffer|
+          source_buffer.read
+        end
+      rescue Parser::SyntaxError, Encoding::UndefinedConversionError,
+        ArgumentError => e
+        handle_error(e, "An error occurred while parsing #{file}.".color(:red))
+        return
+      end
 
-    def inspect_file(file, source, config, report)
-      tokens, sexp, correlations = CLI.rip_source(source)
       disabled_lines = disabled_lines_in(source)
 
-      @cops.each do |cop_klass|
-        cop_name = cop_klass.cop_name
-        cop_config = config.for_cop(cop_name)
+      @cops.each do |cop_class|
+        cop_name = cop_class.cop_name
         if config.cop_enabled?(cop_name)
-          cop_klass.config = cop_config
-          cop = cop_klass.new
-          cop.debug = @options[:debug]
-          cop.correlations = correlations
-          cop.disabled_lines = disabled_lines[cop_name]
-          begin
-            cop.inspect(file, source, tokens, sexp)
-          rescue => e
-            message = "An error occurred while #{cop.name} cop".color(:red) +
-              " was inspecting #{file}.".color(:red)
-            @errors << message
-            warn message
-            if @options[:debug]
-              puts e.message, e.backtrace
-            else
-              warn 'To see the complete backtrace run rubocop -d.'
+          cop = setup_cop(cop_class,
+                          config.for_cop(cop_name),
+                          disabled_lines)
+          if !@options[:only] || @options[:only] == cop_name
+            begin
+              cop.inspect(source, tokens, ast, comments)
+            rescue => e
+              handle_error(e,
+                           "An error occurred while #{cop.name}".color(:red) +
+                           " cop was inspecting #{file}.".color(:red))
             end
           end
           @total_offences += cop.offences.count
@@ -115,6 +110,24 @@ module Rubocop
       end
     end
 
+    def setup_cop(cop_class, cop_config, disabled_lines)
+      cop_class.config = cop_config
+      cop = cop_class.new
+      cop.debug = @options[:debug]
+      cop.disabled_lines = disabled_lines[cop_class.cop_name]
+      cop
+    end
+
+    def handle_error(e, message)
+      @errors << message
+      warn message
+      if @options[:debug]
+        puts e.message, e.backtrace
+      else
+        warn 'To see the complete backtrace run rubocop -d.'
+      end
+    end
+
     def parse_options(args)
       OptionParser.new do |opts|
         opts.banner = 'Usage: rubocop [options] [file1, file2, ...]'
@@ -207,21 +220,28 @@ module Rubocop
       end
     end
 
-    def get_rid_of_invalid_byte_sequences(source)
-      source_encoding = source.encoding.name
-      # UTF-16 works better in this algorithm but is not supported in 1.9.2.
-      temporary_encoding = (RUBY_VERSION == '1.9.2') ? 'UTF-8' : 'UTF-16'
-      source.encode!(temporary_encoding, source_encoding,
-                     invalid: :replace, replace: '')
-      source.encode!(source_encoding, temporary_encoding)
-    end
+    def self.parse(file)
+      parser = Parser::CurrentRuby.new
+
+      parser.diagnostics.all_errors_are_fatal = true
+      parser.diagnostics.ignore_warnings      = true
+
+      parser.diagnostics.consumer = lambda do |diagnostic|
+        $stderr.puts(diagnostic.render)
+      end
+
+      source_buffer = Parser::Source::Buffer.new(file, 1)
+      yield source_buffer
 
-    def self.rip_source(source)
-      tokens = Ripper.lex(source.join("\n")).map { |t| Cop::Token.new(*t) }
-      sexp = Ripper.sexp(source.join("\n"))
-      Cop::Position.make_position_objects(sexp)
-      correlations = Cop::Grammar.new(tokens).correlate(sexp)
-      [tokens, sexp, correlations]
+      ast, comments, tokens = parser.tokenize(source_buffer)
+
+      tokens = tokens.map do |t|
+        type, details = *t
+        text, range = *details
+        Rubocop::Cop::Token.new(range, type, text)
+      end
+
+      [ast, comments, tokens, source_buffer.source.split($RS)]
     end
 
     # Generate a list of target files by expanding globing patterns
@@ -261,12 +281,13 @@ module Rubocop
 
       rb += files.select { |file| File.extname(file) == '.rb' }
       rb += files.select do |file|
-        File.extname(file) == '' &&
-        begin
-          File.open(file) { |f| f.readline } =~ /#!.*ruby/
-        rescue EOFError, ArgumentError => e
-          log_error(e, "Unprocessable file #{file.inspect}: ")
-          false
+        if File.extname(file) == ''
+          begin
+            File.open(file) { |f| f.readline } =~ /#!.*ruby/
+          rescue EOFError, ArgumentError => e
+            log_error(e, "Unprocessable file #{file.inspect}: ")
+            false
+          end
         end
       end