rambling-trie 1.0.3 → 2.0.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Configuration::Properties do
@@ -6,27 +8,33 @@ describe Rambling::Trie::Configuration::Properties do
   describe '.new' do
     it 'configures the serializers' do
       serializers = properties.serializers
-      expect(serializers.formats).to match_array %i(marshal yaml yml zip)
 
-      expect(serializers[:marshal]).to be_instance_of Rambling::Trie::Serializers::Marshal
-      expect(serializers[:yaml]).to be_instance_of Rambling::Trie::Serializers::Yaml
-      expect(serializers[:yml]).to be_instance_of Rambling::Trie::Serializers::Yaml
-      expect(serializers[:zip]).to be_instance_of Rambling::Trie::Serializers::Zip
+      expect(serializers.formats).to match_array %i(marshal yaml yml zip)
+      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
 
     it 'configures the readers' do
       readers = properties.readers
-      expect(readers.formats).to match_array %i(txt)
 
-      expect(readers[:txt]).to be_instance_of Rambling::Trie::Readers::PlainText
+      expect(readers.formats).to match_array %i(txt)
+      expect(readers.providers.to_a).to match_array [
+        [:txt, Rambling::Trie::Readers::PlainText],
+      ]
     end
 
     it 'configures the compressor' do
-      expect(properties.compressor).to be_instance_of Rambling::Trie::Compressor
+      compressor = properties.compressor
+      expect(compressor).to be_instance_of Rambling::Trie::Compressor
     end
 
     it 'configures the root_builder' do
-      expect(properties.root_builder.call).to be_instance_of Rambling::Trie::Nodes::Raw
+      root = properties.root_builder.call
+      expect(root).to be_instance_of Rambling::Trie::Nodes::Raw
     end
   end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Configuration::ProviderCollection do
@@ -13,7 +15,7 @@ describe Rambling::Trie::Configuration::ProviderCollection do
     Rambling::Trie::Configuration::ProviderCollection.new(
       :provider,
       configured_providers,
-      configured_default
+      configured_default,
     )
   end
 
@@ -84,26 +86,20 @@ describe Rambling::Trie::Configuration::ProviderCollection do
     end
 
     context 'when the given value is not in the providers list' do
-      it 'does not change the default provider' do
-        expect do
-          begin
-            provider_collection.default = other_provider
-          rescue
-          end
-        end.not_to change { provider_collection.default }
+      it 'raises an error and keeps the default provider' do
+        expect { provider_collection.default = other_provider }
+          .to raise_error
+          .and(not_change { provider_collection.default })
       end
 
       it 'raises an ArgumentError' do
-        expect do
-          provider_collection.default = other_provider
-        end.to raise_error ArgumentError
+        expect { provider_collection.default = other_provider }
+          .to raise_error ArgumentError
       end
     end
 
     context 'when the providers list is empty' do
-      let(:configured_providers) do
-        {}
-      end
+      let(:configured_providers) { {} }
 
       it 'accepts nil' do
         provider_collection.default = nil

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Container do
@@ -14,8 +16,8 @@ describe Rambling::Trie::Container do
       it 'yields the container' do
         yielded = nil
 
-        container = Rambling::Trie::Container.new root, compressor do |container|
-          yielded = container
+        container = Rambling::Trie::Container.new root, compressor do |c|
+          yielded = c
         end
 
         expect(yielded).to be container
@@ -188,7 +190,7 @@ describe Rambling::Trie::Container do
         children_tree: nil,
         compressed?: nil,
         each: nil,
-        has_key?: nil,
+        key?: nil,
         inspect: nil,
         letter: nil,
         parent: nil,
@@ -225,11 +227,6 @@ describe Rambling::Trie::Container do
       expect(root).to have_received(:[]).with :yep
     end
 
-    it 'delegates `#as_word` to the root node' do
-      container.as_word
-      expect(root).to have_received :as_word
-    end
-
     it 'delegates `#children` to the root node' do
       container.children
       expect(root).to have_received :children
