esse 0.0.3 → 0.1.2

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

@@ -7,26 +7,28 @@ 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
+        alias_method :import!, :import
 
         # Performs multiple indexing or delete operations in a single API call.
         # 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 [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)
+        # @option [String, nil] :suffix The index suffix. Defaults to the nil.
+        # @option [Array] :index list of serialized documents to be indexed(Optional)
+        # @option [Array] :delete list of serialized documents to be deleted(Optional)
+        # @option [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,14 +46,14 @@ module Esse
           return if body.empty?
 
           definition = {
-            index: index_name,
+            index: index_name(suffix: suffix),
             type: type_name,
             body: body,
           }.merge(options)
 
           client.bulk(definition)
         end
-        alias bulk! bulk
+        alias_method :bulk!, :bulk
 
         # Adds a JSON document to the specified index and makes it searchable. If the document
         # already exists, updates the document and increments its version.
@@ -59,32 +61,34 @@ module Esse
         #   UsersIndex::User.index(id: 1, body: { name: 'name' }) # { '_id' => 1, ...}
         #
         # @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)
+        # @option [String, Integer] :id The `_id` of the elasticsearch document
+        # @option [Hash] :body The JSON document that will be indexed (Required)
+        # @option [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),
+            index: index_name(suffix: suffix), type: type_name, id: id, body: body, **options
           )
         end
-        alias index! index
+        alias_method :index!, :index
 
         # Updates a document using the specified script.
         #
         #   UsersIndex::User.update!(id: 1, body: { doc: { ... } }) # { '_id' => 1, ...}
         #
         # @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
+        # @option [String, Integer] :id The `_id` of the elasticsearch document
+        # @option [Hash] :body the body of the request
+        # @option [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),
+            index: index_name(suffix: suffix), type: type_name, id: id, body: body, **options
           )
         end
 
@@ -93,15 +97,16 @@ module Esse
         #   UsersIndex::User.update(id: 1, body: { doc: { ... } }) # { '_id' => 1, ...}
         #
         # @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
-        # @return [Hash, false] the elasticsearch response hash, or false in case of failure
+        # @option [String, Integer] :id The `_id` of the elasticsearch document
+        # @option [Hash] :body the body of the request
+        # @option [String, nil] :suffix The index suffix. Defaults to the nil.
+        # @return [Hash] the elasticsearch response, or an hash with 'errors' as true 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
+          { 'errors' => true }
         end
 
         # Removes a JSON document from the specified index.
@@ -110,13 +115,14 @@ module Esse
         #   UsersIndex::User.delete!(id: 'missing') # raise Elasticsearch::Transport::Transport::Errors::NotFound
         #
         # @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
+        # @option [String, Integer] :id The `_id` of the elasticsearch document
+        # @option [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.
@@ -125,13 +131,14 @@ module Esse
         #   UsersIndex::User.delete(id: 'missing') # false
         #
         # @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
+        # @option [String, Integer] :id The `_id` of the elasticsearch document
+        # @option [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
@@ -142,12 +149,13 @@ module Esse
         #   UsersIndex::User.count(body: { ... }) # 32
         #
         # @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)
+        # @option [Hash] :body A query to restrict the results specified with the Query DSL (optional)
+        # @option [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
@@ -159,10 +167,11 @@ module Esse
         #   UsersIndex::User.exist?(id: 'missing') # false
         #
         # @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
+        # @option [String, Integer] :id The `_id` of the elasticsearch document
+        # @option [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.
@@ -171,13 +180,14 @@ module Esse
         #   UsersIndex::User.find!(id: 'missing') # raise Elasticsearch::Transport::Transport::Errors::NotFound
         #
         # @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
+        # @option [String, Integer] :id The `_id` of the elasticsearch document
+        # @option [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.
@@ -186,12 +196,13 @@ module Esse
         #   UsersIndex::User.find(id: 'missing') # nil
         #
         # @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
+        # @option [String, Integer] :id The `_id` of the elasticsearch document
+        # @option [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/cli/event_listener.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative '../primitives'
+
+module Esse
+  module CLI
+    module EventListener
+      extend Output
+
+      module_function
+
+      def [](event_name)
+        method_name = Hstring.new(event_name).underscore.to_sym
+        return unless respond_to?(method_name)
+
+        method(method_name)
+      end
+
+      def elasticsearch_create_index(event)
+        print_message '[%<runtime>s] Index %<name>s successfuly created',
+          name: colorize(event[:request][:index], :bold),
+          runtime: formatted_runtime(event[:runtime])
+        if (aliases = event.to_h.dig(:request, :body, :aliases)).is_a?(Hash)
+          print_message ' --> Aliases: %<aliases>s', aliases: aliases.keys.join(', ')
+        end
+      end
+
+      def elasticsearch_delete_index(event)
+        print_message '[%<runtime>s] Index %<name>s successfuly deleted',
+          name: colorize(event[:request][:index], :bold),
+          runtime: formatted_runtime(event[:runtime])
+      end
+
+      def elasticsearch_close(event)
+        print_message '[%<runtime>s] Index %<name>s successfuly closed',
+          name: colorize(event[:request][:index], :bold),
+          runtime: formatted_runtime(event[:runtime])
+      end
+
+      def elasticsearch_open(event)
+        print_message '[%<runtime>s] Index %<name>s successfuly opened',
+          name: colorize(event[:request][:index], :bold),
+          runtime: formatted_runtime(event[:runtime])
+      end
+
+      def elasticsearch_update_mapping(event)
+        if event[:request][:type]
+          print_message '[%<runtime>s] Index %<name>s mapping for type %<type>s successfuly updated',
+            name: colorize(event[:request][:index], :bold),
+            type: event[:request][:type],
+            runtime: formatted_runtime(event[:runtime])
+        else
+          print_message '[%<runtime>s] Index %<name>s successfuly updated mapping',
+            name: colorize(event[:request][:index], :bold),
+            runtime: formatted_runtime(event[:runtime])
+        end
+      end
+
+      def elasticsearch_update_settings(event)
+        print_message '[%<runtime>s] Index %<name>s successfuly updated settings',
+          name: colorize(event[:request][:index], :bold),
+          runtime: formatted_runtime(event[:runtime])
+      end
+
+      def elasticsearch_update_aliases(event)
+        actions = event[:request][:body][:actions]
+        removed = actions.select { |a| a.key?(:remove) }
+        added = actions.select { |a| a.key?(:add) }
+        print_message '[%<runtime>s] Successfuly updated aliases:',
+          runtime: formatted_runtime(event[:runtime])
+
+        removed.each do |action|
+          print_message '%<padding>s-> Index %<name>s removed from alias %<alias>s',
+            name: colorize(action[:remove][:index], :bold),
+            alias: colorize(action[:remove][:alias], :bold),
+            padding: runtime_padding(event[:runtime])
+        end
+        added.each do |action|
+          print_message '%<padding>s-> Index %<name>s added to alias %<alias>s',
+            name: colorize(action[:add][:index], :bold),
+            alias: colorize(action[:add][:alias], :bold),
+            padding: runtime_padding(event[:runtime])
+        end
+      end
+    end
+  end
+end

data/lib/esse/cli/generate.rb

@@ -7,7 +7,7 @@ require_relative 'base'
 module Esse
   module CLI
     class Generate < Base
-      NAMESPACE_PATTERN_RE = %r{\:|/|\\}i.freeze
+      NAMESPACE_PATTERN_RE = %r{:|/|\\}i.freeze
 
       def self.source_root
         File.dirname(__FILE__)
@@ -17,11 +17,12 @@ module Esse
       def index(name, *types)
         ns_path = name.split(NAMESPACE_PATTERN_RE).tap(&:pop)
         @index_name = Hstring.new(name.to_s).modulize.sub(/Index$/, '') + 'Index'
+        @index_name = Hstring.new(@index_name)
         @types = types.map { |type| Hstring.new(type) }
         @base_class = base_index_class(*ns_path)
 
         base_dir = Esse.config.indices_directory.join(*ns_path)
-        index_name = Hstring.new(@index_name).demodulize.underscore.to_s
+        index_name = @index_name.demodulize.underscore.to_s
         template(
           'templates/index.rb.erb',
           base_dir.join("#{index_name}.rb"),
@@ -29,13 +30,17 @@ module Esse
         @types.each do |type|
           @type = Hstring.new(type).underscore
           copy_file(
-            'templates/mappings.json',
+            'templates/type_mappings.json',
             base_dir.join(index_name, 'templates', "#{@type}_mapping.json"),
           )
           template(
-            'templates/serializer.rb.erb',
+            'templates/type_serializer.rb.erb',
             base_dir.join(index_name, 'serializers', "#{@type}_serializer.rb"),
           )
+          template(
+            'templates/type_collection.rb.erb',
+            base_dir.join(index_name, 'collections', "#{@type}_collection.rb"),
+          )
         end
       end
 

data/lib/esse/cli/index/base_operation.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Esse
+  module CLI
+    class Index::BaseOperation
+      include Output
+
+      def initialize(indices:, **options)
+        @indices = Array(indices)
+        @options = options
+      end
+
+      # @abstract
+      # @void
+      def run
+        raise NotImplementedError
+      end
+
+      private
+
+      def validate_indices_option!
+        if @indices.empty?
+          raise InvalidOption.new(<<~END)
+            You must specify at least one index class.
+
+            Example:
+              > esse index create CityIndex
+              > esse index create CityIndex, StateIndex
+          END
+        end
+      end
+
+      def indices
+        eager_load_indices!
+        @indices.map do |class_name|
+          const_exist = begin
+            Kernel.const_defined?(class_name)
+          rescue NameError
+            false
+          end
+
+          raise InvalidOption.new(<<~END, class_name: class_name) unless const_exist
+            Unrecognized index class: %<class_name>p. Are you sure you specified the correct index class?
+          END
+
+          klass = Kernel.const_get(class_name)
+          unless klass < Esse::Index
+            path = Esse.config.indices_directory.join(Hstring.new(class_name).underscore.to_s)
+            raise InvalidOption.new(<<~END, class_name: class_name, path: path)
+              %<class_name>s must be a subclass of Esse::Index.
+
+              Example:
+                # %<path>s.rb
+                class %<class_name>s < Esse::Index
+                  # the index definition goes here
+                end
+            END
+          end
+
+          klass
+        end
+      end
+
+      def eager_load_indices!
+        return false unless Esse.config.indices_directory.exist?
+
+        Esse.config.indices_directory.each_child do |path|
+          next unless path.extname == '.rb'
+
+          require(path.expand_path.to_s)
+        end
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_operation'
+
+module Esse
+  module CLI
+    class Index::Close < Index::BaseOperation
+      def run
+        validate_options!
+        indices.each do |index|
+          index.elasticsearch.close!(**options)
+        end
+      end
+
+      private
+
+      def options
+        @options.slice(*@options.keys - CLI_IGNORE_OPTS)
+      end
+
+      def validate_options!
+        validate_indices_option!
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_operation'
+
+module Esse
+  module CLI
+    class Index::Create < Index::BaseOperation
+      def run
+        validate_options!
+        indices.each do |index|
+          index.elasticsearch.create_index!(**options)
+        end
+      end
+
+      private
+
+      def options
+        @options.slice(*@options.keys - CLI_IGNORE_OPTS)
+      end
+
+      def validate_options!
+        validate_indices_option!
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_operation'
+
+module Esse
+  module CLI
+    class Index::Delete < Index::BaseOperation
+      def run
+        validate_options!
+        indices.each do |index|
+          index.elasticsearch.delete_index!(**options)
+        end
+      end
+
+      private
+
+      def options
+        @options.slice(*@options.keys - CLI_IGNORE_OPTS)
+      end
+
+      def validate_options!
+        validate_indices_option!
+      end
+    end
+  end
+end

data/lib/esse/cli/index/import.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_operation'
+
+module Esse
+  module CLI
+    class Index::Import < Index::BaseOperation
+      def run
+        validate_options!
+        indices.each do |index|
+          index.elasticsearch.import!(**options)
+        end
+      end
+
+      private
+
+      def options
+        @options.slice(*@options.keys - CLI_IGNORE_OPTS)
+      end
+
+      def validate_options!
+        validate_indices_option!
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_operation'
+
+module Esse
+  module CLI
+    class Index::Open < Index::BaseOperation
+      def run
+        validate_options!
+        indices.each do |index|
+          index.elasticsearch.open!(**options)
+        end
+      end
+
+      private
+
+      def options
+        @options.slice(*@options.keys - CLI_IGNORE_OPTS)
+      end
+
+      def validate_options!
+        validate_indices_option!
+      end
+    end
+  end
+end

data/lib/esse/cli/index/reset.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_operation'
+
+module Esse
+  module CLI
+    class Index::Reset < Index::BaseOperation
+      def run
+        validate_options!
+        indices.each do |index|
+          index.elasticsearch.reset_index!(**options)
+        end
+      end
+
+      private
+
+      def options
+        @options.slice(*@options.keys - CLI_IGNORE_OPTS)
+      end
+
+      def validate_options!
+        validate_indices_option!
+      end
+    end
+  end
+end

data/lib/esse/cli/index/update_aliases.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'base_operation'
+
+module Esse
+  module CLI
+    class Index::UpdateAliases < Index::BaseOperation
+      def run
+        validate_options!
+        indices.each do |index|
+          index.elasticsearch.update_aliases!(**options)
+        end
+      end
+
+      private
+
+      def options
+        @options.slice(*@options.keys - CLI_IGNORE_OPTS)
+      end
+
+      def validate_options!
+        validate_indices_option!
+
+        if @options[:suffix].nil?
+          raise InvalidOption.new(<<~END)
+            You must specify a suffix to update the aliases.
+          END
+        end
+      end
+    end
+  end
+end

data/lib/esse/cli/index/update_mapping.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'base_operation'
+
+module Esse
+  module CLI
+    class Index::UpdateMapping < Index::BaseOperation
+      def run
+        validate_options!
+        indices.each do |index|
+          if index.type_hash.any?
+            index.type_hash.each_value do |type|
+              # @idea Add update_mapping! to IndexType and use it here
+              index.elasticsearch.update_mapping!(type: type.type_name, **options)
+            end
+          else
+            index.elasticsearch.update_mapping!(**options)
+          end
+        end
+      end
+
+      private
+
+      def options
+        @options.slice(*@options.keys - CLI_IGNORE_OPTS)
+      end
+
+      def validate_options!
+        validate_indices_option!
+      end
+    end
+  end
+end