rkid 0.1 → 0.1.1

data/README.txt

@@ -1,5 +1,58 @@
 Rkid is Rcov In Database
 
-Until there is better packaging (see the todo), customize the following line for your needs:
+WHAT
 
-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"
+Rkid is a tool to surface RCov coverage and callsite data in a relational database. It also provides a friendly ActiveRecord model so you can easily query the data.
+
+WHY
+
+I want to ask questions of my codebase:
+
+* What classes are abstract?
+* Who calls method #x?
+* What coverage does this little unit test have?
+* What classes of objects are passed into #x?
+* What classes does class A collaborate with?
+  * which collaborators are manufactured by class A?
+  * which collaborators in injected into class A?
+  * what implicit interfaces/protocols does A rely on?
+* What implicit interfaces exist in my system (e.g., methods in different class hierarchies invoked from the same callsites)
+* etc.
+
+My ultimate goal is to produce a rich code browser along the lines of the Smalltalk browsers. This should also have wiki-like functionality for adding marginalia to code.
+
+WARNING
+
+Rkid provides a rake task to run your spec suite with rcov turned on. Unlike *normal* rake spec:rcov, I turn on the callsite information. This is the data the illustrates, e.g., who calls what methods; what lines of code one individual test covers; and so forth.
+
+Please note that Rkid is slow. But don't complain: I've optimized from 16 hours down to 1.5 minutes on a sample project. But don't get too excited: because the sample project normally runs 300 specs in 3 seconds. Rkid is currently too slow to run on a Rails app. Don't even bother trying unless you're developing on a Cray.
+
+DEPENDENCIES
+
+* Rspec-based test suite
+* Sqlite3
+
+USAGE
+
+Install the gem from rubyforge
+
+   gem install rkid
+
+Add these lines to your rakefile:
+
+    require 'rkid/rake/task'
+    Rkid::Task.new
+    
+Then, execute this on the command line:
+
+    rake rkid
+
+Finally, Query the data like this:
+
+    require 'rubygems'
+    require 'activerecord'
+    require 'rkid'
+    ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :dbfile => 'rkid.db')
+    Rkid::Klass.find(:all)
+
+And so forth.

data/Rakefile

@@ -19,6 +19,5 @@ Hoe.new('Rkid', Rkid::VERSION) do |p|
   p.email = 'nick@pivotallabs.com'
   p.summary = "Rcov in Database"
   p.url = ""
-  p.extra_deps << ['rspec']
-  p.extra_deps << ['rcov']
+  p.extra_deps += [['rspec'], ['rcov'], ['activerecord']]
 end

data/TODO

@@ -1,4 +1,3 @@
-1. Create rake task factory a la Rspec/HOE and/or patch Rspec's factory
+1. Improve performance by moving code to C. Ignore files are important in the data collecting phase.
 2. Build primitive browser
-3. Improve performance by moving code to C
 4. Fancify browser

data/bin/rkid

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'rkid'
-Rkid.env = 'production'
 
 $ORIGINAL_ARGV = ARGV.clone
 if idx = ARGV.index("--")

data/lib/rkid.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 module Rkid
-  VERSION = '0.1'
+  VERSION = '0.1.1'
 end
 
 require 'rubygems'

data/lib/rkid/analyzer.rb

@@ -1,18 +1,8 @@
 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/
-  ]
+  mattr_accessor :root, :callsite_analyzer, :coverage_analyzer
   
   def self.analyze(&block)
-    prepare
-    yield
-    report
+    prepare; yield; report
   end
   
   def self.prepare
@@ -24,57 +14,89 @@ module Rkid
     callsite_analyzer.remove_hook; coverage_analyzer.remove_hook
     prepare_connection_to_database
     analyze_callsite(callsite_analyzer); analyze_coverage(coverage_analyzer)
+    close_connection_to_database
   end
   
   private
   
-  def self.prepare_connection_to_database
-    ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :dbfile => 'rkid.db')
-    load ::File.join(root, 'db/schema.rb')
+  module Database    
+    def prepare_connection_to_database
+      ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :dbfile => 'rkid.db')
+      load ::File.join(root, 'db/schema.rb')
+      ActiveRecord::Base.connection.raw_connection.transaction
+    end
+  
+    def close_connection_to_database
+      ActiveRecord::Base.connection.raw_connection.commit
+    end
   end
+  extend Database
   
-  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
+  module Analyze
+    IGNORE_FILES = [
+      /\A#{Regexp.escape(Pathname.new(Config::CONFIG["libdir"]).cleanpath.to_s)}/,
+      /\btc_[^.]*.rb/,
+      /\bgems\//,
+      /\bvendor\//,
+      /\A#{Regexp.escape(__FILE__)}\z/
+    ]
+    
+    def 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 }
+        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)
+          klass ||= Klass.create('name' => klass_name)
+          line = lines[[defsite.file, defsite.line]]
+          method = Method.create(
+            'klass_id' => klass.id,
+            'name' => method_name,
+            'defsite_id' => line.id
+          )
+          callsite_analyzer.callsites(klass_method).each do |site, count|
+            callsite = nil
+            site.backtrace.each_with_index do |frame, i|
+              file_name = frame[2]
+              next if IGNORE_FILES.any? { |pattern| file_name =~ pattern }
+            
+              callsite ||= Callsite.create('method_id' => method.id, 'count' => count)
+              line = lines[[file_name, number = frame[3]]]
+              Frame.create('callsite_id' => callsite.id, 'line_id' => line.id, 'level' => i)
+            end
           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 }
+    def 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])
+        lines_in_file, marked, count = coverage_analyzer.data(file_name)
+        lines_in_file.each_with_index do |body, i|
+          Line.update(lines[[file_name, i]], 'body' => body, 'covered' => marked[i], 'times_called' => count[i])
+        end
+      end
+    end
+    
+    private
+    
+    def lines
+      @lines ||= Hash.new do |h, (file_name, number)|
+        h[[file_name, number]] = Line.create('file_id' => files[file_name].id, 'number' => number)
+      end
+    end
+
+    def files
+      @files ||= Hash.new do |h, file_name|
+        h[file_name] = File.create('name' => file_name)
       end
     end
   end
+  extend Analyze
 end

data/lib/rkid/models.rb

@@ -4,7 +4,7 @@ module Rkid
       ActiveRecord::Base.connection.raw_connection
     end
     
-    def insert(attributes)
+    def create(attributes)
       insert = db.prepare <<-SQL
         INSERT INTO #{table_name}
         (#{attributes.keys.join(', ')}) VALUES (#{attributes.keys.collect { |c| ":#{c}" }.join(', ')})
@@ -12,24 +12,12 @@ module Rkid
       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
@@ -39,10 +27,6 @@ module Rkid
     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
@@ -68,7 +52,6 @@ module Rkid
 
     belongs_to :callsite
     belongs_to :line
-    belongs_to :callsite
   end
 
   class Line < ::ActiveRecord::Base
@@ -77,8 +60,7 @@ module Rkid
     belongs_to :method
     belongs_to :file
     
-    def self.update(attributes)
-      line = find_by_number_and_file_id(attributes['number'], attributes['file_id'])
+    def self.update(line, attributes)
       assignments = attributes.keys.collect do |key|
         "#{key} = :#{key}"
       end.join ', '
@@ -87,7 +69,8 @@ module Rkid
         #{assignments}
         WHERE id = :id
       SQL
-      update.execute attributes.except('covered').merge('id' => line.id)
+      update.execute attributes.merge('id' => line.id)
+      line.attributes = attributes
       line
     end
   end

data/spec/rkid/analyzer_spec.rb

@@ -4,7 +4,6 @@ describe Rkid do
   
   before(:all) do
     require 'spec/fixtures/test_class.rb'
-    Rkid.env = 'test'
     Rkid.analyze { TestedClass.new.tested_method }
   end
   
@@ -23,7 +22,7 @@ describe Rkid 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.number.should == File.open(__FILE__).readlines.index("    Rkid.analyze { TestedClass.new.tested_method }\n") + 1
       callsite.frames.first.line.file.name.should == "./spec/rkid/analyzer_spec.rb"
     end
 

metadata

@@ -3,8 +3,8 @@ 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
+  version: 0.1.1
+date: 2008-04-05 00:00:00 -07:00
 summary: Rcov in Database
 require_paths: 
 - lib
@@ -79,6 +79,15 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  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: