tire 0.4.2 → 0.4.3

data/lib/tire/search/script_field.rb

@@ -0,0 +1,23 @@
+module Tire
+  module Search
+
+    # http://www.elasticsearch.org/guide/reference/api/search/script-fields.html
+    # http://www.elasticsearch.org/guide/reference/modules/scripting.html
+
+    class ScriptField
+
+      def initialize(name, options)
+        @hash = { name => options }
+      end
+
+      def to_json
+        to_hash.to_json
+      end
+
+      def to_hash
+        @hash
+      end
+    end
+
+  end
+end

data/lib/tire/tasks.rb

@@ -61,7 +61,7 @@ namespace :tire do
     STDOUT.sync = true
     puts "[IMPORT] Starting import for the '#{ENV['CLASS']}' class"
     tty_cols = 80
-    total    = klass.count rescue nil
+    total    = klass.all.count rescue nil
     offset   = (total.to_s.size*2)+8
     done     = 0
 

data/lib/tire/version.rb

@@ -1,22 +1,15 @@
 module Tire
-  VERSION   = "0.4.2"
+  VERSION   = "0.4.3"
 
   CHANGELOG =<<-END
     IMPORTANT CHANGES LATELY:
 
-    Version 0.4.1
-    -------------
-    * Added a Index#settings method to retrieve index settings as a Hash
-    * Added support for the "scan" search in the Ruby API
-    * Added support for reindexing the index documents into new index
-    * Added basic support for index aliases
-    * Changed, that Index#bulk_store runs against an index endpoint, not against `/_bulk`
-    * Refactorings, fixes, Ruby 1.8 compatibility
-
-    Version 0.4.2
-    -------------
-    * Fixed incorrect handling of PUT requests in the Curb client
-    * Fixed, that blocks passed to `Tire::Index.new` or `Tire.index` losed the scope
-    * Added `Tire::Alias`, interface and DSL to manage aliases as resources
+    * Added a prefix query
+    * Added support for "script fields" (return a script evaluation for each hit)
+    * Added support for the Update API in Tire::Index
+    * [FIX] Fixed incorrect `Results::Item#to_hash` serialization
+    * 730813f Added support for aggregating over multiple fields in the "terms" facet
+    * Added the "Dis Max Query"
+    * Added the ability to transform documents when reindexing
   END
 end

data/test/integration/dis_max_queries_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+module Tire
+
+  class DisMaxQueriesIntegrationTest < Test::Unit::TestCase
+    include Test::Integration
+
+    context "Dis Max queries" do
+      setup do
+        Tire.index 'dis_max_test' do
+          delete
+          create
+
+          store title: "It's an Albino, Albino, Albino thing!", text: "Albino, albino, albino! Wanna know about albino? ..."
+          store title: "Albino Vampire Monkey Attacks!",        text: "The night was just setting in when ..."
+          store title: "Pinky Elephant",                        text: "An albino walks into a ZOO and ..."
+          refresh
+        end
+      end
+
+      teardown do
+        Tire.index('dis_max_test').delete
+      end
+
+      should "boost matches in both fields" do
+        dis_max = Tire.search 'dis_max_test' do
+          query do
+            dis_max do
+              query { string "albino elephant", fields: ['title', 'text'] }
+            end
+          end
+        end
+        # p "DisMax:", dis_max.results.map(&:title)
+
+        assert_equal 'Pinky Elephant', dis_max.results.first.title
+
+        # NOTE: This gives exactly the same result as a boolean query:
+        # boolean = Tire.search 'dis_max_test' do
+        #   query do
+        #     boolean do
+        #       should { string "albino",   fields: ['title', 'text'] }
+        #       should { string "elephant", fields: ['title', 'text'] }
+        #     end
+        #   end
+        # end
+        # p "Boolean:", boolean.results.map(&:title)
+      end
+
+      should "allow to set multiple queries" do
+        s = Tire.search('articles-test') do
+          query do
+            dis_max do
+              query { term :tags, 'ruby' }
+              query { term :tags, 'python' }
+            end
+          end
+        end
+
+        assert_equal 2, s.results.size
+        assert_equal 'Two', s.results[0].title
+        assert_equal 'One', s.results[1].title
+      end
+
+    end
+
+  end
+
+end

data/test/integration/facets_test.rb

@@ -59,6 +59,33 @@ module Tire
         assert_equal 1,      s.results.facets['tags']['terms'].first['count'].to_i
       end
 
+      context "terms" do
+        setup do
+          @s = Tire.search('articles-test') do
+            query { string 'tags:ruby' }
+          end
+        end
+
+        should "return results ordered by term" do
+          @s.facet('tags')              { terms :tags                }
+          @s.facet('term-ordered-tags') { terms :tags, order: 'term' }
+
+          facets = @s.results.facets
+          # p facets
+          assert_equal 'ruby',   facets['tags']['terms']             .first['term']
+          assert_equal 'python', facets['term-ordered-tags']['terms'].first['term']
+        end
+
+        should "return results aggregated over multiple fields" do
+          @s.facet('multiple-fields') { terms ['tags', 'words'] }
+
+          facets = @s.results.facets
+          # p facets
+          assert_equal 4, facets['multiple-fields']['terms'].size
+        end
+
+      end
+
       context "date histogram" do
 
         should "return aggregated values for all results" do

data/test/integration/index_store_test.rb

@@ -22,7 +22,10 @@ module Tire
         end
       end
 
-      teardown { Tire.index('articles-test-ids').delete }
+      teardown do
+        Tire.index('articles-test-ids').delete
+        Tire.index('articles-test-types').delete
+      end
 
       should "happen in existing index" do
         assert   Tire.index("articles-test-ids").exists?
@@ -40,6 +43,19 @@ module Tire
 
       end
 
+      should "store documents as proper types" do
+        Tire.index 'articles-test-types' do
+          delete
+          create
+          store :type => 'my_type', :title => 'One'
+          refresh
+        end
+
+        s = Tire.search('articles-test-types/my_type') { query { all } }
+        assert_equal 1, s.results.count
+        assert_equal 'my_type', s.results.first.type
+      end
+
     end
 
     context "Removing documents from the index" do

data/test/integration/index_update_document_test.rb

@@ -0,0 +1,111 @@
+require 'test_helper'
+
+module Tire
+
+  class IndexUpdateDocumentIntegrationTest < Test::Unit::TestCase
+    include Test::Integration
+
+    context "Updating a document" do
+
+      setup do
+        Tire.index 'articles-with-tags' do
+          delete
+          create
+
+          store :type => 'article', :id => 1, :title => 'One',   :tags => ['foo'],        :views => 0
+          store :type => 'article', :id => 2, :title => 'Two',   :tags => ['foo', 'bar'], :views => 10
+          store :type => 'article', :id => 3, :title => 'Three', :tags => ['foobar']
+
+          refresh
+        end
+      end
+
+      teardown { Tire.index('articles-with-tags').delete }
+
+      should "increment a counter" do
+        Tire.index('articles-with-tags') { update( 'article', '1', :script => "ctx._source.views += 1" ) and refresh }
+
+        document = Tire.search('articles-with-tags') { query { string 'title:one' } }.results.first
+        assert_equal 1, document.views, document.inspect
+
+        Tire.index('articles-with-tags') { update( 'article', '2', :script => "ctx._source.views += 1" ) and refresh }
+
+        document = Tire.search('articles-with-tags') { query { string 'title:two' } }.results.first
+        assert_equal 11, document.views, document.inspect
+      end
+
+      should "add a tag to document" do
+        Tire.index('articles-with-tags') do
+          update 'article', '1', :script => "ctx._source.tags += tag",
+                                 :params => { :tag => 'new' }
+          refresh
+        end
+
+        document = Tire.search('articles-with-tags') { query { string 'title:one' } }.results.first
+        assert_equal ['foo', 'new'], document.tags, document.inspect
+      end
+
+      should "remove a tag from document" do
+        Tire.index('articles-with-tags') do
+          update 'article', '1', :script => "ctx._source.tags = tags",
+                                 :params => { :tags => [] }
+          refresh
+        end
+
+        document = Tire.index('articles-with-tags').retrieve 'article', '1'
+        assert_equal [], document.tags, document.inspect
+      end
+
+      should "remove the entire document if specific condition is met" do
+        Tire.index('articles-with-tags') do
+          # Remove document when it contains tag 'foobar'
+          update 'article', '3', :script => "ctx._source.tags.contains(tag) ? ctx.op = 'delete' : 'none'",
+                                 :params => { :tag => 'foobar' }
+          refresh
+        end
+
+        assert_nil Tire.index('articles-with-tags').retrieve 'article', '3'
+      end
+
+      should "pass the operation parameters to the API" do
+        Tire.index('articles-with-tags').update 'article', '2', { :script => "ctx._source.tags += tag",
+                                                                  :params => { :tag => 'new' }
+                                                                },
+                                                                {
+                                                                  :refresh => true
+                                                                }
+
+        document = Tire.search('articles-with-tags') { query { string 'title:two' } }.results.first
+        assert_equal 3, document.tags.size, document.inspect
+      end
+
+      should "access variables from the outer scope" do
+        $t = self
+
+        class Updater
+          @tags = ['foo', 'bar', 'baz']
+
+          def self.perform_update!
+            $t.assert_not_nil @tags
+
+            Tire.index('articles-with-tags') do |index|
+              $t.assert_not_nil @tags
+
+              index.update 'article', '3', :script => "ctx._source.tags = tags",
+                                     :params => { :tags => @tags }
+              index.refresh
+            end
+          end
+        end
+
+        Updater.perform_update!
+
+        document = Tire.search('articles-with-tags') { query { string 'title:three' } }.results.first
+        assert_equal 3, document.tags.size, document.inspect
+      end
+
+    end
+
+  end
+
+end

