picky 3.5.4 → 3.6.0

data/lib/picky/category_indexed.rb

@@ -6,13 +6,15 @@ module Picky
 
     # Loads the index from cache.
     #
-    def load_from_cache
+    def load
       timed_exclaim %Q{"#{identifier}": Loading index from cache.}
-      clear_realtime_mapping
+      clear_realtime_mapping # TODO What to do?
       exact.load
       partial.load
     end
-    alias reload load_from_cache
+    # TODO Remove in 4.0.
+    #
+    alias reload load
 
     # Gets the weight for this token's text.
     #

data/lib/picky/category_indexing.rb

@@ -107,14 +107,6 @@ module Picky
       @tokenizer || @index.tokenizer
     end
 
-    # Checks the caches for existence.
-    #
-    def check
-      timed_exclaim "Checking #{identifier}."
-      exact.raise_unless_cache_exists
-      partial.raise_unless_cache_exists
-    end
-
     # Deletes the caches.
     #
     def clear
@@ -123,24 +115,6 @@ module Picky
       partial.delete
     end
 
-    # Backup the caches.
-    # (Revert with restore_caches)
-    #
-    def backup
-      timed_exclaim "Backing up #{identifier}."
-      exact.backup
-      partial.backup
-    end
-
-    # Restore the caches.
-    # (Revert with backup_caches)
-    #
-    def restore
-      timed_exclaim "Restoring #{identifier}."
-      exact.restore
-      partial.restore
-    end
-
   end
 
 end

data/lib/picky/category_realtime.rb

@@ -6,6 +6,7 @@ module Picky
     # given id.
     #
     def remove id
+      id = id.send key_format
       exact.remove id
       partial.remove id
     end
@@ -38,6 +39,7 @@ module Picky
     def add_tokenized_token id, text, where = :unshift
       return unless text
       id = id.send key_format # TODO Speed this up!
+
       # text = text.to_sym if @symbols # TODO Symbols.
       exact.add id, text, where
       partial.add_partialized id, text, where

data/lib/picky/extensions/string.rb

@@ -2,6 +2,26 @@
 #
 class String # :nodoc:all
 
+  # Returns a _single_ double metaphone code
+  # for this string.
+  #
+  def double_metaphone
+    codes = Text::Metaphone.double_metaphone self
+    codes.first unless codes.empty?
+  end
+
+  # Returns a metaphone code for this string.
+  #
+  def metaphone
+    Text::Metaphone.metaphone self
+  end
+
+  # Returns a soundex code for this string.
+  #
+  def soundex
+    Text::Soundex.soundex self
+  end
+
   # 'keys'.each_subtoken    # => yields each of ['keys', 'key', 'ke', 'k']
   # 'keys'.each_subtoken(2) # => yields each of ['keys', 'key', 'ke']
   #

data/lib/picky/extensions/symbol.rb

@@ -2,6 +2,28 @@
 #
 class Symbol # :nodoc:all
 
+  # Returns a _single_ double metaphone code
+  # for this symbol.
+  #
+  def double_metaphone
+    codes = Text::Metaphone.double_metaphone self
+    codes.first.intern unless codes.empty?
+  end
+
+  # Returns a metaphone code for this symbol.
+  #
+  def metaphone
+    code = Text::Metaphone.metaphone self.to_s
+    code.intern if code
+  end
+
+  # Returns a soundex code for this symbol.
+  #
+  def soundex
+    code = Text::Soundex.soundex self.to_s
+    code.intern if code
+  end
+
   # :keys.each_subtoken    # => yields each of [:keys, :key, :ke, :k]
   # :keys.each_subtoken(2) # => yields each of [:keys, :key, :ke]
   #

data/lib/picky/generators/similarity/double_metaphone.rb

@@ -19,8 +19,7 @@ module Picky
         # Returns a symbol.
         #
         def encoded str_or_sym
-          codes = Text::Metaphone.double_metaphone str_or_sym.to_s
-          codes.first.intern unless codes.empty?
+          str_or_sym.double_metaphone
         end
 
       end

data/lib/picky/generators/similarity/metaphone.rb

@@ -19,8 +19,7 @@ module Picky
         # Returns a symbol.
         #
         def encoded str_or_sym
-          code = Text::Metaphone.metaphone str_or_sym.to_s
-          code.intern if code
+          str_or_sym.metaphone
         end
 
       end

data/lib/picky/generators/similarity/phonetic.rb

@@ -23,16 +23,6 @@ module Picky
           @amount = amount
         end
 
-        # # Generates an index for the given index (in exact index style).
-        # #
-        # # In the following form:
-        # # [:meier, :mueller, :peter, :pater] => { MR: [:meier], MLR: [:mueller], PTR: [:peter, :pater] }
-        # #
-        # def generate_from inverted
-        #   hash = hashify inverted.keys
-        #   sort hash
-        # end
-
         protected
 
           # Sorts the index values in place.

data/lib/picky/generators/similarity/soundex.rb

@@ -19,8 +19,7 @@ module Picky
         # Returns a symbol.
         #
         def encoded str_or_sym
-          code = Text::Soundex.soundex str_or_sym.to_s
-          code.intern if code
+          str_or_sym.soundex
         end
 
       end

data/lib/picky/index.rb

@@ -132,11 +132,18 @@ module Picky
     #
     def backend backend = nil
       if backend
-        @backend = backend
+        @backend = reset_backend backend
       else
-        @backend || Backends::Memory.new
+        @backend ||= Backends::Memory.new
       end
     end
+    # TODO Rewrite such that reset_backend just sets the
+    #      lazily evaluated backend to nil.
+    #
+    def reset_backend backend
+      categories.reset_backend backend
+      backend
+    end
 
     # TODO Symbols.
     #

data/lib/picky/index_indexed.rb

@@ -4,15 +4,15 @@ module Picky
   #
   class Index
 
-    attr_reader :combinator
-
-    delegate :load_from_cache,
+    delegate :load,
              :analyze,
              :reindex,
              :possible_combinations,
              :to => :categories
 
-    alias reload load_from_cache
+    # TODO Remove in 4.0.
+    #
+    alias reload load
 
     # Define how the results of this index are identified.
     # (Shown in the client, for example)

data/lib/picky/index_indexing.rb

@@ -4,15 +4,11 @@ module Picky
   #
   class Index
 
-    attr_reader :bundle_class
-
     # Delegators for indexing.
     #
     delegate :cache,
-             :check,
              :clear,
-             :backup,
-             :restore,
+             :prepare,
              :to => :categories
 
     # Calling index on an index will call index

data/lib/picky/indexes_indexed.rb

@@ -4,17 +4,18 @@ module Picky
   #
   class Indexes
 
-    instance_delegate :load_from_cache,
-                      :reload,
+    instance_delegate :load,
                       :analyze
 
-    each_delegate :load_from_cache,
+    each_delegate :load,
+                  :reload,
                   :to => :indexes
 
-    # Reloads all indexes, one after another,
-    # in the order they were added.
+    # TODO Remove in 4.0.
     #
-    alias reload load_from_cache
+    def self.reload
+      self.instance.reload
+    end
 
   end
 

data/lib/picky/indexes_indexing.rb

@@ -5,17 +5,11 @@ module Picky
   class Indexes
 
     instance_delegate :index,
-                      :check,
                       :clear,
-                      :backup,
-                      :restore,
                       :index_for_tests,
                       :tokenizer
 
-    each_delegate :check,
-                  :clear,
-                  :backup,
-                  :restore,
+    each_delegate :clear,
                   :to => :indexes
 
     # Runs the indexers in parallel (prepare + cache).

data/lib/picky/loader.rb

@@ -128,6 +128,9 @@ module Picky
       load_relative 'backends/file/basic'
       load_relative 'backends/file/json'
 
+      load_relative 'backends/sqlite'
+      load_relative 'backends/sqlite/db'
+
       # Indexing and Indexed things.
       #
       load_relative 'bundle'
@@ -264,4 +267,4 @@ module Picky
 
   end
 
-end
+end

data/lib/picky/sources/couch.rb

@@ -32,7 +32,7 @@ module Picky
         @db = RestClient::Resource.new options.delete(:url), options
 
         key_format   = options.delete :key_format
-        @key_format  = key_format && key_format.intern || :to_sym
+        @key_format  = key_format && key_format.intern || :to_s
       end
 
       def to_s

data/lib/picky/sources/mongo.rb

@@ -37,7 +37,7 @@ module Picky
 
   		  @db         = RestClient::Resource.new options.delete(:url), options
   			@database   = options.delete(:db)
-  		  @key_format = options[:key_format] && options[:key_format].intern || :to_sym
+  		  @key_format = options[:key_format] && options[:key_format].intern || :to_s
   		end
 
       # Tries to require the rest_client gem.

data/lib/picky/wrappers/bundle/calculation.rb

@@ -24,7 +24,7 @@ module Picky
           float
         end
 
-        # TODO Symbols.
+        # TODO Symbols. Use a block here?
         #
         def ids float_str
           @bundle.ids calculate(float_str.to_f).to_s

data/lib/picky/wrappers/bundle/exact_partial.rb

@@ -10,22 +10,13 @@ module Picky
       # bundle such that a partial index will not
       # be dumped or generated.
       #
-      class ExactPartial
-
-        attr_reader :bundle
-
-        include Delegator
-        include IndexedDelegator
-
-        def initialize bundle
-          @bundle = bundle
-        end
+      class ExactPartial < Wrapper
 
+        # Ignore these.
+        #
         def clear; end
         def dump; end
         def empty; end
-        def generate_caches_from_memory; end
-        def generate_partial_from arg; end
         def index; end
         def load; end
 

data/lib/picky/wrappers/bundle/location.rb

@@ -52,6 +52,7 @@ module Picky
             bundle.load
 
             # TODO Symbols (of the location_anchor!!!).
+            #      It should always be a Symbol.
             #
             @calculation.anchor = bundle['location_anchor'] && bundle['location_anchor'].to_f || raise("Configuration 'location_anchor' for #{bundle.identifier} missing. Did you run rake index already?")
           end

data/lib/tasks/index.rake

@@ -12,13 +12,9 @@ end
 
 namespace :index do
 
-  # Advanced usage.
-  #
-  # desc "Takes a snapshot, indexes, and caches in random order."
   task :randomly => :application do
     Picky::Indexes.index true
   end
-  # desc "Takes a snapshot, indexes, and caches in order given."
   task :ordered => :application do
     Picky::Indexes.index false
   end

data/spec/lib/backends/file/basic_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Picky::Backends::File::Basic do
-  
+
   context 'without options' do
     let(:basic) { described_class.new 'some/cache/path/to/file' }
 
@@ -10,32 +10,20 @@ describe Picky::Backends::File::Basic do
         basic.empty.should == {}
       end
     end
-    
+
     describe 'initial' do
       it 'returns the container that is used for indexing' do
         basic.initial.should == nil
       end
     end
 
-    describe 'backup_file_path_of' do
-      it 'returns a backup path relative to the path' do
-        basic.backup_file_path_of('some/path/to/some.memory.index').should == 'some/path/to/backup/some.memory.index'
-      end
-    end
-  
-    describe 'backup_directory' do
-      it "returns the cache path's backup path" do
-        basic.backup_directory('some/cache/path/to/file').should == 'some/cache/path/to/backup'
-      end
-    end
-  
     describe 'to_s' do
       it 'returns the cache path with the default file extension' do
         basic.to_s.should == 'Picky::Backends::File::Basic(some/cache/path/to/file.file.index,some/cache/path/to/file.file_mapping.index.memory.json)'
       end
     end
   end
-  
+
   context 'with options' do
     let(:basic) do
       described_class.new 'some/cache/path/to/file',
@@ -48,12 +36,12 @@ describe Picky::Backends::File::Basic do
         basic.empty.should == []
       end
     end
-    
+
     describe 'initial' do
       it 'returns the container that is used for indexing' do
         basic.initial.should == []
       end
     end
   end
-  
+
 end

data/spec/lib/backends/memory/basic_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Picky::Backends::Memory::Basic do
-  
+
   context 'without options' do
     let(:basic) { described_class.new 'some/cache/path/to/file' }
 
@@ -10,32 +10,20 @@ describe Picky::Backends::Memory::Basic do
         basic.empty.should == {}
       end
     end
-    
+
     describe 'initial' do
       it 'returns the container that is used for indexing' do
         basic.initial.should == {}
       end
     end
 
-    describe 'backup_file_path_of' do
-      it 'returns a backup path relative to the path' do
-        basic.backup_file_path_of('some/path/to/some.memory.index').should == 'some/path/to/backup/some.memory.index'
-      end
-    end
-  
-    describe 'backup_directory' do
-      it "returns the cache path's backup path" do
-        basic.backup_directory('some/cache/path/to/file').should == 'some/cache/path/to/backup'
-      end
-    end
-  
     describe 'to_s' do
       it 'returns the cache path with the default file extension' do
         basic.to_s.should == 'Picky::Backends::Memory::Basic(some/cache/path/to/file.memory.index)'
       end
     end
   end
-  
+
   context 'with options' do
     let(:basic) do
       described_class.new 'some/cache/path/to/file',
@@ -48,12 +36,12 @@ describe Picky::Backends::Memory::Basic do
         basic.empty.should == []
       end
     end
-    
+
     describe 'initial' do
       it 'returns the container that is used for indexing' do
         basic.initial.should == []
       end
     end
   end
-  
+
 end

data/spec/lib/backends/redis/basic_spec.rb

@@ -1,19 +1,18 @@
 require 'spec_helper'
 
 describe Picky::Backends::Redis::Basic do
-  
+
   let(:client) { stub :client }
-  
+
   context 'without options' do
     let(:index) { described_class.new client, :some_namespace }
 
-    describe 'load, retrieve, backup, delete' do
+    describe 'load, retrieve, delete' do
       it 'is nothing they do (at least on the backend)' do
         index.should_receive(:client).never
 
         index.load
         index.retrieve
-        index.backup
         index.delete
       end
     end
@@ -30,59 +29,13 @@ describe Picky::Backends::Redis::Basic do
       end
     end
 
-    describe 'cache_small?' do
-      context 'size 0' do
-        before(:each) do
-          index.stub! :size => 0
-        end
-        it 'is small' do
-          index.cache_small?.should == true
-        end
-      end
-      context 'size 1' do
-        before(:each) do
-          index.stub! :size => 1
-        end
-        it 'is not small' do
-          index.cache_small?.should == false
-        end
-      end
-    end
-
-    describe 'cache_ok?' do
-      context 'size 0' do
-        before(:each) do
-          index.stub! :size => 0
-        end
-        it 'is not ok' do
-          index.cache_ok?.should == false
-        end
-      end
-      context 'size 1' do
-        before(:each) do
-          index.stub! :size => 1
-        end
-        it 'is ok' do
-          index.cache_ok?.should == true
-        end
-      end
-    end
-
-    describe "size" do
-      it 'delegates to the backend' do
-        client.should_receive(:dbsize).once.with
-
-        index.size
-      end
-    end
-
     describe 'to_s' do
       it 'returns the cache path with the default file extension' do
         index.to_s.should == 'Picky::Backends::Redis::Basic(some_namespace:*)'
       end
     end
   end
-  
+
   context 'with options' do
     let(:index) do
       described_class.new client,
@@ -103,5 +56,5 @@ describe Picky::Backends::Redis::Basic do
       end
     end
   end
-  
+
 end

data/spec/lib/backends/sqlite/db_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+require 'sqlite3'
+
+describe Picky::Backends::Sqlite::DB do
+
+  context 'hash-based indexes' do
+    let(:db) { described_class.new 'some/cache/path/to/file' }
+
+    describe 'dump' do
+      it 'delegates to the given hash' do
+        hash = stub :hash
+
+        db.should_receive(:dump_sqlite).once.with hash
+
+        db.dump hash
+      end
+    end
+
+    describe 'dump_sqlite' do
+      let(:client) { stub :client }
+      before(:each) do
+        db.stub! :db => client
+      end
+      it 'initializes the client' do
+        client.stub! :execute
+
+        db.should_receive(:lazily_initialize_client).once.with
+
+        db.dump_sqlite Hash.new
+      end
+      it 'executes something' do
+        db.stub! :lazily_initialize_client
+
+        client.should_receive(:execute).at_least(1).times
+
+        db.dump_sqlite Hash.new
+      end
+      it 'inserts keys and values' do
+        db.stub! :lazily_initialize_client
+        client.stub! :execute # We only want to test the insert statements.
+
+        client.should_receive(:execute).once.with 'insert into key_value values (?,?)', 'a', '[1,2,3]'
+        client.should_receive(:execute).once.with 'insert into key_value values (?,?)', 'b', '[4,5,6]'
+
+        db.dump_sqlite :a => [1,2,3], :b => [4,5,6]
+      end
+    end
+
+    describe 'load' do
+      it 'returns a copy of itself' do
+        db.load.should == db
+      end
+      it 'initializes the client' do
+        db.should_receive(:lazily_initialize_client).once.with
+
+        db.load
+      end
+    end
+
+    describe 'empty' do
+      it 'returns the container that is used for indexing' do
+        db.empty.should == {}
+      end
+    end
+
+    describe 'initial' do
+      it 'is correct' do
+        db.initial.should == {}
+      end
+    end
+
+    describe 'to_s' do
+      it 'returns the cache path with the default file extension' do
+        db.to_s.should == 'Picky::Backends::Sqlite::DB(some/cache/path/to/file.sqlite3)'
+      end
+    end
+  end
+
+end