tire 0.5.8 → 0.6.0

data/lib/tire/search/query.rb

@@ -28,13 +28,6 @@ module Tire
         @value = { :range => { field => value } }
       end
 
-      def text(field, value, options={})
-        Tire.warn "The 'text' query has been deprecated, please use a 'match' query."
-        query_options = { :query => value }.update(options)
-        @value = { :text => { field => query_options } }
-        @value
-      end
-
       def string(value, options={})
         @value = { :query_string => { :query => value } }
         @value[:query_string].update(options)
@@ -98,8 +91,10 @@ module Tire
         @value
       end
 
-      def ids(values, type)
-        @value = { :ids => { :values => values, :type => type }  }
+      def ids(values, type=nil)
+        @value = { :ids => { :values => Array(values) }  }
+        @value[:ids].update(:type => type) if type
+        @value
       end
 
       def boosting(options={}, &block)
@@ -193,7 +188,10 @@ module Tire
       end
 
       def filter(type, *options)
-        @value.update(:filter => Filter.new(type, *options).to_hash)
+        @value[:filter] ||= {}
+        @value[:filter][:and] ||= []
+        @value[:filter][:and] << Filter.new(type, *options).to_hash
+        @value
       end
 
       def query(&block)

data/lib/tire/tasks.rb

@@ -87,11 +87,6 @@ namespace :tire do
   namespace :import do
     desc import_model_desc
     task :model do
-      if defined?(Rails)
-        puts "[IMPORT] Rails detected, loading environment..."
-        Rake::Task["environment"].invoke
-      end
-
       if ENV['CLASS'].to_s == ''
         puts '='*90, 'USAGE', '='*90, import_model_desc, ""
         exit(1)
@@ -121,11 +116,6 @@ namespace :tire do
 
     desc import_all_desc
     task :all do
-      if defined?(Rails)
-        puts "[IMPORT] Rails detected, loading environment..."
-        Rake::Task["environment"].invoke
-      end
-
       dir    = ENV['DIR'].to_s != '' ? ENV['DIR'] : Rails.root.join("app/models")
       params = eval(ENV['PARAMS'].to_s) || {}
 
@@ -134,7 +124,7 @@ namespace :tire do
         require path
 
         model_filename = path[/#{Regexp.escape(dir.to_s)}\/([^\.]+).rb/, 1]
-        klass          = model_filename.classify.constantize
+        klass          = model_filename.camelize.constantize
 
         # Skip if the class doesn't have Tire integration
         next unless klass.respond_to?(:tire)

data/lib/tire/version.rb

@@ -1,14 +1,20 @@
 module Tire
-  VERSION   = "0.5.8"
+  VERSION   = "0.6.0"
 
   CHANGELOG =<<-END
     IMPORTANT CHANGES LATELY:
 
-    * Fixed, that Model::Persistence uses "string" as the default mapping type
-    * Fixed, that Model::Persistence returns true/false for #save and #destroy operations
-    * Fixed the `uninitialized constant HRULE` in Rake tasks
-    * Fixed `Item#to_hash` functionality to work with Arrays
-    * Updated the Rails application template and install instructions
-    * Improved the test suite for Travis
+    * Fixed incorrect inflection in the Rake import tasks
+    * Added support for `geo_distance` facets
+    * Added support for the `custom_filters_score` query
+    * Added a custom strategy option to <Model.import>
+    * Allow the `:wrapper` option to be passed to Tire.search consistently
+    * Improved the Mongoid importing strategy
+    * Merge returned `fields` with `_source` if both are returned
+    * Removed the deprecated `text` query
+    * [FIX] Rescue HTTP client specific connection errors in MyModel#create_elasticsearch_index
+    * Added support for passing `version` in Tire::Index#store
+    * Added support for `_version_type` in Tire::Index#bulk
+    * Added ActiveModel::Serializers compatibility
   END
 end

data/test/integration/bulk_test.rb

@@ -79,6 +79,19 @@ module Tire
           end
         end
       end
+
+      should "take external versioning into account" do
+        # Tire.configure { logger STDERR, level: 'verbose' }
+        index = Tire.index 'bulk-test-external-versioning' do
+          delete
+          create
+          store id: '1', title: 'A', _version: 10, _version_type: 'external'
+        end
+
+        response = index.bulk_store [ { id: '1', title: 'A', _version: 0, _version_type: 'external'} ]
+
+        assert_match /VersionConflictEngineException/, MultiJson.load(response.body)['items'][0]['index']['error']
+      end
     end
 
   end

data/test/integration/custom_filters_score_queries_test.rb

@@ -0,0 +1,105 @@
+require 'test_helper'
+
+module Tire
+
+  class CustomFiltersScoreQueriesIntegrationTest < Test::Unit::TestCase
+    include Test::Integration
+
+    context "Custom filters score queries" do
+
+      should "score the document based on a matching filter" do
+        s = Tire.search('articles-test') do
+          query do
+            custom_filters_score do
+              query { all }
+
+              # Give documents over 300 words a score of 3
+              filter do
+                filter :range, words: { gt: 300 }
+                boost 3
+              end
+            end
+          end
+        end
+
+        assert_equal 3, s.results[0]._score
+        assert_equal 1, s.results[1]._score
+      end
+
+      should "allow to use a script based boost factor" do
+        s = Tire.search('articles-test') do
+          query do
+            custom_filters_score do
+              query { all }
+
+              # Give documents over 300 words a score of 3
+              filter do
+                filter :range, words: { gt: 300 }
+                script 'doc.words.value * 2'
+              end
+            end
+          end
+        end
+
+        # p s.results.to_a.map { |r| [r.title, r.words, r._score] }
+
+        assert_equal 750, s.results[0]._score
+        assert_equal 1, s.results[1]._score
+      end
+
+      should "allow to define multiple score factors" do
+        s = Tire.search('articles-test') do
+          query do
+            custom_filters_score do
+              query { all }
+
+              # The more words a document contains, the more its score is boosted
+
+              filter do
+                filter :range, words: { to: 10 }
+                boost 1
+              end
+
+              filter do
+                filter :range, words: { to: 100 }
+                boost 2
+              end
+
+              filter do
+                filter :range, words: { to: 150 }
+                boost 3
+              end
+
+              filter do
+                filter :range, words: { to: 250 }
+                boost 5
+              end
+
+              filter do
+                filter :range, words: { to: 350 }
+                boost 7
+              end
+
+              filter do
+                filter :range, words: { from: 350 }
+                boost 10
+              end
+            end
+          end
+        end
+
+        # p s.results.to_a.map { |r| [r.title, r.words, r._score] }
+
+        assert_equal 'Three', s.results[0].title
+        assert_equal 375, s.results[0].words
+        assert_equal 10, s.results[0]._score
+
+        assert_equal 5, s.results[1]._score
+        assert_equal 5, s.results[2]._score
+        assert_equal 3, s.results[3]._score
+        assert_equal 3, s.results[4]._score
+      end
+    end
+  end
+
+end

data/test/integration/dsl_search_test.rb

@@ -39,6 +39,38 @@ module Tire
         assert_equal 1, s.results.count
       end
 
+      context "when passing the wrapper option" do
+        class ::MyCustomWrapper < Tire::Results::Item
+          def title_size
+            self.title.size
+          end
+        end
+
+        should "be allowed when passing a block" do
+          s = Tire.search 'articles-test', wrapper: ::MyCustomWrapper do
+            query { match :title, 'one' }
+          end
+
+          assert_equal ::MyCustomWrapper, s.options[:wrapper]
+
+          assert_instance_of ::MyCustomWrapper, s.results.first
+          assert_equal 3, s.results.first.title_size
+        end
+
+        should "be allowed when not passing a block" do
+          s = Tire.search(
+            'articles-test',
+            payload: { query: { match: { title: 'one' } } },
+            wrapper: ::MyCustomWrapper
+          )
+
+          assert_equal ::MyCustomWrapper, s.options[:wrapper]
+
+          assert_instance_of ::MyCustomWrapper, s.results.first
+          assert_equal 3, s.results.first.title_size
+        end
+      end
+
     end
 
   end

data/test/integration/facets_test.rb

@@ -194,6 +194,53 @@ module Tire
 
       end
 
+      context "geo distance" do
+        setup do
+          @index = Tire.index('bars-test') do
+            delete
+            create :mappings => {
+                     :bar => {
+                       :properties => {
+                         :name =>     { :type => 'string' },
+                         :location => { :type => 'geo_point', :lat_lon => true }
+                       }
+                     }
+                   }
+
+            store :type => 'bar',
+                  :name => 'one',
+                  :location => {:lat => 53.54412, :lon => 9.94021}
+            store :type => 'bar',
+                  :name => 'two',
+                  :location => {:lat => 53.54421, :lon => 9.94673}
+            store :type => 'bar',
+                  :name => 'three',
+                  :location => {:lat => 53.55099, :lon => 10.02527}
+            refresh
+          end
+        end
+
+        teardown { @index.delete }
+
+        should "return aggregated values for all results" do
+          s = Tire.search('bars-test') do
+            query { all }
+            facet 'geo' do
+              geo_distance :location,
+                           {:lat => 53.54507, :lon => 9.95309},
+                           [{:to => 1}, {:from => 1, :to => 10}, {:from => 50}],
+                           unit: 'km'
+            end
+          end
+
+          facets = s.results.facets['geo']['ranges']
+          assert_equal 3, facets.size, facets.inspect
+          assert_equal 2, facets.entries[0]['total_count'], facets.inspect
+          assert_equal 1, facets.entries[1]['total_count'], facets.inspect
+          assert_equal 0, facets.entries[2]['total_count'], facets.inspect
+        end
+      end
+
       context "statistical" do
 
         should "return computed statistical data on a numeric field" do

data/test/integration/results_test.rb

@@ -10,13 +10,18 @@ module Tire
       should "allow easy access to returned documents" do
         q = 'title:one'
         s = Tire.search('articles-test') { query { string q } }
+
         assert_equal 'One',  s.results.first.title
         assert_equal 'ruby', s.results.first.tags[0]
       end
 
       should "allow easy access to returned documents with limited fields" do
         q = 'title:one'
-        s = Tire.search('articles-test') { query { string q }.fields :title }
+        s = Tire.search('articles-test') do
+          query { string q }
+          fields :title
+        end
+
         assert_equal 'One', s.results.first.title
         assert_nil s.results.first.tags
       end
@@ -27,11 +32,36 @@ module Tire
           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
 
+      should "return script fields" do
+        s = Tire.search('articles-test') do
+          query { string 'title:one' }
+          fields :title
+          script_field :words_double, :script => "doc.words.value * 2"
+        end
+
+        assert_equal 'One', s.results.first.title
+        assert_equal 250,   s.results.first.words_double
+      end
+
+      should "return specific fields, script fields and _source fields" do
+        # Tire.configure { logger STDERR, level: 'debug' }
+
+        s = Tire.search('articles-test') do
+          query { string 'title:one' }
+          fields :title, :_source
+          script_field :words_double, :script => "doc.words.value * 2"
+        end
+
+        assert_equal 'One', s.results.first.title
+        assert_equal 250,   s.results.first.words_double
+      end
+
       should "iterate results with hits" do
         s = Tire.search('articles-test') { query { string 'title:one' } }
 

data/test/unit/http_client_test.rb

@@ -43,6 +43,10 @@ module Tire
           end
         end
 
+        should "have __host_unreachable_exceptions" do
+          assert_respond_to Client::RestClient, :__host_unreachable_exceptions
+        end
+
       end
 
       if defined?(Curl)
@@ -81,6 +85,10 @@ module Tire
             threads.each { |t| t.join() }
           end
 
+          should "have __host_unreachable_exceptions" do
+            assert_respond_to Client::RestClient, :__host_unreachable_exceptions
+          end
+
         end
 
       end

data/test/unit/index_test.rb

@@ -335,6 +335,16 @@ module Tire
           @index.store({:title => 'Test'}, {:replication => 'async'})
         end
 
+        should "extract the version from options" do
+          Configuration.client.expects(:post).
+            with do |url, payload|
+              assert_equal "#{Configuration.url}/dummy/document/?version=123", url
+            end.
+            returns(mock_response('{"ok":true,"_id":"test"}'))
+
+          @index.store({:title => 'Test'}, {:version => 123})
+        end
+
         context "document with ID" do
 
           should "store a Hash under its ID property" do
@@ -671,26 +681,44 @@ module Tire
           @index.bulk :delete, [ {:id => '1', :title => 'One'}, {:id => '2', :title => 'Two'} ]
         end
 
-        should "serialize meta parameters such as routing into payload header" do
+        should "serialize meta parameters into payload header" do
           Configuration.client.
             expects(:post).
             with do |url, payload|
               # print payload
               lines = payload.split("\n")
-              assert_match /"_routing":"A"/, lines[0]
-              assert_match /"_routing":"B"/, lines[2]
-              assert_match /"_ttl":"1d"/,    lines[2]
-              assert ! lines[4].include?('"_routing"')
+
+              assert_match /"_routing":"A"/,                     lines[0]
+
+              assert_match /"_ttl":"1d"/,                        lines[2]
+              assert ! lines[2].include?('"_:parent"')
+
+              assert_match /"_version":"1234"/,                  lines[4]
+              assert ! lines[4].include?('"_:routing"')
+
+              assert_match /"_version_type":"external"/,         lines[6]
+              assert ! lines[6].include?('"_:garbage"')
+
+              assert_match /"_percolate":"color:green"/,         lines[8]
+
+              assert_match /"_parent":"5678"/,                   lines[10]
+
+              assert_match /"_timestamp":"2013-02-15 11:00:33"/, lines[12]
+
+              true
             end.
             returns(mock_response('{}'), 200)
 
           @index.bulk :index,
                       [
-                        {:id => '1', :title => 'One', :_routing => 'A'},
-                        {:id => '2', :title => 'Two', :_routing => 'B', :_ttl => '1d'},
-                        {:id => '3', :title => 'Three'}
+                          {:id => '1', :title => 'One',   :_routing => 'A'},
+                          {:id => '2', :title => 'Two',   :_ttl => '1d', :_parent => false},
+                          {:id => '3', :title => 'Three', :_version => '1234', :_routing => ""},
+                          {:id => '4', :title => 'Four',  :_version_type => 'external', :_garbage => "stuff"},
+                          {:id => '5', :title => 'Five',  :_percolate => 'color:green'},
+                          {:id => '6', :title => 'Six',   :_parent => '5678'},
+                          {:id => '7', :title => 'Seven', :_timestamp => '2013-02-15 11:00:33'},
                       ]
-
         end
 
         should "pass URL parameters such as refresh or consistency" do