search_flip 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 140f180d3c3e60a2ff681c46294726278de9c105
-  data.tar.gz: 2a39b8a053056167b3bb08a5e74a8ea868516a1a
+  metadata.gz: 62b02c26a3579fdda9d1eca222c6c1eb19b28382
+  data.tar.gz: fc3fe009dc1c8d84d03ab497c5302922474282c5
 SHA512:
-  metadata.gz: b287350dce24ff80a57d831bc70e58be732793315dd9c0ae5ecebc720ea57b9c91bd1240401b9ec9714eee84536169fc7492eecc1068d70fac58b388ad79dc42
-  data.tar.gz: 685148c002d82f19047a90e80085e0d104ae6e3c0b4b6d81dffc30c221d3a97a611f580b5a6185c97d6c9bd1d6f3e0e65aa7fe53e2ec19a499f653061258952d
+  metadata.gz: f6cee1c3258c0ff0662cec18d72313552706054e55a08c2f14003999c6d0d4bb910112507da340ad9dc1510b9f3f4b422ce11b0ec1b7eea8481450d430436bfc
+  data.tar.gz: 9062e11098ab36c5063f992284a1d94ea27b422fabb0d4e94aa5b1c5b37da8c0508326d20566ab155f649034e2f924e739795b4ab89ab06ca6b2fa107f0e3bd3

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 gemfiles/*.lock
+irb.rb

data/.travis.yml

@@ -1,8 +1,7 @@
 
 rvm:
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
+  - 2.3.3
+  - ruby-head
 
 dist: trusty
 
@@ -13,9 +12,12 @@ env:
   - ES_VERSION=1
   - ES_VERSION=2
   - ES_VERSION=5
+  - ES_VERSION=6
 
 install:
   - travis_retry bundle install
+  - sh -c "if [ '$ES_VERSION' = '6' ]; then (curl -s https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-6.2.2.tar.gz | tar xz -C /tmp); fi"
+  - sh -c "if [ '$ES_VERSION' = '6' ]; then /tmp/elasticsearch-6.2.2/bin/elasticsearch -d; fi"
   - sh -c "if [ '$ES_VERSION' = '5' ]; then (curl -s https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.4.0.tar.gz | tar xz -C /tmp); fi"
   - sh -c "if [ '$ES_VERSION' = '5' ]; then /tmp/elasticsearch-5.4.0/bin/elasticsearch -d; fi"
   - sh -c "if [ '$ES_VERSION' = '2' ]; then (curl -s https://download.elastic.co/elasticsearch/release/org/elasticsearch/distribution/tar/elasticsearch/2.4.1/elasticsearch-2.4.1.tar.gz | tar xz -C /tmp); fi"
@@ -28,7 +30,7 @@ before_script:
   - sleep 30
 
 script:
-  - bundle exec rake test
+  - rake test --trace
 
 sudo: false
 

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+
+# CHANGELOG
+
+* Version 1.1.0
+
+- Added `Criteria#find_results_in_batches` to scroll through the raw results
+- Fixed bug in `Criteria#find_in_batches` which possibly stopped scrolling too early
+- Added delegation for `should`, `should_not`, `must` and `must_not`
+- Migrated To FactoryBot
+

data/README.md

@@ -1,7 +1,10 @@
 
 # SearchFlip
 
+**Full-Featured ElasticSearch Ruby Client with a Chainable DSL**
+
 [![Build Status](https://secure.travis-ci.org/mrkamel/search_flip.png?branch=master)](http://travis-ci.org/mrkamel/search_flip)
+[![Gem Version](https://badge.fury.io/rb/search_flip.svg)](http://badge.fury.io/rb/search_flip)
 
 Using SearchFlip it is dead-simple to create index classes that correspond to
 [ElasticSearch](https://www.elastic.co/) indices and to manipulate, query and
@@ -338,7 +341,7 @@ query.results[0].highlight.title # => "<em>hello</em> world"
 
 There are even more methods to make your life easier, namely `source`,
 `scroll`, `profile`, `includes`, `preload`, `find_in_batches`, `find_each`,
-`failsafe` and `unscope` to name just a few:
+`find_results_in_batches`, `failsafe` and `unscope` to name just a few:
 
 * `source`
 
@@ -378,7 +381,7 @@ end
 
 * `profile`
 
-Use `#profile` To enable query profiling:
+Use `#profile` to enable query profiling:
 
 ```ruby
 query = CommentIndex.profile(true)
@@ -424,6 +427,17 @@ CommentIndex.search("hello world").find_in_batches(batch_size: 100) do |batch|
 end
 ```
 
+* `find_results_in_batches`
+
+Used like `find_in_batches`, but yielding the raw results instead of database
+records. Again, the batch size and scroll API timeout can be specified.
+
+```ruby
+CommentIndex.search("hello world").find_results_in_batches(batch_size: 100) do |batch|
+  # ...
+end
+```
+
 * `find_each`
 
 Like `#find_in_batches`, use `#find_each` to fetch records in batches, but yields

data/lib/search_flip/criteria.rb

@@ -590,21 +590,36 @@ module SearchFlip
     #   batch. Uses #limit to control the batch size.
     # @option options timeout [String] The timeout per scroll request, ie how
     #   long ElasticSearch will keep the request handle open.
-    #
-    # @return [SearchFlip::Criteria] A newly created extended criteria
 
     def find_in_batches(options = {})
       return enum_for(:find_in_batches, options) unless block_given?
 
-      batch_size = options[:batch_size] || 1_000
-      timeout = options[:timeout] || "1m"
+      yield_in_batches(options) do |criteria|
+        yield(criteria.records) if criteria.records.size > 0
+      end
+    end
 
-      criteria = limit(batch_size).scroll(timeout: timeout)
+    # Fetches the results specified by the criteria in batches using the
+    # ElasticSearch scroll API and yields each batch. The batch size and scroll
+    # API timeout can be specified. Checkout out the ElasticSearch docs for
+    # further details.
+    #
+    # @example
+    #   CommentIndex.search("hello world").find_results_in_batches(batch_size: 100) do |batch|
+    #     # ...
+    #   end
+    #
+    # @param options [Hash] The options to control the fetching of batches
+    # @option options batch_size [Fixnum] The number of records to fetch per
+    #   batch. Uses #limit to control the batch size.
+    # @option options timeout [String] The timeout per scroll request, ie how
+    #   long ElasticSearch will keep the request handle open.
 
-      until criteria.records.empty?
-        yield criteria.records
+    def find_results_in_batches(options = {})
+      return enum_for(:find_results_in_batches, options) unless block_given?
 
-        criteria = criteria.scroll(id: criteria.scroll_id, timeout: timeout)
+      yield_in_batches(options) do |criteria|
+        yield criteria.results
       end
     end
 
@@ -623,8 +638,6 @@ module SearchFlip
     #   batch. Uses #limit to control the batch size.
     # @option options timeout [String] The timeout per scroll request, ie how
     #   long ElasticSearch will keep the request handle open.
-    #
-    # @return [SearchFlip::Criteria] A newly created extended criteria
 
     def find_each(options = {})
       return enum_for(:find_each, options) unless block_given?
@@ -732,6 +745,23 @@ module SearchFlip
 
     def_delegators :response, :total_entries, :total_count, :current_page, :previous_page, :prev_page, :next_page, :first_page?, :last_page?, :out_of_range?, :total_pages,
       :hits, :ids, :count, :size, :length, :took, :aggregations, :suggestions, :scope, :results, :records, :scroll_id, :raw_response
+
+    private
+
+    def yield_in_batches(options = {})
+      return enum_for(:yield_in_batches, options) unless block_given?
+
+      batch_size = options[:batch_size] || 1_000
+      timeout = options[:timeout] || "1m"
+
+      criteria = limit(batch_size).scroll(timeout: timeout)
+
+      until criteria.ids.empty?
+        yield criteria.response
+
+        criteria = criteria.scroll(id: criteria.scroll_id, timeout: timeout)
+      end
+    end
   end
 end
 

data/lib/search_flip/index.rb

@@ -216,7 +216,8 @@ module SearchFlip
 
       def_delegators :criteria, :profile, :where, :where_not, :filter, :range, :match_all, :exists, :exists_not, :post_where, :post_where_not, :post_filter, :post_range,
         :post_exists, :post_exists_not, :aggregate, :scroll, :source, :includes, :eager_load, :preload, :sort, :resort, :order, :reorder, :offset, :limit, :paginate,
-        :page, :per, :search, :highlight, :suggest, :custom, :find_in_batches, :find_each, :failsafe, :total_entries, :total_count, :timeout, :terminate_after, :records
+        :page, :per, :search, :highlight, :suggest, :custom, :find_in_batches, :find_results_in_batches, :find_each, :failsafe, :total_entries, :total_count, :timeout,
+        :terminate_after, :records, :should, :should_not, :must, :must_not
 
       # Override to specify the type name used within ElasticSearch. Recap,
       # this gem uses an individual index for each index class, because

data/lib/search_flip/version.rb

@@ -1,5 +1,5 @@
 
 module SearchFlip
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end
 

data/lib/search_flip.rb

@@ -76,7 +76,7 @@ module SearchFlip
   # @return [SearchFlip::Response] The raw response
 
   def self.aliases(payload)
-    SearchFlip::HTTPClient.headers(accept: "application/json").post("#{SearchFlip::Config[:base_url]}/_aliases", body: SearchFlip::JSON.generate(payload))
+    SearchFlip::HTTPClient.headers(accept: "application/json", content_type: "application/json").post("#{SearchFlip::Config[:base_url]}/_aliases", body: SearchFlip::JSON.generate(payload))
   end
 end
 

data/search_flip.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "mocha"
-  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "factory_bot"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "activerecord", ">= 3.0"
   spec.add_development_dependency "webmock"
@@ -32,4 +32,3 @@ Gem::Specification.new do |spec|
   spec.add_dependency "hashie"
   spec.add_dependency "oj"
 end
-

data/test/search_flip/criteria_test.rb

@@ -755,6 +755,19 @@ class SearchFlip::CriteriaTest < SearchFlip::TestCase
     assert_equal [[expected1, expected2], [expected3]], ProductIndex.where(title: "expected").sort(:rank).find_in_batches(batch_size: 2).to_a
   end
 
+  def test_find_results_in_batches
+    expected1 = create(:product, title: "expected", rank: 1)
+    expected2 = create(:product, title: "expected", rank: 2)
+    expected3 = create(:product, title: "expected", rank: 3)
+    rejected = create(:product, title: "rejected")
+
+    create :product, title: "rejected"
+
+    ProductIndex.import [expected1, expected2, expected3, rejected]
+
+    assert_equal [[expected1.id, expected2.id], [expected3.id]], ProductIndex.where(title: "expected").sort(:rank).find_results_in_batches(batch_size: 2).map { |batch| batch.map(&:id) }
+  end
+
   def test_find_each
     expected1 = create(:product, title: "expected", rank: 1)
     expected2 = create(:product, title: "expected", rank: 2)

data/test/search_flip/index_test.rb

@@ -6,7 +6,7 @@ class SearchFlip::IndexTest < SearchFlip::TestCase
     :post_where_not, :post_filter, :post_range, :post_exists, :post_exists_not, :aggregate, :scroll, :source, :includes,
     :eager_load, :preload, :sort, :resort, :order, :reorder, :offset, :limit, :paginate, :page, :per, :search,
     :find_in_batches, :highlight, :suggest, :custom, :find_each, :failsafe, :total_entries, :total_count, :terminate_after,
-    :timeout, to: :criteria, subject: ProductIndex
+    :timeout, :should, :should_not, :must, :must_not, to: :criteria, subject: ProductIndex
 
   def test_create_index
     assert TestIndex.create_index

data/test/test_helper.rb

@@ -2,10 +2,10 @@
 require "minitest"
 require "minitest/autorun"
 require "webmock/minitest"
-require "mocha/mini_test"
+require "mocha/minitest"
 require "search_flip"
 require "active_record"
-require "factory_girl"
+require "factory_bot"
 require "timecop"
 require "yaml"
 
@@ -35,7 +35,7 @@ class Product < ActiveRecord::Base
   has_many :comments
 end
 
-FactoryGirl.define do
+FactoryBot.define do
   factory :product
 end
 
@@ -50,7 +50,7 @@ class User < ActiveRecord::Base
   has_many :products
 end
 
-FactoryGirl.define do
+FactoryBot.define do
   factory :user
 end
 
@@ -68,7 +68,7 @@ class Comment < ActiveRecord::Base
   belongs_to :product
 end
 
-FactoryGirl.define do
+FactoryBot.define do
   factory :comment
 end
 
@@ -156,7 +156,7 @@ class TestIndex
     {
       test: {
         properties: {
-          test_field: { type: "string" }
+          test_field: { type: "date" }
         }
       }
     }
@@ -170,7 +170,7 @@ end
 TestIndex.delete_index if TestIndex.index_exists?
 
 class SearchFlip::TestCase < MiniTest::Test
-  include FactoryGirl::Syntax::Methods
+  include FactoryBot::Syntax::Methods
 
   def self.should_delegate_method(method, to:, subject:, as: method)
     define_method :"test_delegate_#{method}_to_#{to}" do
@@ -240,4 +240,3 @@ class SearchFlip::TestCase < MiniTest::Test
     Product.delete_all
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -187,11 +187,11 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- irb.rb
 - lib/search_flip.rb
 - lib/search_flip/aggregatable.rb
 - lib/search_flip/aggregation.rb

data/irb.rb

@@ -1,7 +0,0 @@
-
-require "irb"
-$:.unshift "./lib"
-
-require "./test/test_helper.rb"
-
-IRB.start