tire 0.3.7 → 0.3.8

data/lib/tire/model/indexing.rb

@@ -31,21 +31,24 @@ module Tire
         # for the corresponding index, telling _ElasticSearch_ how to understand your documents:
         # what type is which property, whether it is analyzed or no, which analyzer to use, etc.
         #
+        # You may pass the top level mapping properties (such as `_source` or `_all`) as a Hash.
+        #
         # Usage:
         #
         #     class Article
         #       # ...
-        #       mapping do
+        #       mapping :_source => { :compress => true } do
         #         indexes :id,    :type => 'string',  :index    => :not_analyzed
         #         indexes :title, :type => 'string',  :analyzer => 'snowball',   :boost => 100
         #         # ...
         #       end
         #     end
         #
-        def mapping
+        def mapping(*args)
           @mapping ||= {}
           if block_given?
-            @store_mapping = true and yield and @store_mapping = false
+            @mapping_options = args.pop
+            @store_mapping   = true and yield and @store_mapping = false
             create_elasticsearch_index
           else
             @mapping
@@ -100,8 +103,12 @@ module Tire
           @store_mapping || false
         end
 
+        def mapping_options
+          @mapping_options || {}
+        end
+
         def mapping_to_hash
-          { document_type.to_sym => { :properties => mapping } }
+          { document_type.to_sym => mapping_options.merge({ :properties => mapping }) }
         end
 
       end

data/lib/tire/results/pagination.rb

@@ -21,7 +21,7 @@ module Tire
         if @options[:page]
           @options[:page].to_i
         else
-          (@options[:size].to_i + @options[:from].to_i) / @options[:size].to_i
+          (per_page + @options[:from].to_i) / per_page
         end
       end
 

data/lib/tire/search.rb

@@ -107,20 +107,21 @@ module Tire
 
           Configuration.logger.log_request '_search', indices, to_curl
 
-          took = @json['took'] rescue nil
+          took = @json['took']  rescue nil
+          code = @response.code rescue nil
 
           if Configuration.logger.level.to_s == 'debug'
             # FIXME: Depends on RestClient implementation
             body = if @json
               defined?(Yajl) ? Yajl::Encoder.encode(@json, :pretty => true) : MultiJson.encode(@json)
             else
-              @response.body
+              @response.body rescue nil
             end
           else
             body = ''
           end
 
-          Configuration.logger.log_response @response.code, took, body
+          Configuration.logger.log_response code || 'N/A', took || 'N/A', body
         end
       end
 

data/lib/tire/search/query.rb

@@ -17,6 +17,10 @@ module Tire
         @value
       end
 
+      def range(field, value)
+        @value = { :range => { field => value } }
+      end
+
       def string(value, options={})
         @value = { :query_string => { :query => value } }
         @value[:query_string].update(options)

data/lib/tire/version.rb

@@ -1,13 +1,13 @@
 module Tire
-  VERSION   = "0.3.7"
+  VERSION   = "0.3.8"
 
   CHANGELOG =<<-END
     IMPORTANT CHANGES LATELY:
 
     * Fixed a bug: `Results::Item` was referencing Ruby classes incorrectly within Rails
