esse 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dff3560f305debeee691263267e43df0e70a17591f6ecfc897025a5c07ada8a
-  data.tar.gz: a8ba452b0bfc81210f104293f852ecacaef585ea23b2e8f24177197fa2555e69
+  metadata.gz: '0785bd8298d822b9778cbbbd98e8ae6b97063d0c18e11da57266e6cb8129c08a'
+  data.tar.gz: ea927277c5d497bf37127f4c0467253d6163cbc2e011cee9af2095a38162e339
 SHA512:
-  metadata.gz: 73bfc1a130c18df947cd02120087eed2b571fa174b84009b687dc0e343697aec1a1a20ae00eb0fc8465a9ad603d95318c02d324b98fe811baddc0b08d3533e28
-  data.tar.gz: 160aaf9fdef9da05108c1e966cfc03a45f9357aeb4682d551458546f66dc067d0585e52f0836aa0b4ee8fb5d634d3b705bced6340e91a99013d571fcded5f574
+  metadata.gz: 11082f005792f640e9e731ae7b0709370b86c6d151773b8c514f9af87f764b0ba53dee2cf036c6f71168488993403d54b24e921ec75031a91c75f6580de239e8
+  data.tar.gz: 6f5d2ca3c8b9c2d2125560fcf9d1406210779743b28f0e58708e84dcd31ccad063d31b40f9ae9e5d4f1a6fdc8445e3897226db479fb5dfa96717adab09e2d0a9

data/lib/esse/document.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Esse
+  # @abstract
+  #
+  # A document is a class that represents a single JSON document to be indexed
+  class Document
+    def initialize(entry, **context)
+      @source = item
+      @context = context
+    end
+
+    # Returns the Elasticsearch `_id` for the document.
+    #
+    # @return [String, Number] The Elasticsearch `_id` for the document
+    # @abstract
+    def id
+      raise NotImplementedError
+    end
+
+    # Returns the Elasticsearch `_routing` for the item. Elasticsearch
+    # default if this value is not provided is to use the `_id`.
+    # Setting this value to `false` or `nil` will omit sending the
+    # meta-field with your requests and use default routing behaviour.
+    #
+    # @return [String, NilClass, Boolean] The Elasticsearch `_routing` for the document
+    # @abstract
+    def routing
+    end
+
+    def attributes
+      {}
+    end
+
+    def to_h
+      {
+        _id: id,
+      }.tap do |hash|
+        hash[:_routing] = routing if routing
+      end
+    end
+  end
+end

data/lib/esse/object_document_mapper.rb

@@ -92,5 +92,19 @@ module Esse
         block.call(entries, *args, **kwargs)
       end
     end
+
+    # Wrap collection data into serialized documents
+    #
+    # Example:
+    #    GeosIndex.documents(id: 1).first
+    #
+    # @return [Enumerator] All serialized entries
+    def documents(*args, **kargs)
+      Enumerator.new do |yielder|
+        each_serialized_batch(*args, **kargs) do |documents, *_inner_args, **_inner_kargs|
+          documents.each { |document| yielder.yield(document) }
+        end
+      end
+    end
   end
 end

data/lib/esse/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Esse
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esse
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Marcos G. Zimmermann
 autorequire: 
 bindir: exec
 cert_chain: []
-date: 2022-01-31 00:00:00.000000000 Z
+date: 2022-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -260,6 +260,7 @@ files:
 - lib/esse/cluster.rb
 - lib/esse/config.rb
 - lib/esse/core.rb
+- lib/esse/document.rb
 - lib/esse/errors.rb
 - lib/esse/events.rb
 - lib/esse/events/bus.rb