rubydeps 0.1.0 → 0.2.0

data/README.md

@@ -12,24 +12,30 @@ Rubydeps will run your test suite to record the call graph of your project and u
 First of all, be sure to step into the root directory of your project, rubydeps searches for ./spec or ./test dirs from there.
 For example, if we want to graph the Rails activemodel dependency graph we'd cd to rails/activemodel and from there we'd write:
 
-    rubydeps testunit --path-filter='activemodel/lib' # to run Test::Unit tests
+    rubydeps testunit #to run Test::Unit tests
 or
-    rubydeps rspec --path-filter='activemodel/lib' # to run RSpec tests
+    rubydeps rspec #to run RSpec tests
 or
-    rubydeps rspec2 --path-filter='activemodel/lib' # to run RSpec 2 tests
+    rubydeps rspec2 #to run RSpec 2 tests
 
-This will output a rubydeps.dot. The --path-filter option specifies a regexp that matches the path of the files you are interested in analyzing. For example you could have filters like 'project_name/app|project_name/lib' to analyze only code that is located in the 'app' and 'lib' dirs or as an alternative you could just exclude some directory you are not interested using a negative regexp like 'project_name(?!.*test)'
-You can convert the dot file to any image format you like using the dot utility that comes with the graphviz installation e.g.:
+This will output a rubydeps.dot. You can convert the dot file to any image format you like using the dot utility that comes with the graphviz installation e.g.:
 
     dot -Tsvg rubydeps.dot > rubydeps.svg
 
+### Command line options
+
+The --path-filter option specifies a regexp that matches the path of the files you are interested in analyzing. For example you could have filters like 'project_name/app|project_name/lib' to analyze only code that is located in the 'app' and 'lib' dirs or as an alternative you could just exclude some directory you are not interested using a negative regexp like 'project_name(?!.*test)'
+
+The --class_name_filter option is similar to the --path_filter options except that the regexp is matched against the class names (i.e. graph node names).
 
 Library usage
 -------------
 
 Just require rubydeps and pass a block to analyze to the dot_for method.
 
-    Rubydeps.dot_for(path_filter_regexp) do
+    require 'rubydeps'
+
+    Rubydeps.dot_for(:path_filter => path_filter_regexp, :class_name_filter) do
       //your code goes here
     end
 
@@ -42,6 +48,11 @@ This is the result of running rubydeps on the [Mechanize](http://github.com/tend
 
 Notice that sometimes you may have missing dependencies as we graph the dependencies exercised by your tests so it's a quick bird's eye view to check your project coverage.
 
+Installation
+------------
+
+    gem install rubydeps
+
 Dependencies
 ------------
 

data/bin/rubydeps

@@ -6,13 +6,13 @@ module Rubydeps
   class Runner < Thor
     desc "testunit", "Create the dependency graph after runnning the testunit tests"
     method_option :path_filter, :type => :string, :default => `pwd`.chomp, :required => true
+    method_option :class_name_filter, :type => :string, :default => '', :required => true
     def testunit
       require 'test/unit'
 
       (Dir["./test/**/*_test.rb"] + Dir["./test/**/test_*.rb"]).each { |f| load f unless f =~ /^-/  }
 
-      ARGV.clear
-      Rubydeps.dot_for(Regexp.new(options[:path_filter])) do
+      create_dependencies_dot_for(options) do
         ::Test::Unit::AutoRunner.run
       end
     end
@@ -20,6 +20,7 @@ module Rubydeps
     desc "rspec", "Create the dependency graph after runnning the rspec tests"
     #TODO: this breaks when using underscores, investigate
     method_option :path_filter, :type => :string, :default => `pwd`.chomp, :required => true
+    method_option :class_name_filter, :type => :string, :default => '', :required => true
     def rspec
       require 'spec'
 
@@ -27,25 +28,33 @@ module Rubydeps
       p.parse(Dir["./spec/**/*_spec.rb"])
       op = p.options
 
-      ARGV.clear
-      Rubydeps.dot_for(Regexp.new(options[:path_filter])) do
+      create_dependencies_dot_for(options) do
         ::Spec::Runner::CommandLine.run(op)
       end
     end
 
     desc "rspec2", "Create the dependency graph after runnning the rspec 2 tests"
     method_option :path_filter, :type => :string, :default => `pwd`.chomp, :required => true
+    method_option :class_name_filter, :type => :string, :default => '', :required => true
     def rspec2
       require 'rspec'
 
       op = ::RSpec::Core::ConfigurationOptions.new(Dir["./spec/**/*_spec.rb"])
       op.parse_options
 
-      ARGV.clear
-      Rubydeps.dot_for(Regexp.new(options[:path_filter])) do
+      create_dependencies_dot_for(options) do
         ::RSpec::Core::CommandLine.new(op).run($stderr, $stdout)
       end
     end
+
+    private 
+
+    def create_dependencies_dot_for(options)
+      ARGV.clear
+      Rubydeps.dot_for(:path_filter => Regexp.new(options[:path_filter]), :class_name_filter => Regexp.new(options[:class_name_filter])) do
+        yield
+      end
+    end
   end
 end
 

data/lib/rubydeps.rb

@@ -4,8 +4,8 @@ require 'rcovrt'
 require 'rcov'
 
 module Rubydeps
-  def self.dot_for(path_filter = /.*/, &block_to_analyze)
-    dependencies_hash = hash_for(path_filter, &block_to_analyze)
+  def self.dot_for(options = {}, &block_to_analyze)
+    dependencies_hash = hash_for(options, &block_to_analyze)
 
     if dependencies_hash
       g = GraphViz::new( "G", :use => 'dot', :mode => 'major', :rankdir => 'LR', :concentrate => 'true', :fontname => 'Arial')
@@ -27,14 +27,17 @@ module Rubydeps
     end
   end
 
-  def self.hash_for(path_filter = /.*/, &block_to_analyze)
+  def self.hash_for(options = {}, &block_to_analyze)
     analyzer = Rcov::CallSiteAnalyzer.new
     analyzer.run_hooked do
       block_to_analyze.call
     end
 
+    path_filter = options.fetch(:path_filter, /.*/)
+    class_name_filter = options.fetch(:class_name_filter, /.*/)
+
     dependency_hash = create_dependency_hash(analyzer, path_filter)
-    clean_hash(dependency_hash)
+    clean_hash(dependency_hash, class_name_filter)
   end
 
 private
@@ -43,6 +46,7 @@ private
   end
 
   #we build a hash structured in this way: {"called_class_name1" => ["calling_class_name1", "calling_class_name2"], "called_class_name2" => ...}
+  #TODO: want moar love here
   def self.create_dependency_hash(analyzer, path_filter)
     dependency_hash = {}
     analyzer.analyzed_classes.each do |c|
@@ -51,7 +55,7 @@ private
         called_class_method = "#{c}##{m}"
         def_site = analyzer.defsite(called_class_method)
         if path_filtered_site?(def_site, path_filter)
-          calling_class_names = []
+          calling_class_names = Set.new
           analyzer.callsites(called_class_method).each do |call_site, _|
             if path_filtered_site?(call_site, path_filter)
               calling_class = call_site.calling_class
@@ -59,7 +63,7 @@ private
               calling_class_names << calling_class_name
             end
           end
-          dependency_hash[called_class_name] ||= []
+          dependency_hash[called_class_name] ||= Set.new
           dependency_hash[called_class_name] += calling_class_names
         end
       end
@@ -68,11 +72,15 @@ private
     dependency_hash
   end
 
-  def self.clean_hash(dependency_hash)
+  def self.clean_hash(dependency_hash, class_name_filter)
     cleaned_hash = {}
     dependency_hash.each do |called_class_name, calling_class_names|
-      if interesting_class_name(called_class_name) && !dependency_hash[called_class_name].empty?
-        cleaned_hash[called_class_name] = calling_class_names.compact.uniq.select{|c| interesting_class_name(c) && c != called_class_name }
+      if interesting_class_name(called_class_name) && !dependency_hash[called_class_name].empty? && called_class_name =~ class_name_filter
+        cleaned_hash[called_class_name] = (calling_class_names - [nil]).select do |c|
+          interesting_class_name(c) &&
+          c != called_class_name &&
+          c =~ class_name_filter
+        end
         cleaned_hash.delete(called_class_name) if cleaned_hash[called_class_name].empty?
       end
     end

data/spec/rubydeps_spec.rb

@@ -1,4 +1,3 @@
-#require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'file_test_helper'
 
 class Grandparent
@@ -86,4 +85,53 @@ describe "Rubydeps" do
     dependencies["Parent"].should == ["Son"]
     dependencies["Grandparent"].should =~ ["Son", "Parent"]
   end
+
+  sample_dir_structure = {'path1/class_a.rb' => <<-CLASSA,
+                             require 'path1/class_b'
+                             require 'path2/class_c'
+                             class A
+                               def depend_on_b_and_c
+                                 B.new.b
+                                 C.new.c
+                               end
+                             end
+                           CLASSA
+                           'path1/class_b.rb' => 'class B; def b; end end',
+                           'path2/class_c.rb' => 'class C; def c; end end'}
+
+  it "should not filter classes when no filter is specified" do
+    with_files(sample_dir_structure) do
+      load 'path1/class_a.rb'
+
+      dependencies = Rubydeps.hash_for do
+        A.new.depend_on_b_and_c
+      end
+
+      dependencies.should == {"B"=>["A"], "C"=>["A"]}
+    end
+  end
+
+  it "should filter classes when a path filter is specified" do
+    with_files(sample_dir_structure) do
+      load 'path1/class_a.rb'
+
+      dependencies = Rubydeps.hash_for(:path_filter => /path1/) do
+        A.new.depend_on_b_and_c
+      end
+
+      dependencies.should == {"B"=>["A"]}
+    end
+  end
+
+  it "should filter classes when a class name filter is specified" do
+    with_files(sample_dir_structure) do
+      load 'path1/class_a.rb'
+
+      dependencies = Rubydeps.hash_for(:class_name_filter => /C|A/) do
+        A.new.depend_on_b_and_c
+      end
+
+      dependencies.should == {"C"=>["A"]}
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rubydeps
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Daniel Cadenas