tanker 0.3.0 → 0.5.0

data/README.rdoc

@@ -5,8 +5,7 @@
 IndexTank is a great search indexing service, this gem tries to make 
 any orm keep in sync with indextank with ease. This gem has a simple 
 but powerful approach to integrating IndexTank to any orm. The gem 
-also supports pagination using the +will_paginate/collection+. Its dead
-simple to integrate with Rails 3 basically you just need to 
+also supports pagination using the +will_paginate/collection+.
 
 There are very few things needed to integrate Tanker to any orm. 
 Basically the orm instance must respond to +id+ and any attributes 
@@ -41,7 +40,7 @@ in the IndexTank Dashboard
       include Tanker
 
       # define the index by supplying the index name and the fields to index
-      tankit 'lgbt' do
+      tankit 'my_index' do
         indexes :title
         indexes :content
         indexes :tag_list #NOTICE this is an array of Tags! Awesome!

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.5.0

data/lib/tanker/configuration.rb

@@ -3,7 +3,7 @@ module Tanker
   module Configuration
 
     def configuration
-     @@configuration || raise(NotConfigured, "Please configure Tanker. Set Tanker.configuration = {:url => ''}")
+      @@configuration || raise(NotConfigured, "Please configure Tanker. Set Tanker.configuration = {:url => ''}")
     end
 
     def configuration=(new_configuration)

data/lib/tanker/railtie.rb

@@ -0,0 +1,16 @@
+require 'rails'
+
+module Tanker
+  class Railtie < Rails::Railtie
+    config.index_tank_url = ''
+
+    config.after_initialize do
+      Tanker.configuration = {:url => config.index_tank_url }
+    end
+
+    rake_tasks do
+      load "tanker/tasks/tanker.rake"
+    end
+
+  end
+end

data/lib/tanker/tasks/tanker.rake

@@ -0,0 +1,29 @@
+namespace :tanker do
+ 
+  desc "Reindex all models"
+  task :reindex => :environment do
+    puts "reinexing all models"
+    load_models
+    Tanker::Utilities.reindex_all_models
+  end
+  
+  desc "Clear all Index Tank indexes"
+  task :clear_indexes => :environment do
+    puts "clearing all indexes"
+    load_models
+    Tanker::Utilities.clear_all_indexes
+  end
+  
+  def load_models
+    app_root = Rails.root
+    dirs = ["#{app_root}/app/models/"] + Dir.glob("#{app_root}/vendor/plugins/*/app/models/")
+    
+    dirs.each do |base|
+      Dir["#{base}**/*.rb"].each do |file|
+        model_name = file.gsub(/^#{base}([\w_\/\\]+)\.rb/, '\1')
+        next if model_name.nil?
+        model_name.camelize.constantize
+      end
+    end
+  end
+end

data/lib/tanker/utilities.rb

@@ -0,0 +1,44 @@
+module Tanker
+  module Utilities
+    class << self
+      def get_model_classes
+        Tanker.included_in ? Tanker.included_in : []
+      end
+
+      def get_available_indexes
+        get_model_classes.map{|model| model.index_name}.uniq.compact
+      end
+
+      def clear_all_indexes
+        get_available_indexes.each do |index_name|
+          begin
+            index = Tanker.api.get_index(index_name)
+
+            if index.exists?
+              puts "Deleting #{index_name} index"
+              index.delete_index()
+            end
+            puts "Creating #{index_name} index"
+            index.create_index()
+            puts "Waiting for the index to be ready"
+            while not index.running?
+              sleep 0.5
+            end
+          rescue => e
+            puts "There was an error clearing or creating the #{index_name} index: #{e.to_s}"
+          end
+        end
+      end
+
+      def reindex_all_models
+        get_model_classes.each do |klass|
+          puts "Indexing #{klass.to_s} model"
+          klass.all.each do |model_instance|
+            model_instance.update_tank_indexes
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/tanker.rb

@@ -1,11 +1,17 @@
 require "rubygems"
 require "bundler"
-require 'indextank_client'
 
+Bundler.setup :default
+
+require 'indextank_client'
 require 'tanker/configuration'
+require 'tanker/utilities'
 require 'will_paginate/collection'
 
-Bundler.setup :default
+
+if defined? Rails
+  require 'tanker/railtie'
+end
 
 module Tanker
 
@@ -13,11 +19,20 @@ module Tanker
   class NoBlockGiven < StandardError; end
 
   autoload :Configuration, 'tanker/configuration'
-
   extend Configuration
 
   class << self
+    attr_reader :included_in
+
+    def api
+      @api ||= IndexTank::ApiClient.new(Tanker.configuration[:url])
+    end
+
     def included(klass)
+      @included_in ||= []
+      @included_in << klass
+      @included_in.uniq!
+
       klass.instance_variable_set('@tanker_configuration', configuration)
       klass.instance_variable_set('@tanker_indexes', [])
       klass.send :include, InstanceMethods
@@ -26,7 +41,6 @@ module Tanker
       class << klass
         define_method(:per_page) { 10 } unless respond_to?(:per_page)
       end
-
     end
   end
 
@@ -48,15 +62,12 @@ module Tanker
       @tanker_indexes << field
     end
 
-    def api
-      @api ||= IndexTank::ApiClient.new(Tanker.configuration[:url])
-    end
-
     def index
-      @index ||= api.get_index(self.index_name)
+      @index ||= Tanker.api.get_index(self.index_name)
     end
 
     def search_tank(query, options = {})
+      ids      = []
       page     = options.delete(:page) || 1
       per_page = options.delete(:per_page) || self.per_page
 
@@ -72,13 +83,12 @@ module Tanker
 
       results = index.search(query, options)
 
-      unless results[:results].empty?
-        ids = results[:results].map{|res| res[:docid].split(" ", 2)}
+      unless results["results"].empty?
+        ids = results["results"].map{|res| res["docid"].split(" ", 2)[1]}
       else
         return nil
       end
 
-
       @entries = WillPaginate::Collection.create(page, per_page) do |pager|
         result = self.find(ids)
         # inject the result array into the paginated collection:
@@ -86,20 +96,21 @@ module Tanker
 
         unless pager.total_entries
           # the pager didn't manage to guess the total count, do it manually
-          pager.total_entries = results[:matches]
+          pager.total_entries = results["matches"]
         end
       end
     end
 
   end
 
-  # these are the instace methods included que
+  # these are the instance methods included
   module InstanceMethods
 
     def tanker_indexes
       self.class.tanker_indexes
     end
 
+    # update a create instance from index tank
     def update_tank_indexes
       data = {}
 
@@ -114,13 +125,15 @@ module Tanker
       self.class.index.add_document(it_doc_id, data)
     end
 
+    # delete instance from index tank
     def delete_tank_indexes
       self.class.index.delete_document(it_doc_id)
     end
 
+    # create a unique index based on the model name and unique id
     def it_doc_id
       self.class.name + ' ' + self.id.to_s
     end
-
   end
 end
+

data/spec/spec_helper.rb

@@ -9,3 +9,50 @@ require 'rspec'
 Rspec.configure do |c|
   c.mock_with :rspec
 end
+
+Tanker.configuration = {:url => 'http://api.indextank.com'}
+
+class Dummy
+
+end
+
+class Person
+  include Tanker
+
+  tankit 'people' do
+    indexes :name
+    indexes :last_name
+  end
+
+  def id
+    1
+  end
+
+  def name
+    'paco'
+  end
+
+  def last_name
+    'viramontes'
+  end
+end
+
+class Dog
+  include Tanker
+
+  tankit 'animals' do
+    indexes :name
+  end
+
+end
+
+class Cat
+  include Tanker
+
+  tankit 'animals' do
+    indexes :name
+  end
+
+end
+
+

data/spec/tanker_spec.rb

@@ -1,33 +1,5 @@
 require 'spec_helper'
 
-Tanker.configuration = {:url => 'http://api.indextank.com'}
-
-class Dummy
-
-end
-
-
-class Person
-  include Tanker
-
-  tankit 'persons' do
-    indexes :name
-    indexes :last_name
-  end
-
-  def id
-    1
-  end
-
-  def name
-    'paco'
-  end
-
-  def last_name
-    'viramontes'
-  end
-end
-
 describe Tanker do
 
   it 'sets configuration' do
@@ -66,7 +38,7 @@ describe Tanker do
 
   describe 'tanker instance' do
     it 'should create an api instance' do
-      Person.api.class.should == IndexTank::ApiClient
+      Tanker.api.class.should == IndexTank::ApiClient
     end
 
     it 'should create a connexion to index tank' do
@@ -76,12 +48,12 @@ describe Tanker do
     it 'should be able to perform a seach query' do
       Person.index.should_receive(:search).and_return(
         {
-          :matches => 1,
-          :results => [{
-            :docid => Person.new.it_doc_id,
-            :name  => 'pedro'
+          "matches" => 1,
+          "results" => [{
+            "docid" => Person.new.it_doc_id,
+            "name"  => 'pedro'
           }],
-          :search_time => 1
+          "search_time" => 1
         }
       )
 

data/spec/utilities_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+class Dummy
+  include Tanker
+
+  tankit 'dummy index' do
+    indexes :name
+  end
+
+end
+
+
+describe Tanker::Utilities do
+
+  it "should get the models where Tanker module was included" do
+    (Tanker::Utilities.get_model_classes - [Dummy, Person, Dog, Cat]).should == []
+  end
+
+  it "should get the available indexes" do
+    Tanker::Utilities.get_available_indexes.should == ["people", "animals", "dummy index"]
+  end
+
+end

data/tanker.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tanker}
-  s.version = "0.3.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["@kidpollo"]
-  s.date = %q{2010-10-04}
+  s.date = %q{2010-10-21}
   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 = [
@@ -29,8 +29,12 @@ Gem::Specification.new do |s|
      "lib/indextank_client.rb",
      "lib/tanker.rb",
      "lib/tanker/configuration.rb",
+     "lib/tanker/railtie.rb",
+     "lib/tanker/tasks/tanker.rake",
+     "lib/tanker/utilities.rb",
      "spec/spec_helper.rb",
      "spec/tanker_spec.rb",
+     "spec/utilities_spec.rb",
      "tanker.gemspec"
   ]
   s.homepage = %q{http://github.com/kidpollo/tanker}
@@ -40,7 +44,8 @@ Gem::Specification.new do |s|
   s.summary = %q{IndexTank integration to your favorite orm}
   s.test_files = [
     "spec/spec_helper.rb",
-     "spec/tanker_spec.rb"
+     "spec/tanker_spec.rb",
+     "spec/utilities_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 5
   - 0
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - "@kidpollo"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-04 00:00:00 -05:00
+date: 2010-10-21 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,8 +71,12 @@ files:
 - lib/indextank_client.rb
 - lib/tanker.rb
 - lib/tanker/configuration.rb
+- lib/tanker/railtie.rb
+- lib/tanker/tasks/tanker.rake
+- lib/tanker/utilities.rb
 - spec/spec_helper.rb
 - spec/tanker_spec.rb
+- spec/utilities_spec.rb
 - tanker.gemspec
 has_rdoc: true
 homepage: http://github.com/kidpollo/tanker
@@ -109,3 +113,4 @@ summary: IndexTank integration to your favorite orm
 test_files: 
 - spec/spec_helper.rb
 - spec/tanker_spec.rb
+- spec/utilities_spec.rb