ruby-lint 0.0.5 → 0.9.0

data/lib/ruby-lint.rb

@@ -1,9 +1,22 @@
-gem 'parser', '>= 2.0.0.pre6'
+gem 'parser', '>= 2.0.0'
 
 require 'parser'
-require 'parser/current'
+
+# Try to load the latest parser and fall back to 2.0. This should only occur on
+# Ruby versions >= 2.1 (e.g. Rubinius HEAD).
+begin
+  require 'parser/current'
+rescue NotImplementedError => error
+  warn "Falling back to Ruby 2.0: #{error.message}"
+
+  require 'parser/ruby20'
+  Parser::CurrentRuby = Parser::Ruby20
+end
+
 require 'yaml'
 require 'set'
+require 'digest/sha1'
+require 'zlib'
 
 require_relative 'ruby-lint/extensions/string'
 
@@ -18,6 +31,10 @@ require_relative 'ruby-lint/docstring/param_tag'
 require_relative 'ruby-lint/docstring/return_tag'
 require_relative 'ruby-lint/docstring/mapping'
 
+require_relative 'ruby-lint/node_hash'
+require_relative 'ruby-lint/cache'
+require_relative 'ruby-lint/cache_entry'
+
 require_relative 'ruby-lint/helper/constant_paths'
 
 require_relative 'ruby-lint/definition_builder/base'
@@ -41,6 +58,7 @@ require_relative 'ruby-lint/global_scope'
 require_relative 'ruby-lint/virtual_machine'
 require_relative 'ruby-lint/constant_loader'
 require_relative 'ruby-lint/file_loader'
+require_relative 'ruby-lint/method_call_info'
 
 require_relative 'ruby-lint/definition/ruby_object'
 require_relative 'ruby-lint/definition/ruby_method'

data/profiling/virtual_machine.rb

