rambling-trie 2.3.0 → 2.4.0

data/spec/support/shared_examples/a_trie_node.rb

@@ -21,7 +21,8 @@ shared_examples_for 'a trie node' do
     end
 
     context 'with a letter and a parent' do
-      let(:parent) { node.class.new }
+      let(:parent) { node_class.new }
+      # noinspection RubyArgCount
       let(:node_with_parent) { node_class.new :a, parent }
 
       it 'does not have any letter' do
@@ -40,9 +41,7 @@ shared_examples_for 'a trie node' do
 
   describe '#root?' do
     context 'when the node has a parent' do
-      before do
-        node.parent = node
-      end
+      before { node.parent = node }
 
       it 'returns false' do
         expect(node).not_to be_root
@@ -50,9 +49,7 @@ shared_examples_for 'a trie node' do
     end
 
     context 'when the node does not have a parent' do
-      before do
-        node.parent = nil
-      end
+      before { node.parent = nil }
 
       it 'returns true' do
         expect(node).to be_root
@@ -61,12 +58,13 @@ shared_examples_for 'a trie node' do
   end
 
   describe '#terminal!' do
+    # rubocop:disable RSpec/MultipleExpectations
     it 'forces the node to be terminal' do
       expect(node).not_to be_terminal
       node.terminal!
-
       expect(node).to be_terminal
     end
+    # rubocop:enable RSpec/MultipleExpectations
 
     it 'returns the node' do
       expect(node.terminal!).to eq node
@@ -74,8 +72,9 @@ shared_examples_for 'a trie node' do
   end
 
   describe 'delegates and aliases' do
-    let(:children_tree) do
-      double(
+    let :children_tree do
+      instance_double(
+        'Hash',
         :children_tree,
         :[] => 'value',
         :[]= => nil,
@@ -84,20 +83,21 @@ shared_examples_for 'a trie node' do
       )
     end
 
-    before do
-      node.children_tree = children_tree
-    end
+    before { node.children_tree = children_tree }
 
+    # rubocop:disable RSpec/MultipleExpectations
     it 'delegates `#[]` to its children tree' do
       expect(node[:key]).to eq 'value'
       expect(children_tree).to have_received(:[]).with :key
     end
+    # rubocop:enable RSpec/MultipleExpectations
 
     it 'delegates `#[]=` to its children tree' do
       node[:key] = 'value'
       expect(children_tree).to have_received(:[]=).with(:key, 'value')
     end
 
+    # rubocop:disable RSpec/MultipleExpectations
     it 'delegates `#key?` to its children tree' do
       allow(children_tree).to receive(:key?)
         .with(:present_key)
@@ -106,18 +106,26 @@ shared_examples_for 'a trie node' do
       expect(node).to have_key(:present_key)
       expect(node).not_to have_key(:absent_key)
     end
+    # rubocop:enable RSpec/MultipleExpectations
 
+    # rubocop:disable RSpec/MultipleExpectations
     it 'delegates `#delete` to its children tree' do
       expect(node.delete :key).to be true
       expect(children_tree).to have_received(:delete).with :key
     end
+    # rubocop:enable RSpec/MultipleExpectations
 
+    # rubocop:disable RSpec/ExampleLength
     it 'delegates `#children` to its children tree values' do
-      children = [double(:child_1), double(:child_2)]
+      children = [
+        instance_double('Rambling::Trie::Nodes::Node', :child_one),
+        instance_double('Rambling::Trie::Nodes::Node', :child_two),
+      ]
       allow(children_tree).to receive(:values).and_return children
 
       expect(node.children).to eq children
     end
+    # rubocop:enable RSpec/ExampleLength
 
     it 'aliases `#has_key?` to `#key?`' do
       node.has_key? :nope

data/spec/support/shared_examples/a_trie_node_implementation.rb

@@ -12,26 +12,22 @@ shared_examples_for 'a trie node implementation' do
 
     context 'when the chars array is not empty' do
       context 'when the node has a tree that matches the characters' do
-        before do
-          add_word_to_tree 'abc'
-        end
+        before { add_word_to_tree 'abc' }
 
-        it 'returns true' do
-          expect(node.partial_word? %w(a)).to be true
-          expect(node.partial_word? %w(a b)).to be true
-          expect(node.partial_word? %w(a b c)).to be true
+        [%w(a), %w(a b), %w(a b c)].each do |letters|
+          it "returns true for '#{letters}'" do
+            expect(node.partial_word? letters).to be true
+          end
         end
       end
 
       context 'when the node has a tree that does not match the characters' do
-        before do
-          add_word_to_tree 'cba'
-        end
+        before { add_word_to_tree 'cba' }
 
-        it 'returns false' do
-          expect(node.partial_word? %w(a)).to be false
-          expect(node.partial_word? %w(a b)).to be false
-          expect(node.partial_word? %w(a b c)).to be false
+        [%w(a), %w(a b), %w(a b c)].each do |letters|
+          it "returns false for '#{letters}'" do
+            expect(node.partial_word? letters).to be false
+          end
         end
       end
     end
@@ -40,9 +36,7 @@ shared_examples_for 'a trie node implementation' do
   describe '#word?' do
     context 'when the chars array is empty' do
       context 'when the node is terminal' do
-        before do
-          node.terminal!
-        end
+        before { node.terminal! }
 
         it 'returns true' do
           expect(node.word? []).to be true
@@ -58,9 +52,7 @@ shared_examples_for 'a trie node implementation' do
 
     context 'when the chars array is not empty' do
       context 'when the node has a tree that matches all the characters' do
-        before do
-          add_word_to_tree 'abc'
-        end
+        before { add_word_to_tree 'abc' }
 
         it 'returns true' do
           expect(node.word? %w(a b c).map(&:dup)).to be true
@@ -68,13 +60,12 @@ shared_examples_for 'a trie node implementation' do
       end
 
       context 'when the node subtree does not match all the characters' do
-        before do
-          add_word_to_tree 'abc'
-        end
+        before { add_word_to_tree 'abc' }
 
-        it 'returns false' do
-          expect(node.word? %w(a).map(&:dup)).to be false
-          expect(node.word? %w(a b).map(&:dup)).to be false
+        [%w(a), %w(a b)].each do |letters|
+          it "returns false for '#{letters}'" do
+            expect(node.word? letters.map(&:dup)).to be false
+          end
         end
       end
     end
@@ -88,26 +79,34 @@ shared_examples_for 'a trie node implementation' do
     end
 
     context 'when the chars array is not empty' do
-      before do
-        add_words_to_tree %w(cba ccab)
-      end
+      before { add_words_to_tree %w(cba ccab) }
 
       context 'when the chars are found' do
-        it 'returns the found child' do
-          expect(node.scan %w(c)).to match_array %w(cba ccab)
-          expect(node.scan %w(c b)).to match_array %w(cba)
-          expect(node.scan %w(c b a)).to match_array %w(cba)
+        [
+          [%w(c), %w(cba ccab)],
+          [%w(c b), %w(cba)],
+          [%w(c b a), %w(cba)],
+        ].each do |test_params|
+          letters, expected = test_params
+
+          it "returns the corresponding children (#{letters} => #{expected})" do
+            expect(node.scan letters).to match_array expected
+          end
         end
       end
 
       context 'when the chars are not found' do
-        it 'returns a Nodes::Missing' do
-          expect(node.scan %w(a)).to be_a Rambling::Trie::Nodes::Missing
-          expect(node.scan %w(a b)).to be_a Rambling::Trie::Nodes::Missing
-          expect(node.scan %w(a b c)).to be_a Rambling::Trie::Nodes::Missing
-          expect(node.scan %w(c a)).to be_a Rambling::Trie::Nodes::Missing
-          expect(node.scan %w(c c b)).to be_a Rambling::Trie::Nodes::Missing
-          expect(node.scan %w(c b a d)).to be_a Rambling::Trie::Nodes::Missing
+        [
+          %w(a),
+          %w(a b),
+          %w(a b c),
+          %w(c a),
+          %w(c c b),
+          %w(c b a d),
+        ].each do |letters|
+          it "returns a Nodes::Missing for '#{letters}'" do
+            expect(node.scan letters).to be_a Rambling::Trie::Nodes::Missing
+          end
         end
       end
     end
@@ -120,9 +119,7 @@ shared_examples_for 'a trie node implementation' do
     end
 
     context 'when the node is terminal' do
-      before do
-        node.terminal!
-      end
+      before { node.terminal! }
 
       it 'adds itself to the words' do
         expect(node.match_prefix %w(g n i t e)).to include 'i'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rambling-trie
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Edgar Gonzalez
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2024-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.28
+        version: 0.9.34
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.28
+        version: 0.9.34
 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:
@@ -86,9 +86,11 @@ files:
 - lib/rambling/trie/nodes/raw.rb
 - lib/rambling/trie/readers.rb
 - lib/rambling/trie/readers/plain_text.rb
+- lib/rambling/trie/readers/reader.rb
 - lib/rambling/trie/serializers.rb
 - lib/rambling/trie/serializers/file.rb
 - lib/rambling/trie/serializers/marshal.rb
+- lib/rambling/trie/serializers/serializer.rb
 - lib/rambling/trie/serializers/yaml.rb
 - lib/rambling/trie/serializers/zip.rb
 - lib/rambling/trie/stringifyable.rb
@@ -108,8 +110,10 @@ files:
 - 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
@@ -119,16 +123,22 @@ files:
 - 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
-homepage: http://github.com/gonzedge/rambling-trie
+homepage: https://github.com/gonzedge/rambling-trie
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/gonzedge/rambling-trie/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/rambling-trie
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -147,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A Ruby implementation of the trie data structure.
@@ -166,8 +176,10 @@ test_files:
 - 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
@@ -177,6 +189,10 @@ test_files:
 - 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