closure_tree 4.1.0 → 4.2.0

data/lib/closure_tree/numeric_deterministic_ordering.rb

@@ -1,6 +1,6 @@
 # This module is only included if the order column is an integer.
 module ClosureTree
-  module DeterministicNumericOrdering
+  module NumericDeterministicOrdering
     extend ActiveSupport::Concern
 
     def self_and_descendants_preordered
@@ -62,8 +62,7 @@ module ClosureTree
 
     def add_sibling(sibling_node, 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
+      _ct.with_advisory_lock do
         if self.order_value.nil? || siblings_before.without(sibling_node).empty?
           update_attribute(:order_value, 0)
         end

data/lib/closure_tree/support.rb

@@ -1,5 +1,10 @@
+require 'closure_tree/support_flags'
+require 'closure_tree/support_attributes'
+
 module ClosureTree
   class Support
+    include ClosureTree::SupportFlags
+    include ClosureTree::SupportAttributes
 
     attr_reader :model_class
     attr_reader :options
@@ -16,22 +21,6 @@ module ClosureTree
       raise IllegalArgumentException, "name_column can't be 'path'" if options[:name_column] == 'path'
     end
 
-    def connection
-      model_class.connection
-    end
-
-    def use_attr_accessible?
-      ActiveRecord::VERSION::MAJOR == 3 &&
-        defined?(ActiveModel::MassAssignmentSecurity) &&
-        model_class.ancestors.include?(ActiveModel::MassAssignmentSecurity)
-    end
-
-    def include_forbidden_attributes_protection?
-      ActiveRecord::VERSION::MAJOR == 3 &&
-        defined?(ActiveModel::ForbiddenAttributesProtection) &&
-        model_class.ancestors.include?(ActiveModel::ForbiddenAttributesProtection)
-    end
-
     def hierarchy_class_for_model
       hierarchy_class = model_class.parent.const_set(short_hierarchy_class_name, Class.new(ActiveRecord::Base))
       use_attr_accessible = use_attr_accessible?
@@ -53,26 +42,6 @@ module ClosureTree
       hierarchy_class
     end
 
-    def parent_column_name
-      options[:parent_column_name]
-    end
-
-    def parent_column_sym
-      parent_column_name.to_sym
-    end
-
-    def has_name?
-      model_class.new.attributes.include? options[:name_column]
-    end
-
-    def name_column
-      options[:name_column]
-    end
-
-    def name_sym
-      name_column.to_sym
-    end
-
     def hierarchy_table_name
       # We need to use the table_name, not something like ct_class.to_s.demodulize + "_hierarchies",
       # because they may have overridden the table name, which is what we want to be consistent with
@@ -83,45 +52,10 @@ module ClosureTree
       ActiveRecord::Base.table_name_prefix + tablename + ActiveRecord::Base.table_name_suffix
     end
 
-    def hierarchy_class_name
-      options[:hierarchy_class_name] || model_class.to_s + "Hierarchy"
-    end
-
-    # Returns the constant name of the hierarchy_class
-    #
-    # @return [String] the constant name
-    #
-    # @example
-    #   Namespace::Model.hierarchy_class_name # => "Namespace::ModelHierarchy"
-    #   Namespace::Model.short_hierarchy_class_name # => "ModelHierarchy"
-    def short_hierarchy_class_name
-      hierarchy_class_name.split('::').last
-    end
-
-    def quoted_hierarchy_table_name
-      connection.quote_table_name hierarchy_table_name
-    end
-
-    def quoted_id_column_name
-      connection.quote_column_name model_class.primary_key
-    end
-
-    def quoted_parent_column_name
-      connection.quote_column_name parent_column_name
-    end
-
-    def quoted_name_column
-      connection.quote_column_name name_column
-    end
-
     def quote(field)
       connection.quote(field)
     end
 
-    def order_option?
-      !options[:order].nil?
-    end
-
     def with_order_option(opts)
       if order_option?
         opts[:order] = [opts[:order], options[:order]].compact.join(",")
@@ -151,64 +85,6 @@ module ClosureTree
       end
     end
 
-    def order_is_numeric?
-      # The table might not exist yet (in the case of ActiveRecord::Observer use, see issue 32)
-      return false if !order_option? || !model_class.table_exists?
-      c = model_class.columns_hash[order_column]
-      c && c.type == :integer
-    end
-
-    def order_column
-      o = options[:order]
-      if o.nil?
-        nil
-      elsif o.is_a?(String)
-        o.split(' ', 2).first
-      else
-        o.to_s
-      end
-    end
-
-    def require_order_column
-      raise ":order value, '#{options[:order]}', isn't a column" if order_column.nil?
-    end
-
-    def order_column_sym
-      require_order_column
-      order_column.to_sym
-    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
-
-    # This is the "topmost" class. This will only potentially not be ct_class if you are using STI.
-    def base_class
-      options[:base_class]
-    end
-
-    def subclass?
-      model_class != model_class.base_class
-    end
-
-    def attribute_names
-      @attribute_names ||= model_class.new.attributes.keys - model_class.protected_attributes.to_a
-    end
-
-    def has_type?
-      attribute_names.include? 'type'
-    end
-
-    def table_name
-      model_class.table_name
-    end
-
-    def quoted_table_name
-      connection.quote_table_name table_name
-    end
-
     def remove_prefix_and_suffix(table_name)
       prefix = Regexp.escape(ActiveRecord::Base.table_name_prefix)
       suffix = Regexp.escape(ActiveRecord::Base.table_name_suffix)
@@ -222,5 +98,17 @@ module ClosureTree
         scope.select(model_class.primary_key).map { |ea| ea._ct_id }
       end
     end
+
+    def with_advisory_lock(&block)
+      if options[:with_advisory_lock]
+        model_class.with_advisory_lock("closure_tree") do
+          model_class.transaction do
+            yield
+          end
+        end
+      else
+        yield
+      end
+    end
   end
 end

data/lib/closure_tree/support_attributes.rb

@@ -0,0 +1,99 @@
+module ClosureTree
+  module SupportAttributes
+
+    # This is the "topmost" class. This will only potentially not be ct_class if you are using STI.
+    def base_class
+      options[:base_class]
+    end
+
+    def attribute_names
+      @attribute_names ||= model_class.new.attributes.keys - model_class.protected_attributes.to_a
+    end
+
+    def connection
+      model_class.connection
+    end
+
+    def table_name
+      model_class.table_name
+    end
+
+    def quoted_table_name
+      connection.quote_table_name(table_name)
+    end
+
+    def hierarchy_class_name
+      options[:hierarchy_class_name] || model_class.to_s + "Hierarchy"
+    end
+
+    def parent_column_name
+      options[:parent_column_name]
+    end
+
+    def parent_column_sym
+      parent_column_name.to_sym
+    end
+
+    def name_column
+      options[:name_column]
+    end
+
+    def name_sym
+      name_column.to_sym
+    end
+
+    # Returns the constant name of the hierarchy_class
+    #
+    # @return [String] the constant name
+    #
+    # @example
+    #   Namespace::Model.hierarchy_class_name # => "Namespace::ModelHierarchy"
+    #   Namespace::Model.short_hierarchy_class_name # => "ModelHierarchy"
+    def short_hierarchy_class_name
+      hierarchy_class_name.split('::').last
+    end
+
+    def quoted_hierarchy_table_name
+      connection.quote_table_name hierarchy_table_name
+    end
+
+    def quoted_id_column_name
+      connection.quote_column_name model_class.primary_key
+    end
+
+    def quoted_parent_column_name
+      connection.quote_column_name parent_column_name
+    end
+
+    def quoted_name_column
+      connection.quote_column_name name_column
+    end
+
+    def order_column
+      o = options[:order]
+      if o.nil?
+        nil
+      elsif o.is_a?(String)
+        o.split(' ', 2).first
+      else
+        o.to_s
+      end
+    end
+
+    def require_order_column
+      raise ":order value, '#{options[:order]}', isn't a column" if order_column.nil?
+    end
+
+    def order_column_sym
+      require_order_column
+      order_column.to_sym
+    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
+
+  end
+end

data/lib/closure_tree/support_flags.rb

@@ -0,0 +1,41 @@
+module ClosureTree
+  module SupportFlags
+
+    def use_attr_accessible?
+      ActiveRecord::VERSION::MAJOR == 3 &&
+        defined?(ActiveModel::MassAssignmentSecurity) &&
+        model_class.respond_to?(:accessible_attributes) &&
+        model_class.accessible_attributes.present?
+    end
+
+    def include_forbidden_attributes_protection?
+      ActiveRecord::VERSION::MAJOR == 3 &&
+        defined?(ActiveModel::ForbiddenAttributesProtection) &&
+        model_class.ancestors.include?(ActiveModel::ForbiddenAttributesProtection)
+    end
+
+    def order_option?
+      !options[:order].nil?
+    end
+
+    def order_is_numeric?
+      # The table might not exist yet (in the case of ActiveRecord::Observer use, see issue 32)
+      return false if !order_option? || !model_class.table_exists?
+      c = model_class.columns_hash[order_column]
+      c && c.type == :integer
+    end
+
+    def subclass?
+      model_class != model_class.base_class
+    end
+
+    def has_type?
+      attribute_names.include? 'type'
+    end
+
+    def has_name?
+      model_class.new.attributes.include? options[:name_column]
+    end
+
+  end
+end

data/lib/closure_tree/version.rb

@@ -1,3 +1,3 @@
 module ClosureTree
-  VERSION = Gem::Version.new("4.1.0") unless defined?(::ClosureTree::VERSION)
+  VERSION = Gem::Version.new("4.2.0") unless defined?(::ClosureTree::VERSION)
 end

data/spec/label_spec.rb

@@ -88,7 +88,6 @@ describe Label do
     it "should find or create by path" do
       date = DateLabel.find_or_create_by_path(%w{2011 November 23})
       date.ancestry_path.should == %w{2011 November 23}
-      date.parent
       date.self_and_ancestors.each { |ea| ea.class.should == DateLabel }
       date.name.should == "23"
       date.parent.name.should == "November"

data/spec/support/models.rb

@@ -3,7 +3,7 @@ require 'uuidtools'
 class Tag < ActiveRecord::Base
   acts_as_tree :dependent => :destroy, :order => "name"
   before_destroy :add_destroyed_tag
-  attr_accessible :name if _ct.use_attr_accessible?
+  attr_accessible :name, :title if _ct.use_attr_accessible?
   def to_s
     name
   end
@@ -18,7 +18,7 @@ class UUIDTag < ActiveRecord::Base
   before_create :set_uuid
   acts_as_tree :dependent => :destroy, :order => 'name', :parent_column_name => 'parent_uuid'
   before_destroy :add_destroyed_tag
-  attr_accessible :name if _ct.use_attr_accessible?
+  attr_accessible :name, :title if _ct.use_attr_accessible?
 
   def set_uuid
     self.uuid = UUIDTools::UUID.timestamp_create.to_s
@@ -34,10 +34,8 @@ class UUIDTag < ActiveRecord::Base
   end
 end
 
-USE_ATTR_ACCESSIBLE = Tag._ct.use_attr_accessible?
-
 class DestroyedTag < ActiveRecord::Base
-  attr_accessible :name if USE_ATTR_ACCESSIBLE
+  attr_accessible :name if Tag._ct.use_attr_accessible?
 end
 
 class User < ActiveRecord::Base
@@ -52,7 +50,7 @@ class User < ActiveRecord::Base
     Contract.where(:user_id => descendant_ids)
   end
 
-  attr_accessible :email, :referrer if USE_ATTR_ACCESSIBLE
+  attr_accessible :email, :referrer if _ct.use_attr_accessible?
 
   def to_s
     email
@@ -65,11 +63,12 @@ end
 
 class Label < ActiveRecord::Base
   # make sure order doesn't matter
-  attr_accessible :name if USE_ATTR_ACCESSIBLE
   acts_as_tree :order => :sort_order, # <- LOOK IT IS A SYMBOL OMG
     :parent_column_name => "mother_id",
     :dependent => :destroy
 
+  attr_accessible :name if _ct.use_attr_accessible?
+
   def to_s
     "#{self.class}: #{name}"
   end

data/spec/tag_examples.rb

@@ -9,7 +9,7 @@ shared_examples_for "Tag (without fixtures)" do
 
     it 'has correct accessible_attributes' do
       if tag_class._ct.use_attr_accessible?
-        tag_class.accessible_attributes.to_a.should =~ %w(parent name)
+        tag_class.accessible_attributes.to_a.should =~ %w(parent name title)
       end
     end
 
@@ -226,6 +226,24 @@ shared_examples_for "Tag (without fixtures)" do
       end
     end
 
+    context 'with_ancestor' do
+      it 'works with no rows' do
+        tag_class.with_ancestor().to_a.should be_empty
+      end
+      it 'finds only children' do
+        c = tag_class.find_or_create_by_path %w(A B C)
+        a, b = c.parent.parent, c.parent
+        e = tag_class.find_or_create_by_path %w(D E)
+        tag_class.with_ancestor(a).to_a.should == [b, c]
+      end
+      it 'limits subsequent where clauses' do
+        a1c = tag_class.find_or_create_by_path %w(A1 B C)
+        a2c = tag_class.find_or_create_by_path %w(A2 B C)
+        tag_class.where(:name => "C").to_a.should =~ [a1c, a2c]
+        tag_class.with_ancestor(a1c.parent.parent).where(:name => "C").to_a.should == [a1c]
+      end
+    end
+
     context "paths" do
       before :each do
         @child = tag_class.find_or_create_by_path(%w(grandparent parent child))
@@ -298,6 +316,26 @@ shared_examples_for "Tag (without fixtures)" do
         # instance method:
         a.find_or_create_by_path(%w{b c}).ancestry_path.should == %w{a b c}
       end
+
+      it "should respect attribute hashes with both selection and creation" do
+        expected_title = 'something else'
+        attrs = {:title => expected_title}
+        existing_title = @grandparent.title
+        new_grandparent = tag_class.find_or_create_by_path(%w{grandparent}, attrs)
+        new_grandparent.should_not == @grandparent
+        new_grandparent.title.should == expected_title
+        @grandparent.reload.title.should == existing_title
+      end
+
+      it "should create a hierarchy with a given attribute" do
+        expected_title = 'unicorn rainbows'
+        attrs = {:title => expected_title}
+        child = tag_class.find_or_create_by_path(%w{grandparent parent child}, attrs)
+        child.should_not == @child
+        [child, child.parent, child.parent.parent].each do |ea|
+          ea.title.should == expected_title
+        end
+      end
     end
 
     context "hash_tree" do
@@ -311,6 +349,7 @@ shared_examples_for "Tag (without fixtures)" do
         @d2 = @b.find_or_create_by_path %w(c2 d2)
         @c2 = @d2.parent
         @full_tree = {@a => {@b => {@c1 => {@d1 => {}}, @c2 => {@d2 => {}}}, @b2 => {}}}
+        #File.open("example.dot", "w") { |f| f.write(tag_class.root.to_dot_digraph) }
       end
 
       context "#hash_tree" do