ruby-lint 0.0.3 → 0.0.4

data/spec/ruby-lint/{definitions_builder → virtual_machine}/modules.rb

@@ -4,11 +4,11 @@ describe 'Building module definitions' do
   describe 'scoping definitions' do
     should 'process a global module' do
       defs    = build_definitions('module Example; end')
-      example = defs.lookup(:constant, 'Example')
+      example = defs.lookup(:const, 'Example')
 
       example.is_a?(ruby_object).should == true
 
-      example.type.should == :module
+      example.type.should == :const
       example.name.should == 'Example'
     end
 
@@ -21,13 +21,13 @@ end
       CODE
 
       defs  = build_definitions(code)
-      first = defs.lookup(:constant, 'First')
+      first = defs.lookup(:const, 'First')
 
       first.is_a?(ruby_object).should == true
 
-      defs.lookup(:constant, 'Second').nil?.should == true
+      defs.lookup(:const, 'Second').nil?.should == true
 
-      first.lookup(:constant, 'Second') \
+      first.lookup(:const, 'Second') \
         .is_a?(ruby_object) \
         .should == true
     end
@@ -44,24 +44,24 @@ end
       CODE
 
       defs  = build_definitions(code)
-      first = defs.lookup(:constant, 'First')
+      first = defs.lookup(:const, 'First')
 
-      first.lookup(:constant, 'Second') \
+      first.lookup(:const, 'Second') \
         .is_a?(ruby_object) \
         .should == true
 
       # Due to "First" and "Third" being defined in the same scope the "Third"
       # constant is available inside the "First" module.
-      first.lookup(:constant, 'Third') \
+      first.lookup(:const, 'Third') \
         .is_a?(ruby_object) \
         .should == true
 
-      first.lookup(:constant, 'Second') \
-        .lookup(:constant, 'Third') \
+      first.lookup(:const, 'Second') \
+        .lookup(:const, 'Third') \
         .is_a?(ruby_object) \
         .should == true
 
-      defs.lookup(:constant, 'Third') \
+      defs.lookup(:const, 'Third') \
         .is_a?(ruby_object) \
         .should == true
     end
@@ -81,7 +81,7 @@ end
 
       defs = build_definitions(code)
 
-      defs.lookup(:constant, 'First') \
+      defs.lookup(:const, 'First') \
         .lookup(:instance_method, 'example') \
         .is_a?(ruby_method) \
         .should == true
@@ -103,7 +103,7 @@ end
 
       defs = build_definitions(code)
 
-      defs.lookup(:constant, 'Second') \
+      defs.lookup(:const, 'Second') \
         .lookup(:instance_method, 'example') \
         .is_a?(ruby_method) \
         .should == true
@@ -123,7 +123,7 @@ end
 
       defs = build_definitions(code)
 
-      defs.lookup(:constant, 'Second') \
+      defs.lookup(:const, 'Second') \
         .lookup(:method, 'example') \
         .is_a?(ruby_method) \
         .should == true
@@ -145,7 +145,7 @@ end
 
       defs = build_definitions(code)
 
-      defs.lookup(:constant, 'Third') \
+      defs.lookup(:const, 'Third') \
         .lookup(:instance_method, 'example') \
         .is_a?(ruby_method) \
         .should == true
@@ -166,7 +166,7 @@ end
 
       defs = build_definitions(code)
 
-      defs.lookup(:constant, 'Second') \
+      defs.lookup(:const, 'Second') \
         .lookup(:instance_method, 'example') \
         .is_a?(ruby_method) \
         .should == true

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

@@ -0,0 +1,33 @@
+require File.expand_path('../../../helper', __FILE__)
+
+describe RubyLint::VirtualMachine do
+  describe 'reference counting' do
+    should 'count the amount of references for a variable' do
+      code = <<-CODE
+  number = 10
+  number
+  number
+      CODE
+
+      defs = build_definitions(code)
+
+      defs.lookup(:lvar, 'number').reference_amount.should == 2
+    end
+
+    should 'count the amount of references for a constant path' do
+      code = <<-CODE
+  module A; end
+  A::B = 10
+  A::B
+  A::B
+      CODE
+
+      defs = build_definitions(code)
+
+      defs.lookup(:const, 'A') \
+        .lookup(:const, 'B') \
+        .reference_amount \
+        .should == 2
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require File.expand_path('../../../helper', __FILE__)
+
+describe RubyLint::VirtualMachine do
+  describe 'marking variables as used/unused' do
+    should 'mark variables as unused by default' do
+      defs = build_definitions('number = 10')
+
+      defs.lookup(:lvar, 'number').used?.should == false
+    end
+
+    should 'mark variables as used' do
+      defs = build_definitions('number = 10; number')
+
+      defs.lookup(:lvar, 'number').used?.should == true
+    end
+  end
+end

data/spec/support/bacon.rb

@@ -15,19 +15,19 @@ end
 
 # Show performance related information after running the tests.
 module Bacon
-  class << self
-    alias old_handle_summary handle_summary
-  end
+  module ColoredOutput
+    alias_method :old_handle_summary, :handle_summary
 
-  def self.handle_summary
-    old_handle_summary
+    def handle_summary
+      old_handle_summary
 
-    memory    = `ps -o rss= #{Process.pid}`.strip.to_f
-    memory_mb = (memory / 1024)
-    time_secs = (Time.now - @timer)
-    time_ms   = time_secs * 1000
+      memory    = `ps -o rss= #{Process.pid}`.strip.to_f
+      memory_mb = (memory / 1024)
+      time_secs = (Time.now - @timer)
+      time_ms   = time_secs * 1000
 
-    puts '%i KB (%.2f MB) used in %.2f miliseconds (%.2f seconds)' \
-      % [memory, memory_mb, time_ms, time_secs]
-  end
-end
+      puts '%i KB (%.2f MB) used in %.2f miliseconds (%.2f seconds)' \
+        % [memory, memory_mb, time_ms, time_secs]
+    end
+  end # TestUnitOutput
+end # Bacon

data/spec/support/building.rb

@@ -5,14 +5,12 @@
 # @return [RubyLint::Definition::RubyObject]
 #
 def build_definitions(code)
-  loader   = RubyLint::ConstantLoader.new
-  iterator = RubyLint::DefinitionsBuilder.new
-  ast      = parse(code, false)
+  ast = parse(code, false)
+  vm  = RubyLint::VirtualMachine.new
 
-  loader.iterate(ast)
-  iterator.iterate(ast)
+  vm.run(ast)
 
-  return iterator.options[:definitions]
+  return vm.definitions
 end
 
 ##
@@ -23,21 +21,30 @@ end
 # @return [RubyLint::Report]
 #
 def build_report(code, iterator)
-  ast          = parse(code, false)
-  defs_builder = RubyLint::DefinitionsBuilder.new
-  loader       = RubyLint::ConstantLoader.new
+  ast = parse(code, false)
+  vm  = RubyLint::VirtualMachine.new
 
-  loader.iterate(ast)
-  defs_builder.iterate(ast)
+  vm.run(ast)
 
   report   = RubyLint::Report.new
-  iterator = iterator.new(
-    :report           => report,
-    :definitions      => defs_builder.options[:definitions],
-    :node_definitions => defs_builder.options[:node_definitions]
-  )
+  iterator = iterator.new(:report => report, :vm => vm)
 
   iterator.iterate(ast)
 
   return report
 end
+
+##
+# Processes the given AST and returns the node associations.
+#
+# @see build_definitions
+# @return [Hash]
+#
+def build_associations(code)
+  ast = parse(code, false)
+  vm  = RubyLint::VirtualMachine.new
+
+  vm.run(ast)
+
+  return vm.associations
+end

data/spec/support/coveralls.rb

@@ -0,0 +1,5 @@
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+
+Coveralls.wear!

data/spec/support/fixtures.rb

@@ -0,0 +1,20 @@
+##
+# Returns the source code of a fixture file.
+#
+# @param [String] path The path to the fixture file, relative to the fixture
+#  directory
+# @return [String]
+#
+def fixture(path)
+  return File.read(fixture_path(path))
+end
+
+##
+# Returns the path to the given fixture file.
+#
+# @param [String] path The path relative to the fixtures directory.
+# @return [String]
+#
+def fixture_path(path)
+  return File.join(File.expand_path('../../fixtures', __FILE__), path)
+end

data/spec/support/parsing.rb

@@ -8,16 +8,14 @@
 # @return [RubyLint::Node]
 #
 def parse(code, first = true)
-  ast = RubyLint::Parser.new(code).parse
+  ast = RubyLint::Parser.new.parse(code)
 
   return first ? ast.children[0] : ast
 end
 
 ##
-# Shorthand for creating instances of {RubyLint::Node}.
-#
-# @see RubyLint::Node#initialize
+# Shorthand for creating instances of a AST node.
 #
 def s(type, *children)
-  return RubyLint::Node.new(type, children)
+  return RubyLint::AST::Node.new(type, children)
 end

data/spec/support/simplecov.rb

@@ -5,12 +5,14 @@ SimpleCov.configure do
   command_name 'bacon'
   project_name 'ruby-lint'
 
-  add_group 'Analysis'   , 'ruby-lint/analyze'
-  add_group 'Definitions', 'ruby-lint/definition'
-  add_group 'Formatters' , 'ruby-lint/formatter'
+  add_group 'Analysis', 'ruby-lint/analysis'
+  add_group 'Definition Containers', 'ruby-lint/definition'
+  add_group 'Definition Builders', 'ruby-lint/definition_builder'
+  add_group 'Presenters', 'ruby-lint/presenter'
 
   add_filter 'spec'
   add_filter 'lib/ruby-lint/version'
+  add_filter 'lib/ruby-lint/definitions'
 end
 
 SimpleCov.start

data/task/build.rake

@@ -1,5 +1,5 @@
 desc 'Builds and signs a new Gem'
-task :build => [:gem] do
+task :signed_build => [:build] do
   name = "#{GEMSPEC.name}-#{GEMSPEC.version}.gem"
   path = File.join(File.expand_path('../../pkg', __FILE__), name)
 

data/task/cop.rake

@@ -0,0 +1,11 @@
+desc 'Runs rubocop on lib/'
+task :cop do
+  if `which rubocop 2>&1` =~ /no rubocop in/
+    abort <<-EOF.strip
+Rubocop is not installed, install it by running `gem insatll rubocop`.
+Make sure that you install version 0.9.0 or newer.
+    EOF
+  end
+
+  sh 'rubocop lib/'
+end

data/task/generate.rake

@@ -1,13 +1,13 @@
 namespace :generate do
   desc 'Generates a set of definitions for a constant'
-  task :definitions, :constant, :directory do |task, args|
+  task :definitions, :constant, :directory, :overwrite do |task, args|
     abort 'You have to specify a constant'  unless args[:constant]
     abort 'You have to specify a directory' unless args[:directory]
 
     generator = RubyLint::DefinitionGenerator.new(
       args[:constant],
       args[:directory],
-      :overwrite => true
+      :overwrite => !!args[:overwrite]
     )
 
     generator.generate
@@ -31,4 +31,42 @@ namespace :generate do
 
     generator.generate
   end
+
+  desc 'Generates definitions for Rails'
+  task :rails do
+    require 'mail'
+    require 'rails/all'
+
+    dir = File.expand_path('../../lib/ruby-lint/definitions/rails', __FILE__)
+
+    constants = [
+      'AbstractController',
+      'ActionController',
+      'ActionDispatch',
+      'ActionMailer',
+      'ActionPack',
+      'ActionView',
+      'ActiveModel',
+      'ActiveRecord',
+      'ActiveSupport',
+      'Arel',
+      'Rails',
+      'Sprockets',
+    ]
+
+    constants.each do |name|
+      constant = Object.const_get(name)
+
+      # Deal with Rails' autoloading nonsense.
+      if constant.respond_to?(:eager_load!)
+        constant.eager_load!
+      end
+
+      Rake::Task['generate:definitions'].execute(
+        :constant  => name,
+        :directory => dir,
+        :overwrite => true
+      )
+    end
+  end
 end

data/task/profile.rake

@@ -0,0 +1,27 @@
+namespace :profile do
+  desc 'Runs debug/profile.rb'
+  task :profile do
+    sh 'ruby debug/profile.rb 2>&1 | less -R -S'
+  end
+
+  desc 'Profiles memory usage'
+  task :memory do
+    ENV['RUBY_PROF_MEASURE_MODE'] = 'memory'
+
+    Rake::Task['profile:profile'].invoke
+  end
+
+  desc 'Profiles object allocations'
+  task :allocations do
+    ENV['RUBY_PROF_MEASURE_MODE'] = 'allocations'
+
+    Rake::Task['profile:profile'].invoke
+  end
+
+  desc 'Profiles process time'
+  task :process do
+    ENV['RUBY_PROF_MEASURE_MODE'] = 'process'
+
+    Rake::Task['profile:profile'].invoke
+  end
+end

data/task/todo.rake

@@ -0,0 +1,6 @@
+desc 'Extracts TODO tags and the likes'
+task :todo do
+  regex = %w{NOTE: FIXME: TODO: THINK: @todo}.join('|')
+
+  sh "ack '#{regex}' lib"
+end

data/task/travis.rake

@@ -0,0 +1,7 @@
+desc 'Runs tests on Travis CI'
+task :travis do
+  ENV['COVERALLS'] = '1'
+  ENV['COVERAGE']  = '1'
+
+  Rake::Task['test'].invoke
+end