acts_as_oqgraph 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,5 +1,5 @@
-ActsAsOQGraph
-===========
+*ActsAsOQGraph*
+
 This gem can be used with ActiveRecord to access the features of the OQGraph
 MySQL plugin. 
 
@@ -11,10 +11,11 @@ pros and cons of both approaches, It really depends on your needs. Both librarie
 use the C++ Boost graph library at the bottom layers. OQGraph has expensive 
 insert operations but is very fast at delivering the graph data and finding paths in a single SQL query.
 
-Concepts:
+*Concepts*
+
 The term graph we are using here is a mathematical one not a pretty picture (sorry designers). 
 For more see: http://en.wikipedia.org/wiki/Graph_(mathematics) 
-A graph consists of nodes (aka vertices) connected by edges (aka edges). 
+A graph consists of nodes (aka vertices) connected by edges (aka links, paths). 
 In a directed graph an edge has a direction. That is, it has an 'from' node and and a 'to' node.
 When tracing a path on the graph you can only go in the direction of the edge.
 The OQGraph gem operates on directed graphs. To create a non directed graph you have to create two edges,
@@ -23,7 +24,8 @@ one each way between each node.
 Edges can be assigned positive floating point values called weights. Weights default to 1.0
 The weights are used in shortest path calculations, a path is shorter if the sum of weights over each edge is smaller.
 
-What you can do with OQGraph:
+*What you can do with OQGraph?*
+
 Imagine your shiny new social networking app, FarceBook.
 You have lots and lots of users each with several friends. How do you find the friends of friends?
 Or even the friends of friends of friends...right up to the six degrees of separation perhaps?
@@ -31,35 +33,37 @@ Or even the friends of friends of friends...right up to the six degrees of separ
 Well you can do it, with some really slow and nasty SQL queries. Relational databases are good at set
 based queries but no good at graph or tree based queries. The OQGraph engine is good at graph based queries, 
 it enables you in one simple SQL query to find all friends of friends. 
-    Do this: user.reachable
-    If you really want to you can rename the reachable method so you can do this in your User model:
-             alias friends, reachable
-    Then I can call: 
-             user.friends
-    and I get the whole tree of friends of friends etc...
+Do this: 
+    user.reachable
+If you really want to you can rename the reachable method so you can do this in your User model:
+    alias friends, reachable
+Then I can call: 
+    user.friends
+and I get the whole tree of friends of friends etc...
              
-    TODO: Perhaps I should hook into ActiveRecord associations somehow so these can be named associations instead of methods.
-          Not really sure of how to go about this as yet
-          .
 Imagine you have a maze to solve. With OQGraph the solution is as simple as: start_cell.shortest_path_to(finish_cell).
 
 It's good for representing tree structures, networks, routes between cities, roads etc.
 
-Usage:
+*Usage*
+
+In your node model file:
+
+  Class Foo < ActiveRecord::Base
+    acts_as_oqgraph
+    end
 
-Class Foo < ActiveRecord::Base
-    acts_as_oqgraph +options+
-end
+*Options*
 
-Options: 
-:class_name - The name of the edge class, defaults to current class name appended with Edge. eg FooEdge
-:table_name - The name of the edge table, defaults to table name of the specified class, eg foo_edges
-:oqgraph_table_name - the name of the volatile oqgraph table. Default foo_edge_oqgraph
-:from_key - The from key field in the edge table. Default 'from_id'
-:to_key - The to key field in the edge table. Default: 'to_id'
-:weight_column - The weight field in the edge table.
+* class_name - The name of the edge class, defaults to current class name appended with Edge. eg FooEdge
+* table_name - The name of the edge table, defaults to table name of the specified class, eg foo_edges
+* oqgraph_table_name - the name of the volatile oqgraph table. Default foo_edge_oqgraph
+* from_key - The from key field in the edge table. Default 'from_id'
+* to_key - The to key field in the edge table. Default: 'to_id'
+* weight_column - The weight field in the edge table.
+
+*Setup*
 
-Setup:
 This gem requires the use of MySQL or MariaDB with the OQGraph engine plugin.
 For details of this see: http://openquery.com/products/graph-engine
 
@@ -71,7 +75,6 @@ You will need a table for the edges with the following schema:
   end   
 The field names and table name can be changed via the options listed above.
 You should be able also to extend the edge model as you wish.
-
 The gem will automatically create the oqgraph table and the associations to it from your node model.
 The associations are:
   node_model.outgoing_edges
@@ -80,14 +83,15 @@ The associations are:
   node_model.incoming_nodes
   edge_model.to
   edge_model.from
-  
-Examples of use:
+
+
+*Examples of use*
 
 Creating edges:
  foo.create_edge_to(bar) 
  foo.create_edge_to_and_from(bar)
 
-Alternate notation using ActiveRecord associations: 
+Edge creation using ActiveRecord associations: 
  foo.outgoing_nodes << bar
 or equivalently:
   bar.incoming_nodes << foo
@@ -122,7 +126,8 @@ Path Finding:
 All these methods return the node object with an additional weight field.
 This enables you to query the weights associated with the edges found.
 
-Behind the Scenes:
+*Behind the Scenes*
+
 When you declare acts_as_oqgraph then the edge class gets created. You can add extra functionality
 if you wish to the edge class by the usual Ruby monkey patching methods.
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/acts_as_oqgraph.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_oqgraph}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Stuart Coyle"]
+  s.date = %q{2010-07-21}
+  s.description = %q{Acts As OQGraph allows ActiveRecord models to use the fast ans powerful OQGraph engine for MYSQL.}
+  s.email = %q{stuart.coyle@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "acts_as_oqgraph.gemspec",
+     "lib/acts_as_oqgraph.rb",
+     "lib/graph_edge.rb",
+     "test/helper.rb",
+     "test/models/custom_test_model.rb",
+     "test/models/test_model.rb",
+     "test/test_acts_as_oqgraph.rb"
+  ]
+  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.summary = %q{Use the Open Query Graph engine with Active Record}
+  s.test_files = [
+    "test/helper.rb",
+     "test/models/custom_test_model.rb",
+     "test/models/test_model.rb",
+     "test/test_acts_as_oqgraph.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/graph_edge.rb

@@ -85,7 +85,6 @@ class GraphEdge < ActiveRecord::Base
     node_class.find_by_sql select_for_node << sql 
   end
    
-  private
     def add_to_graph
       connection.execute <<-EOS
         INSERT INTO #{oqgraph_table_name} (origid, destid, weight) 
@@ -93,6 +92,8 @@ class GraphEdge < ActiveRecord::Base
       EOS
     end
 
+private
+
     def remove_from_graph
       connection.execute <<-EOS
         DELETE FROM #{oqgraph_table_name} WHERE origid = #{self.send(self.class.from_key)} AND destid = #{self.send(self.class.to_key)};

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Stuart Coyle
@@ -34,6 +34,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- acts_as_oqgraph.gemspec
 - lib/acts_as_oqgraph.rb
 - lib/graph_edge.rb
 - test/helper.rb