search_flip 4.0.0.beta5 → 4.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 938e1745f8cfe0173c76f26a4f15ab7e62781fd627dcccb2c2523db7f8ca51bf
-  data.tar.gz: 2a8980bc0de4db9cb081c5186ed94bbee489a470ea30992a9e8a9c248563d3e6
+  metadata.gz: cb9f652fcf2d89715a4ac400906e2b4702bae052b721f671e31caaceca01fd37
+  data.tar.gz: c1bca6110c7e40a223462f183021763ce3dc89f538e5d492099cee751988292d
 SHA512:
-  metadata.gz: 2d622f6d843b9975a66af4ee3d937f1eb60b255d6c5017479dae583543d8f4dbba9608209513da94ba95a3aa3323714a0c1a9b21e594f1f4a2be61844864da3c
-  data.tar.gz: b7835e3adfd35074111e481e3ba54272e59a764a5478c569bc516aa4a8455c939618347a194802a9d6030a91bc52430bf7fac72b00c3ebca1eb09cb13021f21a
+  metadata.gz: 79c607032410d675a0663b13a6af21a64501a587ec1c07852e92e459b4034043121187016aabdab3672e0013fd1b86731b2c3f3a0d4484f08d39134328e3adc3
+  data.tar.gz: a06b1866d3322185692cab6ddd2c8a9dd88bb7eb46b955a732bf6e70fae174dbbd4f658b51cddc051c8d512f5f48619147bd32620fa24623393338360d9ed4e6

data/README.md

@@ -882,6 +882,48 @@ 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.
 
+## JSON
+
+SearchFlip is using the [Oj gem](https://github.com/ohler55/oj) to generate
+and parse JSON. More concretely, SearchFlip is using:
+
+```ruby
+Oj.dump({ key: "value" }, mode: :custom, use_to_json: true, time_format: :xmlschema, bigdecimal_as_decimal: false)
+Oj.load('{"key":"value"}', mode: :custom, use_to_json: true, time_format: :xmlschema, bigdecimal_as_decimal: false)
+```
+
+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
+SearchFlip::Config[:json_options] = {
+  mode: :custom,
+  use_to_json: false,
+  time_format: :xmlschema,
+  bigdecimal_as_decimal: false
+}
+```
+
+However, you then have to convert timestamps manually for indexation via e.g.:
+
+```ruby
+class MyIndex
+  # ...
+
+  def self.serialize(model)
+    {
+      # ...
+
+      created_at: model.created_at.to_time
+    }
+  end
+end
+```
+
+Please check out the oj docs for more details.
+
 ## Feature Support
 
 * for Elasticsearch 2.x, the delete-by-query plugin is required to delete

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/json.rb

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

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "4.0.0.beta5"
+  VERSION = "4.0.0.beta6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta5
+  version: 4.0.0.beta6
 platform: ruby
 authors:
 - Benjamin Vetter