ruby-lint 0.0.4 → 0.0.5

data/ruby-lint.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/ruby-lint/version', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'ruby-lint'
   s.version     = RubyLint::VERSION
-  s.date        = '2013-04-22'
+  s.date        = Time.now.strftime('%Y-%m-%d')
   s.authors     = ['Yorick Peterse']
   s.email       = 'yorickpeterse@gmail.com'
   s.summary     = 'A linter and static code analysis tool for Ruby.'
@@ -29,17 +29,17 @@ using the handle "yorickpeterse".
   s.has_rdoc              = 'yard'
   s.required_ruby_version = '>= 1.9.3'
 
-  s.add_dependency 'parser', ['>= 2.0.0.pre2']
+  s.add_dependency 'parser', ['>= 2.0.0.pre6']
   s.add_dependency 'slop'
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'bacon', ['>= 1.2.0']
+  s.add_development_dependency 'rspec', ['>= 2.14']
   s.add_development_dependency 'yard'
   s.add_development_dependency 'pry-rescue'
-  s.add_development_dependency 'bacon-colored_output'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'rubygems-openpgp'
   s.add_development_dependency 'coveralls'
   s.add_development_dependency 'json'
   s.add_development_dependency 'kramdown'
+  s.add_development_dependency 'redcard'
 end

data/ruby-lint.yml

@@ -0,0 +1,7 @@
+---
+directories:
+  - lib
+
+ignore_paths:
+  - lib/ruby-lint/definitions
+  - lib/ruby-lint/cli

data/spec/fixtures/associating.rb

@@ -0,0 +1,7 @@
+module RubyLint
+  class GlobalScope
+    def self.constant_proxy(name)
+      return Definition::ConstantProxy.new(definitions, name)
+    end
+  end
+end

data/spec/fixtures/file_scanner/lib/example/recursive/source.rb

@@ -0,0 +1,6 @@
+module Example
+  module Recursive
+    class Source < Target
+    end # Source
+  end # Recursive
+end # Example

data/spec/fixtures/file_scanner/lib/example/recursive/target.rb

@@ -0,0 +1,8 @@
+module Example
+  module Recursive
+    class Target
+      def example_method
+      end
+    end # Target
+  end # Recursive
+end # Example

data/spec/fixtures/file_scanner/lib/example/user.rb

@@ -0,0 +1,6 @@
+module Example
+  class User
+    def example_method
+    end
+  end
+end

data/spec/fixtures/file_scanner/lib/test-dashes/foo.rb

@@ -0,0 +1,4 @@
+module TestDashes
+  module Foo
+  end # Foo
+end # TestDashes

data/spec/fixtures/file_scanner/rails/app/models/example/user.rb

@@ -0,0 +1,6 @@
+module Example
+  class User
+    def example_method
+    end
+  end
+end

data/spec/fixtures/file_scanner/rails/app/models/user.rb

@@ -0,0 +1,4 @@
+class User
+  def example_method
+  end
+end

data/spec/fixtures/uses_external.rb

@@ -0,0 +1 @@
+User.new

data/spec/fixtures/uses_external_invalid.rb

@@ -0,0 +1,3 @@
+user = User.new
+
+user.foobar

data/spec/fixtures/uses_external_namespace.rb

@@ -0,0 +1 @@
+Example::User.new

data/spec/ruby-lint/analysis/{argument_amount.rb → argument_amount_spec.rb}