-    * Added support for the Analyze API (#124)
-    * Added support for adding multiple filters (#122)
-    * Fixed incorrect passing of options in the `date` and `terms` facets
-    * Removed SDoc since it breaks with current RDoc
+    * Fixed `ZeroDivisionError` for empty result sets
+    * Display correct exception on request failure
+    * Added support for range queries
+    * Added support for mapping options
   END
 end

data/test/integration/range_queries_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+module Tire
+
+  class RangeQueriesIntegrationTest < Test::Unit::TestCase
+    include Test::Integration
+
+    context "Range queries" do
+
+      should "allow simple range queries" do
+        s = Tire.search('articles-test') do
+          query do
+            range :words, { :gte => 250 }
+          end
+        end
+
+        assert_equal 3, s.results.size
+        assert_equal ['Two', 'Three', 'Four'].sort, s.results.map(&:title).sort
+      end
+
+      should "allow combined range queries" do
+        s = Tire.search('articles-test') do
+          query do
+            range :words, { :gte => 250, :lt => 375 }
+          end
+        end
+
+        assert_equal 2, s.results.size
+        assert_equal ['Two', 'Four'].sort, s.results.map(&:title).sort
+      end
+
+    end
+
+  end
+
+end

data/test/unit/model_search_test.rb

@@ -295,6 +295,38 @@ module Tire
             assert_equal 'snowball', ModelWithCustomMapping.mapping[:title][:analyzer]
           end
 
+          should "create the index with proper mapping options" do
+            expected = {
+              :settings => {},
+              :mappings => {
+                :model_with_custom_mapping_and_options => {
+                  :_source    => { :compress => true  },
+                  :_all       => { :enabled  => false },
+                  :properties => { :title => { :type => 'string', :analyzer => 'snowball', :boost => 10 } }
+                }
+              }
+            }
+
+            Tire::Index.any_instance.expects(:create).with(expected)
+
+            class ::ModelWithCustomMappingAndOptions
+              extend ActiveModel::Naming
+              extend ActiveModel::Callbacks
+
+              include Tire::Model::Search
+              include Tire::Model::Callbacks
+
+              mapping :_source => { :compress => true }, :_all => { :enabled => false } do
+                indexes :title, :type => 'string', :analyzer => 'snowball', :boost => 10
+              end
+
+            end
+
+            assert_equal 'snowball', ModelWithCustomMappingAndOptions.mapping[:title][:analyzer]
+            assert_equal true,       ModelWithCustomMappingAndOptions.mapping_options[:_source][:compress]
+            assert_equal false,      ModelWithCustomMappingAndOptions.mapping_options[:_all][:enabled]
+          end
+
           should "not raise an error when defining mapping" do
             Tire::Index.any_instance.unstub(:exists?)
             Configuration.client.expects(:head).raises(Errno::ECONNREFUSED)

data/test/unit/results_collection_test.rb

@@ -193,6 +193,11 @@ module Tire
           assert_equal 2, @collection.current_page
         end
 
+        should "return current page for empty result" do
+          collection = Results::Collection.new( { 'hits' => { 'hits' => [], 'total' => 0 } } )
+          assert_equal 1, collection.current_page
+        end
+
         should "return previous page" do
           assert_equal 1, @collection.previous_page
         end

data/test/unit/search_query_test.rb

@@ -34,6 +34,10 @@ module Tire::Search
                       Query.new.terms(:foo, ['bar', 'baz'], :minimum_match => 2) )
       end
 
+      should "allow search for a range" do
+        assert_equal( { :range => { :age => { :gte => 21 } } }, Query.new.range(:age, { :gte => 21 }) )
+      end
+
       should "allow search with a query string" do
         assert_equal( { :query_string => { :query => 'title:foo' } },
                       Query.new.string('title:foo') )

data/test/unit/search_test.rb

@@ -134,6 +134,17 @@ module Tire
         Search::Search.new('index').perform
       end
 
+      should "log the original exception on failed request" do
+        Configuration.logger STDERR
+
+        Configuration.client.expects(:get).raises(Errno::ECONNREFUSED)
+        Configuration.logger.expects(:log_response).with('N/A', 'N/A', '')
+
+        assert_raise Errno::ECONNREFUSED do
+          Search::Search.new('index').perform
+        end
+      end
+
       context "sort" do
 
         should "allow sorting by multiple fields" do

metadata

@@ -1,196 +1,257 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: tire
-version: !ruby/object:Gem::Version
-  version: 0.3.7
+version: !ruby/object:Gem::Version 
+  hash: 3
   prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 8
+  version: 0.3.8
 platform: ruby
-authors:
+authors: 
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-19 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-10-24 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &70198841382160 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
         version: 0.9.2
   type: :runtime
-  prerelease: false
-  version_requirements: *70198841382160
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: rest-client
-  requirement: &70198841378280 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
         version: 1.6.0
   type: :runtime
-  prerelease: false
-  version_requirements: *70198841378280
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: multi_json
-  requirement: &70198841370400 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
   type: :runtime
-  prerelease: false
-  version_requirements: *70198841370400
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: activemodel
-  requirement: &70198847329580 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
   type: :runtime
-  prerelease: false
-  version_requirements: *70198847329580
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &70198847328740 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
   type: :development
-  prerelease: false
-  version_requirements: *70198847328740
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: yajl-ruby
-  requirement: &70198847327820 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 8
+        - 0
         version: 0.8.0
   type: :development
-  prerelease: false
-  version_requirements: *70198847327820
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: shoulda
-  requirement: &70198847327040 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70198847327040
-- !ruby/object:Gem::Dependency
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: mocha
-  requirement: &70198847326380 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70198847326380
-- !ruby/object:Gem::Dependency
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
   name: activerecord
-  requirement: &70198847325540 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 3
+        - 0
+        - 7
         version: 3.0.7
   type: :development
-  prerelease: false
-  version_requirements: *70198847325540
-- !ruby/object:Gem::Dependency
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
   name: mongoid
-  requirement: &70198847324900 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 2
+        - 1
         version: 2.2.1
   type: :development
-  prerelease: false
-  version_requirements: *70198847324900
-- !ruby/object:Gem::Dependency
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
   name: sqlite3
-  requirement: &70198847324500 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70198847324500
-- !ruby/object:Gem::Dependency
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
   name: supermodel
-  requirement: &70198847324040 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70198847324040
-- !ruby/object:Gem::Dependency
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
   name: rdoc
-  requirement: &70198847323580 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70198847323580
-- !ruby/object:Gem::Dependency
+  version_requirements: *id013
+- !ruby/object:Gem::Dependency 
   name: rcov
-  requirement: &70198847322960 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70198847322960
-- !ruby/object:Gem::Dependency
+  version_requirements: *id014
+- !ruby/object:Gem::Dependency 
   name: turn
-  requirement: &70198847312220 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id015 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70198847312220
-description: ! "   Tire is a Ruby client for the ElasticSearch search engine/database.\n\n
-  \  It provides Ruby-like API for fluent communication with the ElasticSearch server\n
-  \  and blends with ActiveModel class for convenient usage in Rails applications.\n\n
-  \  It allows to delete and create indices, define mapping for them, supports\n   the
-  bulk API, and presents an easy-to-use DSL for constructing your queries.\n\n   It
-  has full ActiveRecord/ActiveModel compatibility, allowing you to index\n   your
-  models (incrementally upon saving, or in bulk), searching and\n   paginating the
-  results.\n\n   Please check the documentation at <http://karmi.github.com/tire/>.\n"
+  version_requirements: *id015
+description: "   Tire is a Ruby client for the ElasticSearch search engine/database.\n\n   It provides Ruby-like API for fluent communication with the ElasticSearch server\n   and blends with ActiveModel class for convenient usage in Rails applications.\n\n   It allows to delete and create indices, define mapping for them, supports\n   the bulk API, and presents an easy-to-use DSL for constructing your queries.\n\n   It has full ActiveRecord/ActiveModel compatibility, allowing you to index\n   your models (incrementally upon saving, or in bulk), searching and\n   paginating the results.\n\n   Please check the documentation at <http://karmi.github.com/tire/>.\n"
 email: karmi@karmi.cz
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.markdown
 - MIT-LICENSE
-files:
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -247,6 +308,7 @@ files:
 - test/integration/percolator_test.rb
 - test/integration/persistent_model_test.rb
 - test/integration/query_string_test.rb
+- test/integration/range_queries_test.rb
 - test/integration/results_test.rb
 - test/integration/sort_test.rb
 - test/models/active_model_article.rb
@@ -282,38 +344,61 @@ files:
 - test/unit/search_test.rb
 - test/unit/tire_test.rb
 - tire.gemspec
+has_rdoc: true
 homepage: http://github.com/karmi/tire
 licenses: []
-post_install_message: ! "================================================================================\n\n
-  \ Please check the documentation at <http://karmi.github.com/tire/>.\n\n--------------------------------------------------------------------------------\n\n
-  \ IMPORTANT CHANGES LATELY:\n\n  * Fixed a bug: `Results::Item` was referencing
-  Ruby classes incorrectly within Rails\n  * Added support for the Analyze API (#124)\n
-  \ * Added support for adding multiple filters (#122)\n  * Fixed incorrect passing
-  of options in the `date` and `terms` facets\n  * Removed SDoc since it breaks with
-  current RDoc\n\n  See the full changelog at <http://github.com/karmi/tire/commits/v0.3.7>.\n\n--------------------------------------------------------------------------------\n"
-rdoc_options:
+
+post_install_message: |
+  ================================================================================
+  
+    Please check the documentation at <http://karmi.github.com/tire/>.
+  
+  --------------------------------------------------------------------------------
+  
+    IMPORTANT CHANGES LATELY:
+  
+    * Fixed a bug: `Results::Item` was referencing Ruby classes incorrectly within Rails
+    * Fixed `ZeroDivisionError` for empty result sets
+    * Display correct exception on request failure
+    * Added support for range queries
+    * Added support for mapping options
+  
+    See the full changelog at <http://github.com/karmi/tire/commits/v0.3.8>.
+  
+  --------------------------------------------------------------------------------
+
+rdoc_options: 
 - --charset=UTF-8
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  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
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
       version: 1.3.6
 requirements: []
+
 rubyforge_project: tire
-rubygems_version: 1.8.10
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Ruby client for ElasticSearch
-test_files:
+test_files: 
 - test/fixtures/articles/1.json
 - test/fixtures/articles/2.json
 - test/fixtures/articles/3.json
@@ -331,6 +416,7 @@ test_files:
 - test/integration/percolator_test.rb
 - test/integration/persistent_model_test.rb
 - test/integration/query_string_test.rb
+- test/integration/range_queries_test.rb
 - test/integration/results_test.rb
 - test/integration/sort_test.rb
 - test/models/active_model_article.rb