tanker 1.0.0 → 1.1.0

data/spec/tanker_spec.rb

@@ -2,51 +2,184 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 
 describe Tanker do
 
-  it 'sets configuration' do
-    conf =  {:url => 'http://api.indextank.com'}
-    Tanker.configuration = conf
+  describe "configuration" do
 
-    Tanker.configuration.should == conf
-  end
+    it 'sets configuration' do
+      conf =  {:url => 'http://api.indextank.com', :pagination_backend => :will_paginate}
+      Tanker.configuration = conf
 
-  it 'checks for configuration when the module is included' do
-    Tanker.configuration = nil
+      Tanker.configuration.should == conf
+    end
 
-    lambda {
-      Dummy.send(:include, Tanker)
-    }.should raise_error(Tanker::NotConfigured)
-  end
+    it 'adds default values to configuration on set if needed' do
+      conf = {:url => 'http://api.indextank.com'}
+      Tanker.configuration = conf
+      Tanker.configuration.should == conf.merge(:pagination_backend => :will_paginate)
+    end
 
-  it 'should requiquire a block when seting up tanker model' do
-    Tanker.configuration = {:url => 'http://api.indextank.com'}
-    Dummy.send(:include, Tanker)
-    lambda {
-      Dummy.send(:tankit, 'dummy index')
-    }.should raise_error(Tanker::NoBlockGiven)
-  end
+    it 'checks for configuration when the module is included' do
+      Tanker.configuration = nil
 
-  it 'should set indexable fields' do
-    Tanker.configuration = {:url => 'http://api.indextank.com'}
-    Dummy.send(:include, Tanker)
-    Dummy.send(:tankit, 'dummy index') do
-      indexes :field
+      lambda {
+        Class.new.send(:include, Tanker)
+      }.should raise_error(Tanker::NotConfigured)
+    end
+
+    it 'should not add model to .included_in if not configured' do
+      Tanker.configuration = nil
+      begin
+        dummy_class = Class.new
+        dummy_class.send(:include, Tanker)
+      rescue Tanker::NotConfigured => e
+        Tanker.included_in.should_not include dummy_class
+      end
     end
 
-    dummy_instance = Dummy.new
-    dummy_instance.tanker_config.indexes.any? {|field, block| field == :field }.should == true
   end
 
