picky 3.6.7 → 3.6.8

data/lib/picky/tokenizer.rb

@@ -135,14 +135,14 @@ Case sensitive?     #{@case_sensitive ? "Yes." : "-"}
       !@case_sensitive
     end
 
-    def maximum_tokens amount
-      @maximum_tokens = amount
+    def max_words amount
+      @max_words = amount
     end
     def cap words
-      words.slice!(@maximum_tokens..-1) if cap?(words)
+      words.slice!(@max_words..-1) if cap?(words)
     end
     def cap? words
-      @maximum_tokens && words.size > @maximum_tokens
+      @max_words && words.size > @max_words
     end
 
     # Checks if the right argument type has been given.
@@ -160,7 +160,7 @@ Case sensitive?     #{@case_sensitive ? "Yes." : "-"}
       stopwords options[:stopwords]                                     if options[:stopwords]
       splits_text_on options[:splits_text_on]                           || /\s/
       normalizes_words options[:normalizes_words]                       if options[:normalizes_words]
-      maximum_tokens options[:maximum_tokens]
+      max_words options[:max_words]
       rejects_token_if &(options[:rejects_token_if]                     || :blank?)
       case_sensitive options[:case_sensitive]                           unless options[:case_sensitive].nil?
     end
@@ -203,7 +203,7 @@ Case sensitive?     #{@case_sensitive ? "Yes." : "-"}
     #
     # Does:
     #  * Split the text into words.
-    #  * Cap the amount of tokens if maximum_tokens is set.
+    #  * Cap the amount of tokens if max_words is set.
     #
     def pretokenize text
       words = split text

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

@@ -7,7 +7,6 @@ module Picky
       module Delegator
 
         delegate :add,
-                 :clear_realtime_mapping,
 
                  :inverted,
                  :weights,
@@ -18,6 +17,8 @@ module Picky
                  :restore,
                  :delete,
 
+                 :reset_backend,
+
                  :raise_unless_cache_exists,
                  :raise_unless_index_exists,
                  :raise_unless_similarity_exists,
@@ -53,6 +54,7 @@ module Picky
                  :clear_weights,
                  :clear_similarity,
                  :clear_configuration,
+                 :clear_realtime,
                  :identifier,
                  :ids,
                  :load,

data/spec/category_realtime_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe Picky::Category, "Realtime API" do
+
+  Thing = Struct.new :id, :text
+
+  let(:category) do
+    index    = Picky::Index.new :some_index_name
+    category = described_class.new :text, index
+  end
+
+  it 'offers an add method' do
+    category.add Thing.new(1, 'text')
+  end
+  it 'offers a remove method' do
+    category.remove 1
+  end
+  it 'offers a replace method' do
+    category.replace Thing.new(1, 'text')
+  end
+  it 'offers a << method' do
+    category << Thing.new(1, 'text')
+  end
+  # it 'offers a >> method' do
+  #   Thing.new(1, 'text') >> category # I mean, as long as we're dreaming.
+  # end
+  it 'offers an unshift method' do
+    category.unshift Thing.new(1, 'text')
+  end
+
+end

data/spec/functional/backends/file_spec.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+# Describes a Picky index that uses the File backend
+# for data storage.
+#
+# TODO Everything should just fail.
+#
+describe Picky::Backends::File do
+
+  class Book
+    attr_reader :id, :title, :author
+    def initialize id, title, author
+      @id, @title, @author = id, title, author
+    end
+  end
+
+  attr_reader :data, :books
+
+  let(:data) do
+    Picky::Index.new(:books) do
+      key_format :to_s # TODO Also make to_i work.
+      source []
+      category :title, partial: Picky::Partial::Postfix.new(from: 1)
+      category :author, similarity: Picky::Generators::Similarity::DoubleMetaphone.new(3)
+    end
+  end
+  let(:books) { Picky::Search.new data }
+
+  its = ->(*) do
+    it 'searching for it' do
+      books.search('title').ids.should == ['1']
+    end
+    it 'searching for it using multiple words' do
+      books.search('title author').ids.should == ['1']
+    end
+    it 'searching for it using partial' do
+      books.search('tit').ids.should == ['1']
+    end
+    it 'searching for it using similarity' do
+      books.search('aothor~').ids.should == ['1']
+    end
+    it 'handles removing' do
+      data.remove 1
+
+      books.search('title').ids.should == []
+    end
+    it 'handles removing with more than one entry' do
+      data.add Book.new(2, 'title', 'author')
+
+      books.search('title').ids.should == ['2', '1'] # TODO Should be ['2', '1']
+
+      data.remove '1'
+
+      books.search('title').ids.should == ['2']
+    end
+    it 'handles removing with three entries' do
+      data.add Book.new(2, 'title', 'author')
+      data.add Book.new(3, 'title', 'author')
+
+      books.search('title').ids.should == ['3', '2', '1'] # TODO Should be ['3', '2', '1']
+
+      data.remove '1'
+
+      books.search('title').ids.should == ['3', '2']
+    end
+    it 'handles replacing' do
+      data.replace Book.new(1, 'toitle', 'oithor')
+
+      books.search('title').ids.should == []
+      books.search('toitle').ids.should == ['1']
+    end
+    it 'handles clearing' do
+      data.clear
+
+      books.search('title').ids.should == []
+    end
+    it 'handles dumping and loading' do
+      data.dump
+      data.load
+
+      books.search('title').ids.should == ['1']
+    end
+  end
+
+  context 'immediately indexing backend (no dump needed)' do
+    before(:each) do
+      data.backend described_class.new
+      data.clear
+
+      data.add Book.new(1, 'title', 'author')
+    end
+
+    instance_eval &its
+  end
+
+end

data/spec/functional/backends/memory_spec.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+# Describes a Picky index that uses the Memory backend
+# for data storage.
+#
+describe Picky::Backends::Memory do
+
+  class Book
+    attr_reader :id, :title, :author
+    def initialize id, title, author
+      @id, @title, @author = id, title, author
+    end
+  end
+
+  attr_reader :data, :books
+
+  let(:data) do
+    Picky::Index.new(:books) do
+      key_format :to_s # TODO Also make to_i work.
+      source []
+      category :title, partial: Picky::Partial::Postfix.new(from: 1)
+      category :author, similarity: Picky::Generators::Similarity::DoubleMetaphone.new(3)
+    end
+  end
+  let(:books) { Picky::Search.new data }
+
+  its = ->(*) do
+    it 'searching for it' do
+      books.search('title').ids.should == ['1']
+    end
+    it 'searching for it using multiple words' do
+      books.search('title author').ids.should == ['1']
+    end
+    it 'searching for it using partial' do
+      books.search('tit').ids.should == ['1']
+    end
+    it 'searching for it using similarity' do
+      books.search('aothor~').ids.should == ['1']
+    end
+    it 'handles removing' do
+      data.remove 1
+
+      books.search('title').ids.should == []
+    end
+    it 'handles removing with more than one entry' do
+      data.add Book.new(2, 'title', 'author')
+
+      books.search('title').ids.should == ['2', '1'] # TODO Should be ['2', '1']
+
+      data.remove '1'
+
+      books.search('title').ids.should == ['2']
+    end
+    it 'handles removing with three entries' do
+      data.add Book.new(2, 'title', 'author')
+      data.add Book.new(3, 'title', 'author')
+
+      books.search('title').ids.should == ['3', '2', '1'] # TODO Should be ['3', '2', '1']
+
+      data.remove '1'
+
+      books.search('title').ids.should == ['3', '2']
+    end
+    it 'handles replacing' do
+      data.replace Book.new(1, 'toitle', 'oithor')
+
+      books.search('title').ids.should == []
+      books.search('toitle').ids.should == ['1']
+    end
+    it 'handles clearing' do
+      data.clear
+
+      books.search('title').ids.should == []
+    end
+    it 'handles dumping and loading' do
+      data.dump
+      data.load
+
+      books.search('title').ids.should == ['1']
+    end
+  end
+
+  context 'immediately indexing backend (no dump needed)' do
+    before(:each) do
+      data.backend described_class.new
+      data.clear
+
+      data.add Book.new(1, 'title', 'author')
+    end
+
+    instance_eval &its
+  end
+
+end

data/spec/functional/backends/redis_spec.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+# Describes a Picky index that uses the Redis backend
+# for data storage.
+#
+describe Picky::Backends::Redis do
+
+  class Book
+    attr_reader :id, :title, :author
+    def initialize id, title, author
+      @id, @title, @author = id, title, author
+    end
+  end
+
+  attr_reader :data, :books
+
+  let(:data) do
+    Picky::Index.new(:books) do
+      key_format :to_s # TODO Also make to_i work.
+      source []
+      category :title, partial: Picky::Partial::Postfix.new(from: 1)
+      category :author, similarity: Picky::Generators::Similarity::DoubleMetaphone.new(3)
+    end
+  end
+  let(:books) { Picky::Search.new data }
+
+  its = ->(*) do
+    it 'searching for it' do
+      books.search('title').ids.should == ['1']
+    end
+    it 'searching for it using multiple words' do
+      books.search('title author').ids.should == ['1']
+    end
+    it 'searching for it using partial' do
+      books.search('tit').ids.should == ['1']
+    end
+    it 'searching for it using similarity' do
+      books.search('aothor~').ids.should == ['1']
+    end
+    it 'handles removing' do
+      data.remove 1
+
+      books.search('title').ids.should == []
+    end
+    it 'handles removing with more than one entry' do
+      data.add Book.new(2, 'title', 'author')
+
+      books.search('title').ids.should == ['2', '1']
+
+      data.remove '1'
+
+      books.search('title').ids.should == ['2']
+    end
+    it 'handles removing with three entries' do
+      data.add Book.new(2, 'title', 'author')
+      data.add Book.new(3, 'title', 'author')
+
+      books.search('title').ids.should == ['3', '2', '1'] # TODO Should be ['3', '2', '1']
+
+      data.remove '1'
+
+      books.search('title').ids.should == ['3', '2']
+    end
+    it 'handles replacing' do
+      data.replace Book.new(1, 'toitle', 'oithor')
+
+      books.search('title').ids.should == []
+      books.search('toitle').ids.should == ['1']
+    end
+    it 'handles clearing' do
+      data.clear
+
+      books.search('title').ids.should == []
+    end
+    it 'handles dumping and loading' do
+      data.dump
+      data.load
+
+      books.search('title').ids.should == ['1']
+    end
+  end
+
+  context 'default backend (dump needed)' do
+    before(:each) do
+      data.backend Picky::Backends::Redis.new
+      data.clear
+
+      data.add Book.new(1, 'title', 'author')
+    end
+
+    instance_eval &its
+  end
+
+  # context 'immediately indexing backend (no dump needed)' do
+  #   before(:each) do
+  #     data.backend Picky::Backends::Redis.new(immediate: true)
+  #     data.clear
+  #
+  #     data.add Book.new(1, 'title', 'author')
+  #   end
+  #
+  #   instance_eval &its
+  # end
+
+end

data/spec/functional/backends/sqlite_spec.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+# Describes a Picky index that uses the SQLite backend
+# for data storage.
+#
+describe Picky::Backends::SQLite do
+
+  class Book
+    attr_reader :id, :title, :author
+    def initialize id, title, author
+      @id, @title, @author = id, title, author
+    end
+  end
+
+  let(:data) do
+    Picky::Index.new(:books) do
+      source []
+      category :title, partial: Picky::Partial::Postfix.new(from: 1)
+      category :author, similarity: Picky::Generators::Similarity::DoubleMetaphone.new(3)
+    end
+  end
+  let(:books) { Picky::Search.new data }
+
+  its = ->(*) do
+    it 'searching for it' do
+      books.search('title').ids.should == [1]
+    end
+    it 'searching for it using multiple words' do
+      books.search('title author').ids.should == [1]
+    end
+    it 'searching for it using partial' do
+      books.search('tit').ids.should == [1]
+    end
+    it 'searching for it using similarity' do
+      books.search('aothor~').ids.should == [1]
+    end
+    it 'handles removing' do
+      data.remove 1
+
+      books.search('title').ids.should == []
+    end
+    it 'handles removing with more than one entry' do
+      data.add Book.new(2, 'title', 'author')
+
+      books.search('title').ids.should == [2, 1]
+
+      data.remove 1
+
+      books.search('title').ids.should == [2]
+    end
+    it 'handles clearing' do
+      data.clear
+
+      books.search('title').ids.should == []
+    end
+    it 'handles dumping and loading' do
+      data.dump
+      data.load
+
+      books.search('title').ids.should == [1]
+    end
+    it 'handles removing with three entries' do
+      data.add Book.new(2, 'title', 'author')
+      data.add Book.new(3, 'title', 'author')
+
+      books.search('title').ids.should == [3, 2, 1]
+
+      data.remove 1
+
+      books.search('title').ids.should == [3, 2]
+    end
+    it 'handles replacing' do
+      data.replace Book.new(1, 'toitle', 'oithor')
+
+      books.search('title').ids.should == []
+      books.search('toitle').ids.should == [1]
+    end
+  end
+
+  context 'default backend (dump needed)' do
+    before(:each) do
+      data.backend described_class.new
+      data.clear
+
+      data.add Book.new(1, 'title', 'author')
+    end
+
+    instance_eval &its
+  end
+
+  # context 'immediately indexing backend (no dump needed)' do
+  #   before(:each) do
+  #     data.backend described_class.new(self_indexed: true)
+  #     data.clear
+  #
+  #     data.add Book.new(1, 'title', 'author')
+  #   end
+  #
+  #   instance_eval &its
+  # end
+
+end

data/spec/{specific → functional}/exact_first_spec.rb

@@ -2,11 +2,9 @@
 #
 require 'spec_helper'
 
-describe "Weights" do
+describe "exact first" do
 
-  # This tests the weights option.
-  #
-  it 'can handle dynamic weights' do
+  it 'returns exact results first' do
     index = Picky::Index.new :exact_first do
       source { [] }
       category :text, partial: Picky::Partial::Substring.new(from: 1)

data/spec/functional/max_allocations_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe 'Search#max_allocations' do
+
+  it 'offers the option max_allocations' do
+    index = Picky::Index.new :dynamic_weights do
+      category :text1
+      category :text2
+    end
+
+    index.add Struct.new(:id, :text1, :text2).new(1, 'hello world', 'hello world')
+
+    try = Picky::Search.new index
+
+    try.search('hello world').allocations.size.should == 4
+    try.search('hello world').ids.should == [1,1,1,1]
+
+    try_again = Picky::Search.new index do
+      max_allocations 2
+    end
+
+    try_again.search('hello world').allocations.size.should == 2
+    try_again.search('hello world').ids.should == [1,1]
+
+    try_again.max_allocations 1
+
+    try_again.search('hello world').allocations.size.should == 1
+    try_again.search('hello world').ids.should == [1]
+  end
+
+end

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

@@ -13,7 +13,7 @@ describe Picky::Backends::File::Basic do
 
     describe 'initial' do
       it 'returns the container that is used for indexing' do
-        basic.initial.should == nil
+        basic.initial.should == {}
       end
     end
 

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

@@ -5,39 +5,38 @@ describe Picky::Backends::Redis::Basic do
   let(:client) { stub :client }
 
   context 'without options' do
-    let(:index) { described_class.new client, :some_namespace }
+    let(:backend) { described_class.new client, :some_namespace }
 
     describe 'load, retrieve, delete' do
       it 'is nothing they do (at least on the backend)' do
-        index.should_receive(:client).never
+        backend.should_receive(:client).never
 
-        index.load
-        index.retrieve
-        index.delete
+        backend.load
+        backend.retrieve
       end
     end
 
     describe 'empty' do
-      it 'returns the container that is used for indexing' do
-        index.empty.should == {}
+      it 'returns the container that is used for backending' do
+        backend.empty.should == {}
       end
     end
 
     describe 'initial' do
       it 'is correct' do
-        index.initial.class.should == described_class
+        backend.initial.should == {}
       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:*)'
+        backend.to_s.should == 'Picky::Backends::Redis::Basic(some_namespace:*)'
       end
     end
   end
 
   context 'with options' do
-    let(:index) do
+    let(:backend) do
       described_class.new client,
                           :some_namespace,
                           empty: [],
@@ -45,14 +44,14 @@ describe Picky::Backends::Redis::Basic do
     end
 
     describe 'empty' do
-      it 'returns the container that is used for indexing' do
-        index.empty.should == []
+      it 'returns the container that is used for backending' do
+        backend.empty.should == []
       end
     end
 
     describe 'initial' do
       it 'is correct' do
-        index.initial.class.should == Array
+        backend.initial.class.should == Array
       end
     end
   end