edge 0.1.0 → 0.2.0

data/README.md

@@ -32,18 +32,24 @@ acts_as_forest.
     class Location < ActiveRecord::Base
       acts_as_forest :order => "name"
     end
-    
+
     usa = Location.create! :name => "USA"
     illinois = usa.children.create! :name => "Illinois"
     chicago = illinois.children.create! :name => "Chicago"
     indiana = usa.children.create! :name => "Indiana"
     canada = Location.create! :name => "Canada"
     british_columbia = canada.children.create! :name => "British Columbia"
-    
+
     Location.root.all # [usa, canada]
     Location.find_forest # [usa, canada] with all children and parents preloaded
     Location.find_tree usa.id # load a single tree.
 
+It also provides the with_descendents scope to get all currently selected
+nodes and all there descendents. It can be chained after where scopes, but
+must not be used after any other type of scope.
+
+    Location.where(name: "Illinois").with_descendents.all # [illinois, chicago]
+
 ## Benchmarks
 
 Edge includes a performance benchmarks. You can create test forests with a
@@ -58,7 +64,7 @@ size of payload per node.
         -p, --payload NUM                Characters of payload per node
 
 Even on slower machines entire trees can be loaded quickly.
-        
+
     jack@moya:~/work/edge$ ruby -I lib -I bench bench/forest_find.rb
     Trees: 50
     Depth: 3
@@ -71,7 +77,7 @@ Even on slower machines entire trees can be loaded quickly.
     Load one tree 100 times                    0.830000   0.040000   0.870000 (  0.984642)
 
 ### Running the benchmarks
-    
+
 1. Create a database such as edge_bench.
 2. Configure bench/database.yml to connect to it.
 3. Load bench/database_structure.sql into your bench database.

data/Rakefile

@@ -1,2 +1,14 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+task :default => :spec
+
+namespace :db do
+  desc 'bootstrap database'
+  task :setup do
+    sh "createdb edge_test"
+    sh "psql edge_test < spec/database_structure.sql"
+  end
+end

data/lib/edge/forest.rb

@@ -8,32 +8,32 @@ module Edge
       # * order - how to order children (default: none)
       def acts_as_forest(options={})
         options.assert_valid_keys :foreign_key, :order
-        
+
         class_attribute :forest_foreign_key
         self.forest_foreign_key = options[:foreign_key] || "parent_id"
-        
+
         class_attribute :forest_order
         self.forest_order = options[:order] || nil
-                
+
         common_options = {
           :class_name => self,
           :foreign_key => forest_foreign_key
         }
-      
+
         belongs_to :parent, common_options
-          
+
         children_options = if forest_order
           common_options.merge(:order => forest_order)
         else
           common_options
         end
-        
+
         has_many :children, children_options
-        
+
         scope :root, where(forest_foreign_key => nil)
-        
+
         include Edge::Forest::InstanceMethods
-        
+
         # Finds entire forest and preloads all associations. It can be used at
         # the end of an ActiveRecord finder chain.
         #
@@ -44,23 +44,9 @@ module Edge
         #    # loads all nodes with matching names and all there descendants
         #    Category.where(:name => %w{clothing books electronics}).find_forest
         def find_forest
-          all_nodes = Arel::Table.new(:all_nodes)
-              
-          original_term = (current_scope || scoped).arel
-          iterated_term = Arel::SelectManager.new Arel::Table.engine
-          iterated_term.from(arel_table)
-            .project(arel_table.columns)
-            .join(all_nodes)
-            .on(arel_table[forest_foreign_key].eq all_nodes[:id])
-          
-          union = original_term.union(iterated_term)
-          
-          as_statement = Arel::Nodes::As.new all_nodes, union
-          
-          manager = Arel::SelectManager.new Arel::Table.engine
-          manager.with(:recursive, as_statement).from(all_nodes).project(Arel.star)
+          manager = recursive_manager.project(Arel.star)
           manager.order(forest_order) if forest_order
-          
+
           records = find_by_sql manager.to_sql
 
           records_by_id = records.each_with_object({}) { |r, h| h[r.id] = r }
@@ -72,7 +58,7 @@ module Edge
           end
 
           top_level_records = []
-          
+
           records.each do |r|
             parent = records_by_id[r[forest_foreign_key]]
             if parent
@@ -82,10 +68,10 @@ module Edge
               top_level_records.push(r)
             end
           end
-          
+
           top_level_records
         end
-        
+
         # Finds an a tree or trees by id.
         #
         # If any requested ids are not found it raises
@@ -100,44 +86,71 @@ module Edge
             trees.first
           end
         end
-      end      
+
+        # Returns a new scope that includes previously scoped records and their descendants by subsuming the previous scope into a subquery
+        #
+        # Only where scopes can precede this in a scope chain
+        def with_descendants
+          manager = recursive_manager.project('id')
+          unscoped.where(id: manager)
+        end
+
+        private
+        def recursive_manager
+          all_nodes = Arel::Table.new(:all_nodes)
+
+          original_term = (current_scope || scoped).arel
+          iterated_term = Arel::SelectManager.new Arel::Table.engine
+          iterated_term.from(arel_table)
+            .project(arel_table.columns)
+            .join(all_nodes)
+            .on(arel_table[forest_foreign_key].eq all_nodes[:id])
+
+          union = original_term.union(iterated_term)
+
+          as_statement = Arel::Nodes::As.new all_nodes, union
+
+          manager = Arel::SelectManager.new Arel::Table.engine
+          manager.with(:recursive, as_statement).from(all_nodes)
+        end
+      end
     end
-    
+
     module InstanceMethods
       # Returns the root of this node. If this node is root returns self.
       def root
         parent ? parent.root : self
       end
-      
+
       # Returns true is this node is a root or false otherwise
       def root?
         !parent_id
       end
-      
+
       # Returns all sibling nodes (nodes that have the same parent). If this
-      # node is a root node it returns an empty array.      
+      # node is a root node it returns an empty array.
       def siblings
         parent ? parent.children - [self] : []
       end
-      
-      # Returns all ancestors ordered by nearest ancestors first.      
+
+      # Returns all ancestors ordered by nearest ancestors first.
       def ancestors
         _ancestors = []
         node = self
         while(node = node.parent)
           _ancestors.push(node)
         end
-        
+
         _ancestors
       end
-      
+
       # Returns all descendants
       def descendants
         if children.present?
           children + children.map(&:descendants).flatten
         else
           []
-        end    
+        end
       end
     end
   end

data/lib/edge/version.rb

@@ -1,3 +1,3 @@
 module Edge
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/forest_spec.rb

@@ -8,28 +8,28 @@ describe "Edge::Forest" do
   let!(:usa) { Location.create! :name => "USA" }
   let!(:illinois) { Location.create! :parent => usa, :name => "Illinois" }
   let!(:chicago) { Location.create! :parent => illinois, :name => "Chicago" }
-  let!(:indiana) { Location.create! :parent => usa, :name => "Indiana" }  
+  let!(:indiana) { Location.create! :parent => usa, :name => "Indiana" }
   let!(:canada) { Location.create! :name => "Canada" }
   let!(:british_columbia) { Location.create! :parent => canada, :name => "British Columbia" }
-  
+
   describe "root?" do
     context "of root node" do
       it "should be true" do
         usa.root?.should == true
       end
     end
-    
+
     context "of child node" do
       it "should be false" do
         illinois.root?.should == false
       end
     end
-    
+
     context "of leaf node" do
       it "should be root node" do
         chicago.root?.should == false
       end
-    end    
+    end
   end
 
   describe "root" do
@@ -38,103 +38,103 @@ describe "Edge::Forest" do
         usa.root.should == usa
       end
     end
-    
+
     context "of child node" do
       it "should be root node" do
         illinois.root.should == usa
       end
     end
-    
+
     context "of leaf node" do
       it "should be root node" do
         chicago.root.should == usa
       end
     end
   end
-  
+
   describe "parent" do
     context "of root node" do
       it "should be nil" do
         usa.parent.should == nil
       end
     end
-    
+
     context "of child node" do
       it "should be parent" do
         illinois.parent.should == usa
       end
     end
-    
+
     context "of leaf node" do
       it "should be parent" do
         chicago.parent.should == illinois
       end
     end
   end
-  
+
   describe "ancestors" do
     context "of root node" do
       it "should be empty" do
         usa.ancestors.should be_empty
       end
     end
-    
+
     context "of leaf node" do
       it "should be ancestors ordered by ascending distance" do
         chicago.ancestors.should == [illinois, usa]
       end
     end
   end
-  
+
   describe "siblings" do
     context "of root node" do
       it "should be empty" do
         usa.siblings.should be_empty
       end
     end
-    
+
     context "of child node" do
       it "should be other children of parent" do
         illinois.siblings.should include(indiana)
       end
     end
   end
-  
+
   describe "children" do
     it "should be children" do
       usa.children.should include(illinois, indiana)
     end
-    
+
     it "should be ordered" do
       alabama = Location.create! :parent => usa, :name => "Alabama"
       usa.children.should == [alabama, illinois, indiana]
     end
-    
+
     context "of leaf" do
       it "should be empty" do
         chicago.children.should be_empty
       end
     end
   end
-  
+
   describe "descendants" do
     it "should be all descendants" do
       usa.descendants.should include(illinois, indiana, chicago)
     end
-    
+
     context "of leaf" do
       it "should be empty" do
         chicago.descendants.should be_empty
       end
     end
   end
-  
+
   describe "root scope" do
     it "returns only root nodes" do
       Location.root.all.should include(usa, canada)
     end
   end
-  
+
   describe "find_forest" do
     it "preloads all parents and children" do
       forest = Location.find_forest
@@ -150,39 +150,66 @@ describe "Edge::Forest" do
         end
       end
     end
-    
+
     it "works when scoped" do
       forest = Location.where(:name => "USA").find_forest
       forest.should include(usa)
     end
-    
+
     it "preloads children in proper order" do
       alabama = Location.create! :parent => usa, :name => "Alabama"
       forest = Location.find_forest
       tree = forest.find { |l| l.id == usa.id }
       tree.children.should == [alabama, illinois, indiana]
     end
+
+    context "with an infinite loop" do
+      before do
+        usa.update_attribute(:parent, chicago)
+      end
+
+      it "does not re-loop" do
+        Location.find_forest
+      end
+    end
   end
-  
+
   describe "find_tree" do
     it "finds by id" do
       tree = Location.find_tree usa.id
       tree.should == usa
     end
-    
+
     it "finds multiple trees by id" do
       trees = Location.find_tree [indiana.id, illinois.id]
       trees.should include(indiana, illinois)
     end
-    
+
     it "raises ActiveRecord::RecordNotFound when id is not found" do
       expect{Location.find_tree -1}.to raise_error(ActiveRecord::RecordNotFound)
     end
-    
+
     it "raises ActiveRecord::RecordNotFound when not all ids are not found" do
       expect{Location.find_tree [indiana.id, -1]}.to raise_error(ActiveRecord::RecordNotFound)
     end
-    
+
+  end
+
+  describe "with_descendants" do
+    context "unscoped" do
+      it "returns all records" do
+        Location.with_descendants.all.should =~ Location.all
+      end
+    end
+
+    context "scoped" do
+      it "returns a new scope that includes previously scoped records and their descendants" do
+        Location.where(id: canada.id).with_descendants.all.should =~ [canada, british_columbia]
+      end
+
+      it "is not commutative" do
+        Location.with_descendants.where(id: canada.id).all.should == [canada]
+      end
+    end
   end
-  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edge
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-11 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &14555680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *14555680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &14555260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14555260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &14554720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *14554720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &14554220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *14554220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &14553760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +85,12 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *14553760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: Graph functionality for ActiveRecord
 email:
 - jack@jackchristensen.com
@@ -112,9 +137,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Graph functionality for ActiveRecord. Provides tree/forest modeling structure
   that can load entire trees in a single query.
-test_files: []
+test_files:
+- spec/database.yml
+- spec/database_structure.sql
+- spec/forest_spec.rb
+- spec/spec_helper.rb