picky 0.10.5 → 0.11.0

data/spec/lib/indexing/bundle_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+
+describe Indexing::Bundle do
+
+  before(:each) do
+    @category    = stub :category, :name => :some_category
+    @type        = stub :type, :name => :some_type
+    @partial     = stub :partial
+    @weights     = stub :weights
+    @similarity  = stub :similarity
+    @index_class = Indexing::Bundle
+    @index       = @index_class.new :some_name, @category, @type, @partial, @weights, @similarity
+  end
+
+  describe 'identifier' do
+    it 'should return a specific identifier' do
+      @index.identifier.should == 'some_name: some_type some_category'
+    end
+  end
+  
+  describe 'initialize_index_for' do
+    context 'token not yet assigned' do
+      before(:each) do
+        @index.stub! :index => {}
+      end
+      it 'should assign it an empty array' do
+        @index.initialize_index_for :some_token
+
+        @index.index[:some_token].should == []
+      end
+    end
+    context 'token already assigned' do
+      before(:each) do
+        @index.stub! :index => { :some_token => :already_assigned }
+      end
+      it 'should not assign it anymore' do
+        @index.initialize_index_for :some_token
+
+        @index.index[:some_token].should == :already_assigned
+      end
+    end
+  end
+  
+  # TODO
+  #
+  # describe 'retrieve' do
+  #   it 'should call the other methods correctly' do
+  #     results = stub :results
+  #     @index.stub! :execute_query => results
+  #     @index.should_receive(:extract).once.with results
+  #     
+  #     @index.retrieve
+  #   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.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.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.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.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_similarity).once.with
+      @index.should_receive(:dump_weights).once.with
+      
+      @index.dump
+    end
+  end
+  
+  describe 'raise_unless_cache_exists' do
+    before(:each) do
+      @files = stub :files
+      @files.stub! :index_cache_ok? => true
+      @files.stub! :similarity_cache_ok? => true
+      @files.stub! :weights_cache_ok? => true
+      @files.stub! :index_cache_small? => false
+      @files.stub! :similarity_cache_small? => false
+      @files.stub! :weights_cache_small? => false
+      
+      @index.stub! :files => @files
+    end
+    context 'weights cache missing' do
+      before(:each) do
+        @files.stub! :weights_cache_ok? => false
+      end
+      it 'should raise' do
+        lambda do
+          @index.raise_unless_cache_exists
+        end.should raise_error("weights cache for some_name: some_type some_category missing.")
+      end
+    end
+    context 'similarity cache missing' do
+      before(:each) do
+        @files.stub! :similarity_cache_ok? => false
+      end
+      it 'should raise' do
+        lambda do
+          @index.raise_unless_cache_exists
+        end.should raise_error("similarity cache for some_name: some_type some_category missing.")
+      end
+    end
+    context 'index cache missing' do
+      before(:each) do
+        @files.stub! :index_cache_ok? => false
+      end
+      it 'should raise' do
+        lambda do
+          @index.raise_unless_cache_exists
+        end.should raise_error("index cache for some_name: some_type some_category missing.")
+      end
+    end
+  end
+  
+  describe 'initialization' do
+    before(:each) do
+      @category = stub :category, :name => :some_category
+      @type     = stub :type, :name => :some_type
+      
+      @index = @index_class.new :some_name, @category, @type, :similarity, :partial, :weights
+    end
+    it 'should initialize the index correctly' do
+      @index.index.should == {}
+    end
+    it 'should initialize the weights index correctly' do
+      @index.weights.should == {}
+    end
+    it 'should initialize the similarity index correctly' do
+      @index.similarity.should == {}
+    end
+    it 'should initialize the partial strategy correctly' do
+      @index.partial_strategy.should == :partial
+    end
+    it 'should initialize the weights strategy correctly' do
+      @index.weights_strategy.should == :weights
+    end
+    it 'should initialize the similarity strategy correctly' do
+      @index.similarity_strategy.should == :similarity
+    end
+  end
+
+end

