search_flip 2.3.2 → 3.0.0.beta

data/lib/search_flip/post_filterable.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   # The SearchFlip::PostFilterable mixin provides chainable methods like
   # #post_where, #post_exists, #post_range, etc to add and apply search
@@ -23,7 +22,7 @@ module SearchFlip
   module PostFilterable
     def self.included(base)
       base.class_eval do
-        attr_accessor :post_search_values, :post_must_values, :post_must_not_values, :post_should_values, :post_filter_values
+        attr_accessor :post_must_values, :post_must_not_values, :post_filter_values
       end
     end
 
@@ -42,13 +41,9 @@ module SearchFlip
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
     def post_search(q, options = {})
-      raise(SearchFlip::NotSupportedError) if target.connection.version.to_i < 2
+      return self if q.to_s.strip.length.zero?
 
-      fresh.tap do |criteria|
-        if q.to_s.strip.length > 0
-          criteria.post_search_values = (post_search_values || []) + [query_string: { query: q, default_operator: :AND }.merge(options)]
-        end
-      end
+      post_must(query_string: { query: q, default_operator: :AND }.merge(options))
     end
 
     # Adds post filters to your criteria for the supplied hash composed of
@@ -76,11 +71,13 @@ module SearchFlip
     def post_where(hash)
       hash.inject(fresh) do |memo, (key, value)|
         if value.is_a?(Array)
-          memo.post_filter terms: { key => value }
+          memo.post_filter(terms: { key => value })
         elsif value.is_a?(Range)
-          memo.post_filter range: { key => { gte: value.min, lte: value.max } }
+          memo.post_filter(range: { key => { gte: value.min, lte: value.max } })
+        elsif value.nil?
+          memo.post_must_not(exists: { field: key })
         else
-          memo.post_filter term: { key => value }
+          memo.post_filter(term: { key => value })
         end
       end
     end
@@ -109,11 +106,13 @@ module SearchFlip
     def post_where_not(hash)
       hash.inject(fresh) do |memo, (key, value)|
         if value.is_a?(Array)
-          memo.post_must_not terms: { key => value }
+          memo.post_must_not(terms: { key => value })
         elsif value.is_a?(Range)
-          memo.post_must_not range: { key => { gte: value.min, lte: value.max } }
+          memo.post_must_not(range: { key => { gte: value.min, lte: value.max } })
+        elsif value.nil?
+          memo.post_filter(exists: { field: key })
         else
-          memo.post_must_not term: { key => value }
+          memo.post_must_not(term: { key => value })
         end
       end
     end
@@ -132,9 +131,9 @@ module SearchFlip
     #
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
-    def post_filter(*args)
+    def post_filter(clause)
       fresh.tap do |criteria|
-        criteria.post_filter_values = (post_filter_values || []) + args
+        criteria.post_filter_values = (post_filter_values || []) + Helper.wrap_array(clause)
       end
     end
 
@@ -152,9 +151,9 @@ module SearchFlip
     #
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
-    def post_must(*args)
+    def post_must(clause)
       fresh.tap do |criteria|
-        criteria.post_must_values = (post_must_values || []) + args
+        criteria.post_must_values = (post_must_values || []) + Helper.wrap_array(clause)
       end
     end
 
@@ -172,30 +171,27 @@ module SearchFlip
     #
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
-    def post_must_not(*args)
+    def post_must_not(clause)
       fresh.tap do |criteria|
-        criteria.post_must_not_values = (post_must_not_values || []) + args
+        criteria.post_must_not_values = (post_must_not_values || []) + Helper.wrap_array(clause)
       end
     end
 
-    # Adds raw post should queries to the criteria.
+    # Adds a raw post should query to the criteria.
     #
     # @example Raw post term should query
     #   query = CommentIndex.aggregate("...")
-    #   query = query.post_should(term: { state: "new" })
+    #   query = query.post_should([
+    #     { term: { state: "new" } },
+    #     { term: { state: "approved" } }
+    #   ])
     #
-    # @example Raw post range should query
-    #   query = CommentIndex.aggregate("...")
-    #   query = query.post_should(range: { created_at: { gte: Time.parse("2016-01-01") }})
-    #
-    # @param args [Array, Hash] The raw should query arguments
+    # @param clauses [Array] The raw should query arguments
     #
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
-    def post_should(*args)
-      fresh.tap do |criteria|
-        criteria.post_should_values = (post_should_values || []) + args
-      end
+    def post_should(clause)
+      post_must(bool: { should: clause })
     end
 
     # Adds a post range filter to the criteria without being forced to specify
@@ -217,7 +213,7 @@ module SearchFlip
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
     def post_range(field, options = {})
-      post_filter range: { field => options }
+      post_filter(range: { field => options })
     end
 
     # Adds a post exists filter to the criteria, which selects all documents
@@ -232,10 +228,10 @@ module SearchFlip
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
     def post_exists(field)
-      post_filter exists: { field: field }
+      post_filter(exists: { field: field })
     end
 
-    # Adds a post exists not filter to the criteria, which selects all documents
+    # Adds a post exists not query to the criteria, which selects all documents
     # for which the specified field's value is null.
     #
     # @example
@@ -247,8 +243,7 @@ module SearchFlip
     # @return [SearchFlip::Criteria] A newly created extended criteria
 
     def post_exists_not(field)
-      post_must_not exists: { field: field }
+      post_must_not(exists: { field: field })
     end
   end
 end
-

data/lib/search_flip/response.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   # The SearchFlip::Response class wraps a raw SearchFlip response and
   # decorates it with methods for aggregations, hits, records, pagination, etc.
@@ -34,16 +33,16 @@ module SearchFlip
     # Returns the total number of results.
     #
     # @example
-    #   CommentIndex.search("hello world").total_entries
+    #   CommentIndex.search("hello world").total_count
     #   # => 13
     #
     # @return [Fixnum] The total number of results
 
-    def total_entries
+    def total_count
       hits["total"].is_a?(Hash) ? hits["total"]["value"] : hits["total"]
     end
 
-    alias_method :total_count, :total_entries
+    alias_method :total_entries, :total_count
 
     # Returns whether or not the current page is the first page.
     #
@@ -103,7 +102,7 @@ module SearchFlip
     # @return [Fixnum] The current page number
 
     def current_page
-      1 + (criteria.offset_value_with_default / criteria.limit_value_with_default.to_f).ceil
+      1 + (criteria.offset_value_with_default / criteria.limit_value_with_default)
     end
 
     # Returns the number of total pages for the current pagination settings, ie
@@ -116,7 +115,7 @@ module SearchFlip
     # @return [Fixnum] The total number of pages
 
     def total_pages
-      [(total_entries / criteria.limit_value_with_default.to_f).ceil, 1].max
+      [(total_count.to_f / criteria.limit_value_with_default).ceil, 1].max
     end
 
     # Returns the previous page number or nil if no previous page exists, ie if
@@ -324,4 +323,3 @@ module SearchFlip
     end
   end
 end
-

data/lib/search_flip/result.rb

@@ -1,4 +1,3 @@
-
 module SearchFlip
   # The SearchFlip::Result class basically is a hash wrapper that uses
   # Hashie::Mash to provide convenient method access to the hash attributes.
@@ -9,4 +8,3 @@ module SearchFlip
     end
   end
 end
-

data/lib/search_flip/to_json.rb

@@ -1,31 +1,29 @@
-
 require "time"
 require "date"
 require "json"
 
 class Time
-  def to_json
+  def to_json(*args)
     iso8601(6).to_json
   end
 end
 
 class Date
-  def to_json
+  def to_json(*args)
     iso8601.to_json
   end
 end
 
 class DateTime
-  def to_json
+  def to_json(*args)
     iso8601(6).to_json
   end
 end
 
 if defined?(ActiveSupport)
   class ActiveSupport::TimeWithZone
-    def to_json
+    def to_json(*args)
       iso8601(6).to_json
     end
   end
 end
-

data/lib/search_flip/version.rb

@@ -1,5 +1,3 @@
-
 module SearchFlip
-  VERSION = "2.3.2"
+  VERSION = "3.0.0.beta"
 end
-

data/lib/search_flip.rb

@@ -1,5 +1,3 @@
-
-require "ruby2_keywords"
 require "forwardable"
 require "http"
 require "hashie"
@@ -8,6 +6,7 @@ require "oj"
 require "set"
 
 require "search_flip/version"
+require "search_flip/helper"
 require "search_flip/exceptions"
 require "search_flip/json"
 require "search_flip/http_client"
@@ -41,4 +40,3 @@ module SearchFlip
     end
   end
 end
-

data/search_flip.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
@@ -9,12 +8,12 @@ Gem::Specification.new do |spec|
   spec.version       = SearchFlip::VERSION
   spec.authors       = ["Benjamin Vetter"]
   spec.email         = ["vetter@flakks.com"]
-  spec.description   = %q{Full-Featured Elasticsearch Ruby Client with a Chainable DSL}
-  spec.summary       = %q{Full-Featured Elasticsearch Ruby Client with a Chainable DSL}
+  spec.description   = "Full-Featured Elasticsearch Ruby Client with a Chainable DSL"
+  spec.summary       = "Full-Featured Elasticsearch Ruby Client with a Chainable DSL"
   spec.homepage      = "https://github.com/mrkamel/search_flip"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
@@ -30,11 +29,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "factory_bot"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "timecop"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "ruby2_keywords"
   spec.add_dependency "hashie"
   spec.add_dependency "http"
   spec.add_dependency "oj"

data/spec/delegate_matcher.rb

@@ -1,4 +1,3 @@
-
 RSpec::Matchers.define :delegate do |method|
   match do |delegator|
     @method = method
@@ -29,4 +28,3 @@ RSpec::Matchers.define :delegate do |method|
 
   chain(:to) { |to| @to = to }
 end
-

data/spec/search_flip/aggregation_spec.rb

@@ -1,4 +1,3 @@
-
 require File.expand_path("../spec_helper", __dir__)
 
 RSpec.describe SearchFlip::Aggregation do
@@ -287,8 +286,8 @@ RSpec.describe SearchFlip::Aggregation do
       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
       ]
 
@@ -309,7 +308,7 @@ RSpec.describe SearchFlip::Aggregation do
     end
 
     describe "array concatenations" do
-      methods = [:search_values, :must_values, :must_not_values, :should_values, :filter_values]
+      methods = [:must_values, :must_not_values, :filter_values]
 
       methods.each do |method|
         it "concatenates the values for #{method}" do

data/spec/search_flip/bulk_spec.rb

@@ -1,4 +1,3 @@
-
 require File.expand_path("../spec_helper", __dir__)
 
 RSpec.describe SearchFlip::Bulk do
@@ -75,34 +74,40 @@ RSpec.describe SearchFlip::Bulk do
       expect(&block).to raise_error(SearchFlip::ResponseError)
     end
 
-    it "handles overly long payloads" do
+    it "transmits up to bulk_max_mb only" do
       product = create(:product)
 
-      allow(product).to receive(:description).and_return("x" * 1024 * 1024 * 10)
+      allow(product).to receive(:description).and_return("x" * 1024 * 1024)
 
-      block = lambda do
-        ProductIndex.bulk bulk_max_mb: 1_000 do |bulk|
-          20.times do
-            bulk.index product.id, ProductIndex.serialize(product)
-          end
+      ProductIndex.bulk bulk_max_mb: 10 do |bulk|
+        allow(bulk).to receive(:upload).and_call_original
+
+        20.times do
+          bulk.index product.id, ProductIndex.serialize(product)
         end
-      end
 
-      if ProductIndex.connection.version.to_i <= 2
-        expect(&block).to raise_error(SearchFlip::ConnectionError)
-      else
-        expect(&block).to raise_error(SearchFlip::ResponseError)
+        expect(bulk).to have_received(:upload).exactly(2).times
       end
+    end
 
-      block = lambda do
-        ProductIndex.bulk bulk_max_mb: 100 do |bulk|
-          20.times do
-            bulk.index product.id, ProductIndex.serialize(product)
-          end
+    it "uploads a last time if there is data left within the output buffer" do
+      product = create(:product)
+
+      allow(product).to receive(:description).and_return("x" * 1024 * 1024)
+
+      bulk_upload = nil
+
+      ProductIndex.bulk bulk_max_mb: 5.5 do |bulk|
+        bulk_upload = bulk
+
+        allow(bulk).to receive(:upload).and_call_original
+
+        6.times do
+          bulk.index product.id, ProductIndex.serialize(product)
         end
       end
 
-      expect(&block).not_to raise_error
+      expect(bulk_upload).to have_received(:upload).exactly(2).times
     end
   end
 end

data/spec/search_flip/connection_spec.rb

@@ -1,4 +1,3 @@
-
 require File.expand_path("../spec_helper", __dir__)
 
 RSpec.describe SearchFlip::Connection do
@@ -96,6 +95,12 @@ RSpec.describe SearchFlip::Connection do
       expect(connection.get_indices.map { |index| index["index"] }.to_set).to eq(["comments", "products"].to_set)
       expect(connection.get_indices("com*").map { |index| index["index"] }).to eq(["comments"])
     end
+
+    it "accepts additional parameters" do
+      connection = SearchFlip::Connection.new
+
+      expect(connection.get_indices("comments", params: { h: "i" })).to eq([{ "i" => "comments" }])
+    end
   end
 
   describe "#create_index" do
@@ -114,13 +119,15 @@ RSpec.describe SearchFlip::Connection do
     end
 
     it "respects a payload" do
-      connection = SearchFlip::Connection.new
+      begin
+        connection = SearchFlip::Connection.new
 
-      connection.create_index("index_name", settings: { number_of_shards: 3 })
+        connection.create_index("index_name", settings: { number_of_shards: 3 })
 
-      expect(connection.get_index_settings("index_name")["index_name"]["settings"]["index"]["number_of_shards"]).to eq("3")
-    ensure
-      connection.delete_index("index_name") if connection.index_exists?("index_name")
+        expect(connection.get_index_settings("index_name")["index_name"]["settings"]["index"]["number_of_shards"]).to eq("3")
+      ensure
+        connection.delete_index("index_name") if connection.index_exists?("index_name")
+      end
     end
   end
 
@@ -159,6 +166,41 @@ RSpec.describe SearchFlip::Connection do
     end
   end
 
+  describe "#freeze_index" do
+    it "freezes the specified index" do
+      connection = SearchFlip::Connection.new
+
+      if connection.version.to_f >= 6.6
+        begin
+          connection.create_index("index_name")
+          connection.freeze_index("index_name")
+
+          expect(connection.get_indices("index_name", params: { h: "sth" }).first["sth"]).to eq("true")
+        ensure
+          connection.delete_index("index_name") if connection.index_exists?("index_name")
+        end
+      end
+    end
+  end
+
+  describe "#unfreeze_index" do
+    it "unfreezes the specified index" do
+      connection = SearchFlip::Connection.new
+
+      if connection.version.to_f >= 6.6
+        begin
+          connection.create_index("index_name")
+          connection.freeze_index("index_name")
+          connection.unfreeze_index("index_name")
+
+          expect(connection.get_indices("index_name", params: { h: "sth" }).first["sth"]).to eq("false")
+        ensure
+          connection.delete_index("index_name") if connection.index_exists?("index_name")
+        end
+      end
+    end
+  end
+
   describe ".analyze" do
     it "analyzes the provided request" do
       connection = SearchFlip::Connection.new
@@ -282,4 +324,3 @@ RSpec.describe SearchFlip::Connection do
     end
   end
 end
-