picky 2.0.0.pre2 → 2.0.0.pre3

data/spec/lib/internals/index/file/basic_spec.rb

@@ -2,13 +2,23 @@ require 'spec_helper'
 
 describe Internals::Index::File::Basic do
   
-  before(:each) do
-    @file = described_class.new "some/cache/path/to/file"
+  let(:file) { described_class.new 'some/cache/path/to/file' }
+  
+  describe 'backup_file_path_of' do
+    it 'returns a backup path relative to the path' do
+      file.backup_file_path_of('some/path/to/some.index').should == 'some/path/to/backup/some.index'
+    end
+  end
+  
+  describe 'to_s' do
+    it 'returns the cache path with the default file extension' do
+      file.to_s.should == 'some/cache/path/to/file.index'
+    end
   end
   
-  describe "backup_file_path_of" do
-    it "returns a backup path relative to the path" do
-      @file.backup_file_path_of('some/path/to/some.index').should == 'some/path/to/backup/some.index'
+  describe 'backup_directory' do
+    it "returns the cache path's backup path" do
+      file.backup_directory.should == 'some/cache/path/to/backup'
     end
   end
   

data/spec/lib/internals/index/redis/list_hash_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Internals::Index::Redis::ListHash do
+  
+  let(:index) { described_class.new :some_namespace }
+  
+  describe 'member' do
+    it 'raises an error' do
+      expect {
+        index.member :some_sym
+      }.to raise_error("Can't retrieve a single value from a Redis ListHash. Use Index::Redis::StringHash.")
+    end
+  end
+  
+  describe 'collection' do
+    it 'returns whatever comes back from the backend' do
+      backend = stub :backend
+      index.should_receive(:backend).and_return backend
+      
+      backend.stub! :lrange => :some_lrange_result
+      
+      index.collection(:anything).should == :some_lrange_result
+    end
+    it 'calls the right method on the backend' do
+      backend = stub :backend
+      index.should_receive(:backend).and_return backend
+      
+      backend.should_receive(:lrange).once.with "some_namespace:some_sym", 0, -1
+      
+      index.collection :some_sym
+    end
+  end
+  
+end

data/spec/lib/internals/index/redis/string_hash_spec.rb

@@ -4,11 +4,23 @@ describe Internals::Index::Redis::StringHash do
   
   let(:index) { described_class.new :some_namespace }
     
+  describe 'dump' do
+    let(:backend) { index.backend }
+    it 'dumps correctly' do
+      backend.should_receive(:hset).once.ordered.with :some_namespace, :a, 1
+      backend.should_receive(:hset).once.ordered.with :some_namespace, :b, 2
+      backend.should_receive(:hset).once.ordered.with :some_namespace, :c, 3
+      
+      index.dump a: 1, b: 2, c: 3
+    end
+  end
+  
   describe 'collection' do
     it 'raises' do
       expect { index.collection :anything }.to raise_error("Can't retrieve a collection from a StringHash. Use Index::Redis::ListHash.")
     end
   end
+  
   describe 'member' do
     before(:each) do
       @backend = stub :backend

data/spec/lib/internals/indexed/bundle/memory_spec.rb

@@ -10,6 +10,72 @@ describe Internals::Indexed::Bundle::Memory do
     @similarity   = stub :similarity
     @bundle       = described_class.new :some_name, @configuration, @similarity
   end
