chewy 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 434f4c2db17b4906fcb08963bd2e539869179ee6
-  data.tar.gz: 827aba062a02a1911666162159f48671a1ed3634
+  metadata.gz: 11ba7489e6c513a9a8e81cc220a64718808fcde0
+  data.tar.gz: 9a3336d2e062b027ab1ca03396dc6eac549d964a
 SHA512:
-  metadata.gz: 1cf88693d5554070dc6bf5a6ce402e67c30afb4c2d9eb0018b2c8c61d774b1944099bf4d2d043c550743a973eb1fe83dba87e0f6443bec896b58f9a977cad6e6
-  data.tar.gz: 5846df79cf664b56123a77cbfe3c6b3b2d030e5a475919d1500bcbe1d72671c942e440cbf5e95cb6f4091d68f832fb46198e7257a745360daebf10867f1489e0
+  metadata.gz: 17dfc426d7a92c958d5d1548aa7420e380b984297c650e8b9f29658306a8ef30b9a75c3a6d86e4149af6d3d6008228fd709a98797f881fc28600fbcb511cee26
+  data.tar.gz: 55899323c6be7796cd3640a3386c9f39ccfd785a01c0594e74a53fd9022b508e0372644dc92a739c997b9f3ba094e021ed81b2c6b4fc125910a2bec2b15aa515

data/.travis.yml

@@ -1,14 +1,36 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.1
+  - 2.1.3
   # - rbx
 gemfile:
   - Gemfile
-  - gemfiles/Gemfile.rails-3.2
-  - gemfiles/Gemfile.rails-4.0
+  - gemfiles/Gemfile.rails-3.2.active_record
+  - gemfiles/Gemfile.rails-3.2.active_record.kaminari
+  - gemfiles/Gemfile.rails-3.2.active_record.will_paginate
+  - gemfiles/Gemfile.rails-4.0.active_record
+  - gemfiles/Gemfile.rails-4.0.active_record.kaminari
+  - gemfiles/Gemfile.rails-4.0.active_record.will_paginate
+  - gemfiles/Gemfile.rails-4.0.mongoid
+  - gemfiles/Gemfile.rails-4.0.mongoid.kaminari
+  - gemfiles/Gemfile.rails-4.0.mongoid.will_paginate
+  - gemfiles/Gemfile.rails-4.1.active_record
+  - gemfiles/Gemfile.rails-4.1.active_record.kaminari
+  - gemfiles/Gemfile.rails-4.1.active_record.will_paginate
+  - gemfiles/Gemfile.rails-4.1.mongoid
+  - gemfiles/Gemfile.rails-4.1.mongoid.kaminari
+  - gemfiles/Gemfile.rails-4.1.mongoid.will_paginate
+  # - gemfiles/Gemfile.rails-4.2.active_record
+  # - gemfiles/Gemfile.rails-4.2.active_record.kaminari
+  # - gemfiles/Gemfile.rails-4.2.active_record.will_paginate
+  # - gemfiles/Gemfile.rails-4.2.mongoid
+  # - gemfiles/Gemfile.rails-4.2.mongoid.kaminari
+  # - gemfiles/Gemfile.rails-4.2.mongoid.will_paginate
+
 before_install:
   - curl -# https://download.elasticsearch.org/elasticsearch/elasticsearch/elasticsearch-1.3.0.tar.gz | tar xz -C /tmp
 before_script:
   - TEST_CLUSTER_COMMAND="/tmp/elasticsearch-1.3.0/bin/elasticsearch" rake elasticsearch:start
+services:
+  - mongodb
+

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # master
 
+# Version 0.6.0
+
+## Changes
+
+  * Mongoid support YaY! (@fabiotomio, @leemhenson)
+
+  * `urgent: true` option for `update_index` is deprecated and will be removed soon, use `Chewy.atomic` instead
+
+  * `timeout` and `timed_out` support (@MarkMurphy)
+
+  * will_paginate support (@josecoelho)
+
+## Bugfixes
+
+  * All the query chainable methods delegated to indexes and types (partially @Linuus)
+
 # Version 0.5.2
 
 ## Changes

data/Gemfile

@@ -3,10 +3,12 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in chewy.gemspec
 gemspec
 
