search_flip 2.1.0.beta2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b3740c9ca1f4b34538a0302d4efc92afb12ee845d1b534241070ade3255b4dd
-  data.tar.gz: afb51d3e77ef804e3487da46a8f5db33a9d5baa9dd17337afb09fa4874b710e3
+  metadata.gz: cda3eb59fdf7fabf986510c923cbded7f6a1219d734be60a406265d7ec685893
+  data.tar.gz: a30be3c6195e1864b4a37899e079e096129692ec0bb5ac0f78a0cceaf15468a2
 SHA512:
-  metadata.gz: 96e43715270ac96cd15933a6e2243c9f61dec661abe6b70e1aba93d411a7ebaa19c528a6c9f5d11950babd48f144afef06a4b5be29d91bc2d820bc014b81e951
-  data.tar.gz: be195c055a264206dd2a85657fd8c874d8e09661e6bb9d39f0fbc80f1c30cda3ce006082540c739d00eadecbf0f4e2fd68805e4c0099393bbe153986864a67a3
+  metadata.gz: df70d9f06aecbd84e7a5cb1ec16ffdd408a53da7a08f15fac4761a2e70b38b667ee4688abe7d81195eb6389e6decf2b591689a7002b75ca28cae16f8fa5bb88b
+  data.tar.gz: f903399ac8baa4b4a41ebcf3d378b64fbae236a553dc975b90b3c13a9b50e39bdbc6508a6098884510205ae42a55bf057a94f2fa73a4906a5d053d4f86ac7ba8

data/README.md

@@ -297,9 +297,116 @@ temporary, class inherting from UserIndex and overwriting `index_name`.
 SearchFlip supports even more advanced usages, like e.g. post filters, filtered
 aggregations or nested aggregations via simple to use API methods.
 
-### Post filters
+### Query/Filter Criteria Methods
 
-All criteria methods (`#where`, `#where_not`, `#range`, etc.) are available
+SearchFlip provides powerful methods to query/filter Elasticsearch:
+
+* `where`
+
+Feels like ActiveRecord's `where` and performs a bool filter clause
+to the request:
+
+```ruby
+CommentIndex.where(reviewed: true)
+CommentIndex.where(likes: 0 .. 10_000)
+CommentIndex.where(state: ["approved", "rejected"])
+```
+
+* `where_not`
+
+Like `where`, but exluding the matching documents:
+
+```ruby
+CommentIndex.where_not(id: [1, 2, 3])
+```
+
+* `range`
+
+To add a range filter query:
+
+```ruby
+CommentIndex.range(:created_at, gt: Date.today - 1.week, lt: Date.today)
+```
+
+* `filter`
+
+Use `filter` to add raw filter queries:
+
+```ruby
+CommentIndex.filter(term: { state: "approved" })
+```
+
+* `should`
+
+Use `should` to add raw should queries:
+
+```ruby
+CommentIndex.should(term: { state: "approved" })
+```
+
+* `must`
+
+Use `must` to add raw must queries:
+
+```ruby
+CommentIndex.must(term: { state: "approved" })
+
+CommentIndex.must(
+  bool: {
+    should: [
+      { terms: { state: ["approved", "rejected"] }},
+      { term: { username: "mrkamel" }}
+    ]
+  }
+)
+```
+
+* `must_not`
+
+Like `must`, but excluding the matching documents:
+
+```ruby
+CommentIndex.must_not(term: { state: "approved" })
+```
+
+* `search`
+
+Adds a query string query, with AND as default filter:
+
+```ruby
+CommentIndex.search("harry potter")
+CommentIndex.search("state:approved")
+CommentIndex.search("username:a*")
+CommentIndex.search("state:approved OR state:rejected")
+```
+
+* `exists`
+
+Use `exists` to add an `exists` query:
+
+```ruby
+CommentIndex.exists(:state)
+```
+
+* `exists_not`
+
+Like `exists`, but excluding the matching documents:
+
+```ruby
+CommentIndex.exists_not(:state)
+```
+
+* `match_all`
+
+Simply matches all documents:
+
+```ruby
+CommentIndex.match_all
+```
+
+### Post Query/Filter Criteria Methods
+
+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.
 
@@ -379,11 +486,10 @@ query = CommentIndex.highlight(:title).search("hello")
 query.results[0]._hit.highlight.title # => "<em>hello</em> world"
 ```
 
-### Advanced Criteria Methods
+### Other Criteria Methods
 
-There are even more methods to make your life easier, namely `source`,
-`scroll`, `profile`, `includes`, `preload`, `find_in_batches`, `find_each`,
-`find_results_in_batches`, `failsafe` and `unscope` to name just a few:
+There are so many chainable criteria methods to make your life easier.
+For a full list, checkout the reference docs.
 
 * `source`
 
@@ -714,4 +820,3 @@ $ rspec
 ```
 
 That's it.
-

data/lib/search_flip/version.rb

@@ -1,5 +1,5 @@
 
 module SearchFlip
-  VERSION = "2.1.0.beta2"
+  VERSION = "2.1.0"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 2.1.0.beta2
+  version: 2.1.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 2019-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -229,9 +229,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3