tanker 1.1.3 → 1.1.4

data/README.rdoc

@@ -54,6 +54,9 @@ or
       
       # just include the Tanker module
       include Tanker
+      
+      # define a scope
+      scope :awesome, :conditions => {:title => 'Awesome'}
 
       # define the index by supplying the index name and the fields to index
       # this is the index name you create in the Index Tank dashboard
@@ -64,11 +67,17 @@ or
         indexes :content
         indexes :id
         indexes :tag_list #NOTICE this is an array of Tags! Awesome!
+        indexes :category, :category => true # make attributes also be categories (facets)
 
         # you may also dynamically retrieve field data
         indexes :author_names do
           authors.map {|author| author.name }
         end
+        
+        # you cal also dynamically set categories
+        category :content_length do
+          content.length 
+        end
 
         # to pass in a list of variables with your document,
         # supply a hash with the variable integers as keys:
@@ -115,6 +124,14 @@ Search Topics
     @topics = Topic.search_tank('blah',  :conditions => {:tag_list => 'tag1'}) # Gets 2 results!
     @topics = Topic.search_tank('blah',  :conditions => {:title => 'Awesome', :tag_list => 'tag1'}) # Gets 1 result!
 
+Search with scope (Only tested on ActiveRecord)
+
+    @topics = Topic.awesome.search_tank('blah') # Gets 1 result!
+    
+Search with wildcards!
+
+    @topics = Topic.search_tank('Awe*', :page => 1, :per_page => 10) # Gets 1 result!
+
 Search multiple models
 
     @results = Tanker.search([Topic, Post], 'blah') # Gets any Topic OR Post results that match!
@@ -333,11 +350,6 @@ Or you can restrict indexing to a subset of records. This is particularly helpfu
 
     Model.tanker_reindex(:batch_size => 1000, :scope => :not_deleted) # will call Model.not_deleted.all internally
 
-
-== TODO
-* Documentation
-* More fancy stuff (Suggestions?)
-
 == Note on Patches/Pull Requests
  
 * Fork the project.
@@ -348,18 +360,34 @@ Or you can restrict indexing to a subset of records. This is particularly helpfu
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
+== Note on testing
+
+Tanker is has a full suite of unit tests that cover configuration and the api of the library but it also inludes a battery of Integration tests! 
+These tests spec the behabiero between  Index Tank and an ActiveRecord model with a Sqlite3 Backend.
+
+If you want to run the specs you will need to provide an Index Tank Api key and user in the +spec/integration_spec_conf.rb+ file. 
+This file is ignored from the repo but you'll find an example file in the same path.
 
 == Acknowledgements
 The gem is based on a couple of projects:
 
