rkid 0.1

data/Manifest.txt

@@ -0,0 +1,17 @@
+Manifest.txt
+README.txt
+Rakefile
+TODO
+bin/rkid
+db/schema.rb
+lib/rkid.rb
+lib/rkid/analyzer.rb
+lib/rkid/models.rb
+lib/rkid/rake/task.rb
+rkid.db
+spec/fixtures/test_class.rb
+spec/rkid/analyzer_spec.rb
+spec/rkid/sample.db
+spec/spec_helper.rb
+test.db
+test.html

data/README.txt

@@ -0,0 +1,5 @@
+Rkid is Rcov In Database
+
+Until there is better packaging (see the todo), customize the following line for your needs:
+
+ruby -S bin/rkid "/opt/local/lib/ruby/gems/1.8/gems/rspec-1.1.2/bin/spec" -- "/Users/nkallen/Sites/arel/spec/active_relation/unit/predicates/binary_spec.rb"

data/Rakefile

@@ -0,0 +1,24 @@
+$:.unshift(File.dirname(__FILE__) + "/lib")
+
+require 'rubygems'
+require 'rake'
+require 'hoe'
+require 'activerecord'
+require 'spec/rake/spectask'
+require 'rkid'
+require 'rkid/rake/task'
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Hoe.new('Rkid', Rkid::VERSION) do |p|
+  p.name = "rkid"
+  p.author = "Nick Kallen"
+  p.description = "Rcov in Database"
+  p.email = 'nick@pivotallabs.com'
+  p.summary = "Rcov in Database"
+  p.url = ""
+  p.extra_deps << ['rspec']
+  p.extra_deps << ['rcov']
+end

data/TODO

@@ -0,0 +1,4 @@
+1. Create rake task factory a la Rspec/HOE and/or patch Rspec's factory
+2. Build primitive browser
+3. Improve performance by moving code to C
+4. Fancify browser

data/bin/rkid

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'rkid'
+Rkid.env = 'production'
+
+$ORIGINAL_ARGV = ARGV.clone
+if idx = ARGV.index("--")
+  extra_args = ARGV[idx+1..-1]
+  ARGV.replace(ARGV[0,idx])
+else
+  extra_args = []
+end
+
+at_exit {
+  Rkid::report
+}
+
+pending_scripts = ARGV.clone
+ARGV.replace extra_args
+until pending_scripts.empty?
+  prog = pending_scripts.shift
+  Rkid::prepare
+  load prog
+end

data/db/schema.rb

@@ -0,0 +1,34 @@
+ActiveRecord::Schema.define do
+  create_table :klasses, :force => true do |t|
+    t.string :name
+  end
+  add_index :klasses, :name, :unique => true
+  
+  create_table :methods, :force => true do |t|
+    t.string :name
+    t.integer :klass_id, :defsite_id
+  end
+  add_index :methods, [:klass_id, :name, :defsite_id], :unique => true
+    
+  create_table :files, :force => true do |t|
+    t.string :name
+  end
+  add_index :files, [:name], :unique => true
+    
+  create_table :callsites, :force => true do |t|
+    t.integer :method_id, :count
+  end
+    
+  create_table :frames, :force => true do |t|
+    t.integer :line_id, :callsite_id, :level
+  end
+  add_index :frames, [:line_id, :callsite_id, :level], :unique => true
+    
+  create_table :lines, :force => true do |t|
+    t.integer :times_called, :method_id, :file_id, :number
+    t.boolean :covered
+    t.string :body
+  end
+  add_index :lines, [:file_id, :number], :unique => true
+  
+end

data/lib/rkid.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module Rkid
+  VERSION = '0.1'
+end
+
+require 'rubygems'
+require 'activesupport'
+require 'activerecord'
+require 'rcov'
+require 'sqlite3'
+require 'rbconfig'
+
+require 'rkid/analyzer'
+require 'rkid/models'
+
+Rkid.root = File.join(File.dirname(__FILE__), '..')

data/lib/rkid/analyzer.rb

