chewy 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20296cb15e845cc45aacb4dddaebaa735b5f9d80
-  data.tar.gz: 2872561f5db73ad60dc96ef445de9bdd2da529db
+  metadata.gz: 6bfe79b7a76d86426e6b1f67389d386e85ee33bc
+  data.tar.gz: 65102eba1137183f68dc167ef1c91f77abae9758
 SHA512:
-  metadata.gz: 487d34a9309473ae01af8e2f4f2fe4a4318501c83e6370121e97acaa736630ea2b8bfb129b499dc74a01f7899fd131f296ffa372ddfa6eba324a392cd79d6e34
-  data.tar.gz: 6387d3bcd0e6e1f48187a0bbcc00cfaaffb0069673e149cdf32b531f979843c3b47c3572e5fde6c5717bb21446cd2138deb703ae705969bad6568ff9efaeddea
+  metadata.gz: 6b366d1a609fdd330e46e5f4937187e3fdbc697c65869927deb578d7bb58ea170c3e4fcb6bf3a178fba0a29fe8c5c560e3229314da70b2b180ee19eed9084b9c
+  data.tar.gz: 7e76c1cc833e2884b1c48d3c1dbb197a8bae08a90b099ea87aea5ffb36249a51f08ca37bb1f575f3b6786551c3897b9cb4e443764cc46bd86904e096ad4f3126

data/.gitignore

@@ -3,7 +3,7 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
+Gemfile*.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -4,7 +4,11 @@ rvm:
   - 2.0.0
   - 2.1.0
   # - rbx
+gemfile:
+  - Gemfile
+  - gemfiles/Gemfile.rails-3.2
+  - gemfiles/Gemfile.rails-4.0
 before_install:
   - curl -# https://download.elasticsearch.org/elasticsearch/elasticsearch/elasticsearch-1.0.1.tar.gz | tar xz -C /tmp
 before_script:
-  - TEST_CLUSTER_COMMAND="/tmp/elasticsearch-1.0.1/bin/elasticsearch" rake elasticsearch:start
+  - TEST_CLUSTER_COMMAND="/tmp/elasticsearch-1.0.1/bin/elasticsearch" rake elasticsearch:start

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # master
 
+# Version 0.4.0
+
+  * Changed `update_index` matcher behavior. Now it compare array attributes position-independantly.
+
+  * Search aggregations API support (@arion).
+
+  * Chewy::Query#facets called without params performs the request and returns facets.
+
+  * Added `Type.template` dsl method for root objects dynamic templates definition. See [mapping.rb](lib/chewy/type/mapping.rb) for more details.
+
+  * ActiveRecord adapter custom `primary_key` support (@matthee).
+
+  * Urgent update now clears association cache in ActiveRecord to ensure latest changes are imported.
+
+  * `import` now creates index before performing.
+
+  * `Chewy.configuration[:wait_for_status]` option. Can be set to `red`, `yellow` or `green`. If set - chewy will wait for cluster status before creating, deleting index and import. Useful for specs.
+
 # Version 0.3.0
 
   * Added `Chewy.configuration[:index]` config to setup common indexes options.
@@ -16,7 +34,9 @@
 
 # Version 0.2.2
 
-  * Auto-resolved analyzers and analyzers repository:
+  * Support for `none` scope (@undr).
+
+  * Auto-resolved analyzers and analyzers repository (@webgago):
 
     ```ruby
       # Setting up analyzers repository:

data/README.md

@@ -7,9 +7,11 @@ Chewy is ODM and wrapper for official elasticsearch client (https://github.com/e
 
 ## Why chewy?
 
-* Index classes are independant from ORM/ODM models.
 
-  Now implementing, e.g. cross-model autocomplete is much easier. You can just define index and work with it in object-oriented style. You can define several types for index - one per indexed model.
+
+* Multi-model indexes.
+
+  Index classes are independant from ORM/ODM models. Now implementing, e.g. cross-model autocomplete is much easier. You can just define index and work with it in object-oriented style. You can define several types for index - one per indexed model.
 
 * Every index is observable by all the related models.
 
@@ -127,7 +129,9 @@ Chewy.logger = Logger.new
     }
 
     define_type User.active.includes(:country, :badges, :projects) do
-      root _boost: { name: :_boost, null_value: 1.0 } do
+      root date_detection: false do
+        template 'about_translations.*', type: 'string', analyzer: 'stantard'
+
         field :first_name, :last_name
         field :email, analyzer: 'email'
         field :country, value: ->(user) { user.country.name }
@@ -148,6 +152,8 @@ Chewy.logger = Logger.new
   Index settings - http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html
   Root object settings - http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/mapping-root-object-type.html
 
+  See [mapping.rb](lib/chewy/type/mapping.rb) for more details.
+
 5. Add model observing code
 
   ```ruby
@@ -217,10 +223,10 @@ UsersIndex.import user: User.where('rating > 100') # import only active users to
 UsersIndex.reset! # purges index and imports default data for all types
 ```
 
-See [actions.rb](lib/chewy/index/actions.rb) for more details.
-
 Also if passed user is #destroyed? or specified id is not existing in the database, import will perform `delete` index for this it
 
+See [actions.rb](lib/chewy/index/actions.rb) for more details.
+
 ### Observing strategies
 
 There are 3 strategies for index updating: do not update index at all, update right after save and cummulative update. The first is by default.
@@ -678,69 +684,15 @@ rake chewy:update[users] # updates UsersIndex
 ### Rspec integration
 
 Just add `require 'chewy/rspec'` to your spec_helper.rb and you will get additional features:
-
-#### `update_index` matcher
-
-```ruby
-# just update index expectation. Used type class as argument.
-specify { expect { user.save! }.to update_index(UsersIndex.user) }
-# expect do not update target index. Type for `update_index` might be specified via string also
-specify { expect { user.name = 'Duke' }.not_to update_index('users#user') }
-# expecting update specified objects
-specify { expect { user.save! }.to update_index(UsersIndex.user).and_reindex(user) }
-# you can specify even id
-specify { expect { user.save! }.to update_index(UsersIndex.user).and_reindex(42) }
-# expected multiple objects to be reindexed
-specify { expect { [user1, user2].map(&:save!) }
-  .to update_index(UsersIndex.user).and_reindex(user1, user2) }
-specify { expect { [user1, user2].map(&:save!) }
-  .to update_index(UsersIndex.user).and_reindex(user1).and_reindex(user2) }
-# expect object to be reindexed exact twice
-specify { expect { 2.times { user.save! } }
-  .to update_index(UsersIndex.user).and_reindex(user, times: 2) }
-# expect object in index to be updated with specified fields
-specify { expect { user.update_attributes!(name: 'Duke') }
-  .to update_index(UsersIndex.user).and_reindex(user, with: {name: 'Duke'}) }
-# combination of previous two
-specify { expect { 2.times { user.update_attributes!(name: 'Duke') } }
-  .to update_index(UsersIndex.user).and_reindex(user, times: 2, with: {name: 'Duke'}) }
-# for every object
-specify { expect { 2.times { [user1, user2].map { |u| u.update_attributes!(name: 'Duke') } } }
-  .to update_index(UsersIndex.user).and_reindex(user1, user2, times: 2, with: {name: 'Duke'}) }
-# for every object splitted
-specify { expect { 2.times { [user1, user2].map { |u| u.update_attributes!(name: "Duke#{u.id}") } } }
-  .to update_index(UsersIndex.user)
-    .and_reindex(user1, with: {name: 'Duke42'}) }
-    .and_reindex(user2, times: 1, with: {name: 'Duke43'}) }
-# object deletion same abilities as `and_reindex`, except `:with` option
-specify { expect { user.destroy! }.to update_index(UsersIndex.user).and_delete(user) }
-# double deletion, whatever it means
-specify { expect { 2.times { user.destroy! } }.to update_index(UsersIndex.user).and_delete(user, times: 2) }
-# alltogether
-specify { expect { user1.destroy!; user2.save! } }
-  .to update_index(UsersIndex.user).and_reindex(user2).and_delete(user1)
-```
-
-```ruby
-# strictly specifing updated and deleted records
-specify { expect { [user1, user2].map(&:save!) }
-  .to update_index(UsersIndex.user).and_reindex(user1, user2).only }
-specify { expect { [user1, user2].map(&:destroy!) }
-  .to update_index(UsersIndex.user).and_delete(user1, user2).only }
-# this will fail
-specify { expect { [user1, user2].map(&:save!) }
-  .to update_index(UsersIndex.user).and_reindex(user1).only }
-```
+See [update_index.rb](lib/chewy/rspec/update_index.rb) for more details.
 
 ## TODO a.k.a coming soon:
 
-* Dynamic templates additional DSL
 * 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
-* Better facets support
 
 ## Contributing
 

data/chewy.gemspec

@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubysl', '~> 2.0' if RUBY_ENGINE == 'rbx'
 
   spec.add_dependency 'activesupport', '>= 3.2'
-  spec.add_dependency 'elasticsearch'
+  spec.add_dependency 'elasticsearch', '>= 1.0.0'
 end

data/gemfiles/Gemfile.rails-3.2

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 3.2.0'
+gem 'activesupport', '~> 3.2.0'
+
+group :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rb-inotify', require: false
+  gem 'rb-fsevent', require: false
+  gem 'rb-fchange', require: false
+end

data/gemfiles/Gemfile.rails-4.0

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.0.0'
+gem 'activesupport', '~> 4.0.0'
+
+group :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rb-inotify', require: false
+  gem 'rb-fsevent', require: false
+  gem 'rb-fchange', require: false
+end

data/lib/chewy.rb

@@ -1,6 +1,7 @@
 require 'active_support/concern'
 require 'active_support/core_ext'
 require 'active_support/json'
+require 'i18n/core_ext/hash'
 require 'singleton'
 
 require 'elasticsearch'
@@ -38,6 +39,10 @@ module Chewy
     end
   end
 
+  def self.wait_for_status
+    client.cluster.health wait_for_status: Chewy.configuration[:wait_for_status] if Chewy.configuration[:wait_for_status].present?
+  end
+
   def self.config
     Chewy::Config.instance
   end

data/lib/chewy/fields/base.rb

@@ -40,10 +40,10 @@ module Chewy
         subfields = nested.any? ? {
           (multi_field? ? :fields : :properties) => nested.values.map(&:mappings_hash).inject(:merge)
         } : {}
-        {name => options.merge(subfields)}
+        {name => options.deep_symbolize_keys.merge(subfields)}
       end
 
-      private
+    private
 
       def nested_compose(value)
         nested.values.map { |field| field.compose(value) }.inject(:merge)

data/lib/chewy/fields/root.rb

@@ -1,9 +1,42 @@
 module Chewy
   module Fields
     class Root < Chewy::Fields::Base
+      attr_reader :dynamic_templates
+
       def initialize(name, options = {})
         options.reverse_merge!(value: ->(_){_})
         super(name, options)
+        @dynamic_templates = []
+      end
+
+      def mappings_hash
+        mappings = super
+        if dynamic_templates.any?
+          mappings[name][:dynamic_templates] ||= []
+          mappings[name][:dynamic_templates].concat dynamic_templates
+        end
+        mappings
+      end
+
+      def dynamic_template *args
+        options = args.extract_options!.deep_symbolize_keys
+        if args.first
+          template_name = :"template_#{dynamic_templates.count.next}"
+          template = {template_name => {mapping: options}}
+
+          template[template_name][:match_mapping_type] = args.second.to_s if args.second.present?
+
+          regexp = args.first.is_a?(Regexp)
+          template[template_name][:match_pattern] = 'regexp' if regexp
+
+          match = regexp ? args.first.source : args.first
+          path = match.include?(regexp ? '\.' : '.')
+
+          template[template_name][path ? :path_match : :match] = match
+          @dynamic_templates.push(template)
+        else
+          @dynamic_templates.push(options)
+        end
       end
     end
   end

data/lib/chewy/index/actions.rb

@@ -55,6 +55,9 @@ module Chewy
         def create! *args
           options = args.extract_options!.reverse_merge!(alias: true)
           name = build_index_name(suffix: args.first)
+
+          Chewy.wait_for_status
+
           result = client.indices.create(index: name, body: index_params)
           result &&= client.indices.put_alias(index: name, name: index_name) if options[:alias] && name != index_name
           result
@@ -84,6 +87,8 @@ module Chewy
         #   UsersIndex.delete '01-2014' # deletes `users_01-2014` index
         #
         def delete! suffix = nil
+          Chewy.wait_for_status
+
           client.indices.delete index: build_index_name(suffix: suffix)
         end
 
@@ -126,7 +131,7 @@ module Chewy
         [:import, :import!].each do |method|
           class_eval <<-METHOD, __FILE__, __LINE__ + 1
             def #{method} options = {}
-              objects = options.extract!(*type_names.map(&:to_sym))
+              objects = options.reject { |k, v| !type_names.map(&:to_sym).include?(k) }
               types.map do |type|
                 args = [objects[type.type_name.to_sym], options.dup].reject(&:blank?)
                 type.#{method} *args

data/lib/chewy/index/search.rb

@@ -4,7 +4,7 @@ module Chewy
       extend ActiveSupport::Concern
 
       included do
-        singleton_class.delegate :explain, :limit, :offset, :facets, :query,
+        singleton_class.delegate :explain, :limit, :offset, :facets, :aggregations, :query,
           :filter, :order, :reorder, :only, :types, :none, to: :all
       end
 

data/lib/chewy/query.rb

@@ -242,9 +242,37 @@ module Chewy
     #            facets: {tags: {terms: {field: 'tags'}}, ages: {terms: {field: 'age'}}}
     #          }}
     #
-    def facets params
-      chain { criteria.update_facets params }
+    # If called parameterless - returns result facets from ES performing request.
+    # Returns empty hash if no facets was requested or resulted.
+    #
+    def facets params = nil
+      if params
+        chain { criteria.update_facets params }
+      else
+        _response['facets'] || {}
+      end
+    end
+
+    # Sets elasticsearch <tt>aggregations</tt> search request param
+    #
+    #  UsersIndex.filter{ name == 'Johny' }.aggregations(category_id: {terms: {field: 'category_ids'}})
+    #     # => {body: {
+    #            query: {...},
+    #            aggregations: {
+    #              terms: {
+    #                field: 'category_ids'
+    #              }
+    #            }
+    #          }}
+    #
+    def aggregations params = nil
+      if params
+        chain { criteria.update_aggregations params }
+      else
+        _response['aggregations'] || {}
+      end
     end
+    alias :aggs :aggregations
 
     # Marks the criteria as having zero records. This scope  always returns empty array
     # without touching the elasticsearch server.

data/lib/chewy/query/criteria.rb

@@ -4,7 +4,9 @@ module Chewy
   class Query
     class Criteria
       include Compose
-      STORAGES = [:options, :queries, :facets, :filters, :sort, :fields, :types]
+      ARRAY_STORAGES = [:queries, :filters, :sort, :fields, :types]
+      HASH_STORAGES = [:options, :facets, :aggregations]
+      STORAGES = ARRAY_STORAGES + HASH_STORAGES
 
       def initialize options = {}
         @options = options.merge(query_mode: Chewy.query_mode, filter_mode: Chewy.filter_mode)
@@ -14,7 +16,7 @@ module Chewy
         other.is_a?(self.class) && storages == other.storages
       end
 
-      { (STORAGES - [:options, :facets]) => '[]', [:options, :facets] => '{}' }.each do |storages, default|
+      { ARRAY_STORAGES => '[]', HASH_STORAGES => '{}' }.each do |storages, default|
         storages.each do |storage|
           class_eval <<-METHODS, __FILE__, __LINE__ + 1
             def #{storage}
@@ -42,6 +44,10 @@ module Chewy
         facets.merge!(modifer)
       end
 
+      def update_aggregations(modifer)
+        aggregations.merge!(modifer)
+      end
+
       def update_queries(modifer)
         @queries = queries + Array.wrap(modifer).reject(&:blank?)
       end
@@ -81,6 +87,7 @@ module Chewy
       def request_body
         body = (_composed_query(_request_query, _request_filter) || {}).tap do |body|
           body.merge!(facets: facets) if facets?
+          body.merge!(aggregations: aggregations) if aggregations?
           body.merge!(sort: sort) if sort?
           body.merge!(_source: fields) if fields?
         end
@@ -105,7 +112,7 @@ module Chewy
       end
 
       def _request_options
-        options.slice(:size, :from, :explain)
+        options.slice(:size, :from, :explain, :aggregations)
       end
 
       def _request_query

data/lib/chewy/query/nodes/range.rb

@@ -12,8 +12,8 @@ module Chewy
         def initialize name, *args
           @name = name.to_s
           @options = args.extract_options!
-          @range = @options.extract!(:gt, :lt)
-          @bounds = @options.extract!(:left_closed, :right_closed)
+          @range = @options.reject { |k, v| ![:gt, :lt].include?(k) }
+          @bounds = @options.reject { |k, v| ![:left_closed, :right_closed].include?(k) }
           execution = EXECUTION[args.first.to_sym] if args.first
           @options[:execution] = execution if execution
         end

data/lib/chewy/query/nodes/script.rb

@@ -5,7 +5,7 @@ module Chewy
         def initialize script, params = {}
           @script = script
           @params = params
-          @options = params.extract!(:cache)
+          @options = params.reject { |k, v| ![:cache].include?(k) }
         end
 
         def __render__