1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
|
require 'minitest/autorun'
require 'minitest/benchmark'
require 'active_record'
require 'acts_as_tree'
class ActsAsTreeTestCase < Minitest::Test
UPDATE_METHOD = ActiveRecord::VERSION::MAJOR >= 4 ? :update : :update_attributes
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."
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
}
begin
subscribed = ActiveSupport::Notifications.subscribe("sql.active_record", &counter_f)
result = block.call
ensure
ActiveSupport::Notifications.unsubscribe subscribed
end
[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:"
def setup_db(options = {})
# AR keeps printing annoying schema statements
capture_stdout do
ActiveRecord::Base.logger
ActiveRecord::Schema.define do
create_table :mixins, force: true do |t|
t.column :type, :string
t.column :parent_id, :integer
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
create_table :level_mixins, force: true do |t|
t.column :level, :string
t.column :parent_id, :integer
t.timestamps null: false
end
end
# 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
class Mixin < ActiveRecord::Base
include ActsAsTree
end
class LevelMixin < ActiveRecord::Base
include ActsAsTree
acts_as_tree foreign_key: "parent_id", order: "id"
end
class TreeMixin < Mixin
acts_as_tree foreign_key: "parent_id", order: "id"
end
class TreeMixinWithLevelMethod < Mixin
acts_as_tree foreign_key: "parent_id", order: "id"
def level
'Has Level Method'
end
end
class TreeMixinWithoutOrder < Mixin
acts_as_tree foreign_key: "parent_id"
end
class TreeMixinNullify < Mixin
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
end
class RecursivelyCascadedTreeMixin < Mixin
acts_as_tree foreign_key: "parent_id"
has_one :first_child, class_name: 'RecursivelyCascadedTreeMixin', foreign_key: :parent_id
end
class TreeMixinWithTouch < Mixin
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 = @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
assert_equal @root1.children, [@root_child1, @root_child2]
assert_equal @root_child1.children, [@child1_child]
assert_equal @child1_child.children, [@child1_child_child]
assert_equal @child1_child_child.children, []
assert_equal @root_child2.children, []
end
def test_parent
assert_equal @root_child1.parent, @root1
assert_equal @root_child1.parent, @root_child2.parent
assert_nil @root1.parent
end
def test_delete
assert_equal 7, @tree_mixin.count
@root1.destroy
assert_equal 2, @tree_mixin.count
@root2.destroy
@root3.destroy
assert_equal 0, @tree_mixin.count
end
def test_insert
@extra = @root1.children.create
assert @extra
assert_equal @extra.parent, @root1
assert_equal 3, @root1.reload.children.count
assert @root1.children.include?(@extra)
assert @root1.children.include?(@root_child1)
assert @root1.children.include?(@root_child2)
end
def test_ancestors
assert_equal [], @root1.ancestors
assert_equal [@root1], @root_child1.ancestors
assert_equal [@root_child1, @root1], @child1_child.ancestors
assert_equal [@root1], @root_child2.ancestors
assert_equal [], @root2.ancestors
assert_equal [], @root3.ancestors
end
def test_root
assert_equal @root1, @tree_mixin.root
assert_equal @root1, @root1.root
assert_equal @root1, @root_child1.root
assert_equal @root1, @child1_child.root
assert_equal @root1, @root_child2.root
assert_equal @root2, @root2.root
assert_equal @root3, @root3.root
end
def test_roots
assert_equal [@root1, @root2, @root3], @tree_mixin.roots
end
def test_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], @tree_mixin.default_tree_order
end
def test_siblings
assert_equal [@root2, @root3], @root1.siblings
assert_equal [@root_child2], @root_child1.siblings
assert_equal [], @child1_child.siblings
assert_equal [@root_child1], @root_child2.siblings
assert_equal [@root1, @root3], @root2.siblings
assert_equal [@root1, @root2], @root3.siblings
end
def test_self_and_siblings
assert_equal [@root1, @root2, @root3], @root1.self_and_siblings
assert_equal [@root_child1, @root_child2], @root_child1.self_and_siblings
assert_equal [@child1_child], @child1_child.self_and_siblings
assert_equal [@root_child1, @root_child2], @root_child2.self_and_siblings
assert_equal [@root1, @root2, @root3], @root2.self_and_siblings
assert_equal [@root1, @root2, @root3], @root3.self_and_siblings
end
def test_self_and_children
assert_equal [@root1, @root_child1, @root_child2], @root1.self_and_children
assert_equal [@root2], @root2.self_and_children
end
def test_self_and_ancestors
assert_equal [@child1_child, @root_child1, @root1], @child1_child.self_and_ancestors
assert_equal [@root2], @root2.self_and_ancestors
end
def test_self_and_descendants
assert_equal [@root1, @root_child1, @root_child2, @child1_child, @child1_child_child], @root1.self_and_descendants
assert_equal [@root2], @root2.self_and_descendants
end
def test_descendants
assert_equal [@root_child1, @root_child2, @child1_child, @child1_child_child], @root1.descendants
assert_equal [], @root2.descendants
end
def test_nullify
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
def test_is_root
assert_equal true, @root1.root?
assert_equal true, @root2.root?
assert_equal true, @root3.root?
assert_equal false, @root_child1.root?
assert_equal false, @child1_child.root?
assert_equal false, @child1_child_child.root?
assert_equal false, @root_child2.root?
end
def test_is_leaf
assert_equal true, @root2.leaf?
assert_equal true, @root3.leaf?
assert_equal true, @child1_child_child.leaf?
assert_equal true, @root_child2.leaf?
assert_equal false, @root1.leaf?
assert_equal false, @root_child1.leaf?
assert_equal false, @child1_child.leaf?
end
def test_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
|_ 1
| |_ 2
| |_ 3
| |_ 4
| |_ 5
|_ 6
|_ 7
END
assert_equal tree_view_outputs, capture_stdout { @tree_mixin.tree_view(:id) }
end
def test_tree_walker
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
-2
--3
---4
-5
6
7
END
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
-3
--4
5
END
assert_equal walk_tree_dfs_sub_output, capture_stdout { @root1.walk_tree{|elem, level| puts "#{'-'*level}#{elem.id}"} }
walk_tree_bfs_output = <<-END.gsub(/^\s+/, '')
1
6
7
-2
-5
--3
---4
END
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
5
-3
--4
END
assert_equal walk_tree_bfs_sub_output, capture_stdout { @root1.walk_tree(:algorithm => :bfs){|elem, level| puts "#{'-'*level}#{elem.id}"} }
end
end
class TestDeepDescendantsPerformance < ActsAsTreeTestCase
def setup
setup_db
@root1 = TreeMixin.create!
create_cascade_children @root1, "root1", 10
@root2 = TreeMixin.create!
create_cascade_children @root2, "root2", 20
@root3 = TreeMixin.create!
create_cascade_children @root3, "root3", 30
@root4 = TreeMixin.create!
create_cascade_children @root4, "root4", 40
@root5 = TreeMixin.create!
create_cascade_children @root5, "root5", 50
end
def self.bench_range
[1, 2, 3, 4, 5]
end
def bench_descendants
skip("until I deal with the performance difference on travis")
assert_performance_linear 0.99 do |x|
obj = instance_variable_get "@root#{x}"
obj.descendants
end
end
def create_cascade_children parent, parent_name, count
first_child_name = "@#{parent_name}_child1"
first_record = TreeMixin.create! parent_id: parent.id
instance_variable_set first_child_name, first_record
(2...count).each do |child_count|
name = "@#{parent_name}_child#{child_count}"
prev = instance_variable_get "@#{parent_name}_child#{child_count - 1}"
new_record = TreeMixin.create! parent_id: prev.id
instance_variable_set name, new_record
end
end
end
class TreeTestWithEagerLoading < ActsAsTreeTestCase
def setup
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!
@rc1 = RecursivelyCascadedTreeMixin.create!
@rc2 = RecursivelyCascadedTreeMixin.create! parent_id: @rc1.id
@rc3 = RecursivelyCascadedTreeMixin.create! parent_id: @rc2.id
@rc4 = RecursivelyCascadedTreeMixin.create! parent_id: @rc3.id
end
def test_eager_association_loading
roots = TreeMixin.includes(:children)
.where('mixins.parent_id IS NULL')
.order('mixins.id')
assert_equal [@root1, @root2, @root3], roots
assert_no_queries do
assert_equal 2, roots[0].children.size
assert_equal 0, roots[1].children.size
assert_equal 0, roots[2].children.size
end
end
def test_eager_association_loading_with_recursive_cascading_three_levels_has_many
root_node = RecursivelyCascadedTreeMixin.includes({children: {children: :children}})
.order('mixins.id')
.first
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.includes({first_child: {first_child: :first_child}})
.order('mixins.id')
.first
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.includes({parent: {parent: :parent}})
.order('mixins.id DESC')
.first
assert_equal @rc1, assert_no_queries { leaf_node.parent.parent.parent }
end
end
class TreeTestWithoutOrder < ActsAsTreeTestCase
def setup
setup_db
@root1 = TreeMixinWithoutOrder.create!
@root2 = TreeMixinWithoutOrder.create!
end
def test_root
assert [@root1, @root2].include? TreeMixinWithoutOrder.root
end
def test_roots
assert_equal [], [@root1, @root2] - TreeMixinWithoutOrder.roots
end
end
class UnsavedTreeTest < ActsAsTreeTestCase
def setup
setup_db
@root = TreeMixin.new
@root_child = @root.children.build
end
def test_inverse_of
# We want children to be aware of their parent before saving either
assert_equal @root, @root_child.parent
end
end
class TreeTestWithCounterCache < ActsAsTreeTestCase
def setup
setup_db counter_cache: 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 test_counter_cache
assert_equal 2, @root.children_count
assert_equal 1, @child1.children_count
end
def test_update_parents_counter_cache
@child1_child1.public_send(UPDATE_METHOD, :parent_id => @root.id)
assert_equal 3, @root.reload.children_count
assert_equal 0, @child1.reload.children_count
end
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
class TreeTestWithTouch < ActsAsTreeTestCase
def setup
setup_db
@root = TreeMixinWithTouch.create!
@child = TreeMixinWithTouch.create! parent_id: @root.id
end
def test_updated_at
previous_root_updated_at = @root.updated_at
@child.public_send(UPDATE_METHOD, :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
class GenerationMethods < ActsAsTreeTestCase
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!
@root2_child1 = TreeMixin.create! parent_id: @root2.id
@root2_child2 = TreeMixin.create! parent_id: @root2.id
@root2_child1_child = TreeMixin.create! parent_id: @root2_child1.id
@root3 = TreeMixin.create!
@level_column = LevelMixin.create! level: 'Has Level Column'
@level_method = TreeMixinWithLevelMethod.create!
end
def test_generations
assert_equal(
{
0 => [@root1, @root2, @root3],
1 => [@root_child1, @root_child2, @root2_child1, @root2_child2],
2 => [@child1_child, @root2_child1_child],
3 => [@child1_child_child]
},
TreeMixin.generations
)
end
def test_generation
assert_equal [@root2, @root3], @root1.generation
assert_equal [@root_child2, @root2_child1, @root2_child2],
@root_child1.generation
assert_equal [@root2_child1_child], @child1_child.generation
assert_equal [], @child1_child_child.generation
end
def test_self_and_generation
assert_equal [@root1, @root2, @root3], @root1.self_and_generation
assert_equal [@root_child1, @root_child2, @root2_child1, @root2_child2],
@root_child1.self_and_generation
assert_equal [@child1_child, @root2_child1_child],
@child1_child.self_and_generation
assert_equal [@child1_child_child], @child1_child_child.self_and_generation
end
def test_tree_level
assert_equal 0, @root1.tree_level
assert_equal 1, @root_child1.tree_level
assert_equal 2, @child1_child.tree_level
assert_equal 3, @child1_child_child.tree_level
end
def test_level
assert_equal 0, @root1.level
assert_equal 1, @root_child1.level
assert_equal 2, @child1_child.level
assert_equal 3, @child1_child_child.level
end
def test_alias_tree_level
assert_equal 'Has Level Method', @level_method.level
assert_equal 'Has Level Column', @level_column.level
end
end
|