closure_tree 3.9.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA512: 
-  metadata.gz: 4eba6a7034297fd15958c27428782adc3a1b36abc1f0723039583418c33eb08377e3b5cfa744aae985cdd2b1b2cbd91138486e2a0591c0ff2f9c1fcb9893361d
-  data.tar.gz: 8f8f339d462f846bfb59c260756d94ad8328a9bea1f4bf9ad2d9d00317f05efd7f8d099eee2b1c1a8e661ccef827fcbb46cb9f5a22f9e0f816bd5b8118fea9c4
+  metadata.gz: e94fc2a743703667fdfdc150ad5d24ea7799956355191476d15856f81213154f4f2cc8a0981ca978ad80278ccc1201b38ccd9143e1ec00e1ffa243a238ad1d8a
+  data.tar.gz: b5c221f82dbf36750c90a834632b550baa0b2e7d82bc3d9f41621716958e0ed26eb29be8ab480800ff5509b0dafd207dfef558f2079189a5b4f1be8b9eea6809
 SHA1: 
-  metadata.gz: f04e325774ddd75fddfaeb47753095903350aed8
-  data.tar.gz: 66ed5c26efe5cac30d3bb3e3d1d128ae67d4e184
+  metadata.gz: 6f2021ccd1462a82b2735a5b28219c4d870a69a3
+  data.tar.gz: e8559d6b2aeed3aa0dffb07998b3655972ad9b8b

data/README.md

@@ -278,6 +278,27 @@ class WhereTag < Tag ; end
 class WhatTag < Tag ; end
 ```
 
+Please note that Rails (<= 3.2) doesn't handle polymorphic associations correctly if
+you use the ```:type``` attribute, so **this doesn't work**:
+
+```ruby
+# BAD: ActiveRecord ignores the :type attribute:
+root.children.create(:name => "child", :type => "WhenTag")
+```
+
+Instead, use either ```.add_child``` or ```children <<```:
+
+```ruby
+# GOOD!
+a = Tag.create!(:name => "a")
+b = WhenTag.new(:name => "b")
+a.children << b
+c = WhatTag.new(:name => "c")
+b.add_child(c)
+```
+
+See [issue 43](https://github.com/mceachen/closure_tree/issues/43) for more information.
+
 ## Deterministic ordering
 
 By default, children will be ordered by your database engine, which may not be what you want.
@@ -315,6 +336,9 @@ When you enable ```order```, you'll also have the following new methods injected
 
 If your ```order``` column is an integer attribute, you'll also have these:
 
+* The class method ```#roots_and_descendants_preordered```, which returns all nodes in your tree,
+  [pre-ordered](http://en.wikipedia.org/wiki/Tree_traversal#Pre-order).
+
 * ```node1.self_and_descendants_preordered``` which will return descendants,
   [pre-ordered](http://en.wikipedia.org/wiki/Tree_traversal#Pre-order).
 
@@ -420,6 +444,11 @@ Parallelism is not tested with Rails 3.0.x nor 3.1.x due to this
 
 ## Change log
 
+### 3.10.0
+
+* Added ```#roots_and_descendants_preordered```.
+  Thanks for the suggestion, [Leonel Galan](https://github.com/leonelgalan)!
+
 ### 3.9.0
 
 * Added ```.child_ids```.

data/lib/closure_tree/deterministic_ordering.rb

@@ -1,17 +1,33 @@
 module ClosureTree
   module DeterministicOrdering
-    def order_column
-      o = order_option
-      o.split(' ', 2).first if o
-    end
+    extend ActiveSupport::Concern
+
+    module ClassAndInstanceMethods
+      def order_column
+        o = order_option
+        o.split(' ', 2).first if o
+      end
+
+      def require_order_column
+        raise ":order value, '#{order_option}', isn't a column" if order_column.nil?
+      end
+
+      def order_column_sym
+        require_order_column
+        order_column.to_sym
+      end
 
-    def require_order_column
-      raise ":order value, '#{order_option}', isn't a column" if order_column.nil?
+      def quoted_order_column(include_table_name = true)
+        require_order_column
+        prefix = include_table_name ? "#{quoted_table_name}." : ""
+        "#{prefix}#{connection.quote_column_name(order_column)}"
+      end
     end
 
-    def order_column_sym
-      require_order_column
-      order_column.to_sym
+    include ClassAndInstanceMethods
+
+    module ClassMethods
+      include ClassAndInstanceMethods
     end
 
     def order_value
@@ -22,12 +38,6 @@ module ClosureTree
       write_attribute(order_column_sym, new_order_value)
     end
 
-    def quoted_order_column(include_table_name = true)
-      require_order_column
-      prefix = include_table_name ? "#{quoted_table_name}." : ""
-      "#{prefix}#{connection.quote_column_name(order_column)}"
-    end
-
     def siblings_before
       siblings.where(["#{quoted_order_column} < ?", order_value])
     end

data/lib/closure_tree/numeric_deterministic_ordering.rb

@@ -1,6 +1,8 @@
 # This module is only included if the order column is an integer.
 module ClosureTree
   module DeterministicNumericOrdering
+    extend ActiveSupport::Concern
+
     def self_and_descendants_preordered
       # TODO: raise NotImplementedError if sort_order is not numeric and not null?
       h = connection.select_one(<<-SQL)
@@ -24,6 +26,32 @@ module ClosureTree
       self_and_descendants.joins(join_sql).group("#{quoted_table_name}.id").reorder(order_by)
     end
 
+    module ClassMethods
+      def roots_and_descendants_preordered
+        h = connection.select_one(<<-SQL)
+          SELECT
+            count(*) as total_descendants,
+            max(generations) as max_depth
+          FROM #{quoted_hierarchy_table_name}
+        SQL
+        join_sql = <<-SQL
+          JOIN #{quoted_hierarchy_table_name} anc_hier
+            ON anc_hier.descendant_id = #{quoted_table_name}.id
+          JOIN #{quoted_table_name} anc
+            ON anc.id = anc_hier.ancestor_id
+          JOIN (
+            SELECT descendant_id, max(generations) AS max_depth
+            FROM #{quoted_hierarchy_table_name}
+            GROUP BY 1
+          ) AS depths ON depths.descendant_id = anc.id
+        SQL
+        node_score = "(1 + anc.#{quoted_order_column(false)}) * " +
+          "power(#{h['total_descendants']}, #{h['max_depth'].to_i + 1} - depths.max_depth)"
+        order_by = "sum(#{node_score})"
+        joins(join_sql).group("#{quoted_table_name}.id").reorder(order_by)
+      end
+    end
+
     def append_sibling(sibling_node, use_update_all = true)
       add_sibling(sibling_node, use_update_all, true)
     end

data/lib/closure_tree/version.rb

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

data/spec/label_spec.rb

@@ -19,7 +19,7 @@ def create_label_tree
   Label.update_all("sort_order = id")
 end
 
-def create_preorder_tree
+def create_preorder_tree(suffix = "")
   %w(
     a/l/n/r
     a/l/n/q
@@ -30,16 +30,18 @@ def create_preorder_tree
     a/b/c/d/g
     a/b/c/d/f
     a/b/c/d/e
-  ).shuffle.each { |ea| Label.find_or_create_by_path(ea.split '/') }
-  a = Label.find_by_path(["a"])
-  a.order_value = 0
-  a.save!
-  a.self_and_descendants.each do |ea|
-    ea.children.to_a.sort_by(&:name).each_with_index do |ea, idx|
-      ea.order_value = idx
+  ).shuffle.each { |ea| Label.find_or_create_by_path(ea.split('/').collect { |ea| "#{ea}#{suffix}" }) }
+
+  Label.roots.each_with_index do |root, root_idx|
+    root.order_value = root_idx
+    root.save!
+    root.self_and_descendants.each do |ea|
+      ea.children.to_a.sort_by(&:name).each_with_index do |ea, idx|
+        ea.order_value = idx
       ea.save!
     end
   end
+  end
 end
 
 describe Label do
@@ -113,7 +115,24 @@ describe Label do
         end
       end
     end
+
+    it "supports children << and add_child" do
+      a = EventLabel.create!(:name => "a")
+      b = DateLabel.new(:name => "b")
+      a.children << b
+      c = Label.new(:name => "c")
+      b.add_child(c)
+
+      a.self_and_descendants.collect do |ea|
+        ea.class
+      end.should == [EventLabel, DateLabel, Label]
+
+      a.self_and_descendants.collect do |ea|
+        ea.name
+      end.should == %w(a b c)
+    end
   end
+
   context "find_all_by_generation" do
     before :all do
       delete_all_labels
@@ -318,13 +337,20 @@ describe Label do
     end
   end
 
-  context ".self_and_descendants_preordered" do
+  context "preorder" do
     it "returns descendants in proper order" do
       delete_all_labels
       create_preorder_tree
       a = Label.root
       a.name.should == "a"
-      a.self_and_descendants_preordered.collect { |ea| ea.name }.should == ('a'..'r').to_a
+      expected = ('a'..'r').to_a
+      a.self_and_descendants_preordered.collect { |ea| ea.name }.should == expected
+      Label.roots_and_descendants_preordered.collect { |ea| ea.name }.should == expected
+      create_preorder_tree("1")
+      # Should be no change:
+      a.reload.self_and_descendants_preordered.collect { |ea| ea.name }.should == expected
+      expected += ('a'..'r').collect { |ea| "#{ea}1" }
+      Label.roots_and_descendants_preordered.collect { |ea| ea.name }.should == expected
     end
   end unless ENV["DB"] == "sqlite"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: closure_tree
 version: !ruby/object:Gem::Version 
-  version: 3.9.0
+  version: 3.10.0
 platform: ruby
 authors: 
 - Matthew McEachen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-03-06 00:00:00 Z
+date: 2013-03-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord