iv-org-mirror
/
shard-radix
mirror of https://gitea.invidious.io/iv-org/shard-radix.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
shard-radix/CHANGELOG.md

117 lines
4.3 KiB
Markdown
Raw Permalink 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]
Prepare for release: v0.3.9
2019-01-02 18:02:51 +00:00
Prepare for release: v0.4.1
2021-03-23 12:15:56 +00:00
## [0.4.1] - 2021-03-23
Update CHANGELOG with changes from PRs
2021-03-23 12:12:16 +00:00
### Fixed
- Indicate minimum Crystal version (for 1.0 compatibility) [#32](https://github.com/luislavena/radix/pull/32) (@carlhoerberg)
Prepare for release: v0.4.0
2021-01-31 03:01:06 +00:00
## [0.4.0] - 2021-01-31
Correct lookup with shared key and glob Properly skip nodes and continue lookup when the key to be looked up shares partial elements with others. With the following scenario: tree = Radix::Tree(Symbol).new tree.add "/*glob", :catch_all tree.add "/resources", :resources tree.add "/robots.txt", :robots When attempt to lookup for `/reviews`, it will now correctly return `:catch_all` as found. Fixes #23
2021-01-31 01:25:26 +00:00
### Fixed
- Correct lookup issue caused by partial shared key with glob [#23](https://github.com/luislavena/radix/issues/23)
Fix incorrect lookup in non-root nodes Given the following non-root tree: tree = Tree(Symbol).new tree.add "/prefix/", :prefix tree.add "/prefix/foo", :foo Attempt to lookup for `/foo` was incorrectly identifying `:foo` entry as the correct value. This change ensures that child nodes of the current node are not scanned if key and path being looked up do not match. Fixes #27
2021-01-31 02:31:19 +00:00
- Correct lookup caused by non-root key in suffix [#27](https://github.com/luislavena/radix/issues/27)
Correct lookup with shared key and glob Properly skip nodes and continue lookup when the key to be looked up shares partial elements with others. With the following scenario: tree = Radix::Tree(Symbol).new tree.add "/*glob", :catch_all tree.add "/resources", :resources tree.add "/robots.txt", :robots When attempt to lookup for `/reviews`, it will now correctly return `:catch_all` as found. Fixes #23
2021-01-31 01:25:26 +00:00
Remove Radix::Result#key usage in the codebase No longer expose internal functionality used only in tests. Reduce the exposed elements of `Radix::Result` to focus on payload only. Also remove the associated array used to collect all the traversed nodes when performing the lookup. NOTE: this is a breaking change
2021-01-30 23:15:47 +00:00
### Removed
Prepare for release: v0.4.0
2021-01-31 03:01:06 +00:00
- Remove `Radix::Result#key` since exposes internal details about structure (**breaking change**)
Remove Radix::Result#key usage in the codebase No longer expose internal functionality used only in tests. Reduce the exposed elements of `Radix::Result` to focus on payload only. Also remove the associated array used to collect all the traversed nodes when performing the lookup. NOTE: this is a breaking change
2021-01-30 23:15:47 +00:00
Prepare for release: v0.3.9
2019-01-02 18:02:51 +00:00
## [0.3.9] - 2019-01-02
CHANGELOG: document merges [skip ci]
2019-01-02 17:59:44 +00:00
### Fixed
- Correct catch-all issue caused when paths differ [#26](https://github.com/luislavena/radix/pull/26) (@silasb)
Prepare for release: v0.3.8
2017-03-12 16:02:56 +00:00
## [0.3.8] - 2017-03-12
Fix incorrect lookup on non-shared partial keys Given the following nodes in a tree: # ( 8) /product # ( 4) /new # ( 1) s tree = Radix::Tree(Symbol).new tree.add "/products", :products tree.add "/product/new", :product_new It failed to properly identify `/products` during lookup: result = tree.find "/products" result.found? # => false Caused by incorrect comparsion of `s` remaining path against `/new` node instead of continue comparison with the next one. Fixes #21
2017-03-12 15:36:05 +00:00
### Fixed
- Correct lookup issue caused by incorrect comparison of shared key [#21](https://github.com/luislavena/radix/issues/21)
Improves support for non-ascii keys in a tree Properly recognize and organize non-ascii keys into nodes, allowing usage with entries in other languages. With this change, it is possible to use 2 or 3 bytes wide characters (Unicode) without issues: tree = Radix::Tree(Symbol).new tree.add "/", :root tree.add "/日本語", :japanese tree.add "/日本は難しい", :japanese_is_difficult Which produces the following node hierarchy: # ( 1) / (:root) # ( 6) 日本 # (12) は難しい (:japanese_is_difficult) # ( 3) 語 (:japanese) And lookup works as expected: result = tree.find "/日本は難しい" puts result.found? # => true
2017-02-18 23:30:05 +00:00
- Improve support for non-ascii keys in a tree.
Prepare for release: v0.3.7
2017-02-04 16:00:14 +00:00
## [0.3.7] - 2017-02-04
Makes node prioritization insertion-independent The order in which nodes were inserted into a tree might produce failures in lookup mechanism. tree = Radix::Tree(Symbol).new tree.add "/one/:id", :one tree.add "/one-longer/:id", :two result = tree.find "/one-longer/10" # expected `true` result.found? # => false In above example, reversing the order of insertion solved the issue, but exposed the naive sorting/prioritization mechanism used. This change improves that by properly identifying the kind of node being evaluated and compared against others of the same kind. It is now possible to know in advance if a node contains an special condition (named parameter or globbing) or is a normal one: node = Radix::Node(Nil).new("a") node.normal? # => true node = Radix::Node(Nil).new(":query") node.named? # => true node = Radix::Node(Nil).new("*filepath") node.glob? # => true Which helps out with prioritization of nodes: - A normal node ranks higher than a named one - A named node ranks higher than a glob one - On two of same kind, ranks are based on priority With this change in place, above example works as expected: tree = Radix::Tree(Symbol).new tree.add "/one/:id", :one tree.add "/one-longer/:id", :two result = tree.find "/one-longer/10" result.found? # => true Fixes #18
2017-02-04 15:10:51 +00:00
### Fixed
- Correct prioritization of node's children using combination of kind and
priority, allowing partial shared keys to coexist and resolve lookup.
Prepare for release: v0.3.6
2017-01-18 15:29:43 +00:00
## [0.3.6] - 2017-01-18
Lowers named and glob node priority to fix lookup issue Given two similar keys, one short and one with named parameter, lookup was incorrectly picking up the named parameter version instead of the specific one: tree = Radix::Tree(Symbol).new tree.add "/tag-edit/:id", :edit_tag tree.add "/tag-edit2", :alternate_edit_tag result = tree.find("/tag-edit2") result.found? # => false The order of insertion (named before specific) was causing the lookup mechanism to validate it before checking the other options. With the changes present here, short or long keys will be affected anymore by named or globbed keys present when sharing part of the key. Fixes kemalcr/kemal#293
2017-01-17 17:30:20 +00:00
### Fixed
- Correct lookup issue caused by similar priority between named paramter and
shared partial key [kemalcr/kemal#293](https://github.com/kemalcr/kemal/issues/293)
Prepare for release: v0.3.5
2016-11-25 00:04:15 +00:00
## [0.3.5] - 2016-11-24
fix(Tree): corrects lookup issue with catch all and shared key Lookup was failing when part of the given path matched a key at the first character, even when the rest of the key didn't match. It was not possible place a catch all an another key at the same level that started with same character. This change ensures that all shared part between path and key is compared prior assuming usage of that node as part of the lookup. Closes #14
2016-11-24 23:52:07 +00:00
### Fixed
- Correct lookup issue when dealing with catch all and shared partial key (@crisward)
Prepare for release: v0.3.3
2016-11-12 16:58:42 +00:00
Prepare for release: v0.3.4 Yank v0.3.3 due mismatched `Radix::VERSION` version.
2016-11-12 18:47:10 +00:00
## [0.3.4] - 2016-11-12
### Fixed
- Ensure catch all parameter can be used as optional globbing (@jwoertink)
## [0.3.3] - 2016-11-12 [YANKED]
fix(Tree): allows catch all to be used as optional globbing Catch all parameter was limited to be used *after* a slash (`/`) on a path (ie. `/members/*trailing`). Attempts to use it immediately after the path (ie. `/members*trailing`) was not properly identified or captured. This change ensures catch all can be used as globbing, allowing capture of anything after the matching path. Closes #12
2016-11-12 15:49:23 +00:00
### Fixed
- Ensure catch all parameter can be used as optional globbing (@jwoertink)
Prepare for release: v0.3.2
2016-11-05 18:32:44 +00:00
## [0.3.2] - 2016-11-05
fix(Tree): allows insert paths with shared keys unordered When adding new nodes into the tree, the lookup mechanism failed to detect same named parameter was already added to it, raising an exception. Example: tree = Radix::Tree(Symbol).new tree.add "/members/:id/edit", :member_edit tree.add "/members/export", :members_export tree.add "/members/:id/videos", :member_videos # Exception This fix ensures that comparison is done key by key, even if they are inserted into the tree in a different order. Closes #9
2016-11-05 16:42:20 +00:00
### Fixed
- Do not force adding paths with shared named parameter in an specific order (@jwoertink)
spec(VERSION): format naming for better verbose output Avoid `Radix::VERSION` being evaluated and use the string version for presentation purposes.
2016-11-05 18:02:45 +00:00
- Give proper name to `Radix::VERSION` spec when running in verbose mode.
Ensure code samples in docs can be executed
2016-11-05 18:24:27 +00:00
- Ensure code samples in docs can be executed.
Prepare for release: v0.3.1
2016-07-29 16:27:51 +00:00
## [0.3.1] - 2016-07-29
Add VERSION constant for runtime usage Introduce `Radix::VERSION` to be used at runtime by users of the library for any purpose this will help them (expose them, use conditional blocks or similar). Also add spec that checks that defined versions in both `shard.yml` and `Radix::VERSION` matches to avoid messing up releases.
2016-05-16 23:37:41 +00:00
### Added
- Introduce `Radix::VERSION` so library version can be used at runtime.
Prepare for release: v0.3.0
2016-04-16 20:19:29 +00:00
## [0.3.0] - 2016-04-16
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
### 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.4.1
2021-03-23 12:15:56 +00:00
[Unreleased]: https://github.com/luislavena/radix/compare/v0.4.1...HEAD
[0.4.1]: https://github.com/luislavena/radix/compare/v0.4.0...v0.4.1
Prepare for release: v0.4.0
2021-01-31 03:01:06 +00:00
[0.4.0]: https://github.com/luislavena/radix/compare/v0.3.9...v0.4.0
Prepare for release: v0.3.9
2019-01-02 18:02:51 +00:00
[0.3.9]: https://github.com/luislavena/radix/compare/v0.3.8...v0.3.9
Prepare for release: v0.3.8
2017-03-12 16:02:56 +00:00
[0.3.8]: https://github.com/luislavena/radix/compare/v0.3.7...v0.3.8
Prepare for release: v0.3.7
2017-02-04 16:00:14 +00:00
[0.3.7]: https://github.com/luislavena/radix/compare/v0.3.6...v0.3.7
Prepare for release: v0.3.6
2017-01-18 15:29:43 +00:00
[0.3.6]: https://github.com/luislavena/radix/compare/v0.3.5...v0.3.6
Prepare for release: v0.3.5
2016-11-25 00:04:15 +00:00
[0.3.5]: https://github.com/luislavena/radix/compare/v0.3.4...v0.3.5
Prepare for release: v0.3.4 Yank v0.3.3 due mismatched `Radix::VERSION` version.
2016-11-12 18:47:10 +00:00
[0.3.4]: https://github.com/luislavena/radix/compare/v0.3.3...v0.3.4
Prepare for release: v0.3.3
2016-11-12 16:58:42 +00:00
[0.3.3]: https://github.com/luislavena/radix/compare/v0.3.2...v0.3.3
Prepare for release: v0.3.2
2016-11-05 18:32:44 +00:00
[0.3.2]: https://github.com/luislavena/radix/compare/v0.3.1...v0.3.2
Prepare for release: v0.3.1
2016-07-29 16:27:51 +00:00
[0.3.1]: https://github.com/luislavena/radix/compare/v0.3.0...v0.3.1
Prepare for release: v0.3.0
2016-04-16 20:19:29 +00:00
[0.3.0]: https://github.com/luislavena/radix/compare/v0.2.1...v0.3.0
Prepare for release: v0.2.1
2016-03-15 23:52:58 +00:00
[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