search_flip 2.3.2 → 3.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b35fa0a26656805611e1f40be7cf17a80a9e5b307b45eeecca1fe7307ab4c3ec
-  data.tar.gz: 20103b3bf9a10635d9b43885895b9f046ffc72b36c7b1ebd125d0033571a7d6e
+  metadata.gz: f16c0308f14d764aab7fa477c8ba4169bf7d493e774cd8f435d8fa0ecd9ce991
+  data.tar.gz: 7a91d1a23b846eb17466369d82ec5583b6346d237037cd12c0cd8e036df2498d
 SHA512:
-  metadata.gz: 6f894a1fbdc3f62adc190da4de5446a41dfe69a4f4cc717cba45660719790f79a65dad0d4016aed0a4fd197bd90bc71d62b2a9e99efaf3767feec95739abdfc1
-  data.tar.gz: 480eb7a2c092bd2f6dd53ffb11aeb888310ba2cf0e73827532e9b29bc151462748a0b69f09a02165785eb9d554c4b1d1677c97dc03211d3026612b2b008d662a
+  metadata.gz: e5ccd27acffd9cd2e91a66c3b4e99c9fb09d30d8c720785cedaf233ba314e28d2317c331fc7d63a29ef29d9951bd071d8ed849ffd0e3486e6890d428b3c94317
+  data.tar.gz: a7f5b2f4969d7daa6aa578f4a31588b263f44f7e48aa4729bc820032923b804254cb0ad941dc961b8f36c508f07b27ef2ac7198802b02db2385cd1487b32cdc8

data/.rubocop.yml

@@ -1,23 +1,35 @@
-Style/FrozenStringLiteralComment:
+Style/HashTransformValues:
+  Enabled: false
+
+Style/HashTransformKeys:
   Enabled: false
 
-Style/UnneededPercentQ:
+Style/HashEachMethods:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
   Enabled: false
 
-Style/BracesAroundHashParameters:
+Lint/RedundantRequireStatement:
   Enabled: false
 
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
 Style/PercentLiteralDelimiters:
   Enabled: false
 
 Style/SpecialGlobalVars:
-  Enabled: false
+  EnforcedStyle: use_english_names
 
 Security/Eval:
   Enabled: false
 
 Style/WordArray:
-  Enabled: false
+  EnforcedStyle: brackets
 
 Style/ClassAndModuleChildren:
   Enabled: false
@@ -34,19 +46,16 @@ Style/StringLiteralsInInterpolation:
 Metrics/ClassLength:
   Enabled: false
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   Enabled: false
 
 Style/SymbolArray:
-  Enabled: false
+  EnforcedStyle: brackets
 
 Layout/RescueEnsureAlignment:
   Enabled: false
 
-Layout/LeadingBlankLines:
-  Enabled: false
-
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 
 Metrics/MethodLength:
@@ -58,9 +67,6 @@ Metrics/ModuleLength:
 Style/ZeroLengthPredicate:
   Enabled: false
 
-Layout/TrailingBlankLines:
-  Enabled: false
-
 Metrics/PerceivedComplexity:
   Enabled: false
 
@@ -100,20 +106,14 @@ Style/MutableConstant:
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 
 Lint/UnusedMethodArgument:
   Enabled: false
 
-Layout/IndentArray:
-  EnforcedStyle: consistent
-
 Style/IfUnlessModifier:
   Enabled: false
 
 Style/RedundantBegin:
   Enabled: false
-
-Style/OptionalArguments:
-  Enabled: false

data/.travis.yml

@@ -1,8 +1,6 @@
-
 sudo: false
 language: ruby
 env:
-  - ES_IMAGE=elasticsearch:1
   - ES_IMAGE=plainpicture/elasticsearch:2.4.1_delete-by-query
   - ES_IMAGE=elasticsearch:5.4
   - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:6.7.0
@@ -10,11 +8,11 @@ env:
   - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:7.4.0
 rvm:
   - ruby-2.6.2
-  - ruby-2.7.1
 before_install:
   - docker-compose up -d
   - sleep 10
 install:
   - travis_retry bundle install
-script: rspec
-
+script:
+ - bundle exec rspec
+ - bundle exec rubocop

data/CHANGELOG.md

@@ -1,24 +1,40 @@
 
 # CHANGELOG
 
-## v2.3.2
+## v3.0.0
 
-* Remove ruby 2.7 warnings
+* Added `Criteria#to_query`, which returns a raw query including all queries
+  and filters, including the post filters
+* Added `Criteria#all`
+* [BREAKING] Support for elasticsearch 1.x has been removed
+* [BREAKING] No longer pass multiple arguments to `#must`, `#must_not`,
+  `#filter`, `#should`, `#post_must`, `#post_must_not`, `#post_filter`, and
+  `#post_should`. Pass an array of arguments instead: `.post_must([...])`
+* [BREAKING] `#should` and `#post_should` is now equivalent to
+  `.must(bool: { should: ... })` and `.post_must(bool: { should: ... })`,
+* [BREAKING] `#unscope` is removed
+* [BREAKING] `SearchFlip::Connection#get_aliases` no longer returns a
+  Hashie::Mash, but a raw Hash as was already stated in the docs
+* `#post_where` and  `#post_where_not` now handle `nil` values as well:
+  `.post_where_not(title: nil)` with `exists/exists not` filters
+* `Connection#cat_indices/get_indices` now accepts additional parameters
+* `Connection#freeze_index`, `Connection#unfreeze_index`, `Index#freeze_index`
+   and `Index#unfreeze_index` added
 
 ## v2.3.1
 
-* Make search_flip work with hashie 4.0.0
+* Make `search_flip` work with hashie 4.0.0
 
 ## v2.3.0
 
 * [DEPRECATED] `SearchFlip::Criteria#should` is deprecated and will become
-  equivalent to `.must(bool: { should: ... })` in search_flip 3
+  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
+  in `search_flip` 3
 * Added `SearchFlip::Criteria#track_total_hits`
 
 ## v2.1.0

data/Gemfile

@@ -1,7 +1,5 @@
-
 source "https://rubygems.org"
 
 gemspec
 
 gem "activerecord", "< 5" if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.2.2")
-

data/README.md

@@ -9,7 +9,7 @@
 Using SearchFlip it is dead-simple to create index classes that correspond to
 [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 2.x, 5.x, 6.x, 7.x. Check section
 [Feature Support](#feature-support) for version dependent features.
 
 ```ruby
@@ -245,7 +245,6 @@ CommentIndex.search("hello world").sort(id: "desc").aggregate(:username).request
 # => {:query=>{:bool=>{:must=>[{:query_string=>{:query=>"hello world", :default_operator=>:AND}}]}}, ...}
 ```
 
-
 Delete records:
 
 ```ruby
@@ -335,7 +334,7 @@ CommentIndex.where(state: ["approved", "rejected"])
 
 * `where_not`
 
-The `.where_not` method is like `,where`, but excluding the matching documents:
+The `.where_not` method is like `.where`, but excluding the matching documents:
 
 ```ruby
 CommentIndex.where_not(id: [1, 2, 3])
@@ -362,7 +361,10 @@ CommentIndex.filter(term: { state: "approved" })
 Use `.should` to add raw should queries:
 
 ```ruby
-CommentIndex.should(term: { state: "approved" })
+CommentIndex.should([
+  { term: { state: "approved" } },
+  { term: { user: "mrkamel" } },
+])
 ```
 
 * `must`
@@ -371,15 +373,6 @@ 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`
@@ -426,6 +419,35 @@ Simply matches all documents:
 CommentIndex.match_all
 ```
 
+* `all`
+
+Simply returns the criteria as is or an empty criteria when called on the index
+class directly. Useful for chaining.
+
+```ruby
+CommentIndex.all
+```
+
+* `to_query`
+
+Sometimes, you want to convert the constraints of a search flip query to a raw
+query to e.g. use it in a should clause:
+
+```ruby
+CommentIndex.should([
+  CommentIndex.range(:likes_count, gt: 10).to_query,
+  CommentIndex.search("search term").to_query
+])
+```
+
+It returns all added queries and filters, including post filters as a raw
+query:
+
+```ruby
+CommentIndex.where(state: "new").search("text").to_query
+# => {:bool=>{:filter=>[{:term=>{:state=>"new"}}], :must=>[{:query_string=>{:query=>"text", ...}}]}}
+```
+
 ### Post Query/Filter Criteria Methods
 
 All query/filter criteria methods (`#where`, `#where_not`, `#range`, etc.) are available
@@ -835,15 +857,13 @@ require "search_flip/to_json"
 
 ## Feature Support
 
-* `#post_search` and `#profile` are only supported from up to Elasticsearch
-  version >= 2.
 * for Elasticsearch 2.x, the delete-by-query plugin is required to delete
   records via queries
 * `#track_total_hits` is only available with Elasticsearch >= 7
 
 ## Keeping your Models and Indices in Sync
 
-Besides the most basic approach to get you started, SarchFlip currently doesn't
+Besides the most basic approach to get you started, SearchFlip currently doesn't
 ship with any means to automatically keep your models and indices in sync,
 because every method is very much bound to the concrete environment and depends
 on your concrete requirements. In addition, the methods to achieve model/index

data/Rakefile

@@ -6,4 +6,3 @@ Rake::TestTask.new(:test) do |t|
   t.pattern = "test/**/*_test.rb"
   t.verbose = true
 end
-

data/UPDATING.md

@@ -1,6 +1,97 @@
 
 # Updating from previous SearchFlip versions
 
+## Update 2.x to 3.x
+
+* **[BREAKING]**  No longer pass multiple arguments to `#must`, `#must_not`,
+  `#filter`, `#should`, `#post_must`, `#post_must_not`, `#post_filter`, and
+  `#post_should`.
+
+2.x:
+
+```ruby
+CommentIndex.must({ term: { state: "new" } }, { term: { state: "approved" } })
+```
+
+3.x:
+
+```ruby
+CommentIndex.must([
+  { term: { state: "new" } },
+  { term: { state: "approved" } }
+])
+```
+
+Same for `#must_not`, `#filter`, `#should`, etc.
+
+* **[BREAKING]** `#should` and `#post_should` is now equivalent to `.must(bool: {
+  should: ... })` and `.post_must(bool: { should: ... })`, respectively.
+
+No necessary code changes, but different queries will be produced:
+
+2.x:
+
+```ruby
+query = CommentIndex.should([
+  { term: { state: "new" } },
+  { term: { state: "approved" }}
+])
+
+query = query.should([
+  { term: { state: "declined" } },
+  { term: { state: "pending" } }
+])
+```
+
+generated a query matching:
+
+`new OR approved OR declined OR pending`
+
+3.x:
+
+SearchFlip 3 generates a query matching:
+
+`(new OR approved) AND (declined OR pending)`
+
+as desired in nearly all cases.
+
+* [BREAKING] `#unscope` is removed
+
+There is no equivalent replacement, but you can achieve the same by using the
+intermediate queries instead:
+
+2.x:
+
+```ruby
+query1 = CommentIndex.where(price: 0..20).search("some terms")
+query2 = query1.unscope(:search)
+```
+
+3.x
+
+```ruby
+query1 = CommentIndex.where(price: 0..20)
+query2 = query1.search("some terms")
+```
+
+* **[BREAKING]** `SearchFlip::Connection#get_aliases` no longer returns a
+  Hashie::Mash, but a raw Hash as was already stated in the docs
+
+Code changes are only neccessary if you use methods related to `Hashie::Mash`
+on the result of `#get_aliases` like e.g.
+
+2.x:
+
+```ruby
+CommentIndex.connection.get_aliases['index_name'].aliases
+```
+
+3.x:
+
+```ruby
+CommentIndex.connection.get_aliases['index_name']['aliases']
+```
+
 ## Update 1.x to 2.x
 
 * **[BREAKING]** No longer include the `type_name` in `SearchFlip::Index.mapping`

data/lib/search_flip/aggregatable.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   # The SearchFlip::Aggregatable mixin provides handy methods for using
   # the Elasticsearch aggregation framework, which can be chained with
@@ -66,4 +65,3 @@ module SearchFlip
     end
   end
 end
-

data/lib/search_flip/aggregation.rb

@@ -1,12 +1,11 @@
-
 module SearchFlip
   # The SearchFlip::Aggregation class puts together everything
   # 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
-    include SearchFlip::Filterable
-    include SearchFlip::Aggregatable
+    include Filterable
+    include Aggregatable
 
     attr_reader :target
 
@@ -24,22 +23,17 @@ module SearchFlip
       res = {}
       res[:aggregations] = aggregation_values if aggregation_values
 
-      if must_values || search_values || must_not_values || should_values || filter_values
+      if must_values || must_not_values || filter_values
         if target.connection.version.to_i >= 2
           res[:filter] = {
             bool: {}
-              .merge(must_values || search_values ? { must: (must_values || []) + (search_values || []) } : {})
+              .merge(must_values ? { must: must_values } : {})
               .merge(must_not_values ? { must_not: must_not_values } : {})
-              .merge(should_values ? { should: should_values } : {})
               .merge(filter_values ? { filter: filter_values } : {})
           }
         else
           filters = (filter_values || []) + (must_not_values || []).map { |must_not_value| { not: must_not_value } }
-
-          queries = {}
-            .merge(must_values || search_values ? { must: (must_values || []) + (search_values || []) } : {})
-            .merge(should_values ? { should: should_values } : {})
-
+          queries = must_values ? { must: must_values } : {}
           filters_and_queries = filters + (queries.size > 0 ? [bool: queries] : [])
 
           res[:filter] = filters_and_queries.size > 1 ? { and: filters_and_queries } : filters_and_queries.first
@@ -64,8 +58,8 @@ module SearchFlip
         unsupported_methods = [
           :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :offset_value, :limit_value,
           :scroll_args, :highlight_values, :suggest_values, :custom_value, :source_value, :sort_values,
-          :includes_values, :preload_values, :eager_load_values, :post_search_values, :post_must_values,
-          :post_must_not_values, :post_should_values, :post_filter_values, :preference_value,
+          :includes_values, :preload_values, :eager_load_values, :post_must_values,
+          :post_must_not_values, :post_filter_values, :preference_value,
           :search_type_value, :routing_value
         ]
 
@@ -75,10 +69,8 @@ module SearchFlip
           end
         end
 
-        aggregation.search_values = (aggregation.search_values || []) + other.search_values if other.search_values
         aggregation.must_values = (aggregation.must_values || []) + other.must_values if other.must_values
         aggregation.must_not_values = (aggregation.must_not_values || []) + other.must_not_values if other.must_not_values
-        aggregation.should_values = (aggregation.should_values || []) + other.should_values if other.should_values
         aggregation.filter_values = (aggregation.filter_values || []) + other.filter_values if other.filter_values
 
         aggregation.aggregation_values = (aggregation.aggregation_values || {}).merge(other.aggregation_values) if other.aggregation_values
@@ -89,7 +81,7 @@ module SearchFlip
       target.respond_to?(name, *args)
     end
 
-    ruby2_keywords def method_missing(name, *args, &block)
+    def method_missing(name, *args, &block)
       if target.respond_to?(name)
         merge(target.send(name, *args, &block))
       else
@@ -108,4 +100,3 @@ module SearchFlip
     end
   end
 end
-

data/lib/search_flip/bulk.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   # @api private
   #
@@ -87,7 +86,7 @@ module SearchFlip
     #
     # @see #index
 
-    ruby2_keywords def import(*args)
+    def import(*args)
       index(*args)
     end
 
@@ -181,4 +180,3 @@ module SearchFlip
     end
   end
 end
-

data/lib/search_flip/config.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   Config = {
     index_prefix: nil,
@@ -8,4 +7,3 @@ module SearchFlip
     auto_refresh: false
   }
 end
-

data/lib/search_flip/connection.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   class Connection
     attr_reader :base_url, :http_client, :bulk_limit, :bulk_max_mb
@@ -106,7 +105,10 @@ module SearchFlip
     # @return [Hash] The raw response
 
     def analyze(request, params = {})
-      http_client.headers(accept: "application/json").post("#{base_url}/_analyze", json: request, params: params).parse
+      http_client
+        .headers(accept: "application/json")
+        .post("#{base_url}/_analyze", json: request, params: params)
+        .parse
     end
 
     # Fetches information about the specified index aliases. Raises
@@ -122,13 +124,10 @@ module SearchFlip
     # @return [Hash] The raw response
 
     def get_aliases(index_name: "*", alias_name: "*")
-      res =
-        http_client
-          .headers(accept: "application/json", content_type: "application/json")
-          .get("#{base_url}/#{index_name}/_alias/#{alias_name}")
-          .parse
-
-      Hashie::Mash.new(res)
+      http_client
+        .headers(accept: "application/json", content_type: "application/json")
+        .get("#{base_url}/#{index_name}/_alias/#{alias_name}")
+        .parse
     end
 
     # Returns whether or not the associated Elasticsearch alias already
@@ -159,10 +158,10 @@ module SearchFlip
     #
     # @return [Array] The raw response
 
-    def get_indices(name = "*")
+    def get_indices(name = "*", params: {})
       http_client
         .headers(accept: "application/json", content_type: "application/json")
-        .get("#{base_url}/_cat/indices/#{name}")
+        .get("#{base_url}/_cat/indices/#{name}", params: params)
         .parse
     end
 
@@ -210,6 +209,32 @@ module SearchFlip
       true
     end
 
+    # Freezes the specified index within Elasticsearch. Raises
+    # SearchFlip::ResponseError in case any errors occur
+    #
+    # @param index_name [String] The index name
+    #
+    # @return [Boolean] Returns true or raises SearchFlip::ResponseError
+
+    def freeze_index(index_name)
+      http_client.post("#{index_url(index_name)}/_freeze")
+
+      true
+    end
+
+    # Unfreezes the specified index within Elasticsearch. Raises
+    # SearchFlip::ResponseError in case any errors occur
+    #
+    # @param index_name [String] The index name
+    #
+    # @return [Boolean] Returns true or raises SearchFlip::ResponseError
+
+    def unfreeze_index(index_name)
+      http_client.post("#{index_url(index_name)}/_unfreeze")
+
+      true
+    end
+
     # Updates the index settings within Elasticsearch according to the index
     # settings specified. Raises SearchFlip::ResponseError in case any
     # errors occur.
@@ -234,7 +259,10 @@ module SearchFlip
     # @return [Hash] The index settings
 
     def get_index_settings(index_name)
-      http_client.headers(accept: "application/json").get("#{index_url(index_name)}/_settings").parse
+      http_client
+        .headers(accept: "application/json")
+        .get("#{index_url(index_name)}/_settings")
+        .parse
     end
 
     # Sends a refresh request to Elasticsearch. Raises
@@ -338,4 +366,3 @@ module SearchFlip
     end
   end
 end
-