picky 2.3.0 → 2.4.0

data/lib/picky/index/base.rb

@@ -21,6 +21,7 @@ module Index
     # * result_identifier: Use if you'd like a different identifier/name in the results than the name of the index.
     # * after_indexing: As of this writing only used in the db source. Executes the given after_indexing as SQL after the indexing process.
     # * tokenizer: The tokenizer to use for this index. Optional, can be defined in the block using #indexing.
+    # * key_format: The format the ids of this index are in. Optional, can be defined in the block using #key_format.
     #
     # Examples:
     #   my_index = Index::Memory.new(:my_index, source: some_source) do
@@ -139,6 +140,17 @@ INDEX
     end
     alias define_source source
 
+    # Define a key_format on the index.
+    #
+    # Parameter is a source, either one of the standard sources or
+    # anything responding to #each and returning objects that
+    # respond to id and the category names (or the category from option).
+    #
+    def key_format key_format
+      internal_indexing.define_key_format key_format
+    end
+    alias define_key_format key_format
+
     # Defines a searchable category on the index.
     #
     # === Parameters

data/lib/picky/internals/indexers/base.rb

@@ -15,14 +15,6 @@ module Indexers
       process
     end
 
-    # Delegates the key format to the source.
-    #
-    # Default is to_i.
-    #
-    def key_format
-      source.respond_to?(:key_format) && source.key_format || :to_i
-    end
-
   end
 
 end

data/lib/picky/internals/indexing/bundle/base.rb

@@ -80,7 +80,7 @@ module Internals
           key_format = self[:key_format] || :to_i
           files.retrieve do |id, token|
             initialize_index_for token
-            index[token] << id.send(key_format) # TODO Rewrite. Move this into the specific indexing.
+            index[token] << id.send(key_format)
           end
         end
 

data/lib/picky/internals/indexing/category.rb

@@ -21,14 +21,16 @@ module Internals
       #  * source: Use if the category should use a different source.
       #  * weights: Query::Weights.new( [:category1, :category2] => +2, ... )
       #  * tokenizer: Use a subclass of Tokenizers::Base that implements #tokens_for and #empty_tokens.
+      #  * key_format: What this category's keys are formatted with (default is :to_i)
       #
       def initialize name, index, options = {}
         @name  = name
         @index = index
 
-        @source    = options[:source]
-        @from      = options[:from]
-        @tokenizer = options[:tokenizer]
+        @source     = options[:source]
+        @from       = options[:from]
+        @tokenizer  = options[:tokenizer]
+        @key_format = options[:key_format]
 
         # TODO Push into Bundle. At least the weights.
         #
@@ -46,6 +48,16 @@ module Internals
       def source
         @source || @index.source
       end
+      # Return the key format.
+      #
+      # If the source has no key format, then
+      # check for an explicit key format, and
+      # if none is defined, ask the index for
+      # one.
+      #
+      def key_format
+        source.respond_to?(:key_format) && source.key_format || @key_format || index.key_format
+      end
       # The indexer is lazily generated and cached.
       #
       def indexer
@@ -102,9 +114,8 @@ module Internals
       # Uses the one defined in the indexer.
       #
       def configure
-        key_format = indexer.key_format
-        exact[:key_format] = key_format
-        partial[:key_format] = key_format
+        exact[:key_format] = self.key_format
+        partial[:key_format] = self.key_format
       end
       def generate_caches
         generate_caches_from_source

data/lib/picky/internals/indexing/index.rb

@@ -28,6 +28,7 @@ module Internals
         @after_indexing = options[:after_indexing]
         @bundle_class   = options[:indexing_bundle_class] # TODO This should actually be a fixed parameter.
         @tokenizer      = options[:tokenizer]
+        @key_format     = options[:key_format]
 
         @categories = []
       end
@@ -71,6 +72,15 @@ Example:
 )
       end
 
+      #
+      #
+      def define_key_format key_format
+        @key_format = key_format
+      end
+      def key_format
+        @key_format || :to_i
+      end
+
       #
       #
       def find category_name

data/spec/lib/internals/indexers/base_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Indexers::Base do
+
+  let(:indexer) { described_class.new }
+  
+  describe 'index' do
+    it 'messages, then processed' do
+      indexer.should_receive(:indexing_message).once.with.ordered
+      indexer.should_receive(:process).once.with.ordered
+      
+      indexer.index
+    end
+  end
+  
+end

data/spec/lib/internals/indexers/serial_spec.rb

@@ -11,25 +11,6 @@ describe Indexers::Serial do
     @indexer.stub! :timed_exclaim
   end
   
-  describe 'key_format' do
-    context 'source has key_format' do
-      before(:each) do
-        @source.stub! :key_format => :some_key_format
-      end
-      it 'returns what the source returns' do
-        @indexer.key_format.should == :some_key_format
-      end
-    end
-    context 'source does not have key_format' do
-      before(:each) do
-        @source.stub! :key_format => nil
-      end
-      it 'returns :to_i' do
-        @indexer.key_format.should == :to_i
-      end
-    end
-  end
-  
   describe "tokenizer" do
     it "returns the right one" do
       @indexer.tokenizer.should == @tokenizer

data/spec/lib/internals/indexing/category_spec.rb

@@ -106,6 +106,43 @@ describe Internals::Indexing::Category do
       end
     end
     
+    describe 'key_format' do
+      context 'source has key_format' do
+        before(:each) do
+          category.stub! :source => stub(:source, :key_format => :some_key_format)
+        end
+        it 'returns that key_format' do
+          category.key_format.should == :some_key_format
+        end
+      end
+      context 'source does not have key_format' do
+        before(:each) do
+          category.stub! :source => stub(:source)
+        end
+        context 'category has its own key_format' do
+          before(:each) do
+            category.instance_variable_set :@key_format, :other_key_format
+          end
+          it 'returns that key_format' do
+            category.key_format.should == :other_key_format
+          end
+        end
+        context 'category does not have its own key format' do
+          before(:each) do
+            category.instance_variable_set :@key_format, nil
+          end
+          context 'it has an index' do
+            before(:each) do
+              category.stub! :index => stub(:index, :key_format => :yet_another_key_format)
+            end
+            it 'returns that key_format' do
+              category.key_format.should == :yet_another_key_format
+            end
+          end
+        end
+      end
+    end
+    
     describe 'source' do
       context 'with explicit source' do
         let(:category) { described_class.new(:some_category, @index, :source => :category_source) }
@@ -121,15 +158,21 @@ describe Internals::Indexing::Category do
       end
     end
     
-    describe "cache" do
+    describe "cache!" do
       before(:each) do
         category.stub! :generate_caches
+        category.stub! :configure
       end
       it "prepares the cache directory" do
         category.should_receive(:prepare_index_directory).once.with
         
         category.cache!
       end
+      it "configures" do
+        category.should_receive(:configure).once.with
+        
+        category.cache!
+      end
       it "tells the indexer to index" do
         category.should_receive(:generate_caches).once.with
         

metadata

@@ -2,7 +2,7 @@
 name: picky
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors: 
 - Florian Hanke
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-17 00:00:00 +10:00
+date: 2011-04-20 00:00:00 +10:00
 default_executable: picky
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 2.3.0
+        version: 2.4.0
   type: :development
   version_requirements: *id002
 description: Fast Ruby semantic text search engine with comfortable single field interface.
@@ -233,6 +233,7 @@ files:
 - spec/lib/internals/indexed/wrappers/bundle/calculation_spec.rb
 - spec/lib/internals/indexed/wrappers/bundle/wrapper_spec.rb
 - spec/lib/internals/indexed/wrappers/exact_first_spec.rb
+- spec/lib/internals/indexers/base_spec.rb
 - spec/lib/internals/indexers/parallel_spec.rb
 - spec/lib/internals/indexers/serial_spec.rb
 - spec/lib/internals/indexing/bundle/memory_partial_generation_speed_spec.rb
@@ -357,6 +358,7 @@ test_files:
 - spec/lib/internals/indexed/wrappers/bundle/calculation_spec.rb
 - spec/lib/internals/indexed/wrappers/bundle/wrapper_spec.rb
 - spec/lib/internals/indexed/wrappers/exact_first_spec.rb
+- spec/lib/internals/indexers/base_spec.rb
 - spec/lib/internals/indexers/parallel_spec.rb
 - spec/lib/internals/indexers/serial_spec.rb
 - spec/lib/internals/indexing/bundle/memory_partial_generation_speed_spec.rb