rubydeps 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Daniel Cadenas
+
+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.

data/README.md

@@ -0,0 +1,68 @@
+rubydeps
+========
+
+A tool to create class dependency graphs from test suites
+
+Command line usage
+------------------
+
+
+Rubydeps will run your test suite to record the call graph of your project and use it to create a dot graph.
+
+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
+or
+    rubydeps rspec --path-filter='activemodel/lib' # to run RSpec tests
+or
+    rubydeps rspec2 --path-filter='activemodel/lib' # 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.:
+
+    dot -Tsvg rubydeps.dot > rubydeps.svg
+
+
+Library usage
+-------------
+
+Just require rubydeps and pass a block to analyze to the dot_for method.
+
+    Rubydeps.dot_for(path_filter_regexp) do
+      //your code goes here
+    end
+
+Sample output
+-------------
+
+This is the result of running rubydeps on the [Mechanize](http://github.com/tenderlove/mechanize) tests:
+
+![Mechanize dependencies](https://github.com/dcadenas/rubydeps/raw/master/mechanize-deps.png)
+
+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.
+
+Dependencies
+------------
+
+* rcov
+* graphviz
+* ruby-graphviz
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2010 Daniel Cadenas. See LICENSE for details.
+
+Development sponsored by [Cubox](http://www.cuboxsa.com)

data/bin/rubydeps

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+require 'rubydeps'
+require 'thor'
+
+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
+    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
+        ::Test::Unit::AutoRunner.run
+      end
+    end
+
+    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
+    def rspec
+      require 'spec'
+
+      p = ::Spec::Runner::OptionParser.new($stderr, $stdout)
+      p.parse(Dir["./spec/**/*_spec.rb"])
+      op = p.options
+
+      ARGV.clear
+      Rubydeps.dot_for(Regexp.new(options[:path_filter])) 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
+    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
+        ::RSpec::Core::CommandLine.new(op).run($stderr, $stdout)
+      end
+    end
+  end
+end
+
+Rubydeps::Runner.start(ARGV)
+

data/lib/rubydeps.rb

@@ -0,0 +1,92 @@
+require 'graphviz'
+require 'set'
+require 'rcovrt'
+require 'rcov'
+
+module Rubydeps
+  def self.dot_for(path_filter = /.*/, &block_to_analyze)
+    dependencies_hash = hash_for(path_filter, &block_to_analyze)
+
+    if dependencies_hash
+      g = GraphViz::new( "G", :use => 'dot', :mode => 'major', :rankdir => 'LR', :concentrate => 'true', :fontname => 'Arial')
+      dependencies_hash.each do |k,vs|
+        if !k.empty? && !vs.empty?
+          n1 = g.add_node(k.to_s)
+          if vs.respond_to?(:each)
+            vs.each do |v|
+              unless v.empty?
+                n2 = g.add_node(v.to_s)
+                g.add_edge(n2, n1)
+              end
+            end
+          end
+        end
+      end
+
+      g.output( :dot => "rubydeps.dot" )
+    end
+  end
+
+  def self.hash_for(path_filter = /.*/, &block_to_analyze)
+    analyzer = Rcov::CallSiteAnalyzer.new
+    analyzer.run_hooked do
+      block_to_analyze.call
+    end
+
+    dependency_hash = create_dependency_hash(analyzer, path_filter)
+    clean_hash(dependency_hash)
+  end
+
+private
+  def self.path_filtered_site?(code_site, path_filter)
+    code_site && path_filter =~ File.expand_path(code_site.file)
+  end
+
+  #we build a hash structured in this way: {"called_class_name1" => ["calling_class_name1", "calling_class_name2"], "called_class_name2" => ...}
+  def self.create_dependency_hash(analyzer, path_filter)
+    dependency_hash = {}
+    analyzer.analyzed_classes.each do |c|
+      called_class_name = normalize_class_name(c)
+      analyzer.methods_for_class(c).each do |m|
+        called_class_method = "#{c}##{m}"
+        def_site = analyzer.defsite(called_class_method)
+        if path_filtered_site?(def_site, path_filter)
+          calling_class_names = []
+          analyzer.callsites(called_class_method).each do |call_site, _|
+            if path_filtered_site?(call_site, path_filter)
+              calling_class = call_site.calling_class
+              calling_class_name = normalize_class_name(calling_class.to_s)
+              calling_class_names << calling_class_name
+            end
+          end
+          dependency_hash[called_class_name] ||= []
+          dependency_hash[called_class_name] += calling_class_names
+        end
+      end
+    end
+
+    dependency_hash
+  end
+
+  def self.clean_hash(dependency_hash)
+    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 }
+        cleaned_hash.delete(called_class_name) if cleaned_hash[called_class_name].empty?
+      end
+    end
+
+    cleaned_hash
+  end
+
+  def self.interesting_class_name(class_name)
+    !class_name.empty? && class_name != "Rcov::CallSiteAnalyzer" && class_name != "Rcov::DifferentialAnalyzer"
+  end
+
+  def self.normalize_class_name(klass)
+    good_class_name = klass.gsub(/#<Class:(.+)>/, '\1')
+    good_class_name.gsub!(/\([^\)]*\)/, "")
+    good_class_name.gsub(/0x[\da-fA-F]+/, '(hex number)')
+  end
+end

data/spec/rubydeps_spec.rb

@@ -0,0 +1,89 @@
+#require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'file_test_helper'
+
+class Grandparent
+  def self.class_method
+  end
+
+  def instance_method
+  end
+end
+
+class Parent
+  def self.class_method
+    Grandparent.class_method
+  end
+
+  def instance_method
+  end
+end
+
+class Son
+  def self.class_method
+    parent = Parent.new
+    parent.instance_method
+    parent.instance_method
+    class_method2
+    class_method2
+  end
+
+  def self.class_method2
+  end
+
+  def instance_method
+    Parent.class_method
+    Grandparent.class_method
+  end
+end
+
+describe "Rubydeps" do
+  include FileTestHelper
+  it "should show the class level dependencies" do
+    dependencies = Rubydeps.hash_for do
+      class IHaveAClassLevelDependency
+        Son.class_method
+      end
+    end
+
+    dependencies.should == {"Parent"=>["Son"]}
+  end
+
+  it "should create a dot file" do
+    with_files do
+      dependencies = Rubydeps.dot_for do
+        class IHaveAClassLevelDependency
+          Son.class_method
+        end
+      end
+
+      File.read("rubydeps.dot").should match("digraph G")
+    end
+  end
+
+  it "should be idempotent" do
+    Rubydeps.hash_for do
+      class IHaveAClassLevelDependency
+        Son.class_method
+      end
+    end
+
+    dependencies = Rubydeps.hash_for do
+      class IHaveAClassLevelDependency
+        Son.class_method
+      end
+    end
+
+    dependencies.should == {"Parent"=>["Son"]}
+  end
+
+  it "should show the dependencies between the classes inside the block" do
+    dependencies = Rubydeps.hash_for do
+      Son.class_method
+      Son.new.instance_method
+    end
+
+    dependencies.keys.should =~ ["Parent", "Grandparent"]
+    dependencies["Parent"].should == ["Son"]
+    dependencies["Grandparent"].should =~ ["Son", "Parent"]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubydeps'
+require 'rspec'
+require 'rspec/autorun'
+
+Rspec.configure do |config|
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: rubydeps
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Cadenas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-28 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 2
+        - 5
+        - 1
+        version: 2.5.1
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: file_test_helper
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-graphviz
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        - 17
+        version: 0.9.17
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 0
+        - 14
+        - 2
+        version: 0.14.2
+  type: :runtime
+  version_requirements: *id005
+description: Graphs ruby dependencies
+email: dcadenas@gmail.com
+executables: 
+- rubydeps
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- bin/rubydeps
+- lib/rubydeps.rb
+- spec/rubydeps_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/dcadenas/rubydeps
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Graphs ruby depencencies
+test_files: 
+- spec/rubydeps_spec.rb
+- spec/spec_helper.rb