@@ -0,0 +1,20 @@
+require 'ruby-prof'
+
+require_relative '../lib/ruby-lint'
+
+parser = RubyLint::Parser.new
+file   = File.expand_path('../../lib/ruby-lint/virtual_machine.rb', __FILE__)
+ast    = parser.parse(File.read(file), file)
+amount = 1000
+
+result = RubyProf.profile do
+  amount.times do
+    RubyLint::VirtualMachine.new.run(ast)
+  end
+end
+
+result.eliminate_methods!([/Integer#times/])
+
+printer = RubyProf::GraphHtmlPrinter.new(result)
+
+printer.print(STDOUT, :sort_method => :self_time)

data/ruby-lint.gemspec

@@ -29,7 +29,7 @@ using the handle "yorickpeterse".
   s.has_rdoc              = 'yard'
   s.required_ruby_version = '>= 1.9.3'
 
-  s.add_dependency 'parser', ['>= 2.0.0.pre6']
+  s.add_dependency 'parser', ['>= 2.0.0']
   s.add_dependency 'slop'
 
   s.add_development_dependency 'rake'
@@ -42,4 +42,5 @@ using the handle "yorickpeterse".
   s.add_development_dependency 'json'
   s.add_development_dependency 'kramdown'
   s.add_development_dependency 'redcard'
+  s.add_development_dependency 'gnuplot'
 end

data/spec/fixtures/complex/rcap.rb

@@ -1,3 +1,32 @@
+# RCAP is released under the BSD License.
+#
+# Copyright 2010 - 2013 AIMRED CC. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY AIMRED CC ``AS IS'' AND ANY EXPRESS OR IMPLIED
+# WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+# EVENT SHALL AIMRED CC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+# EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# The views and conclusions contained in the software and documentation are
+# those of the authors and should not be interpreted as representing official
+# policies, either expressed or implied, of AIMRED CC.
+
 module RCAP
   # The VM will raise an error if this class doesn't exist.
   module Base

data/spec/fixtures/complex/slop.rb

@@ -1,3 +1,24 @@
+# Copyright (c) 2012 Lee Jarvis
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 require 'slop/option'
 require 'slop/commands'
 

data/spec/fixtures/file_scanner/lib/ruby-lint/definition/constant_proxy.rb

@@ -0,0 +1,6 @@
+module Definition
+  class ConstantProxy
+    def initialize(definitions, name)
+    end
+  end # ConstantProxy
+end # Definition

data/spec/fixtures/file_scanner/lib/ruby-lint/global_scope.rb

@@ -0,0 +1,6 @@
+module RubyLint
+  module GlobalScope
+    def self.definitions
+    end
+  end # GlobalScope
+end # RubyLint

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

@@ -142,4 +142,118 @@ def number; end
 
     report.entries.empty?.should == true
   end
+
+  context 'method arguments' do
+    example 'warn for a unused argument' do
+      code = <<-CODE
+def multiply(number)
+end
+      CODE
+
+      report = build_report(code, RubyLint::Analysis::UnusedVariables)
+      entry  = report.entries[0]
+
+      entry.message.should == 'unused argument number'
+      entry.line.should    == 1
+      entry.column.should  == 13
+    end
+
+    example 'warn for a unused optional argument' do
+      code = <<-CODE
+def multiply(amount = 2)
+end
+      CODE
+
+      report = build_report(code, RubyLint::Analysis::UnusedVariables)
+      entry  = report.entries[0]
+
+      entry.message.should == 'unused argument amount'
+      entry.line.should    == 1
+      entry.column.should  == 13
+    end
+
+    example 'warn for a unused rest argument' do
+      code = <<-CODE
+def multiply(*args)
+end
+      CODE
+
+      report = build_report(code, RubyLint::Analysis::UnusedVariables)
+      entry  = report.entries[0]
+
+      entry.message.should == 'unused argument args'
+      entry.line.should    == 1
+      entry.column.should  == 13
+    end
+
+    example 'warn for a unused block argument' do
+      code = <<-CODE
+def multiply(&block)
+end
+      CODE
+
+      report = build_report(code, RubyLint::Analysis::UnusedVariables)
+      entry  = report.entries[0]
+
+      entry.message.should == 'unused argument block'
+      entry.line.should    == 1
+      entry.column.should  == 13
+    end
+
+    specific_ruby_version '2.0' do
+      example 'warn for a unused keyword argument' do
+        code = <<-CODE
+def multiply(amount: 10)
+end
+        CODE
+
+        report = build_report(code, RubyLint::Analysis::UnusedVariables)
+        entry  = report.entries[0]
+
+        entry.message.should == 'unused argument amount'
+        entry.line.should    == 1
+        entry.column.should  == 13
+      end
+    end
+
+    example 'do not warn for a used argument' do
+      code = <<-CODE
+def multiply(number)
+  return number * 2
+end
+      CODE
+
+      report = build_report(code, RubyLint::Analysis::UnusedVariables)
+
+      report.entries.empty?.should == true
+    end
+  end
+
+  context 'block arguments' do
+    example 'warn for a unused argument' do
+      code = <<-CODE
+[10, 20].each do |number|
+end
+      CODE
+
+      report = build_report(code, RubyLint::Analysis::UnusedVariables)
+      entry  = report.entries[0]
+
+      entry.message.should == 'unused argument number'
+      entry.line.should    == 1
+      entry.column.should  == 18
+    end
+
+    example 'do not warn for a used argument' do
+      code = <<-CODE
+[10, 20].each do |number|
+  number
+end
+      CODE
+
+      report = build_report(code, RubyLint::Analysis::UnusedVariables)
+
+      report.entries.empty?.should == true
+    end
+  end
 end

data/spec/ruby-lint/cache_entry_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe RubyLint::CacheEntry do
+  before do
+    @tempfile = Tempfile.new('ruby-lint')
+  end
+
+  after do
+    File.unlink(@tempfile)
+  end
+
+  example 'should validate the file modification times' do
+    mtimes = {@tempfile.path => @tempfile.mtime}
+    entry  = RubyLint::CacheEntry.new(nil, nil, mtimes)
+
+    entry.valid?.should == true
+
+    @tempfile.write('hello')
+
+    # Bit of a hack to ensure that we don't have to use sleep()
+    entry.mtimes[@tempfile.path] = @tempfile.mtime - 10
+
+    entry.valid?.should == false
+  end
+end

data/spec/ruby-lint/cache_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe RubyLint::Cache do
+  before do
+    @directory = Dir.mktmpdir('ruby-lint')
+    @cache     = RubyLint::Cache.new(@directory)
+  end
+
+  after do
+    FileUtils.rm_rf(@directory)
+  end
+
+  example 'create the cache directory' do
+    directory = Dir::Tmpname.create('ruby-lint') { |name| name }
+    cache     = RubyLint::Cache.new(directory)
+
+    File.directory?(directory).should == false
+
+    cache.create_directory!
+
+    File.directory?(directory).should == true
+
+    FileUtils.rm_rf(directory)
+  end
+
+  example 'set and get a cache entry' do
+    value = 20
+
+    @cache.set('example', value)
+
+    @cache.get('example').should == value
+  end
+
+  example 'check if a cache entry exists' do
+    @cache.exists?('example').should == false
+
+    @cache.set('example', 20)
+
+    @cache.exists?('example').should == true
+  end
+
+  example 'return nothing if a cache entry does not exist' do
+    @cache.get('foo').nil?.should == true
+  end
+
+  example 'remove a cache entry' do
+    @cache.set('example', 20)
+
+    @cache.exists?('example').should == true
+    @cache.delete('example')
+    @cache.exists?('example').should == false
+  end
+end

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

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe RubyLint::Definition::RubyObject do
-  describe 'method definition DSL' do
+  context 'method definition DSL' do
     before do
       @method = ruby_method.new(:name => 'example', :type => :instance_method)
     end
 
-    describe 'return values' do
+    context 'return values' do
       example 'return a static value' do
         @method.returns(10)
 
@@ -23,7 +23,7 @@ describe RubyLint::Definition::RubyObject do
       end
     end
 
-    describe 'calling methods' do
+    context 'calling methods' do
       before do
         @method.returns(10)
       end
@@ -56,7 +56,7 @@ describe RubyLint::Definition::RubyObject do
       end
     end
 
-    describe 'defining arguments' do
+    context 'defining arguments' do
       example 'define an argument' do
         @method.define_argument('number')
 

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

@@ -194,4 +194,37 @@ describe ruby_object do
 
     target.lookup(:const, 'Foo').should == const
   end
+
+  example 'storing location information in a definition' do
+    obj = ruby_object.new(:line => 10, :column => 2, :file => '(ruby-lint)')
+
+    obj.line.should   == 10
+    obj.column.should == 2
+    obj.file.should   == '(ruby-lint)'
+  end
+
+  context 'deep freezing definitions' do
+    before :all do
+      @const  = ruby_object.new(:type => :const, :name => 'Foo')
+      @method = ruby_method.new(:type => :method, :name => 'test')
+
+      @const.add_definition(@method)
+
+      @const.deep_freeze
+    end
+
+    example 'freeze the root constant' do
+      @const.frozen?.should == true
+    end
+
+    example 'freeze the definitions list of the root constant' do
+      @const.definitions.frozen?.should == true
+    end
+
+    example 'freeze child definitions' do
+      @method.frozen?.should         == true
+      @method.calls.frozen?.should   == true
+      @method.callers.frozen?.should == true
+    end
+  end
 end

data/spec/ruby-lint/iterator_spec.rb

@@ -133,4 +133,19 @@ end
     iterator.options[:module].should == true
     iterator.options[:class].should  == false
   end
+
+  example 'allow callbacks without arguments' do
+    ast      = parse('10', false)
+    iterator = Class.new(RubyLint::Iterator) do
+      attr_reader :number
+
+      def on_int
+        @number = true
+      end
+    end.new
+
+    iterator.iterate(ast)
+
+    iterator.number.should == true
+  end
 end