@@ -0,0 +1,80 @@
+module Rkid
+  mattr_accessor :root, :env, :callsite_analyzer, :coverage_analyzer
+    
+  IGNORE_FILES = [
+    /\A#{Regexp.escape(Pathname.new(Config::CONFIG["libdir"]).cleanpath.to_s)}/,
+    /\btc_[^.]*.rb/,
+    /\bgems\//,
+    /\bvendor\//,
+    /\A#{Regexp.escape(__FILE__)}\z/
+  ]
+  
+  def self.analyze(&block)
+    prepare
+    yield
+    report
+  end
+  
+  def self.prepare
+    self.coverage_analyzer, self.callsite_analyzer = Rcov::CodeCoverageAnalyzer.new, Rcov::CallSiteAnalyzer.new
+    callsite_analyzer.install_hook; coverage_analyzer.install_hook
+  end
+  
+  def self.report
+    callsite_analyzer.remove_hook; coverage_analyzer.remove_hook
+    prepare_connection_to_database
+    analyze_callsite(callsite_analyzer); analyze_coverage(coverage_analyzer)
+  end
+  
+  private
+  
+  def self.prepare_connection_to_database
+    ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :dbfile => 'rkid.db')
+    load ::File.join(root, 'db/schema.rb')
+  end
+  
+  def self.analyze_callsite(callsite_analyzer)
+    total = callsite_analyzer.analyzed_classes.size
+    callsite_analyzer.analyzed_classes.each_with_index do |klass_name, i|
+      puts "Processing class '#{klass_name}', #{i+1} of #{total}"
+      klass = nil
+      
+      callsite_analyzer.methods_for_class(klass_name).each do |method_name|
+        defsite = callsite_analyzer.defsite(klass_method = klass_name + "#" + method_name)
+        next if IGNORE_FILES.any? { |pattern| defsite.file =~ pattern }
+        
+        klass ||= Klass.create('name' => klass_name)
+        defsite_file = File.create('name' => defsite.file)
+        defsite_line = Line.create('file_id' => defsite_file.id, 'number' => defsite.line)
+        method = Method.create(
+          'klass_id' => klass.id,
+          'name' => method_name,
+          'defsite_id' => defsite_line.id
+        )
+        callsite_analyzer.callsites(klass_method).each do |site, count|
+          callsite = Callsite.create('method_id' => method.id, 'count' => count)
+          site.backtrace.each_with_index do |frame, i|
+            file_name = file_name = frame[2]
+            next if IGNORE_FILES.any? { |pattern| file_name =~ pattern }
+
+            file = File.create('name' => file_name)
+            line = Line.create('file_id' => file.id, 'number' => frame[3])
+            Frame.create('callsite_id' => callsite.id, 'line_id' => line.id, 'level' => i)
+          end
+        end
+      end
+    end
+  end
+  
+  def self.analyze_coverage(coverage_analyzer)
+    coverage_analyzer.analyzed_files.each do |file_name|
+      next if IGNORE_FILES.any? { |pattern| file_name =~ pattern }
+      
+      lines, marked, count = coverage_analyzer.data(file_name)
+      lines.each_with_index do |body, i|
+        file = File.create('name' => file_name)
+        line = Line.create('file_id' => file.id, 'number' => i, 'body' => body, 'covered' => marked[i], 'times_called' => count[i])
+      end
+    end
+  end
+end

data/lib/rkid/models.rb

@@ -0,0 +1,94 @@
+module Rkid
+  module FastCreate
+    def db
+      ActiveRecord::Base.connection.raw_connection
+    end
+    
+    def insert(attributes)
+      insert = db.prepare <<-SQL
+        INSERT INTO #{table_name}
+        (#{attributes.keys.join(', ')}) VALUES (#{attributes.keys.collect { |c| ":#{c}" }.join(', ')})
+      SQL
+      insert.execute attributes
+      instantiate(attributes.merge('id' => db.last_insert_row_id))
+    end
+    
+    def create(attributes)
+      begin
+        insert(attributes)
+      rescue SQLite3::SQLException
+        update(attributes)
+      end
+    end
+  end
+  
+  class Klass < ::ActiveRecord::Base
+    extend FastCreate
+    
+    has_many :methods, :class_name => 'Method', :dependent => :destroy
+    
+    def self.update(attributes)
+      find_by_name(attributes['name'])
+    end
+  end
+
+  class Method < ::ActiveRecord::Base
+    extend FastCreate
+
+    belongs_to :klass
+    has_many :callsites, :dependent => :destroy
+    has_many :lines, :dependent => :destroy
+    belongs_to :defsite, :class_name => 'Line'
+    
+    def self.update(attributes)
+      find_by_name_and_klass_id(attributes['name'], attributes['klass_id'])
+    end
+  end
+
+  class File < ::ActiveRecord::Base
+    extend FastCreate
+
+    has_many :lines, :order => :number, :dependent => :destroy
+    
+    def self.update(attributes)
+      find_by_name(attributes['name'])
+    end
+  end
+
+  class Callsite < ::ActiveRecord::Base
+    extend FastCreate
+
+    belongs_to :method
+    has_many :frames, :order => :level, :dependent => :destroy
+    has_many :lines, :through => :frames, :dependent => :destroy
+  end
+
+  class Frame < ::ActiveRecord::Base
+    extend FastCreate
+
+    belongs_to :callsite
+    belongs_to :line
+    belongs_to :callsite
+  end
+
+  class Line < ::ActiveRecord::Base
+    extend FastCreate
+
+    belongs_to :method
+    belongs_to :file
+    
+    def self.update(attributes)
+      line = find_by_number_and_file_id(attributes['number'], attributes['file_id'])
+      assignments = attributes.keys.collect do |key|
+        "#{key} = :#{key}"
+      end.join ', '
+      update = db.prepare <<-SQL
+        UPDATE #{table_name} SET
+        #{assignments}
+        WHERE id = :id
+      SQL
+      update.execute attributes.except('covered').merge('id' => line.id)
+      line
+    end
+  end
+end

data/lib/rkid/rake/task.rb

@@ -0,0 +1,16 @@
+require 'rake'
+require 'rake/tasklib'
+
+module Rkid
+  class Task < Rake::TaskLib
+    def initialize
+      desc "Run specs with rkid"
+      task :rkid do
+        rkid_script = ::File.expand_path(::File.dirname(__FILE__) + '/../../../bin/rkid')
+        specs = FileList['spec/**/*_spec.rb'].collect { |fn| %["#{fn}"] }.join(' ')
+        
+        system %(ruby #{rkid_script} `which spec` -- #{specs})
+      end
+    end
+  end
+end

data/spec/fixtures/test_class.rb

@@ -0,0 +1,9 @@
+class TestedClass
+  def tested_method
+    'tested_method'
+  end
+  
+  def untested_method
+    'untested_method'
+  end
+end

data/spec/rkid/analyzer_spec.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Rkid do
+  
+  before(:all) do
+    require 'spec/fixtures/test_class.rb'
+    Rkid.env = 'test'
+    Rkid.analyze { TestedClass.new.tested_method }
+  end
+  
+  describe '::analyze' do
+    before do
+      @file = Rkid::File.find_by_name("./spec/fixtures/test_class.rb")
+    end
+    
+    it 'records classes and methods' do
+      methods = Rkid::Klass.find_by_name('TestedClass').methods
+      methods.find_by_name('tested_method').should_not be_nil
+      methods.find_by_name('untested_method').should be_nil
+    end
+  
+    it 'records callsites of methods' do
+      method = Rkid::Klass.find_by_name('TestedClass').methods.find_by_name('tested_method')
+      callsite = method.callsites.first
+      callsite.count.should == 1
+      callsite.frames.first.line.number.should == 8
+      callsite.frames.first.line.file.name.should == "./spec/rkid/analyzer_spec.rb"
+    end
+
+    it 'records the source of parsed files' do
+      @file.lines.first.body.should == File.open("./spec/fixtures/test_class.rb").readline
+    end
+    
+    it 'indicates whether lines are covered' do
+      @file.lines.first.should_not be_covered
+      @file.lines[1].should be_covered
+      @file.lines[-1].should_not be_covered
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift "#{dir}/../lib"
+
+require 'rubygems'
+require 'spec'
+require 'pp'
+require 'rkid'
+Dir["#{dir}/matchers/*"].each { |m| require "#{dir}/matchers/#{File.basename(m)}" }
+
+Spec::Runner.configure do |config|  
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: rkid
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2008-03-31 00:00:00 -07:00
+summary: Rcov in Database
+require_paths: 
+- lib
+email: nick@pivotallabs.com
+homepage: 
+rubyforge_project: rkid
+description: Rcov in Database
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Nick Kallen
+files: 
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO
+- bin/rkid
+- db/schema.rb
+- lib/rkid.rb
+- lib/rkid/analyzer.rb
+- lib/rkid/models.rb
+- lib/rkid/rake/task.rb
+- rkid.db
+- spec/fixtures/test_class.rb
+- spec/rkid/analyzer_spec.rb
+- spec/rkid/sample.db
+- spec/spec_helper.rb
+- test.db
+- test.html
+test_files: []
+
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- Manifest.txt
+- README.txt
+executables: 
+- rkid
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: