search_flip 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b506132a3198cb96d7afad2e2a6b7b3eb3af73bdb18452459045379d4dde41bc
-  data.tar.gz: 31354cd6f2f715529351fb74e1577382f7c245e381d95f411bbbb1c0a0aeef1d
+  metadata.gz: d3c58927cac30203caa9e781f7f27ad725938b7b4e441e47946de72bdca8810b
+  data.tar.gz: a38d31311c6968b614395251f713b651f833ccd02d6a08f22747a5489db283e5
 SHA512:
-  metadata.gz: 6da9d91a867a2e50cd9ca3abb4784e41019a9980e3c78a6e55c1297190666a2e9bf6b7d0d43aa5431b1252eba5eb3de68d40491377788db4c09dc40579318ed2
-  data.tar.gz: e9be5d2dd82077f093eb07550cdf469d2aba1dfc8f205c26d96ae95e4cbe0be7d0e36b1bc44f9667a3151212cfb949761ef8fe8f8c5fd2a11cc7b10a8d29948e
+  metadata.gz: 9437a0b1ed85637401e636ed9335d7a2a89592efed8a1a7a3071d6a0ebc49feafbeba05c33fda9b729fcc3b37d8f3b28d36394aef70176d378a392a4f2b06a50
+  data.tar.gz: 8b17ed3c7078a8e06f09123ee901094d01b2c158da3baef48ced35e8cee1f51b70251223906c8ad849e4c1b7bfc8fb4561cf70437f546f263f2d9171c443230e

data/.travis.yml

@@ -7,8 +7,9 @@ env:
   - ES_IMAGE=elasticsearch:5.4
   - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:6.7.0
   - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:7.0.0
+  - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:7.3.0
 rvm:
-  - ruby-head
+  - ruby-2.6.2
 before_install:
   - docker-compose up -d
   - sleep 10

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 
 # CHANGELOG
 
+## v2.3.0
+
+* [DEPRECATED] `SearchFlip::Criteria#should` is deprecated and will become
+  equivalent to `.must(bool: { should: ... })` in search_flip 3
+* Added `SearchFlip::Criteria#explain`
+
+## v2.2.0
+
+* [DEPRECATED] `SearchFlip::Criteria#unscope` is deprecated and will be removed
+  in search_flip 3
+* Added `SearchFlip::Criteria#track_total_hits`
+
+## v2.1.0
+
 ## v2.0.0
 
 * Added `SearchFlip::Connection`

data/README.md

@@ -1,15 +1,15 @@
 
 # search_flip
 
-**Full-Featured ElasticSearch Ruby Client with a Chainable DSL**
+**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)
+[![Build Status](https://secure.travis-ci.org/mrkamel/search_flip.svg?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
+[Elasticsearch](https://www.elastic.co/) indices and to manipulate, query and
 aggregate these indices using a chainable, concise, yet powerful DSL. Finally,
-SearchFlip supports ElasticSearch 1.x, 2.x, 5.x, 6.x, 7.x. Check section
+SearchFlip supports Elasticsearch 1.x, 2.x, 5.x, 6.x, 7.x. Check section
 [Feature Support](#feature-support) for version dependent features.
 
 ```ruby
@@ -47,7 +47,7 @@ Comment.search(
 Comment.search("hello world", where: { available: true }, order: { id: "desc" }, aggs: [:username])
 
 # search_flip
-CommentIndex.where(available: true).search("hello world").sort(id: "desc").aggregate(:username)
+CommentIndex.search("hello world").where(available: true).sort(id: "desc").aggregate(:username)
 
 ```
 
@@ -96,7 +96,7 @@ Available config options are:
 * `bulk_limit` a global limit for bulk requests
 * `bulk_max_mb` a global limit for the payload of bulk requests
 * `auto_refresh` tells SearchFlip to automatically refresh an index after
-  import, index, delete, etc operations. This is e.g. usuful for testing, etc.
+  import, index, delete, etc operations. This is e.g. useful for testing, etc.
   Defaults to false.
 
 ## Usage
@@ -109,7 +109,7 @@ class CommentIndex
 end
 ```
 
-Then tell the Index about the index name, the correspoding model and how to
+Then tell the Index about the index name, the corresponding model and how to
 serialize the model for indexing.
 
 ```ruby
@@ -211,7 +211,7 @@ CommentIndex.close_index
 CommentIndex.open_index
 ```
 
-index records (automatically uses the bulk API):
+Index records (automatically uses the [Bulk API]):
 
 ```ruby
 CommentIndex.import(Comment.all)
@@ -220,7 +220,7 @@ CommentIndex.import([Comment.find(1), Comment.find(2)])
 CommentIndex.import(Comment.where("created_at > ?", Time.now - 7.days))
 ```
 
-query records:
+Query records:
 
 ```ruby
 CommentIndex.total_entries
@@ -238,7 +238,7 @@ CommentIndex.aggregate(:username).aggregations(:username)
 ```
 
 Please note that you can check the request that will be send to Elasticsearch
-by simply calling `#request` on the query:
+by calling `#request` on the query:
 
 ```ruby
 CommentIndex.search("hello world").sort(id: "desc").aggregate(:username).request
@@ -246,10 +246,10 @@ CommentIndex.search("hello world").sort(id: "desc").aggregate(:username).request
 ```
 
 
-delete records:
+Delete records:
 
 ```ruby
-# for ElasticSearch >= 2.x and < 5.x, the delete-by-query plugin is required
+# for Elasticsearch >= 2.x and < 5.x, the delete-by-query plugin is required
 # for the following query:
 
 CommentIndex.match_all.delete
@@ -292,11 +292,10 @@ new_user.connection.update_aliases(actions: [
 ])
 ```
 
-If the alias already exists, you of course have to remove it as well first
-within `update_aliases`.
+If the alias already exists, you have to remove it as well first within `update_aliases`.
 
-Please note that `with_settings(index_name: '...')` returns an anonymous, i.e.
-temporary, class inherting from UserIndex and overwriting `index_name`.
+Please note: `with_settings(index_name: '...')` returns an anonymous (i.e.
+temporary) class which inherits from UserIndex and overwrites `index_name`.
 
 ## Chainable Methods
 
@@ -309,7 +308,7 @@ SearchFlip provides powerful methods to query/filter Elasticsearch:
 
 * `where`
 
-Feels like ActiveRecord's `where` and adds a bool filter clause to the request:
+The `.where` method feels like ActiveRecord's `where` and adds a bool filter clause to the request:
 
 ```ruby
 CommentIndex.where(reviewed: true)
@@ -319,7 +318,7 @@ CommentIndex.where(state: ["approved", "rejected"])
 
 * `where_not`
 
-Like `where`, but exluding the matching documents:
+The `.where_not` method is like `,where`, but excluding the matching documents:
 
 ```ruby
 CommentIndex.where_not(id: [1, 2, 3])
@@ -327,7 +326,7 @@ CommentIndex.where_not(id: [1, 2, 3])
 
 * `range`
 
-To add a range filter query:
+Use `.range` to add a range filter query:
 
 ```ruby
 CommentIndex.range(:created_at, gt: Date.today - 1.week, lt: Date.today)
@@ -335,7 +334,7 @@ CommentIndex.range(:created_at, gt: Date.today - 1.week, lt: Date.today)
 
 * `filter`
 
-Use `filter` to add raw filter queries:
+Use `.filter` to add raw filter queries:
 
 ```ruby
 CommentIndex.filter(term: { state: "approved" })
@@ -343,7 +342,7 @@ CommentIndex.filter(term: { state: "approved" })
 
 * `should`
 
-Use `should` to add raw should queries:
+Use `.should` to add raw should queries:
 
 ```ruby
 CommentIndex.should(term: { state: "approved" })
@@ -351,7 +350,7 @@ CommentIndex.should(term: { state: "approved" })
 
 * `must`
 
-Use `must` to add raw must queries:
+Use `.must` to add raw must queries:
 
 ```ruby
 CommentIndex.must(term: { state: "approved" })
@@ -414,7 +413,7 @@ CommentIndex.match_all
 
 All query/filter criteria methods (`#where`, `#where_not`, `#range`, etc.) are available
 in post filter mode as well, ie. filters/queries applied after aggregations
-are calculated. Checkout the ElasticSearch docs for further info.
+are calculated. Checkout the Elasticsearch docs for further info.
 
 ```ruby
 query = CommentIndex.aggregate(:user_id)
@@ -436,7 +435,7 @@ query = OrderIndex.aggregate(:username, order: { revenue: "desc" }) do |aggregat
 end
 ```
 
-Generally, aggregation results returned by ElasticSearch are returned as a
+Generally, aggregation results returned by Elasticsearch are returned as a
 `SearchFlip::Result`, which basically is `Hashie::Mash`such that you can access
 them via:
 
@@ -444,7 +443,7 @@ them via:
 query.aggregations(:username)["mrkamel"].revenue.value
 ```
 
-Still, if you want to get the raw aggregations returned by ElasticSearch,
+Still, if you want to get the raw aggregations returned by Elasticsearch,
 access them without supplying any aggregation name to `#aggregations`:
 
 ```ruby
@@ -615,7 +614,7 @@ end
 * `failsafe`
 
 Use `#failsafe` to prevent any exceptions from being raised for query string
-syntax errors or ElasticSearch being unavailable, etc.
+syntax errors or Elasticsearch being unavailable, etc.
 
 ```ruby
 CommentIndex.search("invalid/request").execute
@@ -772,7 +771,7 @@ that work with whatever ORM you use.
 
 ## Date and Timestamps in JSON
 
-ElasticSearch requires dates and timestamps to have one of the formats listed
+Elasticsearch requires dates and timestamps to have one of the formats listed
 here: [https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#strict-date-time](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#strict-date-time).
 
 However, `JSON.generate` in ruby by default outputs something like:
@@ -782,7 +781,7 @@ JSON.generate(time: Time.now.utc)
 # => "{\"time\":\"2018-02-22 18:19:33 UTC\"}"
 ```
 
-This format is not compatible with ElasticSearch by default. If you're on
+This format is not compatible with Elasticsearch by default. If you're on
 Rails, ActiveSupport adds its own `#to_json` methods to `Time`, `Date`, etc.
 However, ActiveSupport checks whether they are used in combination with
 `JSON.generate` or not and adapt:
@@ -848,7 +847,7 @@ model changes.
 
 ## Links
 
-* ElasticSearch: [https://www.elastic.co/](https://www.elastic.co/)
+* Elasticsearch: [https://www.elastic.co/](https://www.elastic.co/)
 * Reference Docs: [http://www.rubydoc.info/github/mrkamel/search_flip](http://www.rubydoc.info/github/mrkamel/search_flip)
 * Travis: [http://travis-ci.org/mrkamel/search_flip](http://travis-ci.org/mrkamel/search_flip)
 * will_paginate: [https://github.com/mislav/will_paginate](https://github.com/mislav/will_paginate)
@@ -866,7 +865,7 @@ model changes.
 ## Running the test suite
 
 Running the tests is super easy. The test suite uses sqlite, such that you only
-need to install ElasticSearch. You can install ElasticSearch on your own, or
+need to install Elasticsearch. You can install Elasticsearch on your own, or
 you can e.g. use docker-compose:
 
 ```
@@ -876,3 +875,6 @@ $ rspec
 ```
 
 That's it.
+
+
+[Bulk API]: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html

data/lib/search_flip/aggregatable.rb

@@ -1,7 +1,7 @@
 
 module SearchFlip
   # The SearchFlip::Aggregatable mixin provides handy methods for using
-  # the ElasticSearch aggregation framework, which can be chained with
+  # the Elasticsearch aggregation framework, which can be chained with
   # each other, all other criteria methods and even nested.
   #
   # @example
@@ -16,7 +16,7 @@ module SearchFlip
     end
 
     # Adds an arbitrary aggregation to the request which can be chained as well
-    # as nested. Check out the examples and ElasticSearch docs for further
+    # as nested. Check out the examples and Elasticsearch docs for further
     # details.
     #
     # @example Basic usage with optons

data/lib/search_flip/aggregation.rb

@@ -1,7 +1,7 @@
 
 module SearchFlip
   # The SearchFlip::Aggregation class puts together everything
-  # required to use the ElasticSearch aggregation framework via mixins and
+  # required to use the Elasticsearch aggregation framework via mixins and
   # adds a method to convert it to a hash format to be used in the request.
 
   class Aggregation

data/lib/search_flip/connection.rb

@@ -20,12 +20,12 @@ module SearchFlip
       @version_mutex = Mutex.new
     end
 
-    # Queries and returns the ElasticSearch version used.
+    # Queries and returns the Elasticsearch version used.
     #
     # @example
     #   connection.version # => e.g. 2.4.1
     #
-    # @return [String] The ElasticSearch version
+    # @return [String] The Elasticsearch version
 
     def version
       @version_mutex.synchronize do
@@ -33,7 +33,7 @@ module SearchFlip
       end
     end
 
-    # Queries and returns the ElasticSearch cluster health.
+    # Queries and returns the Elasticsearch cluster health.
     #
     # @example
     #   connection.cluster_health # => { "status" => "green", ... }
@@ -44,7 +44,7 @@ module SearchFlip
       http_client.headers(accept: "application/json").get("#{base_url}/_cluster/health").parse
     end
 
-    # Uses the ElasticSearch Multi Search API to execute multiple search requests
+    # Uses the Elasticsearch Multi Search API to execute multiple search requests
     # within a single request. Raises SearchFlip::ResponseError in case any
     # errors occur.
     #
@@ -97,7 +97,7 @@ module SearchFlip
         .parse
     end
 
-    # Sends an analyze request to ElasticSearch. Raises
+    # Sends an analyze request to Elasticsearch. Raises
     # SearchFlip::ResponseError in case any errors occur.
     #
     # @example
@@ -131,7 +131,7 @@ module SearchFlip
       Hashie::Mash.new(res)
     end
 
-    # Returns whether or not the associated ElasticSearch alias already
+    # Returns whether or not the associated Elasticsearch alias already
     # exists.
     #
     # @example
@@ -168,7 +168,7 @@ module SearchFlip
 
     alias_method :cat_indices, :get_indices
 
-    # Creates the specified index within ElasticSearch and applies index
+    # Creates the specified index within Elasticsearch and applies index
     # settings, if specified. Raises SearchFlip::ResponseError in case any
     # errors occur.
     #
@@ -184,7 +184,7 @@ module SearchFlip
       true
     end
 
-    # Closes the specified index within ElasticSearch. Raises
+    # Closes the specified index within Elasticsearch. Raises
     # SearchFlip::ResponseError in case any errors occur
     #
     # @param index_name [String] The index name
@@ -197,7 +197,7 @@ module SearchFlip
       true
     end
 
-    # Opens the specified index within ElasticSearch. Raises
+    # Opens the specified index within Elasticsearch. Raises
     # SearchFlip::ResponseError in case any errors occur
     #
     # @param index_name [String] The index name
@@ -210,7 +210,7 @@ module SearchFlip
       true
     end
 
-    # Updates the index settings within ElasticSearch according to the index
+    # Updates the index settings within Elasticsearch according to the index
     # settings specified. Raises SearchFlip::ResponseError in case any
     # errors occur.
     #
@@ -225,7 +225,7 @@ module SearchFlip
       true
     end
 
-    # Fetches the index settings for the specified index from ElasticSearch.
+    # Fetches the index settings for the specified index from Elasticsearch.
     # Sends a GET request to index_url/_settings. Raises
     # SearchFlip::ResponseError in case any errors occur.
     #
@@ -237,7 +237,7 @@ module SearchFlip
       http_client.headers(accept: "application/json").get("#{index_url(index_name)}/_settings").parse
     end
 
-    # Sends a refresh request to ElasticSearch. Raises
+    # Sends a refresh request to Elasticsearch. Raises
     # SearchFlip::ResponseError in case any errors occur.
     #
     # @param index_names [String, Array] The optional index names to refresh
@@ -250,7 +250,7 @@ module SearchFlip
     end
 
     # Updates the type mapping for the specified index and type within
-    # ElasticSearch according to the specified mapping. Raises
+    # Elasticsearch according to the specified mapping. Raises
     # SearchFlip::ResponseError in case any errors occur.
     #
     # @param index_name [String] The index name
@@ -270,7 +270,7 @@ module SearchFlip
     end
 
     # Retrieves the mapping for the specified index and type from
-    # ElasticSearch. Raises SearchFlip::ResponseError in case any errors occur.
+    # Elasticsearch. Raises SearchFlip::ResponseError in case any errors occur.
     #
     # @param index_name [String] The index name
     # @param type_name [String] The type name. Starting with Elasticsearch 7,
@@ -285,7 +285,7 @@ module SearchFlip
       http_client.headers(accept: "application/json").get("#{url}/_mapping", params: params).parse
     end
 
-    # Deletes the specified index from ElasticSearch. Raises
+    # Deletes the specified index from Elasticsearch. Raises
     # SearchFlip::ResponseError in case any errors occur.
     #
     # @param index_name [String] The index name
@@ -314,24 +314,24 @@ module SearchFlip
       raise e
     end
 
-    # Returns the full ElasticSearch type URL, ie base URL, index name with
+    # Returns the full Elasticsearch type URL, ie base URL, index name with
     # prefix and type name.
     #
     # @param index_name [String] The index name
     # @param type_name [String] The type name
     #
-    # @return [String] The ElasticSearch type URL
+    # @return [String] The Elasticsearch type URL
 
     def type_url(index_name, type_name)
       "#{index_url(index_name)}/#{type_name}"
     end
 
-    # Returns the ElasticSearch index URL for the specified index name, ie base
+    # Returns the Elasticsearch index URL for the specified index name, ie base
     # URL and index name with prefix.
     #
     # @param index_name [String] The index name
     #
-    # @return [String] The ElasticSearch index URL
+    # @return [String] The Elasticsearch index URL
 
     def index_url(index_name)
       "#{base_url}/#{index_name}"