@@ -1,7 +1,7 @@
-require File.expand_path('../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::Analysis::ArgumentAmount do
-  should 'validate the amount of required arguments' do
+  example 'validate the amount of required arguments' do
     code = <<-CODE
 def example(first, second)
 end
@@ -19,7 +19,7 @@ example
     entry.message.should == 'wrong number of arguments (expected 2 but got 0)'
   end
 
-  should 'validate argument amounts when using optional arguments' do
+  example 'validate argument amounts when using optional arguments' do
     code = <<-CODE
 def example(first, second, third = nil)
 end
@@ -38,7 +38,7 @@ example
       '(expected 2..3 but got 0)'
   end
 
-  should 'validate argument amounts when using rest arguments' do
+  example 'validate argument amounts when using rest arguments' do
     code = <<-CODE
 def example(first, second, *args)
 end
@@ -57,7 +57,7 @@ example
       '(expected 2 but got 0)'
   end
 
-  should 'validate argument amounts when using a required and rest argument' do
+  example 'validate argument amounts when using a required and rest argument' do
     code = <<-CODE
 def example(required, *numbers)
 end
@@ -70,7 +70,7 @@ example(10, 20, 30)
     report.entries.length.should == 0
   end
 
-  should 'take variable assignments into account' do
+  example 'take variable assignments into account' do
     code = <<-CODE
 name = 'Ruby'
 
@@ -82,10 +82,36 @@ name.downcase
     report.entries.empty?.should == true
   end
 
-  should 'not validate methods called on undefined receivers' do
+  example 'not validate methods called on undefined receivers' do
     code   = 'A.example_method'
     report = build_report(code, RubyLint::Analysis::ArgumentAmount)
 
     report.entries.empty?.should == true
   end
+
+  example 'use #initialize for arguments when processing .new' do
+    code = <<-CODE
+class Person
+  def initialize(name)
+  end
+end
+
+Person.new
+Person.new(10, 20)
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::ArgumentAmount)
+
+    report.entries.length.should == 2
+
+    first, second = report.entries
+
+    first.line.should    == 6
+    first.column.should  == 0
+    first.message.should == 'wrong number of arguments (expected 1 but got 0)'
+
+    second.line.should    == 7
+    second.column.should  == 0
+    second.message.should == 'wrong number of arguments (expected 1 but got 2)'
+  end
 end

data/spec/ruby-lint/analysis/base_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe RubyLint::Analysis::Base do
+  example 'require a VM' do
+    lambda { RubyLint::Analysis::Base.new }.should raise_error(ArgumentError)
+
+    vm  = RubyLint::VirtualMachine.new
+    blk = lambda { RubyLint::Analysis::Base.new(:vm => vm) }
+
+    blk.should_not raise_error
+  end
+end

data/spec/ruby-lint/analysis/{pedantics.rb → pedantics_spec.rb}

@@ -1,7 +1,7 @@
-require File.expand_path('../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::Analysis::Pedantics do
-  should 'warn when using do/then in various statements' do
+  example 'warn when using do/then in various statements' do
     code = <<-CODE
 if true then; end
 unless true then; end
@@ -23,7 +23,27 @@ while true do; end
     entries[2].message.should == 'the use of then/do is not needed here'
   end
 
-  should 'warn for the use of BEGIN/END' do
+  # See https://github.com/YorickPeterse/ruby-lint/issues/32 for the motivation
+  # behind this test.
+  example 'not warn when no do/then identifier is used in a statement' do
+    code = <<-CODE.strip
+if true; end
+
+if foo && bar
+  true
+else
+  false
+end
+
+foo ? true : false
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::Pedantics)
+
+    report.entries.empty?.should == true
+  end
+
+  example 'warn for the use of BEGIN/END' do
     code = <<-CODE
 BEGIN {}
 END {}
@@ -40,4 +60,4 @@ END {}
     entries[1].line.should    == 2
     entries[1].message.should == 'BEGIN/END is useless'
   end
-end
+end

data/spec/ruby-lint/analysis/{shadowing_variables.rb → shadowing_variables_spec.rb}

@@ -1,7 +1,7 @@
-require File.expand_path('../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::Analysis::ShadowingVariables do
-  should 'warn for shadowing outer variables' do
+  example 'warn for shadowing outer variables' do
     code = <<-CODE
 number = 10
 
@@ -20,7 +20,7 @@ end
     entry.message.should == 'shadowing outer local variable number'
   end
 
-  should 'not warn for shadowed variables in a new scope' do
+  example 'not warn for shadowed variables in a new scope' do
     code = <<-CODE
 number = 10
 
@@ -36,7 +36,7 @@ end
     report.entries.empty?.should == true
   end
 
-  should 'warn when shadowing variables after a new scope' do
+  example 'warn when shadowing variables after a new scope' do
     code = <<-CODE
 number = 10
 
@@ -57,7 +57,7 @@ end
     entry.message.should == 'shadowing outer local variable number'
   end
 
-  should 'not fail when re-using the same block' do
+  example 'not fail when re-using the same block' do
     code = <<-CODE
 number = 10
 
@@ -82,4 +82,4 @@ end
     second.line.should    == 7
     second.column.should  == 17
   end
-end
+end

data/spec/ruby-lint/analysis/undefined_methods_spec.rb

@@ -0,0 +1,320 @@
+require 'spec_helper'
+
+describe RubyLint::Analysis::UndefinedMethods do
+  example 'add an error for calling an undefined method' do
+    report = build_report('example_method', RubyLint::Analysis::UndefinedMethods)
+    entry  = report.entries[0]
+
+    entry.is_a?(RubyLint::Report::Entry).should == true
+
+    entry.line.should    == 1
+    entry.column.should  == 0
+    entry.message.should == 'undefined method example_method'
+  end
+
+  example 'add an error for calling an undefined method with a receiver' do
+    code = <<-CODE
+class << self
+  def example_method
+  end
+end
+
+String.example_method
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+    entry  = report.entries[0]
+
+    entry.is_a?(RubyLint::Report::Entry).should == true
+
+    entry.line.should    == 6
+    entry.column.should  == 0
+    entry.message.should == 'undefined method example_method on String'
+  end
+
+  example 'add an error for calling an undefined method on a receiver instance' do
+    code   = '"hello".example_method'
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+    entry  = report.entries[0]
+
+    entry.is_a?(RubyLint::Report::Entry).should == true
+
+    entry.line.should    == 1
+    entry.column.should  == 0
+    entry.message.should == 'undefined method example_method ' \
+      'on an instance of String'
+  end
+
+  example 'add an error when calling a method defined in a different scope' do
+    code = <<-CODE
+class Person
+  def name
+    return 'name'
+  end
+
+  def greet
+    name
+  end
+end
+
+name
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+    report.entries.length.should == 1
+
+    entry = report.entries[0]
+
+    entry.is_a?(RubyLint::Report::Entry).should == true
+
+    entry.line.should    == 11
+    entry.column.should  == 0
+    entry.message.should == 'undefined method name'
+  end
+
+  describe 'core Ruby types' do
+    example 'do not add errors for calling defined methods on a Fixnum' do
+      report = build_report('10.to_s', RubyLint::Analysis::UndefinedMethods)
+
+      report.entries.empty?.should == true
+    end
+
+    example 'do not add errors for calling defined methods on a Float' do
+      report = build_report('(10.0).to_s', RubyLint::Analysis::UndefinedMethods)
+
+      report.entries.empty?.should == true
+    end
+
+    example 'do not add errors for calling defined methods on a String' do
+      report = build_report('"10".to_s', RubyLint::Analysis::UndefinedMethods)
+
+      report.entries.empty?.should == true
+    end
+
+    example 'do not add errors for calling defined methods on a Hash' do
+      report = build_report('{}.to_s', RubyLint::Analysis::UndefinedMethods)
+
+      report.entries.empty?.should == true
+    end
+
+    example 'do not add errors for calling defined methods on an Array' do
+      report = build_report('[].to_s', RubyLint::Analysis::UndefinedMethods)
+
+      report.entries.empty?.should == true
+    end
+  end
+
+  example 'do not add errors for variables created using blocks' do
+    code = <<-CODE
+[10, 20].each do |number|
+  number.to_s
+end
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+    report.entries.empty?.should == true
+  end
+
+  example 'take variable assignments into account' do
+    code = <<-CODE
+name = 'Ruby'
+
+name.downcase
+name.downcasex
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+    report.entries.length.should == 1
+
+    entry = report.entries[0]
+
+    entry.line.should    == 4
+    entry.column.should  == 0
+    entry.message.should == 'undefined method downcasex on an instance of String'
+  end
+
+  example 'take variable assignments and custom classes into account' do
+    code = <<-CODE
+class User
+  def example
+  end
+end
+
+user = User.new
+
+user.example
+user.invalid
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+    report.entries.length.should == 1
+
+    entry = report.entries[0]
+
+    entry.line.should    == 9
+    entry.column.should  == 0
+    entry.message.should == 'undefined method invalid on an instance of User'
+  end
+
+  example 'do not add errors when calling a method on an undefined constant' do
+    code = 'A.example_method'
+
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+    report.entries.empty?.should == true
+  end
+
+  example 'do not add errors for methods called on variables without values' do
+    code = <<-CODE
+def example(number)
+  number.to_s
+end
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+    report.entries.empty?.should == true
+  end
+
+  example 'report the right receiver name in multiple variable assignments' do
+    code = <<-CODE
+number = 10
+
+first = second = number.foobar
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+    report.entries.length.should == 1
+
+    entry = report.entries[0]
+
+    entry.message.should == 'undefined method foobar on an instance of Fixnum'
+  end
+
+  example 'ignore methods calls on other non existing methods' do
+    code   = 'foo.bar'
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+    report.entries.length.should == 1
+
+    report.entries[0].message.should == 'undefined method foo'
+  end
+
+  example 'ignore methods calls with arguments on other non existing methods' do
+    code   = 'foo.bar(:baz)'
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+    report.entries.length.should == 1
+
+    report.entries[0].message.should == 'undefined method foo'
+  end
+
+  context 'Kernel methods' do
+    example 'do not add errors for methods defined in Kernel' do
+      code   = 'puts "hello"'
+      report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+      report.entries.empty?.should == true
+    end
+
+    example 'do not add errors for Kernel methods in an sclass in a module' do
+      code = <<-CODE
+module Foo
+  def self.foo
+  end
+
+  class << self
+    alias_method :foo, :bar
+  end
+end
+      CODE
+
+      report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+      report.entries.empty?.should == true
+    end
+  end
+
+  context 'core Ruby methods' do
+    example 'do not add errors for #include' do
+      code = <<-CODE
+module Foo
+end
+
+class Bar
+  include Foo
+end
+      CODE
+
+      report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+      report.entries.empty?.should == true
+    end
+
+    example 'do not add errors for #attr_reader' do
+      code = <<-CODE
+class Bar
+  attr_reader :foobar
+end
+      CODE
+
+      report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+      report.entries.empty?.should == true
+    end
+  end
+
+  example 'properly handle method lookups in blocks' do
+    code = <<-CODE
+class Foo
+  def baz
+  end
+
+  [10, 20].each do
+    define_method(:example) do
+      baz
+    end
+  end
+end
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+    report.entries.empty?.should == true
+  end
+
+  example 'do not add errors for private/protected/public' do
+    code = <<-CODE
+private
+protected
+public
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+
+    report.entries.empty?.should == true
+  end
+
+  example 'use the correct error message for YARD documented arguments' do
+    code = <<-CODE
+##
+# @param [Fixnum|Bignum|Numeric] number
+#
+def double(number)
+  return number.to_foo
+end
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::UndefinedMethods)
+    entry  = report.entries[0]
+
+    entry.line.should    == 5
+    entry.message.should == 'undefined method to_foo on an instance of ' \
+      'Fixnum, Bignum or Numeric'
+  end
+end