+gem 'activerecord'
+# gem 'mongoid'
 gem 'kaminari', require: false
+# gem 'will_paginate', require: false
 
 group :test do
-
   gem 'guard'
   gem 'guard-rspec'
   gem 'rb-inotify', require: false

data/README.md

@@ -241,15 +241,8 @@ There are 3 strategies for index updating: do not update index at all, update ri
 By default Chewy indexes are not updated when the observed model is saved or destroyed.
 This depends on the `Chewy.urgent_update` (false by default) or on the per-model update config.
 If you will perform `Chewy.urgent_update = true`, all the models will start to update elasticsearch
-index right after save. Also
+index right after save.
 
-```ruby
-class User < ActiveRecord::Base
-  update_index 'users#user', 'self', urgent: true
-end
-```
-
-will make the same effect for User model only.
 Note than urgent update options affects only outside-atomic-block behavour. Inside
 the `Chewy.atomic { }` block indexes updates as described below.
 
@@ -764,9 +757,8 @@ See [update_index.rb](lib/chewy/rspec/update_index.rb) for more details.
 * Typecasting support
 * Advanced (simplyfied) query DSL: `UsersIndex.query { email == 'my@gmail.com' }` will produce term query
 * update_all support
-* Other than ActiveRecord ORMs support (Mongoid)
 * Maybe, closer ORM/ODM integration, creating index classes implicitly
-* Asunc indexes updating
+* Async indexes updating
 
 ## Contributing
 

data/chewy.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec-its', '~> 1.0.1'
   spec.add_development_dependency 'rspec-collection_matchers'
   spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'activerecord', '>= 3.2'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'elasticsearch-extensions'
   spec.add_development_dependency 'rubysl', '~> 2.0' if RUBY_ENGINE == 'rbx'

data/gemfiles/Gemfile.rails-3.2.active_record

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 3.2.0'
+gem 'activesupport', '~> 3.2.0'

data/gemfiles/Gemfile.rails-3.2.active_record.kaminari

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 3.2.0'
+gem 'activesupport', '~> 3.2.0'
+gem 'kaminari', require: false

data/gemfiles/Gemfile.rails-3.2.active_record.will_paginate

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 3.2.0'
+gem 'activesupport', '~> 3.2.0'
+gem 'will_paginate', require: false

data/gemfiles/Gemfile.rails-4.0.active_record

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.0.0'
+gem 'activesupport', '~> 4.0.0'

data/gemfiles/Gemfile.rails-4.0.active_record.kaminari

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.0.0'
+gem 'activesupport', '~> 4.0.0'
+gem 'kaminari', require: false

data/gemfiles/Gemfile.rails-4.0.active_record.will_paginate

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.0.0'
+gem 'activesupport', '~> 4.0.0'
+gem 'will_paginate', require: false

data/gemfiles/Gemfile.rails-4.0.mongoid

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'mongoid', '~> 4.0.0'
+gem 'activesupport', '~> 4.0.0'

data/gemfiles/Gemfile.rails-4.0.mongoid.kaminari

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'mongoid', '~> 4.0.0'
+gem 'activesupport', '~> 4.0.0'
+gem 'kaminari', require: false

data/gemfiles/Gemfile.rails-4.0.mongoid.will_paginate

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'mongoid', '~> 4.0.0'
+gem 'activesupport', '~> 4.0.0'
+gem 'will_paginate', require: false

data/gemfiles/Gemfile.rails-4.1.active_record

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.1.0'
+gem 'activesupport', '~> 4.1.0'

data/gemfiles/Gemfile.rails-4.1.active_record.kaminari

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.1.0'
+gem 'activesupport', '~> 4.1.0'
+gem 'kaminari', require: false

data/gemfiles/Gemfile.rails-4.1.active_record.will_paginate

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.1.0'
+gem 'activesupport', '~> 4.1.0'
+gem 'will_paginate', require: false

data/gemfiles/Gemfile.rails-4.1.mongoid

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'mongoid', '~> 4.0.0'
+gem 'activesupport', '~> 4.1.0'

data/gemfiles/Gemfile.rails-4.1.mongoid.kaminari

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'mongoid', '~> 4.0.0'
+gem 'activesupport', '~> 4.1.0'
+gem 'kaminari', require: false