data/spec/lib/{query/combinator_spec.rb → indexing/categories_spec.rb}

@@ -1,61 +1,57 @@
 require 'spec_helper'
 
-describe Query::Combinator do
+describe Index::Categories do
   
   context 'with option ignore_unassigned_tokens' do
-    before(:each) do
-      @category1 = stub :category1, :name => :category1
-      @category2 = stub :category2, :name => :category2
-      @category3 = stub :category3, :name => :category3
-      @categories = [@category1, @category2, @category3]
-    end
     context 'ignore_unassigned_tokens true' do
       before(:each) do
-        @combinator = Query::Combinator.new @categories, :ignore_unassigned_tokens => true
+        @categories = Index::Categories.new ignore_unassigned_tokens: true
       end
       it 'should return the right value' do
-        @combinator.ignore_unassigned_tokens.should == true
+        @categories.ignore_unassigned_tokens.should == true
       end
     end
     context 'ignore_unassigned_tokens false' do
       before(:each) do
-        @combinator = Query::Combinator.new @categories, :ignore_unassigned_tokens => false
+        @categories = Index::Categories.new ignore_unassigned_tokens: false
       end
       it 'should return the right value' do
-        @combinator.ignore_unassigned_tokens.should == false
+        @categories.ignore_unassigned_tokens.should == false
       end
     end
   end
   
   context "with real categories" do
     before(:each) do
-      @type1     = stub :type1, :name => :some_type
+      @type1 = stub :type1, :name => :some_type
       
-      @category1 = Index::Category.new :some_name, @type1
-      @category2 = Index::Category.new :some_name, @type1
-      @category3 = Index::Category.new :some_name, @type1
-      @categories = [@category1, @category2, @category3]
-      
-      @combinator = Query::Combinator.new @categories
+      @categories = Index::Categories.new
+      @categories << Index::Category.new(:category1, @type1)
+      @categories << Index::Category.new(:category2, @type1)
+      @categories << Index::Category.new(:category3, @type1)
     end
     describe "similar_possible_for" do
       before(:each) do
         @token = Query::Token.processed 'similar~'
       end
       it "returns possible categories" do
-        @combinator.similar_possible_for(@token).should == []
+        @categories.similar_possible_for(@token).should == []
       end
     end
   end
   
   context 'without options' do
     before(:each) do
-      @category1 = stub :category1, :name => :category1
-      @category2 = stub :category2, :name => :category2
-      @category3 = stub :category3, :name => :category3
-      @categories = [@category1, @category2, @category3]
+      @type1 = stub :type1, :name => :some_type
+      
+      @category1 = Index::Category.new :category1, @type1
+      @category2 = Index::Category.new :category2, @type1
+      @category3 = Index::Category.new :category3, @type1
       
-      @combinator = Query::Combinator.new @categories
+      @categories = Index::Categories.new
+      @categories << @category1
+      @categories << @category2
+      @categories << @category3
     end
     
     describe "possible_combinations_for" do
@@ -67,9 +63,9 @@ describe Query::Combinator do
           @token.stub :similar? => true
         end
         it "calls the right method" do
-          @combinator.should_receive(:similar_possible_for).once.with @token
+          @categories.should_receive(:similar_possible_for).once.with @token
           
-          @combinator.possible_combinations_for @token
+          @categories.possible_combinations_for @token
         end
       end
       context "with non-similar token" do
@@ -77,9 +73,9 @@ describe Query::Combinator do
           @token.stub :similar? => false
         end
         it "calls the right method" do
-          @combinator.should_receive(:possible_for).once.with @token
+          @categories.should_receive(:possible_for).once.with @token
           
-          @combinator.possible_combinations_for @token
+          @categories.possible_combinations_for @token
         end
       end
     end
@@ -96,7 +92,7 @@ describe Query::Combinator do
               @category2.stub! :combination_for => @combination
             end
             it 'should return the right combinations' do
-              @combinator.possible_for(@token).should == [@combination]
+              @categories.possible_for(@token).should == [@combination]
             end
           end
           context 'combination does not exist' do
