acts_as_tree 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bdf6e214ed89182c6f2d9d1c67dc7eb98740bfd
-  data.tar.gz: 3e0b66ce3f15e89cc9200083887dce33f8924636
+  metadata.gz: 1a8e94e638a5ea09d242e3a9d5fde5e1f138d88b
+  data.tar.gz: 7f119917e8d1009117adee5394a2538f54a6a3bd
 SHA512:
-  metadata.gz: 23d0e45f4a847b74b25e7832c046564c7c03a31faa2ab687332b555e00b6efd7f88cb034dd691ae6feba027ba0bcafb3ca2affa86f91825536d61bf57dcca344
-  data.tar.gz: 093917a7a3fcd2ad5a26c93016a47896c18fb1db175f57bbb511aabc00154fd4d42836521eb3669e11dc42d6ceb73d357a5579b7de4b161bf84ab1f78c7636af
+  metadata.gz: 86ff17779db508f61f859d16dd6cf1f4385762df0b526ddf7025d22bd829527d1dedd98ea2533b43e563101f5c4fe692e83c2b1e3be032ed40ff1214833e666e
+  data.tar.gz: d21c5cdcc35a15a87527c1633a628be1f17f69f0fe8acb4c9b7f2b1934d019a2de233707a631be39bd35ac26dfda16197f56d25b5ac2568f8d2080911ee5a9f3

data/README.md

@@ -74,6 +74,8 @@ 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
+* 2.5.0 - August 14, 2016
+	* Allow for use of a different primary key, see #50 -- Two9A
 * 2.4.0 - January 12, 2016
 	* Added support for rails 5.0, see #46 -- klacointe
 * 2.3.0 - November 6, 2015

data/gemfiles/rails-3.0.gemfile

@@ -2,5 +2,6 @@ source "https://rubygems.org"
 
 gem "rails", "~> 3.0.0"
 gem "i18n", "< 0.7"
+gem "rake", "< 11"
 
 gemspec path: "../"

data/gemfiles/rails-3.1.gemfile

@@ -3,5 +3,6 @@ source "https://rubygems.org"
 gem "rails", "~> 3.1.0"
 gem "i18n", "< 0.7"
 gem "rack-cache", "< 1.3"
+gem "rake", "< 11"
 
 gemspec path: "../"

data/gemfiles/rails-3.2.gemfile

@@ -3,5 +3,6 @@ source "https://rubygems.org"
 gem "rails", "~> 3.2.22"
 gem "i18n", "< 0.7"
 gem "rack-cache", "< 1.3"
+gem "rake", "< 11"
 
 gemspec path: "../"

data/gemfiles/rails-4.0.gemfile

@@ -1,5 +1,6 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 4.0.0"
+gem "mime-types", "< 3"
 
 gemspec path: "../"

data/gemfiles/rails-4.1.gemfile

@@ -1,5 +1,6 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 4.1.0"
+gem "mime-types", "< 3"
 
 gemspec path: "../"

data/gemfiles/rails-4.2.gemfile

@@ -1,5 +1,6 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 4.2.0"
+gem "mime-types", "< 3"
 
 gemspec path: "../"

data/lib/acts_as_tree.rb

@@ -54,6 +54,8 @@ module ActsAsTree
   module ClassMethods
     # Configuration options are:
     #
+    # * <tt>primary_key</tt> - specifies the column name for relations
+    #                          (default: +id+)
     # * <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
@@ -63,6 +65,7 @@ module ActsAsTree
     #                            a custom column by passing a symbol or string.
     def acts_as_tree(options = {})
       configuration = {
+        primary_key:   primary_key,
         foreign_key:   "parent_id",
         order:         nil,
         counter_cache: nil,
@@ -78,6 +81,7 @@ module ActsAsTree
 
       belongs_to_opts = {
         class_name:    name,
+        primary_key:   configuration[:primary_key],
         foreign_key:   configuration[:foreign_key],
         counter_cache: configuration[:counter_cache],
         touch:         configuration[:touch],
@@ -91,11 +95,13 @@ module ActsAsTree
       if ActiveRecord::VERSION::MAJOR >= 4
         has_many :children, lambda { order configuration[:order] },
           class_name:  name,
+          primary_key: configuration[:primary_key],
           foreign_key: configuration[:foreign_key],
           dependent:   configuration[:dependent],
           inverse_of:  :parent
       else
         has_many :children, class_name:  name,
+          primary_key: configuration[:primary_key],
           foreign_key: configuration[:foreign_key],
           order:       configuration[:order],
           dependent:   configuration[:dependent],
@@ -135,7 +141,7 @@ module ActsAsTree
         class_eval <<-EOV
           def self.leaves
             internal_ids = select(:#{configuration[:foreign_key]}).where(arel_table[:#{configuration[:foreign_key]}].not_eq(nil))
-            where("id NOT IN (\#{internal_ids.to_sql})").default_tree_order
+            where("\#{connection.quote_column_name('#{configuration[:primary_key]}')} NOT IN (\#{internal_ids.to_sql})").default_tree_order
           end
         EOV
       end
@@ -216,12 +222,12 @@ module ActsAsTree
 
     def walk_tree_bfs(where = {}, node = nil, level = -1, &block)
       nodes = (node.nil? ? roots : node.children).where(where)
-      nodes.each { |child| block.call child, level + 1 }
+      nodes.each { |child| yield(child, level + 1) }
       nodes.each { |child| walk_tree_bfs where, child, level + 1, &block }
     end
 
     def walk_tree_dfs(where = {}, node = nil, level = -1, &block)
-      block.call node, level unless level == -1
+      yield(node, level) unless level == -1
       nodes = (node.nil? ? roots : node.children).where(where)
       nodes.each { |child| walk_tree_dfs where, child, level + 1, &block }
     end

data/lib/acts_as_tree/version.rb

@@ -1,3 +1,3 @@
 module ActsAsTree
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/test/acts_as_tree_test.rb

@@ -47,29 +47,27 @@ end
 
 ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
 
-def setup_db(counter_cache = false)
+def setup_db(options = {})
   # AR keeps printing annoying schema statements
   capture_stdout do
     ActiveRecord::Base.logger
     ActiveRecord::Schema.define(version: 1) do
-      create_table :mixins do |t|
+      create_table :mixins, force: true do |t|
         t.column :type, :string
         t.column :parent_id, :integer
-        t.column(:children_count, :integer, default: 0) if counter_cache
+        t.column :external_id, :integer if options[:external_ids]
+        t.column :external_parent_id, :integer if options[:external_ids]
+        t.column :children_count, :integer, default: 0 if options[:counter_cache]
         t.timestamps null: false
       end
     end
 
-    Mixin.reset_column_information
-  end
-end
-
-def teardown_db
-  # Silence tables deprecation on rails 5.0
-  ActiveSupport::Deprecation.silence do
-    ActiveRecord::Base.connection.tables.each do |table|
-      ActiveRecord::Base.connection.drop_table(table)
+    # Fix broken reset_column_information in some activerecord versions.
+    if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 2 ||
+       ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR == 1
+      ActiveRecord::Base.connection.schema_cache.clear!
     end
+    Mixin.reset_column_information
   end
 end
 
@@ -99,25 +97,30 @@ class RecursivelyCascadedTreeMixin < Mixin
 end
 
 class TreeMixinWithTouch < Mixin
-   acts_as_tree foreign_key: "parent_id", order: "id", touch: true
+  acts_as_tree foreign_key: "parent_id", order: "id", touch: true
+end
+
+class ExternalTreeMixin < Mixin
+  acts_as_tree foreign_key: "external_parent_id", primary_key: "external_id"
+end
+
+class ExternalTreeMixinNullify < Mixin
+  acts_as_tree foreign_key: "external_parent_id", primary_key: "external_id", order: "id", dependent: :nullify
 end
 
 class TreeTest < ActsAsTreeTestCase
 
   def setup
     setup_db
+    @tree_mixin = TreeMixin
 
-    @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
-    teardown_db
+    @root1              = @tree_mixin.create!
+    @root_child1        = @tree_mixin.create! parent_id: @root1.id
+    @child1_child       = @tree_mixin.create! parent_id: @root_child1.id
+    @child1_child_child = @tree_mixin.create! parent_id: @child1_child.id
+    @root_child2        = @tree_mixin.create! parent_id: @root1.id
+    @root2              = @tree_mixin.create!
+    @root3              = @tree_mixin.create!
   end
 
   def test_children
@@ -135,12 +138,12 @@ class TreeTest < ActsAsTreeTestCase
   end
 
   def test_delete
-    assert_equal 7, TreeMixin.count
+    assert_equal 7, @tree_mixin.count
     @root1.destroy
-    assert_equal 2, TreeMixin.count
+    assert_equal 2, @tree_mixin.count
     @root2.destroy
     @root3.destroy
-    assert_equal 0, TreeMixin.count
+    assert_equal 0, @tree_mixin.count
   end
 
   def test_insert
@@ -166,7 +169,7 @@ class TreeTest < ActsAsTreeTestCase
   end
 
   def test_root
-    assert_equal @root1, TreeMixin.root
+    assert_equal @root1, @tree_mixin.root
     assert_equal @root1, @root1.root
     assert_equal @root1, @root_child1.root
     assert_equal @root1, @child1_child.root
@@ -176,15 +179,15 @@ class TreeTest < ActsAsTreeTestCase
   end
 
   def test_roots
-    assert_equal [@root1, @root2, @root3], TreeMixin.roots
+    assert_equal [@root1, @root2, @root3], @tree_mixin.roots
   end
 
   def test_leaves
-    assert_equal [@child1_child_child, @root_child2, @root2, @root3], TreeMixin.leaves
+    assert_equal [@child1_child_child, @root_child2, @root2, @root3], @tree_mixin.leaves
   end
 
   def test_default_tree_order
-    assert_equal [@root1, @root_child1, @child1_child, @child1_child_child, @root_child2, @root2, @root3], TreeMixin.default_tree_order
+    assert_equal [@root1, @root_child1, @child1_child, @child1_child_child, @root_child2, @root2, @root3], @tree_mixin.default_tree_order
   end
 
   def test_siblings
@@ -261,9 +264,9 @@ class TreeTest < ActsAsTreeTestCase
   end
 
   def test_tree_view
-    assert_equal false, Mixin.respond_to?(:tree_view)
-    Mixin.extend ActsAsTree::TreeView
-    assert_equal true,  TreeMixin.respond_to?(:tree_view)
+    assert_equal false, @tree_mixin.respond_to?(:tree_view)
+    @tree_mixin.extend ActsAsTree::TreeView
+    assert_equal true,  @tree_mixin.respond_to?(:tree_view)
 
     tree_view_outputs = <<-END.gsub(/^ {6}/, '')
       root
@@ -275,15 +278,15 @@ class TreeTest < ActsAsTreeTestCase
        |_ 6
        |_ 7
     END
-    assert_equal tree_view_outputs, capture_stdout { TreeMixin.tree_view(:id) }
+    assert_equal tree_view_outputs, capture_stdout { @tree_mixin.tree_view(:id) }
   end
 
   def test_tree_walker
-    assert_equal false, TreeMixin.respond_to?(:walk_tree)
-    assert_equal false, TreeMixin.new.respond_to?(:walk_tree)
-    TreeMixin.extend ActsAsTree::TreeWalker
-    assert_equal true,  TreeMixin.respond_to?(:walk_tree)
-    assert_equal true,  TreeMixin.new.respond_to?(:walk_tree)
+    assert_equal false, @tree_mixin.respond_to?(:walk_tree)
+    assert_equal false, @tree_mixin.new.respond_to?(:walk_tree)
+    @tree_mixin.extend ActsAsTree::TreeWalker
+    assert_equal true,  @tree_mixin.respond_to?(:walk_tree)
+    assert_equal true,  @tree_mixin.new.respond_to?(:walk_tree)
 
     walk_tree_dfs_output = <<-END.gsub(/^\s+/, '')
       1
@@ -294,7 +297,7 @@ class TreeTest < ActsAsTreeTestCase
       6
       7
       END
-    assert_equal walk_tree_dfs_output, capture_stdout { TreeMixin.walk_tree{|elem, level| puts "#{'-'*level}#{elem.id}"} }
+    assert_equal walk_tree_dfs_output, capture_stdout { @tree_mixin.walk_tree{|elem, level| puts "#{'-'*level}#{elem.id}"} }
 
     walk_tree_dfs_sub_output = <<-END.gsub(/^\s+/, '')
       2
@@ -313,7 +316,7 @@ class TreeTest < ActsAsTreeTestCase
       --3
       ---4
       END
-    assert_equal walk_tree_bfs_output, capture_stdout { TreeMixin.walk_tree(:algorithm => :bfs){|elem, level| puts "#{'-'*level}#{elem.id}"} }
+    assert_equal walk_tree_bfs_output, capture_stdout { @tree_mixin.walk_tree(:algorithm => :bfs){|elem, level| puts "#{'-'*level}#{elem.id}"} }
 
     walk_tree_bfs_sub_output = <<-END.gsub(/^\s+/, '')
       2
@@ -327,7 +330,6 @@ end
 
 class TestDeepDescendantsPerformance < ActsAsTreeTestCase
   def setup
-    teardown_db
     setup_db
     @root1 = TreeMixin.create!
     create_cascade_children @root1, "root1", 10
@@ -345,10 +347,6 @@ class TestDeepDescendantsPerformance < ActsAsTreeTestCase
     create_cascade_children @root5, "root5", 50
   end
 
-  def teardown
-    teardown_db
-  end
-
   def self.bench_range
     [1, 2, 3, 4, 5]
   end
@@ -378,7 +376,6 @@ end
 class TreeTestWithEagerLoading < ActsAsTreeTestCase
 
   def setup
-    teardown_db
     setup_db
     @root1        = TreeMixin.create!
     @root_child1  = TreeMixin.create! parent_id: @root1.id
@@ -393,10 +390,6 @@ class TreeTestWithEagerLoading < ActsAsTreeTestCase
     @rc4 = RecursivelyCascadedTreeMixin.create! parent_id: @rc3.id
   end
 
-  def teardown
-    teardown_db
-  end
-
   def test_eager_association_loading
     roots = TreeMixin.includes(:children)
                      .where('mixins.parent_id IS NULL')
@@ -444,10 +437,6 @@ class TreeTestWithoutOrder < ActsAsTreeTestCase
     @root2 = TreeMixinWithoutOrder.create!
   end
 
-  def teardown
-    teardown_db
-  end
-
   def test_root
     assert [@root1, @root2].include? TreeMixinWithoutOrder.root
   end
@@ -464,10 +453,6 @@ class UnsavedTreeTest < ActsAsTreeTestCase
     @root_child = @root.children.build
   end
 
-  def teardown
-    teardown_db
-  end
-
   def test_inverse_of
     # We want children to be aware of their parent before saving either
     assert_equal @root, @root_child.parent
@@ -477,8 +462,7 @@ end
 
 class TreeTestWithCounterCache < ActsAsTreeTestCase
   def setup
-    teardown_db
-    setup_db(true)
+    setup_db counter_cache: true
 
     @root          = TreeMixinWithCounterCache.create!
     @child1        = TreeMixinWithCounterCache.create! parent_id: @root.id
@@ -488,10 +472,6 @@ class TreeTestWithCounterCache < ActsAsTreeTestCase
     [@root, @child1, @child1_child1, @child2].map(&:reload)
   end
 
-  def teardown
-    teardown_db
-  end
-
   def test_counter_cache
     assert_equal 2, @root.children_count
     assert_equal 1, @child1.children_count
@@ -519,22 +499,45 @@ end
 
 class TreeTestWithTouch < ActsAsTreeTestCase
   def setup
-    teardown_db
     setup_db
 
     @root  = TreeMixinWithTouch.create!
     @child = TreeMixinWithTouch.create! parent_id: @root.id
   end
 
-  def teardown
-    teardown_db
-  end
-
   def test_updated_at
     previous_root_updated_at = @root.updated_at
     @child.update_attributes(:type => "new_type")
     @root.reload
-    
+
     assert @root.updated_at != previous_root_updated_at
   end
 end
+
+class ExternalTreeTest < TreeTest
+  def setup
+    setup_db external_ids: true
+    @tree_mixin = ExternalTreeMixin
+
+    @root1              = @tree_mixin.create! external_id: 1101
+    @root_child1        = @tree_mixin.create! external_id: 1102, external_parent_id: @root1.external_id
+    @child1_child       = @tree_mixin.create! external_id: 1103, external_parent_id: @root_child1.external_id
+    @child1_child_child = @tree_mixin.create! external_id: 1104, external_parent_id: @child1_child.external_id
+    @root_child2        = @tree_mixin.create! external_id: 1105, external_parent_id: @root1.external_id
+    @root2              = @tree_mixin.create! external_id: 1106
+    @root3              = @tree_mixin.create! external_id: 1107
+  end
+
+  def test_nullify
+    root4       = ExternalTreeMixinNullify.create! external_id: 1108
+    root4_child = ExternalTreeMixinNullify.create! external_id: 1109, external_parent_id: root4.external_id
+
+    assert_equal 2, ExternalTreeMixinNullify.count
+    assert_equal root4.external_id, root4_child.external_parent_id
+
+    root4.destroy
+
+    assert_equal 1, ExternalTreeMixinNullify.count
+    assert_nil root4_child.reload.external_parent_id
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_tree
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Erik Dahlstrand
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord