-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Includes changes for: - v1.0.0 - v0.9.3 - v0.9.2 - v0.9.1 - v0.9.0 [#13]
- Loading branch information
Showing
1 changed file
with
297 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,297 @@ | ||
| # Changelog | ||
|
|
||
| ## 1.0.0 (unreleased) [compare][compare-v0.9.3-and-master] | ||
|
|
||
| ### Breaking Changes | ||
|
|
||
| - Rename `PlainTextReader` to `Readers::PlainText` by [@gonzedge][github-user-gonzedge] | ||
| - Rename `Compression` to `Compressable` by [@gonzedge][github-user-gonzedge] | ||
| - Rename `Inspect` to `Inspectable` by [@gonzedge][github-user-gonzedge] | ||
|
|
||
| ### Enhancements | ||
|
|
||
| #### Major | ||
|
|
||
| - Add `Serializers` to dump trie into/load trie from disk | ||
| [#10][github-issue-10] by [@gonzedge][github-user-gonzedge] | ||
|
|
||
| ``` ruby | ||
| # Save `your_trie` into a file | ||
| Rambling::Trie.dump your_trie, 'a filename' | ||
|
|
||
| # Load a trie from a file into memory | ||
| trie = Rambling::Trie.load 'a filename' | ||
| ``` | ||
|
|
||
| - Add ability to configure `rambling-trie` [#11][github-issue-11] | ||
| by [@gonzedge][github-user-gonzedge] | ||
|
|
||
| ``` ruby | ||
| Rambling::Trie.config do |config| | ||
| config.compressor = MyCompressor.new | ||
| config.root_builder = lambda { MyNode.new } | ||
| config.readers.add :html, MyHtmlReader.new | ||
| config.readers.default = config.readers[:html] | ||
| config.serializers.add :json, MyJsonSerializer.new | ||
| config.serializers.default = config.serializers[:yml] | ||
| end | ||
| ``` | ||
|
|
||
| - Add `#==` to compare nodes by [@gonzedge][github-user-gonzedge] | ||
|
|
||
| Contained in `Rambling::Trie::Comparable` module. Two nodes are equal to | ||
| each other if they have the same letter, they are both either terminal or | ||
| non-terminal and their children tree is the same | ||
|
|
||
| #### Minor | ||
|
|
||
| - Extract modules for peripheral node functionality by [@gonzedge][github-user-gonzedge] | ||
| - Move `#to_s` to `Stringifyable` module | ||
| - Move `#as_word` to `Stringifyable` module by | ||
| - Move `#==` to `Comparable` module | ||
| - Rename `Compression` to `Compressable` | ||
| - Rename `Inspector` to `Inspectable` | ||
| - Add `#terminal?` value to inspect output by [@gonzedge][github-user-gonzedge] | ||
| - Freeze `Rambling::Trie::VERSION` by [@gonzedge][github-user-gonzedge] | ||
| - Refactor performance instrumentation tasks by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Add `Performance` module | ||
| - Add `Performance::Reporter` & `Performance::Directory` classes | ||
| - Move task execution into individual classes | ||
| - Unify all tasks into single entry point `rake performance[type,method]` | ||
| - Change benchmark report format by [@gonzedge][github-user-gonzedge] | ||
| - Correct supported versions by [@gonzedge][github-user-gonzedge] | ||
| - Only create new `Reader` instance when filepath is given on initialization by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Update license year by [@gonzedge][github-user-gonzedge] | ||
|
|
||
| ## 0.9.3 [compare][compare-v0.9.2-and-v0.9.3] | ||
|
|
||
| ### Enhancements | ||
|
|
||
| #### Major | ||
|
|
||
| - Add Ruby 2.4 to supported versions by [@gonzedge][github-user-gonzedge] | ||
| - Drastically reduce size of gem by [@gonzedge][github-user-gonzedge] | ||
|
|
||
| By excluding unnecessary `assets/` and `reports/` when building the gem. | ||
| **Size reduction**: from ~472KB to ~21KB. | ||
|
|
||
| - Make root node accessible via container by [@gonzedge][github-user-gonzedge] | ||
|
|
||
| So that anyone using rambling-trie can develop their custom algorithms | ||
|
|
||
| - Expose root node's `#to_a` method through `Container` by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Add own `Forwardable#delegate` because of [Ruby 2.4 performance | ||
| degradation][ruby-bug-13111] by [@gonzedge][github-user-gonzedge] | ||
| Was able to take Creation and Compression benchmarks (~8.8s and ~1.5s | ||
| respectively) back down to the Ruby 2.3.3 levels by adding own definition of | ||
| `Forwardable#delegate`. | ||
| #### Minor | ||
| - Ensure unicode words are supported by [@gonzedge][github-user-gonzedge] | ||
| - Add flamegraph reports to performance instrumentation tasks by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Move benchmark/profiling dependencies from gemspec to Gemfile by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Add missing docs by [@gonzedge][github-user-gonzedge] | ||
| - Improvements on TravisCI setup by [@gonzedge][github-user-gonzedge] | ||
| - Add codeclimate test coverage integration by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Move rspec config from .rspec to spec_helper by | ||
| [@gonzedge][github-user-gonzedge] | ||
| ## 0.9.2 [compare][compare-v0.9.1-and-v0.9.2] | ||
| ### Enhancements | ||
| #### Major | ||
| - Fix "undefined method `to_sym`" on compressed trie's `#partial_word?` and | ||
| `#scan` by [@gonzedge][github-user-gonzedge] | ||
| - Expose all usable `Node` methods in `Container` through delegation by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Expose `#as_word` | ||
| - Expose `#children` | ||
| - Expose `#children_tree` | ||
| - Expose `#has_key?` | ||
| - Expose `#parent` | ||
| - Expose `#size` | ||
| - Expose `#to_s` | ||
|
|
||
| #### Minor | ||
|
|
||
| - Unify `#scan` implementation between `Raw` and `Compressed` node by | ||
| [@gonzedge][github-user-gonzedge] | ||
|
|
||
| ## 0.9.1 [compare][compare-v0.9.0-and-v0.9.1] | ||
|
|
||
| ### Enhancements | ||
|
|
||
| #### Major | ||
|
|
||
| - Performance improvements for all trie operations by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Reduce memory footprint without affecting performance for compressed node | ||
| operations by [@gonzedge][github-user-gonzedge] | ||
|
|
||
| Including `#word?`, `#partial_word?` and `#closest_node`. See these commits | ||
| for more info: | ||
|
|
||
| - [aa8c0262f888e88df6a2f1e1351d8f14b21e43c4][github-commit-reduced-memory-footprint] | ||
| - [218fac218a77e70ba04a3672ff5abfddf6544f57][github-commit-current-key-less-memory] | ||
|
|
||
| #### Minor | ||
|
|
||
| - Make trie integration test a bit faster by [@gonzedge][github-user-gonzedge] | ||
| - Remove unnecessary `#to_a` calls from `Container` by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Extract `#recursive_get` to unify `#partial_word?` and `#scan` | ||
| implementations by [@gonzedge][github-user-gonzedge] | ||
| - Better `#word?` implementation for compressed node by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Rename `new_letter` => `letter` by [@gonzedge][github-user-gonzedge] | ||
| - Further performance instrumentation improvements by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Split out benchmark reports per version by [@gonzedge][github-user-gonzedge] | ||
|
|
||
| ## 0.9.0 [compare][compare-v0.8.1-and-v0.9.0] | ||
|
|
||
| ### Breaking Changes | ||
|
|
||
| - `Rambling::Trie.create` now returns a `Container` instead of a `Root` by | ||
| [@gonzedge][github-user-gonzedge] | ||
|
|
||
| `Container` exposes these API entry points: | ||
|
|
||
| - `#partial_word?` and its alias `#match?` | ||
| - `#word?` and its alias `#include?` | ||
| - `#add` and its alias `#<<` | ||
| - yield the constructed `Container` on `#initialize` | ||
|
|
||
| `Rambling::Trie::Node` and its subclasses no longer expose: | ||
|
|
||
| - `#match?` | ||
| - `#include?` | ||
| - `#<<` | ||
| - yield on `#initialize` | ||
|
|
||
| - Remove `Branches` module, all of its behavior is now contained in `RawNode` | ||
| and `CompressedNode` by [@gonzedge][github-user-gonzedge] | ||
| - Rename `Compressor` module to `Compression` (`Compressor` is now the class | ||
| that transforms between a `RawNode` and a `CompressedNode`) by | ||
| [@gonzedge][github-user-gonzedge] | ||
|
|
||
| ### Enhancements | ||
|
|
||
| #### Major | ||
|
|
||
| - Separate uncompressed trie vs compressed trie logic into separate objects by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Create separate `RawNode` and `CompressedNode` classes | ||
| - Add `Compressor` for `#compress!` implementation that maps from a | ||
| `RawNode` to a `CompressedNode` | ||
| - | ||
| - Add `#terminal!` to `Node` to force node to be terminal by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Move `#root?` into `Node` by [@gonzedge][github-user-gonzedge] | ||
| - Improve memory footprint of compressed trie (`CompressedNode`) by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Small memory improvements to `RawNode` by [@gonzedge][github-user-gonzedge] | ||
| - Improve `Rambling::Trie::Enumerable` performance, hence `#scan` performance | ||
| by [@gonzedge][github-user-gonzedge] | ||
| - Improve performance for `#scan` by [@gonzedge][github-user-gonzedge] | ||
| - Additional performance improvements for raw and compressed nodes operations | ||
| by [@gonzedge][github-user-gonzedge] | ||
| - Improve trie creation performance by [@gonzedge][github-user-gonzedge] | ||
| - Improve performance of trie initialization from file by | ||
| [@gonzedge][github-user-gonzedge] | ||
|
|
||
| #### Minor | ||
|
|
||
| - Delegate `#inspect` to `#root` node by [@gonzedge][github-user-gonzedge] | ||
| - Rename `first_letter` to `letter` in `RawNode` by | ||
| [@gonzedge][github-user-gonzedge] | ||
| - Expand performance instrumentation by [@gonzedge][github-user-gonzedge] | ||
|
|
||
| Include memory profiles, call tree profiles and benchmark measurements for | ||
| `#scan` method | ||
|
|
||
| ## 0.8.1 [compare][compare-v0.8.0-and-v0.8.1] | ||
|
|
||
| ## 0.8.0 [compare][compare-v0.7.0-and-v0.8.0] | ||
|
|
||
| ## 0.7.0 [compare][compare-v0.6.1-and-v0.7.0] | ||
|
|
||
| ## 0.6.1 [compare][compare-v0.6.0-and-v0.6.1] | ||
|
|
||
| ## 0.6.0 [compare][compare-v0.5.2-and-v0.6.0] | ||
|
|
||
| ## 0.5.2 [compare][compare-v0.5.1-and-v0.5.2] | ||
|
|
||
| ## 0.5.1 [compare][compare-v0.5.0-and-v0.5.1] | ||
|
|
||
| ## 0.5.0 [compare][compare-v0.4.2-and-v0.5.0] | ||
|
|
||
| ## 0.4.2 [compare][compare-v0.4.1-and-v0.4.2] | ||
|
|
||
| ## 0.4.1 [compare][compare-v0.4.0-and-v0.4.1] | ||
|
|
||
| ## 0.4.0 [compare][compare-v0.3.4-and-v0.4.0] | ||
|
|
||
| ## 0.3.4 [compare][compare-v0.3.3-and-v0.3.4] | ||
|
|
||
| ## 0.3.3 [compare][compare-v0.3.2-and-v0.3.3] | ||
|
|
||
| ## 0.3.2 [compare][compare-v0.3.1-and-v0.3.2] | ||
|
|
||
| ## 0.3.1 [compare][compare-v0.3.0-and-v0.3.1] | ||
|
|
||
| ## 0.3.0 [compare][compare-v0.2.0-and-v0.3.0] | ||
|
|
||
| ## 0.2.0 [compare][compare-v0.1.0-and-v0.2.0] | ||
|
|
||
| ## 0.1.0 [compare][compare-v0.0.2-and-v0.1.0] | ||
|
|
||
| ## 0.0.2 [compare][compare-v0.0.1-and-v0.0.2] | ||
|
|
||
| ## 0.0.1 [compare][compare-v0.0.0-and-v0.0.1] | ||
|
|
||
| [compare-v0.0.0-and-v0.0.1]: https://github.com/gonzedge/rambling-trie/compare/v0.0.0...v0.0.1 | ||
| [compare-v0.0.1-and-v0.0.2]: https://github.com/gonzedge/rambling-trie/compare/v0.0.1...v0.0.2 | ||
| [compare-v0.0.2-and-v0.1.0]: https://github.com/gonzedge/rambling-trie/compare/v0.0.2...v0.1.0 | ||
| [compare-v0.1.0-and-v0.2.0]: https://github.com/gonzedge/rambling-trie/compare/v0.1.0...v0.2.0 | ||
| [compare-v0.2.0-and-v0.3.0]: https://github.com/gonzedge/rambling-trie/compare/v0.2.0...v0.3.0 | ||
| [compare-v0.3.0-and-v0.3.1]: https://github.com/gonzedge/rambling-trie/compare/v0.3.0...v0.3.1 | ||
| [compare-v0.3.1-and-v0.3.2]: https://github.com/gonzedge/rambling-trie/compare/v0.3.1...v0.3.2 | ||
| [compare-v0.3.2-and-v0.3.3]: https://github.com/gonzedge/rambling-trie/compare/v0.3.2...v0.3.3 | ||
| [compare-v0.3.3-and-v0.3.4]: https://github.com/gonzedge/rambling-trie/compare/v0.3.3...v0.3.4 | ||
| [compare-v0.3.4-and-v0.4.0]: https://github.com/gonzedge/rambling-trie/compare/v0.3.4...v0.4.0 | ||
| [compare-v0.4.0-and-v0.4.1]: https://github.com/gonzedge/rambling-trie/compare/v0.4.0...v0.4.1 | ||
| [compare-v0.4.1-and-v0.4.2]: https://github.com/gonzedge/rambling-trie/compare/v0.4.1...v0.4.2 | ||
| [compare-v0.4.2-and-v0.5.0]: https://github.com/gonzedge/rambling-trie/compare/v0.4.2...v0.5.0 | ||
| [compare-v0.5.0-and-v0.5.1]: https://github.com/gonzedge/rambling-trie/compare/v0.5.0...v0.5.1 | ||
| [compare-v0.5.1-and-v0.5.2]: https://github.com/gonzedge/rambling-trie/compare/v0.5.1...v0.5.2 | ||
| [compare-v0.5.2-and-v0.6.0]: https://github.com/gonzedge/rambling-trie/compare/v0.5.2...v0.6.0 | ||
| [compare-v0.6.0-and-v0.6.1]: https://github.com/gonzedge/rambling-trie/compare/v0.6.0...v0.6.1 | ||
| [compare-v0.6.1-and-v0.7.0]: https://github.com/gonzedge/rambling-trie/compare/v0.6.1...v0.7.0 | ||
| [compare-v0.7.0-and-v0.7.0]: https://github.com/gonzedge/rambling-trie/compare/v0.7.0...v0.7.0 | ||
| [compare-v0.7.0-and-v0.8.0]: https://github.com/gonzedge/rambling-trie/compare/v0.7.0...v0.8.0 | ||
| [compare-v0.8.0-and-v0.8.1]: https://github.com/gonzedge/rambling-trie/compare/v0.8.0...v0.8.1 | ||
| [compare-v0.8.1-and-v0.9.0]: https://github.com/gonzedge/rambling-trie/compare/v0.8.1...v0.9.0 | ||
| [compare-v0.9.0-and-v0.9.1]: https://github.com/gonzedge/rambling-trie/compare/v0.9.0...v0.9.1 | ||
| [compare-v0.9.1-and-v0.9.2]: https://github.com/gonzedge/rambling-trie/compare/v0.9.1...v0.9.2 | ||
| [compare-v0.9.2-and-v0.9.3]: https://github.com/gonzedge/rambling-trie/compare/v0.9.2...v0.9.3 | ||
| [compare-v0.9.3-and-master]: https://github.com/gonzedge/rambling-trie/compare/v0.9.3...master | ||
| [github-commit-current-key-less-memory]: https://github.com/gonzedge/rambling-trie/commit/218fac218a77e70ba04a3672ff5abfddf6544f57 | ||
| [github-commit-reduced-memory-footprint]: https://github.com/gonzedge/rambling-trie/commit/aa8c0262f888e88df6a2f1e1351d8f14b21e43c4 | ||
| [github-issue-10]: https://github.com/gonzedge/rambling-trie/issues/10 | ||
| [github-issue-11]: https://github.com/gonzedge/rambling-trie/issues/11 | ||
| [github-user-gonzedge]: https://github.com/gonzedge | ||
| [github-user-lilibethdlc]: https://github.com/lilibethdlc | ||
| [ruby-bug-13111]: https://bugs.ruby-lang.org/issues/13111 |