activerecord-recursive_tree_scopes 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efa3ff153255f4cac37a076ac482b8d13ef8825d
-  data.tar.gz: b5918f4bda320f432e0b51711423a815c9fa8a9b
+  metadata.gz: 8aa1c8117447b477a47776f01fe8588ffcbe695e
+  data.tar.gz: 037dcf0df1b722b581642b2a3fe6ea960ffd4505
 SHA512:
-  metadata.gz: 82b635e671e577ddca6a369351f1d98fc013b027330472241498e546c9c33844e7cbec8c34b97ebadc742126190d2e4b5a69cf80dfcb02e3d3decf985687925d
-  data.tar.gz: adb8ffcf9ff36ba16d98fc5b20edf9456c27f5da2b9b739a809db7d789c5d1daa7cd7083ac5cc3b9ee7c163c342b6403ccc0adce3a67208a4ae93f731714097b
+  metadata.gz: 8d929d9155abc09b234d1e994887ce1c4f5e61211229b65cd4e5ec94cd7e1c78ff6ba312426872134cde98aadd1e6ace5754ca301fce4d68051ce1132ff980f0
+  data.tar.gz: 374c820c032e89a7c5fecd1807397676935b3eb0c332139db7b7005609ed9d6a3abdd775024990973be1d5bc39567bf6c8e84cc88c05e54ba5054a50bca5d840

data/README.md

@@ -61,6 +61,21 @@ ORDER BY employees.id
 ```
 
 
+# Advanced Usage
+Multiple key trees are supported. For example, a `Person` model may have 
+`mother_id` and `father_id` keys. That's no problem, just tell the scope about
+both keys. `person.progenitors` will return all ancestors, mothers and fathers.
+```ruby
+class Person < ActiveRecord::Base
+  belongs_to :mother, class_name: 'Person'
+  belongs_to :father, class_name: 'Person'
+
+  has_ancestors   :progenitors, key: [ :mother_id, :father_id ]
+  has_descendants :progeny,     key: [ :mother_id, :father_id ]
+end
+```
+
+
 ## Friendly
 
 Go ahead, chain away:
@@ -96,7 +111,7 @@ ORDER BY employees.id
 
 
 ## Requirements
-* ActiveRecord >= 3.0.0
+* ActiveRecord >= 3.1.0
 * PostgreSQL >= 8.4
 
 
@@ -105,9 +120,15 @@ ORDER BY employees.id
 Add `gem 'activerecord-recursive_tree_scopes'` to your Gemfile.
 
 
+## Alternatives
+
+The [Edge](https://github.com/JackC/edge) gem is similar but makes better use 
+of Arel and relations.
+
+
 ## Thanks
 
-Thanks to [Joshua Davey](https://github.com/jgdavey) who's 
+Thanks to [Joshua Davey](https://github.com/jgdavey), his 
 [blog post](http://hashrocket.com/blog/posts/recursive-sql-in-activerecord) 
 inspired this gem.
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/activerecord-recursive_tree_scopes.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "activerecord-recursive_tree_scopes"
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Wulff"]
-  s.date = "2013-10-01"
+  s.date = "2013-10-02"
   s.description = "Using an ActiveRecord scope, recursively query trees."
   s.email = "johnw@orcasnet.com"
   s.extra_rdoc_files = [
@@ -37,7 +37,8 @@ Gem::Specification.new do |s|
     "spec/database.yml.travis",
     "spec/spec_helper.rb",
     "spec/support/create_schema.rb",
-    "spec/support/employee.rb"
+    "spec/support/employee.rb",
+    "spec/support/person.rb"
   ]
   s.homepage = "http://github.com/jwulff/activerecord-recursive_tree_scopes"
   s.licenses = ["MIT"]

data/lib/activerecord-recursive_tree_scopes.rb

@@ -2,7 +2,7 @@ module RecursiveTreeScopes
   module ModelMixin
     def has_ancestors(ancestors_name = :ancestors, options = {})
       options[:key] ||= :parent_id
-      
+
       scope ancestors_name, lambda{ |record|
         RecursiveTreeScopes::Scopes.ancestors_for(record, options[:key])
       }
@@ -36,20 +36,21 @@ module RecursiveTreeScopes
       end
 
       def ancestors_sql_for(instance, key)
+        keys = [ key ].flatten
         tree_sql =  <<-SQL
-          WITH RECURSIVE ancestor_search(id, #{key}, path) AS (
-              SELECT id, #{key}, ARRAY[id]
+          WITH RECURSIVE ancestor_search(id, #{keys.join ', '}, path) AS (
+              SELECT id, #{keys.join ', '}, ARRAY[id]
                 FROM #{instance.class.table_name}
                 WHERE id = #{instance.id}
             UNION ALL
-              SELECT #{instance.class.table_name}.id, #{instance.class.table_name}.#{key}, path || #{instance.class.table_name}.id
+              SELECT #{instance.class.table_name}.id, #{keys.collect{|key| "#{instance.class.table_name}.#{key}" }.join ', '}, path || #{instance.class.table_name}.id
                 FROM #{instance.class.table_name}, ancestor_search
-                WHERE ancestor_search.#{key} = #{instance.class.table_name}.id
+                WHERE #{keys.collect{ |key| "ancestor_search.#{key} = #{instance.class.table_name}.id" }.join ' OR '}
             )
           SELECT id
             FROM ancestor_search
             WHERE id != #{instance.id}
-            ORDER BY path
+            ORDER BY array_length(path, 1), path
         SQL
         tree_sql.gsub(/\s{2,}/, ' ')
       end
@@ -59,6 +60,7 @@ module RecursiveTreeScopes
       end
 
       def descendants_sql_for(instance, key)
+        keys = [ key ].flatten
         tree_sql =  <<-SQL
           WITH RECURSIVE descendants_search(id, path) AS (
               SELECT id, ARRAY[id]
@@ -67,13 +69,14 @@ module RecursiveTreeScopes
             UNION ALL
               SELECT #{instance.class.table_name}.id, path || #{instance.class.table_name}.id
               FROM descendants_search
-              JOIN #{instance.class.table_name} ON #{instance.class.table_name}.#{key} = descendants_search.id
+              JOIN #{instance.class.table_name}
+              ON #{keys.collect{ |key| "descendants_search.id = #{instance.class.table_name}.#{key}" }.join ' OR '}
               WHERE NOT #{instance.class.table_name}.id = ANY(path)
           )
           SELECT id
             FROM descendants_search
             WHERE id != #{instance.id}
-            ORDER BY path
+            ORDER BY array_length(path, 1), path
         SQL
         tree_sql.gsub(/\s{2,}/, ' ')
       end

data/spec/activerecord-recursive_tree_scopes_spec.rb

@@ -1,112 +1,212 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "ActiverecordRecursiveTreeScopes" do
-  let!(:alonso)  { Employee.create! name: 'Alonso'                    }
-  let!(:alfred)  { Employee.create! name: 'Alfred'                    }
-  let!(:barry)   { Employee.create! name: 'Barry',   manager: alfred  }
-  let!(:bob)     { Employee.create! name: 'Bob',     manager: alfred  }
-  let!(:charles) { Employee.create! name: 'Charles', manager: barry   }
-  let!(:cameron) { Employee.create! name: 'Cameron', manager: barry   }
-  let!(:carl)    { Employee.create! name: 'Carl',    manager: barry   }
-  let!(:dave)    { Employee.create! name: 'Dave',    manager: carl    }
-  let!(:daryl)   { Employee.create! name: 'Daryl',   manager: charles }
-  let!(:dick)    { Employee.create! name: 'Dick',    manager: charles }
-  let!(:edward)  { Employee.create! name: 'Edward',  manager: dick    }
-  let!(:frank)   { Employee.create! name: 'Frank',   manager: edward  }
-
-  describe 'Alonso' do
-    subject { alonso }
-    its(:manager) { should be_nil }
-    its(:directly_managed) { should == [] }
-    its(:managers) { should == [] }
-    its(:managed) { should == [] }
-  end
-
-  describe 'Alfred' do
-    subject { alfred }
-    its(:manager) { should be_nil }
-    its(:directly_managed) { should == [ barry, bob ] }
-    its(:managers) { should == [] }
-    its(:managed) { should == [ barry, bob, charles, cameron, carl, dave, daryl, dick, edward, frank ] }
+  describe 'simple tree' do
+    let!(:alonso)  { Employee.create! name: 'Alonso'                    }
+    let!(:alfred)  { Employee.create! name: 'Alfred'                    }
+    let!(:barry)   { Employee.create! name: 'Barry',   manager: alfred  }
+    let!(:bob)     { Employee.create! name: 'Bob',     manager: alfred  }
+    let!(:charles) { Employee.create! name: 'Charles', manager: barry   }
+    let!(:cameron) { Employee.create! name: 'Cameron', manager: barry   }
+    let!(:carl)    { Employee.create! name: 'Carl',    manager: barry   }
+    let!(:dave)    { Employee.create! name: 'Dave',    manager: carl    }
+    let!(:daryl)   { Employee.create! name: 'Daryl',   manager: charles }
+    let!(:dick)    { Employee.create! name: 'Dick',    manager: charles }
+    let!(:edward)  { Employee.create! name: 'Edward',  manager: dick    }
+    let!(:frank)   { Employee.create! name: 'Frank',   manager: edward  }
+    
+    describe 'chaining' do
+      describe 'ancestors' do
+        it do
+          frank.managers.where(name: 'Barry').should == [ barry ]
+        end
+      end
+    
+      describe 'descendants' do
+        it do
+          barry.managed.where("name LIKE ?", 'D%').should == [ dave, daryl, dick ]
+        end
+      end
+    end
+    
+    describe 'Alonso' do
+      subject { alonso }
+      its(:manager) { should be_nil }
+      its(:directly_managed) { should == [] }
+      its(:managers) { should == [] }
+      its(:managed) { should == [] }
+    end
+    
+    describe 'Alfred' do
+      subject { alfred }
+      its(:manager) { should be_nil }
+      its(:directly_managed) { should == [ barry, bob ] }
+      its(:managers) { should == [] }
+      its(:managed) { should == [ barry, bob, charles, cameron, carl, dave, daryl, dick, edward, frank ] }
+    end
+    
+    describe 'Barry' do
+      subject { barry }
+      its(:manager) { should == alfred }
+      its(:directly_managed) { should == [ charles, cameron, carl ] }
+      its(:managers) { should == [ alfred ] }
+      its(:managed) { should == [ charles, cameron, carl, dave, daryl, dick, edward, frank ] }
+    end
+    
+    describe 'Bob' do
+      subject { bob }
+      its(:manager) { should == alfred }
+      its(:directly_managed) { should == [] }
+      its(:managers) { should == [ alfred ] }
+      its(:managed) { should == [] }
+    end
+    
+    describe 'Charles' do
+      subject { charles }
+      its(:manager) { should == barry }
+      its(:directly_managed) { should == [ daryl, dick ] }
+      its(:managers) { should == [ alfred, barry ] }
+      its(:managed) { should == [ daryl, dick, edward, frank ] }
+    end
+    
+    describe 'Cameron' do
+      subject { cameron }
+      its(:manager) { should == barry }
+      its(:directly_managed) { should == [] }
+      its(:managers) { should == [ alfred, barry ] }
+      its(:managed) { should == [] }
+    end
+    
+    describe 'Carl' do
+      subject { carl }
+      its(:manager) { should == barry }
+      its(:directly_managed) { should == [ dave ] }
+      its(:managers) { should == [ alfred, barry ] }
+      its(:managed) { should == [ dave ] }
+    end
+    
+    describe 'Dave' do
+      subject { dave }
+      its(:manager) { should == carl }
+      its(:directly_managed) { should == [] }
+      its(:managers) { should == [ alfred, barry, carl ] }
+      its(:managed) { should == [] }
+    end
+    
+    describe 'Daryl' do
+      subject { daryl }
+      its(:manager) { should == charles }
+      its(:directly_managed) { should == [] }
+      its(:managers) { should == [ alfred, barry, charles ] }
+      its(:managed) { should == [] }
+    end
+    
+    describe 'Dick' do
+      subject { dick }
+      its(:manager) { should == charles }
+      its(:directly_managed) { should == [ edward ] }
+      its(:managers) { should == [ alfred, barry, charles ] }
+      its(:managed) { should == [ edward, frank ] }
+    end
+    
+    describe 'Edward' do
+      subject { edward }
+      its(:manager) { should == dick }
+      its(:directly_managed) { should == [ frank ] }
+      its(:managers) { should == [ alfred, barry, charles, dick ] }
+      its(:managed) { should == [ frank ] }
+    end
+    
+    describe 'Frank' do
+      subject { frank }
+      its(:manager) { should == edward }
+      its(:directly_managed) { should == [] }
+      its(:managers) { should == [ alfred, barry, charles, dick, edward ] }
+      its(:managed) { should == [] }
+    end
   end
 
-  describe 'Barry' do
-    subject { barry }
-    its(:manager) { should == alfred }
-    its(:directly_managed) { should == [ charles, cameron, carl ] }
-    its(:managers) { should == [ alfred ] }
-    its(:managed) { should == [ charles, cameron, carl, dave, daryl, dick, edward, frank ] }
-  end
+  describe 'multiple key tree' do
+    let!(:george)  { Person.create! name: 'George' }
+    let!(:hazel)   { Person.create! name: 'Hazel' }
+    let!(:bill)    { Person.create! name: 'Bill', father: george, mother: hazel }
+    let!(:william) { Person.create! name: 'William' }
+    let!(:sharlyn) { Person.create! name: 'Sharlyn' }
+    let!(:tamara)  { Person.create! name: 'Tamara', father: william, mother: sharlyn }
+    let!(:john)    { Person.create! name: 'John', father: bill, mother: tamara }
+    let!(:mark)    { Person.create! name: 'Mark', father: bill, mother: tamara }
+    let!(:buster)  { Person.create! name: 'Buster', father: john }
 
-  describe 'Bob' do
-    subject { bob }
-    its(:manager) { should == alfred }
-    its(:directly_managed) { should == [] }
-    its(:managers) { should == [ alfred ] }
-    its(:managed) { should == [] }
-  end
+    describe 'George' do
+      subject { george }
+      its(:mother) { should be_nil }
+      its(:father) { should be_nil }
+      its(:progenitors) { should == [] }
+      its(:progeny) { should == [ bill, john, mark, buster ] }
+    end
 
-  describe 'Charles' do
-    subject { charles }
-    its(:manager) { should == barry }
-    its(:directly_managed) { should == [ daryl, dick ] }
-    its(:managers) { should == [ alfred, barry ] }
-    its(:managed) { should == [ daryl, dick, edward, frank ] }
-  end
+    describe 'Hazel' do
+      subject { hazel }
+      its(:mother) { should be_nil }
+      its(:father) { should be_nil }
+      its(:progenitors) { should == [] }
+      its(:progeny) { should == [ bill, john, mark, buster ] }
+    end
 
-  describe 'Cameron' do
-    subject { cameron }
-    its(:manager) { should == barry }
-    its(:directly_managed) { should == [] }
-    its(:managers) { should == [ alfred, barry ] }
-    its(:managed) { should == [] }
-  end
+    describe 'William' do
+      subject { william }
+      its(:mother) { should be_nil }
+      its(:father) { should be_nil }
+      its(:progenitors) { should == [] }
+      its(:progeny) { should == [ tamara, john, mark, buster ] }
+    end
 
-  describe 'Carl' do
-    subject { carl }
-    its(:manager) { should == barry }
-    its(:directly_managed) { should == [ dave ] }
-    its(:managers) { should == [ alfred, barry ] }
-    its(:managed) { should == [ dave ] }
-  end
+    describe 'Sharlyn' do
+      subject { sharlyn }
+      its(:mother) { should be_nil }
+      its(:father) { should be_nil }
+      its(:progenitors) { should == [] }
+      its(:progeny) { should == [ tamara, john, mark, buster ] }
+    end
 
-  describe 'Dave' do
-    subject { dave }
-    its(:manager) { should == carl }
-    its(:directly_managed) { should == [] }
-    its(:managers) { should == [ alfred, barry, carl ] }
-    its(:managed) { should == [] }
-  end
+    describe 'Bill' do
+      subject { bill }
+      its(:mother) { should == hazel }
+      its(:father) { should == george }
+      its(:progenitors) { should == [ george, hazel ] }
+      its(:progeny) { should == [ john, mark, buster ] }
+    end
 
-  describe 'Daryl' do
-    subject { daryl }
-    its(:manager) { should == charles }
-    its(:directly_managed) { should == [] }
-    its(:managers) { should == [ alfred, barry, charles ] }
-    its(:managed) { should == [] }
-  end
+    describe 'Tamara' do
+      subject { tamara }
+      its(:mother) { should == sharlyn }
+      its(:father) { should == william }
+      its(:progenitors) { should == [ william, sharlyn ] }
+      its(:progeny) { should == [ john, mark, buster ] }
+    end
 
-  describe 'Dick' do
-    subject { dick }
-    its(:manager) { should == charles }
-    its(:directly_managed) { should == [ edward ] }
-    its(:managers) { should == [ alfred, barry, charles ] }
-    its(:managed) { should == [ edward, frank ] }
-  end
+    describe 'John' do
+      subject { john }
+      its(:mother) { should == tamara }
+      its(:father) { should == bill }
+      its(:progenitors) { should == [ george, hazel, bill, william, sharlyn, tamara ] }
+      its(:progeny) { should == [ buster ] }
+    end
 
-  describe 'Edward' do
-    subject { edward }
-    its(:manager) { should == dick }
-    its(:directly_managed) { should == [ frank ] }
-    its(:managers) { should == [ alfred, barry, charles, dick ] }
-    its(:managed) { should == [ frank ] }
-  end
+    describe 'Mark' do
+      subject { mark }
+      its(:mother) { should == tamara }
+      its(:father) { should == bill }
+      its(:progenitors) { should == [ george, hazel, bill, william, sharlyn, tamara ] }
+      its(:progeny) { should == [] }
+    end
 
-  describe 'Frank' do
-    subject { frank }
-    its(:manager) { should == edward }
-    its(:directly_managed) { should == [] }
-    its(:managers) { should == [ alfred, barry, charles, dick, edward ] }
-    its(:managed) { should == [] }
+    describe 'Buster' do
+      subject { buster }
+      its(:mother) { should be_nil }
+      its(:father) { should == john }
+      its(:progenitors) { should == [ george, hazel, bill, william, sharlyn, tamara, john ] }
+      its(:progeny) { should == [] }
+    end
   end
 end

data/spec/support/create_schema.rb

@@ -6,9 +6,19 @@ class CreateSchema < ActiveRecord::Migration
     end
 
     execute "ALTER TABLE employees ADD CONSTRAINT employees_fk_manager_id FOREIGN KEY (manager_id) REFERENCES employees (id)"
+
+    create_table :people do |t|
+      t.string  :name
+      t.integer :mother_id
+      t.integer :father_id
+    end
+    
+    execute "ALTER TABLE people ADD CONSTRAINT people_fk_mother_id FOREIGN KEY (mother_id) REFERENCES people (id)"
+    execute "ALTER TABLE people ADD CONSTRAINT people_fk_father_id FOREIGN KEY (father_id) REFERENCES people (id)"
   end
 
   def down
     drop_table :employees
+    drop_table :people
   end
 end

data/spec/support/person.rb

@@ -0,0 +1,7 @@
+class Person < ActiveRecord::Base
+  belongs_to :mother, class_name: 'Person'
+  belongs_to :father, class_name: 'Person'
+
+  has_ancestors   :progenitors, key: [ :mother_id, :father_id ]
+  has_descendants :progeny,     key: [ :mother_id, :father_id ]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-recursive_tree_scopes
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - John Wulff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -109,6 +109,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/create_schema.rb
 - spec/support/employee.rb
+- spec/support/person.rb
 homepage: http://github.com/jwulff/activerecord-recursive_tree_scopes
 licenses:
 - MIT