data/gemfiles/Gemfile.rails-4.1.mongoid.will_paginate

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'mongoid', '~> 4.0.0'
+gem 'activesupport', '~> 4.1.0'
+gem 'will_paginate', require: false

data/gemfiles/Gemfile.rails-4.2.active_record

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.2.0'
+gem 'activesupport', '~> 4.2.0'

data/gemfiles/Gemfile.rails-4.2.active_record.kaminari

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.2.0'
+gem 'activesupport', '~> 4.2.0'
+gem 'kaminari', require: false

data/gemfiles/Gemfile.rails-4.2.active_record.will_paginate

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.2.0'
+gem 'activesupport', '~> 4.2.0'
+gem 'will_paginate', require: false

data/gemfiles/Gemfile.rails-4.2.mongoid

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'mongoid', '~> 4.0.0'
+gem 'activesupport', '~> 4.2.0'

data/gemfiles/Gemfile.rails-4.2.mongoid.kaminari

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'mongoid', '~> 4.0.0'
+gem 'activesupport', '~> 4.2.0'
+gem 'kaminari', require: false

data/gemfiles/Gemfile.rails-4.2.mongoid.will_paginate

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'mongoid', '~> 4.0.0'
+gem 'activesupport', '~> 4.2.0'
+gem 'will_paginate', require: false

data/lib/chewy.rb

@@ -7,10 +7,6 @@ require 'i18n/core_ext/hash'
 require 'chewy/backports/deep_dup' unless Object.respond_to?(:deep_dup)
 require 'singleton'
 
-begin
-  require 'kaminari'
-rescue LoadError
-end
 require 'elasticsearch'
 
 require 'chewy/version'
@@ -23,10 +19,40 @@ require 'chewy/query'
 require 'chewy/fields/base'
 require 'chewy/fields/root'
 
+begin
+  require 'kaminari'
+  require 'chewy/query/pagination/kaminari'
+rescue LoadError
+end
+
+begin
+  require 'will_paginate'
+  require 'will_paginate/collection'
+  require 'chewy/query/pagination/will_paginate'
+rescue LoadError
+end
+
 require 'chewy/railtie' if defined?(::Rails)
 
 ActiveSupport.on_load(:active_record) do
   extend Chewy::Type::Observe::ActiveRecordMethods
+
+  begin
+    require 'will_paginate/active_record'
+  rescue LoadError
+  end
+end
+
+ActiveSupport.on_load(:mongoid) do
+  module Mongoid::Document::ClassMethods
+    include Chewy::Type::Observe::MongoidMethods
+  end
+
+  begin
+    require 'will_paginate/mongoid'
+    require 'chewy/query/pagination/will_paginate'
+  rescue LoadError
+  end
 end
 
 module Chewy
@@ -62,8 +88,10 @@ module Chewy
     def create_type index, target, options = {}, &block
       type = Class.new(Chewy::Type)
 
-      adapter = if (target.is_a?(Class) && target < ActiveRecord::Base) || target.is_a?(::ActiveRecord::Relation)
+      adapter = if defined?(::ActiveRecord::Base) && ((target.is_a?(Class) && target < ::ActiveRecord::Base) || target.is_a?(::ActiveRecord::Relation))
         Chewy::Type::Adapter::ActiveRecord.new(target, options)
+      elsif defined?(::Mongoid::Document) && ((target.is_a?(Class) && target.ancestors.include?(::Mongoid::Document)) || target.is_a?(::Mongoid::Criteria))
+        Chewy::Type::Adapter::Mongoid.new(target, options)
       else
         Chewy::Type::Adapter::Object.new(target, options)
       end

data/lib/chewy/config.rb

@@ -171,6 +171,7 @@ module Chewy
       @yaml_options ||= begin
         if defined?(Rails)
           file = Rails.root.join(*%w(config chewy.yml))
+
           if File.exists?(file)
             yaml = ERB.new(File.read(file)).result
             YAML.load(yaml)[Rails.env].try(:deep_symbolize_keys)

data/lib/chewy/index/search.rb

@@ -4,9 +4,12 @@ module Chewy
       extend ActiveSupport::Concern
 
       included do
-        singleton_class.delegate :explain, :limit, :offset, :highlight, :rescore,
-          :facets, :aggregations, :none, :strategy, :query, :filter, :post_filter,
-          :order, :reorder, :only, :types, :suggest, :delete_all, :total_count, to: :all
+        singleton_class.delegate :explain, :query_mode, :filter_mode, :post_filter_mode,
+          :timeout, :limit, :offset, :highlight, :rescore, :facets, :script_score,
+          :boost_factor, :random_score, :field_value_factor, :decay, :aggregations,
+          :suggest, :none, :strategy, :query, :filter, :post_filter, :boost_mode,
+          :score_mode, :order, :reorder, :only, :types, :delete_all, :total,
+          :total_count, :total_entries, to: :all
       end
 
       module ClassMethods

data/lib/chewy/query.rb

@@ -224,6 +224,55 @@ module Chewy
       chain { criteria.update_options post_filter_mode: value }
     end
 
+    # A search timeout, bounding the search request to be executed within the
+    # specified time value and bail with the hits accumulated up to that point
+    # when expired. Defaults to no timeout.
+    #
+    # By default, the coordinating node waits to receive a response from all
+    # shards. If one node is having trouble, it could slow down the response to
+    # all search requests.
+    #
+    # The timeout parameter tells the coordinating node how long it should wait
+    # before giving up and just returning the results that it already has. It
+    # can be better to return some results than none at all.
+    #
+    # The response to a search request will indicate whether the search timed
+    # out and how many shards responded successfully:
+    #
+    #   ...
+    #   "timed_out":     true,
+    #   "_shards": {
+    #       "total":      5,
+    #       "successful": 4,
+    #       "failed":     1
+    #   },
+    #   ...
+    #
+    # The primary shard assigned to perform the index operation might not be
+    # available when the index operation is executed. Some reasons for this
+    # might be that the primary shard is currently recovering from a gateway or
+    # undergoing relocation. By default, the index operation will wait on the
+    # primary shard to become available for up to 1 minute before failing and
+    # responding with an error. The timeout parameter can be used to explicitly
+    # specify how long it waits.
+    #
+    #   UsersIndex.timeout("5000ms")
+    #
+    # Timeout is not a circuit breaker.
+    #
+    # It should be noted that this timeout does not halt the execution of the
+    # query, it merely tells the coordinating node to return the results
+    # collected so far and to close the connection. In the background, other
+    # shards may still be processing the query even though results have been
+    # sent.
+    #
+    # Use the timeout because it is important to your SLA, not because you want
+    # to abort the execution of long running queries.
+    #
+    def timeout value
+      chain { criteria.update_request_options timeout: value }
+    end
+
     # Sets elasticsearch <tt>size</tt> search request param
     # Default value is set in the elasticsearch and is 10.
     #
@@ -790,6 +839,28 @@ module Chewy
       _delete_all_response
     end
 
+    # Returns request total time elapsed as reported by elasticsearch
+    #
+    #   UsersIndex.query(...).filter(...).took
+    #
+    def took
+      _response['took']
+    end
+
+    # Returns request timed_out as reported by elasticsearch
+    #
+    # The timed_out value tells us whether the query timed out or not.
+    #
+    # By default, search requests do not timeout. If low response times are more
+    # important to you than complete results, you can specify a timeout as 10 or
+    # "10ms" (10 milliseconds), or "1s" (1 second). See #timeout method.
+    #
+    #   UsersIndex.query(...).filter(...).timed_out
+    #
+    def timed_out
+      _response['timed_out']
+    end
+
   protected
 
     def initialize_clone other
@@ -835,7 +906,9 @@ module Chewy
     def _results
       @_results ||= (criteria.none? || _response == {} ? [] : _response['hits']['hits']).map do |hit|
         attributes = (hit['_source'] || {}).merge(hit['highlight'] || {}, &RESULT_MERGER)
-        attributes.reverse_merge!(id: hit['_id']).merge!(_score: hit['_score'])
+        attributes.reverse_merge!(id: hit['_id'])
+          .merge!(_score: hit['_score'])
+          .merge!(_explanation: hit['_explanation'])
 
         wrapper = index.type_hash[hit['_type']].new attributes
         wrapper._data = hit