callgrapher 0.0.1 → 0.0.2

data/README.md

@@ -10,9 +10,9 @@ Ruby 1.9 or later & Graphviz on your $PATH
 
 Usage
 -----
-Require 'callgrapher' and call trace_class_dependencies, passing in a block
+Require `callgrapher` and call `trace_class_dependencies`, passing in a block
 containing the code you want to graph. A Hash of sets will be returned, ready
-for proccesing with make_class_graph. Calling make_class_graph uses the `dot`
+for procesing with make_class_graph. Calling `make_class_graph` uses the `dot`
 command to generate a graph & save it to /tmp/graph.png.
 
 Known Limitations

data/lib/callgrapher.rb

@@ -13,24 +13,20 @@
 #  You should have received a copy of the GNU General Public License
 #  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-# This is the main executable for the whysynth-controller project. It also
-# contains most of the code that relies on external libraries. 
-
 require 'set'
 
 module CallGrapher
 
   # @param [Array<String>] file_whitelist
   #   Only include classes defined in these files.
-  # @param [Integer] namespace_depth 
-  #   The number of namespaces to report. For example, a class name of
-  #   Foo::Bar::Baz, when processed with namespace_depth == 1, would be reported
-  #   as just Foo.  With namespace_depth == 2, as Foo::Bar, and so on. A
-  #   namespace_depth of 0 indicates that the entire class name should be
-  #   reported.
-  def self.trace_class_dependencies(namespace_depth = 0,
-                                    file_whitelist = nil,
-                                    class_blacklist = nil)
+  # @param [Array<String>] class_blacklist
+  #   Don't include these classes.
+  # @param [Proc] class_name_processor
+  #   A Proc that takes a single argument (a fully qualified classname) and
+  #   returns the class as it should be shown in the graph.
+  def self.trace_class_dependencies(file_whitelist = nil,
+                                    class_blacklist = nil,
+                                    class_name_processor = lambda{|x| x})
     callstack = []
     classgraph = Hash.new{ |hash, key| hash[key] = Set.new }
 
@@ -40,14 +36,7 @@ module CallGrapher
       case event
         when 'call'
           caller = callstack[-1]
-
-          klass =
-            if namespace_depth > 0
-              klass.name.split('::').first(namespace_depth).join('::')
-            else
-              klass.name
-            end
-
+          klass = class_name_processor.call klass.name
           classgraph[caller].add klass if caller && caller != klass
           callstack.push klass
         when 'return'

data/test/test.rb

@@ -115,31 +115,42 @@ class Test < MiniTest::Unit::TestCase
   EmptyHash = {}
 
   def test_class_dependency_tracing
-    assert_equal ExpectedTestGraph, CallGrapher.trace_class_dependencies{ Class1.new.test }
+    assert_equal ExpectedTestGraph,
+                 CallGrapher.trace_class_dependencies{ Class1.new.test }
   end
 
   def test_graphviz_output
-    assert_equal ExpectedGraphvizGraph, CallGrapher.make_graphviz_graph(ExpectedTestGraph)
+    assert_equal ExpectedGraphvizGraph,
+                 CallGrapher.make_graphviz_graph(ExpectedTestGraph)
   end
 
   def test_file_whitelist
     assert_equal EmptyHash,
-                 CallGrapher.trace_class_dependencies(0, []){ Class1.new.test }
+                 CallGrapher.trace_class_dependencies([]){ Class1.new.test }
 
     assert_equal ExpectedTestGraph,
-                 CallGrapher.trace_class_dependencies(0, [__FILE__]) { Class1.new.test}
+                 CallGrapher.trace_class_dependencies([__FILE__]) { Class1.new.test}
   end
 
-  def test_namespace_depth
-    assert_equal ExpectedTestGraph_NamespaceDepth1,
-                 CallGrapher.trace_class_dependencies(1) { Class1.new.test }
-
-    assert_equal ExpectedTestGraph_NamespaceDepth2,
-                 CallGrapher.trace_class_dependencies(2) { Class1.new.test }
+  def test_class_name_processing
+    first_namespace = lambda { |name| name.split('::').first }
+    graph = CallGrapher.trace_class_dependencies(nil,nil,first_namespace) {
+      Class1.new.test 
+    }
+    assert_equal ExpectedTestGraph_NamespaceDepth1, graph
+
+    first_two_namespaces = lambda { |name| name.split('::').first(2).join('::') }
+    graph2 = CallGrapher.trace_class_dependencies(nil, nil, first_two_namespaces) {
+      Class1.new.test
+    }
+    assert_equal ExpectedTestGraph_NamespaceDepth2, graph2
   end
 
   def test_class_blacklist
-    assert_equal ExpectedTestGraph_WithoutClass4, CallGrapher.trace_class_dependencies(0, [__FILE__], ['Class4']) { Class1.new.test }
+    assert_equal ExpectedTestGraph_WithoutClass4,
+                 CallGrapher.trace_class_dependencies([__FILE__], ['Class4']) {
+                   Class1.new.test
+                 }
   end
 
   # This test doesn't assert anything, it's just convenient to have the tests

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: callgrapher
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-02 00:00:00.000000000 Z
+date: 2012-10-17 00:00:00.000000000 Z
 dependencies: []
 description: Produce a call graph graph by tracing the method calls of running code.
   The output is a .dot file for use with GraphViz