ancestry 1.2.3 → 1.2.4

data/README.rdoc

@@ -15,7 +15,7 @@ To apply Ancestry to any ActiveRecord model, follow these simple steps:
      - Install required gems: <b>bundle install</b>
 
 2. Add ancestry column to your table
-   - Create migration: <b>./script/generate migration add_ancestry_to_[table] ancestry:string</b>
+   - Create migration: <b>rails g migration add_ancestry_to_[table] ancestry:string</b>
    - Add index to migration: <b>add_index [table], :ancestry</b> (UP) / <b>remove_index [table], :ancestry</b> (DOWN)
    - Migrate your database: <b>rake db:migrate</b>
 
@@ -152,16 +152,24 @@ The arrange method also works on a scoped class, for example:
 
   TreeNode.find_by_name('Crunchy').subtree.arrange
 
-The arrange method takes ActiveRecord find options. If you want your hashes to be ordered, you should pass the order to the arrange method instead of to the scope. This only works for Ruby 1.9 and later since before that hashes weren't ordered. For example:
+The arrange method takes ActiveRecord find options. If you want your hashes to be ordered, you should pass the order to the arrange method instead of to the scope. This also works for Ruby 1.8 since an OrderedHash is returned. For example:
 
   TreeNode.find_by_name('Crunchy').subtree.arrange(:order => :name)
 
+= Sorting
+
+If you just want to sort an array of nodes as if you were traversing them in preorder, you can use the sort_by_ancestry class method:
+  
+  TreeNode.sort_by_ancestry(array_of_nodes)
+
+Note that since materialised path trees don't support ordering within a rank, the order of siblings depends on their order in the original array.
+
 = Migrating from plugin that uses parent_id column
 
 Most current tree plugins use a parent_id column (has_ancestry, awesome_nested_set, better_nested_set, acts_as_nested_set). With ancestry its easy to migrate from any of these plugins, to do so, use the build_ancestry_from_parent_ids! method on your ancestry model. These steps provide a more detailed explanation:
 
 1. Add ancestry column to your table
-   - Create migration: <b>./script/generate migration add_ancestry_to_[table] ancestry:string</b>
+   - Create migration: <b>rails g migration add_ancestry_to_[table] ancestry:string</b>
    - Add index to migration: <b>add_index [table], :ancestry</b> (UP) / <b>remove_index [table], :ancestry</b> (DOWN)
    - Migrate your database: <b>rake db:migrate</b>
 
@@ -185,7 +193,7 @@ Most current tree plugins use a parent_id column (has_ancestry, awesome_nested_s
    - Check if all your data is intact and all tests pass
 
 6. Drop parent_id column:
-   - Create migration: <b>./script/generate migration remove_parent_id_from_[table]</b>
+   - Create migration: <b>rails g migration remove_parent_id_from_[table]</b>
    - Add to migration: <b>remove_column [table], :parent_id</b> (UP) / <b>add_column [table], :parent_id, :integer</b> (DOWN)
    - Migrate your database: <b>rake db:migrate</b>
 
@@ -228,8 +236,12 @@ The materialised path pattern requires Ancestry to use a 'like' condition in ord
 
 = Version history
 
-The latest and recommended version of ancestry is 1.2.2. The three numbers of each version numbers are respectively the major, minor and patch versions. We started with major version 1 because it looks so much better and ancestry was already quite mature and complete when it was published. The major version is only bumped when backwards compatibility is broken. The minor version is bumped when new features are added. The patch version is bumped when bugs are fixed.
+The latest version of ancestry is recommended. The three numbers of each version numbers are respectively the major, minor and patch versions. We started with major version 1 because it looks so much better and ancestry was already quite mature and complete when it was published. The major version is only bumped when backwards compatibility is broken. The minor version is bumped when new features are added. The patch version is bumped when bugs are fixed.
 
+- Version 1.2.4 (2011-4-22)
+  - Prepended table names to column names in queries (thx raelik)
+  - Better check to see if acts_as_tree can be overloaded (thx jims)
+  - Performance inprovements (thx kueda)
 - Version 1.2.3 (2010-10-28)
   - Fixed error with determining ActiveRecord version
   - Added option to specify :primary_key_format (thanks goes to rolftimmermans)
@@ -300,6 +312,6 @@ I will try to keep Ancestry up to date with changing versions of Rails and Ruby
 
 Bug report? Faulty/incomplete documentation? Feature request? Please post an issue on 'http://github.com/stefankroes/ancestry/issues'. Please also contact me at s.a.kroes[at]gmail.com if it's urgent.
 
-Question? Contact me at s.a.kroes[at]gmail.com, make sure you read the documentation. You can also join the #ancestry channel on IRC (irc.freenode.net).
+Question? Contact me at s.a.kroes[at]gmail.com, make sure you read the documentation.
 
 Copyright (c) 2009 Stefan Kroes, released under the MIT license

data/ancestry.gemspec

@@ -3,7 +3,7 @@ Gem::Specification.new do |s|
   s.description = 'Organise ActiveRecord model into a tree structure'
   s.summary     = 'Ancestry allows the records of a ActiveRecord model to be organised in a tree structure, using a single, intuitively formatted database column. It exposes all the standard tree structure relations (ancestors, parent, root, children, siblings, descendants) and all of them can be fetched in a single sql query. Additional features are named_scopes, integrity checking, integrity restoration, arrangement of (sub)tree into hashes and different strategies for dealing with orphaned records.'
 
-  s.version = '1.2.3'
+  s.version = '1.2.4'
 
   s.author   = 'Stefan Kroes'
   s.email    = 's.a.kroes@gmail.com'

data/lib/ancestry/class_methods.rb

@@ -36,14 +36,36 @@ module Ancestry
           self.base_class.ordered_by_ancestry_and options.delete(:order)
         end
       # Get all nodes ordered by ancestry and start sorting them into an empty hash
-      scope.all(options).inject(ActiveSupport::OrderedHash.new) do |arranged_nodes, node|
+      arrange_nodes scope.all(options)
+    end
+    
+    # Arrange array of nodes into a nested hash of the form 
+    # {node => children}, where children = {} if the node has no children
+    def arrange_nodes(nodes)
+      # Get all nodes ordered by ancestry and start sorting them into an empty hash
+      nodes.inject(ActiveSupport::OrderedHash.new) do |arranged_nodes, node|
         # Find the insertion point for that node by going through its ancestors
         node.ancestor_ids.inject(arranged_nodes) do |insertion_point, ancestor_id|
           insertion_point.each do |parent, children|
             # Change the insertion point to children if node is a descendant of this parent
             insertion_point = children if ancestor_id == parent.id
-          end; insertion_point
-        end[node] = ActiveSupport::OrderedHash.new; arranged_nodes
+          end
+          insertion_point
+        end[node] = ActiveSupport::OrderedHash.new
+        arranged_nodes
+      end
+    end
+    
+    # Pseudo-preordered array of nodes.  Children will always follow parents, 
+    # but the ordering of nodes within a rank depends on their order in the 
+    # array that gets passed in
+    def sort_by_ancestry(nodes)
+      arranged = nodes.is_a?(Hash) ? nodes : arrange_nodes(nodes.sort_by{|n| n.ancestry || '0'})
+      arranged.inject([]) do |sorted_nodes, pair|
+        node, children = pair
+        sorted_nodes << node
+        sorted_nodes += sort_by_ancestry(children) unless children.blank?
+        sorted_nodes
       end
     end
 
@@ -52,7 +74,7 @@ module Ancestry
       parents = {}
       exceptions = [] if options[:report] == :list
       # For each node ...
-      self.base_class.all.each do |node|
+      self.base_class.find_each do |node|
         begin
           # ... check validity of ancestry column
           if !node.valid? and !node.errors[node.class.ancestry_column].blank?
@@ -86,7 +108,7 @@ module Ancestry
     def restore_ancestry_integrity!
       parents = {}
       # For each node ...
-      self.base_class.all.each do |node|
+      self.base_class.find_each do |node|
         # ... set its ancestry to nil if invalid
         if node.errors[node.class.ancestry_column].blank?
           node.without_ancestry_callbacks do
@@ -104,7 +126,7 @@ module Ancestry
         parents[node.id] = nil if parent == node.id 
       end
       # For each node ...
-      self.base_class.all.each do |node|
+      self.base_class.find_each do |node|
         # ... rebuild ancestry from parents array
         ancestry, parent = nil, parents[node.id]
         until parent.nil?
@@ -118,7 +140,7 @@ module Ancestry
     
     # Build ancestry from parent id's for migration purposes
     def build_ancestry_from_parent_ids! parent_id = nil, ancestry = nil
-      self.base_class.all(:conditions => {:parent_id => parent_id}).each do |node|
+      self.base_class.find_each(:conditions => {:parent_id => parent_id}) do |node|
         node.without_ancestry_callbacks do
           node.update_attribute ancestry_column, ancestry
         end
@@ -129,9 +151,9 @@ module Ancestry
     # Rebuild depth cache if it got corrupted or if depth caching was just turned on
     def rebuild_depth_cache!
       raise Ancestry::AncestryException.new("Cannot rebuild depth cache for model without depth caching.") unless respond_to? :depth_cache_column
-      self.base_class.all.each do |node|
+      self.base_class.find_each do |node|
         node.update_attribute depth_cache_column, node.depth
       end
     end
   end
-end
+end

data/lib/ancestry/has_ancestry.rb

@@ -51,8 +51,8 @@ class << ActiveRecord::Base
     send scope_method, :descendants_of, lambda { |object| {:conditions => to_node(object).descendant_conditions} }
     send scope_method, :subtree_of, lambda { |object| {:conditions => to_node(object).subtree_conditions} }
     send scope_method, :siblings_of, lambda { |object| {:conditions => to_node(object).sibling_conditions} }
-    send scope_method, :ordered_by_ancestry, :order => "(case when #{ancestry_column} is null then 0 else 1 end), #{ancestry_column}"
-    send scope_method, :ordered_by_ancestry_and, lambda { |order| {:order => "(case when #{ancestry_column} is null then 0 else 1 end), #{ancestry_column}, #{order}"} }
+    send scope_method, :ordered_by_ancestry, :order => "(case when #{table_name}.#{ancestry_column} is null then 0 else 1 end), #{table_name}.#{ancestry_column}"
+    send scope_method, :ordered_by_ancestry_and, lambda { |order| {:order => "(case when #{table_name}.#{ancestry_column} is null then 0 else 1 end), #{table_name}.#{ancestry_column}, #{order}"} }
     
     # Update descendants with new ancestry before save
     before_save :update_descendants_with_new_ancestry
@@ -83,7 +83,7 @@ class << ActiveRecord::Base
   end
   
   # Alias has_ancestry with acts_as_tree, if it's available.
-  if !respond_to?(:acts_as_tree)
+  if !defined?(ActsAsTree) 
     alias_method :acts_as_tree, :has_ancestry
   end
-end
+end

data/lib/ancestry/instance_methods.rb

@@ -18,7 +18,7 @@ module Ancestry
               descendant.update_attribute(
                 self.base_class.ancestry_column,
                 descendant.read_attribute(descendant.class.ancestry_column).gsub(
-                  /^#{self.child_ancestry}/, 
+                  /^#{self.child_ancestry}/,
                   if read_attribute(self.class.ancestry_column).blank? then id.to_s else "#{read_attribute self.class.ancestry_column }/#{id}" end
                 )
               )
@@ -55,7 +55,7 @@ module Ancestry
         end
       end
     end
-    
+
     # The ancestry value for this record's children
     def child_ancestry
       # New records cannot have children
@@ -66,7 +66,7 @@ module Ancestry
 
     # Ancestors
     def ancestor_ids
-      read_attribute(self.base_class.ancestry_column).to_s.split('/').map(&:to_i)
+      read_attribute(self.base_class.ancestry_column).to_s.split('/').map { |id| cast_primary_key(id) }
     end
 
     def ancestor_conditions
@@ -76,7 +76,7 @@ module Ancestry
     def ancestors depth_options = {}
       self.base_class.scope_depth(depth_options, depth).ordered_by_ancestry.scoped :conditions => ancestor_conditions
     end
-    
+
     def path_ids
       ancestor_ids + [id]
     end
@@ -88,11 +88,11 @@ module Ancestry
     def path depth_options = {}
       self.base_class.scope_depth(depth_options, depth).ordered_by_ancestry.scoped :conditions => path_conditions
     end
-    
+
     def depth
       ancestor_ids.size
     end
-    
+
     def cache_depth
       write_attribute self.base_class.depth_cache_column, depth
     end
@@ -171,7 +171,7 @@ module Ancestry
 
     # Descendants
     def descendant_conditions
-      ["#{self.base_class.ancestry_column} like ? or #{self.base_class.ancestry_column} = ?", "#{child_ancestry}/%", child_ancestry]
+      ["#{self.base_class.table_name}.#{self.base_class.ancestry_column} like ? or #{self.base_class.table_name}.#{self.base_class.ancestry_column} = ?", "#{child_ancestry}/%", child_ancestry]
     end
 
     def descendants depth_options = {}
@@ -181,10 +181,10 @@ module Ancestry
     def descendant_ids depth_options = {}
       descendants(depth_options).all(:select => self.base_class.primary_key).collect(&self.base_class.primary_key.to_sym)
     end
-    
+
     # Subtree
     def subtree_conditions
-      ["#{self.base_class.primary_key} = ? or #{self.base_class.ancestry_column} like ? or #{self.base_class.ancestry_column} = ?", self.id, "#{child_ancestry}/%", child_ancestry]
+      ["#{self.base_class.table_name}.#{self.base_class.primary_key} = ? or #{self.base_class.table_name}.#{self.base_class.ancestry_column} like ? or #{self.base_class.table_name}.#{self.base_class.ancestry_column} = ?", self.id, "#{child_ancestry}/%", child_ancestry]
     end
 
     def subtree depth_options = {}
@@ -194,20 +194,20 @@ module Ancestry
     def subtree_ids depth_options = {}
       subtree(depth_options).all(:select => self.base_class.primary_key).collect(&self.base_class.primary_key.to_sym)
     end
-    
+
     # Callback disabling
     def without_ancestry_callbacks
       @disable_ancestry_callbacks = true
       yield
       @disable_ancestry_callbacks = false
     end
-      
+
     def ancestry_callbacks_disabled?
       !!@disable_ancestry_callbacks
     end
-    
+
   private
-    
+
     # Workaround to support Rails 2
     def add_error_to_base error
       if rails_3
@@ -216,5 +216,17 @@ module Ancestry
         errors.add_to_base error
       end
     end
+
+    def cast_primary_key(key)
+      if primary_key_type == :string
+        key
+      else
+        key.to_i
+      end
+    end
+
+    def primary_key_type
+      @primary_key_type ||= column_for_attribute(self.class.primary_key).type
+    end
   end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ancestry
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 1
   - 2
-  - 3
-  version: 1.2.3
+  - 4
+  version: 1.2.4
 platform: ruby
 authors: 
 - Stefan Kroes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-28 00:00:00 +02:00
+date: 2011-04-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: Ancestry allows the records of a ActiveRecord model to be organised in a tree structure, using a single, intuitively formatted database column. It exposes all the standard tree structure relations (ancestors, parent, root, children, siblings, descendants) and all of them can be fetched in a single sql query. Additional features are named_scopes, integrity checking, integrity restoration, arrangement of (sub)tree into hashes and different strategies for dealing with orphaned records.