acts_as_tree 0.2.0 → 1.0.0

data/README.md

@@ -2,27 +2,69 @@
 
 # ActsAsTree
 
-## Notes
-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`.
+A gem that extends ActiveRecord to add simple support for organizing items into
+parent–children relationships.
+
+## Example
 
     class Category < ActiveRecord::Base
-      acts_as_tree :order => "name"
+      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
 
+## Compatibility
+
+We no longer support Ruby 1.8 or versions if Rails/ActiveRecord older than 3.0. If you're using a version of ActiveRecord older than 3.0 please use 0.1.1.
+
+Moving forward we will do our best to support the latest versions of ActiveRecord and Ruby.
+
+## Change Log
+
+* 0.2.0 - April 9, 2012
+	*  Rails 3 Support
+* 0.1.1 - February 3, 2010
+	* Bug Fixes
+* 0.1.0 - October 9th, 2009
+	* First Gem Release
+
+## Note on Patches/Pull Requests
+
+1. Fork the project.
+2. Make your feature addition or bug fix.
+3. Add tests for it. This is important so we don't break it in a future version
+   unintentionally.
+4. Commit, do not mess with rakefile, version, or history. (if you want to have
+   your own version, that is fine but bump version in a commit by itself so we can
+   ignore when we pull)
+5. Send us a pull request. Bonus points for topic branches.
+
+## License (MIT)
+
+Copyright (c) 2007 David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the 'Software'), to deal in the
+Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-Copyright (c) 2007 David Heinemeier Hansson, released under the MIT license
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
+AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/acts_as_tree.gemspec

@@ -1,17 +1,15 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "acts_as_tree/version"
+require 'acts_as_tree/version'
 
 Gem::Specification.new do |s|
-  s.name        = "acts_as_tree"
+  s.name        = 'acts_as_tree'
   s.version     = ActiveRecord::Acts::Tree::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"
-  s.summary     = %q{Provides a simple tree behaviour to active_record mdoels.}
-  s.description = %q{Specify this acts_as extension if you want to model a tree structure by providing a parent association and a children association.}
-
-  s.rubyforge_project = "acts_as_tree"
+  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'
+  s.summary     = %q{Provides a simple tree behaviour to active_record models.}
+  s.description = %q{A gem that adds simple support for organizing ActiveRecord models into parent–children relationships.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,features}/*`.split("\n")
@@ -19,9 +17,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rdoc_options  = ["--charset=UTF-8"]
 
+  s.add_dependency "activerecord", ">= 3.0.0"
+
   # Dependencies (installed via 'bundle install')...
-  s.add_development_dependency("bundler", [">= 1.0.0"])
-  s.add_development_dependency("activerecord", [">= 1.15.4.7794"])
-  s.add_development_dependency("rdoc")
-  s.add_development_dependency("sqlite3")
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rdoc"
 end

data/lib/acts_as_tree.rb

@@ -1,3 +1,2 @@
 require 'acts_as_tree/active_record/acts/tree'
 require 'acts_as_tree/version'
-ActiveRecord::Base.class_eval { include ActiveRecord::Acts::Tree }

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

@@ -11,6 +11,8 @@ module ActiveRecord
       # +parent_id+.
       #
       #   class Category < ActiveRecord::Base
+      #     include ActiveRecord::Acts:Tree
+      #
       #     acts_as_tree :order => "name"
       #   end
       #
@@ -53,24 +55,24 @@ module ActiveRecord
         #                            if set to +true+ (default: +false+).
         def acts_as_tree(options = {})
           configuration = { 
-            :foreign_key   => "parent_id",
-            :order         => nil,
-            :counter_cache => nil,
-            :dependent     => :destroy
+            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
+          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
+          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
@@ -78,13 +80,17 @@ module ActiveRecord
             after_update :update_parents_counter_cache
 
             def self.roots
-              find(:all, :conditions => "#{configuration[:foreign_key]} IS NULL",
-                   :order => #{configuration[:order].nil? ? "nil" : %Q{"#{configuration[:order]}"}})
+              order_option = %Q{#{configuration.fetch :order, "nil"}}
+
+              find(:all, conditions: "#{configuration[:foreign_key]} IS NULL",
+                         order:      order_option)
             end
 
             def self.root
-              find(:first, :conditions => "#{configuration[:foreign_key]} IS NULL",
-                   :order => #{configuration[:order].nil? ? "nil" : %Q{"#{configuration[:order]}"}})
+              order_option = %Q{#{configuration.fetch :order, "nil"}}
+
+              find(:first, conditions: "#{configuration[:foreign_key]} IS NULL",
+                           order:      order_option)
             end
           EOV
         end

data/lib/acts_as_tree/version.rb

@@ -1,7 +1,7 @@
 module ActiveRecord
   module Acts
     module Tree
-      VERSION = "0.2.0"
+      VERSION = "1.0.0"
     end
   end
 end

data/test/acts_as_tree_test.rb

@@ -1,6 +1,6 @@
 require 'test/unit'
 require 'active_record'
-require "#{File.dirname(__FILE__)}/../init"
+require 'acts_as_tree'
 
 class Test::Unit::TestCase
   def assert_queries(num = 1)
@@ -15,18 +15,18 @@ class Test::Unit::TestCase
   end
 end
 
-ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
 
 # AR keeps printing annoying schema statements
 $stdout = StringIO.new
 
 def setup_db
   ActiveRecord::Base.logger
-  ActiveRecord::Schema.define(:version => 1) do
+  ActiveRecord::Schema.define(version: 1) do
     create_table :mixins do |t|
       t.column :type, :string
       t.column :parent_id, :integer
-      t.column :children_count, :integer, :default => 0
+      t.column :children_count, :integer, default: 0
     end
   end
 end
@@ -38,40 +38,41 @@ def teardown_db
 end
 
 class Mixin < ActiveRecord::Base
+  include ActiveRecord::Acts::Tree
 end
 
 class TreeMixin < Mixin
-  acts_as_tree :foreign_key => "parent_id", :order => "id"
+  acts_as_tree foreign_key: "parent_id", order: "id"
 end
 
 class TreeMixinWithoutOrder < Mixin
-  acts_as_tree :foreign_key => "parent_id"
+  acts_as_tree foreign_key: "parent_id"
 end
 
 class TreeMixinNullify < Mixin
-  acts_as_tree :foreign_key => "parent_id", :order => "id", :dependent => :nullify
+  acts_as_tree foreign_key: "parent_id", order: "id", dependent: :nullify
 end
 
 class TreeMixinWithCounterCache < Mixin
-  acts_as_tree :foreign_key => "parent_id", :order => "id", :counter_cache => :children_count
+  acts_as_tree foreign_key: "parent_id", order: "id", counter_cache: :children_count
 end
 
 class RecursivelyCascadedTreeMixin < Mixin
-  acts_as_tree :foreign_key => "parent_id"
-  has_one :first_child, :class_name => 'RecursivelyCascadedTreeMixin', :foreign_key => :parent_id
+  acts_as_tree foreign_key: "parent_id"
+  has_one :first_child, class_name: 'RecursivelyCascadedTreeMixin', foreign_key: :parent_id
 end
 
 class TreeTest < Test::Unit::TestCase
 
   def setup
     setup_db
-    @root1 = TreeMixin.create!
-    @root_child1 = TreeMixin.create! :parent_id => @root1.id
-    @child1_child = TreeMixin.create! :parent_id => @root_child1.id
-    @child1_child_child = TreeMixin.create! :parent_id => @child1_child.id
-    @root_child2 = TreeMixin.create! :parent_id => @root1.id
-    @root2 = TreeMixin.create!
-    @root3 = TreeMixin.create!
+    @root1              = TreeMixin.create!
+    @root_child1        = TreeMixin.create! parent_id: @root1.id
+    @child1_child       = TreeMixin.create! parent_id: @root_child1.id
+    @child1_child_child = TreeMixin.create! parent_id: @child1_child.id
+    @root_child2        = TreeMixin.create! parent_id: @root1.id
+    @root2              = TreeMixin.create!
+    @root3              = TreeMixin.create!
   end
 
   def teardown
@@ -161,11 +162,14 @@ class TreeTest < Test::Unit::TestCase
   end
 
   def test_nullify
-    root4 = TreeMixinNullify.create!
-    root4_child = TreeMixinNullify.create! :parent_id => root4.id
+    root4       = TreeMixinNullify.create!
+    root4_child = TreeMixinNullify.create! parent_id: root4.id
+
     assert_equal 2, TreeMixinNullify.count
     assert_equal root4.id, root4_child.parent_id
+
     root4.destroy
+
     assert_equal 1, TreeMixinNullify.count
     assert_nil root4_child.reload.parent_id
   end
@@ -177,17 +181,17 @@ class TreeTestWithEagerLoading < Test::Unit::TestCase
   def setup
     teardown_db
     setup_db
-    @root1 = TreeMixin.create!
-    @root_child1 = TreeMixin.create! :parent_id => @root1.id
-    @child1_child = TreeMixin.create! :parent_id => @root_child1.id
-    @root_child2 = TreeMixin.create! :parent_id => @root1.id
-    @root2 = TreeMixin.create!
-    @root3 = TreeMixin.create!
+    @root1        = TreeMixin.create!
+    @root_child1  = TreeMixin.create! parent_id: @root1.id
+    @child1_child = TreeMixin.create! parent_id: @root_child1.id
+    @root_child2  = TreeMixin.create! parent_id: @root1.id
+    @root2        = TreeMixin.create!
+    @root3        = TreeMixin.create!
 
     @rc1 = RecursivelyCascadedTreeMixin.create!
-    @rc2 = RecursivelyCascadedTreeMixin.create! :parent_id => @rc1.id
-    @rc3 = RecursivelyCascadedTreeMixin.create! :parent_id => @rc2.id
-    @rc4 = RecursivelyCascadedTreeMixin.create! :parent_id => @rc3.id
+    @rc2 = RecursivelyCascadedTreeMixin.create! parent_id: @rc1.id
+    @rc3 = RecursivelyCascadedTreeMixin.create! parent_id: @rc2.id
+    @rc4 = RecursivelyCascadedTreeMixin.create! parent_id: @rc3.id
   end
 
   def teardown
@@ -195,8 +199,12 @@ class TreeTestWithEagerLoading < Test::Unit::TestCase
   end
 
   def test_eager_association_loading
-    roots = TreeMixin.find(:all, :include => :children, :conditions => "mixins.parent_id IS NULL", :order => "mixins.id")
+    roots = TreeMixin.find :all, include: :children,
+                                 conditions: "mixins.parent_id IS NULL",
+                                 order: "mixins.id"
+
     assert_equal [@root1, @root2, @root3], roots
+
     assert_no_queries do
       assert_equal 2, roots[0].children.count
       assert_equal 0, roots[1].children.count
@@ -205,17 +213,26 @@ class TreeTestWithEagerLoading < Test::Unit::TestCase
   end
 
   def test_eager_association_loading_with_recursive_cascading_three_levels_has_many
-    root_node = RecursivelyCascadedTreeMixin.find(:first, :include => { :children => { :children => :children } }, :order => 'mixins.id')
+    root_node = RecursivelyCascadedTreeMixin.find :first,
+                                                  include: {children: {children: :children}},
+                                                  order:   'mixins.id'
+
     assert_equal @rc4, assert_no_queries { root_node.children.first.children.first.children.first }
   end
 
   def test_eager_association_loading_with_recursive_cascading_three_levels_has_one
-    root_node = RecursivelyCascadedTreeMixin.find(:first, :include => { :first_child => { :first_child => :first_child } }, :order => 'mixins.id')
+    root_node = RecursivelyCascadedTreeMixin.find :first,
+                                                  include: {first_child: {first_child: :first_child}},
+                                                  order:   'mixins.id'
+
     assert_equal @rc4, assert_no_queries { root_node.first_child.first_child.first_child }
   end
 
   def test_eager_association_loading_with_recursive_cascading_three_levels_belongs_to
-    leaf_node = RecursivelyCascadedTreeMixin.find(:first, :include => { :parent => { :parent => :parent } }, :order => 'mixins.id DESC')
+    leaf_node = RecursivelyCascadedTreeMixin.find :first,
+                                                  include: {parent: {parent: :parent}},
+                                                  order:   'mixins.id DESC'
+
     assert_equal @rc1, assert_no_queries { leaf_node.parent.parent.parent }
   end
 end
@@ -233,7 +250,7 @@ class TreeTestWithoutOrder < Test::Unit::TestCase
   end
 
   def test_root
-    assert [@root1, @root2].include?(TreeMixinWithoutOrder.root)
+    assert [@root1, @root2].include? TreeMixinWithoutOrder.root
   end
 
   def test_roots
@@ -244,7 +261,7 @@ end
 class UnsavedTreeTest < Test::Unit::TestCase
   def setup
     setup_db
-    @root = TreeMixin.new
+    @root       = TreeMixin.new
     @root_child = @root.children.build
   end
 
@@ -263,10 +280,10 @@ class TreeTestWithCounterCache < Test::Unit::TestCase
   def setup
     teardown_db
     setup_db
-    @root = TreeMixinWithCounterCache.create!
-    @child1 = TreeMixinWithCounterCache.create! :parent_id => @root.id
-    @child1_child1 = TreeMixinWithCounterCache.create! :parent_id => @child1.id
-    @child2 = TreeMixinWithCounterCache.create! :parent_id => @root.id
+    @root          = TreeMixinWithCounterCache.create!
+    @child1        = TreeMixinWithCounterCache.create! parent_id: @root.id
+    @child1_child1 = TreeMixinWithCounterCache.create! parent_id: @child1.id
+    @child2        = TreeMixinWithCounterCache.create! parent_id: @root.id
   end
 
   def teardown

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tree
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,33 +12,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-09 00:00:00.000000000 Z
+date: 2012-04-14 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &70099568607080 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: *70099568607080
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70099568606560 !ruby/object:Gem::Requirement
+  requirement: &70099083764900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.15.4.7794
-  type: :development
+        version: 3.0.0
+  type: :runtime
   prerelease: false
-  version_requirements: *70099568606560
+  version_requirements: *70099083764900
 - !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: &70099568606180 !ruby/object:Gem::Requirement
+  name: sqlite3
+  requirement: &70099083764300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,10 +35,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099568606180
+  version_requirements: *70099083764300
 - !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: &70099568605720 !ruby/object:Gem::Requirement
+  name: rdoc
+  requirement: &70099083763760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,9 +46,9 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70099568605720
-description: Specify this acts_as extension if you want to model a tree structure
-  by providing a parent association and a children association.
+  version_requirements: *70099083763760
+description: A gem that adds simple support for organizing ActiveRecord models into
+  parent–children relationships.
 email:
 - erik.dahlstrand@gmail.com
 - mark@amerine.net
@@ -74,7 +63,6 @@ files:
 - README.md
 - Rakefile
 - acts_as_tree.gemspec
-- init.rb
 - lib/acts_as_tree.rb
 - lib/acts_as_tree/active_record/acts/tree.rb
 - lib/acts_as_tree/version.rb
@@ -99,11 +87,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: acts_as_tree
+rubyforge_project: 
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Provides a simple tree behaviour to active_record mdoels.
+summary: Provides a simple tree behaviour to active_record models.
 test_files:
 - test/acts_as_tree_test.rb
 has_rdoc: 

data/init.rb

@@ -1,2 +0,0 @@
-$:.unshift "#{File.dirname(__FILE__)}/lib"
-require 'acts_as_tree'