iv-org-mirror/shard-radix
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-radix.git synced 2024-08-15 00:43:21 +00:00
Code Issues Projects Releases Packages Wiki Activity
shard-radix/CHANGELOG.md

50 lines
1.6 KiB
Markdown
Raw Normal View History

Add more details to Change Log - Correct project name. - Add links for Unreleased section. - Indicate the versioning schema the project aims to comply with.
2016-03-10 19:49:49 +00:00
# Change Log
All notable changes to Radix project will be documented in this file.
This project aims to comply with [Semantic Versioning](http://semver.org/),
so please check *Changed* and *Removed* notes before upgrading.
Introduce types for forward compiler compatiblity After Crystal 0.15, compiler will require declare the types used by instance variables on classes. This require changes to the usage of `Radix::Tree` by introducing the type of payload elements it will handle: # Will only support symbols as payload tree = Radix::Tree(Symbol).new tree.add "/", :root # Error: cannot add node with anything other than Symbol tree.add "/meaning-of-life", 42 The changes ensure future compatibility with Crystal and also enforces a more declarative usage of `Radix::Tree`. If necessary, you can combine multiple types to ensure a tree can contain all the wide range of payloads you need: tree = Radix::Tree.new(Foo | Bar | Symbol).new tree.add "/", :root tree.add "/foo", foo_instance This change includes: - Tree, Node and Result has been updated to require types. - Node is capable of have optional payload (from defined type). - Documentation has been updated to reflect this change.
2016-04-14 23:46:12 +00:00
## [Unreleased]
### Fixed
- Improve forward compatibility with newer versions of the compiler by adding
missing types to solve type inference errors.
### Changed
- `Radix::Tree` now requires the usage of a type which will be used as node's
payload. See [README](README.md) for details.
Prepare for release: v0.2.1
2016-03-15 23:52:58 +00:00
## [0.2.1] - 2016-03-15
### Fixed
- Correct `Result#key` incorrect inferred type.
### Removed
- Attempt to use two named parameters at the same level will raise
`Radix::Tree::SharedKeyError`
## [0.2.0] - 2016-03-15 [YANKED]
Remove deprecation on shared named parameters Deal with named parameters under same level (shared) and raise proper `SharedKeyError` exception. This is a non-backward compatible change aims to solve result mapping issues and tree lookup. Now README covers this under *Caveats* section and offers an alternative organization of the paths used on the tree. To avoid potential issues when using `master` instead of a locked release, bump the version.
2016-03-10 23:49:52 +00:00
### Removed
- Attempt to use two named parameters at the same level will raise
`Radix::Tree::SharedKeyError`
Prepare for release: v0.1.2
2016-03-10 23:18:59 +00:00
## [0.1.2] - 2016-03-10
Correctly split named parameters on tree insert Our Radix implementation was literally considering every single character as candidate for splitting, which caused keys that contained named parameters markers (`:foo`) to be broken across nodes: tree = Radix::Tree.new tree.add "/", :root tree.add "/:post", :post tree.add "/:category/:post", :category_post # / # : # post # category/:post This caused incorrect behavior when performing lookup (`Tree#find`) and failing to detect and map the key name, even when the value was properly captured: result = tree.find "/example" pp result.found? # => false This change corrects the issue by identifying named parameter marker and once detected, consider everything until a separator or the end of the supplied string is reached to be a unique key: tree = Radix::Tree.new tree.add "/", :root tree.add "/:post", :post tree.add "/:category/:post", :category_post # / # :category/:post # :post However, due how Radix tree is structured, two named parameters at the same level might result in problems during lookup phase: tree = Radix::Tree.new tree.add "/", :root tree.add "/:post", :post tree.add "/:category/:post", :category_post # / # :category/:post # :post tree.root.sort! # / # :post # :category/:post result = tree.find "/example" pp result.found? # => false pp result.params # => {"post" => "example"} result = tree.find "/news/first-post" pp result.found? # => false pp result.params # => {"post" => "news"} Causing lookup to fail and values be stored under incorrect keys for the parameters. Because of this, a deprecation warning will be shown to allow users adjust and correct their code prior fully removing it and raise error (you know, semantic versioning and all that jazz). This fixes #5 and closes #4
2016-03-10 12:55:10 +00:00
### Fixed
- No longer split named parameters that share same level (@alsm)
### Changed
- Attempt to use two named parameters at same level will display a
deprecation warning. Future versions will raise `Radix::Tree::SharedKeyError`
doc: Add CHANGELOG.md file with list of changes [skip ci]
2016-02-29 15:08:48 +00:00
Prepare for release: v0.1.1
2016-02-29 15:11:12 +00:00
## [0.1.1] - 2016-02-29
doc: Add CHANGELOG.md file with list of changes [skip ci]
2016-02-29 15:08:48 +00:00
### Fixed
- Fix named parameter key names extraction.
## [0.1.0] - 2016-01-24
### Added
- Initial release based on code extracted from Beryl.
Prepare for release: v0.2.1
2016-03-15 23:52:58 +00:00
[Unreleased]: https://github.com/luislavena/radix/compare/v0.2.1...HEAD
[0.2.1]: https://github.com/luislavena/radix/compare/v0.2.0...v0.2.1
Prepare for release: v0.2.0
2016-03-15 23:39:35 +00:00
[0.2.0]: https://github.com/luislavena/radix/compare/v0.1.2...v0.2.0
Prepare for release: v0.1.2
2016-03-10 23:18:59 +00:00
[0.1.2]: https://github.com/luislavena/radix/compare/v0.1.1...v0.1.2
Prepare for release: v0.1.1
2016-02-29 15:11:12 +00:00
[0.1.1]: https://github.com/luislavena/radix/compare/v0.1.0...v0.1.1
Reference in a new issue Copy permalink