esse 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d7f91a4ecb008fe3d8849175cb6f1bb08605d56432b7bc7f52ca9df0c55e77e
-  data.tar.gz: a9b4143597ca2ca571360814b381e8398bd3ac8b45134fc5b3086dfc8a33f0a1
+  metadata.gz: a79fdcfdbdc2c217432f128fc93fa67f543c450d9e2cfa1d7f1d57b5242f1be4
+  data.tar.gz: ae620c10d8930fcf86e0323d375ed96effa4c77beeb8da13cd0be2738133bc3b
 SHA512:
-  metadata.gz: ef25dc5238beea72d67eeaf146dad16184cd8d78c76fc84516154e8ddd5cb93f2c5f1fd84574359147d6428dbdb1d25f037d0dce004f79e4e22cbbf1dcc2a30b
-  data.tar.gz: 6c5237fc9f5b59376ef6e948132c5a78200f4f849acab591ba603b3c5173d95c6179dfec3844331a6ba30f41ae519515b12c3f3396d80e4bff5dd3445525faad
+  metadata.gz: 406f2d91072eb6c8e7dca67072ff5954c3fad9d94efbb20582ecec81bbe4d2080bb6c0921d2b41702745214932d3d15879469061ddca8189913f333b4ee4bb6e
+  data.tar.gz: e5f4aecf985af27f3a80f47188a5fa9524a935c9a382da77673d7b3ebb9c71fab2543a19f10725372ca87d2088d25e17919e73f4152000d2dcfc9a23e729a2c3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    esse (0.0.2)
+    esse (0.0.4)
       elasticsearch
       multi_json
       thor (>= 0.19)

data/lib/esse/backend/index/aliases.rb

@@ -44,7 +44,7 @@ module Esse
               *indices.map do |index|
                 { remove: { index: index, alias: index_name } }
               end,
-              { add: {index: real_index_name(suffix), alias: index_name } }
+              { add: {index: build_real_index_name(suffix), alias: index_name } }
             ],
           }
           client.indices.update_aliases(options)

data/lib/esse/backend/index/close.rb

@@ -21,9 +21,7 @@ module Esse
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html
         def close!(suffix: index_version, **options)
-          name = suffix ? real_index_name(suffix) : index_name
-
-          client.indices.close(options.merge(index: name))
+          client.indices.close(options.merge(index: index_name(suffix: suffix)))
         end
 
         # Close an index (keep the data on disk, but deny operations with the index).

data/lib/esse/backend/index/create.rb

@@ -39,7 +39,7 @@ module Esse
         # @see http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/
         def create_index!(suffix: nil, **options)
           options = DEFAULT_OPTIONS.merge(options)
-          name = real_index_name(suffix)
+          name = build_real_index_name(suffix)
           definition = [settings_hash, mappings_hash].reduce(&:merge)
 
           if options[:alias] && name != index_name

data/lib/esse/backend/index/delete.rb

@@ -13,9 +13,7 @@ module Esse
         # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] when index does not exists
         # @return [Hash] elasticsearch response
         def delete_index!(suffix:)
-          name = suffix ? real_index_name(suffix) : index_name
-
-          client.indices.delete(index: name)
+          client.indices.delete(index: index_name(suffix: suffix))
         end
 
         # Deletes ES index

data/lib/esse/backend/index/existance.rb

@@ -12,8 +12,7 @@ module Esse
         # @option options [String, nil] :suffix The index suffix. Defaults to the index_version.
         #   Use nil if you want to check existence of the `index_name` index or alias.
         def exist?(suffix: index_version)
-          name = suffix ? real_index_name(suffix) : index_name
-          client.indices.exists(index: name)
+          client.indices.exists(index: index_name(suffix: suffix))
         end
       end
 

data/lib/esse/backend/index/open.rb

@@ -21,9 +21,7 @@ module Esse
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-open.html
         def open!(suffix: index_version, **options)
-          name = suffix ? real_index_name(suffix) : index_name
-
-          client.indices.open(options.merge(index: name))
+          client.indices.open(options.merge(index: index_name(suffix: suffix)))
         end
 
         # Open a previously closed index

data/lib/esse/backend/index/update.rb

@@ -27,9 +27,7 @@ module Esse
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping/
         def update_mapping!(suffix: index_version, **options)
-          name = suffix ? real_index_name(suffix) : index_name
-
-          client.indices.put_mapping(options.merge(index: name, body: mappings_hash.fetch(Esse::MAPPING_ROOT_KEY)))
+          client.indices.put_mapping(options.merge(index: index_name(suffix: suffix), body: mappings_hash.fetch(Esse::MAPPING_ROOT_KEY)))
         end
 
         # Create or update a mapping
@@ -78,13 +76,12 @@ module Esse
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/
         def update_settings!(suffix: index_version, **options)
-          name = suffix ? real_index_name(suffix) : index_name
           response = nil
 
           close!(suffix: suffix)
           begin
             body = settings_hash(cluster_settings: false).fetch(Esse::SETTING_ROOT_KEY)
-            response = client.indices.put_settings(options.merge(index: name, body: body))
+            response = client.indices.put_settings(options.merge(index: index_name(suffix: suffix), body: body))
           ensure
             open!(suffix: suffix)
           end

data/lib/esse/backend/index.rb

@@ -16,7 +16,7 @@ module Esse
 
       extend Forwardable
 
-      NAMING = %i[index_name index_version].freeze
+      NAMING = %i[index_version].freeze
       DEFINITION = %i[settings_hash mappings_hash].freeze
 
       def_delegators :@index, :type_hash, *(NAMING + DEFINITION)
@@ -27,9 +27,17 @@ module Esse
 
       protected
 
-      def real_index_name(suffix = nil)
+      def index_name(suffix: nil)
+        suffix = Hstring.new(suffix).underscore.presence
+        return @index.index_name unless suffix
+
+        [@index.index_name, suffix].join('_')
+      end
+
+      def build_real_index_name(suffix = nil)
         suffix = Hstring.new(suffix).underscore.presence || index_version || Esse.timestamp
-        [index_name, suffix].compact.join('_')
+
+        index_name(suffix: suffix)
       end
 
       def client

data/lib/esse/backend/index_type/documents.rb

@@ -7,11 +7,12 @@ module Esse
         # Resolve collection and index data
         #
         # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @option [String, nil] :suffix The index suffix. Defaults to the nil.
         # @option [Hash] :context The collection context. This value will be passed as argument to the collection
         #   May be SQL condition or any other filter you have defined on the collection.
-        def import(context: {}, **options)
+        def import(context: {}, suffix: nil, **options)
           each_serialized_batch(context || {}) do |batch|
-            bulk(index: batch, **options)
+            bulk(index: batch, suffix: suffix, **options)
           end
         end
         alias import! import
@@ -20,13 +21,14 @@ module Esse
         # This reduces overhead and can greatly increase indexing speed.
         #
         # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
+        # @param options [String, nil] :suffix The index suffix. Defaults to the nil.
         # @param options [Array] :index list of serialized documents to be indexed(Optional)
         # @param options [Array] :delete list of serialized documents to be deleted(Optional)
         # @param options [Array] :create list of serialized documents to be created(Optional)
         # @return [Hash, nil] the elasticsearch response or nil if there is no data.
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-bulk.html
-        def bulk(index: nil, delete: nil, create: nil, **options)
+        def bulk(index: nil, delete: nil, create: nil, suffix: nil, **options)
           body = []
           Array(index).each do |entry|
             id, data = Esse.doc_id!(entry)
@@ -44,7 +46,7 @@ module Esse
           return if body.empty?
 
           definition = {
-            index: index_name,
+            index: index_name(suffix: suffix),
             type: type_name,
             body: body,
           }.merge(options)
@@ -61,12 +63,13 @@ module Esse
         # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
         # @param options [String, Integer] :id The `_id` of the elasticsearch document
         # @param options [Hash] :body The JSON document that will be indexed (Required)
+        # @param options [String, nil] :suffix The index suffix. Defaults to the nil.
         # @return [Hash] the elasticsearch response Hash
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-index_.html
-        def index(id:, body:, **options)
+        def index(id:, body:, suffix: nil, **options)
           client.index(
-            options.merge(index: index_name, type: type_name, id: id, body: body),
+            options.merge(index: index_name(suffix: suffix), type: type_name, id: id, body: body),
           )
         end
         alias index! index
@@ -78,13 +81,14 @@ module Esse
         # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
         # @param options [String, Integer] :id The `_id` of the elasticsearch document
         # @param options [Hash] :body the body of the request
+        # @param options [String, nil] :suffix The index suffix. Defaults to the nil.
         # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] when the doc does not exist
         # @return [Hash] elasticsearch response hash
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-update.html
-        def update!(id:, body:, **options)
+        def update!(id:, body:, suffix: nil, **options)
           client.update(
-            options.merge(index: index_name, type: type_name, id: id, body: body),
+            options.merge(index: index_name(suffix: suffix), type: type_name, id: id, body: body),
           )
         end
 
@@ -95,11 +99,12 @@ module Esse
         # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
         # @param options [String, Integer] :id The `_id` of the elasticsearch document
         # @param options [Hash] :body the body of the request
+        # @param options [String, nil] :suffix The index suffix. Defaults to the nil.
         # @return [Hash, false] the elasticsearch response hash, or false in case of failure
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-update.html
-        def update(id:, body:, **options)
-          update!(id: id, body: body, **options)
+        def update(id:, body:, suffix: nil, **options)
+          update!(id: id, body: body, suffix: suffix, **options)
         rescue Elasticsearch::Transport::Transport::Errors::NotFound
           false
         end
@@ -111,12 +116,13 @@ module Esse
         #
         # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
         # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @param options [String, nil] :suffix The index suffix. Defaults to the nil.
         # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] when the doc does not exist
         # @return [Boolean] true when the operation is successfully completed
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-delete.html
-        def delete!(id:, **options)
-          client.delete(options.merge(index: index_name, type: type_name, id: id))
+        def delete!(id:, suffix: nil, **options)
+          client.delete(options.merge(index: index_name(suffix: suffix), type: type_name, id: id))
         end
 
         # Removes a JSON document from the specified index.
@@ -126,12 +132,13 @@ module Esse
         #
         # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
         # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @param options [String, nil] :suffix The index suffix. Defaults to the nil.
         # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] when the doc does not exist
         # @return [Boolean] true when the operation is successfully completed
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-delete.html
-        def delete(id:, **options)
-          delete!(id: id, **options)
+        def delete(id:, suffix: nil, **options)
+          delete!(id: id, suffix: suffix, **options)
         rescue Elasticsearch::Transport::Transport::Errors::NotFound
           false
         end
@@ -143,11 +150,12 @@ module Esse
         #
         # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
         # @param options [Hash] :body A query to restrict the results specified with the Query DSL (optional)
+        # @param options [String, nil] :suffix The index suffix. Defaults to the nil.
         # @return [Integer] amount of documents found
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-count.html
-        def count(**options)
-          response = client.count(options.merge(index: index_name, type: type_name))
+        def count(suffix: nil, **options)
+          response = client.count(options.merge(index: index_name(suffix: suffix), type: type_name))
           response['count']
         rescue Elasticsearch::Transport::Transport::Errors::NotFound
           0
@@ -160,9 +168,10 @@ module Esse
         #
         # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
         # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @param options [String, nil] :suffix The index suffix. Defaults to the nil.
         # @return [Boolean] true if the document exists
-        def exist?(id:, **options)
-          client.exists(options.merge(index: index_name, type: type_name, id: id))
+        def exist?(id:, suffix: nil, **options)
+          client.exists(options.merge(index: index_name(suffix: suffix), type: type_name, id: id))
         end
 
         # Retrieves the specified JSON document from an index.
@@ -172,12 +181,13 @@ module Esse
         #
         # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
         # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @param options [String, nil] :suffix The index suffix. Defaults to the nil.
         # @raise [Elasticsearch::Transport::Transport::Errors::NotFound] when the doc does not exist
         # @return [Hash] The elasticsearch document.
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-get.html
-        def find!(id:, **options)
-          client.get(options.merge(index: index_name, type: type_name, id: id))
+        def find!(id:, suffix: nil, **options)
+          client.get(options.merge(index: index_name(suffix: suffix), type: type_name, id: id))
         end
 
         # Retrieves the specified JSON document from an index.
@@ -187,11 +197,12 @@ module Esse
         #
         # @param options [Hash] Hash of paramenters that will be passed along to elasticsearch request
         # @param options [String, Integer] :id The `_id` of the elasticsearch document
+        # @param options [String, nil] :suffix The index suffix. Defaults to the nil.
         # @return [Hash, nil] The elasticsearch document
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-get.html
-        def find(id:, **options)
-          find!(id: id, **options)
+        def find(id:, suffix: nil, **options)
+          find!(id: id, suffix: suffix, **options)
         rescue Elasticsearch::Transport::Transport::Errors::NotFound
           nil
         end

data/lib/esse/backend/index_type.rb

@@ -11,8 +11,6 @@ module Esse
 
       # Type delegators
       def_delegators :@index_type, :type_name, :each_serialized_batch, :serialize
-      # Index delegators
-      def_delegators :index_class, :index_name
 
       def initialize(type)
         @index_type = type
@@ -20,6 +18,13 @@ module Esse
 
       protected
 
+      def index_name(suffix: nil)
+        suffix = Hstring.new(suffix).underscore.presence
+        return index_class.index_name unless suffix
+
+        [index_class.index_name, suffix].join('_')
+      end
+
       def index_class
         @index_type.index
       end

data/lib/esse/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esse
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Marcos G. Zimmermann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-10 00:00:00.000000000 Z
+date: 2020-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch