rambling-trie 2.4.0 → 2.5.1

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.4.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Edgar Gonzalez
@@ -9,50 +9,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-27 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.1'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.34
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.34
+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. '
 email:
@@ -62,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
@@ -96,49 +56,37 @@ files:
 - lib/rambling/trie/stringifyable.rb
 - lib/rambling/trie/version.rb
 - rambling-trie.gemspec
-- spec/assets/test_words.en_US.txt
-- spec/assets/test_words.es_DO.txt
-- spec/integration/rambling/trie_spec.rb
-- spec/lib/rambling/trie/comparable_spec.rb
-- spec/lib/rambling/trie/compressor_spec.rb
-- spec/lib/rambling/trie/configuration/properties_spec.rb
-- spec/lib/rambling/trie/configuration/provider_collection_spec.rb
-- spec/lib/rambling/trie/container_spec.rb
-- spec/lib/rambling/trie/enumerable_spec.rb
-- spec/lib/rambling/trie/inspectable_spec.rb
-- spec/lib/rambling/trie/nodes/compressed_spec.rb
-- spec/lib/rambling/trie/nodes/node_spec.rb
-- spec/lib/rambling/trie/nodes/raw_spec.rb
-- spec/lib/rambling/trie/readers/plain_text_spec.rb
-- spec/lib/rambling/trie/readers/reader_spec.rb
-- spec/lib/rambling/trie/serializers/file_spec.rb
-- spec/lib/rambling/trie/serializers/marshal_spec.rb
-- spec/lib/rambling/trie/serializers/serializer_spec.rb
-- spec/lib/rambling/trie/serializers/yaml_spec.rb
-- spec/lib/rambling/trie/serializers/zip_spec.rb
-- spec/lib/rambling/trie/stringifyable_spec.rb
-- spec/lib/rambling/trie_spec.rb
-- spec/spec_helper.rb
-- spec/support/config.rb
-- spec/support/helpers/add_word.rb
-- spec/support/helpers/one_line_heredoc.rb
-- spec/support/shared_examples/a_compressible_trie.rb
-- spec/support/shared_examples/a_container_partial_word.rb
-- spec/support/shared_examples/a_container_scan.rb
-- spec/support/shared_examples/a_container_word.rb
-- spec/support/shared_examples/a_container_words_within.rb
-- spec/support/shared_examples/a_serializable_trie.rb
-- spec/support/shared_examples/a_serializer.rb
-- spec/support/shared_examples/a_trie_data_structure.rb
-- spec/support/shared_examples/a_trie_node.rb
-- spec/support/shared_examples/a_trie_node_implementation.rb
-- spec/tmp/.gitkeep
+- 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
 metadata:
-  changelog_uri: https://github.com/gonzedge/rambling-trie/blob/master/CHANGELOG.md
+  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:
@@ -147,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4'
@@ -157,45 +105,8 @@ 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.
-test_files:
-- spec/assets/test_words.en_US.txt
-- spec/assets/test_words.es_DO.txt
-- spec/integration/rambling/trie_spec.rb
-- spec/lib/rambling/trie/comparable_spec.rb
-- spec/lib/rambling/trie/compressor_spec.rb
-- spec/lib/rambling/trie/configuration/properties_spec.rb
-- spec/lib/rambling/trie/configuration/provider_collection_spec.rb
-- spec/lib/rambling/trie/container_spec.rb
-- spec/lib/rambling/trie/enumerable_spec.rb
-- spec/lib/rambling/trie/inspectable_spec.rb
-- spec/lib/rambling/trie/nodes/compressed_spec.rb
-- spec/lib/rambling/trie/nodes/node_spec.rb
-- spec/lib/rambling/trie/nodes/raw_spec.rb
-- spec/lib/rambling/trie/readers/plain_text_spec.rb
-- spec/lib/rambling/trie/readers/reader_spec.rb
-- spec/lib/rambling/trie/serializers/file_spec.rb
-- spec/lib/rambling/trie/serializers/marshal_spec.rb
-- spec/lib/rambling/trie/serializers/serializer_spec.rb
-- spec/lib/rambling/trie/serializers/yaml_spec.rb
-- spec/lib/rambling/trie/serializers/zip_spec.rb
-- spec/lib/rambling/trie/stringifyable_spec.rb
-- spec/lib/rambling/trie_spec.rb
-- spec/spec_helper.rb
-- spec/support/config.rb
-- spec/support/helpers/add_word.rb
-- spec/support/helpers/one_line_heredoc.rb
-- spec/support/shared_examples/a_compressible_trie.rb
-- spec/support/shared_examples/a_container_partial_word.rb
-- spec/support/shared_examples/a_container_scan.rb
-- spec/support/shared_examples/a_container_word.rb
-- spec/support/shared_examples/a_container_words_within.rb
-- spec/support/shared_examples/a_serializable_trie.rb
-- spec/support/shared_examples/a_serializer.rb
-- spec/support/shared_examples/a_trie_data_structure.rb
-- spec/support/shared_examples/a_trie_node.rb
-- spec/support/shared_examples/a_trie_node_implementation.rb
-- spec/tmp/.gitkeep
+test_files: []

data/spec/assets/test_words.en_US.txt

@@ -1,23 +0,0 @@
-are
-beautiful
-course
-false
-hello
-hi
-is
-it
-mine
-my
-no
-of
-ours
-today
-true
-truth
-whatever
-where
-who
-yeah
-you
-your
-yours

data/spec/assets/test_words.es_DO.txt

@@ -1,24 +0,0 @@
-claro
-donde
-dónde
-eres
-es
-eso
-falso
-hermoso
-hola
-hoy
-mi
-mío
-no
-nuestro
-ola
-quien
-quién
-si
-tu
-tus
-tuyos
-verdad
-verdadero
-🙃

data/spec/integration/rambling/trie_spec.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'zip'
-
-describe Rambling::Trie do
-  let(:assets_path) { File.join ::SPEC_ROOT, 'assets' }
-
-  describe '::VERSION' do
-    let(:root_path) { File.join ::SPEC_ROOT, '..' }
-    let(:readme_path) { File.join root_path, 'README.md' }
-    let(:readme) { File.read readme_path }
-    let(:changelog_path) { File.join root_path, 'CHANGELOG.md' }
-    let(:changelog) { File.read changelog_path }
-
-    let(:changelog_versions) do
-      matches = []
-      changelog.scan %r{^## (\d+\.\d+\.\d+)} do |match|
-        matches << match[0]
-      end
-      matches
-    end
-
-    it 'matches with the version in the README badge' do
-      match = %r{\?version=(?<version>.*)$}.match readme
-      expect(match['version']).to eq Rambling::Trie::VERSION
-    end
-
-    it 'is the version before the one at the top of the CHANGELOG' do
-      changelog_version = Gem::Version.new changelog_versions.first
-      lib_version = Gem::Version.new "#{Rambling::Trie::VERSION}.0"
-      expect(changelog_version).to eq lib_version.bump
-    end
-
-    it 'is included in the CHANGELOG diffs' do
-      changelog_versions.shift
-      expect(changelog_versions.first).to eq Rambling::Trie::VERSION
-    end
-  end
-
-  context 'when providing words directly' do
-    it_behaves_like 'a compressible trie' do
-      let(:trie) { described_class.create }
-      let(:words) { %w(a couple of words for our full trie integration test) }
-
-      before { trie.concat words }
-    end
-  end
-
-  context 'when provided with words with unicode characters' do
-    it_behaves_like 'a compressible trie' do
-      let(:trie) { described_class.create }
-      let :words do
-        %w(poquísimas palabras para nuestra prueba de integración completa 🙃)
-      end
-
-      before { trie.concat words }
-    end
-  end
-
-  context 'when provided with a filepath' do
-    let(:trie) { described_class.create filepath }
-    let(:words) { File.readlines(filepath).map(&:chomp) }
-
-    context 'with english words' do
-      it_behaves_like 'a compressible trie' do
-        let(:filepath) { File.join assets_path, 'test_words.en_US.txt' }
-      end
-    end
-
-    context 'with unicode characters' do
-      it_behaves_like 'a compressible trie' do
-        let(:filepath) { File.join assets_path, 'test_words.es_DO.txt' }
-      end
-    end
-  end
-
-  describe 'dump and load' do
-    let(:words_filepath) { File.join assets_path, 'test_words.en_US.txt' }
-    let(:words) { File.readlines(words_filepath).map(&:chomp) }
-
-    context 'when serialized with Ruby marshal format (default)' do
-      it_behaves_like 'a serializable trie' do
-        let(:trie_to_serialize) { described_class.create words_filepath }
-        let(:file_format) { :marshal }
-      end
-    end
-
-    context 'when serialized with YAML' do
-      it_behaves_like 'a serializable trie' do
-        let(:trie_to_serialize) { described_class.create words_filepath }
-        let(:file_format) { :yml }
-      end
-    end
-
-    context 'when serialized with zipped Ruby marshal format' do
-      let!(:original_on_exists_proc) { ::Zip.on_exists_proc }
-      let!(:original_continue_on_exists_proc) { ::Zip.continue_on_exists_proc }
-
-      before do
-        ::Zip.on_exists_proc = true
-        ::Zip.continue_on_exists_proc = true
-      end
-
-      after do
-        ::Zip.on_exists_proc = original_on_exists_proc
-        ::Zip.continue_on_exists_proc = original_continue_on_exists_proc
-      end
-
-      it_behaves_like 'a serializable trie' do
-        let(:trie_to_serialize) { described_class.create words_filepath }
-        let(:file_format) { 'marshal.zip' }
-      end
-    end
-  end
-end

data/spec/lib/rambling/trie/comparable_spec.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Rambling::Trie::Comparable do
-  describe '#==' do
-    let(:node_one) { Rambling::Trie::Nodes::Raw.new }
-    let(:node_two) { Rambling::Trie::Nodes::Raw.new }
-
-    context 'when the nodes do not have the same letter' do
-      before do
-        node_one.letter = :a
-        node_two.letter = :b
-      end
-
-      it 'returns false' do
-        expect(node_one).not_to eq node_two
-      end
-    end
-
-    context 'when nodes have same letter, not terminal and no children' do
-      before do
-        node_one.letter = :a
-        node_two.letter = :a
-      end
-
-      it 'returns true' do
-        expect(node_one).to eq node_two
-      end
-    end
-
-    context 'when the nodes have the same letter and are terminal' do
-      before do
-        node_one.letter = :a
-        node_one.terminal!
-
-        node_two.letter = :a
-        node_two.terminal!
-      end
-
-      it 'returns true' do
-        expect(node_one).to eq node_two
-      end
-    end
-
-    context 'when the nodes have the same letter but are not both terminal' do
-      before do
-        node_one.letter = :a
-        node_one.terminal!
-
-        node_two.letter = :a
-      end
-
-      it 'returns false' do
-        expect(node_one).not_to eq node_two
-      end
-    end
-
-    context 'when the nodes have the same letter and the same children' do
-      before do
-        node_one.letter = :t
-        add_words node_one, %w(hese hree hings)
-
-        node_two.letter = :t
-        add_words node_two, %w(hese hree hings)
-      end
-
-      it 'returns true' do
-        expect(node_one).to eq node_two
-      end
-    end
-
-    context 'when the nodes have the same letter but different children' do
-      before do
-        node_one.letter = :t
-        add_words node_one, %w(hese wo)
-
-        node_two.letter = :t
-        add_words node_two, %w(hese hree hings)
-      end
-
-      it 'returns false' do
-        expect(node_one).not_to eq node_two
-      end
-    end
-  end
-end

data/spec/lib/rambling/trie/compressor_spec.rb

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Rambling::Trie::Compressor do
-  let(:compressor) { described_class.new }
-
-  describe '#compress' do
-    let(:node) { Rambling::Trie::Nodes::Raw.new }
-
-    it 'compresses the node' do
-      add_words node, %w(a few words hello hell)
-      compressed = compressor.compress node
-
-      expect(compressed.children_tree.keys).to eq %i(a f w h)
-    end
-
-    context 'with at least one word' do
-      before { add_words node, %w(all the words) }
-
-      it 'keeps the node letter nil' do
-        compressed = compressor.compress node
-
-        expect(compressed.letter).to be_nil
-      end
-    end
-
-    context 'with a single word' do
-      before { add_word node, 'all' }
-
-      # rubocop:disable RSpec/ExampleLength, RSpec/MultipleExpectations
-      it 'compresses into a single node without children' do
-        compressed = compressor.compress node
-        compressed_node_a = compressed[:a]
-
-        expect(compressed_node_a.letter).to eq :all
-        expect(compressed_node_a.children.size).to eq 0
-        expect(compressed_node_a).to be_terminal
-        expect(compressed_node_a).to be_compressed
-      end
-      # rubocop:enable RSpec/ExampleLength, RSpec/MultipleExpectations
-    end
-
-    context 'with two words' do
-      before { add_words node, %w(all ask) }
-
-      # rubocop:disable RSpec/ExampleLength, RSpec/MultipleExpectations
-      it 'compresses into corresponding three nodes' do
-        compressed = compressor.compress node
-
-        expect(compressed[:a].letter).to eq :a
-        expect(compressed[:a].children.size).to eq 2
-
-        expect(compressed[:a][:l].letter).to eq :ll
-        expect(compressed[:a][:s].letter).to eq :sk
-
-        expect(compressed[:a][:l].children.size).to eq 0
-        expect(compressed[:a][:s].children.size).to eq 0
-
-        expect(compressed[:a][:l]).to be_terminal
-        expect(compressed[:a][:s]).to be_terminal
-
-        expect(compressed[:a][:l]).to be_compressed
-        expect(compressed[:a][:s]).to be_compressed
-      end
-      # rubocop:enable RSpec/ExampleLength, RSpec/MultipleExpectations
-    end
-
-    # rubocop:disable RSpec/ExampleLength, RSpec/MultipleExpectations
-    it 'reassigns the parent nodes correctly' do
-      add_words node, %w(repay rest repaint)
-      compressed = compressor.compress node
-
-      expect(compressed[:r].letter).to eq :re
-      expect(compressed[:r].parent).to eq compressed
-      expect(compressed[:r].children.size).to eq 2
-
-      expect(compressed[:r][:p].letter).to eq :pa
-      expect(compressed[:r][:p].parent).to eq compressed[:r]
-      expect(compressed[:r][:p].children.size).to eq 2
-
-      expect(compressed[:r][:s].letter).to eq :st
-      expect(compressed[:r][:s].parent).to eq compressed[:r]
-      expect(compressed[:r][:s].children.size).to eq 0
-
-      expect(compressed[:r][:p][:y].letter).to eq :y
-      expect(compressed[:r][:p][:y].parent).to eq compressed[:r][:p]
-      expect(compressed[:r][:p][:y].children.size).to eq 0
-
-      expect(compressed[:r][:p][:i].letter).to eq :int
-      expect(compressed[:r][:p][:i].parent).to eq compressed[:r][:p]
-      expect(compressed[:r][:p][:i].children.size).to eq 0
-    end
-    # rubocop:enable RSpec/ExampleLength, RSpec/MultipleExpectations
-
-    # rubocop:disable RSpec/ExampleLength, RSpec/MultipleExpectations
-    it 'does not compress terminal nodes' do
-      add_words node, %w(you your yours)
-      compressed = compressor.compress node
-
-      expect(compressed[:y].letter).to eq :you
-
-      expect(compressed[:y][:r].letter).to eq :r
-      expect(compressed[:y][:r]).to be_compressed
-
-      expect(compressed[:y][:r][:s].letter).to eq :s
-      expect(compressed[:y][:r][:s]).to be_compressed
-    end
-    # rubocop:enable RSpec/ExampleLength, RSpec/MultipleExpectations
-  end
-end

data/spec/lib/rambling/trie/configuration/properties_spec.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Rambling::Trie::Configuration::Properties do
-  let(:properties) { described_class.new }
-
-  describe '.new' do
-    it 'configures the serializer formats' do
-      serializers = properties.serializers
-      expect(serializers.formats).to match_array %i(marshal yaml yml zip)
-    end
-
-    # rubocop:disable RSpec/ExampleLength
-    it 'configures the serializer providers' do
-      serializers = properties.serializers
-      expect(serializers.providers.to_a).to match_array [
-        [:marshal, Rambling::Trie::Serializers::Marshal],
-        [:yaml, Rambling::Trie::Serializers::Yaml],
-        [:yml, Rambling::Trie::Serializers::Yaml],
-        [:zip, Rambling::Trie::Serializers::Zip],
-      ]
-    end
-    # rubocop:enable RSpec/ExampleLength
-
-    it 'configures the reader formats' do
-      readers = properties.readers
-      expect(readers.formats).to match_array %i(txt)
-    end
-
-    it 'configures the reader providers' do
-      readers = properties.readers
-      expect(readers.providers.to_a).to match_array [
-        [:txt, Rambling::Trie::Readers::PlainText],
-      ]
-    end
-
-    it 'configures the compressor' do
-      compressor = properties.compressor
-      expect(compressor).to be_instance_of Rambling::Trie::Compressor
-    end
-
-    it 'configures the root_builder' do
-      root = properties.root_builder.call
-      expect(root).to be_instance_of Rambling::Trie::Nodes::Raw
-    end
-  end
-
-  describe '#reset' do
-    before do
-      properties.serializers.add :test, 'test'
-      properties.readers.add :test, 'test'
-    end
-
-    # rubocop:disable RSpec/MultipleExpectations
-    it 'resets the serializers to initial values' do
-      expect(properties.serializers.formats).to include :test
-
-      properties.reset
-
-      expect(properties.serializers.formats).not_to include :test
-    end
-    # rubocop:enable RSpec/MultipleExpectations
-
-    # rubocop:disable RSpec/MultipleExpectations
-    it 'resets the readers to initial values' do
-      expect(properties.readers.formats).to include :test
-
-      properties.reset
-
-      expect(properties.readers.formats).not_to include :test
-    end
-    # rubocop:enable RSpec/MultipleExpectations
-  end
-end