rubocop 0.2.0 → 0.2.1

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing to Rubocop
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/Gemfile

@@ -6,11 +6,10 @@ source 'http://rubygems.org'
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem 'rspec', '~> 2.8.0'
-  gem 'yard', '~> 0.7'
-  gem 'redcarpet'
-  gem 'cucumber', '>= 0'
-  gem 'bundler', '~> 1.1.0'
+  gem 'rake', '~> 10.0.0'
+  gem 'rspec', '~> 2.12.0'
+  gem 'yard', '~> 0.8.0'
+  gem 'bundler', '~> 1.2.0'
   gem 'jeweler', '~> 1.8.3'
   gem 'simplecov'
 end

data/Gemfile.lock

@@ -1,51 +1,39 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    builder (3.0.0)
-    cucumber (1.1.9)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.2)
-      gherkin (~> 2.9.0)
-      json (>= 1.4.6)
-      term-ansicolor (>= 1.0.6)
     diff-lcs (1.1.3)
-    gherkin (2.9.3)
-      json (>= 1.4.6)
     git (1.2.5)
-    jeweler (1.8.3)
+    jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.6.6)
-    multi_json (1.3.2)
-    rake (0.9.2.2)
+    json (1.7.6)
+    multi_json (1.5.0)
+    rake (10.0.3)
     rdoc (3.12)
       json (~> 1.4)
-    redcarpet (2.1.1)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    simplecov (0.6.2)
-      multi_json (~> 1.3)
-      simplecov-html (~> 0.5.3)
-    simplecov-html (0.5.3)
-    term-ansicolor (1.0.7)
-    yard (0.7.5)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    yard (0.8.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.1.0)
-  cucumber
+  bundler (~> 1.2.0)
   jeweler (~> 1.8.3)
-  redcarpet
-  rspec (~> 2.8.0)
+  rake (~> 10.0.0)
+  rspec (~> 2.12.0)
   simplecov
-  yard (~> 0.7)
+  yard (~> 0.8.0)

data/README.md

@@ -18,18 +18,8 @@ Alternatively you can `rubocop` a list of files and folders to check:
 $ rubocop app spec lib/something.rb
 ```
 
-## Contributing to Rubocop
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
 ## Copyright
 
-Copyright (c) 2012 Bozhidar Batsov. See LICENSE.txt for
+Copyright (c) 2012-2013 Bozhidar Batsov. See LICENSE.txt for
 further details.
 

data/Rakefile

@@ -36,9 +36,6 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-require 'cucumber/rake/task'
-Cucumber::Rake::Task.new(:features)
-
 task :default => :spec
 
 require 'yard'

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/features/support/env.rb

@@ -5,7 +5,7 @@ begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 

data/lib/rubocop.rb

@@ -18,6 +18,10 @@ require 'rubocop/cop/numeric_literals'
 require 'rubocop/cop/align_parameters'
 require 'rubocop/cop/def_parentheses'
 require 'rubocop/cop/if_then_else'
+require 'rubocop/cop/blocks'
+require 'rubocop/cop/parameter_lists'
+require 'rubocop/cop/string_literals'
+require 'rubocop/cop/ternary_operator'
 
 require 'rubocop/report/report'
 require 'rubocop/report/plain_text'

data/lib/rubocop/cli.rb

@@ -14,12 +14,12 @@ module Rubocop
       $options = { mode: :default }
 
       OptionParser.new do |opts|
-        opts.banner = "Usage: rubocop [options] [file1, file2, ...]"
+        opts.banner = 'Usage: rubocop [options] [file1, file2, ...]'
 
-        opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+        opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
           $options[:verbose] = v
         end
-        opts.on("-e", "--emacs", "Emacs style output") do
+        opts.on('-e', '--emacs', 'Emacs style output') do
           $options[:mode] = :emacs_style
         end
       end.parse!(args)
@@ -31,18 +31,15 @@ module Rubocop
       target_files(args).each do |file|
         report = Report.create(file, $options[:mode])
         source = File.readlines(file).map do |line|
-          enc = line.encoding.name
-          # Get rid of invalid byte sequences
-          line.encode!('UTF-16', enc, invalid: :replace, replace: '')
-          line.encode!(enc, 'UTF-16')
-
+          get_rid_of_invalid_byte_sequences(line)
           line.chomp
         end
 
-        tokens, sexp = CLI.rip_source(source)
+        tokens, sexp, correlations = CLI.rip_source(source)
 
         cops.each do |cop_klass|
           cop = cop_klass.new
+          cop.correlations = correlations
           cop.inspect(file, source, tokens, sexp)
           total_offences += cop.offences.count
           report << cop if cop.has_report?
@@ -57,17 +54,26 @@ module Rubocop
       return total_offences == 0 ? 0 : 1
     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.
+      temporary_encoding = (RUBY_VERSION == '1.9.2') ? 'UTF-8' : 'UTF-16'
+      line.encode!(temporary_encoding, enc, invalid: :replace, replace: '')
+      line.encode!(enc, temporary_encoding)
+    end
+
     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)
-      [tokens, sexp]
+      correlations = Cop::Grammar.new(tokens).correlate(sexp)
+      [tokens, sexp, correlations]
     end
 
     def show_cops_on_duty(cops)
-      puts "Reporting for duty:"
+      puts 'Reporting for duty:'
       cops.each { |c| puts c }
-      puts "*******************"
+      puts '*******************'
     end
 
     # Generate a list of target files by expanding globing patterns

data/lib/rubocop/cop/align_parameters.rb

@@ -33,7 +33,7 @@ module Rubocop
       def get_args(method_add_arg)
         fcall = method_add_arg[1]
         return nil if fcall[0] != :fcall
-        return nil if fcall[1][0..1] == [:@ident, "lambda"]
+        return nil if fcall[1][0..1] == [:@ident, 'lambda']
         arg_paren = method_add_arg[2..-1][0]
         return nil if arg_paren[0] != :arg_paren || arg_paren[1].nil?
 

data/lib/rubocop/cop/blocks.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class Blocks < Cop
+      ERROR_MESSAGE = ['Avoid using {...} for multi-line blocks.',
+                       'Prefer {...} over do...end for single-line blocks.']
+
+      def inspect(file, source, tokens, sexp)
+        @file = file
+
+        # The reverse_correlations maps grammar path object ids to
+        # token indexes, so we can use it to find the corresponding }
+        # for each {.
+        reverse_correlations = Hash.new([])
+        @correlations.each do |ix, path|
+          reverse_correlations[path.object_id] += [ix]
+        end
+        tokens.each_with_index do |t, ix|
+          case [t.type, t.text]
+          when [:on_lbrace, '{']
+            path = @correlations[ix] or next
+            if path.last == :brace_block
+              rbrace_ix = reverse_correlations[path.object_id] - [ix]
+              if rbrace_ix.empty?
+                fail "\n#@file:#{t.pos.lineno}:#{t.pos.column}: " +
+                  'Matching brace not found'
+              end
+              if tokens[*rbrace_ix].pos.lineno > t.pos.lineno
+                add_offence(:convention, t.pos.lineno, ERROR_MESSAGE[0])
+              end
+            end
+          when [:on_kw, 'do']
+            end_offset = tokens[ix..-1].index { |t2| t2.text == 'end' }
+            unless end_offset
+              fail "\n#@file:#{t.pos.lineno}:#{t.pos.column}: " +
+                'Matching end not found'
+            end
+            end_token_ix = ix + end_offset
+            if tokens[end_token_ix].pos.lineno == t.pos.lineno
+              add_offence(:convention, t.pos.lineno, ERROR_MESSAGE[1])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/cop.rb

@@ -32,6 +32,7 @@ module Rubocop
 
     class Cop
       attr_accessor :offences
+      attr_writer :correlations
 
       @all = []
       @enabled = []

data/lib/rubocop/cop/def_parentheses.rb

@@ -4,7 +4,7 @@ module Rubocop
   module Cop
     class DefParentheses < Cop
       ERROR_MESSAGE = ['Use def with parentheses when there are arguments.',
-                       "Omit the parentheses in defs when the method " +
+                       'Omit the parentheses in defs when the method ' +
                        "doesn't accept any arguments."]
       EMPTY_PARAMS = [:params, nil, nil, nil, nil, nil]
 

data/lib/rubocop/cop/grammar.rb

@@ -7,10 +7,10 @@ module Rubocop
         @tokens_without_pos = tokens.map { |t| [t.type, t.text] }
         process_embedded_expressions
         @token_indexes = {}
-        @tokens_without_pos.each_with_index { |t, i|
+        @tokens_without_pos.each_with_index do |t, i|
           @token_indexes[t] ||= []
           @token_indexes[t] << i
-        }
+        end
         @ix = 0
         @table = {}
         token_positions = tokens.map { |t| [t.pos.lineno, t.pos.column] }
@@ -122,12 +122,12 @@ module Rubocop
 
       def add_matching_rbrace(ix)
         brace_depth = 0
-        rbrace_offset = @tokens_without_pos[@ix..-1].index do |t|
+        rbrace_offset = @tokens_without_pos[ix..-1].index do |t|
           brace_depth += 1 if t == [:on_lbrace, '{']
           brace_depth -= 1 if t == [:on_rbrace, '}']
           brace_depth == 0 && t == [:on_rbrace, '}']
         end
-        @table[@ix + rbrace_offset] = @table[ix] if rbrace_offset
+        @table[ix + rbrace_offset] = @table[ix] if rbrace_offset
       end
     end
   end

data/lib/rubocop/cop/parameter_lists.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class ParameterLists < Cop
+      ERROR_MESSAGE = 'Avoid parameter lists longer than four parameters.'
+
+      def inspect(file, source, tokens, sexp)
+        each(:params, sexp) do |params|
+          if params[1] && params[1].size > 4
+            add_offence(:convention, params[1][0][-1].lineno, ERROR_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/string_literals.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class StringLiterals < Cop
+      ERROR_MESSAGE = "Prefer single-quoted strings when you don't need " +
+        'string interpolation or special symbols.'
+
+      def inspect(file, source, tokens, sexp)
+        state = :outside
+        tokens.each do |t|
+          state = case [state, t.type]
+                  when [:outside, :on_tstring_beg]
+                    :double_quote if t.text == '"'
+
+                  when [:double_quote, :on_tstring_content]
+                    :valid_double_quote if t.text =~ /'|\\[ntrx]/
+
+                  when [:double_quote, :on_embexpr_beg]
+                    :embedded_expression
+
+                  when [:double_quote, :on_tstring_end]
+                    add_offence(:convention, t.pos.lineno, ERROR_MESSAGE)
+                    :outside
+
+                  when [:embedded_expression, :on_rbrace]
+                    :valid_double_quote
+
+                  when [:valid_double_quote, :on_tstring_end]
+                    :outside
+            end || state
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/surrounding_space.rb

@@ -8,7 +8,7 @@ module Rubocop
       ERROR_MESSAGE = 'Surrounding space missing for '
 
       def inspect(file, source, tokens, sexp)
-        Grammar.new(tokens).correlate(sexp).sort.each do |ix, grammar_path|
+        @correlations.sort.each do |ix, grammar_path|
           t = tokens[ix]
           case t.type
           when :on_op

data/lib/rubocop/cop/ternary_operator.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class TernaryOperator < Cop
+      ERROR_MESSAGE = 'Avoid multi-line ?: (the ternary operator); use ' +
+        'if/unless instead.'
+
+      def inspect(file, source, tokens, sexp)
+        each(:ifop, sexp) do |ifop|
+          line_numbers = all_positions(ifop).map(&:lineno)
+          if line_numbers.uniq.size > 1
+            add_offence(:convention, line_numbers[0], ERROR_MESSAGE)
+          end
+        end
+      end
+
+      def all_positions(sexp)
+        return [sexp[2]] if sexp[0] =~ /^@/
+        sexp.grep(Array).inject([]) { |memo, s| memo + all_positions(s) }
+      end
+    end
+  end
+end

data/lib/rubocop/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Rubocop
-  VERSION = "0.0.1"
+  VERSION = '0.0.1'
 end

data/rubocop.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rubocop"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bozhidar Batsov"]
-  s.date = "2013-01-02"
+  s.date = "2013-01-12"
   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"]
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
     ".rspec",
     ".rvmrc",
     ".travis.yml",
+    "CONTRIBUTING.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -36,6 +37,7 @@ Gem::Specification.new do |s|
     "lib/rubocop.rb",
     "lib/rubocop/cli.rb",
     "lib/rubocop/cop/align_parameters.rb",
+    "lib/rubocop/cop/blocks.rb",
     "lib/rubocop/cop/cop.rb",
     "lib/rubocop/cop/def_parentheses.rb",
     "lib/rubocop/cop/empty_lines.rb",
@@ -48,9 +50,12 @@ Gem::Specification.new do |s|
     "lib/rubocop/cop/line_length.rb",
     "lib/rubocop/cop/numeric_literals.rb",
     "lib/rubocop/cop/offence.rb",
+    "lib/rubocop/cop/parameter_lists.rb",
     "lib/rubocop/cop/space_after_comma_etc.rb",
+    "lib/rubocop/cop/string_literals.rb",
     "lib/rubocop/cop/surrounding_space.rb",
     "lib/rubocop/cop/tab.rb",
+    "lib/rubocop/cop/ternary_operator.rb",
     "lib/rubocop/cop/trailing_whitespace.rb",
     "lib/rubocop/report/emacs_style.rb",
     "lib/rubocop/report/plain_text.rb",
@@ -59,6 +64,7 @@ Gem::Specification.new do |s|
     "rubocop.gemspec",
     "spec/rubocop/cli_spec.rb",
     "spec/rubocop/cops/align_parameters_spec.rb",
+    "spec/rubocop/cops/blocks_spec.rb",
     "spec/rubocop/cops/cop_spec.rb",
     "spec/rubocop/cops/def_parentheses_spec.rb",
     "spec/rubocop/cops/empty_lines_spec.rb",
@@ -70,9 +76,12 @@ Gem::Specification.new do |s|
     "spec/rubocop/cops/line_length_spec.rb",
     "spec/rubocop/cops/numeric_literals_spec.rb",
     "spec/rubocop/cops/offence_spec.rb",
+    "spec/rubocop/cops/parameter_lists_spec.rb",
     "spec/rubocop/cops/space_after_comma_etc_spec.rb",
+    "spec/rubocop/cops/string_literals_spec.rb",
     "spec/rubocop/cops/surrounding_space_spec.rb",
     "spec/rubocop/cops/tab_spec.rb",
+    "spec/rubocop/cops/ternary_operator_spec.rb",
     "spec/rubocop/cops/trailing_whitespace_spec.rb",
     "spec/rubocop/reports/emacs_style_spec.rb",
     "spec/rubocop/reports/report_spec.rb",
@@ -88,28 +97,25 @@ 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<rspec>, ["~> 2.8.0"])
-      s.add_development_dependency(%q<yard>, ["~> 0.7"])
-      s.add_development_dependency(%q<redcarpet>, [">= 0"])
-      s.add_development_dependency(%q<cucumber>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      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_development_dependency(%q<simplecov>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-      s.add_dependency(%q<yard>, ["~> 0.7"])
-      s.add_dependency(%q<redcarpet>, [">= 0"])
-      s.add_dependency(%q<cucumber>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      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<simplecov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
-    s.add_dependency(%q<yard>, ["~> 0.7"])
-    s.add_dependency(%q<redcarpet>, [">= 0"])
-    s.add_dependency(%q<cucumber>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    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<simplecov>, [">= 0"])
   end

data/spec/rubocop/cli_spec.rb

@@ -71,6 +71,18 @@ module Rubocop
         cli.run
         $stdout.string.should =~ /files inspected, 0 offences detected\n/
       end
+
+      it 'can process a file with an invalide UTF-8 byte sequence' do
+        File.open('example.rb', 'w') do |f|
+          f.puts '# encoding: utf-8'
+          f.puts "# \xf9\x29"
+        end
+        begin
+          cli.run(['--emacs', 'example.rb']).should == 0
+        ensure
+          File.delete 'example.rb'
+        end
+      end
     end
   end
 end

data/spec/rubocop/cops/align_parameters_spec.rb

@@ -91,7 +91,7 @@ module Rubocop
         align.offences.map(&:message).should == []
       end
 
-      it "accepts braceless hashes" do
+      it 'accepts braceless hashes' do
         inspect_source(align, '',
                        ['run(collection, :entry_name => label,',
                         '                :paginator  => paginator)'])

data/spec/rubocop/cops/blocks_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe Blocks do
+      let (:blocks) { Blocks.new }
+
+      it 'registers an offence for a multiline block with braces' do
+        inspect_source(blocks, '', ['each { |x|',
+                                    '}'])
+        blocks.offences.map(&:message).should ==
+          ['Avoid using {...} for multi-line blocks.']
+      end
+
+      it 'registers an offence for a single line block with do-end' do
+        inspect_source(blocks, '', ['each do |x| end'])
+        blocks.offences.map(&:message).should ==
+          ['Prefer {...} over do...end for single-line blocks.']
+      end
+
+      it 'accepts a single line block with braces' do
+        inspect_source(blocks, '', ['each { |x| }'])
+        blocks.offences.map(&:message).should == []
+      end
+
+      it 'accepts a multiline block with do-end' do
+        inspect_source(blocks, '', ['each do |x|',
+                                    'end'])
+        blocks.offences.map(&:message).should == []
+      end
+    end
+  end
+end

data/spec/rubocop/cops/def_parentheses_spec.rb

@@ -21,7 +21,7 @@ module Rubocop
         inspect_source(def_par, '', src)
         def_par.offences.map(&:message).should ==
           ["Omit the parentheses in defs when the method doesn't accept any " +
-           "arguments."]
+           'arguments.']
       end
 
       it 'accepts def with arg and parens' do

data/spec/rubocop/cops/grammar_spec.rb

@@ -9,38 +9,40 @@ module Rubocop
       tokens = Ripper.lex(EXAMPLE).map { |t| Token.new(*t) }
       let (:grammar) { Grammar.new(tokens) }
 
-      it "correlates token indices to grammar paths" do
+      it 'correlates token indices to grammar paths' do
         method_block = [:program, :method_add_block]
         brace_block = method_block + [:brace_block]
         Ripper.lex(EXAMPLE).should ==
-          [[[1, 0], :on_int, "3"],
-           [[1, 1], :on_period, "."],
-           [[1, 2], :on_ident, "times"],
-           [[1, 7], :on_sp, " "],
-           [[1, 8], :on_lbrace, "{"],
-           [[1, 9], :on_sp, " "], # 5
-           [[1, 10], :on_op, "|"],
-           [[1, 11], :on_ident, "i"],
-           [[1, 12], :on_op, "|"],
-           [[1, 13], :on_sp, " "],
-           [[1, 14], :on_ident, "x"], # 10
-           [[1, 15], :on_sp, " "],
-           [[1, 16], :on_op, "="],
-           [[1, 17], :on_sp, " "],
-           [[1, 18], :on_tstring_beg, "\""],
-           [[1, 19], :on_embexpr_beg, "\#{"], # 15
-           [[1, 21], :on_ident, "y"],
-           [[1, 22], :on_rbrace, "}"],
-           [[1, 23], :on_embexpr_beg, "\#{"],
-           [[1, 25], :on_ident, "z"],
-           [[1, 26], :on_rbrace, "}"], # 20
-           [[1, 27], :on_tstring_content, "}"],
-           [[1, 28], :on_tstring_end, "\""],
-           [[1, 29], :on_sp, " "],
-           [[1, 30], :on_rbrace, "}"]]
+          [[[1, 0], :on_int, '3'],
+           [[1, 1], :on_period, '.'],
+           [[1, 2], :on_ident, 'times'],
+           [[1, 7], :on_sp, ' '],
+           [[1, 8], :on_lbrace, '{'],
+           [[1, 9], :on_sp, ' '], # 5
+           [[1, 10], :on_op, '|'],
+           [[1, 11], :on_ident, 'i'],
+           [[1, 12], :on_op, '|'],
+           [[1, 13], :on_sp, ' '],
+           [[1, 14], :on_ident, 'x'], # 10
+           [[1, 15], :on_sp, ' '],
+           [[1, 16], :on_op, '='],
+           [[1, 17], :on_sp, ' '],
+           [[1, 18], :on_tstring_beg, '"'],
+           [[1, 19], :on_embexpr_beg, '#{'], # 15
+           [[1, 21], :on_ident, 'y'],
+           [[1, 22], :on_rbrace, '}'],
+           [[1, 23], :on_embexpr_beg, '#{'],
+           [[1, 25], :on_ident, 'z'],
+           [[1, 26], :on_rbrace, '}'], # 20
+           [[1, 27], :on_tstring_content, '}'],
+           [[1, 28], :on_tstring_end, '"'],
+           [[1, 29], :on_sp, ' '],
+           [[1, 30], :on_rbrace, '}']]
 
         sexp = Ripper.sexp(EXAMPLE)
         Position.make_position_objects(sexp)
+
+        varref = (RUBY_VERSION == '1.9.2') ? :var_ref : :vcall
         grammar.correlate(sexp).should == {
           0  => method_block + [:call, :@int],                    # 3
           2  => method_block + [:call, :@ident],                  # times
@@ -51,9 +53,9 @@ module Rubocop
           10 => brace_block + [:assign, :var_field, :@ident],     # x
           12 => brace_block + [:assign],                          # =
           16 => brace_block + [:assign, :string_literal, :string_content,
-                               :string_embexpr, :vcall, :@ident], # y
+                               :string_embexpr, varref, :@ident], # y
           19 => brace_block + [:assign, :string_literal, :string_content,
-                               :string_embexpr, :vcall, :@ident], # z
+                               :string_embexpr, varref, :@ident], # z
           21 => brace_block + [:assign, :string_literal, :string_content,
                                :@tstring_content],                # }
           24 => brace_block,                                      # }

data/spec/rubocop/cops/hash_syntax_spec.rb

@@ -8,35 +8,35 @@ module Rubocop
       let (:hash_syntax) { HashSyntax.new }
 
       it 'registers an offence for hash rocket syntax when new is possible' do
-        inspect_source(hash_syntax, "", ['x = { :a => 0 }'])
+        inspect_source(hash_syntax, '', ['x = { :a => 0 }'])
         hash_syntax.offences.map(&:message).should ==
           ['Ruby 1.8 hash syntax detected']
       end
 
       it 'registers an offence for mixed syntax when new is possible' do
-        inspect_source(hash_syntax, "", ['x = { :a => 0, b: 1 }'])
+        inspect_source(hash_syntax, '', ['x = { :a => 0, b: 1 }'])
         hash_syntax.offences.map(&:message).should ==
           ['Ruby 1.8 hash syntax detected']
       end
 
       it 'registers an offence for hash rockets in method calls' do
-        inspect_source(hash_syntax, "", ['func(3, :a => 0)'])
+        inspect_source(hash_syntax, '', ['func(3, :a => 0)'])
         hash_syntax.offences.map(&:message).should ==
           ['Ruby 1.8 hash syntax detected']
       end
 
       it 'accepts hash rockets when keys have different types' do
-        inspect_source(hash_syntax, "", ['x = { :a => 0, "b" => 1 }'])
+        inspect_source(hash_syntax, '', ['x = { :a => 0, "b" => 1 }'])
         hash_syntax.offences.map(&:message).should == []
       end
 
       it 'accepts new syntax in a hash literal' do
-        inspect_source(hash_syntax, "", ['x = { a: 0, b: 1 }'])
+        inspect_source(hash_syntax, '', ['x = { a: 0, b: 1 }'])
         hash_syntax.offences.map(&:message).should == []
       end
 
       it 'accepts new syntax in method calls' do
-        inspect_source(hash_syntax, "", ['func(3, a: 0)'])
+        inspect_source(hash_syntax, '', ['func(3, a: 0)'])
         hash_syntax.offences.map(&:message).should == []
       end
     end

data/spec/rubocop/cops/if_then_else_spec.rb

@@ -14,7 +14,7 @@ module Rubocop
                                           'end',
                                           "if cond then\t",
                                           'end',
-                                          "if cond then  ",
+                                          'if cond then  ',
                                           'end',
                                           'if cond then # bad',
                                           'end'])

data/spec/rubocop/cops/numeric_literals_spec.rb

@@ -7,39 +7,39 @@ module Rubocop
     describe NumericLiterals do
       let (:num) { NumericLiterals.new }
 
-      it "registers an offence for a long integer without underscores" do
+      it 'registers an offence for a long integer without underscores' do
         inspect_source(num, 'file.rb', ['a = 123456'])
         num.offences.map(&:message).should ==
           ['Add underscores to large numeric literals to improve their ' +
            'readability.']
       end
 
-      it "registers an offence for an integer with not enough underscores" do
+      it 'registers an offence for an integer with not enough underscores' do
         inspect_source(num, 'file.rb', ['a = 123456_789000'])
         num.offences.map(&:message).should ==
           ['Add underscores to large numeric literals to improve their ' +
            'readability.']
       end
 
-      it "registers an offence for a long float without underscores" do
+      it 'registers an offence for a long float without underscores' do
         inspect_source(num, 'file.rb', ['a = 1.234567'])
         num.offences.map(&:message).should ==
           ['Add underscores to large numeric literals to improve their ' +
            'readability.']
       end
 
-      it "accepts long numbers with underscore" do
+      it 'accepts long numbers with underscore' do
         inspect_source(num, 'file.rb', ['a = 123_456',
                                        'b = 1.234_56'])
         num.offences.map(&:message).should == []
       end
 
-      it "accepts a short integer without underscore" do
+      it 'accepts a short integer without underscore' do
         inspect_source(num, 'file.rb', ['a = 123'])
         num.offences.map(&:message).should == []
       end
 
-      it "accepts short numbers without underscore" do
+      it 'accepts short numbers without underscore' do
         inspect_source(num, 'file.rb', ['a = 123',
                                        'b = 123.456'])
         num.offences.map(&:message).should == []

data/spec/rubocop/cops/parameter_lists_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe ParameterLists do
+      let (:list) { ParameterLists.new }
+
+      it 'registers an offence for a method def with 5 parameters' do
+        inspect_source(list, 'file.rb', ['def meth(a, b, c, d, e)',
+                                         'end'])
+        list.offences.map(&:message).should ==
+          ['Avoid parameter lists longer than four parameters.']
+      end
+
+      it 'accepts a method def with 4 parameters' do
+        inspect_source(list, 'file.rb', ['def meth(a, b, c, d)',
+                                         'end'])
+        list.offences.map(&:message).should == []
+      end
+    end
+  end
+end

data/spec/rubocop/cops/string_literals_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe StringLiterals do
+      let (:sl) { StringLiterals.new }
+
+      it 'registers an offence for double quotes when single quotes suffice' do
+        inspect_source(sl, 'file.rb', ['s = "abc"'])
+        sl.offences.map(&:message).should ==
+          ["Prefer single-quoted strings when you don't need string " +
+           'interpolation or special symbols.']
+      end
+
+      it 'accepts double quotes when they are needed' do
+        src = ['a = "\n"',
+               'b = "#{encode_severity}:#{sprintf("%3d", line_number)}: #{m}"',
+               'c = "\'"']
+        inspect_source(sl, 'file.rb', src)
+        sl.offences.map(&:message).should == []
+      end
+
+      it 'can handle double quotes within embedded expression' do
+        src = ['"#{"A"}"']
+        inspect_source(sl, 'file.rb', src)
+        sl.offences.map(&:message).should == []
+      end
+    end
+  end
+end

data/spec/rubocop/cops/surrounding_space_spec.rb

@@ -161,7 +161,7 @@ module Rubocop
       it 'registers an offences for exponent operator with spaces' do
         inspect_source(space, 'file.rb', ['x = a * b ** 2'])
         space.offences.map(&:message).should ==
-          ["Space around operator ** detected."]
+          ['Space around operator ** detected.']
       end
 
       it 'accepts exponent operator without spaces' do

data/spec/rubocop/cops/ternary_operator_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe TernaryOperator do
+      let (:num) { TernaryOperator.new }
+
+      it 'registers an offence for a multiline ternary operator expression' do
+        inspect_source(num, 'file.rb', ['a = cond ?',
+                                        '  b : c'])
+        num.offences.map(&:message).should ==
+          ['Avoid multi-line ?: (the ternary operator); use if/unless ' +
+           'instead.']
+      end
+
+      it 'accepts a single line ternary operator expression' do
+        inspect_source(num, 'file.rb', ['a = cond ? b : c'])
+        num.offences.map(&:message).should == []
+      end
+    end
+  end
+end

data/spec/rubocop/reports/emacs_style_spec.rb

@@ -17,7 +17,7 @@ module Rubocop
 
         s = StringIO.new
         emacs_style.display(s)
-        s.string.should == ["test:1: C: message 1",
+        s.string.should == ['test:1: C: message 1',
                             "test:11: F: message 2\n"].join("\n")
       end
     end

data/spec/spec_helper.rb

@@ -23,7 +23,7 @@ module ExitCodeMatchers
     end
     failure_message_for_should do |block|
       "expected block to call exit(#{code}) but exit" +
-        (actual.nil? ? " not called" : "(#{actual}) was called")
+        (actual.nil? ? ' not called' : "(#{actual}) was called")
     end
     failure_message_for_should_not do |block|
       "expected block not to call exit(#{code})"
@@ -39,6 +39,7 @@ RSpec.configure do |config|
 end
 
 def inspect_source(cop, file, source)
-  tokens, sexp = Rubocop::CLI.rip_source(source)
+  tokens, sexp, correlations = Rubocop::CLI.rip_source(source)
+  cop.correlations = correlations
   cop.inspect(file, source, tokens, sexp)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-02 00:00:00.000000000 Z
+date: 2013-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 10.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,15 +26,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 10.0.0
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,39 +42,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: cucumber
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -138,6 +122,7 @@ files:
 - .rspec
 - .rvmrc
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -151,6 +136,7 @@ files:
 - lib/rubocop.rb
 - lib/rubocop/cli.rb
 - lib/rubocop/cop/align_parameters.rb
+- lib/rubocop/cop/blocks.rb
 - lib/rubocop/cop/cop.rb
 - lib/rubocop/cop/def_parentheses.rb
 - lib/rubocop/cop/empty_lines.rb
@@ -163,9 +149,12 @@ files:
 - lib/rubocop/cop/line_length.rb
 - lib/rubocop/cop/numeric_literals.rb
 - lib/rubocop/cop/offence.rb
+- lib/rubocop/cop/parameter_lists.rb
 - lib/rubocop/cop/space_after_comma_etc.rb
+- lib/rubocop/cop/string_literals.rb
 - lib/rubocop/cop/surrounding_space.rb
 - lib/rubocop/cop/tab.rb
+- lib/rubocop/cop/ternary_operator.rb
 - lib/rubocop/cop/trailing_whitespace.rb
 - lib/rubocop/report/emacs_style.rb
 - lib/rubocop/report/plain_text.rb
@@ -174,6 +163,7 @@ files:
 - rubocop.gemspec
 - spec/rubocop/cli_spec.rb
 - spec/rubocop/cops/align_parameters_spec.rb
+- spec/rubocop/cops/blocks_spec.rb
 - spec/rubocop/cops/cop_spec.rb
 - spec/rubocop/cops/def_parentheses_spec.rb
 - spec/rubocop/cops/empty_lines_spec.rb
@@ -185,9 +175,12 @@ files:
 - spec/rubocop/cops/line_length_spec.rb
 - spec/rubocop/cops/numeric_literals_spec.rb
 - spec/rubocop/cops/offence_spec.rb
+- spec/rubocop/cops/parameter_lists_spec.rb
 - spec/rubocop/cops/space_after_comma_etc_spec.rb
+- spec/rubocop/cops/string_literals_spec.rb
 - spec/rubocop/cops/surrounding_space_spec.rb
 - spec/rubocop/cops/tab_spec.rb
+- spec/rubocop/cops/ternary_operator_spec.rb
 - spec/rubocop/cops/trailing_whitespace_spec.rb
 - spec/rubocop/reports/emacs_style_spec.rb
 - spec/rubocop/reports/report_spec.rb
@@ -207,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2416637958385031259
+      hash: 3978981872359853745
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: