acts_as_oqgraph 0.1.6 → 0.1.7

data/README.rdoc

@@ -42,6 +42,7 @@ Then I can call:
 and I get the whole tree of friends of friends etc...
              
 Imagine you have a maze to solve. With OQGraph the solution is as simple as: start_cell.shortest_path_to(finish_cell).
+See the demo code at http://github.com/stuart/acts_as_oqgraph_demo
 
 It's good for representing tree structures, networks, routes between cities etc.
 
@@ -149,8 +150,9 @@ The OQGraph table will also get created if it does not exist. The OQGraph table
 memory only. The table structure is not volatile and gets stored in the db. 
 When your application starts up it will put all the edges into the graph table and update them as
 they are created, deleted or modified. This could slow things down at startup but caching classes in production
-means it does not happen on every request. I will add functionality to only update the oqgraph table if the 
-db server has been stopped, once I figure out the best way to do it.
+means it does not happen on every request. The graph table is only rewritten now when the DB has been restarted.
+You can use this code to force the graph to be rebuilt:
+  NodeModel.rebuild_graph
 
 == How fast is it?
 I've tested with an application with 10000 nodes and 0 to 9 links from each.
@@ -175,15 +177,14 @@ Of course YMMV.
 == Hairy bits, bugs and gotchas
 
 To keep the oqgraph table up to date the edge model copies all of it records in when first instantiated.
-This means that if you do not have
-  config.cache_classes = true
-in your environment and you have a lot of nodes your app will be dog slow. Also the app will be slow to start at first if
-there are many nodes even when caches are cached.
+This means that on first startup the app can be slow to respond until the whole graph has been written.
+This should not need to happen again unless the DB is restarted. You can get the MySQL server to update the graph
+by using the --init-file=<SQLfile> option in my.cnf with the appropriate SQL in it.  
 
 I've encountered a bug where the oqgraph table occasionally needs to be dropped and rebuilt. It's being tracked down.
 If you are not getting any results from the oqgrah table try dropping it and restarting the app.
 
-I'm working on a way to tell if the oqgraph table is stale. Suggestions would be welcome.
+I'm working on a way to tell if the oqgraph table is stale other than by the current count of rows. Suggestions would be welcome.
 
 There is a method 'in_edges' in the edge model class. This does not currently work. 'out_edges' does.
 

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "acts_as_oqgraph"
     gem.summary = %Q{Use the Open Query Graph engine with Active Record}
-    gem.description = %Q{Acts As OQGraph allows ActiveRecord models to use the fast ans powerful OQGraph engine for MYSQL.}
+    gem.description = %Q{Acts As OQGraph allows ActiveRecord models to use the fast and powerful OQGraph engine for MYSQL.}
     gem.email = "stuart.coyle@gmail.com"
     gem.homepage = "http://github.com/stuart/acts_as_oqgraph"
     gem.authors = ["Stuart Coyle"]

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/acts_as_oqgraph.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_oqgraph}
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stuart Coyle"]
-  s.date = %q{2010-07-22}
-  s.description = %q{Acts As OQGraph allows ActiveRecord models to use the fast ans powerful OQGraph engine for MYSQL.}
+  s.date = %q{2011-06-06}
+  s.description = %q{Acts As OQGraph allows ActiveRecord models to use the fast and powerful OQGraph engine for MYSQL.}
   s.email = %q{stuart.coyle@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/stuart/acts_as_oqgraph}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Use the Open Query Graph engine with Active Record}
   s.test_files = [
     "test/helper.rb",
@@ -47,7 +47,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

data/lib/acts_as_oqgraph.rb

@@ -36,7 +36,9 @@ module OQGraph
       # The field names and table name can be changed via the options listed above.
       #
       # The gem will automatically create the oqgraph table.
-      # 
+      # To rebuild the oqgraph table do:
+      #       Model.rebuild_graph
+      #
       # Examples of use:
       # 
       # Creating and removing edges:
@@ -127,9 +129,14 @@ module OQGraph
             '#{edge_table_name}'
           end
           
+          def self.rebuild_graph
+            edge_class.create_graph_table
+          end
         EOF
       end      
       
+
+      
       private
       
       # Check that we have the OQGraph engine plugin installed in MySQL

data/lib/graph_edge.rb

@@ -6,13 +6,8 @@ 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 rather than when the app is restarted.
-  def self.create_graph_table
-    connection.execute "DROP TABLE IF EXISTS #{oqgraph_table_name}"
-    
+  # Creates the OQgraph table if it does not exist and populate with edges.
+  def self.create_graph_table     
     connection.execute <<-EOS
     CREATE TABLE IF NOT EXISTS #{oqgraph_table_name} (
         latch   SMALLINT  UNSIGNED NULL,
@@ -24,12 +19,15 @@ class GraphEdge < ActiveRecord::Base
         KEY (latch, origid, destid) USING HASH,
         KEY (latch, destid, origid) USING HASH
       ) ENGINE=OQGRAPH;
-     EOS
+    EOS
     
-    connection.execute <<-EOS
-      INSERT INTO #{oqgraph_table_name} (origid, destid, weight) 
-      SELECT #{from_key}, #{to_key}, #{weight_column} FROM #{table_name}
+    # if the DB server has restarted then there will be no records in the oqgraph table.
+    if !up_to_date?
+      connection.execute <<-EOS
+        REPLACE INTO #{oqgraph_table_name} (origid, destid, weight) 
+        SELECT #{from_key}, #{to_key}, #{weight_column} FROM #{table_name}
       EOS
+    end                   
   end   
   
   # Returns the shortest path from node to node.
@@ -75,7 +73,7 @@ class GraphEdge < ActiveRecord::Base
   
   # Finds the edges leading directly into the node
   # FIXME: Note this currently does not work.
-  # I suspect a bug in OQGRaph engine.
+  # I suspect a bug in OQGraph engine.
   # Using the node classes incoming_nodes is equivalent to this.
   def self.in_edges(node)
     sql = <<-EOS
@@ -135,4 +133,8 @@ private
   def self.node_table
     node_class.table_name
   end
+  
+  def self.up_to_date?
+    connection.select_value("SELECT COUNT(*) FROM #{oqgraph_table_name}") == connection.select_value("SELECT COUNT(*) FROM #{table_name}")
+  end
 end

data/test/test_acts_as_oqgraph.rb

@@ -15,8 +15,8 @@ class TestActsAsOqgraph < ActiveSupport::TestCase
     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')
+    require File.join(File.expand_path(File.dirname(__FILE__)),"models/custom_test_model")
+    require File.join(File.expand_path(File.dirname(__FILE__)),"models/test_model")
     
     @test_1 = TestModel.create(:name => 'a')
     @test_2 = TestModel.create(:name => 'b')
@@ -134,7 +134,7 @@ class TestActsAsOqgraph < ActiveSupport::TestCase
   end
   
   def test_getting_shortest_path_more_complex
-    #
+    # 
     # a -- b -- c -- d
     #      |      / 
     #      e-- f 
@@ -222,12 +222,27 @@ class TestActsAsOqgraph < ActiveSupport::TestCase
     end
    end
    
+   # There's an odd case here where MySQL would raise an error only when using Rails.
    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_nothing_raised do
        edge.destroy
      end
-   end
+   end  
+   
+   def test_rebuild_graph
+     @test_1.create_edge_to @test_2
+     @test_2.create_edge_to @test_3
+     @test_3.create_edge_to @test_4
+     # Simulate the DB restart
+     ActiveRecord::Base.connection.execute("DELETE FROM test_model_oqgraph;")
+     TestModel.rebuild_graph
     
+     assert_equal [@test_1, @test_2, @test_3, @test_4], @test_1.shortest_path_to(@test_4)
+     assert_equal ['a','b','c','d'], @test_1.shortest_path_to(@test_4).map(&:name)
+   
+   end
+   
+   
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 7
+  version: 0.1.7
 platform: ruby
 authors: 
 - Stuart Coyle
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-22 00:00:00 +10:00
+date: 2011-06-06 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
-description: Acts As OQGraph allows ActiveRecord models to use the fast ans powerful OQGraph engine for MYSQL.
+description: Acts As OQGraph allows ActiveRecord models to use the fast and powerful OQGraph engine for MYSQL.
 email: stuart.coyle@gmail.com
 executables: []
 
@@ -51,6 +51,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -58,6 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -67,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Use the Open Query Graph engine with Active Record