acts_as_tree 1.0.1 → 1.1.0

data/.travis.yml

@@ -2,5 +2,4 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
-  - rbx-19mode
   - ruby-head

data/README.md

@@ -1,14 +1,15 @@
-[![Build Status](https://secure.travis-ci.org/amerine/acts_as_tree.png?branch=master)](http://travis-ci.org/amerine/acts_as_tree)
+# ActsAsTree [![Build Status](https://secure.travis-ci.org/amerine/acts_as_tree.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/amerine/acts_as_tree.png?travis)][gemnasium]
+[travis]: (http://travis-ci.org/amerine/acts_as_tree)
+[gemnasium]: (https://gemnasium.com/amerine/acts_as_tree)
 
-# ActsAsTree
 
-A gem that extends ActiveRecord to add simple support for organizing items into
+ActsAsTree extends ActiveRecord to add simple support for organizing items into
 parent–children relationships.
 
 ## Example
 
     class Category < ActiveRecord::Base
-      include ActiveRecord::Acts::Tree
+      include ActsAsTree
 
       acts_as_tree order: "name"
     end
@@ -29,9 +30,14 @@ We no longer support Ruby 1.8 or versions if Rails/ActiveRecord older than 3.0.
 Moving forward we will do our best to support the latest versions of ActiveRecord and Ruby.
 
 ## Change Log
-
+* 1.1.0 - April 24th, 2012
+	* Deprecate the ActiveRecord::Acts::Tree module in favor of ActsAsTree
+* 1.0.1 - April 18th, 2012
+	* Include the Railtie for easier loading in Rails. Will reassess the forced module inclusion in the future.
+* 1.0.0 - April 14th, 2012
+	* Official 1.0 release. Force users to include the ActiveRecord::Acts::Tree module.
 * 0.2.0 - April 9, 2012
-	*  Rails 3 Support
+	* Rails 3 Support
 * 0.1.1 - February 3, 2010
 	* Bug Fixes
 * 0.1.0 - October 9th, 2009

data/Rakefile

@@ -12,7 +12,7 @@ task :default => :test
 require 'rdoc/task'
 RDoc::Task.new do |rdoc|
   require "acts_as_tree/version"
-  version = ActiveRecord::Acts::Tree::VERSION
+  version = ActsAsTree::VERSION
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "acts_as_tree-rails3 #{version}"

data/acts_as_tree.gemspec

@@ -4,7 +4,7 @@ require 'acts_as_tree/version'
 
 Gem::Specification.new do |s|
   s.name        = 'acts_as_tree'
-  s.version     = ActiveRecord::Acts::Tree::VERSION
+  s.version     = ActsAsTree::VERSION
   s.authors     = ['Erik Dahlstrand', 'Rails Core', 'Mark Turner', 'Swanand Pagnis']
   s.email       = ['erik.dahlstrand@gmail.com', 'mark@amerine.net', 'swanand.pagnis@gmail.com']
   s.homepage    = 'https://github.com/amerine/acts_as_tree'

data/lib/acts_as_tree.rb

@@ -1,7 +1,7 @@
-require 'acts_as_tree/active_record/acts/tree'
 require 'acts_as_tree/version'
 
 module ActsAsTree
+
   if defined? Rails::Railtie
     require 'rails'
     class Railtie < Rails::Railtie
@@ -16,8 +16,154 @@ module ActsAsTree
   class Railtie
     def self.insert
       if defined?(ActiveRecord)
-        ActiveRecord::Base.send(:include, ActiveRecord::Acts::Tree)
+        ActiveRecord::Base.send(:include, ActsAsTree)
       end
     end
   end
-end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # Specify this +acts_as+ extension if you want to model a tree structure
+  # by providing a parent association and a children association. This
+  # requires that you have a foreign key column, which by default is called
+  # +parent_id+.
+  #
+  #   class Category < ActiveRecord::Base
+  #     include ActiveRecord::Acts:Tree
+  #
+  #     acts_as_tree :order => "name"
+  #   end
+  #
+  #   Example:
+  #   root
+  #    \_ child1
+  #         \_ subchild1
+  #         \_ subchild2
+  #
+  #   root      = Category.create("name" => "root")
+  #   child1    = root.children.create("name" => "child1")
+  #   subchild1 = child1.children.create("name" => "subchild1")
+  #
+  #   root.parent   # => nil
+  #   child1.parent # => root
+  #   root.children # => [child1]
+  #   root.children.first.children.first # => subchild1
+  #
+  # In addition to the parent and children associations, the following
+  # instance methods are added to the class after calling
+  # <tt>acts_as_tree</tt>:
+  # * <tt>siblings</tt> - Returns all the children of the parent, excluding
+  #                       the current node (<tt>[subchild2]</tt> when called
+  #                       on <tt>subchild1</tt>)
+  # * <tt>self_and_siblings</tt> - Returns all the children of the parent,
+  #                                including the current node (<tt>[subchild1, subchild2]</tt>
+  #                                when called on <tt>subchild1</tt>)
+  # * <tt>ancestors</tt> - Returns all the ancestors of the current node
+  #                        (<tt>[child1, root]</tt> when called on <tt>subchild2</tt>)
+  # * <tt>root</tt> - Returns the root of the current node (<tt>root</tt>
+  #                   when called on <tt>subchild2</tt>)
+  module ClassMethods
+    # Configuration options are:
+    #
+    # * <tt>foreign_key</tt> - specifies the column name to use for tracking
+    #                          of the tree (default: +parent_id+)
+    # * <tt>order</tt> - makes it possible to sort the children according to
+    #                    this SQL snippet.
+    # * <tt>counter_cache</tt> - keeps a count in a +children_count+ column
+    #                            if set to +true+ (default: +false+).
+    def acts_as_tree(options = {})
+      configuration = {
+        foreign_key:   "parent_id",
+        order:         nil,
+        counter_cache: nil,
+        dependent:     :destroy
+      }
+
+      configuration.update(options) if options.is_a?(Hash)
+
+      belongs_to :parent, class_name:    name,
+        foreign_key:   configuration[:foreign_key],
+        counter_cache: configuration[:counter_cache],
+        inverse_of:    :children
+
+      has_many :children, class_name:  name,
+        foreign_key: configuration[:foreign_key],
+        order:       configuration[:order],
+        dependent:   configuration[:dependent],
+        inverse_of:  :parent
+
+      class_eval <<-EOV
+            include ActsAsTree::InstanceMethods
+
+            after_update :update_parents_counter_cache
+
+            def self.roots
+              order_option = %Q{#{configuration.fetch :order, "nil"}}
+
+              find(:all, conditions: "#{configuration[:foreign_key]} IS NULL",
+                         order:      order_option)
+            end
+
+            def self.root
+              order_option = %Q{#{configuration.fetch :order, "nil"}}
+
+              find(:first, conditions: "#{configuration[:foreign_key]} IS NULL",
+                           order:      order_option)
+            end
+      EOV
+    end
+  end
+
+  module InstanceMethods
+    # Returns list of ancestors, starting from parent until root.
+    #
+    #   subchild1.ancestors # => [child1, root]
+    def ancestors
+      node, nodes = self, []
+      nodes << node = node.parent while node.parent
+      nodes
+    end
+
+    # Returns the root node of the tree.
+    def root
+      node = self
+      node = node.parent while node.parent
+      node
+    end
+
+    # Returns all siblings of the current node.
+    #
+    #   subchild1.siblings # => [subchild2]
+    def siblings
+      self_and_siblings - [self]
+    end
+
+    # Returns all siblings and a reference to the current node.
+    #
+    #   subchild1.self_and_siblings # => [subchild1, subchild2]
+    def self_and_siblings
+      parent ? parent.children : self.class.roots
+    end
+
+    # Returns children (without subchildren) and current node itself.
+    #
+    #   root.self_and_children # => [root, child1]
+    def self_and_children
+      [self] + self.children
+    end
+
+    private
+
+    def update_parents_counter_cache
+      if self.respond_to?(:children_count) && parent_id_changed?
+        self.class.decrement_counter(:children_count, parent_id_was)
+        self.class.increment_counter(:children_count, parent_id)
+      end
+    end
+  end
+end
+
+# Deprecating the following code in the future.
+require 'acts_as_tree/active_record/acts/tree'

data/lib/acts_as_tree/active_record/acts/tree.rb

@@ -1,147 +1,14 @@
+require 'acts_as_tree'
+
 module ActiveRecord
   module Acts #:nodoc:
-    module Tree #:nodoc:
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      # Specify this +acts_as+ extension if you want to model a tree structure
-      # by providing a parent association and a children association. This
-      # requires that you have a foreign key column, which by default is called
-      # +parent_id+.
-      #
-      #   class Category < ActiveRecord::Base
-      #     include ActiveRecord::Acts:Tree
-      #
-      #     acts_as_tree :order => "name"
-      #   end
-      #
-      #   Example:
-      #   root
-      #    \_ child1
-      #         \_ subchild1
-      #         \_ subchild2
-      #
-      #   root      = Category.create("name" => "root")
-      #   child1    = root.children.create("name" => "child1")
-      #   subchild1 = child1.children.create("name" => "subchild1")
-      #
-      #   root.parent   # => nil
-      #   child1.parent # => root
-      #   root.children # => [child1]
-      #   root.children.first.children.first # => subchild1
-      #
-      # In addition to the parent and children associations, the following
-      # instance methods are added to the class after calling
-      # <tt>acts_as_tree</tt>:
-      # * <tt>siblings</tt> - Returns all the children of the parent, excluding
-      #                       the current node (<tt>[subchild2]</tt> when called
-      #                       on <tt>subchild1</tt>)
-      # * <tt>self_and_siblings</tt> - Returns all the children of the parent,
-      #                                including the current node (<tt>[subchild1, subchild2]</tt>
-      #                                when called on <tt>subchild1</tt>)
-      # * <tt>ancestors</tt> - Returns all the ancestors of the current node
-      #                        (<tt>[child1, root]</tt> when called on <tt>subchild2</tt>)
-      # * <tt>root</tt> - Returns the root of the current node (<tt>root</tt>
-      #                   when called on <tt>subchild2</tt>)
-      module ClassMethods
-        # Configuration options are:
-        #
-        # * <tt>foreign_key</tt> - specifies the column name to use for tracking
-        #                          of the tree (default: +parent_id+)
-        # * <tt>order</tt> - makes it possible to sort the children according to
-        #                    this SQL snippet.
-        # * <tt>counter_cache</tt> - keeps a count in a +children_count+ column
-        #                            if set to +true+ (default: +false+).
-        def acts_as_tree(options = {})
-          configuration = { 
-            foreign_key:   "parent_id",
-            order:         nil,
-            counter_cache: nil,
-            dependent:     :destroy
-          }
-
-          configuration.update(options) if options.is_a?(Hash)
-
-          belongs_to :parent, class_name:    name,
-                              foreign_key:   configuration[:foreign_key],
-                              counter_cache: configuration[:counter_cache],
-                              inverse_of:    :children
-
-          has_many :children, class_name:  name,
-                              foreign_key: configuration[:foreign_key],
-                              order:       configuration[:order],
-                              dependent:   configuration[:dependent],
-                              inverse_of:  :parent
-
-          class_eval <<-EOV
-            include ActiveRecord::Acts::Tree::InstanceMethods
-
-            after_update :update_parents_counter_cache
-
-            def self.roots
-              order_option = %Q{#{configuration.fetch :order, "nil"}}
+    module Tree
+      include ::ActsAsTree
 
-              find(:all, conditions: "#{configuration[:foreign_key]} IS NULL",
-                         order:      order_option)
-            end
-
-            def self.root
-              order_option = %Q{#{configuration.fetch :order, "nil"}}
-
-              find(:first, conditions: "#{configuration[:foreign_key]} IS NULL",
-                           order:      order_option)
-            end
-          EOV
-        end
-      end
-
-      module InstanceMethods
-        # Returns list of ancestors, starting from parent until root.
-        #
-        #   subchild1.ancestors # => [child1, root]
-        def ancestors
-          node, nodes = self, []
-          nodes << node = node.parent while node.parent
-          nodes
-        end
-
-        # Returns the root node of the tree.
-        def root
-          node = self
-          node = node.parent while node.parent
-          node
-        end
-
-        # Returns all siblings of the current node.
-        #
-        #   subchild1.siblings # => [subchild2]
-        def siblings
-          self_and_siblings - [self]
-        end
-
-        # Returns all siblings and a reference to the current node.
-        #
-        #   subchild1.self_and_siblings # => [subchild1, subchild2]
-        def self_and_siblings
-          parent ? parent.children : self.class.roots
-        end
-
-        # Returns children (without subchildren) and current node itself.
-        #
-        #   root.self_and_children # => [root, child1]
-        def self_and_children
-          [self] + self.children
-        end
-
-        private
+      def self.included(base)
+        Kernel.warn "[DEPRECATION] The module ActiveRecord::Acts::Tree has moved to ActsAsTree"
 
-        def update_parents_counter_cache
-          if self.respond_to?(:children_count) && parent_id_changed?
-            self.class.decrement_counter(:children_count, parent_id_was)
-            self.class.increment_counter(:children_count, parent_id)
-          end
-        end
+        base.extend ::ActsAsTree::ClassMethods
       end
     end
   end

data/lib/acts_as_tree/version.rb

@@ -1,7 +1,3 @@
-module ActiveRecord
-  module Acts
-    module Tree
-      VERSION = "1.0.1"
-    end
-  end
+module ActsAsTree
+  VERSION = "1.1.0"
 end

data/test/acts_as_tree_test.rb

@@ -38,7 +38,7 @@ def teardown_db
 end
 
 class Mixin < ActiveRecord::Base
-  include ActiveRecord::Acts::Tree
+  include ActsAsTree
 end
 
 class TreeMixin < Mixin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tree
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,11 +12,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-18 00:00:00.000000000 Z
+date: 2012-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70288490534000 !ruby/object:Gem::Requirement
+  requirement: &70112110455280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70288490534000
+  version_requirements: *70112110455280
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70288490533300 !ruby/object:Gem::Requirement
+  requirement: &70112110454840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70288490533300
+  version_requirements: *70112110454840
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70288490532580 !ruby/object:Gem::Requirement
+  requirement: &70112110454380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,7 +46,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70288490532580
+  version_requirements: *70112110454380
 description: A gem that adds simple support for organizing ActiveRecord models into
   parent–children relationships.
 email: