rambling-trie 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c38f152f6ffdb5b7c3f5abde873ae3024651a52a7697fa4e706d01e28fe504e
-  data.tar.gz: 8cdec337b99995019a24d702b48dce2ee3e9a9e6acde298cd5cfef8086e93bc9
+  metadata.gz: 52fe8e610cf15d433a18cbb24cdd4b72c48a4ab50398868ab68cce58ea0a8de6
+  data.tar.gz: a106639989c7ad33230c252d470a9c7924fd65204ab633743bd813d4f69fa4d4
 SHA512:
-  metadata.gz: 6bbadda2f93e7efdae19f0db8749e304be56b288d62095a269904c4d6e3b6e2f7723acba618fd4e8e8de416108ca9e6249c7a6c9ce5a70e70036e6ad287cb7e2
-  data.tar.gz: b60a49628ba61bca14d5a92573df83203feb0346d306adbc628ab7dfad54da82574902ee1f4985a365582a6c5a285b788a108ee7e7d2c22b0ce3f06dc5eccf78
+  metadata.gz: 6d4659cf7e712e4fbed4e6054d6f27f7db0ecbf4dca13fcad6cab34c3050b78cb63cee7993ccda2146868b8d7203932bea08667bb510d0afdcada8cb403c3418
+  data.tar.gz: a36621b0ee84dbb8905ca8af25b8fc1b2b08a23ce171fb83c3ec632f39ffc1e7108828330eb93c4285948e5c32a1a6c6d116ad74d9da5a28aa9bd428110dafe5

data/Gemfile

@@ -18,6 +18,7 @@ group :test do
 end
 
 group :local do
+  gem 'benchmark', require: false
   gem 'benchmark-ips', require: false
   gem 'flamegraph', require: false
   gem 'flog', require: false
@@ -26,6 +27,7 @@ group :local do
   gem 'guard-rspec', require: false
   gem 'guard-rubocop', require: false
   gem 'guard-yard', require: false
+  gem 'irb', require: false
   gem 'mdl', require: false
   gem 'memory_profiler', require: false
   gem 'pry', require: false

data/README.md

@@ -9,9 +9,6 @@
 [![Documentation Status][inch_ci_badge]][rubydoc]
 [![CodeQL Status][github_action_codeql_badge]][github_action_codeql_link]
 
-[![Code Climate Grade][code_climate_grade_badge]][code_climate_link]
-[![Code Climate Issue Count][code_climate_issues_badge]][code_climate_link]
-
 The Rambling Trie is a Ruby implementation of the [trie data structure][trie_wiki], which includes compression abilities
 and is designed to be very fast to traverse.
 
@@ -21,10 +18,10 @@ and is designed to be very fast to traverse.
 
 You will need:
 
-* Ruby 3.1.0 or up
+* Ruby 3.2.0 or up
 * RubyGems
 
-See [RVM][rvm], [rbenv][rbenv] or [chruby][chruby] for more information on how to manage Ruby versions.
+See [asdf][asdf], [RVM][rvm], [rbenv][rbenv] or [chruby][chruby] for more information on how to manage Ruby versions.
 
 ### Installation
 
@@ -77,9 +74,8 @@ trie
 ```
 
 If you want to use a custom file format, you will need to provide a custom `Reader` that defines an `#each_word` method
-that yields each word contained in the file. Look at the [`PlainText` reader][rambling_trie_plain_text_reader] class for
-an example, and at the [Configuration section][rambling_trie_configuration] to see how to add your own custom file
-readers.
+that yields each word contained in the file. Look at the [`PlainText` reader](./lib/rambling/trie/readers/plain_text.rb)
+class for an example, and at the [Configuration section](#configuration) to see how to add your own custom file readers.
 
 ### Operations
 
@@ -182,7 +178,7 @@ trie.all? { |word| word.include? 'x' }
 
 ### Serialization
 
-Starting from version 1.0.0, you can store a full trie instance on disk and retrieve/use it later on. Loading a trie
+Starting from version `1.0.0`, you can store a full trie instance on disk and retrieve/use it later on. Loading a trie
 from disk takes less time, less cpu and less memory than loading every word into the trie every time. This is
 particularly useful for production applications, when you have word lists that you know are going to be static, or that
 change with little frequency.
@@ -206,22 +202,29 @@ Currently, these formats are supported to store tries on disk:
 
 * Ruby's [binary (Marshal)][marshal] format
 * [YAML][yaml]
+* Zip version of any other format ([optional `rubyzip` dependency](#optional-rubyzip-dependency))
+
+> When dumping into or loading from disk, the format is determined automatically based on the file extension, so `.yml`
+> or `.yaml` files will be handled through `YAML` and `.marshal` files through `Marshal`.
+
+##### Optional `rubyzip` dependency
 
-> When dumping into or loading from disk, the format is determined
-> automatically based on the file extension, so `.yml` or `.yaml` files will be
-> handled through `YAML` and `.marshal` files through `Marshal`.
+Compressed versions of all other [supported formats](#supported-formats) are available via the [`rubyzip`][rubyzip] gem.
+This is an optional dependency.
 
-Optionally, you can use a `.zip` version of the supported formats. In order to do so, you'll have to install
-the [`rubyzip`][rubyzip] gem:
+> ⚠️ Rambling Trie `2.6.0` and above support `rubyzip` `3.x` only.
+> For `rubyzip` `2.x` support, use Rambling Trie `2.5.1` and below.
 
 ```shell
 gem install rubyzip
+# or gem install rubyzip --version '<3` for 2.x
 ```
 
 Or, include it in your `Gemfile` and bundle it:
 
 ```ruby
 gem 'rubyzip'
+# or gem 'rubyzip', '<3' for 2.x
 ```
 
 Then, you can load contents form a `.zip` file like this:
@@ -274,12 +277,14 @@ want edge documentation, you can go the [GitHub project RubyDoc.info page][rubyd
 
 The Rambling Trie has been tested with the following Ruby versions:
 
+* 4.0.x
+* 3.4.x
 * 3.3.x
 * 3.2.x
-* 3.1.x
 
 **No longer supported**:
 
+* 3.1.x (EOL'ed)
 * 3.0.x (EOL'ed)
 * 2.7.x (EOL'ed)
 * 2.6.x (EOL'ed)
@@ -292,9 +297,14 @@ The Rambling Trie has been tested with the following Ruby versions:
 * 1.9.x (EOL'ed)
 * 1.8.x (EOL'ed)
 
+## Compatible RBS and Steep versions
+
+Type signatures for `Rambling::Trie` are included in the [`sig` directory](./sig)! The current version (`2.6.0`) was
+checked with RBS `3.10.4` and Steep `1.10.0`.
+
 ## Contributing to Rambling Trie
 
-Take a look at the [contributing guide][rambling_trie_contributing_guide] to get started, or fire a question
+Take a look at the [contributing guide](./CONTRIBUTING.md) to get started, or fire a question
 to [@gonzedge][github_user_gonzedge].
 
 ## License and copyright
@@ -316,7 +326,8 @@ WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEM
 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-[badge_fury_badge]: https://badge.fury.io/rb/rambling-trie.svg?version=2.5.1
+[asdf]: https://asdf-vm.com/
+[badge_fury_badge]: https://badge.fury.io/rb/rambling-trie.svg?version=2.6.0
 [badge_fury_link]: https://badge.fury.io/rb/rambling-trie
 [chruby]: https://github.com/postmodern/chruby
 [code_climate_grade_badge]: https://codeclimate.com/github/gonzedge/rambling-trie/badges/gpa.svg
@@ -337,9 +348,6 @@ OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 [license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
 [license_link]: https://opensource.org/licenses/mit-license.php
 [marshal]: https://ruby-doc.org/3.3.0/Marshal.html
-[rambling_trie_configuration]: https://github.com/gonzedge/rambling-trie#configuration
-[rambling_trie_contributing_guide]: https://github.com/gonzedge/rambling-trie/blob/main/CONTRIBUTING.md
-[rambling_trie_plain_text_reader]: https://github.com/gonzedge/rambling-trie/blob/main/lib/rambling/trie/readers/plain_text.rb
 [rbenv]: https://github.com/sstephenson/rbenv
 [rubydoc]: http://rubydoc.info/gems/rambling-trie
 [rubydoc_github]: http://rubydoc.info/github/gonzedge/rambling-trie

data/lib/rambling/trie/compressor.rb

@@ -26,7 +26,7 @@ module Rambling
       # @param [Nodes::Node] node the node to compress.
       # @return [Nodes::Compressed] node the compressed version of the node.
       def compress_only_child_and_merge node
-        compressed_child = compress(node.first_child) # : Nodes::Compressed
+        compressed_child = compress(node.first_child) || raise(InvalidOperation, 'got nil while compressing only child')
         merge node, compressed_child
       end
 
@@ -34,21 +34,33 @@ module Rambling
         letter = node.letter.to_s << other.letter.to_s
 
         compressed = Rambling::Trie::Nodes::Compressed.new letter.to_sym, node.parent, other.children_tree
-        compressed.terminal! if other.terminal?
+        if other.terminal?
+          compressed.terminal!
+          value = other.value
+          compressed.value = value if value
+        end
         compressed
       end
 
       def compress_children_and_copy node
         children_tree = compress_children(node.children_tree)
         compressed = Rambling::Trie::Nodes::Compressed.new node.letter, node.parent, children_tree
-        compressed.terminal! if node.terminal?
+        if node.terminal?
+          compressed.terminal!
+          value = node.value
+          compressed.value = value if value
+        end
         compressed
       end
 
       def compress_children tree
+        # @type var new_tree: Hash[Symbol, Nodes::Node]
         new_tree = {}
 
-        tree.each { |letter, child| new_tree[letter] = compress child }
+        tree.each do |letter, child|
+          compressed_child = compress(child) || raise(InvalidOperation, "got nil while compressing #{letter}")
+          new_tree[letter] = compressed_child
+        end
 
         new_tree
       end

data/lib/rambling/trie/container.rb

@@ -27,8 +27,8 @@ module Rambling
       # @raise [InvalidOperation] if the trie is already compressed.
       # @see Nodes::Raw#add
       # @see Nodes::Compressed#add
-      def add word
-        root.add reversed_char_symbols word
+      def add word, value = nil
+        root.add reversed_char_symbols(word), value
       end
 
       # Adds all provided words to the trie.
@@ -37,8 +37,12 @@ module Rambling
       # @raise [InvalidOperation] if the trie is already compressed.
       # @see Nodes::Raw#add
       # @see Nodes::Compressed#add
-      def concat words
-        words.map { |word| add word }
+      def concat words, values = nil
+        if values
+          words.each_with_index.map { |word, index| add(word, values[index]) }
+        else
+          words.map { |word| add word }
+        end
       end
 
       # Compresses the existing trie using redundant node elimination.
@@ -209,7 +213,7 @@ module Rambling
       end
 
       def compress_root
-        compressor.compress root # : Nodes::Compressed
+        compressor.compress(root) || raise
       end
 
       def reversed_char_symbols word

data/lib/rambling/trie/enumerable.rb

@@ -7,7 +7,8 @@ module Rambling
       include ::Enumerable
 
       # Empty enumerator constant for early each exits.
-      EMPTY_ENUMERATOR = [].to_enum :each
+      EMPTY_ENUMERATOR = [] # : Array[String]
+                         .to_enum :each
 
       # Returns number of words contained in the trie
       # @see https://ruby-doc.org/3.3.0/Enumerable.html#method-i-count Enumerable#count

data/lib/rambling/trie/inspectable.rb

@@ -18,15 +18,20 @@ module Rambling
       def attributes
         [
           letter_inspect,
+          value_inspect,
           terminal_inspect,
           children_inspect,
-        ].join ', '
+        ].compact.join ', '
       end
 
       def letter_inspect
         "letter: #{letter.inspect}"
       end
 
+      def value_inspect
+        value && "value: #{value.inspect}"
+      end
+
       def terminal_inspect
         "terminal: #{terminal.inspect}"
       end

data/lib/rambling/trie/nodes/compressed.rb

@@ -3,7 +3,7 @@
 module Rambling
   module Trie
     module Nodes
-      # A representation of a node in an compressed trie data structure.
+      # A representation of a node in a compressed trie data structure.
       # :reek:RepeatedConditional { max_ifs: 4 }
       class Compressed < Rambling::Trie::Nodes::Node
         # Creates a new compressed node.
@@ -22,7 +22,7 @@ module Rambling
         # @param [String] _ the word to add to the trie.
         # @raise [InvalidOperation] if the trie is already compressed.
         # @return [void]
-        def add _
+        def add _, _ = nil
           raise Rambling::Trie::InvalidOperation, 'Cannot add word to compressed trie'
         end
 

data/lib/rambling/trie/nodes/node.rb

@@ -31,6 +31,10 @@ module Rambling
         # @return [Node, nil] the parent of the current node.
         attr_accessor :parent
 
+        # Arbitrary value stored in this node
+        # @return [TValue, nil] the parent of the current node.
+        attr_accessor :value
+
         # Creates a new node.
         # @param [Symbol, nil] letter the Node's letter value.
         # @param [Node, nil] parent the parent of the current node.

data/lib/rambling/trie/nodes/raw.rb

@@ -10,12 +10,15 @@ module Rambling
         # @param [Array<Symbol>] reversed_chars the char array to add to the trie, in reverse order.
         # @return [Node] the added/modified node based on the word added.
         # @note This method clears the contents of the chars variable.
-        def add reversed_chars
+        def add reversed_chars, value = nil
           if reversed_chars.empty?
-            terminal! unless root?
+            unless root?
+              self.value = value
+              terminal!
+            end
             self
           else
-            add_to_children_tree reversed_chars
+            add_to_children_tree reversed_chars, value
           end
         end
 
@@ -27,10 +30,10 @@ module Rambling
 
         private
 
-        def add_to_children_tree chars
+        def add_to_children_tree chars, value = nil
           letter = chars.pop || raise
           child = children_tree[letter] || new_node(letter)
-          child.add chars
+          child.add chars, value
           child
         end
 

data/lib/rambling/trie/serializers/zip.rb

@@ -30,7 +30,7 @@ module Rambling
 
             entry_name = entry.name
             entry_path = path entry_name
-            entry.extract entry_path
+            entry.extract ::File.basename(entry_path), destination_directory: tmp_path
 
             serializer = serializers.resolve entry_name
             raise unless serializer
@@ -48,7 +48,7 @@ module Rambling
         def dump contents, filepath
           require 'zip'
 
-          ::Zip::File.open filepath, ::Zip::File::CREATE do |zip|
+          ::Zip::File.open filepath, create: true do |zip|
             filename = ::File.basename filepath, '.zip'
 
             entry_path = path filename

data/lib/rambling/trie/version.rb

@@ -3,6 +3,6 @@
 module Rambling
   module Trie
     # Current version of the rambling-trie.
-    VERSION = '2.5.1'
+    VERSION = '2.6.0'
   end
 end

data/lib/rambling/trie.rb

@@ -28,7 +28,7 @@ module Rambling
             (reader || raise).each_word(filepath) { |word| container << word }
           end
 
-          yield container if block_given?
+          yield container if block_given? # steep:ignore
         end
       end
 
@@ -37,7 +37,7 @@ module Rambling
       # Available formats are `yml`, `marshal`, and `zip` versions of all the
       # previous formats. You can also define your own.
       # @param [String] filepath the file to load the words from.
-      # @param [Serializer, nil] serializer the object responsible of loading the trie from disk.
+      # @param [Serializer, nil] serializer the object responsible for loading the trie from disk.
       # @return [Container] the trie just loaded.
       # @yield [Container] the trie just loaded.
       # @see Rambling::Trie::Serializers Serializers.
@@ -47,7 +47,7 @@ module Rambling
         serializer ||= serializers.resolve filepath
         root = (serializer || raise).load filepath
         Rambling::Trie::Container.new root, compressor do |container|
-          yield container if block_given?
+          yield container if block_given? # steep:ignore
         end
       end
 

data/rambling-trie.gemspec

@@ -31,5 +31,5 @@ Gem::Specification.new do |gem|
   gem.license = 'MIT'
   gem.version = Rambling::Trie::VERSION
   gem.platform = Gem::Platform::RUBY
-  gem.required_ruby_version = '>= 3.1', '< 4'
+  gem.required_ruby_version = '>= 3.2', '< 5'
 end

data/sig/lib/nilable.rbs

@@ -0,0 +1,3 @@
+interface _Nilable
+  def nil?: -> bool
+end

data/sig/lib/rambling/trie/comparable.rbs

@@ -1,7 +1,7 @@
 module Rambling
   module Trie
-    module Comparable
-      def ==: (Nodes::Node) -> bool
+    module Comparable[TValue < _Inspect]
+      def ==: (Nodes::Node[TValue]) -> bool
 
       private
 
@@ -11,7 +11,7 @@ module Rambling
 
       def terminal?: -> bool
 
-      def children_tree: -> Hash[Symbol, Nodes::Node]
+      def children_tree: -> Hash[Symbol, Nodes::Node[TValue]]
     end
   end
 end

data/sig/lib/rambling/trie/compressible.rbs

@@ -1,6 +1,6 @@
 module Rambling
   module Trie
-    module Compressible
+    module Compressible[TValue < _Inspect]
       def compressible?: -> bool
 
       private
@@ -11,7 +11,7 @@ module Rambling
 
       def terminal?: -> bool
 
-      def children_tree: -> Hash[Symbol, Nodes::Node]
+      def children_tree: -> Hash[Symbol, Nodes::Node[TValue]]
     end
   end
 end

data/sig/lib/rambling/trie/compressor.rbs

@@ -1,17 +1,17 @@
 module Rambling
   module Trie
-    class Compressor
-      def compress: (Nodes::Node?) -> Nodes::Compressed?
+    class Compressor[TValue < _Inspect]
+      def compress: (Nodes::Node[TValue]?) -> Nodes::Compressed[TValue]?
 
       private
 
-      def compress_only_child_and_merge: (Nodes::Node) -> Nodes::Compressed
+      def compress_only_child_and_merge: (Nodes::Node[TValue]) -> Nodes::Compressed[TValue]
 
-      def merge: (Nodes::Node, Nodes::Node) -> Nodes::Compressed
+      def merge: (Nodes::Node[TValue], Nodes::Node[TValue]) -> Nodes::Compressed[TValue]
 
-      def compress_children_and_copy: (Nodes::Node) -> Nodes::Compressed
+      def compress_children_and_copy: (Nodes::Node[TValue]) -> Nodes::Compressed[TValue]
 
-      def compress_children: (Hash[Symbol, Nodes::Node]) -> Hash[Symbol, Nodes::Node]
+      def compress_children: (Hash[Symbol, Nodes::Node[TValue]]) -> Hash[Symbol, Nodes::Node[TValue]]
     end
   end
 end

data/sig/lib/rambling/trie/configuration/properties.rbs

@@ -1,11 +1,11 @@
 module Rambling
   module Trie
     module Configuration
-      class Properties
+      class Properties[TValue < _Inspect]
         attr_reader readers: ProviderCollection[Readers::Reader]
-        attr_reader serializers: ProviderCollection[Serializers::Serializer[Nodes::Node]]
-        attr_accessor compressor: Compressor
-        attr_accessor root_builder: ^() -> Nodes::Node
+        attr_reader serializers: ProviderCollection[Serializers::Serializer[Nodes::Node[TValue]]]
+        attr_accessor compressor: Compressor[TValue]
+        attr_accessor root_builder: ^() -> Nodes::Node[TValue]
         attr_accessor tmp_path: String
 
         def initialize: -> void
@@ -15,7 +15,7 @@ module Rambling
         private
 
         attr_writer readers: ProviderCollection[Readers::Reader]
-        attr_writer serializers: ProviderCollection[Serializers::Serializer[Nodes::Node]]
+        attr_writer serializers: ProviderCollection[Serializers::Serializer[Nodes::Node[TValue]]]
 
         def reset_readers: -> void
 

data/sig/lib/rambling/trie/configuration/provider_collection.rbs

@@ -2,10 +2,6 @@ module Rambling
   module Trie
     module Configuration
       class ProviderCollection[TProvider < _Nilable]
-        interface _Nilable
-          def nil?: -> bool
-        end
-
         @providers: Hash[Symbol, TProvider]
 
         attr_reader name: Symbol

data/sig/lib/rambling/trie/container.rbs

@@ -1,27 +1,27 @@
 module Rambling
   module Trie
-    class Container
+    class Container[TValue < _Inspect]
       include ::Enumerable[String]
 
-      @compressor: Compressor
+      @compressor: Compressor[TValue]
 
-      attr_reader root: Nodes::Node
+      attr_reader root: Nodes::Node[TValue]
 
-      def initialize: (Nodes::Node, Compressor) ?{ (Container) -> void } -> void
+      def initialize: (Nodes::Node[TValue], Compressor[TValue]) ?{ (Container[TValue]) -> void } -> void
 
-      def add: (String) -> Nodes::Node
+      def add: (String, ?TValue?) -> Nodes::Node[TValue]
 
-      def concat: (Array[String]) -> Array[Nodes::Node]
+      def concat: (Array[String], ?Array[TValue?]?) -> Array[Nodes::Node[TValue]]
 
-      def compress!: -> Container
+      def compress!: -> Container[TValue]
 
-      def compress: -> Container
+      def compress: -> Container[TValue]
 
-      def each: { (String) -> void } -> (Enumerator[String, void] | Enumerable)
+      def each: { (String) -> void } -> (Enumerator[String, void] | Enumerable[TValue])
 
       def partial_word?: (String) -> bool
 
-      def push: (*String) -> Array[Nodes::Node]
+      def push: (*String) -> Array[Nodes::Node[TValue]]
 
       def word?: (String) -> bool
 
@@ -31,13 +31,13 @@ module Rambling
 
       def words_within?: (String) -> bool
 
-      def ==: (Container) -> bool
+      def ==: (Container[TValue]) -> bool
 
-      def []: (Symbol) -> Nodes::Node
+      def []: (Symbol) -> Nodes::Node[TValue]?
 
-      def children: -> Array[Nodes::Node]
+      def children: -> Array[Nodes::Node[TValue]]
 
-      def children_tree: -> Hash[Symbol, Nodes::Node]
+      def children_tree: -> Hash[Symbol, Nodes::Node[TValue]]
 
       def compressed?: -> bool
 
@@ -56,12 +56,12 @@ module Rambling
 
       private
 
-      attr_reader compressor: Compressor
-      attr_writer root: Nodes::Node
+      attr_reader compressor: Compressor[TValue]
+      attr_writer root: Nodes::Node[TValue]
 
       def words_within_root: (String) ?{ (String) -> void } -> Enumerator[String, void]
 
-      def compress_root: -> Nodes::Compressed
+      def compress_root: -> Nodes::Compressed[TValue]
 
       def reversed_char_symbols: (String) -> Array[Symbol]
     end

data/sig/lib/rambling/trie/enumerable.rbs

@@ -1,13 +1,13 @@
 module Rambling
   module Trie
-    module Enumerable
+    module Enumerable[TValue < _Inspect]
       include ::Enumerable[String]
 
       EMPTY_ENUMERATOR: Enumerator[String, void]
 
       alias size count
 
-      def each: { (String) -> void } -> (Enumerator[String, void] | Enumerable)
+      def each: { (String) -> void } -> (Enumerator[String, void] | Enumerable[TValue])
 
       private
 
@@ -17,7 +17,7 @@ module Rambling
 
       def terminal?: -> bool
 
-      def children_tree: -> Hash[Symbol, Nodes::Node]
+      def children_tree: -> Hash[Symbol, Nodes::Node[TValue]]
     end
   end
 end

data/sig/lib/rambling/trie/inspectable.rbs

@@ -1,6 +1,7 @@
 module Rambling
   module Trie
-    module Inspectable
+    module Inspectable[TValue < _Inspect]
+
       def inspect: -> String
 
       private
@@ -11,6 +12,8 @@ module Rambling
 
       def letter_inspect: -> String
 
+      def value_inspect: -> String?
+
       def terminal_inspect: -> String
 
       def children_inspect: -> String
@@ -19,9 +22,11 @@ module Rambling
 
       def letter: -> Symbol
 
+      def value: -> TValue
+
       def terminal: -> bool?
 
-      def children_tree: -> Hash[Symbol, Nodes::Node]
+      def children_tree: -> Hash[Symbol, Nodes::Node[TValue]]
     end
   end
 end

data/sig/lib/rambling/trie/nodes/compressed.rbs

@@ -1,10 +1,10 @@
 module Rambling
   module Trie
     module Nodes
-      class Compressed < Node
-        def initialize: (?Symbol?, ?Node?, ?Hash[Symbol, Node]) -> void
+      class Compressed[TValue < _Inspect] < Node[TValue]
+        def initialize: (?Symbol?, ?Node[TValue]?, ?Hash[Symbol, Node[TValue]]) -> void
 
-        def add: (Array[Symbol]) -> Node
+        def add: (Array[Symbol], ?TValue) -> Node[TValue]
 
         def compressed?: -> bool
 
@@ -18,7 +18,7 @@ module Rambling
 
         def word_chars?: (Array[String]) -> bool
 
-        def closest_node: (Array[String]) -> Node
+        def closest_node: (Array[String]) -> Node[TValue]
       end
     end
   end

data/sig/lib/rambling/trie/nodes/missing.rbs

@@ -1,9 +1,9 @@
 module Rambling
   module Trie
     module Nodes
-      class Missing < Node
+      class Missing[TValue < _Inspect] < Node[TValue]
         def initialize: -> void
       end
     end
   end
-end
+end

data/sig/lib/rambling/trie/nodes/node.rbs

@@ -1,34 +1,35 @@
 module Rambling
   module Trie
     module Nodes
-      class Node
-        include Compressible
-        include Enumerable
-        include Comparable
-        include Stringifyable
-        include Inspectable
+      class Node[TValue < _Inspect]
+        include Compressible[TValue]
+        include Enumerable[TValue]
+        include Comparable[TValue]
+        include Stringifyable[TValue]
+        include Inspectable[TValue]
 
         attr_reader letter: Symbol?
-        attr_accessor children_tree: Hash[Symbol, Node]
-        attr_accessor parent: Node?
+        attr_accessor children_tree: Hash[Symbol, Node[TValue]]
+        attr_accessor parent: Node[TValue]?
+        attr_accessor value: TValue?
 
-        def initialize: (?Symbol?, ?Node?, ?Hash[Symbol, Node]) -> void
+        def initialize: (?Symbol?, ?Node[TValue]?, ?Hash[Symbol, Node[TValue]]) -> void
 
-        def add: (Array[Symbol]) -> Node
+        def add: (Array[Symbol], ?TValue?) -> Node[TValue]
 
-        def children: -> Array[Node]
+        def children: -> Array[Node[TValue]]
 
-        def first_child: -> Node?
+        def first_child: -> Node[TValue]?
 
         def match_prefix: (Array[String]) { (String) -> void } -> Enumerator[String, void]
 
         def root?: -> bool
 
-        def scan: (Array[String]) -> Node
+        def scan: (Array[String]) -> Node[TValue]
 
         def terminal?: -> bool
 
-        def terminal!: -> Node
+        def terminal!: -> Node[TValue]
 
         def letter=: (String | Symbol?) -> Symbol?
 
@@ -38,13 +39,13 @@ module Rambling
 
         def word?: (Array[String]) -> bool
 
-        def []: (Symbol) -> Node
+        def []: (Symbol) -> Node[TValue]?
 
-        def []=: (Symbol, Node) -> Node
+        def []=: (Symbol, Node[TValue]) -> Node[TValue]
 
         def key?: (Symbol) -> bool
 
-        def delete: (Symbol) -> Node?
+        def delete: (Symbol) -> Node[TValue]?
 
         alias has_key? key?
 
@@ -52,7 +53,7 @@ module Rambling
 
         attr_accessor terminal: bool?
 
-        def missing: -> Node
+        def missing: -> Node[TValue]
 
         # abstract methods
 
@@ -62,7 +63,7 @@ module Rambling
 
         def word_chars?: (Array[String]) -> bool
 
-        def closest_node: (Array[String]) -> Node
+        def closest_node: (Array[String]) -> Node[TValue]
       end
     end
   end

data/sig/lib/rambling/trie/nodes/raw.rbs

@@ -1,16 +1,16 @@
 module Rambling
   module Trie
     module Nodes
-      class Raw < Node
-        def add: (Array[Symbol]) -> Node
+      class Raw[TValue < _Inspect] < Node[TValue]
+        def add: (Array[Symbol], ?TValue?) -> Node[TValue]
 
         def compressed?: -> bool
 
         private
 
-        def add_to_children_tree: (Array[Symbol]) -> Node
+        def add_to_children_tree: (Array[Symbol], ?TValue?) -> Node[TValue]
 
-        def new_node: (Symbol) -> Node
+        def new_node: (Symbol) -> Node[TValue]
 
         # overrides
 
@@ -20,7 +20,7 @@ module Rambling
 
         def word_chars?: (Array[String]) -> bool
 
-        def closest_node: (Array[String]) -> Node
+        def closest_node: (Array[String]) -> Node[TValue]
       end
     end
   end

data/sig/lib/rambling/trie/readers/plain_text.rbs

@@ -6,4 +6,4 @@ module Rambling
       end
     end
   end
-end
+end

data/sig/lib/rambling/trie/serializers/marshal.rbs

@@ -1,7 +1,7 @@
 module Rambling
   module Trie
     module Serializers
-      class Marshal < Serializer[Nodes::Node]
+      class Marshal[TValue < _Inspect] < Serializer[Nodes::Node[TValue]]
         @serializer: Serializer[String]
 
         private

data/sig/lib/rambling/trie/serializers/yaml.rbs

@@ -1,7 +1,7 @@
 module Rambling
   module Trie
     module Serializers
-      class Yaml < Serializer[Nodes::Node]
+      class Yaml[TValue < _Inspect] < Serializer[Nodes::Node[TValue]]
         @serializer: Serializer[String]
 
         private

data/sig/lib/rambling/trie/serializers/zip.rbs

@@ -1,16 +1,16 @@
 module Rambling
   module Trie
     module Serializers
-      class Zip < Serializer[Nodes::Node]
-        @properties: Configuration::Properties
+      class Zip[TValue < _Inspect] < Serializer[Nodes::Node[TValue]]
+        @properties: Configuration::Properties[TValue]
 
-        def initialize: (Configuration::Properties) -> void
+        def initialize: (Configuration::Properties[TValue]) -> void
 
         private
 
-        attr_reader properties: Configuration::Properties
+        attr_reader properties: Configuration::Properties[TValue]
 
-        def serializers: -> Configuration::ProviderCollection[Serializer[Nodes::Node]]
+        def serializers: -> Configuration::ProviderCollection[Serializer[Nodes::Node[TValue]]]
 
         def tmp_path: -> String
 

data/sig/lib/rambling/trie/stringifyable.rbs

@@ -1,6 +1,6 @@
 module Rambling
   module Trie
-    module Stringifyable
+    module Stringifyable[TValue < _Inspect]
       def as_word: -> String
 
       def to_s: -> String
@@ -13,9 +13,9 @@ module Rambling
 
       def terminal?: -> bool
 
-      def parent: -> Nodes::Node?
+      def parent: -> Nodes::Node[TValue]?
 
-      def children_tree: -> Hash[Symbol, Nodes::Node]
+      def children_tree: -> Hash[Symbol, Nodes::Node[TValue]]
     end
   end
 end

data/sig/lib/rambling/trie.rbs

@@ -2,26 +2,24 @@ module Rambling
   module Trie
     VERSION: String
 
-    @properties: Configuration::Properties
+    def self.create: [TValue < _Inspect] (?String?, ?Readers::Reader?) ?{ (Container[TValue]) -> void } -> Container[TValue]
 
-    def self.create: (?String?, ?Readers::Reader?) ?{ (Container) -> void } -> Container
+    def self.load: [TValue < _Inspect] (String, ?Serializers::Serializer[Nodes::Node[TValue]]?) ?{ (Container[TValue]) -> void } -> Container[TValue]
 
-    def self.load: (String, ?Serializers::Serializer[Nodes::Node]?) ?{ (Container) -> void } -> Container
+    def self.dump: [TValue < _Inspect] (Container[TValue], String, ?Serializers::Serializer[Nodes::Node[TValue]]?) -> void
 
-    def self.dump: (Container, String, ?Serializers::Serializer[Nodes::Node]?) -> void
-
-    def self.config: ?{ (Configuration::Properties) -> void } -> Configuration::Properties
+    def self.config: [TValue < _Inspect] ?{ (Configuration::Properties[TValue]) -> void } -> Configuration::Properties[TValue]
 
     private
 
-    def self.properties: -> Configuration::Properties
+    def self.properties: [TValue < _Inspect] -> Configuration::Properties[TValue]
 
     def self.readers: -> Configuration::ProviderCollection[Readers::Reader]
 
-    def self.serializers: -> Configuration::ProviderCollection[Serializers::Serializer[Nodes::Node]]
+    def self.serializers: [TValue < _Inspect] -> Configuration::ProviderCollection[Serializers::Serializer[Nodes::Node[TValue]]]
 
-    def self.compressor: -> Compressor
+    def self.compressor: [TValue < _Inspect] -> Compressor[TValue]
 
-    def self.root_builder: -> ^() -> Nodes::Node
+    def self.root_builder: [TValue < _Inspect] -> ^() -> Nodes::Node[TValue]
   end
 end

data/sig/lib/zip/entry.rbs

@@ -4,8 +4,8 @@ module Zip
 
     def name: -> String
 
-    def extract: (String) -> void
+    def extract: (String, ?destination_directory: String?) -> void
 
     def each: ?{ (Entry) -> void } -> (Enumerator[Entry, void])
   end
-end
+end

data/sig/lib/zip/file.rbs

@@ -1,11 +1,9 @@
 module Zip
   class File
-    CREATE: bool
-
-    def self.open: [TContent] (String, ?bool?) { (File) -> TContent } -> TContent
+    def self.open: [TContent] (String, ?create: bool?) { (File) -> TContent } -> TContent
 
     def entries: -> Array[Entry]
 
     def add: (String, String) -> void
   end
-end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rambling-trie
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Edgar Gonzalez
 - Lilibeth De La Cruz
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: 'The Rambling Trie is a Ruby implementation of the trie data structure,
   which includes compression abilities and is designed to be very fast to traverse. '
@@ -56,6 +55,7 @@ files:
 - lib/rambling/trie/stringifyable.rb
 - lib/rambling/trie/version.rb
 - rambling-trie.gemspec
+- sig/lib/nilable.rbs
 - sig/lib/rambling/trie.rbs
 - sig/lib/rambling/trie/comparable.rbs
 - sig/lib/rambling/trie/compressible.rbs
@@ -87,7 +87,6 @@ metadata:
   changelog_uri: https://github.com/gonzedge/rambling-trie/blob/main/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/rambling-trie
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,18 +94,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '4'
+      version: '5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A Ruby implementation of the trie data structure.
 test_files: []