esse 0.0.5 → 0.1.3

data/lib/esse/index.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'core'
+require_relative 'object_document_mapper'
 
 module Esse
   class Index
@@ -13,6 +13,7 @@ module Esse
     require_relative 'index/mappings'
     require_relative 'index/descendants'
     require_relative 'index/backend'
+    extend ObjectDocumentMapper
 
     @cluster_id = nil
 

data/lib/esse/index_mapping.rb

@@ -12,14 +12,14 @@ module Esse
 
     # This method will be overwrited when passing a block during the
     # mapping defination
-    def as_json
+    def to_h
       return @mappings unless @mappings.empty?
 
       from_template || @mappings
     end
 
     def body
-      as_json
+      to_h
     end
 
     def empty?

data/lib/esse/index_setting.rb

@@ -3,8 +3,12 @@
 module Esse
   # https://www.elastic.co/guide/en/elasticsearch/reference/1.7/indices.html
   class IndexSetting
-    def initialize(body: {}, paths: [], globals: {})
-      @globals = globals || {}
+    # @param [Hash] options
+    # @option options [Proc] :globals  A proc that will be called to load global settings
+    # @option options [Array] :paths   A list of paths to load settings from
+    # @option options [Hash]  :body    A hash of settings to override
+    def initialize(body: {}, paths: [], globals: nil)
+      @globals = globals || -> { {} }
       @paths = Array(paths)
       @settings = body
     end
@@ -19,14 +23,14 @@ module Esse
     #     end
     #   end
     #
-    def as_json
+    def to_h
       return @settings unless @settings.empty?
 
       from_template || @settings
     end
 
     def body
-      @globals.merge(as_json)
+      HashUtils.deep_merge(@globals.call, to_h)
     end
 
     protected

data/lib/esse/index_type/actions.rb

@@ -3,7 +3,8 @@
 module Esse
   class IndexType
     module ClassMethods
-      def action(name, options = {}, &block); end
+      def action(name, options = {}, &block)
+      end
     end
 
     extend ClassMethods

data/lib/esse/index_type/backend.rb

@@ -3,9 +3,10 @@
 module Esse
   class IndexType
     module ClassMethods
-      def backend
+      def elasticsearch
         Esse::Backend::IndexType.new(self)
       end
+      alias_method :backend, :elasticsearch
     end
 
     extend ClassMethods

data/lib/esse/index_type/mappings.rb

@@ -7,9 +7,9 @@ module Esse
       # This method is only used to define mapping
       def mappings(hash = {}, &block)
         @mapping = Esse::IndexMapping.new(body: hash, paths: template_dirs, filenames: mapping_filenames)
-        return unless block_given?
+        return unless block
 
-        @mapping.define_singleton_method(:as_json, &block)
+        @mapping.define_singleton_method(:to_h, &block)
       end
 
       # This is the actually content that will be passed through the ES api

data/lib/esse/index_type.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
+require_relative 'object_document_mapper'
+
 module Esse
+  # Type is actually deprecated. Elasticsearch today uses _doc instead of type
+  # And in upcoming release it will be totally removed.
+  # But I want to keep compatibility with old versions of es.
   class IndexType
     require_relative 'index_type/actions'
     require_relative 'index_type/mappings'
-    require_relative 'index_type/serializer'
     require_relative 'index_type/backend'
+    extend ObjectDocumentMapper
   end
 end

data/lib/esse/logging.rb

@@ -0,0 +1,19 @@
+require 'logger'
+
+module Esse
+  module Logging
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def logger
+        @logger ||= ::Logger.new($stdout)
+      end
+
+      def logger=(log)
+        @logger = log || ::Logger.new(File::NULL)
+      end
+    end
+  end
+end

data/lib/esse/object_document_mapper.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Esse
+  module ObjectDocumentMapper
+    # Convert ruby object to json. Arguments will be same of passed through the
+    # collection. It's allowed a block or a class with the `to_h` instance method.
+    # Example with block
+    #   serializer do |model, **context|
+    #     {
+    #       id: model.id,
+    #       admin: context[:is_admin],
+    #     }
+    #   end
+    # Example with serializer class
+    #   serializer UserSerializer
+    def serializer(klass = nil, &block)
+      if block
+        @serializer_proc = block
+      elsif klass.is_a?(Class) && klass.instance_methods.include?(:to_h)
+        @serializer_proc = proc { |*args, **kwargs| klass.new(*args, **kwargs).to_h }
+      elsif klass.is_a?(Class) && klass.instance_methods.include?(:as_json) # backward compatibility
+        @serializer_proc = proc { |*args, **kwargs| klass.new(*args, **kwargs).as_json }
+      elsif klass.is_a?(Class) && klass.instance_methods.include?(:call)
+        @serializer_proc = proc { |*args, **kwargs| klass.new(*args, **kwargs).call }
+      else
+        msg = format('%<arg>p is not a valid serializer. The serializer should ' \
+                      'respond with `to_h` instance method.', arg: klass,)
+        raise ArgumentError, msg
+      end
+    end
+
+    def serialize(model, *args, **kwargs)
+      unless @serializer_proc
+        raise NotImplementedError, format('there is no serializer defined for the %<k>p index', k: to_s)
+      end
+
+      @serializer_proc.call(model, *args, **kwargs)
+    end
+
+    # Used to define the source of data. A block is required. And its
+    # content should yield an array of each object that should be serialized.
+    # The list of arguments will be passed throught the serializer method.
+    #
+    # Here is an example of how this should work:
+    #   collection do |conditions, &block|
+    #     User.where(conditions).find_in_batches(batch_size: 5000) do |batch|
+    #       block.call(batch, conditions)
+    #     end
+    #   end
+    def collection(collection_class = nil, &block)
+      raise ArgumentError, 'a collection class or a block is required' if block.nil? && collection_class.nil?
+
+      if block.nil? && collection_class.is_a?(Class) && !collection_class.include?(Enumerable)
+        msg = '%<arg>p is not a valid collection class.' \
+              ' Collections should implement the Enumerable interface'
+        raise ArgumentError, format(msg, arg: collection_class)
+      end
+
+      @collection_proc = collection_class || block
+    end
+
+    # Used to fetch all batch of data defined on the collection model.
+    # Arguments can be anything. They will just be passed through the block.
+    # Useful when the collection depends on scope or any other conditions
+    # Example
+    #   each_batch(active: true) do |data, _opts|
+    #     puts data.size
+    #   end
+    def each_batch(*args, **kwargs, &block)
+      unless @collection_proc
+        raise NotImplementedError, format('there is no collection defined for the %<k>p index', k: to_s)
+      end
+
+      case @collection_proc
+      when Class
+        @collection_proc.new(*args, **kwargs).each(&block)
+      else
+        @collection_proc.call(*args, **kwargs, &block)
+      end
+    rescue LocalJumpError
+      raise(SyntaxError, 'block must be explicitly declared in the collection definition')
+    end
+
+    # Wrap collection data into serialized batches
+    #
+    # @param args [*Object] Any argument is allowed here. The collection will be called with same arguments.
+    #   And the serializer will be initialized with those arguments too.
+    # @yield [Array, *Object] serialized collection and method arguments
+    def each_serialized_batch(*args, **kwargs, &block)
+      each_batch(*args, **kwargs) do |batch|
+        entries = batch.map { |entry| serialize(entry, *args, **kwargs) }.compact
+        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/primitives/hash_utils.rb

@@ -0,0 +1,40 @@
+require 'forwardable'
+
+module Esse
+  # The idea here is to add useful methods to the ruby standard objects without
+  # monkey patching them
+  module HashUtils
+    module_function
+
+    def deep_transform_keys(hash, &block)
+      hash.each_with_object({}) do |(key, value), result|
+        result[yield(key)] = \
+          if value.is_a?(Hash)
+            deep_transform_keys(value, &block)
+          else
+            value
+          end
+      end
+    end
+
+    def deep_merge(target, source)
+      target.merge(source) do |key, oldval, newval|
+        if oldval.is_a?(Hash) && newval.is_a?(Hash)
+          deep_merge(oldval, newval)
+        else
+          newval
+        end
+      end
+    end
+
+    def deep_merge!(target, source)
+      target.merge!(source) do |key, oldval, newval|
+        if oldval.is_a?(Hash) && newval.is_a?(Hash)
+          deep_merge!(oldval, newval)
+        else
+          newval
+        end
+      end
+    end
+  end
+end

data/lib/esse/primitives/hstring.rb

@@ -9,7 +9,7 @@ module Esse
   class Hstring
     extend Forwardable
 
-    def_delegators :@value, :==, :eq, :to_s, :inspect, :sub, :capitalize
+    def_delegators :@value, :==, :eq, :to_s, :to_sym, :inspect, :sub, :capitalize
     attr_reader :value
 
     def self.def_conventional(bang_method, conv_method = nil)
@@ -54,18 +54,19 @@ module Esse
     def_conventional :demodulize!
 
     def modulize!
-      @value = @value.split(%r{\:\:|\\|/}).map { |part| self.class.new(part).camelize.to_s }.join('::')
+      @value = @value.split(%r{::|\\|/}).map { |part| self.class.new(part).camelize.to_s }.join('::')
       self
     end
     def_conventional :modulize!
 
     def underscore!
       @value = @value
-        .sub(/^\:\:/, '')
+        .sub(/^::/, '')
         .gsub('::', '/')
         .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
         .gsub(/([a-z\d])([A-Z])/, '\1_\2')
         .tr('-', '_')
+        .tr('.', '_')
         .gsub(/\s/, '_')
         .gsub(/__+/, '_')
         .downcase

data/lib/esse/primitives/output.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+begin
+  require 'rainbow'
+rescue LoadError
+end
+
+module Esse
+  module Output
+    module_function
+
+    def formatted_runtime(number)
+      colorize(sprintf('%.3f ms', number), :lightgray)
+    end
+
+    def runtime_padding(number, extra = 2)
+      ' ' * (extra + sprintf('%.3f ms', number).size)
+    end
+
+    def colorize(text, *attributes)
+      if defined? Rainbow
+        attributes.reduce(Rainbow(text)) { |p, a| p.public_send(a) }
+      else
+        text
+      end
+    end
+
+    def print_error(message_or_error, backtrace: false, **options)
+      options[:level] ||= :error
+      message = message_or_error.to_s
+
+      print_message(message, output: :stderr, **options)
+
+      if message_or_error.is_a?(Exception) && backtrace
+        limit = backtrace.is_a?(Integer) ? backtrace : -1
+        print_backtrace(message_or_error, limit: limit, level: options[:level])
+      end
+    end
+
+    def print_backtrace(error, limit: -1, **options)
+      return unless error.respond_to?(:backtrace)
+      return if error.backtrace.nil?
+
+      error.backtrace[0..limit].each { |frame| print_error(frame, **options) }
+    end
+
+    def print_message(message, level: :info, output: $stdout, newline: true, **fields)
+      output = \
+        case output
+        when :stdout, 'stdout'
+          $stdout
+        when :stderr, 'stderr'
+          $stderr
+        when IO, StringIO
+          output
+        else
+          raise ArgumentError, "Invalid output #{output.inspect}"
+        end
+
+      message = format(message, **fields)
+      newline ? output.puts(message) : output.print(message)
+    end
+  end
+end

data/lib/esse/primitives.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require_relative 'primitives/hstring'
+require_relative 'primitives/hash_utils'

data/lib/esse/template_loader.rb

@@ -24,7 +24,7 @@ module Esse
       path = nil
       @directories.each do |dir|
         patterns.find do |pattern|
-          path = Dir[dir.join("#{pattern}.{#{@extensions.join(',')}}")].first
+          path = Dir[dir.join("#{pattern}.{#{@extensions.join(",")}}")].first
           break if path
         end
         break if path

data/lib/esse/version.rb

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

data/lib/esse.rb

@@ -1,10 +1,19 @@
 # frozen_string_literal: true
 
-require 'esse/index'
+require_relative 'esse/core'
+require_relative 'esse/errors'
+require_relative 'esse/index'
 
 module Esse
   SETTING_ROOT_KEY = 'settings'
   MAPPING_ROOT_KEY = 'mappings'
-
-  class Error < StandardError; end
+  CLI_IGNORE_OPTS = %i[
+    require
+    silent
+  ].freeze
+  CLI_CONFIG_PATHS = %w[
+    Essefile
+    config/esse.rb
+    config/initializers/esse.rb
+  ].freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esse
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.3
 platform: ruby
 authors:
 - Marcos G. Zimmermann
 autorequire: 
 bindir: exec
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2022-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.19'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -136,28 +150,78 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.20
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.5
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 description: All the elegance of ruby with the elasticsearch flexibility. This gem
   is a pretty simple but excential helpers to deal with mapping, indexing, serialization
   and search.
 email:
 - mgzmaster@gmail.com
-executables: []
+executables:
+- esse
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".tool-versions"
-- ".yardopts"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
-- esse.gemspec
 - exec/esse
 - lib/esse.rb
 - lib/esse/backend/index.rb
@@ -175,14 +239,33 @@ files:
 - lib/esse/backend/index_type/documents.rb
 - lib/esse/cli.rb
 - lib/esse/cli/base.rb
+- lib/esse/cli/event_listener.rb
 - lib/esse/cli/generate.rb
 - lib/esse/cli/index.rb
+- lib/esse/cli/index/base_operation.rb
+- lib/esse/cli/index/close.rb
+- lib/esse/cli/index/create.rb
+- lib/esse/cli/index/delete.rb
+- lib/esse/cli/index/import.rb
+- lib/esse/cli/index/open.rb
+- lib/esse/cli/index/reset.rb
+- lib/esse/cli/index/update_aliases.rb
+- lib/esse/cli/index/update_mapping.rb
+- lib/esse/cli/index/update_settings.rb
+- lib/esse/cli/templates/config.rb.erb
 - lib/esse/cli/templates/index.rb.erb
-- lib/esse/cli/templates/mappings.json
-- lib/esse/cli/templates/serializer.rb.erb
+- lib/esse/cli/templates/type_collection.rb.erb
+- lib/esse/cli/templates/type_mappings.json
+- lib/esse/cli/templates/type_serializer.rb.erb
 - 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
+- lib/esse/events/event.rb
+- lib/esse/events/publisher.rb
 - lib/esse/index.rb
 - lib/esse/index/actions.rb
 - lib/esse/index/backend.rb
@@ -199,9 +282,12 @@ files:
 - lib/esse/index_type/actions.rb
 - lib/esse/index_type/backend.rb
 - lib/esse/index_type/mappings.rb
-- lib/esse/index_type/serializer.rb
+- lib/esse/logging.rb
+- lib/esse/object_document_mapper.rb
 - lib/esse/primitives.rb
+- lib/esse/primitives/hash_utils.rb
 - lib/esse/primitives/hstring.rb
+- lib/esse/primitives/output.rb
 - lib/esse/template_loader.rb
 - lib/esse/version.rb
 homepage: https://github.com/marcosgz/esse
@@ -226,7 +312,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Pure Ruby toolkit based on official elasticsearch-ruby library. (No! It isn't

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/.rspec_status
-/tmp/
-esse-*.gem
-/app
-/.env