@@ -245,14 +242,19 @@ describe Rambling::Trie::Container do
       expect(root).to have_received :compressed?
     end
 
-    it 'delegates `#has_key?` to the root node' do
+    it 'delegates `#key?` to the root node' do
+      container.key? :yup
+      expect(root).to have_received(:key?).with :yup
+    end
+
+    it 'aliases `#has_key?` to `#key?`' do
       container.has_key? :yup
-      expect(root).to have_received(:has_key?).with :yup
+      expect(root).to have_received(:key?).with :yup
     end
 
     it 'aliases `#has_letter?` to `#has_key?`' do
       container.has_letter? :yup
-      expect(root).to have_received(:has_key?).with :yup
+      expect(root).to have_received(:key?).with :yup
     end
 
     it 'delegates `#inspect` to the root node' do
@@ -260,25 +262,10 @@ describe Rambling::Trie::Container do
       expect(root).to have_received :inspect
     end
 
-    it 'delegates `#letter` to the root node' do
-      container.letter
-      expect(root).to have_received :letter
-    end
-
-    it 'delegates `#parent` to the root node' do
-      container.parent
-      expect(root).to have_received :parent
-    end
-
     it 'delegates `#size` to the root node' do
       container.size
       expect(root).to have_received :size
     end
-
-    it 'delegates `#to_s` to the root node' do
-      container.to_s
-      expect(root).to have_received :to_s
-    end
   end
 
   describe '#compress!' do
@@ -417,17 +404,8 @@ describe Rambling::Trie::Container do
       end
 
       it 'returns an array with the words that match' do
-        expect(container.scan 'hi').to eq [
-          'hi',
-          'high',
-          'highlight',
-          'histerical'
-        ]
-
-        expect(container.scan 'hig').to eq [
-          'high',
-          'highlight'
-        ]
+        expect(container.scan 'hi').to eq %w(hi high highlight histerical)
+        expect(container.scan 'hig').to eq %w(high highlight)
       end
 
       context 'and the root has been compressed' do
@@ -436,17 +414,8 @@ describe Rambling::Trie::Container do
         end
 
         it 'returns an array with the words that match' do
-          expect(container.scan 'hi').to eq [
-            'hi',
-            'high',
-            'highlight',
-            'histerical'
-          ]
-
-          expect(container.scan 'hig').to eq [
-            'high',
-            'highlight'
-          ]
+          expect(container.scan 'hi').to eq %w(hi high highlight histerical)
+          expect(container.scan 'hig').to eq %w(high highlight)
         end
       end
     end
@@ -457,7 +426,7 @@ describe Rambling::Trie::Container do
       end
 
       it 'returns an empty array' do
-        expect(container.scan 'hi').to eq []
+        expect(container.scan 'hi').to eq %w()
       end
 
       context 'and the root has been compressed' do
@@ -466,7 +435,7 @@ describe Rambling::Trie::Container do
         end
 
         it 'returns an empty array' do
-          expect(container.scan 'hi').to eq []
+          expect(container.scan 'hi').to eq %w()
         end
       end
     end
@@ -529,7 +498,8 @@ describe Rambling::Trie::Container do
 
     context 'phrase contains a few words' do
       it 'returns an array with all words found in the phrase' do
-        expect(container.words_within 'xyzword otherzxyone').to match_array %w(word other one)
+        expect(container.words_within 'xyzword otherzxyone')
+          .to match_array %w(word other one)
       end
 
       context 'and the node is compressed' do
@@ -538,7 +508,8 @@ describe Rambling::Trie::Container do
         end
 
         it 'returns an array with all words found in the phrase' do
-          expect(container.words_within 'xyzword otherzxyone').to match_array %w(word other one)
+          expect(container.words_within 'xyzword otherzxyone')
+            .to match_array %w(word other one)
         end
       end
     end
@@ -610,7 +581,11 @@ describe Rambling::Trie::Container do
     end
 
     it 'returns the container class name plus the root inspection' do
-      expect(container.inspect).to eq '#<Rambling::Trie::Container root: #<Rambling::Trie::Nodes::Raw letter: nil, terminal: nil, children: [:a, :f, :w, :h]>>'
+      expect(container.inspect).to eq one_line <<~CONTAINER
+        #<Rambling::Trie::Container root: #<Rambling::Trie::Nodes::Raw letter: nil,
+        terminal: nil,
+        children: [:a, :f, :w, :h]>>
+      CONTAINER
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 module Rambling

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Inspectable do
@@ -12,19 +14,42 @@ describe Rambling::Trie::Inspectable do
     let(:terminal_node) { node[:o][:n][:l][:y] }
 
     it 'returns a pretty printed version of the node' do
-      expect(node.inspect).to eq "#<Rambling::Trie::Nodes::Raw letter: nil, terminal: nil, children: [:o, :t, :w]>"
-      expect(child.inspect).to eq "#<Rambling::Trie::Nodes::Raw letter: :o, terminal: nil, children: [:n]>"
-      expect(terminal_node.inspect).to eq "#<Rambling::Trie::Nodes::Raw letter: :y, terminal: true, children: []>"
+      expect(node.inspect).to eq one_line <<~RAW
+        #<Rambling::Trie::Nodes::Raw letter: nil,
+        terminal: nil,
+        children: [:o, :t, :w]>
+      RAW
+
+      expect(child.inspect).to eq one_line <<~CHILD
+        #<Rambling::Trie::Nodes::Raw letter: :o,
+        terminal: nil,
+        children: [:n]>
+      CHILD
+
+      expect(terminal_node.inspect).to eq one_line <<~TERMINAL
+        #<Rambling::Trie::Nodes::Raw letter: :y,
+        terminal: true,
+        children: []>
+      TERMINAL
     end
 
     context 'for a compressed node' do
       let(:compressor) { Rambling::Trie::Compressor.new }
-      let(:compressed_node) { compressor.compress node }
-      let(:compressed_child) { compressed_node[:only] }
+      let(:compressed) { compressor.compress node }
+      let(:compressed_child) { compressed[:o] }
 
       it 'returns a pretty printed version of the compressed node' do
-        expect(compressed_node.inspect).to eq "#<Rambling::Trie::Nodes::Compressed letter: nil, terminal: nil, children: [:only, :three, :words]>"
-        expect(compressed_child.inspect).to eq "#<Rambling::Trie::Nodes::Compressed letter: :only, terminal: true, children: []>"
+        expect(compressed.inspect).to eq one_line <<~COMPRESSED
+          #<Rambling::Trie::Nodes::Compressed letter: nil,
+          terminal: nil,
+          children: [:o, :t, :w]>
+        COMPRESSED
+
+        expect(compressed_child.inspect).to eq one_line <<~CHILD
+          #<Rambling::Trie::Nodes::Compressed letter: :only,
+          terminal: true,
+          children: []>
+        CHILD
       end
     end
   end

data/spec/lib/rambling/trie/nodes/compressed_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Nodes::Compressed do

data/spec/lib/rambling/trie/nodes/node_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Nodes::Node do

data/spec/lib/rambling/trie/nodes/raw_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Nodes::Raw do

data/spec/lib/rambling/trie/readers/plain_text_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Readers::PlainText do
   describe '#each_word' do
     let(:filepath) { File.join(::SPEC_ROOT, 'assets', 'test_words.en_US.txt') }
-    let(:words) { File.readlines(filepath).map &:chomp }
+    let(:words) { File.readlines(filepath).map(&:chomp) }
 
     it 'yields every word yielded by the file' do
       yielded = []

data/spec/lib/rambling/trie/serializers/file_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Serializers::File do

data/spec/lib/rambling/trie/serializers/marshal_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Serializers::Marshal do

data/spec/lib/rambling/trie/serializers/yaml_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Serializers::Yaml do

data/spec/lib/rambling/trie/serializers/zip_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Serializers::Zip do
@@ -10,17 +12,17 @@ describe Rambling::Trie::Serializers::Zip do
       properties.tmp_path = tmp_path
     end
 
-    let(:filename) { File.basename(filepath).gsub /\.zip/, ''}
+    let(:filename) { File.basename(filepath).gsub %r{\.zip}, '' }
     let(:formatted_content) { zip Marshal.dump content }
 
     def zip content
-      io = Zip::OutputStream.write_buffer do |io|
+      cursor = Zip::OutputStream.write_buffer do |io|
         io.put_next_entry filename
         io.write content
       end
 
-      io.rewind
-      io.read
+      cursor.rewind
+      cursor.read
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Stringifyable do
@@ -36,7 +38,8 @@ describe Rambling::Trie::Stringifyable do
       end
 
       it 'raises an error for a non terminal node' do
-        expect { node[:l].as_word }.to raise_error Rambling::Trie::InvalidOperation
+        expect { node[:l].as_word }
+          .to raise_error Rambling::Trie::InvalidOperation
       end
     end
 
@@ -70,11 +73,12 @@ describe Rambling::Trie::Stringifyable do
 
       it 'returns the words for the terminal nodes' do
         expect(compressed_node[:m].as_word).to eq 'am'
-        expect(compressed_node[:dd].as_word).to eq 'add'
+        expect(compressed_node[:d].as_word).to eq 'add'
       end
 
       it 'raise an error for non terminal nodes' do
-        expect { compressed_node.as_word }.to raise_error Rambling::Trie::InvalidOperation
+        expect { compressed_node.as_word }
+          .to raise_error Rambling::Trie::InvalidOperation
       end
     end
   end

data/spec/lib/rambling/trie_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie do
@@ -31,7 +33,10 @@ describe Rambling::Trie do
 
       before do
         receive_and_yield = receive(:each_word)
-        words.inject(receive_and_yield) { |yielder, word| yielder.and_yield word }
+        words.inject(receive_and_yield) do |yielder, word|
+          yielder.and_yield word
+        end
+
         allow(reader).to receive_and_yield
         allow(container).to receive :<<
       end
@@ -40,7 +45,7 @@ describe Rambling::Trie do
         Rambling::Trie.create filepath, reader
 
         words.each do |word|
-          expect(container).to have_received(:<<).with(word)
+          expect(container).to have_received(:<<).with word
         end
       end
     end
@@ -77,7 +82,7 @@ describe Rambling::Trie do
     end
 
     it 'uses the serializer to load the root node from the given filepath' do
-      trie = Rambling::Trie.load filepath, serializer
+      Rambling::Trie.load filepath, serializer
       expect(serializer).to have_received(:load).with filepath
     end
 
@@ -98,16 +103,16 @@ describe Rambling::Trie do
       end
 
       it 'determines the serializer based on the file extension' do
-        trie = Rambling::Trie.load 'test.marshal'
+        Rambling::Trie.load 'test.marshal'
         expect(marshal_serializer).to have_received(:load).with 'test.marshal'
 
-        trie = Rambling::Trie.load 'test.yml'
+        Rambling::Trie.load 'test.yml'
         expect(yaml_serializer).to have_received(:load).with 'test.yml'
 
-        trie = Rambling::Trie.load 'test.yaml'
+        Rambling::Trie.load 'test.yaml'
         expect(yaml_serializer).to have_received(:load).with 'test.yaml'
 
-        trie = Rambling::Trie.load 'test'
+        Rambling::Trie.load 'test'
         expect(default_serializer).to have_received(:load).with 'test'
       end
     end
@@ -153,10 +158,12 @@ describe Rambling::Trie do
     context 'when provided with a format' do
       it 'uses the corresponding serializer' do
         Rambling::Trie.dump trie, "#{filename}.marshal"
-        expect(marshal_serializer).to have_received(:dump).with root, "#{filename}.marshal"
+        expect(marshal_serializer).to have_received(:dump)
+          .with root, "#{filename}.marshal"
 
         Rambling::Trie.dump trie, "#{filename}.yml"
-        expect(yaml_serializer).to have_received(:dump).with root, "#{filename}.yml"
+        expect(yaml_serializer).to have_received(:dump)
+          .with root, "#{filename}.yml"
       end
     end
   end