ruby-lint 0.0.4 → 0.0.5

data/spec/ruby-lint/virtual_machine/classes/{sclass.rb → sclass_spec.rb}

@@ -1,8 +1,8 @@
-require File.expand_path('../../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::VirtualMachine do
   describe 'using sclass blocks' do
-    should 'define a class method using `class << self`' do
+    example 'define a class method using `class << self`' do
       code = <<-CODE
 class First
   class << self
@@ -20,7 +20,7 @@ end
         .should == true
     end
 
-    should 'define a class method using `class << self` in the global scope' do
+    example 'define a class method using `class << self` in the global scope' do
       code = <<-CODE
 class << self
   def example
@@ -33,7 +33,7 @@ end
       defs.lookup(:method, 'example').is_a?(ruby_method).should == true
     end
 
-    should 'define a class method using `class << String`' do
+    example 'define a class method using `class << String`' do
       code = <<-CODE
 class << String
   def example
@@ -49,7 +49,7 @@ end
         .should == true
     end
 
-    should 'define a class method using `class << String` nested in a class' do
+    example 'define a class method using `class << String` nested in a class' do
       code = <<-CODE
 class First
   class << String
@@ -72,7 +72,7 @@ end
         .should == true
     end
 
-    should 'define an instance method using `class << variable`' do
+    example 'define an instance method using `class << variable`' do
       code = <<-CODE
 variable = "foo"
 
@@ -91,4 +91,4 @@ end
         .should == true
     end
   end
-end
+end

data/spec/ruby-lint/virtual_machine/classes/{scoping.rb → scoping_spec.rb}

@@ -1,8 +1,8 @@
-require File.expand_path('../../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::VirtualMachine do
   describe 'scoping class definitions' do
-    should 'process a global class' do
+    example 'process a global class' do
       defs    = build_definitions('class Example; end')
       example = defs.lookup(:const, 'Example')
 
@@ -12,7 +12,7 @@ describe RubyLint::VirtualMachine do
       example.name.should == 'Example'
     end
 
-    should 'process a nested class' do
+    example 'process a nested class' do
       code = <<-CODE
 class First
   class Second
@@ -32,7 +32,7 @@ end
         .should == true
     end
 
-    should 'process a global and nested class' do
+    example 'process a global and nested class' do
       code = <<-CODE
 class First
   class Second
@@ -57,4 +57,4 @@ end
       defs.lookup(:const, 'Third').is_a?(ruby_object).should == true
     end
   end
-end
+end

data/spec/ruby-lint/virtual_machine/complex/{rails.rb → rails_spec.rb}

@@ -1,8 +1,8 @@
-require File.expand_path('../../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::VirtualMachine do
   describe 'rails' do
-    should 'process a basic Rails controller' do
+    example 'process a basic Rails controller' do
       code = fixture('complex/rails/basic_controller.rb')
       defs = build_definitions(code)
 
@@ -15,4 +15,4 @@ describe RubyLint::VirtualMachine do
         .should == true
     end
   end
-end
+end

data/spec/ruby-lint/virtual_machine/complex/{rcap.rb → rcap_spec.rb}

@@ -1,9 +1,9 @@
-require File.expand_path('../../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::VirtualMachine do
   # https://github.com/farrel/RCAP/blob/master/lib/rcap/cap_1_2/alert.rb
   describe 'rcap' do
-    should 'process the Alert class' do
+    example 'process the Alert class' do
       code  = fixture('complex/rcap.rb')
       defs  = build_definitions(code)
       const = defs.lookup_constant_path('RCAP::CAP_1_2::Alert')
@@ -12,4 +12,4 @@ describe RubyLint::VirtualMachine do
       const.has_definition?(:instance_method, 'xmlns').should == true
     end
   end
-end
+end

data/spec/ruby-lint/virtual_machine/complex/{slop.rb → slop_spec.rb}

@@ -1,8 +1,8 @@
-require File.expand_path('../../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::VirtualMachine do
   describe 'slop' do
-    should 'process the Slop gem' do
+    example 'process the Slop gem' do
       code  = fixture('complex/slop.rb')
       defs  = build_definitions(code)
       const = defs.lookup(:const, 'Slop')
@@ -13,4 +13,4 @@ describe RubyLint::VirtualMachine do
       const.has_definition?(:method, 'parse!').should == true
     end
   end
-end
+end

data/spec/ruby-lint/virtual_machine/constants_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe RubyLint::VirtualMachine do
+  context 'generic constants' do
+    # These tests are put in place to ensure that a class/module can refer to
+    # itself without having to look anything up in parent scopes. An example:
+    #
+    #     class Foo
+    #       Foo # => points to the class
+    #     end
+    #
+    example 'add the constant to itself' do
+      code = <<-CODE
+  module A
+  end
+
+  class B
+  end
+      CODE
+
+      defs  = build_definitions(code)
+      mod   = defs.lookup(:const, 'A')
+      klass = defs.lookup(:const, 'B')
+
+      # `lookup_parent` is set to false to ensure that the code doesn't use
+      # parent scopes to find the constant.
+      mod.lookup(:const, 'A', false).should   == mod
+      klass.lookup(:const, 'B', false).should == klass
+    end
+  end
+end

data/spec/ruby-lint/virtual_machine/{for.rb → for_spec.rb}

@@ -1,7 +1,7 @@
-require File.expand_path('../../../helper', __FILE__)
+require 'spec_helper'
 
 describe 'Building variable definitions using for loops' do
-  should 'create local variables' do
+  example 'create local variables' do
     code = <<-CODE
 for key, value in something
 
@@ -13,4 +13,4 @@ end
     defs.lookup(:lvar, 'key').is_a?(ruby_object).should   == true
     defs.lookup(:lvar, 'value').is_a?(ruby_object).should == true
   end
-end
+end

data/spec/ruby-lint/virtual_machine/{freeze.rb → freeze_spec.rb}

@@ -1,7 +1,7 @@
-require File.expand_path('../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::VirtualMachine do
-  should 'freeze the VM and all instance variables' do
+  example 'freeze the VM and all instance variables' do
     vm = RubyLint::VirtualMachine.new
 
     vm.freeze
@@ -10,4 +10,4 @@ describe RubyLint::VirtualMachine do
     vm.definitions.frozen?.should  == true
     vm.associations.frozen?.should == true
   end
-end
+end

data/spec/ruby-lint/virtual_machine/global_variables_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe RubyLint::VirtualMachine do
+  describe 'global variables' do
+    example 'provide a list of default global variables' do
+      scope = RubyLint::GlobalScope.definitions
+
+      scope.lookup(:gvar, '$LOAD_PATH').is_a?(ruby_object).should == true
+      scope.lookup(:gvar, '$9').is_a?(ruby_object).should         == true
+    end
+  end
+end

data/spec/ruby-lint/virtual_machine/inherit_kernel_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe RubyLint::VirtualMachine do
+  context 'inheriting definitions using modules' do
+    example 'modules should inherit from Kernel' do
+      code = 'module Foo; end'
+      defs = build_definitions(code)
+
+      defs.lookup(:const, 'Foo')
+        .lookup(:method, 'alias_method')
+        .is_a?(ruby_method)
+        .should == true
+    end
+  end
+end

data/spec/ruby-lint/virtual_machine/{interpolation.rb → interpolation_spec.rb}

@@ -1,12 +1,12 @@
-require File.expand_path('../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::VirtualMachine do
   describe 'string interpolation' do
-    should 'process an assignment in a string' do
+    example 'process an assignment in a string' do
       code = '"hello #{number = 10}"'
       defs = build_definitions(code)
 
       defs.lookup(:lvar, 'number').value.value.should == 10
     end
   end
-end
+end

data/spec/ruby-lint/virtual_machine/methods/attr_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe RubyLint::VirtualMachine do
+  context 'attr methods' do
+    example 'should define a read-only attribute using #attr' do
+      code = <<-CODE
+class Example
+  attr :number
+end
+      CODE
+
+      defs = build_definitions(code)
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:instance_method, 'number')
+        .should == true
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:ivar, '@number')
+        .should == true
+
+      defs.lookup(:const, 'Example')
+        .lookup(:ivar, '@number')
+        .used?
+        .should == true
+    end
+
+    example 'should define an accessor attribute using #attr' do
+      code = <<-CODE
+class Example
+  attr :number, true
+end
+      CODE
+
+      defs = build_definitions(code)
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:instance_method, 'number')
+        .should == true
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:instance_method, 'number=')
+        .should == true
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:ivar, '@number')
+        .should == true
+    end
+
+    example 'should define a read-only attribute using #attr_reader' do
+      code = <<-CODE
+class Example
+  attr_reader :number
+end
+      CODE
+
+      defs = build_definitions(code)
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:instance_method, 'number')
+        .should == true
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:instance_method, 'number=')
+        .should == false
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:ivar, '@number')
+        .should == true
+    end
+
+    example 'should define a write-only attribute using #attr_writer' do
+      code = <<-CODE
+class Example
+  attr_writer :number
+end
+      CODE
+
+      defs = build_definitions(code)
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:instance_method, 'number')
+        .should == false
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:instance_method, 'number=')
+        .should == true
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:ivar, '@number')
+        .should == true
+    end
+
+    example 'should define an accessor attribute using #attr_accessor' do
+      code = <<-CODE
+class Example
+  attr_accessor :number
+end
+      CODE
+
+      defs = build_definitions(code)
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:instance_method, 'number')
+        .should == true
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:instance_method, 'number=')
+        .should == true
+
+      defs.lookup(:const, 'Example')
+        .has_definition?(:ivar, '@number')
+        .should == true
+    end
+  end
+end

