rubocop 0.4.0 → 0.4.1

data/.rubocop.yml

@@ -1,61 +1,80 @@
 # This is the default configuration file with all checking enabled. It is also
 # the configuration used to check the rubocop source code.
 
+# Use UTF-8 as the source file encoding.
 Encoding:
   Enabled: true
 
+# Limit lines to 80 characters.
 LineLength:
   Enabled: true
   Max: 79
 
+# No hard tabs.
 Tab:
   Enabled: true
 
+# Avoid trailing whitespace.
 TrailingWhitespace:
   Enabled: true
 
+# Use two spaces per indentation level.
 Indentation:
   Enabled: true
 
+# Use empty lines between defs and to break up a method into logical paragraphs.
 EmptyLines:
   Enabled: true
 
+# Use spaces around operators.
 SpaceAroundOperators:
   Enabled: true
 
+# Use spaces around { and before }.
 SpaceAroundBraces:
   Enabled: true
 
+# No spaces after ( or before ).
 SpaceInsideParens:
   Enabled: true
 
+# No spaces after [ or before ].
 SpaceInsideBrackets:
   Enabled: true
 
+# Use spaces after commas.
 SpaceAfterComma:
   Enabled: true
 
+# Use spaces after semicolons.
 SpaceAfterSemicolon:
   Enabled: true
 
+# Use spaces after colons.
 SpaceAfterColon:
   Enabled: true
 
+# Prefer symbols instead of strings as hash keys.
 HashSyntax:
   Enabled: true
 
+# Use Unix-style line endings.
 EndOfLine:
   Enabled: true
 
+# Add underscores to large numeric literals to improve their readability.
 NumericLiterals:
   Enabled: true
 
+# Align the parameters of a method call if they span more than one line.
 AlignParameters:
   Enabled: true
 
+# Use def with parentheses when there are arguments.
 DefWithParentheses:
   Enabled: true
 
+# Omit the parentheses when the method doesn't accept any arguments.
 DefWithoutParentheses:
   Enabled: true
 
@@ -68,62 +87,94 @@ MultilineIfThen:
 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:
   Enabled: true
 
+# Avoid parameter lists longer than three or four parameters.
 ParameterLists:
   Enabled: true
 
+# Prefer ' strings when you don't need string interpolation or special symbols.
 StringLiterals:
   Enabled: true
 
+# Avoid multi-line ?: (the ternary operator); use if/unless instead.
 MultilineTernaryOperator:
   Enabled: true
 
+# Use one expression per branch in a ternary operator.
 NestedTernaryOperator:
   Enabled: true
 
+# Never use unless with else. Rewrite these with the positive case first.
 UnlessElse:
   Enabled: true
 
+# Use &&/|| for boolean expressions, and/or for control flow.
 AmpersandsPipesVsAndOr:
   Enabled: true
 
+# Use when x then ... for one-line cases.
 WhenThen:
   Enabled: true
 
+# Favor modifier if/unless usage when you have a single-line body.
 IfUnlessModifier:
   Enabled: true
 
+# Favor modifier while/until usage when you have a single-line body.
 WhileUntilModifier:
   Enabled: true
 
+# Favor unless over if for negative conditions (or control flow or).
 FavorUnlessOverNegatedIf:
   Enabled: true
 
+# Favor until over while for negative conditions.
 FavorUntilOverNegatedWhile:
   Enabled: true
 
+# Use spaces around the = operator when assigning default values in def params.
 SpaceAroundEqualsInParameterDefault:
   Enabled: true
 
+# Use the new lambda literal syntax.
 NewLambdaLiteral:
   Enabled: true
 
+# Don't use parentheses around the condition of an if/unless/while.
 ParenthesesAroundCondition:
   Enabled: true
 
+# Use snake_case for symbols, methods and variables.
 MethodAndVariableSnakeCase:
   Enabled: true
 
+# Use CamelCase for classes and modules.
 ClassAndModuleCamelCase:
   Enabled: true
 
+# Causes Ruby to check the syntax of the script and exit without executing.
 Syntax:
   Enabled: true
 
+# Preferred collection methods.
 CollectionMethods:
   Enabled: true
+
+# Prefer each over for.
+AvoidFor:
+  Enabled: true
+
+# Avoid Perl-style global variables.
+AvoidPerlisms:
+  Enabled: true
+
+# Avoid Perl-style regex back references.
+AvoidPerlBackrefs:
+  Enabled: true

data/README.md

@@ -41,7 +41,7 @@ Command flag       | Description
 `-d/--debug`       | Displays some extra debug output
 `-e/--emacs`       | Output the results in Emacs format
 `-c/--config`      | Run with specified config file
-`-s/-silent`       | Suppress the final summary
+`-s/--silent`      | Suppress the final summary
 
 ## Configuration
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/lib/rubocop.rb

@@ -38,6 +38,9 @@ require 'rubocop/cop/parentheses_around_condition'
 require 'rubocop/cop/method_and_variable_snake_case'
 require 'rubocop/cop/class_and_module_camel_case'
 require 'rubocop/cop/collection_methods'
+require 'rubocop/cop/avoid_for'
+require 'rubocop/cop/avoid_perlisms'
+require 'rubocop/cop/avoid_perl_backrefs'
 
 require 'rubocop/report/report'
 require 'rubocop/report/plain_text'

data/lib/rubocop/cop/avoid_for.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class AvoidFor < Cop
+      ERROR_MESSAGE = 'Prefer *each* over *for*.'
+
+      def inspect(file, source, tokens, sexp)
+        each(:for, sexp) do |s|
+          add_offence(:convention,
+                      s[1][1][2].lineno,
+                      ERROR_MESSAGE)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/avoid_perl_backrefs.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class AvoidPerlBackrefs < Cop
+      def inspect(file, source, tokens, sexp)
+        each(:@backref, sexp) do |s|
+          backref = s[1]
+          lineno = s[2].lineno
+
+          add_offence(
+            :convention,
+            lineno,
+            "Prefer the use of MatchData over #{backref}."
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/avoid_perlisms.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class AvoidPerlisms < Cop
+      PREFERRED_VARS = {
+        '$:' => '$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'
+      }
+
+      def inspect(file, source, tokens, sexp)
+        each(:@gvar, sexp) do |s|
+          global_var = s[1]
+
+          if PREFERRED_VARS[global_var]
+            add_offence(
+              :convention,
+              s[2].lineno,
+              "Prefer #{PREFERRED_VARS[global_var]} over #{global_var}."
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/grammar.rb

@@ -5,7 +5,7 @@ module Rubocop
     class Grammar
       def initialize(tokens)
         @tokens_without_pos = tokens.map { |t| [t.type, t.text] }
-        process_embedded_expressions
+        process_embedded_expressions if RUBY_VERSION < '2.0'
         @token_indexes = {}
         @tokens_without_pos.each_with_index do |t, i|
           @token_indexes[t] ||= []
@@ -21,7 +21,7 @@ module Rubocop
         }
       end
 
-      # The string "#{x}" will give the tokens
+      # In ruby 1.9.3 and below, the string "#{x}" will give the tokens
       # [:on_tstring_beg, '"'], [:on_embexpr_beg, '#{'], [:on_ident, 'x'],
       # [:on_rbrace, '}'], [:on_tstring_end, '"']
       # which is not so good for us. We want to distinguish between a
@@ -45,7 +45,7 @@ module Rubocop
             end
           when :inside_expr
             case type
-            when :on_lbrace
+            when :on_lbrace, :on_embexpr_end
               brace_depth += 1
             when :on_rbrace
               if brace_depth == 1

data/rubocop.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rubocop"
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bozhidar Batsov"]
-  s.date = "2013-04-11"
+  s.date = "2013-04-13"
   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"]
@@ -34,6 +34,9 @@ Gem::Specification.new do |s|
     "lib/rubocop/cli.rb",
     "lib/rubocop/cop/align_parameters.rb",
     "lib/rubocop/cop/ampersands_pipes_vs_and_or.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",
@@ -72,6 +75,9 @@ 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/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",

data/spec/rubocop/cli_spec.rb

@@ -215,7 +215,7 @@ module Rubocop
         )
       end
 
-      it 'can process a file with an invalide UTF-8 byte sequence' do
+      it 'can process a file with an invalid UTF-8 byte sequence' do
         File.open('example.rb', 'w') do |f|
           f.puts '# encoding: utf-8'
           f.puts "# \xf9\x29"

data/spec/rubocop/cops/avoid_for_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe AvoidFor do
+      let(:af) { AvoidFor.new }
+
+      it 'registers an offence for for' do
+        inspect_source(af,
+                       'file.rb',
+                       ['for n in [1, 2, 3] do',
+                        'puts n',
+                        'end'])
+        expect(af.offences.size).to eq(1)
+        expect(af.offences.map(&:message))
+          .to eq([AvoidFor::ERROR_MESSAGE])
+      end
+    end
+  end
+end

data/spec/rubocop/cops/avoid_perl_backrefs_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe AvoidPerlBackrefs do
+      let(:ap) { AvoidPerlBackrefs.new }
+
+      it 'registers an offence for $1' do
+        inspect_source(ap, 'file.rb', ['puts $1'])
+        expect(ap.offences.size).to eq(1)
+        expect(ap.offences.map(&:message))
+          .to eq(['Prefer the use of MatchData over $1.'])
+      end
+    end
+  end
+end

data/spec/rubocop/cops/avoid_perlisms_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe AvoidPerlisms do
+      let(:ap) { AvoidPerlisms.new }
+
+      it 'registers an offence for $:' do
+        inspect_source(ap, 'file.rb', ['puts $:'])
+        expect(ap.offences.size).to eq(1)
+        expect(ap.offences.map(&:message))
+          .to eq(['Prefer $LOAD_PATH over $:.'])
+      end
+
+      it 'registers an offence for $"' do
+        inspect_source(ap, 'file.rb', ['puts $"'])
+        expect(ap.offences.size).to eq(1)
+        expect(ap.offences.map(&:message))
+          .to eq(['Prefer $LOADED_FEATURES over $".'])
+      end
+
+      it 'registers an offence for $0' do
+        inspect_source(ap, 'file.rb', ['puts $0'])
+        expect(ap.offences.size).to eq(1)
+        expect(ap.offences.map(&:message))
+          .to eq(['Prefer $PROGRAM_NAME over $0.'])
+      end
+    end
+  end
+end

data/spec/rubocop/cops/grammar_spec.rb

@@ -9,7 +9,7 @@ module Rubocop
       tokens = Ripper.lex(EXAMPLE).map { |t| Token.new(*t) }
       let(:grammar) { Grammar.new(tokens) }
 
-      it 'correlates token indices to grammar paths', ruby: 2.0 do
+      it 'correlates token indices to grammar paths' do
         method_block = [:program, :method_add_block]
         brace_block = method_block + [:brace_block]
         test_2_0 = [[[1, 0], :on_int, '3'],
@@ -58,13 +58,9 @@ module Rubocop
                                :string_embexpr, varref, :@ident], # z
           21 => brace_block + [:assign, :string_literal, :string_content,
                                :@tstring_content],                # }
+          24 => brace_block
         }
-        if RUBY_VERSION >= '2.0'
-          expect(grammar.correlate(sexp)).to eq(test)
-        else
-          test = (test[24] = brace_block)
-          expect(grammar.correlate(sexp)).to eq(test)
-        end
+        expect(grammar.correlate(sexp)).to eq(test)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-11 00:00:00.000000000 Z
+date: 2013-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
@@ -149,6 +149,9 @@ files:
 - lib/rubocop/cli.rb
 - lib/rubocop/cop/align_parameters.rb
 - lib/rubocop/cop/ampersands_pipes_vs_and_or.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
@@ -187,6 +190,9 @@ files:
 - 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/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
@@ -246,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1039361930821170753
+      hash: -395662942126839838
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: