closure_tree 3.7.3 → 3.8.0

data/lib/closure_tree/numeric_deterministic_ordering.rb

@@ -0,0 +1,65 @@
+# This module is only included if the order column is an integer.
+module ClosureTree
+  module DeterministicNumericOrdering
+    def self_and_descendants_preordered
+      # TODO: raise NotImplementedError if sort_order is not numeric and not null?
+      h = connection.select_one(<<-SQL)
+        SELECT
+          count(*) as total_descendants,
+          max(generations) as max_depth
+        FROM #{quoted_hierarchy_table_name}
+        WHERE ancestor_id = #{ct_quote(self.id)}
+      SQL
+      join_sql = <<-SQL
+        JOIN #{quoted_hierarchy_table_name} anc_hier
+          ON anc_hier.descendant_id = #{quoted_hierarchy_table_name}.descendant_id
+        JOIN #{quoted_table_name} anc
+          ON anc.id = anc_hier.ancestor_id
+        JOIN #{quoted_hierarchy_table_name} depths
+          ON depths.ancestor_id = #{ct_quote(self.id)} AND 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.generations)"
+      order_by = "sum(#{node_score})"
+      self_and_descendants.joins(join_sql).group("#{quoted_table_name}.id").reorder(order_by)
+    end
+
+    def append_sibling(sibling_node, use_update_all = true)
+      add_sibling(sibling_node, use_update_all, true)
+    end
+
+    def prepend_sibling(sibling_node, use_update_all = true)
+      add_sibling(sibling_node, use_update_all, false)
+    end
+
+    def add_sibling(sibling_node, use_update_all = true, add_after = true)
+      fail "can't add self as sibling" if self == sibling_node
+      # issue 40: we need to lock the parent to prevent deadlocks on parallel sibling additions
+      ct_with_advisory_lock do
+        # issue 18: we need to set the order_value explicitly so subsequent orders will work.
+        update_attribute(:order_value, 0) if self.order_value.nil?
+        sibling_node.order_value = self.order_value.to_i + (add_after ? 1 : -1)
+        # We need to incr the before_siblings to make room for sibling_node:
+        if use_update_all
+          col = quoted_order_column(false)
+          # issue 21: we have to use the base class, so STI doesn't get in the way of only updating the child class instances:
+          ct_base_class.update_all(
+            ["#{col} = #{col} #{add_after ? '+' : '-'} 1", "updated_at = now()"],
+            ["#{quoted_parent_column_name} = ? AND #{col} #{add_after ? '>=' : '<='} ?",
+              ct_parent_id,
+              sibling_node.order_value])
+        else
+          last_value = sibling_node.order_value.to_i
+          (add_after ? siblings_after : siblings_before.reverse).each do |ea|
+            last_value += (add_after ? 1 : -1)
+            ea.order_value = last_value
+            ea.save!
+          end
+        end
+        sibling_node.parent = self.parent
+        sibling_node.save!
+        sibling_node.reload
+      end
+    end
+  end
+end

data/lib/closure_tree/version.rb

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

data/lib/closure_tree/with_advisory_lock.rb

@@ -0,0 +1,18 @@
+require 'with_advisory_lock'
+
+module ClosureTree
+  module WithAdvisoryLock
+    def ct_with_advisory_lock(&block)
+      if closure_tree_options[:with_advisory_lock]
+        with_advisory_lock("closure_tree") do
+          transaction do
+            yield
+          end
+        end
+      else
+        yield
+      end
+    end
+  end
+end
+

data/spec/label_spec.rb

@@ -5,7 +5,7 @@ def delete_all_labels
   Label.delete_all
 end
 
-def create_label_hierarchy
+def create_label_tree
   @d1 = Label.find_or_create_by_path %w(a1 b1 c1 d1)
   @c1 = @d1.parent
   @b1 = @c1.parent
@@ -19,6 +19,29 @@ def create_label_hierarchy
   Label.update_all("sort_order = id")
 end
 
+def create_preorder_tree
+  %w(
+    a/l/n/r
+    a/l/n/q
+    a/l/n/p
+    a/l/n/o
+    a/l/m
+    a/b/h/i/j/k
+    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
+      ea.save!
+    end
+  end
+end
+
 describe Label do
   context "Base Label class" do
     it "should find or create by path" do
@@ -81,7 +104,7 @@ describe Label do
   context "find_all_by_generation" do
     before :all do
       delete_all_labels
-      create_label_hierarchy
+      create_label_tree
     end
 
     it "finds roots from the class method" do
@@ -122,7 +145,7 @@ describe Label do
   context "loading through self_and_ scopes" do
     before :all do
       delete_all_labels
-      create_label_hierarchy
+      create_label_tree
     end
 
     it "self_and_descendants should result in one select" do
@@ -281,4 +304,14 @@ describe Label do
       labels(:a1).leaves.collect(&:name).should == %w(b2 e2 d2 c1-six c1-seven c1-eight c1-nine)
     end
   end
+
+  context ".self_and_descendants_preordered" 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
+    end
+  end unless ENV["DB"] == "sqlite"
 end

metadata

@@ -1,217 +1,212 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: closure_tree
-version: !ruby/object:Gem::Version
-  version: 3.7.3
+version: !ruby/object:Gem::Version 
+  hash: 39
   prerelease: 
+  segments: 
+  - 3
+  - 8
+  - 0
+  version: 3.8.0
 platform: ruby
-authors:
+authors: 
 - Matthew McEachen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-19 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
+
+date: 2013-02-23 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
         version: 3.0.0
-  type: :runtime
+  version_requirements: *id001
+  name: activerecord
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: with_advisory_lock
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 0
+        - 6
         version: 0.0.6
-  type: :runtime
+  version_requirements: *id002
+  name: with_advisory_lock
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.0.6
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
   name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id006
   name: rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id007
   name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id008
   name: mysql2
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id009
   name: pg
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id010
   name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id011
   name: uuidtools
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+- !ruby/object:Gem::Dependency 
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id012
   name: strong_parameters
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  type: :development
 description: Easily and efficiently make your ActiveRecord model support hierarchies
-email:
+email: 
 - matthew-github@mceachen.org
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/closure_tree/acts_as_tree.rb
+- lib/closure_tree/columns.rb
+- lib/closure_tree/deterministic_ordering.rb
+- lib/closure_tree/model.rb
+- lib/closure_tree/numeric_deterministic_ordering.rb
 - lib/closure_tree/version.rb
+- lib/closure_tree/with_advisory_lock.rb
 - lib/closure_tree.rb
 - MIT-LICENSE
 - Rakefile
@@ -229,37 +224,41 @@ files:
 - spec/support/models.rb
 - spec/tag_spec.rb
 - spec/user_spec.rb
+has_rdoc: true
 homepage: http://matthew.mceachen.us/closure_tree
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -1398803141248485966
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -1398803141248485966
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Easily and efficiently make your ActiveRecord model support hierarchies
-test_files:
+test_files: 
 - spec/cuisine_type_spec.rb
 - spec/db/database.yml
 - spec/db/schema.rb
@@ -273,4 +272,3 @@ test_files:
 - spec/support/models.rb
 - spec/tag_spec.rb
 - spec/user_spec.rb
-has_rdoc: