ruby-lint 0.0.4 → 0.0.5

data/spec/ruby-lint/analysis/{undefined_variables.rb → undefined_variables_spec.rb}

@@ -1,7 +1,7 @@
-require File.expand_path('../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::Analysis::UndefinedVariables do
-  should 'add an error for using an undefined instance variable' do
+  example 'add an error for using an undefined instance variable' do
     report = build_report('@number', RubyLint::Analysis::UndefinedVariables)
     entry  = report.entries[0]
 
@@ -12,7 +12,7 @@ describe RubyLint::Analysis::UndefinedVariables do
     entry.message.should == 'undefined instance variable @number'
   end
 
-  should 'add an error for using an undefined class variable' do
+  example 'add an error for using an undefined class variable' do
     report = build_report('@@number', RubyLint::Analysis::UndefinedVariables)
     entry  = report.entries[0]
 
@@ -23,7 +23,7 @@ describe RubyLint::Analysis::UndefinedVariables do
     entry.message.should == 'undefined class variable @@number'
   end
 
-  should 'add an error for using an undefined global variable' do
+  example 'add an error for using an undefined global variable' do
     report = build_report('$number', RubyLint::Analysis::UndefinedVariables)
     entry  = report.entries[0]
 
@@ -34,7 +34,7 @@ describe RubyLint::Analysis::UndefinedVariables do
     entry.message.should == 'undefined global variable $number'
   end
 
-  should 'add an error for using an undefined constant' do
+  example 'add an error for using an undefined constant' do
     report = build_report('NUMBER', RubyLint::Analysis::UndefinedVariables)
     entry  = report.entries[0]
 
@@ -45,7 +45,7 @@ describe RubyLint::Analysis::UndefinedVariables do
     entry.message.should == 'undefined constant NUMBER'
   end
 
-  should 'add an error for using an undefined constant path' do
+  example 'add an error for using an undefined constant path' do
     code = <<-CODE
 # This is to ensure that the on_const() callback isn't used to check for "B"
 # in the global scope.
@@ -67,7 +67,7 @@ A::B
     entry.message.should == 'undefined constant A::B'
   end
 
-  should 'not depend on the order of variable definitions' do
+  example 'do not depend on the order of variable definitions' do
     code = <<-CODE
 class Person
   def first
@@ -85,14 +85,14 @@ end
     report.entries.empty?.should == true
   end
 
-  should 'not add errors when autoloading constants' do
+  example 'do not add errors when autoloading constants' do
     code   = 'Encoding::BIG5'
     report = build_report(code, RubyLint::Analysis::UndefinedVariables)
 
     report.entries.empty?.should == true
   end
 
-  should 'not error when inheriting data in a block' do
+  example 'do not error when inheriting data in a block' do
     code = <<-CODE
 NUMBER = 10
 
@@ -106,10 +106,33 @@ CODE
     report.entries.empty?.should == true
   end
 
-  should 'not add errors for variable references in string interpolation' do
+  example 'do not add errors for variable references in string interpolation' do
     code   = 'number = 10; "#{number}"'
     report = build_report(code, RubyLint::Analysis::UndefinedVariables)
 
     report.entries.empty?.should == true
   end
+
+  example 'do not add errors for class names' do
+    code = <<-CODE
+class Foo
+end
+
+module Namespace
+  class Bar
+  end
+end
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::UndefinedVariables)
+
+    report.entries.empty?.should == true
+  end
+
+  example 'do not add errors when aliasing global variables' do
+    code   = 'alias $ARGV $*'
+    report = build_report(code, RubyLint::Analysis::UndefinedVariables)
+
+    report.entries.empty?.should == true
+  end
 end

data/spec/ruby-lint/analysis/{unused_variables.rb → unused_variables_spec.rb}

@@ -1,7 +1,7 @@
-require File.expand_path('../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::Analysis::UnusedVariables do
-  should 'warn for unused local variables' do
+  example 'warn for unused local variables' do
     report = build_report('number = 1', RubyLint::Analysis::UnusedVariables)
     entry  = report.entries[0]
 
@@ -12,7 +12,16 @@ describe RubyLint::Analysis::UnusedVariables do
     entry.message.should == 'unused local variable number'
   end
 
-  should 'not warn for used variables' do
+  example 'warn for unused instance variables' do
+    report = build_report('@number = 1', RubyLint::Analysis::UnusedVariables)
+    entry = report.entries[0]
+
+    entry.line.should    == 1
+    entry.column.should  == 0
+    entry.message.should == 'unused instance variable @number'
+  end
+
+  example 'do not warn for used variables' do
     code = <<-CODE
 number = 1
 
@@ -24,7 +33,7 @@ number
     report.entries.empty?.should == true
   end
 
-  should 'warn for unused constants' do
+  example 'warn for unused constants' do
     report = build_report('NUMBER = 10', RubyLint::Analysis::UnusedVariables)
     entry  = report.entries[0]
 
@@ -35,7 +44,7 @@ number
     entry.message.should == 'unused constant NUMBER'
   end
 
-  should 'not warn for used constants' do
+  example 'do not warn for used constants' do
     code = <<-CODE
 A = 10
 
@@ -47,7 +56,7 @@ A
     report.entries.empty?.should == true
   end
 
-  should 'warn for unused constant paths' do
+  example 'warn for unused constant paths' do
     code = <<-CODE
 module A
 end
@@ -68,7 +77,7 @@ A::B = 10
     entry.message.should == 'unused constant A::B'
   end
 
-  should 'warn for unused variables in a method scope' do
+  example 'warn for unused variables in a method scope' do
     code = <<-CODE
 def some_method
   number = 10
@@ -85,7 +94,7 @@ end
     entry.message.should == 'unused local variable number'
   end
 
-  should 'not add a warning when assigning a variable to another variable' do
+  example 'do not add a warning when assigning a variable to another variable' do
     code = <<-CODE
 first  = 10
 second = first
@@ -102,7 +111,7 @@ second = first
     entry.message.should == 'unused local variable second'
   end
 
-  should 'not add warnings when defining classes and modules' do
+  example 'do not add warnings when defining classes and modules' do
     code = <<-CODE
 module A
 end
@@ -115,4 +124,22 @@ end
 
     report.entries.empty?.should == true
   end
+
+  example 'ignore ivars if there is a corresponding method' do
+    code = <<-CODE
+@number = 10
+
+def number; end
+    CODE
+
+    report = build_report(code, RubyLint::Analysis::UnusedVariables)
+
+    report.entries.empty?.should == true
+  end
+
+  example 'ignore local variables that start with an underscore' do
+    report = build_report('_number = 10', RubyLint::Analysis::UnusedVariables)
+
+    report.entries.empty?.should == true
+  end
 end

data/spec/ruby-lint/ast/{node.rb → node_spec.rb}

@@ -1,11 +1,11 @@
-require File.expand_path('../../../helper', __FILE__)
+require 'spec_helper'
 
 describe RubyLint::AST::Node do
-  should 'return the value for a scalar' do
+  example 'return the value for a scalar' do
     s(:str, 'hello').children[0].should == 'hello'
   end
 
-  should 'return the value for an Array' do
+  example 'return the value for an Array' do
     numbers = s(:array, s(:int, 10), s(:int, 20)).children
 
     numbers.is_a?(Array).should == true
@@ -15,7 +15,7 @@ describe RubyLint::AST::Node do
     numbers[1].children[0].should == 20
   end
 
-  should 'return the value for a Hash' do
+  example 'return the value for a Hash' do
     pairs = s(:hash, s(:pair, s(:str, 'number'), s(:int, 10))).children
 
     pairs.is_a?(Array).should == true
@@ -23,11 +23,17 @@ describe RubyLint::AST::Node do
     pairs[0].children[1].children[0].should == 10
   end
 
-  should 'should try to guess the Ruby class of a node' do
+  example 'should try to guess the Ruby class of a node' do
     s(:str, 'foo').ruby_class.should == 'String'
   end
 
-  should 'check if a node is a constant path' do
+  example 'check if a node is a constant path' do
     s(:const, s(:const, nil, :A), :B).constant_path?.should == true
   end
+
+  example 'inspect a node using #inspect_oneline' do
+    output = '(const (const nil :A) :B)'
+
+    s(:const, s(:const, nil, :A), :B).inspect_oneline.should == output
+  end
 end

data/spec/ruby-lint/cli/{analyze.rb → analyze_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('../../../helper', __FILE__)
+require 'spec_helper'
 require File.expand_path('../../../../lib/ruby-lint/cli', __FILE__)
 
 describe RubyLint::CLI do
@@ -10,8 +10,8 @@ describe RubyLint::CLI do
       @command.output_destination = @output
     end
 
-    should 'analyze a valid Ruby file' do
-      file = File.expand_path('../../../fixtures/valid.rb', __FILE__)
+    example 'analyze a valid Ruby file' do
+      file = fixture_path('valid.rb')
 
       @command.parse([file])
 
@@ -19,13 +19,24 @@ describe RubyLint::CLI do
       @output.read.empty?.should == true
     end
 
-    should 'analyze an invalid Ruby file' do
-      file = File.expand_path('../../../fixtures/invalid.rb', __FILE__)
+    example 'analyze an invalid Ruby file' do
+      file = fixture_path('invalid.rb')
 
       @command.parse([file])
 
       @output.rewind
       @output.read.should =~ /undefined method foobar/
     end
+
+    example 'include benchmarking output' do
+      @command.parse(['-b', fixture_path('valid.rb')])
+
+      @output.rewind
+
+      output = @output.read
+
+      output.should =~ /Execution time:/
+      output.should =~ /Memory usage:/
+    end
   end
 end

data/spec/ruby-lint/cli/{ast.rb → ast_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('../../../helper', __FILE__)
+require 'spec_helper'
 require File.expand_path('../../../../lib/ruby-lint/cli', __FILE__)
 
 describe RubyLint::CLI do
@@ -10,7 +10,7 @@ describe RubyLint::CLI do
       @command.output_destination = @output
     end
 
-    should 'show the AST of a Ruby file' do
+    example 'show the AST of a Ruby file' do
       file   = File.expand_path('../../../fixtures/valid.rb', __FILE__)
       output = RubyLint::Parser.new.parse(File.read(file)).inspect
 
@@ -20,4 +20,4 @@ describe RubyLint::CLI do
       @output.read.strip.should == output
     end
   end
-end
+end

data/spec/ruby-lint/configuration_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe RubyLint::Configuration do
+  context 'default options' do
+    before do
+      @configuration = RubyLint::Configuration.new
+    end
+
+    example 'set the default report levels' do
+      @configuration.report_levels.should == RubyLint::Report::DEFAULT_LEVELS
+    end
+
+    example 'set the default presenter' do
+      @configuration.default_presenter.should == RubyLint::Presenter::Text
+    end
+
+    example 'set the default analysis classes' do
+      @configuration.default_analysis_classes.empty?.should == false
+    end
+
+    example 'set the default debug mode' do
+      @configuration.debug.should == false
+    end
+  end
+
+  context 'empty and invalid arguments' do
+    before do
+      @configuration = RubyLint::Configuration.new
+    end
+
+    example 'set the report levels' do
+      @configuration.report_levels = []
+
+      @configuration.report_levels
+        .should == @configuration.default_report_levels
+    end
+
+    example 'set an invalid presenter' do
+      blk = lambda { @configuration.presenter = String }
+
+      blk.should raise_error(ArgumentError, /Invalid presenter/)
+    end
+
+    example 'set the analysis classes' do
+      @configuration.analysis_classes = []
+
+      @configuration.analysis_classes
+        .should == @configuration.default_analysis_classes
+    end
+
+    example 'set an invalid directory' do
+      blk = lambda do
+        @configuration.directories = ['idoubtthisdirectoryexists']
+      end
+
+      blk.should raise_error(ArgumentError, /does not exist/)
+    end
+  end
+
+  context 'setting options via the constructor' do
+    example 'set the report levels' do
+      conf = RubyLint::Configuration.new(:report_levels => ['info'])
+
+      conf.report_levels.should == [:info]
+    end
+
+    example 'set the presenter' do
+      conf = RubyLint::Configuration.new(:presenter => 'json')
+
+      conf.presenter.should == RubyLint::Presenter::JSON
+    end
+
+    example 'set the analysis classes' do
+      conf = RubyLint::Configuration.new(
+        :analysis_classes => ['undefined_methods']
+      )
+
+      conf.analysis_classes.should == [RubyLint::Analysis::UndefinedMethods]
+    end
+
+    example 'set the debug mode' do
+      conf = RubyLint::Configuration.new(:debug => true)
+
+      conf.debug.should == true
+    end
+  end
+
+  context 'setting options via a configuration file' do
+    example 'set the options from a YAML file' do
+      paths = [fixture_path('config.yml')]
+      conf  = RubyLint::Configuration.load_from_file(paths)
+
+      conf.report_levels.should    == [:info]
+      conf.analysis_classes.should == [RubyLint::Analysis::UndefinedMethods]
+      conf.presenter.should        == RubyLint::Presenter::JSON
+    end
+
+    example 'return a default configuration file' do
+      conf = RubyLint::Configuration.load_from_file([])
+
+      conf.is_a?(RubyLint::Configuration).should == true
+
+      conf.report_levels.should == RubyLint::Report::DEFAULT_LEVELS
+    end
+  end
+end

data/spec/ruby-lint/definition/constant_proxy_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe RubyLint::Definition::ConstantProxy do
+  before do
+    @source = ruby_object.new(:name => 'global', :type => :global)
+    @proxy  = RubyLint::Definition::ConstantProxy.new(@source, 'Foo')
+  end
+
+  example 'create a new constant proxy' do
+    @proxy.proxy_source.should == @source
+    @proxy.proxy_name.should   == 'Foo'
+  end
+
+  example 'act like a RubyObject definition' do
+    @proxy.lookup(:const, 'Bar').nil?.should == true
+  end
+
+  example 'cache the definition when it exists' do
+    @proxy.name.nil?.should == true
+    @proxy.type.nil?.should == true
+
+    @proxy.lookup(:const, 'VERSION').nil?.should == true
+
+    @source.define_constant('Foo').define_constant('VERSION')
+
+    @proxy.name.should == 'Foo'
+    @proxy.type.should == :const
+
+    @proxy.lookup(:const, 'VERSION').is_a?(ruby_object).should == true
+  end
+
+  example 'autoload definitions from the global scope' do
+    proxy = RubyLint::Definition::ConstantProxy.new(
+      RubyLint::GlobalScope,
+      'ObjectSpace'
+    )
+
+    proxy.type.should == :const
+    proxy.name.should == 'ObjectSpace'
+
+    proxy.proxy_definition.is_a?(ruby_object).should == true
+  end
+
+  example 'delegating #inspect' do
+    proxy = RubyLint::Definition::ConstantProxy.new(
+      RubyLint::GlobalScope,
+      'ObjectSpace'
+    )
+
+    object_space = RubyLint::GlobalScope.global_constant('ObjectSpace')
+
+    proxy.inspect.should == object_space.inspect
+  end
+end