cognitive_distance 0.0.1.pre

data/spec/cognitive_distance/measurements_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe CognitiveDistance::Measurements do
+  class SuckySuckSucks
+    class << self
+      attr_reader :lameness_args
+      def lameness *args
+        @lameness_args = args
+      end
+    end
+  end
+  
+  it "registers a measurement" do
+    CognitiveDistance::Measurements.register_measurement SuckySuckSucks, :lameness, :beefcake
+    CognitiveDistance::Measurements.measure_beefcake :x, :y, :z
+    SuckySuckSucks.lameness_args.must_equal [:x, :y, :z]
+  end
+end
+

data/spec/cognitive_distance/presenters/graph_to_dot_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe CognitiveDistance::Presenters::GraphToDot do
+  before do
+    @presenter = CognitiveDistance::Presenters::GraphToDot.new
+    @graph = CognitiveDistance::Structures::Graph.new
+    @graph.link :a, :b, :c
+    @graph.link :b, :c
+  end
+
+  it "converts a graph to dot format" do
+    dotted = @presenter.present @graph
+    dotted.must_equal "digraph \"graphname\" {\n\"a\" -> \"b\";\n\"a\" -> \"c\";\n\"b\" -> \"c\";\n}"
+  end
+
+  it "names the graph" do
+    dotted = @presenter.present @graph, "MyGraph"
+    dotted.must_equal "digraph \"MyGraph\" {\n\"a\" -> \"b\";\n\"a\" -> \"c\";\n\"b\" -> \"c\";\n}"
+  end
+
+  it "uses a block to map nodes to names" do
+    dotted = @presenter.present(@graph, "Blocked!") { |v| "Node #{v}" }
+    dotted.must_equal "digraph \"Blocked!\" {\n\"Node a\" -> \"Node b\";\n\"Node a\" -> \"Node c\";\n\"Node b\" -> \"Node c\";\n}"
+  end
+end
+

data/spec/cognitive_distance/structures/call_node_root_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe CognitiveDistance::Structures::CallNodeRoot do
+  before do
+    @node = CognitiveDistance::Structures::CallNodeRoot.new
+  end
+
+  it "should always return itself on pop!" do
+    @node.pop!.must_equal @node
+  end
+
+  it "should not have a context" do
+    @node.context.is_a?(CognitiveDistance::Structures::MissingCallContext).must_equal true
+  end
+
+  it "should not yield itself when enumerating" do
+    @node.inject(false) { |found, n|
+      found || n.equal?(@node)
+    }.must_equal false
+  end
+
+  it "should not include itself when converting to an array" do
+    c1 = @node.push! 1, nil, nil, nil, nil
+    c2 = @node.push! 2, nil, nil, nil, nil
+    @node.to_a.must_equal [
+      [c1, [] ],
+      [c2, [] ]
+    ]
+  end
+end
+

data/spec/cognitive_distance/structures/call_node_spec.rb

@@ -0,0 +1,91 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe CognitiveDistance::Structures::CallNode do
+  before do
+    @parent = Object.new
+    @node = CognitiveDistance::Structures::CallNode.new(@parent)
+    @node.trace_class = 0
+  end
+
+  it "sets a parent" do
+    @node.parent.must_equal @parent
+  end
+
+  it "returns its parent on pop!" do
+    @node.pop!.must_equal @parent
+  end
+
+  it "returns a newly created child on push!" do
+    child = @node.push! 1, 2, 3, 4, 5
+    @node.children.last.must_equal child
+  end
+
+  it "completely sets up the new child" do
+    child = @node.push! 1, 2, 3, 4, 5
+    child.trace_class.must_equal 1
+    child.trace_method.must_equal 2
+    child.trace_file.must_equal 3
+    child.trace_line.must_equal 4
+    child.trace_binding.must_equal 5
+    child.parent.must_equal @node
+    child.children.must_be_empty
+  end
+
+  it "generates a context from a binding" do
+    method = [].method(:empty?)
+    binding = method.to_proc.binding
+    @node.trace_binding = binding
+    @node.context.must_equal method
+  end
+
+  it "yields itself and then each child when enumerating" do
+    # Make a child
+    @node.trace_class = 0
+    child1 = @node.push!(1, nil, nil, nil, nil)
+    # And two grandchildren
+    child1.push!(11, nil, nil, nil, nil)
+    child1.push!(12, nil, nil, nil, nil)
+    # Make another child
+    @node.push!(2, nil, nil, nil, nil)
+    @node.map(&:trace_class).must_equal [0, 1, 11, 12, 2]
+  end
+
+  it "is empty when it has no children" do
+    @node.empty?.must_equal true
+    @node.push! 1, nil, nil, nil, nil
+    @node.empty?.must_equal false
+  end
+
+  it "determines size by the number of children plus their sizes" do
+    child1 = @node.push! nil, nil, nil, nil, nil
+    child2 = @node.push! nil, nil, nil, nil, nil
+    child1.push! nil, nil, nil, nil, nil
+    child1.push! nil, nil, nil, nil, nil
+    child2.push! nil, nil, nil, nil, nil
+    # node => 2 children, child1 => 2 children, child2 => 1 child
+    @node.size.must_equal 5
+  end
+
+  it "freezes its children when freezing" do
+    child1 = @node.push! nil, nil, nil, nil, nil
+    child1.push! nil, nil, nil, nil, nil
+    @node.freeze
+    @node.all?(&:frozen?).must_equal true
+    @node.children.frozen?.must_equal true
+  end
+
+  it "converts to an array" do
+    c1 = @node.push! 1, nil, nil, nil, nil
+    c2 = @node.push! 2, nil, nil, nil, nil
+    c1_1 = c1.push! 3, nil, nil, nil, nil
+    c1_1_1 = c1_1.push! 4, nil, nil, nil, nil
+    c2_1 = c2.push! 5, nil, nil, nil, nil
+    @node.to_a.must_equal [
+      @node, [
+        [c1, [ [ c1_1, [ [c1_1_1, []] ] ] ] ],
+        [c2, [ [ c2_1, [] ] ] ]
+      ]
+    ]
+  end
+end
+

data/spec/cognitive_distance/structures/call_tree_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe CognitiveDistance::Structures::CallTree do
+  before do
+    @call_tree = CognitiveDistance::Structures::CallTree.new
+  end
+
+  def populate_tree
+    @call_tree.called 1, nil, nil, nil, nil
+    @call_tree.called 11, nil, nil, nil, nil
+    @call_tree.returned 11, nil, nil, nil, nil
+    @call_tree.called 12, nil, nil, nil, nil
+    @call_tree.returned 12, nil, nil, nil, nil
+    @call_tree.returned 1, nil, nil, nil, nil
+    @call_tree.called 2, nil, nil, nil, nil
+    @call_tree.called 21, nil, nil, nil, nil
+    @call_tree.returned 21, nil, nil, nil, nil
+    @call_tree.returned 2, nil, nil, nil, nil
+    @call_tree.called 3, nil, nil, nil, nil
+    @call_tree.returned 3, nil, nil, nil, nil
+  end
+
+  it "returns the root node" do
+    @call_tree.root.
+      is_a?(CognitiveDistance::Structures::CallNodeRoot).must_equal true
+  end
+
+  it "is empty when there's nothing in the tree" do
+    @call_tree.empty?.must_equal true
+    @call_tree.called nil, nil, nil, nil, nil
+    @call_tree.empty?.must_equal false
+  end
+
+  it "converts to an array by converting the root node" do
+    populate_tree
+    @call_tree.to_a.must_equal @call_tree.root.to_a
+  end
+
+  it "contains all nodes when enumerated" do
+    populate_tree
+    @call_tree.map(&:trace_class).must_equal [1, 11, 12, 2, 21, 3]
+  end
+
+  it "calculates size from the children of the root" do
+    populate_tree
+    @call_tree.size.must_equal 6
+  end
+
+  it "freezes all nodes when freezing the tree" do
+    populate_tree
+    @call_tree.freeze
+    @call_tree.all?(&:frozen?).must_equal true
+  end
+end
+

data/spec/cognitive_distance/structures/graph_spec.rb

