Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add :child_order to .rebuild! #377

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add :child_order to .rebuild! #377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,8 @@ end
```
This way, the complete hierarchy including all subclasses will be rebuilt.

If you need to preserve a certain children order to rebuild your tree you can call `rebuild` with the keyword `child_order` and give a regular ordering hash: `rebuild!(child_order: {name: :desc})`

## Deterministic ordering

By default, children will be ordered by your database engine, which may not be what you want.
Expand Down
8 changes: 4 additions & 4 deletions lib/closure_tree/hierarchy_maintenance.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def _ct_before_destroy
true # don't prevent destruction
end

def rebuild!(called_by_rebuild = false)
def rebuild!(called_by_rebuild = false, child_order: nil)
_ct.with_advisory_lock do
delete_hierarchy_references unless (defined? @was_new_record) && @was_new_record
hierarchy_class.create!(:ancestor => self, :descendant => self, :generations => 0)
Expand All @@ -82,7 +82,7 @@ def rebuild!(called_by_rebuild = false)
_ct_reorder_siblings if !called_by_rebuild
end

children.find_each { |c| c.rebuild!(true) }
children.reorder(child_order).find_each { |c| c.rebuild!(true, child_order: child_order) }

_ct_reorder_children if _ct.order_is_numeric? && children.present?
end
Expand Down Expand Up @@ -110,10 +110,10 @@ def delete_hierarchy_references
module ClassMethods
# Rebuilds the hierarchy table based on the parent_id column in the database.
# Note that the hierarchy table will be truncated.
def rebuild!
def rebuild!(child_order: nil)
_ct.with_advisory_lock do
cleanup!
roots.find_each { |n| n.send(:rebuild!) } # roots just uses the parent_id column, so this is safe.
roots.find_each { |n| n.send(:rebuild!, child_order: child_order) } # roots just uses the parent_id column, so this is safe.
end
nil
end
Expand Down
9 changes: 9 additions & 0 deletions spec/closure_tree/hierarchy_maintenance_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@
Metal.rebuild!
expect(MetalHierarchy.count).to eq(hierarchy_count)
end

it 'rebuild tree with specific child order' do
parent = Metal.create(value: "Parent")
Metal.create(value: "name3")
Metal.create(value: "name1")
Metal.create(value: "name2")
expect(parent.children).to receive(:reorder).with({value: :desc}).once.and_call_original
parent.rebuild!(child_order: {value: :desc})
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should assert that the order is correct.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great idea. i asserted that on our project but that's of course not sufficient. can you please help me how i could do it? The Metal model doesn't seem to have a sort_order, how would you write a spec for this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expect(parent.children[0].value).to_equal 'name1'
expect(parent.children[1].value).to_equal 'name2'
expect(parent.children[2].value).to_equal 'name3'

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expect(parent.children[0].value).to_equal 'name1'
expect(parent.children[1].value).to_equal 'name2'
expect(parent.children[2].value).to_equal 'name3'

okay, if that would be sufficient, lemme add that quick. thanks.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seuros is it possible that my fix isn't really a fix for the scope of the gem? it did work on our project, but i can't get it running for the specs on the gem.

i did create a new model which should the the numeric ordering.

class MetalWithNumericOrder < ActiveRecord::Base
  self.table_name = "#{table_name_prefix}metal#{table_name_suffix}"
  has_closure_tree order: 'sort_order', name_column: 'value', numeric_order: true
  self.inheritance_column = 'metal_type'
end

parent = MetalWithNumericOrder.create(value: "Parent")
      MetalWithNumericOrder.create(value: "3", parent: parent)
      MetalWithNumericOrder.create(value: "1", parent: parent)
      MetalWithNumericOrder.create(value: "2", parent: parent)
parent.rebuild!

i create a tree and now the order is 3, 1, 2 which is correct.

i would like to recreate the tree, but sort based on value, so i would expect then descendants to be 1,2,3

however i seem to be missing some logic here.

i had the impression that children.reorder(child_order).find_each { |c| c.rebuild!(true, child_order: child_order) } would be sufficient since that decides how we reorder the tree but it seems to be done in reorder_with_parent_id. do i need to inject the reordering in there?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have act as list in the app ?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seuros yes, acts_as_list is within it. does it interfere?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @krtschmr , i missed this PR.

As you noticed reorder is part of Act as list and this gem . We could add a file that is required manually to add this feature. But it should not be part of the core maintenance file.

end
end

describe '.cleanup!' do
Expand Down