data/spec/ruby-lint/virtual_machine/methods/define_method_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe RubyLint::VirtualMachine do
+  context 'define_method' do
+    example 'change the instance type of the block to `:instance`' do
+      code = <<-CODE
+class A
+  define_method(:example) do
+  end
+end
+      CODE
+
+      assoc = build_associations(code).to_a.last.last
+
+      assoc.type.should          == :block
+      assoc.instance_type.should == :instance
+    end
+
+    example 'should not mess up nested blocks' do
+      code = <<-CODE
+class A
+  something.each do
+    define_method(:example) do
+    end
+  end
+end
+      CODE
+
+      assoc = build_associations(code).to_a
+
+      something = assoc[2].last
+      define    = assoc[4].last
+
+      something.type.should          == :block
+      something.instance_type.should == :class
+
+      define.type.should          == :block
+      define.instance_type.should == :instance
+    end
+  end
+end

data/spec/ruby-lint/virtual_machine/methods/{defining.rb → defining_spec.rb}

@@ -1,8 +1,8 @@
-require File.expand_path('../../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::VirtualMachine do
   describe 'defining methods' do
-    should 'process a definition with a variable assignment in the body' do
+    example 'process a definition with a variable assignment in the body' do
       code = <<-CODE
   def example
     number = 10
@@ -19,7 +19,7 @@ describe RubyLint::VirtualMachine do
       defs.lookup(:lvar, 'number').nil?.should == true
     end
 
-    should 'process a definition with a receiver' do
+    example 'process a definition with a receiver' do
       code = <<-CODE
   def String.example
     number = 10
@@ -37,4 +37,4 @@ describe RubyLint::VirtualMachine do
       defs.lookup(:instance_method, 'example').nil?.should == true
     end
   end
-end
+end

data/spec/ruby-lint/virtual_machine/methods/docstrings_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe RubyLint::VirtualMachine do
+  context 'method arguments and docstrings' do
+    example 'extract the type of a parameter' do
+      code = <<-CODE
+# @param [Numeric] number
+def example(number)
+end
+      CODE
+
+      defs = build_definitions(code)
+
+      number  = defs.lookup(:instance_method, 'example').lookup(:lvar, 'number')
+      numeric = RubyLint::GlobalScope.global_constant('Numeric')
+
+      number.is_a?(ruby_object).should        == true
+      number.parents.include?(numeric).should == true
+    end
+
+    example 'extract the type of a parameter using a method' do
+      code = <<-CODE
+# @param [#to_s] number
+def example(number)
+end
+      CODE
+
+      defs   = build_definitions(code)
+      number = defs.lookup(:instance_method, 'example').lookup(:lvar, 'number')
+
+      number.is_a?(ruby_object).should                                  == true
+      number.lookup(:instance_method, 'to_s').is_a?(ruby_method).should == true
+    end
+
+    example 'extract multiple types from a parameter' do
+      code = <<-CODE
+# @param [Float|Fixnum] number
+def example(number)
+end
+      CODE
+
+      float  = RubyLint::GlobalScope.global_constant('Float')
+      fixnum = RubyLint::GlobalScope.global_constant('Fixnum')
+
+      defs   = build_definitions(code)
+      number = defs.lookup(:instance_method, 'example').lookup(:lvar, 'number')
+
+      number.is_a?(ruby_object).should       == true
+      number.parents.include?(float).should  == true
+      number.parents.include?(fixnum).should == true
+    end
+  end
+
+  context 'method return values and docstrings' do
+    example 'extract the type of a return tag' do
+      code = <<-CODE
+# @return [Numeric]
+def example
+end
+      CODE
+
+      defs    = build_definitions(code)
+      method  = defs.lookup(:instance_method, 'example')
+      numeric = RubyLint::GlobalScope.global_constant('Numeric')
+
+      method.return_value.should == numeric
+    end
+  end
+end