@@ -0,0 +1,142 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe CognitiveDistance::Structures::Graph do
+  before do
+    @graph = CognitiveDistance::Structures::Graph.new
+  end
+
+  class TestSubGraph < CognitiveDistance::Structures::Graph
+  end
+
+  it "is empty when there is nothing in it" do
+    @graph.empty?.must_equal true
+    @graph.link "vertex 1", "vertex 2"
+    @graph.empty?.must_equal false
+  end
+
+  it "records vertices" do
+    @graph.vertices.size.must_equal 0
+    @graph.link "vertex 1", "vertex 2", "vertex 3", "vertex 4", "vertex 2"
+    @graph.link "vertex 2", "vertex 3", "vertex 5", "vertex 1"
+    @graph.vertices.size.must_equal 5
+  end
+
+  it "records edges" do
+    @graph.edges.size.must_equal 0
+    @graph.link "vertex 1", "vertex 2", "vertex 3", "vertex 4", "vertex 2"
+    @graph.link "vertex 2", "vertex 3", "vertex 5", "vertex 1"
+    @graph.edges.size.must_equal 7
+  end
+
+  it "is enumerable" do
+    @graph.class.must_include Enumerable
+  end
+
+  it "enumerates over edges" do
+    collected = @graph.map { |e| e }
+    collected.must_equal @graph.edges
+  end
+
+  it "returns vertices that share an edge with the given vertex" do
+    @graph.link "vertex 1", "vertex 2", "vertex 3"
+    @graph.any_edges("vertex 4").size.must_equal 0
+    @graph.link "vertex 1", "vertex 4"
+    @graph.link "vertex 4", "vertex 2"
+    edges = @graph.any_edges("vertex 4")
+    edges.size.must_equal 2
+    edges.must_include ["vertex 1", "vertex 4"]
+    edges.must_include ["vertex 4", "vertex 2"]
+   end
+
+  it "returns vertices that link out of the given vertex" do
+    @graph.link "vertex 1", "vertex 2", "vertex 4"
+    @graph.out_edges("vertex 4").size.must_equal 0
+    @graph.link "vertex 4", "vertex 2"
+    edges = @graph.out_edges("vertex 4")
+    edges.must_equal [ [ "vertex 4", "vertex 2" ] ]
+  end
+
+  it "returns vertices link into the given vertex" do
+    @graph.link "vertex 4", "vertex 2", "vertex 3"
+    @graph.in_edges("vertex 4").size.must_equal 0
+    @graph.link "vertex 1", "vertex 4"
+    edges = @graph.in_edges("vertex 4")
+    edges.must_equal [ [ "vertex 1", "vertex 4" ] ]
+  end
+
+  it "records bi-directional links" do
+    @graph.bilink "vertex 1", "vertex 2"
+    @graph.in_edges("vertex 1").must_equal [ ["vertex 2", "vertex 1"] ]
+    @graph.out_edges("vertex 1").must_equal [ ["vertex 1", "vertex 2"] ]
+    @graph.in_edges("vertex 2").must_equal [ ["vertex 1", "vertex 2"] ]
+    @graph.out_edges("vertex 2").must_equal [ ["vertex 2", "vertex 1"] ]
+  end
+
+  it "converts to an array of edges" do
+    @graph.bilink "vertex 1", "vertex 2"
+    @graph.link "vertex 1", "vertex 4"
+    edge_array = @graph.to_a
+    edge_array.size.must_equal 3
+    edge_array.must_include ["vertex 1", "vertex 2"]
+    edge_array.must_include ["vertex 2", "vertex 1"]
+    edge_array.must_include ["vertex 1", "vertex 4"]
+  end
+
+  it "is always equal to itself" do
+    (@graph == @graph).must_equal true
+    @graph.link "a", "b"
+    (@graph == @graph).must_equal true
+  end
+
+  it "is equal (==) to another graph iff they have the same edges" do
+    graph2 = CognitiveDistance::Structures::Graph.new
+    @graph.bilink "vertex 1", "vertex 2"
+    @graph.link "vertex 3", "vertex 1"
+    @graph.link "vertex 2", "vertex 4"
+
+    graph2.link "vertex 1", "vertex 2"
+    graph2.link "vertex 2", "vertex 4"
+    graph2.link "vertex 3", "vertex 1"
+   
+    (graph2 == @graph).must_equal false
+    (@graph == graph2).must_equal false
+    graph2.link "vertex 2", "vertex 1"
+    (graph2 == @graph).must_equal true
+    (@graph == graph2).must_equal true
+  end
+
+  it "is equal (==) to an array of edges" do
+    @graph.bilink "vertex 1", "vertex 2"
+    @graph.link "vertex 3", "vertex 1"
+    @graph.link "vertex 2", "vertex 4"
+    (@graph == [
+      [ "vertex 1", "vertex 2" ],
+      [ "vertex 2", "vertex 4" ],
+      [ "vertex 3", "vertex 1" ],
+      [ "vertex 2", "vertex 1" ]
+    ]).must_equal true
+  end
+
+  it "is only identical (equal?) to itself" do
+    graph2 = CognitiveDistance::Structures::Graph.new
+    @graph.link "a", "b"
+    graph2.link "a", "b"
+    (@graph == graph2).must_equal true
+    @graph.equal?(graph2).must_equal false
+    graph2.equal?(@graph).must_equal false
+    @graph.equal?(@graph).must_equal true
+    graph2.equal?(graph2).must_equal true
+  end
+
+  it "is type equal (eql?) to another graph iff they have the same edges" do
+    graph2 = TestSubGraph.new
+    graph3 = [ [ "a", "b" ] ]
+    @graph.link "a", "b"
+    graph2.link "a", "b"
+    @graph.eql?(graph2).must_equal true
+    graph2.eql?(@graph).must_equal true
+    @graph.eql?(graph3).must_equal false
+    graph2.eql?(graph3).must_equal false
+  end
+end
+

data/spec/cognitive_distance/structures/missing_call_context_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe CognitiveDistance::Structures::MissingCallContext do
+  before do
+    @missing_call_context = CognitiveDistance::Structures::MissingCallContext.new
+  end
+
+  it "is not equal to some other object" do
+    @missing_call_context.equal?("test string").must_equal false
+  end
+
+  it "is not equal to another missing call context" do
+    other = CognitiveDistance::Structures::MissingCallContext.new
+    @missing_call_context.equal?(other).must_equal false
+  end
+
+  it "is not equal to itself" do
+    @missing_call_context.equal?(@missing_call_context).must_equal false
+  end
+end
+

data/spec/cognitive_distance/tracer_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe CognitiveDistance::Tracer do
+  before do
+    @traced_obj = CognitiveDistance::Test::TracesInternal.new
+    @tracer = CognitiveDistance::Tracer.new(@traced_obj)
+  end
+
+  def to_methods arr
+    arr.map { |(node, children)|
+      [node.trace_method, to_methods(children)]
+    }
+  end
+
+  it "returns a CallTree after tracing" do
+    call_tree = @tracer.trace(:method1)
+    call_tree.is_a?(CognitiveDistance::Structures::CallTree).must_equal true
+    call_tree.to_a.size.must_equal 1
+  end
+
+  it "traces out a CallTree" do
+    call_tree = @tracer.trace(:method1)
+    to_methods(call_tree.to_a).must_equal [
+      [:method1, [
+        [:method2, [
+          [:method4, []]
+        ]],
+        [:method3, []]
+      ]]
+    ]
+  end
+
+  it "traces out properly when an exception is raised" do
+    call_tree = @tracer.trace(:test_raising)
+    to_methods(call_tree.to_a).must_equal [
+      [:test_raising, [
+        [:prepare_the_raising, [
+          [ :do_the_raising, [] ]
+        ]],
+        [:method3, []]
+      ]]
+    ]
+  end
+
+  it "traces out properly when throwing and catching" do
+    call_tree = @tracer.trace(:test_throwing)
+    to_methods(call_tree.to_a).must_equal [
+      [:test_throwing, [
+          [:prepare_the_throwing, [
+            [ :do_the_throwing, [] ]
+          ]],
+          [:method4, []]
+      ]]
+    ]
+  end
+end
+