thinkingtank 0.0.4 → 0.0.5

data/lib/thinkingtank.rb

@@ -0,0 +1,14 @@
+require 'rails'
+require 'thinkingtank/init'
+
+if defined?(Rails::Railtie)
+    # Rails 3
+    # The Railtie will load the Activerecord extensions at the appropriate
+    # point in the boot process
+    require 'thinkingtank/railtie'
+else
+    # Rails 2
+    # Load the extensions now, since we don't have fine-grained control like
+    # in a Railtie
+    require 'thinkingtank/activerecord_extensions'
+end

data/lib/thinkingtank/activerecord_extensions.rb

@@ -0,0 +1,60 @@
+require 'thinkingtank/init'
+
+class << ActiveRecord::Base
+    @indexable = false
+    def search(*args)
+        return indextank_search(true, *args)
+    end
+    def search_raw(*args)
+        return indextank_search(false, *args)
+    end
+
+    def define_index(name = nil, &block)
+        include ThinkingTank::IndexMethods
+        @thinkingtank_builder = ThinkingTank::Builder.new self, &block
+        @indexable = true
+        after_save :update_index
+    end
+
+    def is_indexable?
+        return @indexable
+    end
+
+    def thinkingtank_builder
+        return @thinkingtank_builder
+    end
+
+    private
+
+    def indextank_search(models, *args)
+        options = args.extract_options!
+        query = args.join(' ')
+
+        # transform fields in query
+
+        if options.has_key? :conditions
+            options[:conditions].each do |field,value|
+                query += " #{field}:(#{value})"
+            end
+        end
+
+        options.slice!(:snippet, :fetch, :function)
+
+        it = ThinkingTank::Configuration.instance.client
+        models = []
+        res = it.search("__any:(#{query.to_s}) __type:#{self.name}", options)
+        if models
+            res['results'].each do |doc|
+                type, docid = doc['docid'].split(" ", 2)
+                models << self.find(id=docid)
+            end
+            return models
+        else
+            res['results'].each do |doc|
+                type, docid = doc['docid'].split(" ", 2)
+                doc['model'] = self.find(id=docid)
+            end
+            return res
+        end
+    end
+end

data/lib/{indextank_client.rb → thinkingtank/indextank_client.rb}

@@ -246,7 +246,7 @@ module IndexTank
     
     class HerokuClient < ApiClient
         def initialize()
-            super(ENV['HEROKUTANK_API_URL'])
+            super(ENV['INDEXTANK_API_URL'])
         end
     end
 

data/lib/thinkingtank/init.rb

@@ -1,4 +1,10 @@
-require 'indextank_client'
+# Require these to allow requiring thinkingtank outside a Rails app, e.g.
+# for testing.
+require 'erb'
+require 'yaml'
+require 'singleton'
+
+require 'thinkingtank/indextank_client'
 
 module ThinkingTank
     class Builder
@@ -23,6 +29,7 @@ module ThinkingTank
         include Singleton
         attr_accessor :app_root, :client
         def initialize
+            self.app_root = Rails.root if defined?(Rails.root)
             self.app_root = RAILS_ROOT if defined?(RAILS_ROOT)
             self.app_root = Merb.root  if defined?(Merb)
             self.app_root ||= Dir.pwd
@@ -31,12 +38,15 @@ module ThinkingTank
             return unless File.exists?(path)
 
             conf = YAML::load(ERB.new(IO.read(path)).result)[environment]
-            api_url = ENV['HEROKUTANK_API_URL'] || conf['api_url']
-            self.client = IndexTank::ApiClient.new(api_url).get_index(conf['index_name'])
+            api_url = ENV['INDEXTANK_API_URL'] || conf['api_url']
+            index_name = conf['index_name'] || 'default_index'
+            self.client = IndexTank::ApiClient.new(api_url).get_index(index_name)
         end
         def environment
             if defined?(Merb)
                 Merb.environment
+            elsif defined?(Rails.env)
+                Rails.env
             elsif defined?(RAILS_ENV)
                 RAILS_ENV
             else
@@ -61,65 +71,3 @@ module ThinkingTank
     end
 
 end
-
-class << ActiveRecord::Base
-    @indexable = false
-    def search(*args)
-        return indextank_search(true, *args)
-    end
-    def search_raw(*args)
-        return indextank_search(false, *args)
-    end
-
-    def define_index(name = nil, &block)
-        include ThinkingTank::IndexMethods
-        @thinkingtank_builder = ThinkingTank::Builder.new self, &block
-        @indexable = true
-        after_save :update_index
-    end
-
-    def is_indexable?
-        return @indexable
-    end
-
-    def thinkingtank_builder
-        return @thinkingtank_builder
-    end
-    
-    private
-    
-    def indextank_search(models, *args)
-        options = args.extract_options!
-        query = args.join(' ')
-        
-        # transform fields in query
-        
-        if options.has_key? :conditions
-            options[:conditions].each do |field,value|
-                query += " #{field}:(#{value})"
-            end
-        end
-        
-        options.slice!(:snippet, :fetch, :function)
-
-        it = ThinkingTank::Configuration.instance.client
-        models = []
-        res = it.search("__any:(#{query.to_s}) __type:#{self.name}", options)
-        if models
-            res['results'].each do |doc|
-                type, docid = doc['docid'].split(" ", 2)
-                models << self.find(id=docid)
-            end
-            return models
-        else
-            res['results'].each do |doc|
-                type, docid = doc['docid'].split(" ", 2)
-                doc['model'] = self.find(id=docid)
-            end
-            return res
-        end
-    end
-
-end
-
-

data/lib/thinkingtank/railtie.rb

@@ -0,0 +1,9 @@
+class ThinkingTankRailtie < ::Rails::Railtie
+    rake_tasks do
+        require 'thinkingtank/tasks'
+    end
+
+    config.before_initialize do
+        require 'thinkingtank/activerecord_extensions'
+    end
+end

data/lib/thinkingtank/tasks.rb

@@ -1,6 +1,5 @@
-require 'erb'
-require 'active_record'
-require 'indextank_client'
+# Load init for Rails 2, since it directly loads this file
+require 'thinkingtank/init'
 
 def load_models
     app_root = ThinkingTank::Configuration.instance.app_root
@@ -30,19 +29,44 @@ end
 
 def reindex_models
     it = ThinkingTank::Configuration.instance.client
-    if it.exists?
+    if it.nil?
+        puts "!!! Couldn't create a client. Does config/indextank.yml have the correct info?"
+        return false
+    end
+
+    if it.exists? and it.code
+        # Check for code because it.exists? may return true for a
+        # nonexistent index
         puts "Deleting existing index"
         it.delete_index()
     end
     puts "Creating a new empty index"
     it.create_index()
-    puts "Waiting for the index to be ready"
+    puts "Waiting for the index to be ready (this might take a while)"
     while not it.running?
+        print "."
+        STDOUT.flush
         sleep 0.5
     end
+    print "\n"
+    STDOUT.flush
+
+
+    subclasses = nil
+    if ActiveRecord::Base.respond_to?(:descendants)
+        # Rails 3.0.0 and higher
+        subclasses = ActiveRecord::Base.descendants
+    elsif Object.respond_to?(:subclasses_of)
+        subclasses = Object.subclasses_of(ActiveRecord::Base)
+    end
 
-    Object.subclasses_of(ActiveRecord::Base).each do |klass|
-        reindex klass if klass.is_indexable?
+    if subclasses.nil?
+        STDERR.puts "Couldn't detect models to index."
+        return false
+    else
+        subclasses.each do |klass|
+            reindex klass if klass.is_indexable?
+        end
     end
 end
 
@@ -54,6 +78,8 @@ def reindex(klass)
 end
 
 namespace :indextank do
+    # MUST have a description for it to show up in rake -T!
+    desc "Reindex all models. This deletes and recreates the index."
     task :reindex => :environment do
         load_models
         reindex_models
@@ -61,5 +87,6 @@ namespace :indextank do
 end
 
 namespace :it do
+    desc "An alias for indextank:reindex"
     task :reindex => "indextank:reindex"
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: thinkingtank
 version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Flaptor
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-27 00:00:00 -07:00
+date: 2010-12-23 00:00:00 -02:00
 default_executable: 
 dependencies: []
 
@@ -29,12 +30,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- rails/init.rb
-- lib/indextank_client.rb
+- lib/thinkingtank/indextank_client.rb
 - lib/thinkingtank/init.rb
-- README
-- tasks/rails.rake
+- lib/thinkingtank/railtie.rb
 - lib/thinkingtank/tasks.rb
+- lib/thinkingtank/activerecord_extensions.rb
+- lib/thinkingtank.rb
 has_rdoc: true
 homepage: http://indextank.com/
 licenses: []
@@ -45,23 +46,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Thinking-Sphinx-like Indextank plugin.

data/README

@@ -1,67 +0,0 @@
-ThinkingTank
-=============
-
-ActiveRecord extension that allows to define models that should be indexed 
-in an existing IndexTank index. It supports a very similar syntax to 
-ThinkingSphinx allowing to easily port an existing project.
-
-Every indexable model should include a define_index block in its class 
-definition, see the example for more details. This block supports the indexes
- method and receives a field name.
-
-Model classes now have a search method that receives one or more string 
-arguments with query strings (according to the query specifications) and 
-supports the :conditions argument as a hash from field name to query string. 
-
-In order for this extension to work you need to define a config/indextank.yml
-in your application with the api_key and index_code (or index_name) settings 
-for each environment (similar to config/database.yml).
-
-Indexed fields in ActiveRecord are prepended an underscore when sent to 
-IndexTank so if you plan to write query strings that use your field names you 
-will have to prepend the underscore to the field names.
-
-In order for the ThinkingTank rake tasks to be available you need to add:
-
-    require 'thinkingtank/tasks'
-    
-to your Rakefile. You can use the following task to reindex your entire database:
-
-    rake indextank:reindex
-
-
-Example
-=======
-
-Sample config/indextank.yml file:
-
-        development:
-          api_key: '<YOUR API KEY>'
-          index_code: '<INDEX CODE>'
-          # instead of index_code you can also use an index_name
-        test:
-          api_key: '<YOUR API KEY>'
-          index_code: '<INDEX CODE>'
-          # instead of index_code you can also use an index_name
-        production:
-          api_key: '<YOUR API KEY>'
-          index_code: '<INDEX CODE>'
-          # instead of index_code you can also use an index_name
-
-Sample model:
-    class Person < ActiveRecord::Base
-        define_index do
-            indexes :name
-            indexes gender
-            indexes age
-        end
-    end
-
-Sample query code:
-    Person.search("john")
-    Person.search("john OR stacey")
-    Person.search("stacey", :conditions => { :age => 25 } )
-    Person.search("james", :conditions => { :age => 25 , :gender => "female" } )
-   
-
-Copyright(c) 2010 Flaptor Inc.

data/rails/init.rb

@@ -1,4 +0,0 @@
-# Include hook code here
-require 'active_record'
-require File.dirname(__FILE__) + '/../lib/thinkingtank/init'
-

data/tasks/rails.rake

@@ -1 +0,0 @@
-require File.join(File.dirname(__FILE__), '/tasks')