acts_as_tree 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67e739d15a0e45a13063f0a4d18a2d4b44de1d9e
-  data.tar.gz: a2625316f1ff34237ecd2c131f4720e7cf47fe2c
+  metadata.gz: 935893a440670b7d94b79bf3705368e8bbb376bb
+  data.tar.gz: 559f8dadb94b8a72f0cbf338958c632019d87d0d
 SHA512:
-  metadata.gz: 02a256b253af5f240d9576a3e0c50adf0c50ba8a8ed6cc502b0b1d021f9a10e21444bba6e202083e51987fa35a1ee7e19bb04e98c7b20ccef61cf34ebd67aa73
-  data.tar.gz: b27d9dc1cf52e55f8db87a0ff7e139b3e3770859610b0cccdd417485782b697f68e4d98d0c3d2c3d756428696568a56c81d71970a80a42adf18cad36007df181
+  metadata.gz: fd51a4bfee115a00ee7306906955ab022da8544cdb7de247f66417998572dd0dfc3219a03aa3bad3b7c02658cd75827d76ad1bf04af07cade21e787b3bedf08a
+  data.tar.gz: d298cf66a35aaa8da2826d270ec3e5b046c6cced630547e40a1640114c849ebf1646d10d2f18c9d5bcd6172e1796afb04179ae7b28d6b84ea68ef58669b37aa4

data/README.md

@@ -2,7 +2,7 @@
 [travis]: (http://travis-ci.org/amerine/acts_as_tree)
 
 
-ActsAsTree extends ActiveRecord to add simple support for organizing items into parent–children relationships.
+ActsAsTree extends ActiveRecord to add simple support for organizing items into parent–children relationships. By default, ActsAsTree expects a foreign key column called `parent_id`.
 
 ## Example
 
@@ -48,6 +48,10 @@ We no longer support Ruby 1.8 or versions of 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.6.1 - April 21, 2014
+	* Readme Immprovements, see #26 -- schlick
+	* Improvements and Fixes for counter cache (fix counter\_cache: true). See #24, #25 -- dv
+	* Cleanup and fix tests, see #24.
 * 1.6.0 - April 21, 2014
 	* Added new `leaves` method. See #23 -- MichalPokorny
 * 1.5.1 - March 28, 2014
@@ -62,7 +66,7 @@ Moving forward we will do our best to support the latest versions of ActiveRecor
 	* Rails 4.0 Support! -- mischa78
 	* Readme Fixes -- mischa78 & seanhussey
 * 1.2.0 - October 29th, 2012
-	* Adding new `self_with_ancestors` accessor -- fbuenemann
+	* Adding new `self_with_ancestors` accessor -- felixbuenemann
 	* `roots` is now a scope.
 * 1.1.0 - April 24th, 2012
 	* Deprecate the ActiveRecord::Acts::Tree module in favor of ActsAsTree
@@ -91,6 +95,23 @@ Moving forward we will do our best to support the latest versions of ActiveRecor
    access to the repository and are welcome as full contributors to ActsAsTree. All
    we ask is that all changes go through CI and a Pull Request before merging.
 
+## Releasing new versions
+
+1. We follow Semver. So if you're shipping interface breaking changes then bump
+   the major version. We don't care if we ship version 1101.1.1, as long as
+   people know that 1101.1.1 has breaking differences from 1100.0. If you're
+   adding new features, but not changing existing functionality bump the minor
+   version, if you're shipping a bugfix, just bump the patch.
+2. Following the above rules, change the version found in lib/acts_as_tree/version.rb.
+3. Make sure the Change log in the README includes a brief summary of the versions
+   changes, with credit to the contributors.
+4. Commit these changes in one "release-prep" commit (on the master branch).
+5. Push that commit up to the repo.
+6. Run `rake release`
+   This will create and push a tag to Github, then generate a gem and push it to
+   Rubygems.
+7. Profit.
+
 ## License (MIT)
 
 Copyright (c) 2007 David Heinemeier Hansson

data/acts_as_tree.gemspec

@@ -5,8 +5,8 @@ require 'acts_as_tree/version'
 Gem::Specification.new do |s|
   s.name        = 'acts_as_tree'
   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.authors     = ['Erik Dahlstrand', 'Rails Core', 'Mark Turner', 'Swanand Pagnis', 'Felix Bünemann']
+  s.email       = ['erik.dahlstrand@gmail.com', 'mark@amerine.net', 'swanand.pagnis@gmail.com', 'felix.buenemann@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.}

data/lib/acts_as_tree.rb

@@ -59,7 +59,8 @@ module ActsAsTree
     # * <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+).
+    #                            if set to +true+ (default: +false+). Specify
+    #                            a custom column by passing a symbol or string.
     def acts_as_tree(options = {})
       configuration = {
         foreign_key:   "parent_id",
@@ -70,6 +71,10 @@ module ActsAsTree
 
       configuration.update(options) if options.is_a?(Hash)
 
+      if configuration[:counter_cache] == true
+        configuration[:counter_cache] = :children_count
+      end
+
       belongs_to :parent, class_name:    name,
         foreign_key:   configuration[:foreign_key],
         counter_cache: configuration[:counter_cache],
@@ -92,8 +97,6 @@ module ActsAsTree
       class_eval <<-EOV
         include ActsAsTree::InstanceMethods
 
-        after_update :update_parents_counter_cache
-
         def self.default_tree_order
           order_option = %Q{#{configuration.fetch :order, "nil"}}
           order(order_option)
@@ -109,11 +112,16 @@ module ActsAsTree
       EOV
 
       if configuration[:counter_cache]
-        class_eval <<-EOV
-          def self.leaves
-            where(:children_count => 0).default_tree_order
-          end
-        EOV
+        after_update :update_parents_counter_cache
+
+        def children_counter_cache_column
+          reflect_on_association(:parent).counter_cache_column
+        end
+
+        def leaves
+          where(children_counter_cache_column => 0).default_tree_order
+        end
+
       else
         # Fallback to less efficent ways to find leaves.
         class_eval <<-EOV
@@ -232,15 +240,17 @@ module ActsAsTree
     #   subchild1.leaf? # => true
     #   child1.leaf?    # => false
     def leaf?
-      children.count == 0
+      children.size.zero?
     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)
+      counter_cache_column = self.class.children_counter_cache_column
+
+      if parent_id_changed?
+        self.class.decrement_counter(counter_cache_column, parent_id_was)
+        self.class.increment_counter(counter_cache_column, parent_id)
       end
     end
   end

data/lib/acts_as_tree/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTree
-  VERSION = "1.6.0"
+  VERSION = "1.6.1"
 end

data/test/acts_as_tree_test.rb

@@ -4,31 +4,57 @@ require 'active_record'
 require 'acts_as_tree'
 
 class MiniTest::Unit::TestCase
-  def assert_queries(num = 1)
-    $query_count = 0
-    yield
+  def assert_queries(num = 1, &block)
+    query_count, result = count_queries(&block)
+    result
   ensure
-    assert_equal num, $query_count, "#{$query_count} instead of #{num} queries were executed."
+    assert_equal num, query_count, "#{query_count} instead of #{num} queries were executed."
   end
 
   def assert_no_queries(&block)
     assert_queries(0, &block)
   end
+
+  def count_queries &block
+    count = 0
+
+    counter_f = ->(name, started, finished, unique_id, payload) {
+      unless %w[ CACHE SCHEMA ].include? payload[:name]
+        count += 1
+      end
+    }
+
+    result = ActiveSupport::Notifications.subscribed(counter_f, "sql.active_record", &block)
+
+    [count, result]
+  end
+
+  def capture_stdout(&block)
+    real_stdout = $stdout
+
+    $stdout = StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = real_stdout
+  end
 end
 
 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
-    create_table :mixins do |t|
-      t.column :type, :string
-      t.column :parent_id, :integer
-      t.column :children_count, :integer, default: 0
+def setup_db(counter_cache = false)
+  # AR keeps printing annoying schema statements
+  capture_stdout do
+    ActiveRecord::Base.logger
+    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) if counter_cache
+      end
     end
+
+    Mixin.reset_column_information
   end
 end
 
@@ -236,9 +262,7 @@ class TreeTest < MiniTest::Unit::TestCase
        |_ 6
        |_ 7
     END
-    $stdout.reopen # reinitializes $stdout
-    TreeMixin.tree_view(:id)
-    assert_equal tree_view_outputs, $stdout.string
+    assert_equal tree_view_outputs, capture_stdout { TreeMixin.tree_view(:id) }
   end
 end
 
@@ -322,9 +346,9 @@ class TreeTestWithEagerLoading < MiniTest::Unit::TestCase
     assert_equal [@root1, @root2, @root3], roots
 
     assert_no_queries do
-      assert_equal 2, roots[0].children.count
-      assert_equal 0, roots[1].children.count
-      assert_equal 0, roots[2].children.count
+      assert_equal 2, roots[0].children.size
+      assert_equal 0, roots[1].children.size
+      assert_equal 0, roots[2].children.size
     end
   end
 
@@ -395,11 +419,14 @@ end
 class TreeTestWithCounterCache < MiniTest::Unit::TestCase
   def setup
     teardown_db
-    setup_db
+    setup_db(true)
+
     @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, @child1, @child1_child1, @child2].map(&:reload)
   end
 
   def teardown
@@ -407,8 +434,8 @@ class TreeTestWithCounterCache < MiniTest::Unit::TestCase
   end
 
   def test_counter_cache
-    assert_equal 2, @root.reload.children_count
-    assert_equal 1, @child1.reload.children_count
+    assert_equal 2, @root.children_count
+    assert_equal 1, @child1.children_count
   end
 
   def test_update_parents_counter_cache
@@ -419,5 +446,13 @@ class TreeTestWithCounterCache < MiniTest::Unit::TestCase
 
   def test_leaves
     assert_equal [@child1_child1, @child2], TreeMixinWithCounterCache.leaves
+
+    assert !@root.leaf?
+    assert @child2.leaf?
+  end
+
+  def test_counter_cache_being_used
+    assert_no_queries { @root.leaf? }
+    assert_no_queries { @child2.leaf? }
   end
 end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tree
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Erik Dahlstrand
 - Rails Core
 - Mark Turner
 - Swanand Pagnis
+- Felix Bünemann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-21 00:00:00.000000000 Z
+date: 2014-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -75,6 +76,7 @@ email:
 - erik.dahlstrand@gmail.com
 - mark@amerine.net
 - swanand.pagnis@gmail.com
+- felix.buenemann@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []