rubocop 0.4.0 → 0.8.0

data/lib/rubocop/cop/ternary_operator.rb

@@ -2,39 +2,41 @@
 
 module Rubocop
   module Cop
-    module TernaryOperator
-      def inspect(file, source, tokens, sexp)
-        each(:ifop, sexp) do |ifop|
-          if offends?(ifop)
-            add_offence(:convention, all_positions(ifop).first.lineno,
-                        error_message)
-          end
-        end
-      end
-    end
-
     class MultilineTernaryOperator < Cop
-      include TernaryOperator
-
-      def error_message
+      MSG =
         'Avoid multi-line ?: (the ternary operator); use if/unless instead.'
-      end
 
-      def offends?(ifop)
-        all_positions(ifop).map(&:lineno).uniq.size > 1
+      def on_if(node)
+        loc = node.loc
+
+        # discard non-ternary ops
+        return unless loc.respond_to?(:question)
+
+        add_offence(:convention, loc.line, MSG) if loc.line != loc.colon.line
+
+        super
       end
     end
 
     class NestedTernaryOperator < Cop
-      include TernaryOperator
+      MSG = 'Ternary operators must not be nested. Prefer if/else ' +
+          'constructs instead.'
 
-      def error_message
-        'Ternary operators must not be nested. Prefer if/else constructs ' +
-          'instead.'
-      end
+      def on_if(node)
+        loc = node.loc
+
+        # discard non-ternary ops
+        return unless loc.respond_to?(:question)
+
+        node.children.each do |child|
+          on_node(:if, child) do |c|
+            if c.loc.respond_to?(:question)
+              add_offence(:convention, c.loc.line, MSG)
+            end
+          end
+        end
 
-      def offends?(ifop)
-        ifop.flatten[1..-1].include?(:ifop)
+        super
       end
     end
   end

data/lib/rubocop/cop/trailing_whitespace.rb

@@ -3,13 +3,11 @@
 module Rubocop
   module Cop
     class TrailingWhitespace < Cop
-      ERROR_MESSAGE = 'Trailing whitespace detected.'
+      MSG = 'Trailing whitespace detected.'
 
-      def inspect(file, source, tokens, sexp)
+      def inspect(source, tokens, ast, comments)
         source.each_with_index do |line, index|
-          if line =~ /.*[ \t]+$/
-            add_offence(:convention, index + 1, ERROR_MESSAGE)
-          end
+          add_offence(:convention, index + 1, MSG) if line =~ /.*[ \t]+$/
         end
       end
     end

data/lib/rubocop/cop/trivial_accessors.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class TrivialAccessors < Cop
+      MSG = 'Use attr_%s to define trivial %s methods.'
+
+      def on_def(node)
+        _, args, body = *node
+
+        kind = if body.type == :ivar
+                 'reader'
+               elsif args.children.size == 1 && body.type == :ivasgn &&
+                   body.children[1].type == :lvar
+                 'writer'
+               end
+        if kind
+          add_offence(:convention, node.loc.keyword.line,
+                      sprintf(MSG, kind, kind))
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/rubocop/cop/unless_else.rb

@@ -3,16 +3,20 @@
 module Rubocop
   module Cop
     class UnlessElse < Cop
-      ERROR_MESSAGE = 'Never use unless with else. Rewrite these with the ' +
+      MSG = 'Never use unless with else. Rewrite these with the ' +
         'positive case first.'
 
-      def inspect(file, source, tokens, sexp)
-        each(:unless, sexp) do |unless_sexp|
-          if unless_sexp.compact.find { |s| s[0] == :else }
-            add_offence(:convention, all_positions(unless_sexp).first.lineno,
-                        ERROR_MESSAGE)
-          end
+      def on_if(node)
+        loc = node.loc
+
+        # discard ternary ops and modifier if/unless nodes
+        return unless loc.respond_to?(:keyword) && loc.respond_to?(:else)
+
+        if loc.keyword.source == 'unless' && loc.else
+          add_offence(:convention, loc.line, MSG)
         end
+
+        super
       end
     end
   end

