closure_tree 3.4.3 → 3.5.0

data/README.md

@@ -203,6 +203,9 @@ When you include ```acts_as_tree``` in your model, you can provide a hash to ove
 * ```Tag.roots``` returns all root nodes
 * ```Tag.leaves``` returns all leaf nodes
 * ```Tag.hash_tree``` returns an [ordered, nested hash](#nested-hashes) that can be depth-limited.
+* ```Tag.find_by_path(path)``` returns the node whose name path is ```path```. See (#find_or_create_by_path).
+* ```Tag.find_or_create_by_path(path)``` returns the node whose name path is ```path```, and will create the node if it doesn't exist already.See (#find_or_create_by_path).
+* ```Tag.find_all_by_generation(generation_level)``` returns the descendant nodes who are ```generation_level``` away from a root. ```Tag.find_all_by_generation(0)``` is equivalent to ```Tag.roots```.
 
 ### Instance methods
 
@@ -224,6 +227,12 @@ When you include ```acts_as_tree``` in your model, you can provide a hash to ove
 * ```tag.descendant_ids``` returns an array of the IDs of the descendants.
 * ```tag.self_and_descendants``` returns a scope of all children, childrens' children, etc., including self, ordered by depth.
 * ```tag.hash_tree``` returns an [ordered, nested hash](#nested-hashes) that can be depth-limited.
+* ```tag.find_by_path(path)``` returns the node whose name path *from ```tag```* is ```path```. See (#find_or_create_by_path).
+* ```tag.find_or_create_by_path(path)``` returns the node whose name path *from ```tag```* is ```path```, and will create the node if it doesn't exist already.See (#find_or_create_by_path).
+* ```tag.find_all_by_generation(generation_level)``` returns the descendant nodes who are ```generation_level``` away from ```tag```.
+    * ```tag.find_all_by_generation(0).to_a``` == ```[tag]```
+    * ```tag.find_all_by_generation(1)``` == ```tag.children```
+    * ```tag.find_all_by_generation(2)``` will return the tag's grandchildren, and so on.
 * ```tag.destroy``` will destroy a node and do <em>something</em> to its children, which is determined by the ```:dependent``` option passed to ```acts_as_tree```.
 
 ## <a id="sti"></a>Polymorphic hierarchies with STI
@@ -320,13 +329,12 @@ Closure tree is [tested under every combination](http://travis-ci.org/#!/mceache
 * The latest Rails 3.0, 3.1, and 3.2 branches, and
 * MySQL, PostgreSQL, and SQLite.
 
-
 ## Change log
 
-### 3.4.3
+### 3.5.0
 
-* Fixed [issue 19](https://github.com/mceachen/closure_tree/issues/19), which caused
-  ```self_and_siblings``` to fail if ```parent_id``` was not the ```parent_column_name```
+* Added ```find_all_by_generation```
+  for [feature request 17](https://github.com/mceachen/closure_tree/issues/17)).
 
 ### 3.4.2
 

data/lib/closure_tree/acts_as_tree.rb

@@ -87,6 +87,25 @@ module ClosureTree
         roots.inject(ActiveSupport::OrderedHash.new) { |h, ea| h.merge(ea.hash_tree(options)) }
       end
 
+      def find_all_by_generation(generation_level)
+        s = joins(<<-SQL)
+          INNER JOIN (
+            SELECT #{primary_key} as root_id
+            FROM #{quoted_table_name}
+            WHERE #{quoted_parent_column_name} IS NULL
+          ) AS roots
+          INNER JOIN (
+            SELECT ancestor_id, descendant_id
+            FROM #{quoted_hierarchy_table_name}
+            GROUP BY 1, 2
+            HAVING MAX(#{quoted_hierarchy_table_name}.generations) = #{generation_level.to_i}
+          ) AS descendants
+          ON #{quoted_table_name}.#{primary_key} = descendants.descendant_id
+            AND roots.root_id = ancestor_id
+        SQL
+        order_option ? s.order(order_option) : s
+      end
+
       def self.leaves
         s = joins(<<-SQL)
           INNER JOIN (
@@ -94,7 +113,7 @@ module ClosureTree
             FROM #{quoted_hierarchy_table_name}
             GROUP BY 1
             HAVING MAX(#{quoted_hierarchy_table_name}.generations) = 0
-          ) AS leaves ON (#{quoted_table_name}.#{primary_key} = leaves.ancestor_id)
+          ) AS leaves ON #{quoted_table_name}.#{primary_key} = leaves.ancestor_id
         SQL
         order_option ? s.order(order_option) : s
       end
@@ -205,6 +224,19 @@ module ClosureTree
       node
     end
 
+    def find_all_by_generation(generation_level)
+      s = self.class.joins(<<-SQL)
+          INNER JOIN (
+            SELECT descendant_id
+            FROM #{quoted_hierarchy_table_name}
+            WHERE ancestor_id = #{self.id}
+            GROUP BY 1
+            HAVING MAX(#{quoted_hierarchy_table_name}.generations) = #{generation_level.to_i}
+          ) AS descendants ON #{quoted_table_name}.#{self.class.primary_key} = descendants.descendant_id
+      SQL
+      order_option ? s.order(order_option) : s
+    end
+
     def hash_tree(options = {})
       tree = ActiveSupport::OrderedHash.new
       tree[self] = ActiveSupport::OrderedHash.new

data/lib/closure_tree/version.rb

@@ -1,3 +1,3 @@
 module ClosureTree
-  VERSION = "3.4.3" unless defined?(::ClosureTree::VERSION)
+  VERSION = "3.5.0" unless defined?(::ClosureTree::VERSION)
 end

data/spec/label_spec.rb

@@ -65,6 +65,48 @@ describe Label do
     end
   end
 
+  context "find_all_by_generation" do
+    before :all do
+      nuke_db
+      @d1 = Label.find_or_create_by_path %w(a b c1 d1)
+      @d2 = Label.find_or_create_by_path %w(a b c2 d2)
+      @c1 = @d1.parent
+      @c2 = @d2.parent
+      @b = @c1.parent
+      @a = @b.parent
+    end
+
+    it "finds roots from the class method" do
+      Label.find_all_by_generation(1).to_a.should == [@b]
+    end
+
+    it "finds roots from themselves" do
+      @a.find_all_by_generation(0).to_a.should == [@a]
+    end
+
+    it "finds itself for non-roots" do
+      @b.find_all_by_generation(0).to_a.should == [@b]
+    end
+
+    it "finds children for roots" do
+      Label.find_all_by_generation(1).to_a.should == [@b]
+    end
+
+    it "finds children" do
+      @a.find_all_by_generation(1).to_a.should == [@b]
+      @b.find_all_by_generation(1).to_a.should == [@c1, @c2]
+    end
+
+    it "finds grandchildren for roots" do
+      Label.find_all_by_generation(2).to_a.should == [@c1, @c2]
+    end
+
+    it "finds grandchildren" do
+      @a.find_all_by_generation(2).to_a.should == [@c1, @c2]
+      @b.find_all_by_generation(2).to_a.should == [@d1, @d2]
+    end
+  end
+
   context "Deterministic siblings sort with custom integer column" do
     nuke_db
     fixtures :labels

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: closure_tree
 version: !ruby/object:Gem::Version
-  version: 3.4.3
+  version: 3.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -192,7 +192,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1873822360950581335
+      hash: 1009921537345124595
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -201,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1873822360950581335
+      hash: 1009921537345124595
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23