search_flip 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4e3ca349bd68555b2826d84c17b192335752947babe02ee51c5501cb04f79ca
-  data.tar.gz: e95021068918513669da2730d613157ad7151995c4a25f532f4274c3a848710f
+  metadata.gz: 021f5dd6d172381d777444631e96f2ebff0759b002f38b9ca555f844184d5dd9
+  data.tar.gz: ded7bbcab491ca187a68214377aa1f6ab2e3774739224744181aca16cf81e504
 SHA512:
-  metadata.gz: dcb46f99778d2243e6fb4187f85eb9a1db9aedc25a5f2b8287c3cdb8dcd259253bc3430e1e36521ea5794a2a9188f91473ae8d8572edc8c775ac0d234ac2e284
-  data.tar.gz: 1dbb3ba32c9c2a16f1c2b30aba7257dffc39b708f3e68ec8552c6d6d8ac6a751027a2899a3865051f7d1fdd7a6acd7a1f456eba552c7b50f4c2956292f41d413
+  metadata.gz: adc9acf973b399aa0595bdc42705516f9a13cb4cfbd18b5ee5db613d8c91261c3bba80834848b8079c4569431dfcbcff0368787b5edeb42f517e864721a54bef
+  data.tar.gz: 0b8769e3c59d1953036b2fc1618cfbd15db7bc4d19beef0a71e24aeb82830b499eff820e061b397ee20c15d4942941df69cc4dff2b20e4b35119193e78af74b7

data/.github/workflows/test.yml

@@ -0,0 +1,35 @@
+on: push
+name: test
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        elasticsearch:
+        - plainpicture/elasticsearch:2.4.1_delete-by-query
+        - elasticsearch:5.4
+        - docker.elastic.co/elasticsearch/elasticsearch:6.7.0
+        - docker.elastic.co/elasticsearch/elasticsearch:7.0.0
+        - docker.elastic.co/elasticsearch/elasticsearch:7.11.2
+        ruby:
+        - 2.5
+        - 2.6
+        - 2.7
+    services:
+      elasticsearch:
+        image: ${{ matrix.elasticsearch }}
+        env:
+          discovery.type: single-node
+        ports:
+          - 9200:9200
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - run: gem install bundler
+    - run: bundle
+    - run: sleep 10
+    - run: bundle exec rspec
+    - run: bundle exec rubocop

data/.rubocop.yml

@@ -1,5 +1,16 @@
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+
+Layout/EmptyLineBetweenDefs:
+  EmptyLineBetweenClassDefs: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Style/ExplicitBlockArgument:
+  Enabled: false
 
 Style/HashTransformValues:
   Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,29 @@
 
 # CHANGELOG
 
+## v3.3.0
+
+* Update httprb
+* Changed oj default options
+* Allow to set oj json options
+
+## v3.2.1
+
+* Fix `refresh` having a empty body breaking in elasticsearch 7.11
+
+## v3.2.0
+
+* Fix `index_scope` not being passed in `each_record` without block
+* Added `SearchFlip::Criteria#match_none`
+
+## v3.1.2
+
+* Fix ignored false value for source when merging criterias
+
+## v3.1.1
+
+* Make `SearchFlip::Result.from_hit` work with the `_source` being disabled
+
 ## v3.1.0
 
 * Added plugin support in `SearchFlip::HTTPClient`

data/README.md

@@ -3,7 +3,7 @@
 
 **Full-Featured Elasticsearch Ruby Client with a Chainable DSL**
 
-[![Build Status](https://secure.travis-ci.org/mrkamel/search_flip.svg?branch=master)](http://travis-ci.org/mrkamel/search_flip)
+[![Build](https://github.com/mrkamel/search_flip/workflows/test/badge.svg)](https://github.com/mrkamel/search_flip/actions?query=workflow%3Atest+branch%3Amaster)
 [![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
@@ -51,8 +51,7 @@ CommentIndex.search("hello world").where(available: true).sort(id: "desc").aggre
 
 ```
 
-Finally, SearchFlip comes with a minimal set of dependencies (http-rb, hashie
-and oj only).
+Finally, SearchFlip comes with a minimal set of dependencies.
 
 ## Reference Docs
 
@@ -419,6 +418,14 @@ Simply matches all documents:
 CommentIndex.match_all
 ```
 
+* `match_none`
+
+Simply matches none documents at all:
+
+```ruby
+CommentIndex.match_none
+```
+
 * `all`
 
 Simply returns the criteria as is or an empty criteria when called on the index
@@ -875,57 +882,52 @@ Thus, if your ORM supports `.find_each`, `#id` and `#where` you are already
 good to go. Otherwise, simply add your custom implementation of those methods
 that work with whatever ORM you use.
 
-## Date and Timestamps in JSON
-
-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).
+## JSON
 
-However, `JSON.generate` in ruby by default outputs something like:
+SearchFlip is using the [Oj gem](https://github.com/ohler55/oj) to generate
+JSON. More concretely, SearchFlip is using:
 
 ```ruby
-JSON.generate(time: Time.now.utc)
-# => "{\"time\":\"2018-02-22 18:19:33 UTC\"}"
+Oj.dump({ key: "value" }, mode: :custom, use_to_json: true, time_format: :xmlschema, bigdecimal_as_decimal: false)
 ```
 
-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:
+The `use_to_json` option is used for maximum compatibility, most importantly
+when using rails `ActiveSupport::TimeWithZone` timestamps, which `oj` can not
+serialize natively. However, `use_to_json` adds performance overhead. You can
+change the json options via:
 
 ```ruby
-Time.now.utc.to_json
-=> "\"2018-02-22T18:18:22.088Z\""
-
-JSON.generate(time: Time.now.utc)
-=> "{\"time\":\"2018-02-22 18:18:59 UTC\"}"
+SearchFlip::Config[:json_options] = {
+  mode: :custom,
+  use_to_json: false,
+  time_format: :xmlschema,
+  bigdecimal_as_decimal: false
+}
 ```
 
-SearchFlip is using the [Oj gem](https://github.com/ohler55/oj) to generate
-JSON. More concretely, SearchFlip is using:
+However, you then have to convert timestamps manually for indexation via e.g.:
 
 ```ruby
-Oj.dump({ key: "value" }, mode: :custom, use_to_json: true)
-```
+class MyIndex
+  # ...
 
-This mitigates the issues if you're on Rails:
+  def self.serialize(model)
+    {
+      # ...
 
-```ruby
-Oj.dump(Time.now, mode: :custom, use_to_json: true)
-# => "\"2018-02-22T18:21:21.064Z\""
+      created_at: model.created_at.to_time
+    }
+  end
+end
 ```
 
-However, if you're not on Rails, you need to add `#to_json` methods to `Time`,
-`Date` and `DateTime` to get proper serialization. You can either add them on
-your own, via other libraries or by simply using:
-
-```ruby
-require "search_flip/to_json"
-```
+Please check out the oj docs for more details.
 
 ## Feature Support
 
 * for Elasticsearch 2.x, the delete-by-query plugin is required to delete
   records via queries
+* `#match_none` is only available with Elasticsearch >= 5
 * `#track_total_hits` is only available with Elasticsearch >= 7
 
 ## Keeping your Models and Indices in Sync
@@ -949,6 +951,10 @@ It uses `after_commit` (if applicable, `after_save`, `after_destroy` and
 `after_touch` otherwise) hooks to synchronously update the index when your
 model changes.
 
+## Semantic Versioning
+
+SearchFlip is using Semantic Versioning: [SemVer](http://semver.org/)
+
 ## Links
 
 * Elasticsearch: [https://www.elastic.co/](https://www.elastic.co/)
@@ -980,5 +986,4 @@ $ rspec
 
 That's it.
 
-
 [Bulk API]: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html

data/lib/search_flip.rb

@@ -3,6 +3,7 @@ require "forwardable"
 require "http"
 require "hashie"
 require "thread"
+require "json"
 require "oj"
 require "set"
 
@@ -39,6 +40,8 @@ module SearchFlip
     attr_reader :code, :body
 
     def initialize(code:, body:)
+      super
+
       @code = code
       @body = body
     end

data/lib/search_flip/aggregation.rb

@@ -40,7 +40,7 @@ module SearchFlip
         else
           filters = (filter_values || []) + (must_not_values || []).map { |must_not_value| { not: must_not_value } }
           queries = must_values ? { must: must_values } : {}
-          filters_and_queries = filters + (queries.size > 0 ? [bool: queries] : [])
+          filters_and_queries = filters + (queries.size > 0 ? [{ bool: queries }] : [])
 
           res[:filter] = filters_and_queries.size > 1 ? { and: filters_and_queries } : filters_and_queries.first
         end
@@ -101,7 +101,7 @@ module SearchFlip
     end
 
     def respond_to_missing?(name, *args)
-      target.respond_to?(name, *args)
+      target.respond_to?(name, *args) || super
     end
 
     def method_missing(name, *args, &block)

data/lib/search_flip/bulk.rb

@@ -143,7 +143,7 @@ module SearchFlip
 
       return if options[:raise] == false
 
-      parsed_response = response.parse
+      parsed_response = SearchFlip::JSON.parse(response.to_s)
 
       return unless parsed_response["errors"]
 

data/lib/search_flip/config.rb

@@ -5,6 +5,12 @@ module SearchFlip
     bulk_limit: 1_000,
     bulk_max_mb: 100,
     auto_refresh: false,
-    instrumenter: NullInstrumenter.new
+    instrumenter: NullInstrumenter.new,
+    json_options: {
+      mode: :custom,
+      use_to_json: true,
+      time_format: :xmlschema,
+      bigdecimal_as_decimal: false
+    }
   }
 end

data/lib/search_flip/connection.rb

@@ -28,7 +28,11 @@ module SearchFlip
 
     def version
       @version_mutex.synchronize do
-        @version ||= http_client.headers(accept: "application/json").get("#{base_url}/").parse["version"]["number"]
+        @version ||= begin
+          response = http_client.headers(accept: "application/json").get("#{base_url}/")
+
+          SearchFlip::JSON.parse(response.to_s)["version"]["number"]
+        end
       end
     end
 
@@ -40,7 +44,9 @@ module SearchFlip
     # @return [Hash] The raw response
 
     def cluster_health
-      http_client.headers(accept: "application/json").get("#{base_url}/_cluster/health").parse
+      response = http_client.headers(accept: "application/json").get("#{base_url}/_cluster/health")
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     # Uses the Elasticsearch Multi Search API to execute multiple search requests
@@ -71,7 +77,7 @@ module SearchFlip
           .headers(accept: "application/json", content_type: "application/x-ndjson")
           .post("#{base_url}/_msearch", body: payload)
 
-      raw_response.parse["responses"].map.with_index do |response, index|
+      SearchFlip::JSON.parse(raw_response.to_s)["responses"].map.with_index do |response, index|
         SearchFlip::Response.new(criterias[index], response)
       end
     end
@@ -90,10 +96,11 @@ module SearchFlip
     # @return [Hash] The raw response
 
     def update_aliases(payload)
-      http_client
+      response = http_client
         .headers(accept: "application/json", content_type: "application/json")
         .post("#{base_url}/_aliases", body: SearchFlip::JSON.generate(payload))
-        .parse
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     # Sends an analyze request to Elasticsearch. Raises
@@ -105,10 +112,11 @@ module SearchFlip
     # @return [Hash] The raw response
 
     def analyze(request, params = {})
-      http_client
+      response = http_client
         .headers(accept: "application/json")
         .post("#{base_url}/_analyze", json: request, params: params)
-        .parse
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     # Fetches information about the specified index aliases. Raises
@@ -124,10 +132,11 @@ module SearchFlip
     # @return [Hash] The raw response
 
     def get_aliases(index_name: "*", alias_name: "*")
-      http_client
+      response = http_client
         .headers(accept: "application/json", content_type: "application/json")
         .get("#{base_url}/#{index_name}/_alias/#{alias_name}")
-        .parse
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     # Returns whether or not the associated Elasticsearch alias already
@@ -159,10 +168,11 @@ module SearchFlip
     # @return [Array] The raw response
 
     def get_indices(name = "*", params: {})
-      http_client
+      response = http_client
         .headers(accept: "application/json", content_type: "application/json")
         .get("#{base_url}/_cat/indices/#{name}", params: params)
-        .parse
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     alias_method :cat_indices, :get_indices
@@ -259,10 +269,11 @@ module SearchFlip
     # @return [Hash] The index settings
 
     def get_index_settings(index_name)
-      http_client
+      response = http_client
         .headers(accept: "application/json")
         .get("#{index_url(index_name)}/_settings")
-        .parse
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     # Sends a refresh request to Elasticsearch. Raises
@@ -272,7 +283,7 @@ module SearchFlip
     # @return [Boolean] Returns true or raises SearchFlip::ResponseError
 
     def refresh(index_names = nil)
-      http_client.post("#{index_names ? index_url(Array(index_names).join(",")) : base_url}/_refresh", json: {})
+      http_client.post("#{index_names ? index_url(Array(index_names).join(",")) : base_url}/_refresh")
 
       true
     end
@@ -310,7 +321,9 @@ module SearchFlip
       url = type_name ? type_url(index_name, type_name) : index_url(index_name)
       params = type_name && version.to_f >= 6.7 ? { include_type_name: true } : {}
 
-      http_client.headers(accept: "application/json").get("#{url}/_mapping", params: params).parse
+      response = http_client.headers(accept: "application/json").get("#{url}/_mapping", params: params)
+
+      SearchFlip::JSON.parse(response.to_s)
     end
 
     # Deletes the specified index from Elasticsearch. Raises

data/lib/search_flip/criteria.rb

@@ -44,35 +44,25 @@ module SearchFlip
       other = other.criteria
 
       fresh.tap do |criteria|
-        criteria.profile_value = other.profile_value unless other.profile_value.nil?
-        criteria.failsafe_value = other.failsafe_value unless other.failsafe_value.nil?
-        criteria.terminate_after_value = other.terminate_after_value unless other.terminate_after_value.nil?
-        criteria.timeout_value = other.timeout_value unless other.timeout_value.nil?
-        criteria.offset_value = other.offset_value if other.offset_value
-        criteria.limit_value = other.limit_value if other.limit_value
-        criteria.scroll_args = other.scroll_args if other.scroll_args
-        criteria.source_value = other.source_value if other.source_value
-        criteria.preference_value = other.preference_value if other.preference_value
-        criteria.search_type_value = other.search_type_value if other.search_type_value
-        criteria.routing_value = other.routing_value if other.routing_value
-        criteria.track_total_hits_value = other.track_total_hits_value unless other.track_total_hits_value.nil?
-        criteria.explain_value = other.explain_value unless other.explain_value.nil?
-
-        criteria.sort_values = (criteria.sort_values || []) + other.sort_values if other.sort_values
-        criteria.includes_values = (criteria.includes_values || []) + other.includes_values if other.includes_values
-        criteria.preload_values = (criteria.preload_values || []) + other.preload_values if other.preload_values
-        criteria.eager_load_values = (criteria.eager_load_values || []) + other.eager_load_values if other.eager_load_values
-        criteria.must_values = (criteria.must_values || []) + other.must_values if other.must_values
-        criteria.must_not_values = (criteria.must_not_values || []) + other.must_not_values if other.must_not_values
-        criteria.filter_values = (criteria.filter_values || []) + other.filter_values if other.filter_values
-        criteria.post_must_values = (criteria.post_must_values || []) + other.post_must_values if other.post_must_values
-        criteria.post_must_not_values = (criteria.post_must_not_values || []) + other.post_must_not_values if other.post_must_not_values
-        criteria.post_filter_values = (criteria.post_filter_values || []) + other.post_filter_values if other.post_filter_values
-
-        criteria.highlight_values = (criteria.highlight_values || {}).merge(other.highlight_values) if other.highlight_values
-        criteria.suggest_values = (criteria.suggest_values || {}).merge(other.suggest_values) if other.suggest_values
-        criteria.custom_value = (criteria.custom_value || {}).merge(other.custom_value) if other.custom_value
-        criteria.aggregation_values = (criteria.aggregation_values || {}).merge(other.aggregation_values) if other.aggregation_values
+        [
+          :profile_value, :failsafe_value, :terminate_after_value, :timeout_value, :offset_value,
+          :limit_value, :scroll_args, :source_value, :preference_value, :search_type_value,
+          :routing_value, :track_total_hits_value, :explain_value
+        ].each do |name|
+          criteria.send(:"#{name}=", other.send(name)) unless other.send(name).nil?
+        end
+
+        [
+          :sort_values, :includes_values, :preload_values, :eager_load_values, :must_values,
+          :must_not_values, :filter_values, :post_must_values, :post_must_not_values,
+          :post_filter_values
+        ].each do |name|
+          criteria.send(:"#{name}=", (criteria.send(name) || []) + other.send(name)) if other.send(name)
+        end
+
+        [:highlight_values, :suggest_values, :custom_value, :aggregation_values].each do |name|
+          criteria.send(:"#{name}=", (criteria.send(name) || {}).merge(other.send(name))) if other.send(name)
+        end
       end
     end
 
@@ -576,7 +566,7 @@ module SearchFlip
     end
 
     def respond_to_missing?(name, *args)
-      target.respond_to?(name, *args)
+      target.respond_to?(name, *args) || super
     end
 
     def method_missing(name, *args, &block)
@@ -618,7 +608,7 @@ module SearchFlip
           http_request.post("#{target.type_url}/_search", params: request_params, json: request)
         end
 
-      SearchFlip::Response.new(self, http_response.parse)
+      SearchFlip::Response.new(self, SearchFlip::JSON.parse(http_response.to_s))
     rescue SearchFlip::ConnectionError, SearchFlip::ResponseError => e
       raise e unless failsafe_value
 

data/lib/search_flip/filterable.rb

@@ -235,6 +235,22 @@ module SearchFlip
       filter(match_all: options)
     end
 
+    # Adds a match none filter to the criteria, which simply matches none
+    # documents at all. Check out the Elasticsearch docs for further details.
+    #
+    # @example Basic usage
+    #   CommentIndex.match_none
+    #
+    # @example Filter chaining
+    #   query = CommentIndex.search("...")
+    #   query = query.match_none unless current_user.admin?
+    #
+    # @return [SearchFlip::Criteria] A newly created extended criteria
+
+    def match_none
+      filter(match_none: {})
+    end
+
     # Adds an exists filter to the criteria, which selects all documents for
     # which the specified field has a non-null value.
     #

data/lib/search_flip/highlightable.rb

@@ -34,9 +34,10 @@ module SearchFlip
         criteria.highlight_values = (criteria.highlight_values || {}).merge(options)
 
         hash =
-          if fields.is_a?(Hash)
+          case fields
+          when Hash
             fields
-          elsif fields.is_a?(Array)
+          when Array
             fields.each_with_object({}) { |field, h| h[field] = {} }
           else
             { fields => {} }

data/lib/search_flip/index.rb

@@ -153,7 +153,7 @@ module SearchFlip
       #   scope to be applied to the scope
 
       def each_record(scope, index_scope: false)
-        return enum_for(:each_record, scope) unless block_given?
+        return enum_for(:each_record, scope, index_scope: index_scope) unless block_given?
 
         if scope.respond_to?(:find_each)
           (index_scope ? self.index_scope(scope) : scope).find_each do |record|
@@ -247,8 +247,8 @@ module SearchFlip
         SearchFlip::Criteria.new(target: self)
       end
 
-      def_delegators :criteria, :all, :profile, :where, :where_not, :filter, :range, :match_all, :exists,
-        :exists_not, :post_where, :post_where_not, :post_range, :post_exists, :post_exists_not,
+      def_delegators :criteria, :all, :profile, :where, :where_not, :filter, :range, :match_all, :match_none,
+        :exists, :exists_not, :post_where, :post_where_not, :post_range, :post_exists, :post_exists_not,
         :post_filter, :post_must, :post_must_not, :post_should, :aggregate, :scroll, :source,
         :includes, :eager_load, :preload, :sort, :resort, :order, :reorder, :offset, :limit, :paginate,
         :page, :per, :search, :highlight, :suggest, :custom, :find_in_batches, :find_results_in_batches,
@@ -455,7 +455,9 @@ module SearchFlip
       # @return [Hash] The specified document
 
       def get(id, params = {})
-        connection.http_client.headers(accept: "application/json").get("#{type_url}/#{id}", params: params).parse
+        response = connection.http_client.headers(accept: "application/json").get("#{type_url}/#{id}", params: params)
+
+        SearchFlip::JSON.parse(response.to_s)
       end
 
       # Retrieves the documents specified by ids from elasticsearch.
@@ -471,7 +473,9 @@ module SearchFlip
       # @return [Hash] The raw response
 
       def mget(request, params = {})
-        connection.http_client.headers(accept: "application/json").post("#{type_url}/_mget", json: request, params: params).parse
+        response = connection.http_client.headers(accept: "application/json").post("#{type_url}/_mget", json: request, params: params)
+
+        SearchFlip::JSON.parse(response.to_s)
       end
 
       # Sends an analyze request to Elasticsearch. Raises
@@ -483,7 +487,9 @@ module SearchFlip
       # @return [Hash] The raw response
 
       def analyze(request, params = {})
-        connection.http_client.headers(accept: "application/json").post("#{index_url}/_analyze", json: request, params: params).parse
+        response = connection.http_client.headers(accept: "application/json").post("#{index_url}/_analyze", json: request, params: params)
+
+        SearchFlip::JSON.parse(response.to_s)
       end
 
       # Sends a index refresh request to Elasticsearch. Raises

data/lib/search_flip/json.rb

@@ -1,16 +1,11 @@
 module SearchFlip
   class JSON
-    @default_options = {
-      mode: :custom,
-      use_to_json: true
-    }
-
-    def self.default_options
-      @default_options
+    def self.generate(obj)
+      Oj.dump(obj, SearchFlip::Config[:json_options])
     end
 
-    def self.generate(obj)
-      Oj.dump(obj, default_options)
+    def self.parse(json)
+      ::JSON.parse(json)
     end
   end
 end

data/lib/search_flip/result.rb

@@ -17,7 +17,7 @@ module SearchFlip
     #   SearchFlip::Result.from_hit(top_sales_hits.first)
 
     def self.from_hit(hit)
-      raw_result = hit["_source"].dup
+      raw_result = (hit["_source"] || {}).dup
 
       raw_result["_hit"] = hit.each_with_object({}) do |(key, value), hash|
         hash[key] = value if key != "_source"

data/lib/search_flip/to_json.rb

@@ -1,29 +1 @@
-require "time"
-require "date"
-require "json"
-
-class Time
-  def to_json(*args)
-    iso8601(6).to_json
-  end
-end
-
-class Date
-  def to_json(*args)
-    iso8601.to_json
-  end
-end
-
-class DateTime
-  def to_json(*args)
-    iso8601(6).to_json
-  end
-end
-
-if defined?(ActiveSupport)
-  class ActiveSupport::TimeWithZone
-    def to_json(*args)
-      iso8601(6).to_json
-    end
-  end
-end
+warn "[DEPRECATION] Using search_flip/to_json is not neccessary anymore"

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "3.1.0"
+  VERSION = "3.3.0"
 end

data/search_flip.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "hashie"
   spec.add_dependency "http"
+  spec.add_dependency "json"
   spec.add_dependency "oj"
   spec.add_dependency "ruby2_keywords"
 end

data/spec/search_flip/connection_spec.rb

@@ -36,10 +36,10 @@ RSpec.describe SearchFlip::Connection do
     it "changes the aliases" do
       connection = SearchFlip::Connection.new
 
-      connection.update_aliases(actions: [add: { index: "products", alias: "alias1" }])
+      connection.update_aliases(actions: [{ add: { index: "products", alias: "alias1" } }])
       expect(connection.get_aliases(alias_name: "alias1").keys).to eq(["products"])
 
-      connection.update_aliases(actions: [remove: { index: "products", alias: "alias1" }])
+      connection.update_aliases(actions: [{ remove: { index: "products", alias: "alias1" } }])
       expect(connection.alias_exists?("alias1")).to eq(false)
     end
   end
@@ -79,11 +79,11 @@ RSpec.describe SearchFlip::Connection do
 
         expect(connection.alias_exists?(:some_alias)).to eq(false)
 
-        connection.update_aliases(actions: [add: { index: "products", alias: "some_alias" }])
+        connection.update_aliases(actions: [{ add: { index: "products", alias: "some_alias" } }])
 
         expect(connection.alias_exists?(:some_alias)).to eq(true)
       ensure
-        connection.update_aliases(actions: [remove: { index: "products", alias: "some_alias" }])
+        connection.update_aliases(actions: [{ remove: { index: "products", alias: "some_alias" } }])
       end
     end
   end

data/spec/search_flip/criteria_spec.rb

@@ -110,6 +110,16 @@ RSpec.describe SearchFlip::Criteria do
 
           expect(criteria1.merge(criteria2).send(method)).to eq("value2")
         end
+
+        it "handles false values correctly" do
+          criteria1 = SearchFlip::Criteria.new(target: TestIndex)
+          criteria1.send("#{method}=", true)
+
+          criteria2 = SearchFlip::Criteria.new(target: TestIndex)
+          criteria2.send("#{method}=", false)
+
+          expect(criteria1.merge(criteria2).send(method)).to eq(false)
+        end
       end
     end
 
@@ -406,6 +416,18 @@ RSpec.describe SearchFlip::Criteria do
     end
   end
 
+  describe "#match_none" do
+    it "does not match any documents" do
+      if ProductIndex.connection.version.to_i >= 5
+        ProductIndex.import create(:product)
+
+        query = ProductIndex.match_none
+
+        expect(query.records).to eq([])
+      end
+    end
+  end
+
   describe "#exists" do
     it "sets up the constraints correctly and is chainable" do
       product1 = create(:product, title: "title1", description: "description1")

data/spec/search_flip/index_spec.rb

@@ -5,8 +5,8 @@ RSpec.describe SearchFlip::Index do
     subject { ProductIndex }
 
     methods = [
-      :all, :profile, :where, :where_not, :filter, :range, :match_all, :exists,
-      :exists_not, :post_where, :post_where_not, :post_filter, :post_must,
+      :all, :profile, :where, :where_not, :filter, :range, :match_all, :match_none,
+      :exists, :exists_not, :post_where, :post_where_not, :post_filter, :post_must,
       :post_must_not, :post_should, :post_range, :post_exists, :post_exists_not,
       :aggregate, :scroll, :source, :includes, :eager_load, :preload, :sort, :resort,
       :order, :reorder, :offset, :limit, :paginate, :page, :per, :search,
@@ -211,12 +211,18 @@ RSpec.describe SearchFlip::Index do
         mapping = { properties: { id: { type: "long" } } }
 
         allow(TestIndex).to receive(:mapping).and_return(mapping)
-        allow(TestIndex.connection).to receive(:update_mapping).and_call_original
+        allow(TestIndex.connection).to receive(:update_mapping)
 
         TestIndex.update_mapping
 
         expect(TestIndex.connection).to have_received(:update_mapping).with("test", { "test" => mapping }, type_name: "test")
       end
+
+      it "updates the mapping" do
+        TestIndex.create_index
+
+        expect(TestIndex.update_mapping).to eq(true)
+      end
     end
   end
 
@@ -258,12 +264,19 @@ RSpec.describe SearchFlip::Index do
         TestIndex.create_index
         TestIndex.update_mapping
 
-        allow(TestIndex.connection).to receive(:get_mapping).and_call_original
+        allow(TestIndex.connection).to receive(:get_mapping)
 
         TestIndex.get_mapping
 
         expect(TestIndex.connection).to have_received(:get_mapping).with("test", type_name: "test")
       end
+
+      it "returns the mapping" do
+        TestIndex.create_index
+        TestIndex.update_mapping
+
+        expect(TestIndex.get_mapping).to be_present
+      end
     end
   end
 

data/spec/search_flip/json_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path("../spec_helper", __dir__)
+
+RSpec.describe SearchFlip::JSON do
+  describe ".generate" do
+    it "encodes timestamps correctly" do
+      Timecop.freeze "2020-06-01 12:00:00 UTC" do
+        expect(described_class.generate(timestamp: Time.now.utc)).to eq('{"timestamp":"2020-06-01T12:00:00.000Z"}')
+      end
+    end
+
+    it "encodes bigdecimals as string" do
+      expect(described_class.generate(value: BigDecimal(1))).to eq('{"value":"1.0"}')
+    end
+
+    it "delegates to Oj" do
+      allow(Oj).to receive(:dump)
+
+      payload = { key: "value" }
+
+      described_class.generate(payload)
+
+      expect(Oj).to have_received(:dump).with(payload, mode: :custom, use_to_json: true, time_format: :xmlschema, bigdecimal_as_decimal: false)
+    end
+
+    it "generates json" do
+      expect(described_class.generate(key: "value")).to eq('{"key":"value"}')
+    end
+  end
+
+  describe ".parse" do
+    it "returns the parsed json payload" do
+      expect(described_class.parse('{"key":"value"}')).to eq("key" => "value")
+    end
+
+    it "delegates to JSON" do
+      allow(JSON).to receive(:parse)
+
+      payload = '{"key":"value"}'
+
+      described_class.parse(payload)
+
+      expect(JSON).to have_received(:parse).with(payload)
+    end
+  end
+end

data/spec/search_flip/null_instrumenter_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe SearchFlip::NullInstrumenter do
     it "calls start" do
       allow(subject).to receive(:start)
 
-      subject.instrument("name", { key: "value" }) {}
+      subject.instrument("name", { key: "value" }) { true }
 
       expect(subject).to have_received(:start)
     end
@@ -15,7 +15,7 @@ RSpec.describe SearchFlip::NullInstrumenter do
     it "calls finish" do
       allow(subject).to receive(:finish)
 
-      subject.instrument("name", { key: "value" }) {}
+      subject.instrument("name", { key: "value" }) { true }
 
       expect(subject).to have_received(:finish)
     end

data/spec/search_flip/result_spec.rb

@@ -13,5 +13,11 @@ RSpec.describe SearchFlip::Result do
 
       expect(result.key1[0].key2).to eq("value")
     end
+
+    it "works with the _source being disabled" do
+      result = SearchFlip::Result.from_hit("_id" => 1)
+
+      expect(result._hit._id).to eq(1)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -213,9 +227,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -259,11 +273,11 @@ files:
 - spec/search_flip/criteria_spec.rb
 - spec/search_flip/http_client_spec.rb
 - spec/search_flip/index_spec.rb
+- spec/search_flip/json_spec.rb
 - spec/search_flip/model_spec.rb
 - spec/search_flip/null_instrumenter_spec.rb
 - spec/search_flip/response_spec.rb
 - spec/search_flip/result_spec.rb
-- spec/search_flip/to_json_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mrkamel/search_flip
 licenses:
@@ -287,7 +301,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Full-Featured Elasticsearch Ruby Client with a Chainable DSL
@@ -300,9 +314,9 @@ test_files:
 - spec/search_flip/criteria_spec.rb
 - spec/search_flip/http_client_spec.rb
 - spec/search_flip/index_spec.rb
+- spec/search_flip/json_spec.rb
 - spec/search_flip/model_spec.rb
 - spec/search_flip/null_instrumenter_spec.rb
 - spec/search_flip/response_spec.rb
 - spec/search_flip/result_spec.rb
-- spec/search_flip/to_json_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,20 +0,0 @@
-sudo: false
-language: ruby
-env:
-  - 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
-  - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:7.0.0
-  - ES_IMAGE=docker.elastic.co/elasticsearch/elasticsearch:7.6.0
-rvm:
-  - ruby-2.5.3
-  - ruby-2.6.2
-  - ruby-2.7.1
-before_install:
-  - docker-compose up -d
-  - sleep 10
-install:
-  - travis_retry bundle install
-script:
- - bundle exec rspec
- - bundle exec rubocop

data/spec/search_flip/to_json_spec.rb

@@ -1,28 +0,0 @@
-require File.expand_path("../spec_helper", __dir__)
-require "search_flip/to_json"
-
-RSpec.describe "to_json" do
-  it "uses the correct format for Time" do
-    Timecop.freeze Time.parse("2018-01-01 12:00:00 UTC") do
-      expect(Time.now.utc.to_json).to eq("\"2018-01-01T12:00:00.000000Z\"")
-    end
-  end
-
-  it "uses the correct format for Date" do
-    Timecop.freeze Time.parse("2018-01-01 12:00:00 UTC") do
-      expect(Date.today.to_json).to eq("\"2018-01-01\"")
-    end
-  end
-
-  it "uses the correct format for DateTime" do
-    Timecop.freeze Time.parse("2018-01-01 12:00:00 UTC") do
-      expect(Time.now.utc.to_json).to eq("\"2018-01-01T12:00:00.000000Z\"")
-    end
-  end
-
-  it "uses the correct format for TimeWithZone" do
-    Timecop.freeze Time.parse("2018-01-01 12:00:00 UTC") do
-      expect(Time.find_zone("UTC").now.to_json).to eq("\"2018-01-01T12:00:00.000000Z\"")
-    end
-  end
-end