-*{redis-textsearch}[http://github.com/nateware/redis-textsearch]
-*{mongomapper}[http://github.com/jnunemaker/mongomapper]
-*{thinkingtank}[http://github.com/flaptor/thinkingtank]
-*{will_paginate}[http://github.com/mislav/will_paginate]
+* {redis-textsearch}[http://github.com/nateware/redis-textsearch]
+* {mongomapper}[http://github.com/jnunemaker/mongomapper]
+* {thinkingtank}[http://github.com/flaptor/thinkingtank]
+* {will_paginate}[http://github.com/mislav/will_paginate]
 
 Kudos to this awesome projects and developers
 
+There is a growing list of colabrators to this Gem so I would briefly mention them so if you know them and use this gem buy them a beer!
+
+* {@JackDanger}[http://github.com/JackDanger]
+* {@edgarjs}[http://github.com/edgarjs]
+* {@slothbear}[http://github.com/slothbear]
+* {@dabit}[http://github.com/dabit]
+* {@coryschires}[http://github.com/coryschires]
+* {@arvida}[http://github.com/arvida]
+* {@joeljunstrom}[http://github.com/joeljunstrom]
 
 == Copyright
 
-Copyright (c) 2010 @kidpollo. See LICENSE for details.
+Copyright (c) 2011 @kidpollo. See LICENSE for details.

data/Rakefile

@@ -18,30 +18,13 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'spec'
-  test.pattern = 'spec/*_spec.rb'
-  test.verbose = true
+require "rspec/core/rake_task"
+# RSpec 2.0
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rspec_opts = ['--backtrace']
 end
-task :spec => :test
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-#task :test => :check_dependencies
-
-task :default => :test
+task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-1.1.3
+1.1.4

data/lib/tanker/pagination/kaminari.rb

@@ -30,9 +30,10 @@ module Tanker
 
       class << self
         def create(results, total_hits, options = {})
-          new(results, options[:per_page], options[:page]-1, total_hits)
+          instance = new(results, options[:per_page], options[:page]-1, total_hits)
+          instance
         end
       end
     end
   end
-end
+end

data/lib/tanker/pagination/will_paginate.rb

@@ -12,4 +12,4 @@ module Tanker
       end
     end
   end
-end
+end

data/lib/tanker/pagination.rb

@@ -4,13 +4,26 @@ module Tanker
     autoload :WillPaginate, 'tanker/pagination/will_paginate'
     autoload :Kaminari, 'tanker/pagination/kaminari'
 
-    def self.create(results, total_hits, options = {})
+    def self.create(results, total_hits, options = {}, categories = {})
       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)
+        page = Object.const_get(:Tanker).const_get(:Pagination).const_get(backend).create(results, total_hits, options)
+        page.extend Categories
+        page.categories = categories
+        page
       rescue NameError
         raise(BadConfiguration, "Unknown pagination backend")
       end
     end
+    
+    module Categories
+      def categories
+        @categories
+      end
+
+      def categories=(val)
+        @categories = val
+      end
+    end
   end
-end
+end

data/lib/tanker.rb

@@ -103,18 +103,22 @@ module Tanker
       options[:fetch]   += ",#{fetch.join(',')}" if fetch
       options[:snippet] = snippets.join(',') if snippets
 
+      # convert category_filters to a json string
+      options[:category_filters] = options[:category_filters].to_json if options[:category_filters]
+
       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}) OR __any:(#{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)
+      categories = results['facets'] if results.has_key?('facets')
 
       instantiated_results = if (fetch || snippets)
         instantiate_results_from_results(results, fetch, snippets)
       else
         instantiate_results_from_db(results)
       end
-      paginate === false ? instantiated_results : Pagination.create(instantiated_results, results['matches'], paginate)
+      paginate === false ? instantiated_results : Pagination.create(instantiated_results, results['matches'], paginate, categories)
     end
 
     protected
@@ -133,13 +137,19 @@ module Tanker
 
         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)
+          klass_const = constantize(klass)
+          if klass_const.respond_to?('find_all_by_id') 
+            id_map[klass] = klass_const.find_all_by_id(ids)
+          else
+            id_map[klass] = klass_const.find(ids)
+          end  
         end
         # return them in order
-        results.map do |result|
+        results = results.map do |result|
           model, id = result["__type"], result["__id"]
           id_map[model].detect {|record| id == record.id.to_s }
         end
+        results.compact
       end
 
       def instantiate_results_from_results(index_result, fetch = false, snippets = false)
@@ -270,18 +280,33 @@ module Tanker
     attr_accessor :options
 
     def initialize(index_name, options, block)
-      @index_name = index_name
-      @options    = options
-      @indexes    = []
-      @variables  = []
-      @functions  = {}
+      @index_name         = index_name
+      @options            = options
+      @indexes            = []
+      @categories         = []
+      @variables          = []
+      @functions          = {}
       instance_exec &block
     end
 
-    def indexes(field = nil, &block)
-      @indexes << [field, block] if field
+    def indexes(field = nil, options = {}, &block)
+      if field
+        @indexes     << [field, block]
+        @categories  << [field, block] if options[:category]
+      end
       @indexes
     end
+   
+    def category(field = nil, options = {}, &block)
+      categories field, options, &block
+    end
+
+    def categories(field = nil, options = {}, &block)
+      if field
+        @categories  << [field, block]
+      end
+      @categories
+    end
 
     def variables(&block)
       @variables << block if block
@@ -310,6 +335,10 @@ module Tanker
       tanker_config.indexes
     end
 
+    def tanker_categories
+      tanker_config.categories
+    end
+
     def tanker_variables
       tanker_config.variables
     end
@@ -333,7 +362,7 @@ module Tanker
       if respond_to?(:created_at)
         data[:timestamp] = created_at.to_i
       end
-
+      
       tanker_indexes.each do |field, block|
         val = block ? instance_exec(&block) : send(field)
         val = val.join(' ') if Array === val
@@ -342,7 +371,7 @@ module Tanker
 
       data[:__any] = data.values.sort_by{|v| v.to_s}.join " . "
       data[:__type] = type_name
-      data[:__id] = self.id
+      data[:__id] = self.id.is_a?(Fixnum) ? self.id : self.id.to_s
 
       data
     end
@@ -363,6 +392,15 @@ module Tanker
         end
       end
 
+      unless tanker_categories.empty?
+        options[:categories] = {}
+        tanker_categories.each do |field, block|
+          val = block ? instance_exec(&block) : send(field)
+          val = val.join(' ') if Array === val
+          options[:categories][field] = val.to_s unless val.nil?
+        end
+      end 
+  
       options
     end
 

data/spec/integration_spec.rb

@@ -21,19 +21,33 @@ ActiveRecord::Schema.define do
     t.string :tags
     t.text :description
   end
+  create_table :companies do |t|
+    t.string :name
+  end
 end
 
 class Product < ActiveRecord::Base
   include Tanker
 
+  scope :amazon, :conditions => {:href => "amazon"}
+
   tankit 'tanker_integration_tests' do
     indexes :name
-    indexes :href
+    indexes :href, :category => true
     indexes :tags
     indexes :description
   end
 end
 
+class Company < ActiveRecord::Base
+  include Tanker
+
+  tankit 'tanker_integration_tests' do
+    indexes :name
+  end
+end
+
+
 describe 'An imaginary store' do
 
   before(:all) do
@@ -67,6 +81,9 @@ describe 'An imaginary store' do
     @products_in_database = Product.all
 
     Product.tanker_reindex
+
+    @apple = Company.create(:name => 'apple')
+    Company.tanker_reindex
   end
 
   describe 'basic searching' do
@@ -106,6 +123,11 @@ describe 'An imaginary store' do
       results.should include(@iphone)
       results.should have(1).product
     end
+
+    it "should not find a Company when searching Product" do
+      results = Product.search_tank("apple")
+      results.should_not include(@apple)
+    end
   end
 
   describe 'searching by tag' do
@@ -241,5 +263,32 @@ describe 'An imaginary store' do
     end
   end
   
+  describe 'categories' do
+    it 'should find categories for query features' do
+      @results = Product.search_tank('features', :snippets => [:description], :fetch => [:name, :href])
+      @results.categories.should == {"href"=>{"amazon"=>1, "apple"=>1}}
+    end
+
+    it 'should find categories for query decent' do
+      @results = Product.search_tank('decent', :snippets => [:description], :fetch => [:name, :href])
+      @results.categories.should == {"href"=>{"amazon"=>2, "google"=>2, "yahoo"=>3, "ebay"=>1}}
+    end
+
+    it 'should apply actegory filters to search on products filtered by yahoo' do
+      category_filters = {
+        'href' => ['yahoo']
+      }
+      @results = Product.search_tank('decent', :snippets => [:description], :fetch => [:name, :href], :category_filters => category_filters )
+      @results.count.should == 3
+    end
+  end 
+  
+  describe 'on scope' do
+    it 'should return amazon product only', :focus => true do
+      results = Product.amazon.search_tank('decent')
+      results.should include(@samsung, @motorola)
+      results.should have_exactly(2).products
+    end
+  end
 end
 

data/spec/tanker_spec.rb

@@ -60,11 +60,33 @@ describe Tanker 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 set category values for indexable fields inline' do
+      @dummy_class.send(:tankit, 'dummy index') do
+        indexes :category, :category => true
+      end
+      
+      dummy_instance = @dummy_class.new
+      dummy_instance.tanker_config.categories.any? {|field, block| field == :category }.should == true
+    end
+
+    it 'should allow set category values for indexable fields from dynamic attributes' do
+      @dummy_class.send(:tankit, 'dummy index') do
+        indexes :category, :category => true
+        category :category_2 do
+          'blah'
+        end 
+      end
+      
+      dummy_instance = @dummy_class.new
+      dummy_instance.tanker_config.categories.any? {|field, block| field == :category }.should == true
+      dummy_instance.tanker_config.categories.any? {|field, block| field == :category_2 }.should == true
+    end
+
     it 'should allow blocks for indexable field data' do
       @dummy_class.send(:tankit, 'dummy index') do
         indexes :class_name do
@@ -207,7 +229,7 @@ describe Tanker do
         }
       )
 
-      Person.should_receive(:find).and_return(
+      Person.should_receive(:find_all_by_id).and_return(
       [Person.new]
       )
 
@@ -238,7 +260,7 @@ describe Tanker do
         }
       )
 
-      Person.should_receive(:find).with(['mystring1d', '1']).and_return(
+      Person.should_receive(:find_all_by_id).with(['mystring1d', '1']).and_return(
         [Person.new, Person.new]
       )
 
@@ -249,7 +271,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)) OR __any:(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})
 
@@ -301,10 +323,10 @@ describe Tanker do
         }
       )
 
-      Dog.should_receive(:find).and_return(
+      Dog.should_receive(:find_all_by_id).and_return(
         [Dog.new(:name => 'fido', :id => 7)]
       )
-      Cat.should_receive(:find).and_return(
+      Cat.should_receive(:find_all_by_id).and_return(
         [Cat.new(:name => 'fluffy', :id => 9)]
       )
 
@@ -328,7 +350,7 @@ describe Tanker do
           }]
         })
 
-      Foo::Bar.should_receive(:find).and_return([stub(:id => 42)])
+      Foo::Bar.should_receive(:find_all_by_id).and_return([stub(:id => 42)])
 
       Foo::Bar.search_tank('bar')
     end
@@ -352,10 +374,10 @@ describe Tanker do
         }
       )
 
-      Person.should_receive(:find).with(['1', '2']).and_return(
-        [Person.new, Person.new]
+      Person.should_receive(:find_all_by_id).with(['1', '2']).and_return(
+        [Person.new(:id => 1), Person.new(:id => 2)]
       )
-
+      
       collection = Person.search_tank('hey!', :paginate => false)
       collection.class.should == Array
       collection.size.should == 2
@@ -380,7 +402,7 @@ describe Tanker do
         }
       )
 
-      Person.should_receive(:find).with(['1', '2']).and_return(
+      Person.should_receive(:find_all_by_id).with(['1', '2']).and_return(
         [Person.new, Person.new]
       )
 
@@ -396,7 +418,7 @@ describe Tanker do
       person = Person.new(:name => 'Name', :last_name => 'Last Name')
 
       Person.tanker_index.should_receive(:add_document).with(
-        Person.new.it_doc_id,
+        Person.new(:id => 1).it_doc_id,
         {
           :__any     => "#{$frozen_moment.to_i} . Last Name . Name",
           :__type    => 'Person',
@@ -518,7 +540,7 @@ describe Tanker do
           "search_time" => 1
         }
       )
-      Person.should_receive(:find).and_return([Person.new])
+      Person.should_receive(:find_all_by_id).and_return([Person.new])
 
       lambda { Person.search_tank('test') }.should raise_error(Tanker::BadConfiguration)
     end
@@ -538,7 +560,7 @@ describe Tanker do
         }
       )
 
-      Person.should_receive(:find).and_return([Person.new])
+      Person.should_receive(:find_all_by_id).and_return([Person.new])
 
       array = Person.search_tank('hey!')
       array.class.should == Tanker::Pagination::Kaminari
@@ -548,4 +570,5 @@ describe Tanker do
       array.current_page.should == 1
     end
   end
+
 end

data/tanker.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tanker}
-  s.version = "1.1.3"
+  s.version = "1.1.4"
 
   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-07-01}
+  s.date = %q{2011-08-31}
   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 = [

metadata

@@ -2,7 +2,7 @@
 name: tanker
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors: 
 - Francisco Viramontes
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-01 00:00:00 Z
+date: 2011-08-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json