@@ -104,7 +100,7 @@ describe Query::Combinator do
               @category2.stub! :combination_for => nil
             end
             it 'should return the right combinations' do
-              @combinator.possible_for(@token).should == []
+              @categories.possible_for(@token).should == []
             end
           end
         end
@@ -123,7 +119,7 @@ describe Query::Combinator do
           @token = stub :token, :user_defined_category_name => :category2
         end
         it 'should return the right categories' do
-          @combinator.possible_categories(@token).should == [@category2]
+          @categories.possible_categories(@token).should == [@category2]
         end
       end
       context 'user defined does not exist' do
@@ -131,7 +127,7 @@ describe Query::Combinator do
           @token = stub :token, :user_defined_category_name => nil
         end
         it 'should return all categories' do
-          @combinator.possible_categories(@token).should == @categories
+          @categories.possible_categories(@token).should == [@category1, @category2, @category3]
         end
       end
     end
@@ -142,7 +138,7 @@ describe Query::Combinator do
           @token = stub :token, :user_defined_category_name => :category2
         end
         it 'should return the right categories' do
-          @combinator.user_defined_categories(@token).should == [@category2]
+          @categories.user_defined_categories(@token).should == [@category2]
         end
       end
       context 'category does not exist' do
@@ -150,7 +146,7 @@ describe Query::Combinator do
           @token = stub :token, :user_defined_category_name => :gnoergel
         end
         it 'should return nil' do
-          @combinator.user_defined_categories(@token).should == nil
+          @categories.user_defined_categories(@token).should == nil
         end
       end
     end

data/spec/lib/indexing/category_spec.rb

@@ -0,0 +1,257 @@
+require 'spec_helper'
+describe Indexing::Category do
+  
+  context "unit specs" do
+    before(:each) do
+      @type = stub :some_type, :name => :some_type
+      @category = Indexing::Category.new :some_name, @type
+      @exact = @category.exact
+      @partial = @category.partial
+    end
+    describe 'dump_caches' do
+      before(:each) do
+        @exact.stub! :dump
+        @partial.stub! :dump
+      end
+      it 'should dump the exact index' do
+        @exact.should_receive(:dump).once.with
+
+        @category.dump_caches
+      end
+      it 'should dump the partial index' do
+        @partial.should_receive(:dump).once.with
+
+        @category.dump_caches
+      end
+    end
+
+    describe 'generate_derived_partial' do
+      it 'should delegate to partial' do
+        @partial.should_receive(:generate_derived).once.with
+
+        @category.generate_derived_partial
+      end
+    end
+
+    describe 'generate_derived_exact' do
+      it 'should delegate to exact' do
+        @exact.should_receive(:generate_derived).once.with
+
+        @category.generate_derived_exact
+      end
+    end
+
+    describe 'generate_indexes_from_exact_index' do
+      it 'should call three method in order' do
+        @category.should_receive(:generate_derived_exact).once.with().ordered
+        @category.should_receive(:generate_partial).once.with().ordered
+        @category.should_receive(:generate_derived_partial).once.with().ordered
+
+        @category.generate_indexes_from_exact_index
+      end
+    end
+    
+    describe 'generate_caches_from_memory' do
+      it 'should delegate to partial' do
+        @partial.should_receive(:generate_caches_from_memory).once.with
+
+        @category.generate_caches_from_memory
+      end
+    end
+
+    describe 'generate_partial' do
+      it 'should return whatever the partial generation returns' do
+        @exact.stub! :index
+        @partial.stub! :generate_partial_from => :generation_returns
+
+        @category.generate_partial
+      end
+      it 'should use the exact index to generate the partial index' do
+        exact_index = stub :exact_index
+        @exact.stub! :index => exact_index
+        @partial.should_receive(:generate_partial_from).once.with(exact_index)
+
+        @category.generate_partial
+      end
+    end
+
+    describe 'generate_caches_from_source' do
+      it 'should delegate to exact' do
+        @exact.should_receive(:generate_caches_from_source).once.with
+
+        @category.generate_caches_from_source
+      end
+    end
+
+    describe 'generate_caches' do
+      it 'should call multiple methods in order' do
+        @category.should_receive(:generate_caches_from_source).once.with().ordered
+        @category.should_receive(:generate_partial).once.with().ordered
+        @category.should_receive(:generate_caches_from_memory).once.with().ordered
+        @category.should_receive(:dump_caches).once.with().ordered
+        @category.should_receive(:timed_exclaim).once.ordered
+        
+        @category.generate_caches
+      end
+    end
+    
+    describe "virtual?" do
+      context "with virtual true" do
+        before(:each) do
+          @category = Indexing::Category.new :some_name, @type, virtual: true
+        end
+        it "returns the right value" do
+          @category.virtual?.should == true
+        end
+      end
+      context "with virtual object" do
+        before(:each) do
+          @category = Indexing::Category.new :some_name, @type, :virtual => 123.6
+        end
+        it "returns the right value" do
+          @category.virtual?.should == true
+        end
+      end
+      context "with virtual nil" do
+        before(:each) do
+          @category = Indexing::Category.new :some_name, @type, :virtual => nil
+        end
+        it "returns the right value" do
+          @category.virtual?.should == false
+        end
+      end
+      context "with virtual false" do
+        before(:each) do
+          @category = Indexing::Category.new :some_name, @type, :virtual => false
+        end
+        it "returns the right value" do
+          @category.virtual?.should == false
+        end
+      end
+    end
+    describe "tokenizer" do
+      context "with specific tokenizer" do
+        before(:each) do
+          @category = Indexing::Category.new :some_name, @type, tokenizer: Tokenizers::Index.new
+        end
+        it "caches" do
+          @category.tokenizer.should == @category.tokenizer
+        end
+        it "returns an instance" do
+          @category.tokenizer.should be_kind_of(Tokenizers::Index)
+        end
+      end
+    end
+    describe "indexer" do
+      context "with default indexer" do
+        before(:each) do
+          @category = Indexing::Category.new :some_name, @type
+        end
+        it "caches" do
+          @category.indexer.should == @category.indexer
+        end
+      end
+      context "with specific indexer" do
+        before(:each) do
+          @category = Indexing::Category.new :some_name, @type, tokenizer: Indexers::Default
+        end
+        it "caches" do
+          @category.indexer.should == @category.indexer
+        end
+        it "returns an instance" do
+          @category.indexer.should be_kind_of(Indexers::Default)
+        end
+        it "creates a new instance of the right class" do
+          Indexers::Default.should_receive(:new).once.with @type, @category
+          
+          @category.indexer
+        end
+      end
+    end
+    describe "cache" do
+      before(:each) do
+        @category = Indexing::Category.new :some_name, @type
+        @category.stub! :prepare_cache_directory
+        
+        @category.stub! :generate_caches
+      end
+      it "prepares the cache directory" do
+        @category.should_receive(:prepare_cache_directory).once.with
+        
+        @category.cache
+      end
+      it "tells the indexer to index" do
+        @category.should_receive(:generate_caches).once.with
+        
+        @category.cache
+      end
+    end
+    describe "prepare_cache_directory" do
+      before(:each) do
+        @category = Indexing::Category.new :some_name, @type
+        
+        @category.stub! :cache_directory => :some_cache_directory
+      end
+      it "tells the FileUtils to mkdir_p" do
+        FileUtils.should_receive(:mkdir_p).once.with :some_cache_directory
+        
+        @category.prepare_cache_directory
+      end
+    end
+    describe "index" do
+      before(:each) do
+        @category = Indexing::Category.new :some_name, @type
+        @category.stub! :prepare_cache_directory
+        
+        @indexer = stub :indexer, :index => nil
+        @category.stub! :indexer => @indexer
+      end
+      it "prepares the cache directory" do
+        @category.should_receive(:prepare_cache_directory).once.with
+        
+        @category.index
+      end
+      it "tells the indexer to index" do
+        @indexer.should_receive(:index).once.with
+        
+        @category.index
+      end
+    end
+    describe "source" do
+      context "with source" do
+        before(:each) do
+          @category = Indexing::Category.new :some_name, @type, :source => :some_given_source
+        end
+        it "returns the given source" do
+          @category.source.should == :some_given_source
+        end
+      end
+      context "without source" do
+        before(:each) do
+          @type = stub :type, :name => :some_type, :source => :some_type_source
+          
+          @category = Indexing::Category.new :some_name, @type
+        end
+        it "returns the type's source" do
+          @category.source.should == :some_type_source
+        end
+      end
+    end
+    context "name symbol" do
+      before(:each) do
+        @category = Indexing::Category.new :some_name, @type
+      end
+      describe "search_index_file_name" do
+        it "returns the right file name" do
+          @category.search_index_file_name.should == 'some/search/root/index/test/some_type/prepared_some_name_index.txt'
+        end
+      end
+    end
+    context "name string" do
+      it "works" do
+        @category = Indexing::Category.new 'some_name', @type
+      end
+    end
+  end
+  
+end

data/spec/lib/indexing/type_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Indexing::Type do
+  
+  context "with categories" do
+    before(:each) do
+      @source = stub :some_source
+      
+      @categories = stub :categories
+      
+      @index = Indexing::Type.new :some_name, @source
+      @index.add_category :some_category_name1
+      @index.add_category :some_category_name2
+      
+      @index.stub! :categories => @categories
+    end
+    describe "generate_caches" do
+      it "delegates to each category" do
+        @categories.should_receive(:generate_caches).once.with
+        
+        @index.generate_caches
+      end
+    end
+  end
+  
+  context "no categories" do
+    it "works" do
+      Indexing::Type.new :some_name, @source
+    end
+  end
+  
+end

data/spec/lib/loader_spec.rb

@@ -4,8 +4,6 @@ describe Loader do
 
   before(:each) do
     @loader_path = File.absolute_path("#{File.dirname(__FILE__)}/../../lib/picky/loader.rb")
-    Configuration.stub! :apply
-    Indexes.stub! :setup
   end
   
   describe 'load_application' do

data/spec/lib/query/base_spec.rb

@@ -107,11 +107,16 @@ describe 'Query::Base' do
     end
   end
   
+  before(:each) do
+    @type      = stub :type
+    @index     = stub :some_index, :index => @type
+  end
+  
   describe 'initializer' do
     context 'with tokenizer' do
       before(:each) do
         @tokenizer = stub :tokenizer, :tokenize => :some_tokenized_text
-        @query     = Query::Full.new 'some query', :some_index, :tokenizer => @tokenizer
+        @query     = Query::Full.new @index, tokenizer: @tokenizer
       end
       it 'should tokenize using the tokenizer' do
         @query.tokenized('some text').should == :some_tokenized_text
@@ -122,7 +127,7 @@ describe 'Query::Base' do
   describe "results_from" do
     describe 'Full' do
       before(:each) do
-        @query = Query::Full.new 'some query', :some_index
+        @query = Query::Full.new @index
       end
       it "should work" do
         allocations = stub :allocations, :process! => true
@@ -132,7 +137,7 @@ describe 'Query::Base' do
     end
     describe 'Live' do
       before(:each) do
-        @query = Query::Live.new 'some query', :some_index
+        @query = Query::Live.new @index
       end
       it "should work" do
         allocations = stub :allocations, :process! => true
@@ -142,18 +147,4 @@ describe 'Query::Base' do
     end
   end
 
-  describe "sorted_allocations" do
-    before(:each) do
-      @index_class = stub :index_class
-      @query = Query::Base.new @index_class
-    end
-    it "should generate the right kind of allocations" do
-      tokens = @query.tokenized 'some query'
-      
-      @index_class.stub! :possible_combinations => []
-      
-      @query.sorted_allocations(tokens).should be_kind_of(Query::Allocations)
-    end
-  end
-
 end