tire 0.1.1 → 0.1.2

data/README.markdown

@@ -209,8 +209,13 @@ Fortunately, _Tire_ makes blending _ElasticSearch_ features into your models tri
 ActiveModel Integration
 -----------------------
 
-Let's suppose you have an `Article` class in your Rails application. To make it searchable with
-_Tire_, you just `include` it:
+If you're the type with no time for lengthy introductions, you can generate a fully working
+example Rails application, with an `ActiveRecord` model and a search form, to play with:
+
+    $ rails new searchapp -m https://github.com/karmi/tire/raw/master/examples/rails-application-template.rb
+
+For the rest, let's suppose you have an `Article` class in your Rails application.
+To make it searchable with _Tire_, you just `include` it:
 
     class Article < ActiveRecord::Base
       include Tire::Model::Search
@@ -224,14 +229,18 @@ When you now save a record:
                    :author =>  "Captain Nemo",
                    :published_on => Time.now
 
-it is automatically added into the index, because of the included callbacks. The document attributes
-are indexed exactly as when you call the `Article#to_json` method.
+it is automatically added into the index, because of the included callbacks.
+(You may want to skip them in special cases, like when your records are indexed via some external
+mechanism, let's say CouchDB or RabbitMQ [river](http://www.elasticsearch.org/blog/2010/09/28/the_river.html)
+for _ElasticSearch_.)
+
+The document attributes are indexed exactly as when you call the `Article#to_json` method.
 
 Now you can search the records:
 
     Article.search 'love'
 
-OK. Often, this is where the game stops. Not here.
+OK. This is where the game stops, often. Not here.
 
 First of all, you may use the full query DSL, as explained above, with filters, sorting,
 advanced facet aggregation, highlighting, etc:
@@ -292,7 +301,7 @@ so you can pass any parameters to the `search` method in the controller, as usua
 
 OK. Chances are, you have lots of records stored in the underlying database. How will you get them to _ElasticSearch_? Easy:
 
-    Article.index.import Article.all
+    Article.elasticsearch_index.import Article.all
 
 However, this way, all your records are loaded into memory, serialized into JSON,
 and sent down the wire to _ElasticSearch_. Not practical, you say? You're right.
@@ -326,11 +335,6 @@ You can index your data into a fresh index (and possibly update an alias if ever
 
     $ rake environment tire:import CLASS='Article' INDEX='articles-2011-05'
 
-If you're the type who has no time for long introductions, you can generate a fully working
-example Rails application, with an `ActiveRecord` model and a search form, to play with:
-
-    $ rails new searchapp -m https://github.com/karmi/tire/raw/master/examples/rails-application-template.rb
-
 OK. All this time we have been talking about `ActiveRecord` models, since
 it is a reasonable Rails' default for the storage layer.
 
@@ -408,6 +412,8 @@ _Tire_ is already used in production by its authors. Nevertheless, it's not cons
 
 There are todos, plans and ideas, some of which are listed below, in the order of importance:
 
+* Wrap all Tire functionality mixed into a model in a "forwardable" object, and proxy everything via this object. (The immediate problem: [Mongoid](http://mongoid.org/docs/indexing.html))
+* If we're not stepping on other's toes, bring Tire methods like `index`, `search`, `mapping` also to the class/instance top-level namespace.
 * Proper RDoc annotations for the source code
 * [Histogram](http://www.elasticsearch.org/guide/reference/api/search/facets/histogram-facet.html) facets
 * [Statistical](http://www.elasticsearch.org/guide/reference/api/search/facets/statistical-facet.html) facets

data/examples/rails-application-template.rb

@@ -2,33 +2,53 @@
 # Template for generating a no-frills Rails application with support for ElasticSearch full-text search via Tire
 # ===================================================================================================================
 #
-# This file creates a basic, fully working Rails application
-# with support for ElasticSearch full-text search via the Tire gem.
+# This file creates a basic, fully working Rails application with support for ElasticSearch full-text search
+# via the Tire gem [http://github.com/karmi/tire].
 #
+# You DON'T NEED ELASTICSEARCH INSTALLED, it is installed and launched automatically by this script.
 #
 # Requirements
 # ------------
 #
+# * Git
 # * Ruby >= 1.8.7
 # * Rubygems
-# * Rails 3
+# * Rails >= 3.0.7
+# * Sun Java 6 (for ElasticSearch)
 #
 #
 # Usage
 # -----
 #
-#     $ rails new searchapp -m https://github.com/karmi/tire/raw/master/examples/rails-application-template.rb
+#     $ rails new tired -m https://github.com/karmi/tire/raw/master/examples/rails-application-template.rb
 #
 # ===================================================================================================================
 
 require 'rubygems'
-require 'restclient'
 
-at_exit do
-  say_status  "Stop", "ElasticSearch", :yellow
+begin
+  require 'restclient'
+rescue LoadError
+  puts        "\n"
+  say_status  "ERROR", "Rubygem 'rest-client' not installed\n", :red
+  puts        '-'*80
+  say_status  "", "gem install rest-client"
+  puts        "\n"
 
+  if yes?("Should I install it for you?", :bold)
+    say_status "gem", "install rest-client", :yellow
+    system "gem install rest-client"
+  else
+    exit(1)
+  end
+end
+
+at_exit do
   pid = File.read("#{destination_root}/tmp/pids/elasticsearch.pid") rescue nil
-  run "kill #{pid}" if pid
+  if pid
+    say_status  "Stop", "ElasticSearch", :yellow
+    run "kill #{pid}"
+  end
 end
 
 run "rm public/index.html"

data/lib/tire/model/import.rb

@@ -7,7 +7,7 @@ module Tire
 
         def import options={}, &block
           method = options.delete(:method) || 'paginate'
-          self.index.import self, method, options, &block
+          self.elasticsearch_index.import self, method, options, &block
         end
 
       end

data/lib/tire/model/indexing.rb

@@ -28,8 +28,8 @@ module Tire
         def create_index_or_update_mapping
           # STDERR.puts "Creating index with mapping", mapping_to_hash.inspect
           # STDERR.puts "Index exists?, #{index.exists?}"
-          unless index.exists?
-            index.create :mappings => mapping_to_hash
+          unless elasticsearch_index.exists?
+            elasticsearch_index.create :mappings => mapping_to_hash
           else
             # TODO: Update mapping
           end

data/lib/tire/model/search.rb

@@ -31,7 +31,7 @@ module Tire
           sort  = options[:order] || options[:sort]
           sort  = Array(sort)
           unless block_given?
-            s = Tire::Search::Search.new(index.name, options)
+            s = Tire::Search::Search.new(elasticsearch_index.name, options)
             s.query { string query }
             s.sort do
               sort.each do |t|
@@ -43,7 +43,7 @@ module Tire
             s.from( options[:page].to_i <= 1 ? 0 : (options[:per_page].to_i * (options[:page].to_i-1)) ) if options[:page] && options[:per_page]
             s.perform.results
           else
-            s = Tire::Search::Search.new(index.name, options)
+            s = Tire::Search::Search.new(elasticsearch_index.name, options)
             block.arity < 1 ? s.instance_eval(&block) : block.call(s)
             s.perform.results
           end
@@ -51,7 +51,15 @@ module Tire
           Tire::Configuration.wrapper old_wrapper
         end
 
-        def index
+        # Wrapper for the ES index for this class
+        #
+        # TODO: Implement some "forwardable" object named +tire+ for Tire mixins,
+        #       and proxy everything via this object. If we're not stepping on
+        #       other libs toes, extend/include also to the top level.
+        #
+        #       The original culprit is Mongoid here, see https://github.com/karmi/tire/issues/7
+        #
+        def elasticsearch_index
           @index = Index.new(index_name)
         end
 
@@ -64,14 +72,14 @@ module Tire
         end
 
         def index
-          self.class.index
+          self.class.elasticsearch_index
         end
 
         def update_elastic_search_index
           if destroyed?
-            self.class.index.remove document_type, self
+            index.remove document_type, self
           else
-            response  = self.class.index.store  document_type, self
+            response  = index.store  document_type, self
             self.id ||= response['_id'] if self.respond_to?(:id=)
             self
           end

data/lib/tire/tasks.rb

@@ -44,7 +44,7 @@ namespace :tire do
     klass  = eval(ENV['CLASS'].to_s)
     params = eval(ENV['PARAMS'].to_s) || {}
 
-    index = Tire::Index.new( ENV['INDEX'] || klass.index.name )
+    index = Tire::Index.new( ENV['INDEX'] || klass.elasticsearch_index.name )
 
     if ENV['FORCE']
       puts "[IMPORT] Deleting index '#{index.name}'"

data/lib/tire/version.rb

@@ -1,3 +1,3 @@
 module Tire
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/integration/active_model_searchable_test.rb

@@ -28,7 +28,7 @@ module Tire
         assert_equal 'czech', SupermodelArticle.mapping[:title][:analyzer]
         assert_equal 15,      SupermodelArticle.mapping[:title][:boost]
 
-        assert_equal 'czech', SupermodelArticle.index.mapping['supermodel_article']['properties']['title']['analyzer']
+        assert_equal 'czech', SupermodelArticle.elasticsearch_index.mapping['supermodel_article']['properties']['title']['analyzer']
       end
 
       should "save document into index on save and find it with score" do
@@ -65,7 +65,7 @@ module Tire
         SupermodelArticle.create! :title => 'foo'
         SupermodelArticle.create! :title => 'bar'
 
-        SupermodelArticle.index.refresh
+        SupermodelArticle.elasticsearch_index.refresh
         results = SupermodelArticle.search 'foo OR bar^100'
 
         assert_equal 2, results.count

data/test/integration/active_record_searchable_test.rb

@@ -37,7 +37,7 @@ module Tire
         assert_equal 'snowball', ActiveRecordArticle.mapping[:title][:analyzer]
         assert_equal 10, ActiveRecordArticle.mapping[:title][:boost]
 
-        assert_equal 'snowball', ActiveRecordArticle.index.mapping['active_record_article']['properties']['title']['analyzer']
+        assert_equal 'snowball', ActiveRecordArticle.elasticsearch_index.mapping['active_record_article']['properties']['title']['analyzer']
       end
 
       should "save document into index on save and find it" do
@@ -75,7 +75,7 @@ module Tire
         ActiveRecordArticle.create! :title => 'foo'
         ActiveRecordArticle.create! :title => 'bar'
 
-        ActiveRecordArticle.index.refresh
+        ActiveRecordArticle.elasticsearch_index.refresh
         results = ActiveRecordArticle.search 'foo OR bar^100'
         assert_equal 2, results.count
 
@@ -85,7 +85,7 @@ module Tire
       context "with pagination" do
         setup do
           1.upto(9) { |number| ActiveRecordArticle.create :title => "Test#{number}" }
-          ActiveRecordArticle.index.refresh
+          ActiveRecordArticle.elasticsearch_index.refresh
         end
 
         context "and parameter searches" do

data/test/unit/index_test.rb

@@ -253,7 +253,7 @@ module Tire
           one = ActiveModelArticle.new 'title' => 'One'; one.id = '1'
           two = ActiveModelArticle.new 'title' => 'Two'; two.id = '2'
 
-          ActiveModelArticle.index.bulk_store [ one, two ]
+          ActiveModelArticle.elasticsearch_index.bulk_store [ one, two ]
 
         end
 

data/test/unit/model_search_test.rb

@@ -20,6 +20,21 @@ module Tire
           assert_respond_to ActiveModelArticle, :search
         end
 
+        should_eventually "contain all Tire class/instance methods in a proxy object" do
+        end
+
+        should_eventually "include Tire class methods in class top-level namespace when they do not exist" do
+        end
+
+        should_eventually "include Tire instance methods in instance top-level namespace when they do not exist" do
+        end
+
+        should_eventually "NOT overload existing top-level class methods" do
+        end
+
+        should_eventually "NOT overload existing top-level instance methods" do
+        end
+
         should "search in index named after class name by default" do
           i = 'active_model_articles'
           Tire::Search::Search.expects(:new).with(i, {}).returns(@stub)
@@ -27,6 +42,9 @@ module Tire
           ActiveModelArticle.search 'foo'
         end
 
+        should_eventually "search only in document types for this class by default" do
+        end
+
         should "search in custom name" do
           first  = 'custom-index-name'
           second = 'another-custom-index-name'
@@ -47,7 +65,7 @@ module Tire
         should "allow to refresh index" do
           Index.any_instance.expects(:refresh)
 
-          ActiveModelArticle.index.refresh
+          ActiveModelArticle.elasticsearch_index.refresh
         end
 
         should "wrap results in proper class with ID and score and not change the original wrapper" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tire
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Karel Minarik
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-02 00:00:00 +02:00
+date: 2011-05-03 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency