dagnabit 2.2.1 → 2.2.2

data/README.rdoc

@@ -1,9 +1,3 @@
-= This is the GitHub branch
-
-This branch is updated irregularly.  The canonical dagnabit repository is hosted on Gitorious:
-
-http://gitorious.org/dagnabit/dagnabit
-
 = dagnabit
 
 dagnabit is (yet another) ActiveRecord plugin for directed acyclic graphs.  It
@@ -83,6 +77,9 @@ In your node models, put
 +acts_as_dag_link+ accepts some configuration options.  These configuration
 options are discussed below.
 
+For a code example of a complete setup, see the <tt>dagnabit-test</tt> script
+in +bin+.
+
 === Link table schemas
 
 Link storage is accomplished with two tables having identical schemas.  One
@@ -109,6 +106,9 @@ The behavior of the plugin with a deviant schema is unspecified.
 * +transitive_closure_table_name+: The table where tuples in the transitive
   closure of the graph should be stored.  Defaults to
   <tt>#{link_table_name}_transitive_closure_tuples</tt>.
+* +transitive_closure_class_name+: The transitive closure is represented with
+  an ActiveRecord class whose name defaults to +TransitiveClosureLink+.  Set this
+  option to change that name.
 * +descendant_id_column+: Column in the link tables for recording the ID of a
   descendant.  Defaults to +descendant_id+.
 * +ancestor_id_column+: Column in the link tables for recording the ID of a
@@ -146,22 +146,20 @@ edge model was called +Link+, these would be valid expressions:
 
 +acts_as_dag_node+ adds the following instance methods to nodes:
  
-* +descendants+: All descendants of the node.  Read-only.
+* +children+: All children of the node.  Read-only.
+* +parents+: All parents of the node.  Read-only.
 * +ancestors+: All ancestors of the node.  Read-only.
+* +descendants+: All descendants of the node.  Read-only.
 
 === Link interface
 
 The following class methods are available on links:
 
 * +paths+: Retrieves all paths from one node to another.
-* +path+: Returns whether a node is reachable from another node.
-* +find_edge+: Finds an edge from one node to another, or nil if none exists.
+* <tt>path?</tt>: Returns whether a node is reachable from another node.
 * +build_edge+: Builds an edge from one node to another node.
 * +connect+: Builds and saves an edge from one node to another.  Identical to
   <tt>build_edge(nodeA, nodeB).save</tt>.
-* <tt>connect!</tt>: Builds and saves an edge from one node to another, raising
-  an exception if save fails.  Identical to <tt>build_edge(nodeA,
-  nodeB).save!</tt>.
 
 == Introduction to the codebase
 

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 2
 :minor: 2
-:patch: 1
+:patch: 2
 :build: 

data/bin/dagnabit-test

@@ -6,7 +6,7 @@
 #
 
 require 'rubygems'
-require 'activerecord'
+require 'active_record'
 
 src = File.dirname(__FILE__) + '/../lib/dagnabit.rb'
 if File.exists?(src)

data/dagnabit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dagnabit}
-  s.version = "2.2.1"
+  s.version = "2.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Yip"]
-  s.date = %q{2009-12-07}
+  s.date = %q{2010-02-04}
   s.default_executable = %q{dagnabit-test}
   s.email = %q{yipdw@northwestern.edu}
   s.executables = ["dagnabit-test"]
@@ -75,7 +75,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Directed acyclic graph plugin for ActiveRecord}
   s.test_files = [
-    "test/connections/native_postgresql/connection.rb",
+    "test/benchmark/helper.rb",
+     "test/benchmark/linear_benchmark.rb",
+     "test/connections/native_postgresql/connection.rb",
      "test/connections/native_sqlite3/connection.rb",
      "test/dagnabit/link/test_associations.rb",
      "test/dagnabit/link/test_class_methods.rb",

data/lib/dagnabit/link/transitive_closure_recalculation/on_update.rb

@@ -3,7 +3,11 @@ module Dagnabit
     module TransitiveClosureRecalculation
       module OnUpdate
         def after_update
+          current_values = dag_link_column_names.map { |n| connection.quote(send(n)) }
           old_values = dag_link_column_names.map { |n| connection.quote(changes[n].try(:first) || send(n)) }
+
+          return unless current_values != old_values
+
           update_transitive_closure_for_destroy(*old_values)
           update_transitive_closure_for_create
         end

data/test/benchmark/helper.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'active_support/test_case'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dagnabit'
+
+ActiveRecord::Base.logger = Logger.new("benchmark.log")
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+ActiveRecord::Schema.define do
+  [:links, :links_transitive_closure_tuples].each do |table|
+    create_table table do |t|
+      t.integer :ancestor_id
+      t.integer :descendant_id
+      t.string :ancestor_type
+      t.string :descendant_type
+    end
+  end
+
+  create_table :nodes do |t|
+    t.string :data
+  end
+end
+
+class Link < ActiveRecord::Base
+  acts_as_dag_link
+end
+
+class Node < ActiveRecord::Base
+  acts_as_dag_node_linked_by 'Link'
+end
+
+REPETITIONS = 5
+
+class BenchmarkTestCase < ActiveSupport::TestCase
+  def teardown
+    Node.delete_all
+    Link.delete_all
+  end
+end

data/test/benchmark/linear_benchmark.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/helper'
+
+class LinearBenchmark < BenchmarkTestCase
+  def test_speed
+    Benchmark.bm do |x|
+      root = Node.create
+      last_node = root
+
+      100.times do |i|
+        target = Node.create
+        
+        x.report("Graph depth: #{i+1}") { Link.connect(last_node, target) }
+
+        assert_equal 1, last_node.children.length
+        assert_equal i+1, root.descendants.length
+
+        last_node = target
+      end
+    end
+  end
+
+  def test_deletion_from_long_list
+    nodes = []
+    last_node = Node.create
+    
+    puts 'Building long list...'
+    50.times do |i|
+      target = Node.create
+      Link.connect(last_node, target)
+      last_node = target
+
+      nodes << target
+    end
+    
+    Benchmark.bm do |x|
+      nodes.each_with_index do |node, i|
+        x.report("Destroying node #{i}") { node.destroy }
+      end
+    end
+  end
+end

data/test/dagnabit/link/test_transitive_closure_recalculation.rb

@@ -134,6 +134,17 @@ module Dagnabit
         tc = CustomTransitiveClosureLink.find(:first, :conditions => { :the_ancestor_id => n1.id, :the_descendant_id => n3.id })
         assert_nil tc, 'expected to not find path from n1 to n3'
       end
+
+      should "not recalculate transitive closure if neither a link's source nor target changed" do
+        n1 = ::Node.create
+        n2 = ::Node.create
+
+        l1 = ::Link.new(:ancestor => n1, :descendant => n2)
+
+        l1.expects(:update_transitive_closure_for_destroy).never
+        l1.save
+        l1.save
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dagnabit
 version: !ruby/object:Gem::Version 
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors: 
 - David Yip
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-07 00:00:00 -06:00
+date: 2010-02-04 00:00:00 -06:00
 default_executable: dagnabit-test
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -141,6 +141,8 @@ signing_key:
 specification_version: 3
 summary: Directed acyclic graph plugin for ActiveRecord
 test_files: 
+- test/benchmark/helper.rb
+- test/benchmark/linear_benchmark.rb
 - test/connections/native_postgresql/connection.rb
 - test/connections/native_sqlite3/connection.rb
 - test/dagnabit/link/test_associations.rb