tanker 1.1.2 → 1.1.3

data/Gemfile

@@ -6,6 +6,7 @@ group :test do
   gem 'rspec', '>= 2.5.0'
   gem 'activerecord', '>= 3.0.7'
   gem 'sqlite3'
+  #gem 'ruby-debug19'
 end
 
 group :development do

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.1.3

data/lib/tanker/pagination/kaminari.rb

@@ -0,0 +1,38 @@
+unless defined? Kaminari
+  raise(Tanker::BadConfiguration, "Tanker: Please add 'kaminari' to your Gemfile to use kaminari pagination backend")
+end
+
+module Tanker
+  module Pagination
+    class Kaminari < Array
+      include ::Kaminari::ConfigurationMethods::ClassMethods
+      include ::Kaminari::PageScopeMethods
+
+      attr_reader :limit_value, :offset_value, :total_count
+
+      def initialize(original_array, limit_val, offset_val, total_count)
+        @limit_value = limit_val || default_per_page
+        @offset_value, @total_count = offset_val, total_count
+        super(original_array)
+      end
+
+      def page(num = 1)
+        self
+      end
+
+      def limit(num)
+        self
+      end
+
+      def current_page
+        offset_value+1
+      end
+
+      class << self
+        def create(results, total_hits, options = {})
+          new(results, options[:per_page], options[:page]-1, total_hits)
+        end
+      end
+    end
+  end
+end

data/lib/tanker/pagination/will_paginate.rb

@@ -0,0 +1,15 @@
+begin
+  require 'will_paginate/collection'
+rescue LoadError
+  raise(Tanker::BadConfiguration, "Tanker: Please add 'will_paginate' to your Gemfile to use will_paginate pagination backend")
+end
+
+module Tanker
+  module Pagination
+    class WillPaginate
+      def self.create(results, total_hits, options = {})
+        ::WillPaginate::Collection.create(options[:page], options[:per_page], total_hits) { |pager| pager.replace results }
+      end
+    end
+  end
+end

data/lib/tanker/pagination.rb

@@ -0,0 +1,16 @@
+module Tanker
+  module Pagination
+
+    autoload :WillPaginate, 'tanker/pagination/will_paginate'
+    autoload :Kaminari, 'tanker/pagination/kaminari'
+
+    def self.create(results, total_hits, options = {})
+      begin
+        backend = Tanker.configuration[:pagination_backend].to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase } # classify pagination backend name
+        Object.const_get(:Tanker).const_get(:Pagination).const_get(backend).create(results, total_hits, options)
+      rescue NameError
+        raise(BadConfiguration, "Unknown pagination backend")
+      end
+    end
+  end
+end

data/lib/tanker.rb

@@ -9,7 +9,6 @@ end
 require 'indextank_client'
 require 'tanker/configuration'
 require 'tanker/utilities'
-require 'will_paginate/collection'
 
 if defined? Rails
   begin
@@ -28,7 +27,7 @@ module Tanker
   autoload :Configuration, 'tanker/configuration'
   extend Configuration
 
-  autoload :KaminariPaginatedArray, 'tanker/paginated_array'
+  autoload :Pagination, 'tanker/pagination'
 
   class << self
     attr_reader :included_in
@@ -101,26 +100,26 @@ module Tanker
 
       # fetch values from index tank or just the type and id to instace results localy
       options[:fetch]   =  "__type,__id"
-      options[:fetch]   += ",#{fetch.join(',')}" if fetch 
+      options[:fetch]   += ",#{fetch.join(',')}" if fetch
       options[:snippet] = snippets.join(',') if snippets
-      
+
       search_on_fields = models.map{|model| model.tanker_config.indexes.map{|arr| arr[0]}.uniq}.flatten.uniq.join(":(#{query.to_s}) OR ")
-      query = "#{search_on_fields}:(#{query.to_s}) __type:(#{models.map(&:name).map {|name| "\"#{name.split('::').join(' ')}\"" }.join(' OR ')})"
 
+      query = "#{search_on_fields}:(#{query.to_s}) OR __any:(#{query.to_s}) __type:(#{models.map(&:name).map {|name| "\"#{name.split('::').join(' ')}\"" }.join(' OR ')})"
       options = { :start => paginate[:per_page] * (paginate[:page] - 1), :len => paginate[:per_page] }.merge(options) if paginate
       results = index.search(query, options)
-      
+
       instantiated_results = if (fetch || snippets)
         instantiate_results_from_results(results, fetch, snippets)
       else
         instantiate_results_from_db(results)
       end
-      paginate === false ? instantiated_results : paginate_results(instantiated_results, paginate, results['matches'])
+      paginate === false ? instantiated_results : Pagination.create(instantiated_results, results['matches'], paginate)
     end
 
     protected
 
-      def instantiate_results_from_db(index_result) 
+      def instantiate_results_from_db(index_result)
         results = index_result['results']
         return [] if results.empty?
 
@@ -131,7 +130,7 @@ module Tanker
           acc[model] << id
           acc
         end
-        
+
         id_map.each do |klass, ids|
           # replace the id list with an eager-loaded list of records for this model
           id_map[klass] = constantize(klass).find(ids)
@@ -143,26 +142,10 @@ module Tanker
         end
       end
 
-      def paginate_results(results, pagination_options, total_hits)
-        case Tanker.configuration[:pagination_backend]
-        when :will_paginate
-          WillPaginate::Collection.create(pagination_options[:page],
-                                          pagination_options[:per_page],
-                                          total_hits) { |pager| pager.replace results }
-        when :kaminari
-          Tanker::KaminariPaginatedArray.new(results,
-                                             pagination_options[:per_page],
-                                             pagination_options[:page]-1,
-                                             total_hits)
-        else
-          raise(BadConfiguration, "Unknown pagination backend")
-        end
-      end
-
       def instantiate_results_from_results(index_result, fetch = false, snippets = false)
         results = index_result['results']
         return [] if results.empty?
-        instances = []   
+        instances = []
         id_map = results.inject({}) do |acc, result|
           model = result["__type"]
           instance = constantize(model).new()
@@ -366,10 +349,9 @@ module Tanker
 
     #dynamically create a snippet read attribute (method)
     def create_snippet_attribute(key, value)
-      # the method name should something_snippet not snippet_something as the api returns it
-      self.class.send(:define_method,  "#{key.match(/snippet_(\w+)/)[1]}_snippet") do
-        value
-      end
+      # method name should something_snippet not snippet_something as the api returns it
+      method_name = "#{key.match(/snippet_(\w+)/)[1]}_snippet"
+      (class << self; self end).send(:define_method, method_name) { value }
     end
 
     def tanker_index_options

data/spec/integration_spec.rb

@@ -16,9 +16,10 @@ ActiveRecord::Base.establish_connection(
 
 ActiveRecord::Schema.define do
   create_table :products do |t|
-    t.string :name    
+    t.string :name
     t.string :href
     t.string :tags
+    t.text :description
   end
 end
 
@@ -28,156 +29,217 @@ class Product < ActiveRecord::Base
   tankit 'tanker_integration_tests' do
     indexes :name
     indexes :href
+    indexes :tags
+    indexes :description
   end
 end
 
-#class Product
-#  include Tanker
-
-#  tankit 'tanker_integration_tests' do
-#    indexes :name
-#    indexes :href
-#    indexes :tags
-#  end
-
-#  attr_accessor :name, :href, :tags
-
-#  def initialize(options = {})
-#    @name = options[:name]
-#    @href = options[:href]
-#    @tags = options[:tags]
-#  end
-
-#  def id
-#    @id ||= self.class.throwaway_id
-#  end
-#  
-#  def id=(val)
-#    @id = val
-#  end
-#   
-#  class << self
-#    def create(options)
-#      self.new(options)
-#    end
-#
-#    def throwaway_id
-#      @throwaway_id = (@throwaway_id ? @throwaway_id + 1 : 0)
-#    end
-#
-#    def all
-#      ObjectSpace.each_object(self)
-#    end
-#
-#    def find(ids)
-#      all.select{|instance| ids.include?(instance.id.to_s) }
-#    end
-#  end
-#end
-
-describe 'Tanker integration tests with IndexTank' do
-
-  before(:all) do 
+describe 'An imaginary store' do
+
+  before(:all) do
     Tanker::Utilities.clear_index('tanker_integration_tests')
-    
-    @catapult = Product.create(:name => 'Acme catapult')
-    @tnt      = Product.create(:name => 'Acme TNT')
-    @cat      = Product.create(:name => 'Acme cat')
-      
+
+    # Google products
+    @blackberry = Product.create(:name => 'blackberry', :href => "google", :tags => ['decent', 'businessmen love it'])
+    @nokia = Product.create(:name => 'nokia', :href => "google", :tags => ['decent'])
+
+    # Amazon products
+    @android = Product.create(:name => 'android', :href => "amazon", :tags => ['awesome'])
+    @samsung = Product.create(:name => 'samsung', :href => "amazon", :tags => ['decent'])
+    @motorola = Product.create(:name => 'motorola', :href => "amazon", :tags => ['decent'],
+      :description => "Not sure about features since I've never owned one.")
+
+    # Ebay products
+    @palmpre = Product.create(:name => 'palmpre', :href => "ebay", :tags => ['discontinued', 'worst phone ever'])
+    @palm_pixi_plus = Product.create(:name => 'palm pixi plus', :href => "ebay", :tags => ['terrible'])
+    @lg_vortex = Product.create(:name => 'lg vortex', :href => "ebay", :tags => ['decent'])
+    @t_mobile = Product.create(:name => 't mobile', :href => "ebay", :tags => ['terrible'])
+
+    # Yahoo products
+    @htc = Product.create(:name => 'htc', :href => "yahoo", :tags => ['decent'])
+    @htc_evo = Product.create(:name => 'htc evo', :href => "yahoo", :tags => ['decent'])
+    @ericson = Product.create(:name => 'ericson', :href => "yahoo", :tags => ['decent'])
+
+    # Apple products
+    @iphone = Product.create(:name => 'iphone', :href => "apple", :tags => ['awesome', 'poor reception'], 
+      :description => 'Puts even more features at your fingertips')
+
+    @products_in_database = Product.all
+
     Product.tanker_reindex
   end
 
-  context 'An imaginary store' do
-    describe 'basic searching' do
-      it 'should find all Acme products' do
-        @results = Product.search_tank('Acme')
-        (@results - [@catapult, @tnt, @cat]).should be_empty
-        @results[0].id.should_not be_nil
-      end
-  
-      it 'should find all catapults' do
-        @results = Product.search_tank('catapult')
-        (@results - [@catapult]).should be_empty
-      end
-
-      it 'should find all things cat' do
-        @results = Product.search_tank('cat')
-        (@results - [@catapult, @cat]).should be_empty
-      end
-    end
-   
-    describe 'filtering dogs' do
-
-      before(:all) do
-        @doggie_1 = Product.create(:name => 'doggie 1', :tags => ['puppuy', 'pug'] )
-        @doggie_2 = Product.create(:name => 'doggie 2', :tags => ['pug'] )
-        @doggie_3 = Product.create(:name => 'doggie 3', :tags => ['puppuy', 'yoirkie'] )
-        Product.tanker_reindex
-      end
-
-      after(:all) do
-        @doggie_1.delete_tank_indexes 
-        @doggie_2.delete_tank_indexes 
-        @doggie_3.delete_tank_indexes 
-      end
-
-      it 'should filter by puppy tags' do
-        @results = Product.search_tank('doggie', :conditions => {:tags => 'puppy'})
-        (@results - [@doggie_1, @doggie_3]).should be_empty
-      end
-
-      it 'should not search for doggie_3' do
-        @results = Product.search_tank('doggie', :conditions => {:tags => 'puppy', '-name' => 'doggie_3'})
-        (@results - [@doggie_1]).should be_empty
-
-        @results = Product.search_tank('doggie', :conditions => {:tags => 'puppy', 'NOT name' => 'doggie_3'})
-        (@results - [@doggie_1]).should be_empty
-
-        @results = Product.search_tank('doggie NOT doggie_3', :conditions => {:tags => 'puppy'} )
-        (@results - [@doggie_1]).should be_empty
-      end
-    end
-
-    describe 'snippets and fetching data' do 
-      before(:all) do
-        @prod_1 = Product.create(:name => 'something small')
-        @very_long_sting = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.'
-        @prod_2 = Product.create(:name => @very_long_sting, :href => 'http://google.com' )
-        @prod_3 = Product.create(:name => 'product with tags', :tags => ['oneword', 'two words'])
-        Product.tanker_reindex
-      end
-
-      after(:all) do
-        @prod_1.delete_tank_indexes 
-        @prod_2.delete_tank_indexes 
-        @prod_3.delete_tank_indexes 
-      end
-     
-      it 'should fetch attribute requested from Index Tank and create an intstance of the Model without calling the database' do
-        @results = Product.search_tank('something', :fetch => [:name])
-        @results.count.should == 1
-        
-        @new_prod_instance = @results[0]
-        @new_prod_instance.name.should == 'something small'
-      end
-
-      it 'should get a snippet for an attribute requested from Index Tank and create an intstance of the Model without calling the database and with a _snippet attribute reader' do
-        @results = Product.search_tank('product', :snippets => [:name])
-        @results.count.should == 1
-       
-        @new_prod_instance = @results[0]
-        @new_prod_instance.name_snippet.should =~ /<b>product<\/b>/
-      end
-
-      it 'should create a new instance of a model and fetch attributes that where requested and get snippets for the attributes required as snippets' do 
-        @results = Product.search_tank('quis exercitation', :snippets => [:name], :fetch => [:href])
-        @results.count.should == 1
-        
-        @new_prod_instance = @results[0]
-        @new_prod_instance.name_snippet.should =~ /<b>quis<\/b>/
-        @new_prod_instance.href.should == 'http://google.com'
-      end
-    end   
+  describe 'basic searching' do
+
+    it 'should find all amazon products' do
+      results = Product.search_tank('amazon')
+      results.should include(@android, @samsung, @motorola)
+      results.should have_exactly(3).products
+    end
+
+    it 'should find the iphone' do
+      results = Product.search_tank('iphone')
+      results.should include(@iphone)
+      results.should have_exactly(1).product
+    end
+
+    it 'should find all "palm" phones with wildcard word search' do
+      results = Product.search_tank('palm*')
+      results.should include(@palmpre, @palm_pixi_plus)
+      results.should have_exactly(2).products
+    end
+
+    it 'should search multiple words from the same field' do
+      results = Product.search_tank('palm pixi plus')
+      results.should include(@palm_pixi_plus)
+      results.should have_exactly(1).product
+    end
+
+    it "should narrow the results by searching across multiple fields" do
+      results = Product.search_tank('apple iphone')
+      results.should include(@iphone)
+      results.should have(1).product
+    end
+
+    it "should serach case insensitively" do
+      results = Product.search_tank('IPHONE')
+      results.should include(@iphone)
+      results.should have(1).product
+    end
+  end
+
+  describe 'searching by tag' do
+    it 'should find all "awesome" products regardless of other attributes' do
+      results = Product.search_tank('', :conditions => {:tags => 'awesome'})
+      results.should include(@android, @iphone)
+      results.should have_exactly(2).products
+    end
+
+    it 'should find all "decent" products sold by amazon' do
+      results = Product.search_tank('amazon', :conditions => {:tags => 'decent'})
+      results.should include(@samsung, @motorola)
+      results.should have_exactly(2).products
+    end
+
+    it 'should find all "terrible" or "discontinued" products sold by ebay' do
+      results = Product.search_tank('ebay', :conditions => {:tags => 'terrible OR discontinued'})
+      results.should include(@t_mobile, @palmpre, @palm_pixi_plus)
+      results.should have_exactly(3).products
+    end
+
+    it 'should find products tagged as "discontinued" and "worst phone ever" sold by ebay' do
+      results = Product.search_tank('ebay', :conditions => {:tags => ['discontinued', 'worst phone ever']})
+      results.should include(@palmpre)
+      results.should have_exactly(1).product
+    end
   end
+
+  describe "negative search conditions" do
+
+    it 'should find all "awesome" products excluding those sold by apple' do
+      results = Product.search_tank('awesome', :conditions => {'-href' => 'apple'})
+      results.should include(@android)
+      results.should have_exactly(1).product
+    end
+
+    it 'should find all "awesome" products excluding those sold by apple (using alternate syntax)' do
+      results = Product.search_tank('awesome', :conditions => {'NOT href' => 'apple'})
+      results.should include(@android)
+      results.should have_exactly(1).product
+    end
+
+    it 'should find all "decent" products excluding those sold by apple (using alternate syntax)' do
+      results = Product.search_tank('awesome', :conditions => {'NOT href' => 'apple'})
+      results.should include(@android)
+      results.should have_exactly(1).product
+    end
+
+    it 'should find the "htc" but not the "htc evo"' do
+      results = Product.search_tank('htc NOT evo')
+      results.should include(@htc)
+      results.should have_exactly(1).product
+    end
+  end
+
+  describe "fetching products (as opposed to searching)" do
+
+    before { @results = Product.search_tank('apple', :fetch => [:name]) }
+
+    it 'should find all "apple" products' do
+      @results.should have_exactly(1).product
+    end
+
+    it "should set values only for the fetched attributes" do
+      @results.first.name.should == 'iphone'
+    end
+
+    it "should set any non-fetched attributes to nil" do
+      @results.first.href.should be_nil
+      @results.first.tags.should be_nil
+    end
+
+    it "should build results from the index without touching the database" do
+      @products_in_database.should_not include(@results)
+    end
+  end
+
+  describe "searching snippets" do
+    before(:all) { @results = Product.search_tank('features', :snippets => [:description]) }
+
+    it 'should find snippets for any product with "features" in the description' do
+      @results.should have_exactly(2).products # motorola and iphone
+    end
+
+    it "should build results from the index without touching the database" do
+      @products_in_database.should_not include(@results)
+    end
+
+    it 'should dynamically create an "<attribute>_snippet" method for each result' do
+      @results.each { |r| r.should respond_to(:description_snippet) }
+    end
+
+    it 'should return a snippet for iphone' do
+      snippets = @results.map(&:description_snippet)
+      snippets.should include("Puts even more <b>features</b> at your fingertips")
+    end
+
+    it 'should return a snippet for motorola' do
+      snippets = @results.map(&:description_snippet)
+      snippets.should include("Not sure about <b>features</b> since I've never owned one")
+    end
+  end
+
+  describe "searching snippets while also fetching specific attributes" do
+    before :all do 
+      @results = Product.search_tank('features', :snippets => [:description], :fetch => [:name, :href])
+      @indexed_iphone = @results.detect { |r| r.name == 'iphone' }
+      @indexed_motorola = @results.detect { |r| r.name == 'motorola' }
+    end
+
+    it 'should find any product with "features" in the description' do
+      @results.should include(@indexed_motorola, @indexed_iphone)
+      @results.should have_exactly(2).products
+    end
+
+    it "should build results from the index without touching the database" do
+      @products_in_database.should_not include(@results)
+    end
+
+    it 'should set the "name" attribute for all results' do
+      @indexed_motorola.name.should == 'motorola'
+      @indexed_iphone.name.should == 'iphone'
+    end
+
+    it 'should set the "href" attribute for all results' do
+      @indexed_motorola.href.should == 'amazon'
+      @indexed_iphone.href.should == 'apple'
+    end
+
+    it 'should set the "description_snippet" attribute for all results' do
+      @indexed_motorola.description_snippet.should == "Not sure about <b>features</b> since I've never owned one"
+      @indexed_iphone.description_snippet.should == "Puts even more <b>features</b> at your fingertips"
+    end
+  end
+  
 end
 

data/spec/tanker_spec.rb

@@ -249,7 +249,7 @@ describe Tanker do
 
     it 'should be able to use multi-value query phrases' do
       Person.tanker_index.should_receive(:search).with(
-        'name:(hey! location_id:(1) location_id:(2)) OR last_name:(hey! location_id:(1) location_id:(2)) __type:("Person")',
+        'name:(hey! location_id:(1) location_id:(2)) OR last_name:(hey! location_id:(1) location_id:(2)) OR __any:(hey! location_id:(1) location_id:(2)) __type:("Person")',
         anything
       ).and_return({'results' => [], 'matches' => 0})
 
@@ -500,9 +500,9 @@ describe Tanker do
     end
 
     # Need to do this for tests to pass on 1.8.7. If not tanker.rb is
-    # reloaded Tanker::KaminariPaginatedArray const gets removed (!?)
+    # reloaded Tanker::Pagination::Kaminari const gets removed (!?)
     before :each do
-      load 'tanker.rb'
+      load 'tanker/pagination.rb'
     end
 
     it 'should raise error message if Kaminari gem is not required' do
@@ -541,7 +541,7 @@ describe Tanker do
       Person.should_receive(:find).and_return([Person.new])
 
       array = Person.search_tank('hey!')
-      array.class.should == Tanker::KaminariPaginatedArray
+      array.class.should == Tanker::Pagination::Kaminari
       array.total_count.should == 1
       array.num_pages.should == 1
       array.limit_value.should == 10

data/tanker.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tanker}
-  s.version = "1.1.2"
+  s.version = "1.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Francisco Viramontes}, %q{Jack Danger Canty}]
-  s.date = %q{2011-06-13}
+  s.date = %q{2011-07-01}
   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,7 +27,9 @@ Gem::Specification.new do |s|
     "lib/indextank_client.rb",
     "lib/tanker.rb",
     "lib/tanker/configuration.rb",
-    "lib/tanker/paginated_array.rb",
+    "lib/tanker/pagination.rb",
+    "lib/tanker/pagination/kaminari.rb",
+    "lib/tanker/pagination/will_paginate.rb",
     "lib/tanker/railtie.rb",
     "lib/tanker/tasks/tanker.rake",
     "lib/tanker/utilities.rb",

metadata

@@ -2,7 +2,7 @@
 name: tanker
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors: 
 - Francisco Viramontes
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-13 00:00:00 Z
+date: 2011-07-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -77,7 +77,9 @@ files:
 - lib/indextank_client.rb
 - lib/tanker.rb
 - lib/tanker/configuration.rb
-- lib/tanker/paginated_array.rb
+- lib/tanker/pagination.rb
+- lib/tanker/pagination/kaminari.rb
+- lib/tanker/pagination/will_paginate.rb
 - lib/tanker/railtie.rb
 - lib/tanker/tasks/tanker.rake
 - lib/tanker/utilities.rb

data/lib/tanker/paginated_array.rb

@@ -1,30 +0,0 @@
-unless defined?(Kaminari)
-  raise(Tanker::BadConfiguration, "Tanker: Please add 'kaminari' to your Gemfile to use kaminari pagination backend")
-end
-
-module Tanker
-  class KaminariPaginatedArray < Array
-    include ::Kaminari::ConfigurationMethods::ClassMethods
-    include ::Kaminari::PageScopeMethods
-
-    attr_reader :limit_value, :offset_value, :total_count
-
-    def initialize(original_array, limit_val, offset_val, total_count)
-      @limit_value = limit_val || default_per_page
-      @offset_value, @total_count = offset_val, total_count
-      super(original_array)
-    end
-
-    def page(num = 1)
-      self
-    end
-
-    def limit(num)
-      self
-    end
-
-    def current_page
-      offset_value+1
-    end
-  end
-end