data/lib/rubocop/cop/util.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    module Util
+      module_function
+
+      def strip_quotes(str)
+        if str[0] == '"' || str[0] == "'"
+          str[0] = ''
+          str[-1] = ''
+        else
+          # we're dealing with %q or %Q
+          str[0, 3] = ''
+          str[-1] = ''
+        end
+
+        str
+      end
+
+      def block_length(block_node)
+        block_node.loc.end.line - block_node.loc.begin.line
+      end
+    end
+  end
+end

data/lib/rubocop/cop/variable_interpolation.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class VariableInterpolation < Cop
+      MSG = 'Replace interpolated var %s with expression #{%s}.'
+
+      def on_dstr(node)
+        var_nodes(node.children).each do |v|
+          var = (v.type == :nth_ref ? '$' : '') + v.to_a[0].to_s
+
+          if node.loc.expression.source.include?("##{var}")
+            add_offence(:convention,
+                        v.loc.line,
+                        sprintf(MSG, var, var))
+          end
+        end
+
+        super
+      end
+
+      private
+
+      def var_nodes(nodes)
+        nodes.select { |n| [:ivar, :cvar, :gvar, :nth_ref].include?(n.type) }
+      end
+    end
+  end
+end

data/lib/rubocop/cop/when_then.rb

@@ -3,22 +3,14 @@
 module Rubocop
   module Cop
     class WhenThen < Cop
-      ERROR_MESSAGE = 'Never use "when x;". Use "when x then" instead.'
+      MSG = 'Never use "when x;". Use "when x then" instead.'
 
-      def inspect(file, source, tokens, sexp)
-        each(:when, sexp) do |s|
-          # The grammar is:
-          # when <value> <divider> <body>
-          # where divider is either semicolon, then, or line break.
-          last_pos_in_value = all_positions(s[1])[-1]
-          start_index = tokens.index { |t| t.pos == last_pos_in_value }
-          tokens[start_index..-1].each do |t|
-            break if ['then', "\n"].include?(t.text)
-            if t.type == :on_semicolon
-              add_offence(:convention, t.pos.lineno, ERROR_MESSAGE)
-            end
-          end
+      def on_when(node)
+        if node.loc.begin && node.loc.begin.source == ';'
+          add_offence(:convention, node.loc.line, MSG)
         end
+
+        super
       end
     end
   end

data/lib/rubocop/cop/word_array.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+module Rubocop
+  module Cop
+    class WordArray < Cop
+      MSG = 'Use %w or %W for array of words.'
+
+      def on_array(node)
+        return unless node.loc.begin && node.loc.begin.source == '['
+
+        array_elems = node.children
+
+        # no need to check empty arrays
+        return unless array_elems && array_elems.size > 1
+
+        string_array = array_elems.all? { |e| e.type == :str }
+
+        if string_array && !complex_content?(array_elems)
+          add_offence(:convention, node.loc.line, MSG)
+        end
+
+        super
+      end
+
+      private
+
+      def complex_content?(arr_sexp)
+        arr_sexp.each do |s|
+          str_content = Util.strip_quotes(s.loc.expression.source)
+          return true unless str_content =~ /\A[\w-]+\z/
+        end
+
+        false
+      end
+    end
+  end
+end

data/lib/rubocop/report/emacs_style.rb

@@ -7,8 +7,8 @@ module Rubocop
       # Generates a string representation of the report
       def generate
         report = entries.map do |e|
-          '%s:%d: %s: %s' % [@filename, e.line_number, e.encode_severity,
-                             e.message]
+          sprintf('%s:%d: %s: %s', @filename,
+                  e.line_number, e.encode_severity, e.message)
         end
         report.join("\n")
       end

data/lib/rubocop/report/plain_text.rb

@@ -6,7 +6,7 @@ module Rubocop
     class PlainText < Report
       # Generates a string representation of the report
       def generate
-        report = "== #{filename} ==\n".yellow
+        report = "== #{filename} ==\n".color(:yellow)
         report << entries.join("\n")
       end
 

data/lib/rubocop/version.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
 module Rubocop
-  VERSION = '0.3.2'
+  module Version
+    STRING = '0.8.0'
+  end
 end

data/lib/rubocop.rb

@@ -1,23 +1,25 @@
 # encoding: utf-8
 
-require 'ripper'
-require 'term/ansicolor'
-
-class String
-  include Term::ANSIColor
-end
+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'
 require 'rubocop/cop/line_length'
+require 'rubocop/cop/line_continuation'
 require 'rubocop/cop/syntax'
 require 'rubocop/cop/tab'
 require 'rubocop/cop/trailing_whitespace'
-require 'rubocop/cop/indentation'
+require 'rubocop/cop/case_indentation'
+require 'rubocop/cop/empty_line_between_defs'
 require 'rubocop/cop/empty_lines'
 require 'rubocop/cop/surrounding_space'
 require 'rubocop/cop/space_after_comma_etc'
+require 'rubocop/cop/space_after_control_keyword'
 require 'rubocop/cop/hash_syntax'
 require 'rubocop/cop/end_of_line'
 require 'rubocop/cop/numeric_literals'
@@ -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'
@@ -38,10 +40,48 @@ 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/cop/avoid_global_vars'
+require 'rubocop/cop/avoid_class_vars'
+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/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/empty_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/cop/class_methods'
+require 'rubocop/cop/single_line_methods'
+require 'rubocop/cop/word_array'
+require 'rubocop/cop/symbol_array'
+require 'rubocop/cop/trivial_accessors'
+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'
 require 'rubocop/report/emacs_style'
 
+require 'rubocop/config'
+require 'rubocop/config_store'
 require 'rubocop/cli'
 require 'rubocop/version'

data/rubocop.gemspec

@@ -1,156 +1,37 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
-Gem::Specification.new do |s|
-  s.name = "rubocop"
-  s.version = "0.4.0"
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'rubocop/version'
+require 'English'
 
-  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.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",
-    "CONTRIBUTING.md",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "bin/rubocop",
-    "lib/rubocop.rb",
-    "lib/rubocop/cli.rb",
-    "lib/rubocop/cop/align_parameters.rb",
-    "lib/rubocop/cop/ampersands_pipes_vs_and_or.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_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/space_after_comma_etc.rb",
-    "lib/rubocop/cop/string_literals.rb",
-    "lib/rubocop/cop/surrounding_space.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/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/align_parameters_spec.rb",
-    "spec/rubocop/cops/ampersands_pipes_vs_and_or_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_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/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/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/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."
+Gem::Specification.new do |s|
+  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 = <<-EOF
+    Automatic Ruby code style checking tool.
+    Aims to enforce the community-driven Ruby Style Guide.
+  EOF
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.email = 'bozhidar@batsov.com'
+  s.files = `git ls-files`.split($RS)
+  s.test_files = s.files.grep(/^spec\//)
+  s.executables = s.files.grep(/^bin\//) { |f| File.basename(f) }
+  s.extra_rdoc_files = ['LICENSE.txt', 'README.md']
+  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 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('rainbow', '>= 1.1.4')
+  s.add_runtime_dependency('parser', '~> 2.0.0.beta2')
+  s.add_development_dependency('rake', '~> 10.0')
+  s.add_development_dependency('rspec', '~> 2.13')
+  s.add_development_dependency('yard', '~> 0.8')
+  s.add_development_dependency('bundler', '~> 1.3')
+  s.add_development_dependency('simplecov', '~> 0.7')
 end
-

data/spec/project_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'RuboCop Project' do
+  describe '.rubocop.yml' do
+    it 'has configuration for all cops' do
+      cop_names = Rubocop::Cop::Cop.all.map(&:cop_name)
+      expect(Rubocop::Config.load_file('.rubocop.yml').keys.sort)
+        .to eq((['AllCops'] + cop_names).sort)
+    end
+  end
+
+  describe 'source codes', broken: true do
+    before { $stdout = StringIO.new }
+    after  { $stdout = STDOUT }
+
+    it 'has no violations' do
+      # Need to pass an empty array explicitly
+      # so that the CLI does not refer arguments of `rspec`
+      Rubocop::CLI.new.run([])
+      expect($stdout.string).to match(
+        /files inspected, no offences detected\n/
+      )
+    end
+  end
+end