chewy 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11ba7489e6c513a9a8e81cc220a64718808fcde0
-  data.tar.gz: 9a3336d2e062b027ab1ca03396dc6eac549d964a
+  metadata.gz: 751edf8eb80e8e5a9f2eaf9dc2d1a1e639427a91
+  data.tar.gz: 985d1dd1398d00df7f922cf9147cae1a006f9ca0
 SHA512:
-  metadata.gz: 17dfc426d7a92c958d5d1548aa7420e380b984297c650e8b9f29658306a8ef30b9a75c3a6d86e4149af6d3d6008228fd709a98797f881fc28600fbcb511cee26
-  data.tar.gz: 55899323c6be7796cd3640a3386c9f39ccfd785a01c0594e74a53fd9022b508e0372644dc92a739c997b9f3ba094e021ed81b2c6b4fc125910a2bec2b15aa515
+  metadata.gz: bf632b85c2b0849ef88b549a170deca5d2ac39f2ec6822eabc7f5bd2d9d3c86ccbca2199bdae3ae72990e59f1de8945aee4547b0efe6b84ae789435895af9c10
+  data.tar.gz: 787052a2a10499f4b0dba7b68292a7a300616cc170c34e264d821e862fe69553bf61ef1fe9c5d9c6419d6b720fd3673b1cbd564c0011119261ed8e80beff600a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # master
 
+# Version 0.6.1
+
+## Changes
+
+  * `min_score` query option support (@jshirley)
+
+  * `Chewy::Query#find` method for finding records by id
+
 # Version 0.6.0
 
 ## Changes

data/Gemfile

@@ -11,7 +11,4 @@ gem 'kaminari', require: false
 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

@@ -15,7 +15,6 @@ require 'chewy/config'
 require 'chewy/runtime'
 require 'chewy/index'
 require 'chewy/type'
-require 'chewy/query'
 require 'chewy/fields/base'
 require 'chewy/fields/root'
 

data/lib/chewy/errors.rb

@@ -11,6 +11,9 @@ module Chewy
   class UnderivableType < Error
   end
 
+  class DocumentNotFound < Error
+  end
+
   class ImportFailed < Error
     def initialize type, errors
       output = "Import failed for `#{type}` with:\n"

data/lib/chewy/index.rb

@@ -1,13 +1,13 @@
+require 'chewy/search'
 require 'chewy/index/actions'
 require 'chewy/index/aliases'
-require 'chewy/index/search'
 require 'chewy/index/settings'
 
 module Chewy
   class Index
+    include Search
     include Actions
     include Aliases
-    include Search
 
     singleton_class.delegate :client, to: 'Chewy'
 

data/lib/chewy/query.rb

@@ -314,6 +314,14 @@ module Chewy
       chain { criteria.update_request_options rescore: value }
     end
 
+    # Elasticsearch minscore option support
+    #
+    # UsersIndex.query(...).min_score(0.5)
+    #
+    def min_score value
+      chain { criteria.update_request_options min_score: value }
+    end
+
     # Adds facets section to the search request.
     # All the chained facets a merged and added to the
     # search request
@@ -530,6 +538,7 @@ module Chewy
     #     # => []
     #   UsersIndex.none.query(text: {name: 'Johny'}).to_a
     #     # => []
+    #
     def none
       chain { criteria.update_options none: true }
     end
@@ -836,7 +845,31 @@ module Chewy
     #   UsersIndex::User.filter{ age <= 42 }.delete_all
     #
     def delete_all
-      _delete_all_response
+      request = chain { criteria.update_options simple: true }.send(:_request)
+      ActiveSupport::Notifications.instrument 'delete_query.chewy', request: request, index: index do
+        index.client.delete_by_query(request)
+      end
+    end
+
+    # Deletes all records matching a query.
+    #
+    #   UsersIndex.find(42)
+    #   UsersIndex.filter{ age <= 42 }.find(42)
+    #   UsersIndex::User.find(42)
+    #   UsersIndex::User.filter{ age <= 42 }.find(42)
+    #
+    # In all the previous examples find will return a single object.
+    # To get a collection - pass an array of ids.
+    #
+    #    UsersIndex::User.find(42, 7, 3) # array of objects with ids in [42, 7, 3]
+    #    UsersIndex::User.find([8, 13])  # array of objects with ids in [8, 13]
+    #    UsersIndex::User.find([42])     # array of the object with id == 42
+    #
+    def find *ids
+      results = chain { criteria.update_options simple: true }.filter { _id == ids.flatten }.to_a
+
+      raise Chewy::DocumentNotFound.new("Could not find documents for ids #{ids.flatten}") if results.empty?
+      ids.one? && !ids.first.is_a?(Array) ? results.first : results
     end
 
     # Returns request total time elapsed as reported by elasticsearch
@@ -882,10 +915,6 @@ module Chewy
       @_request ||= criteria.request_body.merge(index: index.index_name, type: types)
     end
 
-    def _delete_all_request
-      @_delete_all_request ||= criteria.delete_all_request_body.merge(index: index.index_name, type: types)
-    end
-
     def _response
       @_response ||= ActiveSupport::Notifications.instrument 'search_query.chewy', request: _request, index: index do
         begin
@@ -897,12 +926,6 @@ module Chewy
       end
     end
 
-    def _delete_all_response
-      @_delete_all_response ||= ActiveSupport::Notifications.instrument 'delete_query.chewy', request: _delete_all_request, index: index do
-        index.client.delete_by_query(_delete_all_request)
-      end
-    end
-
     def _results
       @_results ||= (criteria.none? || _response == {} ? [] : _response['hits']['hits']).map do |hit|
         attributes = (hit['_source'] || {}).merge(hit['highlight'] || {}, &RESULT_MERGER)

data/lib/chewy/query/criteria.rb

@@ -101,24 +101,22 @@ module Chewy
       end
 
       def request_body
-        body = {}
+        body = _filtered_query(_request_query, _request_filter, options.slice(:strategy))
 
+        if options[:simple]
+          { body: body.presence || { query: { match_all: {} } } }
+        else
+          body.merge!(post_filter: _request_post_filter) if post_filters?
+          body.merge!(facets: facets) if facets?
+          body.merge!(aggregations: aggregations) if aggregations?
+          body.merge!(suggest: suggest) if suggest?
+          body.merge!(sort: sort) if sort?
+          body.merge!(_source: fields) if fields?
 
-        body.merge!(_filtered_query(_request_query, _request_filter, options.slice(:strategy)))
-        body.merge!(post_filter: _request_post_filter) if post_filters?
-        body.merge!(facets: facets) if facets?
-        body.merge!(aggregations: aggregations) if aggregations?
-        body.merge!(suggest: suggest) if suggest?
-        body.merge!(sort: sort) if sort?
-        body.merge!(_source: fields) if fields?
-
-        body = _boost_query(body)
-
-        { body: body.merge!(request_options) }
-      end
+          body = _boost_query(body)
 
-      def delete_all_request_body
-        { body: _filtered_query(_request_query, _request_filter, options.slice(:strategy)).presence || { query: { match_all: {} } } }
+          { body: body.merge!(request_options) }
+        end
       end
 
     protected
@@ -151,10 +149,6 @@ module Chewy
         body.tap { |b| b[:query] = { function_score: score } }
       end
 
-      def _request_options
-        options.slice(:size, :from, :explain, :highlight, :rescore)
-      end
-
       def _request_query
         _queries_join(queries, options[:query_mode])
       end

data/lib/chewy/search.rb

@@ -0,0 +1,35 @@
+require 'chewy/query'
+
+module Chewy
+  module Search
+    extend ActiveSupport::Concern
+
+    included do
+      singleton_class.delegate :explain, :query_mode, :filter_mode, :post_filter_mode,
+        :timeout, :limit, :offset, :highlight, :min_score, :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, :find, :total,
+        :total_count, :total_entries, to: :all
+    end
+
+    module ClassMethods
+      def all
+        Chewy::Query.new(search_index, types: search_type)
+      end
+
+      def search_string query, options = {}
+        options = options.merge(index: search_index.index_name, type: search_type, q: query)
+        client.search(options)
+      end
+
+      def search_index
+        raise NotImplementedError
+      end
+
+      def search_type
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/chewy/type.rb

@@ -1,4 +1,4 @@
-require 'chewy/index/search'
+require 'chewy/search'
 require 'chewy/type/mapping'
 require 'chewy/type/wrapper'
 require 'chewy/type/observe'
@@ -10,7 +10,7 @@ require 'chewy/type/adapter/mongoid'
 
 module Chewy
   class Type
-    include Chewy::Index::Search
+    include Search
     include Mapping
     include Wrapper
     include Observe

data/lib/chewy/version.rb

@@ -1,3 +1,3 @@
 module Chewy
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

data/spec/chewy/index/search_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Chewy::Index::Search do
+describe Chewy::Search do
   before do
     stub_index(:products) do
       define_type :product

data/spec/chewy/query_spec.rb

@@ -291,6 +291,31 @@ describe Chewy::Query do
     specify { expect { ProductsIndex::City.delete_all }.to change { ProductsIndex.total }.from(9).to(6) }
   end
 
+  describe '#find' do
+    let(:products) { 3.times.map { |i| {id: i.next.to_s, name: "Name#{i.next}", age: 10 * i.next}.stringify_keys! } }
+    let(:cities) { 1.times.map { |i| {id: '4'}.stringify_keys! } }
+    let(:countries) { 1.times.map { |i| {id: '4'}.stringify_keys! } }
+
+    before do
+      ProductsIndex::Product.import!(products.map { |h| double(h) })
+      ProductsIndex::City.import!(cities.map { |h| double(h) })
+      ProductsIndex::Country.import!(countries.map { |h| double(h) })
+    end
+
+    specify { expect(subject.find(1)).to be_a(ProductsIndex::Product) }
+    specify { expect(subject.find(1).id).to eq('1') }
+    specify { expect(subject.find(4).id).to eq('4') }
+    specify { expect(subject.find([1]).map(&:id)).to match_array(%w(1)) }
+    specify { expect(subject.find([4]).map(&:id)).to match_array(%w(4 4)) }
+    specify { expect(subject.find([1, 3]).map(&:id)).to match_array(%w(1 3)) }
+    specify { expect(subject.find(1, 3).map(&:id)).to match_array(%w(1 3)) }
+    specify { expect(subject.find(1, 10).map(&:id)).to match_array(%w(1)) }
+
+    specify { expect { subject.find(10) }.to raise_error Chewy::DocumentNotFound }
+    specify { expect { subject.find([10]) }.to raise_error Chewy::DocumentNotFound }
+    specify { expect { subject.find([10, 20]) }.to raise_error Chewy::DocumentNotFound }
+  end
+
   describe '#none' do
     specify { expect(subject.none).to be_a described_class }
     specify { expect(subject.none).not_to eq(subject) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chewy
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - pyromaniac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2014-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -186,7 +186,6 @@ files:
 - lib/chewy/index.rb
 - lib/chewy/index/actions.rb
 - lib/chewy/index/aliases.rb
-- lib/chewy/index/search.rb
 - lib/chewy/index/settings.rb
 - lib/chewy/query.rb
 - lib/chewy/query/compose.rb
@@ -221,6 +220,7 @@ files:
 - lib/chewy/rspec/update_index.rb
 - lib/chewy/runtime.rb
 - lib/chewy/runtime/version.rb
+- lib/chewy/search.rb
 - lib/chewy/type.rb
 - lib/chewy/type/actions.rb
 - lib/chewy/type/adapter/active_record.rb

data/lib/chewy/index/search.rb

@@ -1,35 +0,0 @@
-module Chewy
-  class Index
-    module Search
-      extend ActiveSupport::Concern
-
-      included do
-        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
-        def all
-          Chewy::Query.new(search_index, types: search_type)
-        end
-
-        def search_string query, options = {}
-          options = options.merge(index: search_index.index_name, type: search_type, q: query)
-          client.search(options)
-        end
-
-        def search_index
-          raise NotImplementedError
-        end
-
-        def search_type
-          raise NotImplementedError
-        end
-      end
-    end
-  end
-end