rambling-trie 2.5.0 → 2.5.1

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

@@ -0,0 +1,47 @@
+module Rambling
+  module Trie
+    module Configuration
+      class ProviderCollection[TProvider < _Nilable]
+        interface _Nilable
+          def nil?: -> bool
+        end
+
+        @providers: Hash[Symbol, TProvider]
+
+        attr_reader name: Symbol
+        attr_reader default: TProvider?
+
+        def initialize: (Symbol, Hash[Symbol, TProvider], ?TProvider?) -> void
+
+        def []: (Symbol) -> TProvider
+
+        def add: (Symbol, TProvider) -> TProvider
+
+        def default=: (TProvider?) -> TProvider?
+
+        def formats: -> Array[Symbol]
+
+        def providers: -> Hash[Symbol, TProvider]
+
+        def reset: -> void
+
+        def resolve: (String) -> TProvider?
+
+        private
+
+        attr_reader configured_default: TProvider?
+        attr_reader configured_providers: Hash[Symbol, TProvider]
+
+        def []=: (Symbol, TProvider) -> TProvider
+
+        def values: -> Array[TProvider]
+
+        def file_format: (String) -> Symbol
+
+        def contains?: (TProvider?) -> bool
+
+        alias provider_instances values
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module Rambling
+  module Trie
+    class Container
+      include ::Enumerable[String]
+
+      @compressor: Compressor
+
+      attr_reader root: Nodes::Node
+
+      def initialize: (Nodes::Node, Compressor) ?{ (Container) -> void } -> void
+
+      def add: (String) -> Nodes::Node
+
+      def concat: (Array[String]) -> Array[Nodes::Node]
+
+      def compress!: -> Container
+
+      def compress: -> Container
+
+      def each: { (String) -> void } -> (Enumerator[String, void] | Enumerable)
+
+      def partial_word?: (String) -> bool
+
+      def push: (*String) -> Array[Nodes::Node]
+
+      def word?: (String) -> bool
+
+      def scan: (String) -> Array[String]
+
+      def words_within: (String) -> Array[String]
+
+      def words_within?: (String) -> bool
+
+      def ==: (Container) -> bool
+
+      def []: (Symbol) -> Nodes::Node
+
+      def children: -> Array[Nodes::Node]
+
+      def children_tree: -> Hash[Symbol, Nodes::Node]
+
+      def compressed?: -> bool
+
+      def to_a: -> Array[String]
+
+      def key?: (Symbol) -> bool
+
+      def size: -> Numeric
+
+      alias include? word?
+      alias match? partial_word?
+      alias words? scan
+      alias << add
+      alias has_key? key?
+      alias has_letter? key?
+
+      private
+
+      attr_reader compressor: Compressor
+      attr_writer root: Nodes::Node
+
+      def words_within_root: (String) ?{ (String) -> void } -> Enumerator[String, void]
+
+      def compress_root: -> Nodes::Compressed
+
+      def reversed_char_symbols: (String) -> Array[Symbol]
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Rambling
+  module Trie
+    module Enumerable
+      include ::Enumerable[String]
+
+      EMPTY_ENUMERATOR: Enumerator[String, void]
+
+      alias size count
+
+      def each: { (String) -> void } -> (Enumerator[String, void] | Enumerable)
+
+      private
+
+      # abstract methods
+
+      def as_word: -> String
+
+      def terminal?: -> bool
+
+      def children_tree: -> Hash[Symbol, Nodes::Node]
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Rambling
+  module Trie
+    module Inspectable
+      def inspect: -> String
+
+      private
+
+      def class_name: -> String?
+
+      def attributes: -> String
+
+      def letter_inspect: -> String
+
+      def terminal_inspect: -> String
+
+      def children_inspect: -> String
+
+      # abstract methods
+
+      def letter: -> Symbol
+
+      def terminal: -> bool?
+
+      def children_tree: -> Hash[Symbol, Nodes::Node]
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Rambling
+  module Trie
+    class InvalidOperation < RuntimeError
+      def initialize: (String? message) -> void
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Rambling
+  module Trie
+    module Nodes
+      class Compressed < Node
+        def initialize: (?Symbol?, ?Node?, ?Hash[Symbol, Node]) -> void
+
+        def add: (Array[Symbol]) -> Node
+
+        def compressed?: -> bool
+
+        private
+
+        # overrides
+
+        def children_match_prefix: (Array[String]) { (String) -> void } -> Enumerator[String, void]
+
+        def partial_word_chars?: (Array[String]) -> bool
+
+        def word_chars?: (Array[String]) -> bool
+
+        def closest_node: (Array[String]) -> Node
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,69 @@
+module Rambling
+  module Trie
+    module Nodes
+      class Node
+        include Compressible
+        include Enumerable
+        include Comparable
+        include Stringifyable
+        include Inspectable
+
+        attr_reader letter: Symbol?
+        attr_accessor children_tree: Hash[Symbol, Node]
+        attr_accessor parent: Node?
+
+        def initialize: (?Symbol?, ?Node?, ?Hash[Symbol, Node]) -> void
+
+        def add: (Array[Symbol]) -> Node
+
+        def children: -> Array[Node]
+
+        def first_child: -> Node?
+
+        def match_prefix: (Array[String]) { (String) -> void } -> Enumerator[String, void]
+
+        def root?: -> bool
+
+        def scan: (Array[String]) -> Node
+
+        def terminal?: -> bool
+
+        def terminal!: -> Node
+
+        def letter=: (String | Symbol?) -> Symbol?
+
+        def compressed?: -> bool
+
+        def partial_word?: (Array[String]) -> bool
+
+        def word?: (Array[String]) -> bool
+
+        def []: (Symbol) -> Node
+
+        def []=: (Symbol, Node) -> Node
+
+        def key?: (Symbol) -> bool
+
+        def delete: (Symbol) -> Node?
+
+        alias has_key? key?
+
+        private
+
+        attr_accessor terminal: bool?
+
+        def missing: -> Node
+
+        # abstract methods
+
+        def children_match_prefix: (Array[String]) { (String) -> void } -> Enumerator[String, void]
+
+        def partial_word_chars?: (Array[String]) -> bool
+
+        def word_chars?: (Array[String]) -> bool
+
+        def closest_node: (Array[String]) -> Node
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Rambling
+  module Trie
+    module Nodes
+      class Raw < Node
+        def add: (Array[Symbol]) -> Node
+
+        def compressed?: -> bool
+
+        private
+
+        def add_to_children_tree: (Array[Symbol]) -> Node
+
+        def new_node: (Symbol) -> Node
+
+        # overrides
+
+        def children_match_prefix: (Array[String]) { (String) -> void } -> Enumerator[String, void]
+
+        def partial_word_chars?: (Array[String]) -> bool
+
+        def word_chars?: (Array[String]) -> bool
+
+        def closest_node: (Array[String]) -> Node
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Rambling
+  module Trie
+    module Readers
+      class PlainText < Reader
+        def each_word: (String) { (String?) -> void } -> (Enumerator[String?, void] | PlainText)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Rambling
+  module Trie
+    module Readers
+      class Reader
+        def each_word: (String) { (String) -> void } -> (Enumerator[String, void] | Reader)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Rambling
+  module Trie
+    module Serializers
+      class File < Serializer[String]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Rambling
+  module Trie
+    module Serializers
+      class Marshal < Serializer[Nodes::Node]
+        @serializer: Serializer[String]
+
+        private
+
+        attr_reader serializer: Serializer[String]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Rambling
+  module Trie
+    module Serializers
+      class Serializer[TContents]
+        def load: (String) -> TContents
+        def dump: (TContents, String) -> Numeric
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Rambling
+  module Trie
+    module Serializers
+      class Yaml < Serializer[Nodes::Node]
+        @serializer: Serializer[String]
+
+        private
+
+        attr_reader serializer: Serializer[String]
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,21 @@
+module Rambling
+  module Trie
+    module Stringifyable
+      def as_word: -> String
+
+      def to_s: -> String
+
+      private
+
+      # abstract methods
+
+      def letter: -> Symbol
+
+      def terminal?: -> bool
+
+      def parent: -> Nodes::Node?
+
+      def children_tree: -> Hash[Symbol, Nodes::Node]
+    end
+  end
+end

data/sig/lib/rambling/trie.rbs

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

data/sig/lib/zip/entry.rbs

@@ -0,0 +1,11 @@
+module Zip
+  class Entry
+    include Enumerable[Entry]
+
+    def name: -> String
+
+    def extract: (String) -> void
+
+    def each: ?{ (Entry) -> void } -> (Enumerator[Entry, void])
+  end
+end

data/sig/lib/zip/file.rbs

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rambling-trie
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Edgar Gonzalez
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-30 00:00:00.000000000 Z
+date: 2024-12-05 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. '
@@ -20,11 +20,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Dockerfile
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- Steepfile
 - lib/rambling-trie.rb
 - lib/rambling/trie.rb
 - lib/rambling/trie/comparable.rb
@@ -54,6 +56,30 @@ files:
 - lib/rambling/trie/stringifyable.rb
 - lib/rambling/trie/version.rb
 - rambling-trie.gemspec
+- sig/lib/rambling/trie.rbs
+- sig/lib/rambling/trie/comparable.rbs
+- sig/lib/rambling/trie/compressible.rbs
+- sig/lib/rambling/trie/compressor.rbs
+- sig/lib/rambling/trie/configuration/properties.rbs
+- sig/lib/rambling/trie/configuration/provider_collection.rbs
+- sig/lib/rambling/trie/container.rbs
+- sig/lib/rambling/trie/enumerable.rbs
+- sig/lib/rambling/trie/inspectable.rbs
+- sig/lib/rambling/trie/invalid_operation.rbs
+- sig/lib/rambling/trie/nodes/compressed.rbs
+- sig/lib/rambling/trie/nodes/missing.rbs
+- sig/lib/rambling/trie/nodes/node.rbs
+- sig/lib/rambling/trie/nodes/raw.rbs
+- sig/lib/rambling/trie/readers/plain_text.rbs
+- sig/lib/rambling/trie/readers/reader.rbs
+- sig/lib/rambling/trie/serializers/file.rbs
+- sig/lib/rambling/trie/serializers/marshal.rbs
+- sig/lib/rambling/trie/serializers/serializer.rbs
+- sig/lib/rambling/trie/serializers/yaml.rbs
+- sig/lib/rambling/trie/serializers/zip.rbs
+- sig/lib/rambling/trie/stringifyable.rbs
+- sig/lib/zip/entry.rbs
+- sig/lib/zip/file.rbs
 homepage: https://github.com/gonzedge/rambling-trie
 licenses:
 - MIT
@@ -79,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A Ruby implementation of the trie data structure.