+  
+  describe 'to_s' do
+    it 'does something' do
+      @bundle.to_s.should == <<-TO_S
+Memory
+  Files:
+    Index:      spec/test_directory/index/test/some_index/some_category_some_name_index.json
+    Weights:    spec/test_directory/index/test/some_index/some_category_some_name_weights.json
+    Similarity: spec/test_directory/index/test/some_index/some_category_some_name_similarity.dump
+    Config:     spec/test_directory/index/test/some_index/some_category_some_name_configuration.json
+      TO_S
+    end
+  end
+  
+  describe 'clear_index' do
+    before(:each) do
+      @bundle.instance_variable_set(:@index, :not_empty)
+    end
+    it 'has not cleared the index' do
+      @bundle.index.should == :not_empty
+    end
+    it 'clears the index' do
+      @bundle.clear_index
+      
+      @bundle.index.should be_empty
+    end
+  end
+  describe 'clear_weights' do
+    before(:each) do
+      @bundle.instance_variable_set(:@weights, :not_empty)
+    end
+    it 'has not cleared the weights' do
+      @bundle.weights.should == :not_empty
+    end
+    it 'clears the weights' do
+      @bundle.clear_weights
+      
+      @bundle.weights.should be_empty
+    end
+  end
+  describe 'clear_similarity' do
+    before(:each) do
+      @bundle.instance_variable_set(:@similarity, :not_empty)
+    end
+    it 'has not cleared the similarity index' do
+      @bundle.similarity.should == :not_empty
+    end
+    it 'clears the similarity index' do
+      @bundle.clear_similarity
+      
+      @bundle.similarity.should be_empty
+    end
+  end
+  describe 'clear_configuration' do
+    before(:each) do
+      @bundle.instance_variable_set(:@configuration, :not_empty)
+    end
+    it 'has not cleared the similarity index' do
+      @bundle.configuration.should == :not_empty
+    end
+    it 'clears the similarity index' do
+      @bundle.clear_configuration
+      
+      @bundle.configuration.should be_empty
+    end
+  end
 
   describe 'identifier' do
     it 'should return a specific identifier' do

data/spec/lib/internals/indexing/bundle/memory_spec.rb

@@ -10,34 +10,50 @@ describe Internals::Indexing::Bundle::Memory do
     @partial     = stub :partial
     @weights     = stub :weights
     @similarity  = stub :similarity
-    @index       = described_class.new :some_name, @configuration, @similarity, @partial, @weights
   end
-
+  let(:index) { described_class.new :some_name, @configuration, @similarity, @partial, @weights }
+  
+  describe 'raise_cache_missing' do
+    it 'does something' do
+      expect {
+        index.raise_cache_missing :similarity
+      }.to raise_error("Error: The similarity cache for some_index:some_category:some_name is missing.")
+    end
+  end
+  
+  describe 'warn_cache_small' do
+    it 'warns the user' do
+      index.should_receive(:warn).once.with "Warning: similarity cache for some_index:some_category:some_name smaller than 16 bytes."
+      
+      index.warn_cache_small :similarity
+    end
+  end
+  
   describe 'identifier' do
     it 'should return a specific identifier' do
-      @index.identifier.should == 'some_index:some_category:some_name'
+      index.identifier.should == 'some_index:some_category:some_name'
     end
   end
   
   describe 'initialize_index_for' do
     context 'token not yet assigned' do
       before(:each) do
-        @index.stub! :index => {}
+        index.stub! :index => {}
       end
       it 'should assign it an empty array' do
-        @index.initialize_index_for :some_token
+        index.initialize_index_for :some_token
 
-        @index.index[:some_token].should == []
+        index.index[:some_token].should == []
       end
     end
     context 'token already assigned' do
       before(:each) do
-        @index.stub! :index => { :some_token => :already_assigned }
+        index.stub! :index => { :some_token => :already_assigned }
       end
       it 'should not assign it anymore' do
-        @index.initialize_index_for :some_token
+        index.initialize_index_for :some_token
 
-        @index.index[:some_token].should == :already_assigned
+        index.index[:some_token].should == :already_assigned
       end
     end
   end
@@ -46,123 +62,123 @@ describe Internals::Indexing::Bundle::Memory do
     before(:each) do
       files = stub :files
       files.should_receive(:retrieve).once.and_yield '  1234', :some_token
-      @index.stub! :files => files
+      index.stub! :files => files
       
       @ary = stub :ary
       @internal_index.should_receive(:[]).any_number_of_times.and_return @ary
-      @index.stub! :index => @internal_index
+      index.stub! :index => @internal_index
     end
     context 'id key format' do
       before(:each) do
-        @index.should_receive(:[]).once.with(:key_format).and_return :to_i
+        index.should_receive(:[]).once.with(:key_format).and_return :to_i
       end
       it 'should call the other methods correctly' do
         @ary.should_receive(:<<).once.with 1234
         
-        @index.retrieve
+        index.retrieve
       end
     end
     context 'other key format' do
       before(:each) do
-        @index.should_receive(:[]).once.with(:key_format).and_return :strip
+        index.should_receive(:[]).once.with(:key_format).and_return :strip
       end
       it 'should call the other methods correctly' do
         @ary.should_receive(:<<).once.with '1234'
         
-        @index.retrieve
+        index.retrieve
       end
     end
     context 'no key format - default' do
       before(:each) do
-        @index.should_receive(:[]).once.with(:key_format).and_return nil
+        index.should_receive(:[]).once.with(:key_format).and_return nil
       end
       it 'should call the other methods correctly' do
         @ary.should_receive(:<<).once.with 1234
         
-        @index.retrieve
+        index.retrieve
       end
     end
   end
 
   describe 'load_from_index_file' do
     it 'should call two methods in order' do
-      @index.should_receive(:load_from_index_generation_message).once.ordered
-      @index.should_receive(:clear).once.ordered
-      @index.should_receive(:retrieve).once.ordered
+      index.should_receive(:load_from_index_generation_message).once.ordered
+      index.should_receive(:clear).once.ordered
+      index.should_receive(:retrieve).once.ordered
 
-      @index.load_from_index_file
+      index.load_from_index_file
     end
   end
 
   describe 'generate_derived' do
     it 'should call two methods in order' do
-      @index.should_receive(:generate_weights).once.ordered
-      @index.should_receive(:generate_similarity).once.ordered
+      index.should_receive(:generate_weights).once.ordered
+      index.should_receive(:generate_similarity).once.ordered
 
-      @index.generate_derived
+      index.generate_derived
     end
   end
 
   describe 'generate_caches_from_memory' do
     it 'should call two methods in order' do
-      @index.should_receive(:cache_from_memory_generation_message).once.ordered
-      @index.should_receive(:generate_derived).once.ordered
+      index.should_receive(:cache_from_memory_generation_message).once.ordered
+      index.should_receive(:generate_derived).once.ordered
 
-      @index.generate_caches_from_memory
+      index.generate_caches_from_memory
     end
   end
 
   describe 'generate_caches_from_source' do
     it 'should call two methods in order' do
-      @index.should_receive(:load_from_index_file).once.ordered
-      @index.should_receive(:generate_caches_from_memory).once.ordered
+      index.should_receive(:load_from_index_file).once.ordered
+      index.should_receive(:generate_caches_from_memory).once.ordered
 
-      @index.generate_caches_from_source
+      index.generate_caches_from_source
     end
   end
   
   describe 'dump' do
     it 'should trigger dumps' do
-      @index.should_receive(:dump_index).once.with
-      @index.should_receive(:dump_weights).once.with
-      @index.should_receive(:dump_similarity).once.with
-      @index.should_receive(:dump_configuration).once.with
+      index.should_receive(:dump_index).once.with
+      index.should_receive(:dump_weights).once.with
+      index.should_receive(:dump_similarity).once.with
+      index.should_receive(:dump_configuration).once.with
       
-      @index.dump
+      index.dump
     end
   end
 
   describe 'raise_unless_cache_exists' do
     it "calls methods in order" do
-      @index.should_receive(:raise_unless_index_exists).once.ordered
-      @index.should_receive(:raise_unless_similarity_exists).once.ordered
+      index.should_receive(:raise_unless_index_exists).once.ordered
+      index.should_receive(:raise_unless_similarity_exists).once.ordered
       
-      @index.raise_unless_cache_exists
+      index.raise_unless_cache_exists
     end
   end
   describe 'raise_unless_index_exists' do
     context 'partial strategy saved' do
       before(:each) do
         strategy = stub :strategy, :saved? => true
-        @index.stub! :partial_strategy => strategy
+        index.stub! :partial_strategy => strategy
       end
       it "calls the methods in order" do
-        @index.should_receive(:warn_if_index_small).once.ordered
-        @index.should_receive(:raise_unless_index_ok).once.ordered
+        index.should_receive(:warn_if_index_small).once.ordered
+        index.should_receive(:raise_unless_index_ok).once.ordered
         
-        @index.raise_unless_index_exists
+        index.raise_unless_index_exists
       end
     end
     context 'partial strategy not saved' do
       before(:each) do
         strategy = stub :strategy, :saved? => false
-        @index.stub! :partial_strategy => strategy
+        index.stub! :partial_strategy => strategy
       end
       it "calls nothing" do
-        @index.should_receive(:warn_if_index_small).never
-        @index.should_receive(:raise_unless_index_ok).never
+        index.should_receive(:warn_if_index_small).never
+        index.should_receive(:raise_unless_index_ok).never
         
-        @index.raise_unless_index_exists
+        index.raise_unless_index_exists
       end
     end
   end
@@ -170,40 +186,40 @@ describe Internals::Indexing::Bundle::Memory do
     context 'similarity strategy saved' do
       before(:each) do
         strategy = stub :strategy, :saved? => true
-        @index.stub! :similarity_strategy => strategy
+        index.stub! :similarity_strategy => strategy
       end
       it "calls the methods in order" do
-        @index.should_receive(:warn_if_similarity_small).once.ordered
-        @index.should_receive(:raise_unless_similarity_ok).once.ordered
+        index.should_receive(:warn_if_similarity_small).once.ordered
+        index.should_receive(:raise_unless_similarity_ok).once.ordered
         
-        @index.raise_unless_similarity_exists
+        index.raise_unless_similarity_exists
       end
     end
     context 'similarity strategy not saved' do
       before(:each) do
         strategy = stub :strategy, :saved? => false
-        @index.stub! :similarity_strategy => strategy
+        index.stub! :similarity_strategy => strategy
       end
       it "calls nothing" do
-        @index.should_receive(:warn_if_similarity_small).never
-        @index.should_receive(:raise_unless_similarity_ok).never
+        index.should_receive(:warn_if_similarity_small).never
+        index.should_receive(:raise_unless_similarity_ok).never
         
-        @index.raise_unless_similarity_exists
+        index.raise_unless_similarity_exists
       end
     end
   end
   describe 'warn_if_similarity_small' do
     before(:each) do
-      @files = @index.files
+      @files = index.files
     end
     context "files similarity cache small" do
       before(:each) do
         @files.stub! :similarity_cache_small? => true
       end
       it "warns" do
-        @index.should_receive(:warn_cache_small).once.with :similarity
+        index.should_receive(:warn_cache_small).once.with :similarity
         
-        @index.warn_if_similarity_small
+        index.warn_if_similarity_small
       end
     end
     context "files similarity cache not small" do
@@ -211,24 +227,24 @@ describe Internals::Indexing::Bundle::Memory do
         @files.stub! :similarity_cache_small? => false
       end
       it "does not warn" do
-        @index.should_receive(:warn_cache_small).never
+        index.should_receive(:warn_cache_small).never
         
-        @index.warn_if_similarity_small
+        index.warn_if_similarity_small
       end
     end
   end
   describe 'raise_unless_similarity_ok' do
     before(:each) do
-      @files = @index.files
+      @files = index.files
     end
     context "files similarity cache ok" do
       before(:each) do
         @files.stub! :similarity_cache_ok? => true
       end
       it "warns" do
-        @index.should_receive(:raise_cache_missing).never
+        index.should_receive(:raise_cache_missing).never
         
-        @index.raise_unless_similarity_ok
+        index.raise_unless_similarity_ok
       end
     end
     context "files similarity cache not ok" do
@@ -236,34 +252,34 @@ describe Internals::Indexing::Bundle::Memory do
         @files.stub! :similarity_cache_ok? => false
       end
       it "does not warn" do
-        @index.should_receive(:raise_cache_missing).once.with :similarity
+        index.should_receive(:raise_cache_missing).once.with :similarity
         
-        @index.raise_unless_similarity_ok
+        index.raise_unless_similarity_ok
       end
     end
   end
   
   describe 'initialization' do
     it 'should initialize the index correctly' do
-      @index.index.should == {}
+      index.index.should == {}
     end
     it 'should initialize the weights index correctly' do
-      @index.weights.should == {}
+      index.weights.should == {}
     end
     it 'should initialize the similarity index correctly' do
-      @index.similarity.should == {}
+      index.similarity.should == {}
     end
     it 'should initialize the configuration correctly' do
-      @index.configuration.should == {}
+      index.configuration.should == {}
     end
     it 'should initialize the partial strategy correctly' do
-      @index.partial_strategy.should == @partial
+      index.partial_strategy.should == @partial
     end
     it 'should initialize the weights strategy correctly' do
-      @index.weights_strategy.should == @weights
+      index.weights_strategy.should == @weights
     end
     it 'should initialize the similarity strategy correctly' do
-      @index.similarity_strategy.should == @similarity
+      index.similarity_strategy.should == @similarity
     end
   end