data/test/integration/persistent_model_test.rb

@@ -50,7 +50,20 @@ module Tire
         results = PersistentArticle.find [1, 2]
 
         assert_equal 2, results.size
+      end
+
+      should "be persisted" do
+        one = PersistentArticle.create :id => 1, :title => 'One'
+        PersistentArticle.index.refresh
+
+        a = PersistentArticle.all.first
+        assert a.persisted?, a.inspect
+
+        b = PersistentArticle.first
+        assert b.persisted?, b.inspect
 
+        c = PersistentArticle.search { query { string 'one' } }.first
+        assert c.persisted?, c.inspect
       end
 
       should "return default values for properties without value" do

data/test/integration/prefix_query_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+module Tire
+
+  class PrefixQueryTest < Test::Unit::TestCase
+    include Test::Integration
+
+    context "Prefix queries" do
+
+      should "search by a prefix" do
+        s = Tire.search('articles-test') do
+          query do
+            # "on" => "One"
+            prefix :title, "on"
+          end
+        end
+
+        assert_equal 1, s.results.size
+        assert_equal ['One'], s.results.map(&:title)
+      end
+
+      should "allow to specify boost" do
+        s = Tire.search('articles-test') do
+          query do
+            boolean do
+              # "on" => "One", boost it
+              should { prefix :title, "on", :boost => 2.0 }
+              should { all }
+            end
+          end
+          sort { by :_score }
+        end
+        
+        assert_equal 5, s.results.size
+        assert_equal 'One', s.results.first.title
+      
+      end
+
+    end
+
+  end
+
+end

data/test/integration/reindex_test.rb

@@ -39,6 +39,16 @@ module Tire
         assert_equal 2, Tire.search('reindex-test-new').results.total
       end
 
+      should "transform documents with a passed lambda" do
+        Tire.index('reindex-test').reindex 'reindex-test-new', transform: lambda { |document|
+                                                                            document[:title] += 'UPDATED'
+                                                                            document
+                                                                          }
+
+        Tire.index('reindex-test-new').refresh
+        assert_match /UPDATED/, Tire.search('reindex-test-new').results.first.title
+      end
+
     end
 
   end

data/test/integration/script_fields_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+module Tire
+
+  class ScriptFieldsIntegrationTest < Test::Unit::TestCase
+    include Test::Integration
+
+    context "ScriptFields" do
+
+      should "add multiple fields to the results" do
+        # 1.json > title: "One", words: 125
+
+        s = Tire.search('articles-test') do
+          query { string "One" }
+          script_field :double_words, :script => "doc['words'].value * 2"
+          script_field :triple_words, :script => "doc['words'].value * 3"
+        end
+
+        assert_equal 250, s.results.first.double_words
+        assert_equal 375, s.results.first.triple_words
+      end
+
+      should "allow passing parameters to the script" do
+        # 1.json > title: "One", words: 125
+
+        s = Tire.search('articles-test') do
+          query { string "One" }
+          script_field :double_words, :script => "doc['words'].value * factor", :params => { :factor => 2 }
+        end
+
+        assert_equal 250, s.results.first.double_words
+      end
+
+    end
+
+  end
+
+end

data/test/test_helper.rb

@@ -8,7 +8,7 @@ require 'yajl/json_gem'
 require 'sqlite3'
 
 require 'shoulda'
-require 'turn/autorun' unless ENV["TM_FILEPATH"] || ENV["CI"] || defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
+require 'turn/autorun' unless ENV["TM_FILEPATH"] || defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
 require 'mocha'
 
 require 'active_support/core_ext/hash/indifferent_access'
@@ -32,6 +32,11 @@ require File.dirname(__FILE__) + '/models/validated_model'
 
 class Test::Unit::TestCase
 
+  def assert_block(message=nil)
+    raise Test::Unit::AssertionFailedError.new(message.to_s) if (! yield)
+    return true
+  end if defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
+
   def mock_response(body, code=200, headers={})
     Tire::HTTP::Response.new(body, code, headers)
   end