acts_as_oqgraph 0.1.5 → 0.1.6

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/acts_as_oqgraph.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_oqgraph}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stuart Coyle"]

data/lib/acts_as_oqgraph.rb

@@ -60,7 +60,10 @@ module OQGraph
       # Path Finding:
       #   foo.shortest_path_to(baz)
       #    returns [foo, bar,baz]
-      # 
+      #
+      # With breadth first edge weights are not taken into account:
+      #  foo.shortest_path_to(baz, :method => :breadth_first)
+      #
       # All these methods return the node object with an additional weight field.
       # This enables you to query the weights associated with the edges found.
       # 
@@ -139,9 +142,7 @@ module OQGraph
           end
           return result
         rescue ActiveRecord::StatementInvalid => e
-          # This will occur if the table is not using MySQL
-          # TODO: Raise a sensible error message here.
-          return false
+          raise "MySQL or MariaDB 5.1 or above with the OQGRAPH engine is required for the acts_as_oqgraph gem.\nThe following error was raised: #{e.inspect}"
         end    
       end
     end
@@ -178,7 +179,7 @@ module OQGraph
       
       # Returns an array of all nodes which can trace to this node
       def originating
-        edge_class.originating_vertices(self)
+        edge_class.originating_nodes(self)
       end
       
       # true if the other node can reach this node.
@@ -188,7 +189,7 @@ module OQGraph
       
       # Returns all nodes reachable from this node.
       def reachable
-        edge_class.reachable_vertices(self)
+        edge_class.reachable_nodes(self)
       end
       
       # true if the other node is reachable from this one

data/lib/graph_edge.rb

@@ -6,12 +6,13 @@ class GraphEdge < ActiveRecord::Base
   after_destroy :remove_from_graph
   after_update  :update_graph
   
-  
   # Creates the OQgraph table if it does not exist.
   # Deletes all entries if it does exist and then repopulates with 
-  # current edges. TODO Optimise this so that it only does so if the 
-  # DB server has been restarted.
+  # current edges. TODO: Optimise this so that it only does so if the 
+  # DB server has been restarted rather than when the app is restarted.
   def self.create_graph_table
+    connection.execute "DROP TABLE IF EXISTS #{oqgraph_table_name}"
+    
     connection.execute <<-EOS
     CREATE TABLE IF NOT EXISTS #{oqgraph_table_name} (
         latch   SMALLINT  UNSIGNED NULL,
@@ -25,13 +26,17 @@ class GraphEdge < ActiveRecord::Base
       ) ENGINE=OQGRAPH;
      EOS
     
-    connection.execute("DELETE FROM #{oqgraph_table_name}")
-    
-    self.all.each do |edge|
-      edge.add_to_graph
-    end
+    connection.execute <<-EOS
+      INSERT INTO #{oqgraph_table_name} (origid, destid, weight) 
+      SELECT #{from_key}, #{to_key}, #{weight_column} FROM #{table_name}
+      EOS
   end   
   
+  # Returns the shortest path from node to node.
+  # +options+ A hash containing options.
+  # The only option is :method which can be 
+  # :breadth_first to do a breadth first search.
+  # It defaults to using Djikstra's algorithm.
   def self.shortest_path(from, to, options)
     latch = case options[:method]
       when :breadth_first then 2
@@ -48,73 +53,85 @@ class GraphEdge < ActiveRecord::Base
     node_class.find_by_sql select_for_node << sql
   end
   
-  def self.originating_vertices(to)    
+  # Finds all the nodes that lead to the node
+  def self.originating_nodes(node)    
     sql = <<-EOS
-     WHERE latch = 1 AND destid = #{to.id}
+     WHERE latch = 1 AND destid = #{node.id}
      ORDER BY seq;
     EOS
     
     node_class.find_by_sql select_for_node << sql 
   end
   
-  def self.reachable_vertices(from)    
+  # Finds all the nodes that are reachable from the node
+  def self.reachable_nodes(node)    
     sql = <<-EOS
-     WHERE latch = 1 AND origid = #{from.id}
+     WHERE latch = 1 AND origid = #{node.id}
      ORDER BY seq;
     EOS
     
     node_class.find_by_sql select_for_node << sql 
   end
   
+  # Finds the edges leading directly into the node
   # FIXME: Note this currently does not work.
   # I suspect a bug in OQGRaph engine.
-  def self.in_edges(to)
+  # Using the node classes incoming_nodes is equivalent to this.
+  def self.in_edges(node)
     sql = <<-EOS
-     WHERE latch = 0 AND destid = #{to.id}
+     WHERE latch = 0 AND destid = #{node.id}
     EOS
     
     node_class.find_by_sql select_for_node << sql 
   end
   
-  def self.out_edges(from)    
+  # Finds the edges leading directly out of the node
+  def self.out_edges(node)    
     sql = <<-EOS
-     WHERE latch = 0 AND origid = #{from.id}
+     WHERE latch = 0 AND origid = #{node.id}
     EOS
   
     node_class.find_by_sql select_for_node << sql 
   end
-   
-    def add_to_graph
-      connection.execute <<-EOS
-        REPLACE INTO #{oqgraph_table_name} (origid, destid, weight) 
-        VALUES (#{self.send(self.class.from_key)}, #{self.send(self.class.to_key)}, #{weight || 1.0})
-      EOS
-    end
 
 private
-
-    def remove_from_graph
-      # Ignores trying to delete nonexistent records
-       connection.execute <<-EOS
-          DELETE IGNORE FROM #{oqgraph_table_name} WHERE origid = #{self.send(self.class.from_key)} AND destid = #{self.send(self.class.to_key)};
-       EOS
-    end
-
-    def update_graph
-      connection.execute <<-EOS
-        UPDATE #{oqgraph_table_name} 
-        SET origid = #{self.send(self.class.from_key)}, 
-            destid = #{self.send(self.class.to_key)}, 
-            weight = #{weight} 
-        WHERE origid = #{self.send(self.class.from_key + '_was')} AND destid = #{self.send(self.class.to_key + '_was')};
-      EOS
-    end
+  
+  # Callback to add new graph edges to the OQGraph table
+  def add_to_graph
+    connection.execute <<-EOS
+      REPLACE INTO #{oqgraph_table_name} (origid, destid, weight) 
+      VALUES (#{self.send(self.class.from_key)}, #{self.send(self.class.to_key)}, #{self.send(self.class.weight_column) || 1.0})
+    EOS
+  end    
+    
+    
+  # Callback to remove deleted graph edges from the OQGraph table
+  def remove_from_graph
+    # Ignores trying to delete nonexistent records
+     connection.execute <<-EOS
+        DELETE IGNORE FROM #{oqgraph_table_name} WHERE origid = #{self.send(self.class.from_key)} AND destid = #{self.send(self.class.to_key)};
+     EOS
+  end
+  
+  # Callback to update graph edges in the OQGraph table
+  def update_graph
+    connection.execute <<-EOS
+      UPDATE #{oqgraph_table_name} 
+      SET origid = #{self.send(self.class.from_key)}, 
+          destid = #{self.send(self.class.to_key)}, 
+          weight = #{self.send(self.class.weight_column)} 
+      WHERE origid = #{self.send(self.class.from_key + '_was')} AND destid = #{self.send(self.class.to_key + '_was')};
+    EOS
+  end
+  
+  # nodoc
   def self.select_for_node
     sql = "SELECT "
     sql << node_class.columns.map{|column| "#{node_table}.#{column.name}"}.join(",")
     sql << ", #{oqgraph_table_name}.weight FROM #{oqgraph_table_name} JOIN #{node_table} ON (linkid=id) "
   end
   
+  # Returns the table containing the nodes for these edges.
   def self.node_table
     node_class.table_name
   end

data/test/test_acts_as_oqgraph.rb

@@ -2,7 +2,6 @@ require 'helper'
 
 class TestActsAsOqgraph < ActiveSupport::TestCase
   def setup
-    
     ActiveRecord::Base.establish_connection(
         :adapter  => "mysql",
         :host     => "localhost",
@@ -13,8 +12,9 @@ class TestActsAsOqgraph < ActiveSupport::TestCase
     
     ActiveRecord::Base.connection.execute("CREATE TABLE IF NOT EXISTS test_models(id INTEGER DEFAULT NULL AUTO_INCREMENT PRIMARY KEY, name VARCHAR(255) );")
     ActiveRecord::Base.connection.execute("CREATE TABLE IF NOT EXISTS test_model_edges(id INTEGER DEFAULT NULL AUTO_INCREMENT PRIMARY KEY, from_id INTEGER, to_id INTEGER, weight DOUBLE);")
-    ActiveRecord::Base.connection.execute("CREATE TABLE IF NOT EXISTS custom_edges(id INTEGER DEFAULT NULL AUTO_INCREMENT PRIMARY KEY, from_id INTEGER, to_id INTEGER, weight DOUBLE);")
+    ActiveRecord::Base.connection.execute("CREATE TABLE IF NOT EXISTS custom_edges(id INTEGER DEFAULT NULL AUTO_INCREMENT PRIMARY KEY, orig_id INTEGER, dest_id INTEGER, length DOUBLE);")
     
+    # These requires need the tables to be created.
     require File.join(File.dirname(__FILE__),'models/custom_test_model')
     require File.join(File.dirname(__FILE__),'models/test_model')
     
@@ -24,7 +24,6 @@ class TestActsAsOqgraph < ActiveSupport::TestCase
     @test_4 = TestModel.create(:name => 'd')
     @test_5 = TestModel.create(:name => 'e')
     @test_6 = TestModel.create(:name => 'f')
-    
   end
 
   def teardown
@@ -33,7 +32,6 @@ class TestActsAsOqgraph < ActiveSupport::TestCase
     ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS custom_edges;")
     ActiveRecord::Base.connection.execute("DELETE FROM test_model_oqgraph;") 
     ActiveRecord::Base.connection.execute("DELETE FROM custom_test_model_oqgraph;") 
-    
   end
   
   def test_edge_table_and_class_names
@@ -70,6 +68,11 @@ class TestActsAsOqgraph < ActiveSupport::TestCase
     assert_equal 'dest_id', CustomEdge.to_key
     assert_equal 'orig_id', CustomEdge.from_key
     assert_equal 'length', CustomEdge.weight_column
+    mysql = Mysql.new('localhost', 'root', '', 'test')
+    fields = mysql.list_fields('custom_edges').fetch_fields.map{|f| f.name}
+    assert fields.include?('orig_id')
+    assert fields.include?('dest_id')
+    assert fields.include?('length')
   end
   
   def test_test_model_edge_creation
@@ -222,7 +225,7 @@ class TestActsAsOqgraph < ActiveSupport::TestCase
    def test_deletion_of_nonexistent_edge_raises_error
      edge = @test_1.create_edge_to @test_2
      ActiveRecord::Base.connection.execute("DELETE FROM test_model_oqgraph WHERE destid = #{edge.to_id} AND origid = #{edge.from_id}")
-     assert_raises ActiveRecord::StatementInvalid do
+     assert_nothing_raised do
        edge.destroy
      end
    end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Stuart Coyle