Skip to content

CHANGELOG.md

Latest commit

 

History

History
578 lines (373 loc) · 26.6 KB

CHANGELOG.md

File metadata and controls

578 lines (373 loc) · 26.6 KB

Changelog

9.6.1 (2026-03-07)

Bug Fixes

9.6.0 (2026-02-16)

Features

  • raise error when advisory lock cannot be acquired within configured timeout (#480) (c030385)
  • sibling reordering when node changes parent or scope (#484) (254ba36)

9.5.0 (2026-01-21)

Features

  • Add dependent: :adopt option for has_closure_tree (#471) (d47d7c9)
  • add PostgreSQL schema-qualified table name support (#462) (5f9006c)
  • Add runtime advisory lock name customization and multi-database documentation (#454) (d6ffd73)
  • migrate from ActiveSupport::Autoload to Zeitwerk (#457) (d18e80c)
  • rewrite with clean api (#451) (f56f2e1)
  • use with_advisory_lock that support rails 8.2 (#479) (bca6231)

Bug Fixes

  • add implicit_order_column for Rails 8.1+ compatibility (#464) (f384303)
  • configure release-please to recognize v8.0.0 release (#455) (fc34f21)
  • eager loading of hierarchies by defining the primary key (#465) (8c7e490)
  • hierarchy class inheritance to avoid STI validations (#392) (#472) (73b07a6)
  • improve api usage (#475) (cde4d29)
  • nil scope values being excluded from scope filtering (#476) (f45880e)
  • restore proper deprecation for database_less configuration (#459) (de8b402)

9.3.0 (2025-11-19)

Features

  • eager loading of hierarchies by defining the primary key (#465) (8c7e490)

9.2.0 (2025-10-17)

Features

  • add PostgreSQL schema-qualified table name support (#462) (5f9006c)

Bug Fixes

  • add implicit_order_column for Rails 8.1+ compatibility (#464) (f384303)

9.1.1 (2025-07-24)

Bug Fixes

  • restore proper deprecation for database_less configuration (#459) (de8b402)

9.1.0 (2025-07-23)

Features

  • migrate from ActiveSupport::Autoload to Zeitwerk (#457) (d18e80c)

9.0.0 (2025-07-21)

Features

  • Add runtime advisory lock name customization and multi-database documentation (#454) (d6ffd73)
  • rewrite with clean api (#451) (f56f2e1)

Bug Fixes

  • configure release-please to recognize v8.0.0 release (#455) (fc34f21)

8.0.0

  • Drop support to EOL ruby and rails
  • Reference ancestor_hierarchies in depth instead of ancestors to avoid n+1

7.4.0

Full Changelog

  • fix: hierarchy model with namespace should inherit from the superclass of basic model #384 (shawndodo)
  • Add with_descendant to readme #381 (mattvague)

7.3.0

  • Ruby 3.0 support

7.2.0

  • Ruby 2.7 support
  • Ordering raw SQL argument wrapped with Arel.sql

7.1.0

Closure Tree is now tested against Rails 6.0

  • Directly require core_ext for String#strip_heredocPR 350
  • Call Module#module_parent instead of deprecated #parentPR 354

7.0.0

Closure Tree is now tested against Rails 5.2

  • Postpone configuration (database introspection)PR 264
  • Fix "tree.find_by_path([])" PR 288
  • Fixed generator specs and added migration version PR 292
  • Eliminate deprecation warnings in ActiveRecord 5.2 PR 296
  • When using 'oracle_enhanced', remove 'AS' on the table_name alias. PR 298
  • README update PR 301
  • Add with_descendant finder PR 302
  • Fix pg version for rails prior 5.1 PR 303
  • Test on Rails 5.2 & fix mysql for older Rails PR 304
  • Test with ActiveRecord 5.2.0 PR 307
  • README update PR 310
  • FactoryBot linter failing for a model that uses closure_tree PR 311
  • Added dont_order_roots option PR 312
  • Added instance methods to determine the relationship between 2 nodes PR 314
  • Add an instance method to check the relationship between 2 nodes: #family_of? PR 319
  • Remove options restrictions on has_closure_tree_root PR 321
  • Fix uninitialized variable warnings PR 323

6.6.0

Closure Tree is now tested against Rails 5.1, and just passed 50 contributors and 1000 stars on github! 🎉!

Note that Closure Tree has moved to a new "Closure Tree" github organization. Future gem releases will be done by other contributors.

6.5.0

6.4.0

  • Merged PR 236 which adds documentation for has_closure_tree_root.
  • Added ruby 2.4 and dropped Rails 4.1 from the build matrix.

6.3.0

6.2.0

6.1.0

  • Added official support for ActiveRecord 5.0! Thanks to Abdelkader Boudih, Jay Fredlund, Veselin Stoyanov, and Aaron Russell for all the PRs.
  • Add database_less configuration to not raise an error during build step when database is unavailable which is a common case in some PaaS like (Heroku, Catalyze, ..., etc).

6.0.0

  • Andrew Kumanyaev dramatically improved mutation performance on large trees. Thanks for the PR!
  • Martin Schmidt discovered and fixed build problems due to new versions of mysql2 and ammeter which broke Travis builds. Thanks for the PR!
  • Fabien MICHEL updated the README with another example. Thanks for the PR!

6.0.0.alpha,beta,gamma

  • Dropped support for versions of Rails 3.2 and 4.0 (which are no longer supported).
  • Dropped support for Ruby 1.9 and JRuby 1.9 (which are no longer supported).
  • Added support for .hash_tree from .parent and .children. Addresses PR146. Thanks for reporting this and the breaking test, Mike!

5.2.0

  • Eduardo Turiño renamed acts_as_tree to has_closure_tree. We'll keep both annotations around for the forseeable future, but I think not name-colliding by default is strictly better. (Thanks for both the suggestion and PR!)
  • Ryan Selk made several enhancements to the migration generation (thanks!).
  • ruok5 updated the README to clarify a heirarchy maintenance usecase. Thanks!
  • Made migrations error with a helpful message if the target didn't have the has_closure_tree or acts_as_tree annotation. This addresses issue 131.

5.1.1

  • Fixed bug in rails g closure_tree:migration (introduced by me, not by seuros!) that was reported and fixed by Rich Kuo. Thanks!

5.1.0

5.0.0

Breaking API changes

  • find_by_path and find_or_create_by_path now takes either an array of strings or an array of attribute hashes, which can include the inheritance column for STI support.
  • Removed the extraneous base_class acts_as_tree option—it needlessly duplicated ActiveRecord's method.
  • Removed the unused name acts_as_tree option.

Improvements and bugfixes

  • Cleaned up the inheritance support methods to delegate correctly to ActiveRecord
  • Fixed a query generation error when ancestor paths exceeded 50 items.
  • Documented the .touch option

4.6.3

4.6.2

  • Pulled in 106 which fixed a bug introduced in 4.6.0 which broke if the numeric ordering column wasn't named 'sort_order'. Tests have been added. Thanks for the fix, Fission Xuiptz!

4.6.1

4.6.0

  • Deterministically ordered trees are guaranteed to have a sort_order now.

    This may be a breaking change if you're expecting sort_order to be nullable.

    Many thanks to David Schmidt for raising and working on the issue!

  • Added append_child and prepend_child

  • All raw SQL is now strip_heredoc'ed

4.5.0

4.4.0

  • Added .self_and_descendant_ids and .self_and_ancestors_ids from PR92. Thanks, Kir Shatrov!

  • Dropped support for Rails 3.0.

4.3.0

  • Use foreigner to prove that things are inserted and deleted without violating foreign key constraints

  • Added Rails 4.1.0.rc2 as a Travis CI build target

4.2.9

  • Support for Heroku's cray assets:precompile hack for Rails 4. Addresses issue 78. Thanks for the assist, Alex Bowman.

4.2.8

  • More massaging for Rails 4 and attr_accessible support

4.2.7

  • self_and_ancestors and ancestry_hierarchy are reloaded when nodes are reparented. Addresses issue 68. Thanks for the assist, Ivan Stana.

4.2.6

  • Explicitly added MIT licensing to the gemspec.

4.2.5

  • Fix for potential deadlock from delete_hierarchy_references not being called within an advisory lock. Thanks, Armando Guereca, for finding that!

  • Sped up find_or_create_by_path to skip cycle detection validation. A node whose ancestry was 200-deep took 20 seconds to create (!!), and now takes < 1 second.

  • Fixed issue with MySQL that prevented nodes > 60 levels deep from being created

4.2.4

  • Support for root?, child?, and proper parent-child associations when both the parent and the child are not persisted. Addresses issue 64. Thanks for the help, Gabriel Mazetto!

4.2.3

  • Fixed attr_accessible? error introduced in 4.2.2 (issue 66).
  • Switched to use new WithAdvisoryLock::DatabaseAdapterSupport (in v0.0.9) to add Postgis support

4.2.2

  • Support attr_accessible and strong_attributes even if you're on Rails 4

4.2.1

  • Deleting from NumericDeterministicOrdering doesn't create sort order gaps anymore.

4.2.0

  • Added with_ancestor(*ancestors). Thanks for the idea, Matt!
  • Applied Leonel Galan's fix for Strong Attribute support
  • find_or_create_by now uses passed-in attributes as both selection and creation criteria. Thanks for the help, Judd Blair! Please note that this changes prior behavior—test your code with this new version!
  • ct_advisory_lock was moved into the _ct support class, to reduce model method pollution
  • Moved a bunch of code into more focused piles of module mixins

4.1.0

  • Added support for Rails 4.0.0.rc1 and Ruby 2.0.0 (while maintaining backward compatibility with Rails 3, BOOYA)
  • Added #to_dot_digraph, suitable for Graphviz rendering

4.0.1

  • Numeric, deterministically ordered siblings will always be [0..#{self_and_siblings.count}] (previously, the sort order might use negative values, which broke the preordering). Resolves issue 49. Thanks for the help, Leonel Galan, Juan Hoyos, and Michael Elfassy!

  • The order option can be a symbol now. Resolves issue 46.

4.0.0

  • Moved all of closure_tree's implementation-detail methods into a ClosureTree::Support instance, which removes almost all of the namespace pollution in your models that wasn't for normal consumption. If you were using any of these methods, they're now available through the "_ct" class and instance member.

    This change may break consumers, so I incremented the major version number, even though no new functionality was released.

3.10.2

  • Prevent faulty SQL statement when #siblings is called on an unsaved records. Resolves issue 52. Perfect pull request by Gary Greyling.

  • The .roots class method now correctly respects the :order option. Resolves issue 53. Thanks for finding this, Brendon Muir!

3.10.1

  • Multipart constant names like "Admin::PageHierarchy" are now supported. Resolves issue 47. Thanks for the perfect pull request, Simon Menke!

  • Committing transactions involving large numbers of hierarchy model classes was very slow due to hash collisions in the hierarchy class. A better hash implementation addressed issue 48. Thanks, Joel Turkel!

3.10.0

  • Added #roots_and_descendants_preordered. Thanks for the suggestion, Leonel Galan!

3.9.0

  • Added .child_ids.
  • Removed dependent => destroy on the descendant_hierarchy and ancestor_hierarchy collections (they were a mistake).
  • Clarified documentation for creation and child associations. Because Tag.create!(:parent => ...) requires a .reload, I removed it as an example.

All three of these improvements were suggested by Andrew Bromwich. Thanks!

3.8.2

  • find_by_path uses 1 SELECT now. BOOM.

3.8.1

  • Double-check locking for find_or_create_by_path

3.8.0

  • Support for preordered descendants. This requires a numeric sort order column. Resolves feature request 38.
  • Moved modules from acts_as_tree into separate files

3.7.3

Due to MySQL's inability to lock rows properly, I've switched to advisory_locks for all write paths. This will prevent deadlocks, addressing issue 41.

3.7.2

  • Support for UUID primary keys. Addresses issue 40. Thanks for the pull request, Julien!

3.7.1

  • Moved requires into ActiveSupport.on_load
  • Added require 'with_advisory_lock'

3.7.0

Thread safety!

  • Advisory locks were integrated with the class-level find_or_create_by_path and rebuild!.
  • Pessimistic locking is used by the instance-level find_or_create_by_path.

3.6.9

  • Don Morrison massaged the #hash_tree query to be more efficient, and found a bug in hash_tree's query that resulted in duplicate rows, wasting time on the ruby side.

3.6.7

  • Added workaround for ActiveRecord::Observer usage pre-db-creation. Addresses issue 32. Thanks, Don Morrison!

3.6.6

3.6.5

3.6.4

3.6.3

3.6.2

  • Fixed issue 23, which added support for #siblings when sort_order wasn't specified. Thanks, Gary Greyling!

3.6.1

  • Fixed issue 20, which affected deterministic ordering when siblings where different STI classes. Thanks, edwinramirez!

3.6.0

Added support for:

  • :hierarchy_class_name as an option
  • ActiveRecord::Base.table_name_prefix
  • ActiveRecord::Base.table_name_suffix

This addresses issue 21. Thanks, Judd Blair!

3.5.2

3.4.2

  • Fixed issue 18, which affected append_node/prepend_node ordering when the first node didn't have an explicit order_by value

3.4.1

  • Reverted .gemspec mistake that changed add_development_dependency to add_runtime_dependency

3.4.0

Fixed issue 15:

  • "parent" is now attr_accessible, which adds support for constructor-provided parents.
  • updated readme accordingly

3.3.2

  • Merged calebphillips' patch for a more efficient leaves query

3.3.1

  • Added support for partially-unsaved hierarchies issue 13:
a = Tag.new(name: "a")
b = Tag.new(name: "b")
a.children << b
a.save

3.3.0

3.2.1

  • Added ancestor_ids, descendant_ids, and sibling_ids
  • Added example spec to solve issue 9

3.2.0

  • Added support for deterministic ordering of nodes.

3.1.0

  • Switched to using has_many :though rather than has_and_belongs_to_many

3.0.4

3.0.3

  • Added support for ActiveRecord's whitelist_attributes (Make sure you read the Rails Security Guide, and enable config.active_record.whitelist_attributes in your config/application.rb ASAP!)

3.0.2

  • Fix for ancestry-loop detection (performed by a validation, not through raising an exception in before_save)

3.0.1

  • Support 3.2.0's fickle deprecation of InstanceMethods (Thanks, jheiss)!

3.0.0

  • Support for polymorphic trees
  • find_by_path and find_or_create_by_path signatures changed to support constructor attributes
  • tested against Rails 3.1.3

2.0.0

  • Had to increment the major version, as rebuild! will need to be called by prior consumers to support the new leaves class and instance methods.
  • Tag deletion is supported now along with :dependent => :destroy and :dependent => :delete_all
  • Switched from default rails plugin directory structure to rspec
  • Support for running specs under different database engines: export DB ; for DB in sqlite3 mysql postgresql ; do rake ; done