-  it 'should allow blocks for indexable field data' do
-    Tanker.configuration = {:url => 'http://api.indextank.com'}
-    Dummy.send(:include, Tanker)
-    Dummy.send(:tankit, 'dummy index') do
-      indexes :class_name do
-        self.class.name
+  describe ".tankit" do
+
+    before :each do
+      Tanker.configuration = {:url => 'http://api.indextank.com'}
+      @dummy_class = Class.new do
+        include Tanker
+      end
+    end
+
+    after :each do
+      Tanker.instance_variable_set(:@included_in, Tanker.included_in - [@dummy_class])
+    end
+
+    it 'should require a block when setting up tanker model' do
+      lambda {
+        @dummy_class.send(:tankit, 'dummy index')
+      }.should raise_error(Tanker::NoBlockGiven)
+    end
+
+    it 'should set indexable fields' do
+      @dummy_class.send(:tankit, 'dummy index') do
+        indexes :field
+      end
+
+      dummy_instance = @dummy_class.new
+      dummy_instance.tanker_config.indexes.any? {|field, block| field == :field }.should == true
+    end
+
+    it 'should allow blocks for indexable field data' do
+      @dummy_class.send(:tankit, 'dummy index') do
+        indexes :class_name do
+          self.class.name
+        end
+      end
+
+      dummy_instance = @dummy_class.new
+      dummy_instance.tanker_config.indexes.any? {|field, block| field == :class_name }.should == true
+    end
+
+    it 'should overwrite the previous index name if provided' do
+      @dummy_class.send(:tankit, 'first index') do
+      end
+      @dummy_class.send(:tankit, 'second index') do
+      end
+
+      dummy_instance = @dummy_class.new
+      dummy_instance.tanker_config.index_name.should == 'second index'
+    end
+
+    it 'should keep the previous index name if not provided' do
+      @dummy_class.send(:tankit, 'dummy index') do
+      end
+      @dummy_class.send(:tankit) do
+      end
+
+      dummy_instance = @dummy_class.new
+      dummy_instance.tanker_config.index_name.should == 'dummy index'
+    end
+
+    it 'should keep previously indexed fields' do
+      @dummy_class.send(:tankit, 'dummy index') do
+        indexes :something
+      end
+      @dummy_class.send(:tankit, 'dummy index') do
+        indexes :something_else
+      end
+
+      dummy_instance = @dummy_class.new
+      Hash[*dummy_instance.tanker_config.indexes.flatten].keys.should == [:something, :something_else]
+    end
+
+    it 'should overwrite previously indexed fields if re-indexed' do
+      @dummy_class.send(:tankit, 'dummy index') do
+        indexes :something do
+          "first"
+        end
+      end
+      @dummy_class.send(:tankit, 'dummy index') do
+        indexes :something do
+          "second"
+        end
+      end
+
+      dummy_instance = @dummy_class.new
+      dummy_instance.stub!(:id => 1)
+      dummy_instance.tanker_index_data[:something].should == "second"
+    end
+
+    it 'should merge with previously defined variables' do
+      @dummy_class.send(:tankit, 'dummy index') do
+        variables do
+          {
+            0 => 3.1415927,
+            1 => 2.7182818
+          }
+        end
+      end
+      @dummy_class.send(:tankit, 'dummy index') do
+        variables do
+          {
+            0 => 1.618034
+          }
+        end
+      end
+
+      dummy_instance = @dummy_class.new
+      dummy_instance.tanker_index_options[:variables].should == { 0 => 1.618034, 1 => 2.7182818 }
+    end
+
+    it 'should allow setting of __type by supplying :as option' do
+      @dummy_class.send(:tankit, 'dummy index', { :as => 'MySpecialModel' }) do
       end
+
+      dummy_instance = @dummy_class.new
+      dummy_instance.stub!(:id => 1)
+      dummy_instance.tanker_index_data[:__type].should == 'MySpecialModel'
     end
 
-    dummy_instance = Dummy.new
-    dummy_instance.tanker_config.indexes.any? {|field, block| field == :class_name }.should == true
+    it "can be initially defined in one module and extended in the including class" do
+      dummy_module = Module.new do
+        def self.included(base)
+          base.send :include, Tanker
+
+          base.tankit 'dummy index' do
+            indexes :name
+          end
+        end
+      end
+
+      dummy_class = Class.new do
+        include dummy_module
+
+        tankit 'another index' do
+          indexes :email
+        end
+      end
+
+      dummy_instance = dummy_class.new
+      dummy_instance.tanker_config.index_name.should == 'another index'
+      Hash[*dummy_instance.tanker_config.indexes.flatten].keys.should == [:name, :email]
+
+      Tanker.instance_variable_set(:@included_in, Tanker.included_in - [dummy_class])
+    end
   end
 
   describe 'tanker instance' do
@@ -63,8 +196,10 @@ describe Tanker do
         {
           "matches" => 1,
           "results" => [{
-            "docid" => Person.new.it_doc_id,
-            "name"  => 'pedro'
+            "docid"  => Person.new.it_doc_id,
+            "name"   => 'pedro',
+            "__type" => 'Person',
+            "__id"   => '1'
           }],
           "search_time" => 1
         }
@@ -82,10 +217,38 @@ describe Tanker do
       collection.current_page.should == 1
     end
 
+    it 'should handle string and integer ids in search results' do
+      Person.tanker_index.should_receive(:search).and_return(
+        {
+          "matches" => 2,
+          "results" => [{
+            "docid"  => 'Person mystring1d',
+            "name"   => 'pedro',
+            "__type" => 'Person',
+            "__id"   => 'mystring1d'
+          },{
+            "docid"  => 'Person 1',
+            "name"   => 'jaun',
+            "__type" => 'Person',
+            "__id"   => '1'
+          }],
+          "search_time" => 1
+        }
+      )
+
+      Person.should_receive(:find).with(['mystring1d', '1']).and_return(
+        [Person.new, Person.new]
+      )
+
+      collection = Person.search_tank('hey!')
+      collection.class.should == WillPaginate::Collection
+      collection.total_entries.should == 2
+    end
+
     it 'should be able to use multi-value query phrases' do
       Person.tanker_index.should_receive(:search).with(
-        "__any:(hey! location_id:(1) location_id:(2)) __type:(Person)",
-        {:start => 0, :len => 10}
+        'name:(hey! location_id:(1) location_id:(2)) OR last_name:(hey! location_id:(1) location_id:(2)) __type:("Person")',
+        anything
       ).and_return({'results' => [], 'matches' => 0})
 
       collection = Person.search_tank('hey!', :conditions => {:location_id => [1,2]})
@@ -93,11 +256,8 @@ describe Tanker do
 
     it 'should be able to use filter_functions' do
       Person.tanker_index.should_receive(:search).with(
-        "__any:(hey!) __type:(Person)",
-        { :start => 0,
-          :len => 10,
-          :filter_function2 => "0:10,20:40"
-        }
+        anything,
+        hash_including(:filter_function2 => "0:10,20:40")
       ).and_return({'results' => [], 'matches' => 0})
 
       collection = Person.search_tank('hey!',
@@ -107,11 +267,8 @@ describe Tanker do
     end
     it 'should be able to use filter_docvars' do
       Person.tanker_index.should_receive(:search).with(
-        "__any:(hey!) __type:(Person)",
-        { :start => 0,
-          :len => 10,
-          :filter_docvar3 => "*:7,80:100"
-        }
+        anything,
+        hash_including(:filter_docvar3 => "*:7,80:100")
       ).and_return({'results' => [], 'matches' => 0})
 
       collection = Person.search_tank('hey!',
@@ -127,12 +284,16 @@ describe Tanker do
         {
           "matches" => 2,
           "results" => [{
-            "docid" => 'Dog 7',
-            "name"  => 'fido'
+            "docid"  => 'Dog 7',
+            "name"   => 'fido',
+            "__type" => 'Dog',
+            "__id"   => '7'
           },
           {
-            "docid" => 'Cat 9',
-            "name"  => 'fluffy'
+            "docid"  => 'Cat 9',
+            "name"   => 'fluffy',
+            "__type" => 'Cat',
+            "__id"   => '9'
           }],
           "search_time" => 1
         }
@@ -153,6 +314,82 @@ describe Tanker do
       collection.current_page.should == 1
     end
 
+    it 'should be able to search for modularized model classes' do
+      Foo::Bar.tanker_index.
+        should_receive(:search).
+        with(/__type:\(.*"Foo Bar".*\)/, anything).
+        and_return({
+          "results" => [{
+            "docid"  => 'Foo::Bar 42',
+            "__type" => 'Foo::Bar',
+            "__id"   => '42'
+          }]
+        })
+
+      Foo::Bar.should_receive(:find).and_return([stub(:id => 42)])
+
+      Foo::Bar.search_tank('bar')
+    end
+
+    it 'should be able to perform a search without pagination' do
+      Person.tanker_index.should_receive(:search).and_return(
+        {
+          "matches" => 2,
+          "results" => [{
+            "docid"  => 'Person 1',
+            "name"   => 'pedro',
+            "__type" => 'Person',
+            "__id"   => '1'
+          },{
+            "docid"  => 'Person 2',
+            "name"   => 'jaun',
+            "__type" => 'Person',
+            "__id"   => '2'
+          }],
+          "search_time" => 1
+        }
+      )
+
+      Person.should_receive(:find).with(['1', '2']).and_return(
+        [Person.new, Person.new]
+      )
+
+      collection = Person.search_tank('hey!', :paginate => false)
+      collection.class.should == Array
+      collection.size.should == 2
+    end
+
+    it 'should be able to perform a search with pagination settings in :paginate option' do
+      Person.tanker_index.should_receive(:search).and_return(
+        {
+          "matches" => 2,
+          "results" => [{
+            "docid"  => 'Person 1',
+            "name"   => 'pedro',
+            "__type" => 'Person',
+            "__id"   => '1'
+          },{
+            "docid"  => 'Person 2',
+            "name"   => 'jaun',
+            "__type" => 'Person',
+            "__id"   => '2'
+          }],
+          "search_time" => 1
+        }
+      )
+
+      Person.should_receive(:find).with(['1', '2']).and_return(
+        [Person.new, Person.new]
+      )
+
+      collection = Person.search_tank('hey!', :paginate => { :page => 2, :per_page => 1 })
+      collection.class.should == WillPaginate::Collection
+      collection.total_entries.should == 2
+      collection.total_pages.should == 2
+      collection.per_page.should == 1
+      collection.current_page.should == 2
+    end
+
     it 'should be able to update the index' do
       person = Person.new(:name => 'Name', :last_name => 'Last Name')
 
@@ -161,6 +398,7 @@ describe Tanker do
         {
           :__any     => "#{$frozen_moment.to_i} . Last Name . Name",
           :__type    => 'Person',
+          :__id      => 1,
           :name      => 'Name',
           :last_name => 'Last Name',
           :timestamp => $frozen_moment.to_i
@@ -186,6 +424,7 @@ describe Tanker do
             :fields => {
               :__any     => "#{$frozen_moment.to_i} . Last Name . Name",
               :__type    => 'Person',
+              :__id      => 1,
               :name      => 'Name',
               :last_name => 'Last Name',
               :timestamp => $frozen_moment.to_i
@@ -209,5 +448,96 @@ describe Tanker do
       person.delete_tank_indexes
     end
 
+    describe 'snippets' do
+      it 'should not call find method but instead create new instances the models matched the search with the snippetted fields as snippet_ attributes' do
+        Person.tanker_index.should_receive(:search).and_return(
+        {
+          "matches" => 1,
+          "results" => [{
+            "docid"         =>  Person.new.it_doc_id,
+            'snippet_name'  => 'ped...',
+            "__type" => 'Person',
+            "__id"   => '1'
+          }],
+          "search_time" => 1
+        })
+
+        collection = Person.search_tank('hey!', :snippets => [:name])
+        collection[0].name_snippet.should == 'ped...'
+      end
+    end
+
+    describe 'fetch' do
+      it 'should not call find method but instead create new instances the models matched the search with the fetched fields as attributes' do
+        Person.tanker_index.should_receive(:search).and_return(
+        {
+          "matches" => 1,
+          "results" => [{
+            "docid"         =>  Person.new.it_doc_id,
+            'name'  => 'Osama',
+            "__type" => 'Person',
+            "__id"   => '1'
+          }],
+          "search_time" => 1
+        })
+
+        collection = Person.search_tank('terrorist', :fetch => [:name])
+        collection[0].name.should == 'Osama'
+      end
+    end
+  end
+
+  describe "Kaminari support" do
+
+    before :all do
+      Tanker.configuration = {:url => 'http://api.indextank.com', :pagination_backend => :kaminari}
+    end
+
+    after :all do
+      Tanker.configuration = {}
+    end
+
+    it 'should raise error message if Kaminari gem is not required' do
+      Person.tanker_index.should_receive(:search).and_return(
+        {
+          "matches" => 1,
+          "results" => [{
+            "docid"  => Person.new.it_doc_id,
+            "name"   => 'pedro',
+            "__type" => 'Person',
+            "__id"   => '1'
+          }],
+          "search_time" => 1
+        }
+      )
+      Person.should_receive(:find).and_return([Person.new])
+
+      lambda { Person.search_tank('test') }.should raise_error(Tanker::BadConfiguration)
+    end
+
+    it 'should be able to return Kaminari compatible array for a search' do
+      require 'kaminari'
+      Person.tanker_index.should_receive(:search).and_return(
+        {
+          "matches" => 1,
+          "results" => [{
+            "docid"  => Person.new.it_doc_id,
+            "name"   => 'pedro',
+            "__type" => 'Person',
+            "__id"   => '1'
+          }],
+          "search_time" => 1
+        }
+      )
+
+      Person.should_receive(:find).and_return([Person.new])
+
+      array = Person.search_tank('hey!')
+      array.class.should == Tanker::KaminariPaginatedArray
+      array.total_count.should == 1
+      array.num_pages.should == 1
+      array.limit_value.should == 10
+      array.current_page.should == 1
+    end
   end
 end

data/spec/utilities_spec.rb

@@ -1,23 +1,32 @@
 require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 
-class Dummy
-  include Tanker
+describe Tanker::Utilities do
 
-  tankit 'dummy index' do
-    indexes :name
-  end
+  before(:each) do 
+    
+    @included_in = Tanker.instance_variable_get :@included_in
+    Tanker.instance_variable_set :@included_in, []
 
-end
+    class Dummy
+      include Tanker
 
+      tankit 'dummy index' do
+        indexes :name
+      end
 
-describe Tanker::Utilities do
+    end
+  end
+
+  after(:each) do
+    Tanker.instance_variable_set :@included_in, @included_in
+  end
 
   it "should get the models where Tanker module was included" do
-    (Tanker::Utilities.get_model_classes - [Dummy, Person, Dog, Cat]).should == []
+    (Tanker::Utilities.get_model_classes - [Dummy]).should == []
   end
 
   it "should get the available indexes" do
-    Tanker::Utilities.get_available_indexes.should == ["people", "animals", "dummy index"]
+    Tanker::Utilities.get_available_indexes.should == ["dummy index"]
   end
 
 end

data/tanker.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tanker}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["@kidpollo", "Jack Danger Canty"]
-  s.date = %q{2011-04-02}
+  s.authors = [%q{@kidpollo}, %q{Jack Danger Canty}]
+  s.date = %q{2011-06-06}
   s.description = %q{IndexTank is a great search indexing service, this gem tries to make any orm keep in sync with indextank with ease}
   s.email = %q{kidpollo@gmail.com}
   s.extra_rdoc_files = [
@@ -27,19 +27,23 @@ Gem::Specification.new do |s|
     "lib/indextank_client.rb",
     "lib/tanker.rb",
     "lib/tanker/configuration.rb",
+    "lib/tanker/paginated_array.rb",
     "lib/tanker/railtie.rb",
     "lib/tanker/tasks/tanker.rake",
     "lib/tanker/utilities.rb",
+    "spec/integration_spec.rb",
+    "spec/integration_spec_conf.rb.example",
     "spec/spec_helper.rb",
     "spec/tanker_spec.rb",
     "spec/utilities_spec.rb",
     "tanker.gemspec"
   ]
   s.homepage = %q{http://github.com/kidpollo/tanker}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.7.1}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
   s.summary = %q{IndexTank integration to your favorite orm}
   s.test_files = [
+    "spec/integration_spec.rb",
     "spec/spec_helper.rb",
     "spec/tanker_spec.rb",
     "spec/utilities_spec.rb"
@@ -50,14 +54,20 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 1.5.1"])
       s.add_runtime_dependency(%q<will_paginate>, [">= 2.3.15"])
+      s.add_runtime_dependency(%q<kaminari>, [">= 0"])
     else
       s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 1.5.1"])
       s.add_dependency(%q<will_paginate>, [">= 2.3.15"])
+      s.add_dependency(%q<kaminari>, [">= 0"])
     end
   else
     s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 1.5.1"])
     s.add_dependency(%q<will_paginate>, [">= 2.3.15"])
+    s.add_dependency(%q<kaminari>, [">= 0"])
   end
 end