tire 0.1.16 → 0.2.0

data/test/integration/filters_test.rb

@@ -36,7 +36,7 @@ module Tire
         end
 
         assert_equal 1, s.results.count
-        assert_equal 3, s.results.facets['tags'].size
+        assert_equal 3, s.results.facets['tags']['terms'].size
       end
 
     end

data/test/integration/highlight_test.rb

@@ -32,7 +32,6 @@ module Tire
           store   :id => 1, :content => content
           refresh
         end
-        sleep(0.5)
 
         s = Tire.search('highlight-test') do
           query { string 'fox' }

data/test/integration/index_mapping_test.rb

@@ -6,7 +6,7 @@ module Tire
     include Test::Integration
 
     context "Default mapping" do
-      teardown { Tire.index('mapped-index').delete }
+      teardown { Tire.index('mapped-index').delete; sleep 0.1 }
 
       should "create and return the default mapping" do
 
@@ -14,8 +14,8 @@ module Tire
           create
           store :type => :article, :title => 'One'
           refresh
+          sleep 1
         end
-        sleep 1.5
 
         assert_equal 'string', index.mapping['article']['properties']['title']['type'],  index.mapping.inspect
         assert_nil             index.mapping['article']['properties']['title']['boost'], index.mapping.inspect
@@ -23,14 +23,13 @@ module Tire
     end
 
     context "Creating index with mapping" do
-      teardown { Tire.index('mapped-index').delete; sleep 1 }
+      teardown { Tire.index('mapped-index').delete; sleep 0.1 }
     
       should "create the specified mapping" do
     
         index = Tire.index 'mapped-index' do
           create :mappings => { :article => { :properties => { :title => { :type => 'string', :boost => 2.0, :store => 'yes' } } } }
         end
-        sleep 1
 
         # p index.mapping    
         assert_equal 2.0,   index.mapping['article']['properties']['title']['boost'],  index.mapping.inspect

data/test/integration/percolator_test.rb

@@ -20,7 +20,7 @@ module Tire
         should "register query as a Hash" do
           query = { :query => { :query_string => { :query => 'warning' } } }
           assert @index.register_percolator_query('alert', query)
-          Tire.index('_percolator').refresh; sleep 0.1
+          Tire.index('_percolator').refresh
 
           percolator = Configuration.client.get("#{Configuration.url}/_percolator/percolator-test/alert")
           assert percolator
@@ -28,7 +28,7 @@ module Tire
 
         should "register query as block" do
           assert @index.register_percolator_query('alert') { string 'warning' }
-          Tire.index('_percolator').refresh; sleep 0.1
+          Tire.index('_percolator').refresh
 
           percolator = Configuration.client.get("#{Configuration.url}/_percolator/percolator-test/alert")
           assert percolator
@@ -37,11 +37,11 @@ module Tire
         should "unregister a query" do
           query = { :query => { :query_string => { :query => 'warning' } } }
           assert @index.register_percolator_query('alert', query)
-          Tire.index('_percolator').refresh; sleep 0.1
+          Tire.index('_percolator').refresh
           assert Configuration.client.get("#{Configuration.url}/_percolator/percolator-test/alert")
 
           assert @index.unregister_percolator_query('alert')
-          Tire.index('_percolator').refresh; sleep 0.1
+          Tire.index('_percolator').refresh
 
           assert_raise(RestClient::ResourceNotFound) do
             Configuration.client.get("#{Configuration.url}/_percolator/percolator-test/alert")
@@ -55,7 +55,7 @@ module Tire
           @index.register_percolator_query('alert') { string 'warning' }
           @index.register_percolator_query('gantz') { string '"y u no match"' }
           @index.register_percolator_query('weather', :tags => ['weather']) { string 'severe' }
-          Tire.index('_percolator').refresh; sleep 0.1
+          Tire.index('_percolator').refresh
         end
 
         should "return an empty array when no query matches" do
@@ -79,7 +79,7 @@ module Tire
           @index.register_percolator_query('alert') { string 'warning' }
           @index.register_percolator_query('gantz') { string '"y u no match"' }
           @index.register_percolator_query('weather', :tags => ['weather']) { string 'severe' }
-          Tire.index('_percolator').refresh; sleep 0.1
+          Tire.index('_percolator').refresh
         end
 
         should "return an empty array when no query matches" do

data/test/integration/persistent_model_test.rb

@@ -22,13 +22,31 @@ module Tire
         two = PersistentArticle.create :id => 2, :title => 'Two'
 
         PersistentArticle.index.refresh
-        sleep(1.5)
 
         results = PersistentArticle.find [1, 2]
 
         assert_equal 2, results.size
         
       end
+
+      context "with pagination" do
+
+        setup do
+          1.upto(9) { |number| PersistentArticle.create :title => "Test#{number}" }
+          PersistentArticle.elasticsearch_index.refresh
+        end
+
+        should "find first page with five results" do
+          results = PersistentArticle.search( :per_page => 5, :page => 1 ) { query { all } }
+          assert_equal 5, results.size
+
+          assert_equal 2, results.total_pages
+          assert_equal 1, results.current_page
+          assert_equal nil, results.previous_page
+          assert_equal 2, results.next_page
+        end
+      end
+
     end
 
   end

data/test/integration/query_string_test.rb

@@ -30,6 +30,15 @@ module Tire
         assert_equal 4, search(q).results.count
       end
 
+      should "pass options to query definition" do
+        s = Tire.search 'articles-test' do
+          query do
+            string 'ruby python', :default_operator => 'AND'
+          end
+        end
+        assert_equal 1, s.results.count
+      end
+
     end
 
     private

data/test/integration/results_test.rb

@@ -21,6 +21,17 @@ module Tire
         assert_nil s.results.first.tags
       end
 
+      should "allow to retrieve multiple fields" do
+        q = 'title:one'
+        s = Tire.search('articles-test') do
+          query { string q }
+          fields 'title', 'tags'
+        end
+        assert_equal 'One',  s.results.first.title
+        assert_equal 'ruby', s.results.first.tags[0]
+        assert_nil s.results.first.published_on
+      end
+
     end
 
   end

data/test/models/active_record_models.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'active_record'
+
+class ActiveRecordArticle < ActiveRecord::Base
+  has_many :comments, :class_name => "ActiveRecordComment", :foreign_key => "article_id"
+  has_many :stats,    :class_name => "ActiveRecordStat",    :foreign_key => "article_id"
+
+  include Tire::Model::Search
+  include Tire::Model::Callbacks
+
+  mapping do
+    indexes :title,      :type => 'string', :boost => 10, :analyzer => 'snowball'
+    indexes :created_at, :type => 'date'
+
+    indexes :comments do
+      indexes :author
+      indexes :body
+    end
+  end
+
+  def to_indexed_json
+    {
+      :title        => title,
+      :length       => length,
+
+      :comments     => comments.map { |c| { :_type  => 'active_record_comment',
+                                            :_id    => c.id,
+                                            :author => c.author,
+                                            :body   => c.body  } },
+      :stats        => stats.map    { |s| { :pageviews  => s.pageviews } }
+    }.to_json
+  end
+
+  def length
+    title.length
+  end
+
+  def comment_authors
+    comments.map(&:author).to_sentence
+  end
+end
+
+class ActiveRecordComment < ActiveRecord::Base
+  belongs_to :article, :class_name => "ActiveRecordArticle", :foreign_key => "article_id"
+end
+
+class ActiveRecordStat < ActiveRecord::Base
+  belongs_to :article, :class_name => "ActiveRecordArticle", :foreign_key => "article_id"
+end

data/test/test_helper.rb

@@ -34,6 +34,8 @@ module Test::Integration
   URL = "http://localhost:9200"
 
   def setup
+    begin; Object.send(:remove_const, :Rails); rescue; end
+
     begin
       ::RestClient.get URL
     rescue Errno::ECONNREFUSED

data/test/unit/index_test.rb

@@ -181,7 +181,10 @@ module Tire
         setup do
           Configuration.reset :wrapper
 
-          Configuration.client.stubs(:post).with("#{Configuration.url}/dummy/article/", '{"title":"Test"}').
+          Configuration.client.stubs(:post).with do |url, payload|
+                                              url     == "#{Configuration.url}/dummy/article/" &&
+                                              payload =~ /"title":"Test"/
+                                            end.
                                             returns(mock_response('{"ok":true,"_id":"id-1"}'))
           @index.store :type => 'article', :title => 'Test'
         end
@@ -319,7 +322,7 @@ module Tire
           end
         end
 
-        should "raise exception when collection item does not have ID" do
+        should "display error message when collection item does not have ID" do
           Configuration.client.expects(:post).with { |url, json| url  == "#{Configuration.url}/_bulk" }
           STDERR.expects(:puts).once
 
@@ -487,7 +490,7 @@ module Tire
           Configuration.client.expects(:put).with do |url, payload|
                                                payload = MultiJson.decode(payload)
                                                url == "#{Configuration.url}/_percolator/dummy/my-query" &&
-                                               payload['query']['query_string']['query'] == 'foo'
+                                               payload['query']['query_string']['query'] == 'foo' &&
                                                payload['tags'] == ['alert']
                                            end.
                                returns(mock_response('{
@@ -548,13 +551,21 @@ module Tire
         context "while storing document" do
 
           should "percolate document against all registered queries" do
-            Configuration.client.expects(:post).with("#{Configuration.url}/dummy/article/?percolate=*", '{"title":"Test"}').
+            Configuration.client.expects(:post).
+                                 with do |url, payload|
+                                   url     == "#{Configuration.url}/dummy/article/?percolate=*" &&
+                                   payload =~ /"title":"Test"/
+                                 end.
                                  returns(mock_response('{"ok":true,"_id":"test","matches":["alerts"]}'))
             @index.store( {:type => 'article', :title => 'Test'}, {:percolate => true} )
           end
 
           should "percolate document against specific queries" do
-            Configuration.client.expects(:post).with("#{Configuration.url}/dummy/article/?percolate=tag:alerts", '{"title":"Test"}').
+            Configuration.client.expects(:post).
+                                 with do |url, payload|
+                                   url     == "#{Configuration.url}/dummy/article/?percolate=tag:alerts" &&
+                                   payload =~ /"title":"Test"/
+                                 end.
                                  returns(mock_response('{"ok":true,"_id":"test","matches":["alerts"]}'))
             response = @index.store( {:type => 'article', :title => 'Test'}, {:percolate => 'tag:alerts'} )
             assert_equal response['matches'], ['alerts']

data/test/unit/model_search_test.rb

@@ -90,20 +90,18 @@ module Tire
           ActiveModelArticle.elasticsearch_index.refresh
         end
 
-        should "wrap results in proper class with ID and score and not change the original wrapper" do
+        should "wrap results in instances of the wrapper class" do
           response = { 'hits' => { 'hits' => [{'_id' => 1, '_score' => 0.8, '_source' => { 'title' => 'Article' }}] } }
           Configuration.client.expects(:get).returns(mock_response(response.to_json))
 
           collection = ActiveModelArticle.search 'foo'
           assert_instance_of Results::Collection, collection
 
-          assert_equal Results::Item, Tire::Configuration.wrapper
-
           document = collection.first
 
-          assert_instance_of ActiveModelArticle, document
-          assert_not_nil document._score
-          assert_equal 1, document.id
+          assert_instance_of Results::Item, document
+          assert_not_nil     document._score
+          assert_equal 1,    document.id
           assert_equal 'Article', document.title
         end
 
@@ -129,6 +127,15 @@ module Tire
             end
           end
 
+          should "allow to pass :page and :per_page options" do
+            Tire::Search::Search.any_instance.expects(:size).with(10)
+            Tire::Search::Search.any_instance.expects(:from).with(20)
+
+            ActiveModelArticle.search :per_page => 10, :page => 3 do
+              query { string 'foo' }
+            end
+          end
+
         end
 
         context "searching with query string" do
@@ -551,6 +558,38 @@ module Tire
 
       end
 
+      context "Results::Item" do
+
+        setup do
+          module ::Rails
+          end
+
+          class ::FakeRailsModel
+            extend  ActiveModel::Naming
+            include ActiveModel::Conversion
+            def self.find(*args); new; end
+          end
+
+          @document = Results::Item.new :id => 1, :_type => 'fake_rails_model', :title => 'Test'
+        end
+
+        should "load the 'real' instance from the corresponding model" do
+          assert_respond_to  @document, :load
+          assert_instance_of FakeRailsModel, @document.load
+        end
+
+        should "pass the ID to the corresponding model's find method" do
+          FakeRailsModel.expects(:find).with(1).returns(FakeRailsModel.new)
+          @document.load
+        end
+
+        should "pass the options to the corresponding model's find method" do
+          FakeRailsModel.expects(:find).with(1, {:include => 'everything'}).returns(FakeRailsModel.new)
+          @document.load :include => 'everything'
+        end
+
+      end
+
     end
 
   end

data/test/unit/results_collection_test.rb

@@ -6,7 +6,8 @@ module Tire
 
     context "Collection" do
       setup do
-        Configuration.reset :wrapper
+        begin; Object.send(:remove_const, :Rails); rescue; end
+        Configuration.reset
         @default_response = { 'hits' => { 'hits' => [{'_id' => 1, '_score' => 1, '_source' => {:title => 'Test'}},
                                                      {'_id' => 2},
                                                      {'_id' => 3}] } }
@@ -110,7 +111,7 @@ module Tire
         # Underlying issue: https://github.com/karmi/tire/pull/31#issuecomment-1340967
         #
         setup do
-          Configuration.reset :wrapper
+          Configuration.reset
           @default_response = { 'hits' => { 'hits' =>
             [ { '_id' => 1, '_score' => 0.5, '_index' => 'testing', '_type' => 'article',
                 'fields' => {
@@ -187,6 +188,54 @@ module Tire
 
       end
 
+      context "with eager loading" do
+        setup do
+          @response = { 'hits' => { 'hits' => [ {'_id' => 1, '_type' => 'active_record_article'},
+                                                {'_id' => 2, '_type' => 'active_record_article'},
+                                                {'_id' => 3, '_type' => 'active_record_article'}] } }
+          ActiveRecordArticle.stubs(:inspect).returns("<ActiveRecordArticle>")
+        end
+
+        should "load the records via model find method from database" do
+          ActiveRecordArticle.expects(:find).with([1,2,3]).
+                              returns([ Results::Item.new(:id => 3),
+                                        Results::Item.new(:id => 1),
+                                        Results::Item.new(:id => 2)  ])
+          Results::Collection.new(@response, :load => true).results
+        end
+
+        should "pass the :load option Hash to model find metod" do
+          ActiveRecordArticle.expects(:find).with([1,2,3], :include => 'comments').
+                              returns([ Results::Item.new(:id => 3),
+                                        Results::Item.new(:id => 1),
+                                        Results::Item.new(:id => 2)  ])
+          Results::Collection.new(@response, :load => { :include => 'comments' }).results
+        end
+
+        should "preserve the order of records returned from search" do
+          ActiveRecordArticle.expects(:find).with([1,2,3]).
+                              returns([ Results::Item.new(:id => 3),
+                                        Results::Item.new(:id => 1),
+                                        Results::Item.new(:id => 2)  ])
+          assert_equal [1,2,3], Results::Collection.new(@response, :load => true).results.map(&:id)
+        end
+
+        should "raise error when model class cannot be inferred from _type" do
+          assert_raise(NameError) do
+            response = { 'hits' => { 'hits' => [ {'_id' => 1, '_type' => 'hic_sunt_leones'}] } }
+            Results::Collection.new(response, :load => true).results
+          end
+        end
+
+        should "raise error when _type is missing" do
+          assert_raise(NoMethodError) do
+            response = { 'hits' => { 'hits' => [ {'_id' => 1}] } }
+            Results::Collection.new(response, :load => true).results
+          end
+        end
+
+      end
+
     end
 
   end

data/test/unit/results_item_test.rb

@@ -1,9 +1,17 @@
 require 'test_helper'
 
 module Tire
-
   class ResultsItemTest < Test::Unit::TestCase
 
+    # ActiveModel compatibility tests
+    #
+    def setup
+      super
+      begin; Object.send(:remove_const, :Rails); rescue; end
+      @model = Results::Item.new :title => 'Test'
+    end
+    include ActiveModel::Lint::Tests
+
     context "Item" do
 
       setup do
@@ -57,6 +65,61 @@ module Tire
         assert_equal 'Kafka', @document.author.name
       end
 
+      should "wrap arrays" do
+        @document = Results::Item.new :stats => [1, 2, 3]
+        assert_equal [1, 2, 3], @document.stats
+      end
+
+      should "wrap hashes in arrays" do
+        @document = Results::Item.new :comments => [{:title => 'one'}, {:title => 'two'}]
+        assert_equal 2,    @document.comments.size
+        assert_instance_of Results::Item, @document.comments.first
+        assert_equal       'one', @document.comments.first.title
+        assert_equal       'two', @document.comments.last.title
+      end
+
+      should "be an Item instance" do
+        assert_instance_of Tire::Results::Item, @document
+      end
+
+      should "be convertible to hash" do
+        assert_instance_of Hash, @document.to_hash
+      end
+
+      should "be inspectable" do
+        assert_match /<Item title|Item author/, @document.inspect
+      end
+
+      context "within Rails" do
+
+        setup do
+          module ::Rails
+          end
+
+          class ::FakeRailsModel
+            extend  ActiveModel::Naming
+            include ActiveModel::Conversion
+            def self.find(id, options); new; end
+          end
+
+          @document = Results::Item.new :id => 1, :_type => 'fake_rails_model', :title => 'Test'
+        end
+
+        should "be an instance of model, based on _type" do
+          assert_equal FakeRailsModel, @document.class
+        end
+
+        should "be inspectable with masquerade" do
+          assert_match /<Item \(FakeRailsModel\)/, @document.inspect
+        end
+
+        should "return proper singular and plural forms" do
+          assert_equal 'fake_rails_model',  ActiveModel::Naming.singular(@document)
+          assert_equal 'fake_rails_models', ActiveModel::Naming.plural(@document)
+        end
+
+      end
+
     end
 
   end