elasticsearch-persistence 5.0.2 → 6.1.1

data/lib/elasticsearch/persistence/model/rails.rb

@@ -1,47 +0,0 @@
-module Elasticsearch
-  module Persistence
-    module Model
-
-      # Make the `Persistence::Model` models compatible with Ruby On Rails applications
-      #
-      module Rails
-        def self.included(base)
-          base.class_eval do
-
-            def initialize(attributes={})
-              super(__convert_rails_dates(attributes))
-            end
-
-            def update(attributes={}, options={})
-              super(__convert_rails_dates(attributes), options)
-            end
-          end
-        end
-
-        # Decorates the passed in `attributes` so they extract the date & time values from Rails forms
-        #
-        # @example Correctly combine the date and time to a datetime string
-        #
-        #     params = { "published_on(1i)"=>"2014",
-        #                      "published_on(2i)"=>"1",
-        #                      "published_on(3i)"=>"1",
-        #                      "published_on(4i)"=>"12",
-        #                      "published_on(5i)"=>"00"
-        #                     }
-        #     MyRailsModel.new(params).published_on.iso8601
-        #     # => "2014-01-01T12:00:00+00:00"
-        #
-        def __convert_rails_dates(attributes={})
-          day = attributes.select { |p| p =~ /\([1-3]/ }.reduce({}) { |sum, item| (sum[item.first.gsub(/\(.+\)/, '')] ||= '' )<< item.last+'-'; sum  }
-          time = attributes.select { |p| p =~ /\([4-6]/ }.reduce({}) { |sum, item| (sum[item.first.gsub(/\(.+\)/, '')] ||= '' )<< item.last+':'; sum  }
-          unless day.empty?
-            attributes.update day.reduce({}) { |sum, item| sum[item.first] = item.last; sum[item.first] += ' ' + time[item.first] unless time.empty?; sum }
-          end
-
-          return attributes
-        end; module_function :__convert_rails_dates
-      end
-
-    end
-  end
-end

data/lib/elasticsearch/persistence/model/store.rb

@@ -1,254 +0,0 @@
-module Elasticsearch
-  module Persistence
-    module Model
-
-      # This module contains the storage related features of {Elasticsearch::Persistence::Model}
-      #
-      module Store
-        module ClassMethods #:nodoc:
-
-          # Creates a class instance, saves it, if validations pass, and returns it
-          #
-          # @example Create a new person
-          #
-          #     Person.create name: 'John Smith'
-          #     # => #<Person:0x007f889e302b30 ... @id="bG7yQDAXRhCi3ZfVcx6oAA", @name="John Smith" ...>
-          #
-          # @return [Object] The model instance
-          #
-          def create(attributes, options={})
-            object = self.new(attributes)
-            object.run_callbacks :create do
-              object.save(options)
-              object
-            end
-          end
-        end
-
-        module InstanceMethods
-
-          # Saves the model (if validations pass) and returns the response (or `false`)
-          #
-          # @example Save a valid model instance
-          #
-          #     p = Person.new(name: 'John')
-          #     p.save
-          #     => {"_index"=>"people", ... "_id"=>"RzFSXFR0R8u1CZIWNs2Gvg", "_version"=>1, "created"=>true}
-          #
-          # @example Save an invalid model instance
-          #
-          #     p = Person.new(name: nil)
-          #     p.save
-          #     # => false
-          #
-          # @return [Hash,FalseClass] The Elasticsearch response as a Hash or `false`
-          #
-          def save(options={})
-            unless options.delete(:validate) == false
-              return false unless valid?
-            end
-
-            run_callbacks :save do
-              options.update id: self.id
-              options.update index: self._index if self._index
-              options.update type:  self._type  if self._type
-
-              self[:updated_at] = Time.now.utc
-
-              response = self.class.gateway.save(self, options)
-
-              @_id       = response['_id']
-              @_index    = response['_index']
-              @_type     = response['_type']
-              @_version  = response['_version']
-              @persisted = true
-
-              response
-            end
-          end
-
-          # Deletes the model from Elasticsearch (if it's persisted), freezes it, and returns the response
-          #
-          # @example Delete a model instance
-          #
-          #     p.destroy
-          #     => {"_index"=>"people", ... "_id"=>"RzFSXFR0R8u1CZIWNs2Gvg", "_version"=>2 ...}
-          #
-          # @return [Hash] The Elasticsearch response as a Hash
-          #
-          def destroy(options={})
-            raise DocumentNotPersisted, "Object not persisted: #{self.inspect}" unless persisted?
-
-            run_callbacks :destroy do
-              options.update index: self._index if self._index
-              options.update type:  self._type  if self._type
-
-              response = self.class.gateway.delete(self.id, options)
-
-              @destroyed = true
-              @persisted = false
-              self.freeze
-              response
-            end
-          end; alias :delete :destroy
-
-          # Updates the model (via Elasticsearch's "Update" API) and returns the response
-          #
-          # @example Update a model with partial attributes
-          #
-          #     p.update name: 'UPDATED'
-          #     => {"_index"=>"people", ... "_version"=>2}
-          #
-          # @example Pass a version for concurrency control
-          #
-          #     p.update( { name: 'UPDATED' }, { version: 2 } )
-          #     => {"_index"=>"people", ... "_version"=>3}
-          #
-          # @example An exception is raised when the version doesn't match
-          #
-          #     p.update( { name: 'UPDATED' }, { version: 2 } )
-          #     => Elasticsearch::Transport::Transport::Errors::Conflict: [409] {"error" ... }
-          #
-          # @return [Hash] The Elasticsearch response as a Hash
-          #
-          def update(attributes={}, options={})
-            unless options.delete(:validate) == false
-              return false unless valid?
-            end
-            raise DocumentNotPersisted, "Object not persisted: #{self.inspect}" unless persisted?
-
-            run_callbacks :update do
-              options.update index: self._index if self._index
-              options.update type:  self._type  if self._type
-
-              attributes.update( { updated_at: Time.now.utc } )
-              response = self.class.gateway.update(self.id, { doc: attributes}.merge(options))
-
-              self.attributes = self.attributes.merge(attributes)
-              @_index    = response['_index']
-              @_type     = response['_type']
-              @_version  = response['_version']
-
-              response
-            end
-          end; alias :update_attributes :update
-
-          # Increments a numeric attribute (via Elasticsearch's "Update" API) and returns the response
-          #
-          # @example Increment the `salary` attribute by 1
-          #
-          #     p.increment :salary
-          #
-          # @example Increment the `salary` attribute by 100
-          #
-          #     p.increment :salary, 100
-          #
-          # @return [Hash] The Elasticsearch response as a Hash
-          #
-          def increment(attribute, value=1, options={})
-            raise DocumentNotPersisted, "Object not persisted: #{self.inspect}" unless persisted?
-
-            options.update index: self._index if self._index
-            options.update type:  self._type  if self._type
-
-            response = self.class.gateway.update(self.id, { script: "ctx._source.#{attribute} += #{value}"}.merge(options))
-
-            self[attribute] += value
-
-            @_index    = response['_index']
-            @_type     = response['_type']
-            @_version  = response['_version']
-
-            response
-          end
-
-          # Decrements a numeric attribute (via Elasticsearch's "Update" API) and returns the response
-          #
-          # @example Decrement the `salary` attribute by 1
-          #
-          #     p.decrement :salary
-          #
-          # @example Decrement the `salary` attribute by 100
-          #
-          #     p.decrement :salary, 100
-          #
-          # @return [Hash] The Elasticsearch response as a Hash
-          #
-          def decrement(attribute, value=1, options={})
-            raise DocumentNotPersisted, "Object not persisted: #{self.inspect}" unless persisted?
-
-            options.update index: self._index if self._index
-            options.update type:  self._type  if self._type
-
-            response = self.class.gateway.update(self.id, { script: "ctx._source.#{attribute} = ctx._source.#{attribute} - #{value}"}.merge(options))
-            self[attribute] -= value
-
-            @_index    = response['_index']
-            @_type     = response['_type']
-            @_version  = response['_version']
-
-            response
-          end
-
-          # Updates the `updated_at` attribute, saves the model and returns the response
-          #
-          # @example Update the `updated_at` attribute (default)
-          #
-          #     p.touch
-          #
-          # @example Update a custom attribute: `saved_on`
-          #
-          #     p.touch :saved_on
-          #
-          # @return [Hash] The Elasticsearch response as a Hash
-          #
-          def touch(attribute=:updated_at, options={})
-            raise DocumentNotPersisted, "Object not persisted: #{self.inspect}"  unless persisted?
-            raise ArgumentError, "Object does not have '#{attribute}' attribute" unless respond_to?(attribute)
-
-            run_callbacks :touch do
-              options.update index: self._index if self._index
-              options.update type:  self._type  if self._type
-
-              value = Time.now.utc
-              response = self.class.gateway.update(self.id, { doc: { attribute => value.iso8601 }}.merge(options))
-
-              self[attribute] = value
-
-              @_index    = response['_index']
-              @_type     = response['_type']
-              @_version  = response['_version']
-
-              response
-            end
-          end
-
-          # Returns true when the model has been destroyed, false otherwise
-          #
-          # @return [TrueClass,FalseClass]
-          #
-          def destroyed?
-            !!@destroyed
-          end
-
-          # Returns true when the model has been already saved to the database, false otherwise
-          #
-          # @return [TrueClass,FalseClass]
-          #
-          def persisted?
-            !!@persisted && !destroyed?
-          end
-
-          # Returns true when the model has not been saved yet, false otherwise
-          #
-          # @return [TrueClass,FalseClass]
-          #
-          def new_record?
-            !persisted? && !destroyed?
-          end
-        end
-      end
-
-    end
-  end
-end

data/lib/elasticsearch/persistence/repository/class.rb

@@ -1,71 +0,0 @@
-module Elasticsearch
-  module Persistence
-    module Repository
-
-      # The default repository class, to be used either directly, or as a gateway in a custom repository class
-      #
-      # @example Standalone use
-      #
-      #     repository = Elasticsearch::Persistence::Repository::Class.new
-      #     # => #<Elasticsearch::Persistence::Repository::Class ...>
-      #     repository.save(my_object)
-      #     # => {"_index"=> ... }
-      #
-      # @example Shortcut use
-      #
-      #     repository = Elasticsearch::Persistence::Repository.new
-      #     # => #<Elasticsearch::Persistence::Repository::Class ...>
-      #
-      # @example Configuration via a block
-      #
-      #     repository = Elasticsearch::Persistence::Repository.new do
-      #       index 'my_notes'
-      #     end
-      #
-      #     # => #<Elasticsearch::Persistence::Repository::Class ...>
-      #     # > repository.save(my_object)
-      #     # => {"_index"=> ... }
-      #
-      # @example Accessing the gateway in a custom class
-      #
-      #     class MyRepository
-      #       include Elasticsearch::Persistence::Repository
-      #     end
-      #
-      #     repository = MyRepository.new
-      #
-      #     repository.gateway.client.info
-      #     # => {"status"=>200, "name"=>"Venom", ... }
-      #
-      class Class
-        include Elasticsearch::Persistence::Repository::Client
-        include Elasticsearch::Persistence::Repository::Naming
-        include Elasticsearch::Persistence::Repository::Serialize
-        include Elasticsearch::Persistence::Repository::Store
-        include Elasticsearch::Persistence::Repository::Find
-        include Elasticsearch::Persistence::Repository::Search
-
-        include Elasticsearch::Model::Indexing::ClassMethods
-
-        attr_reader :options
-
-        def initialize(options={}, &block)
-          @options = options
-          index_name options.delete(:index)
-          block.arity < 1 ? instance_eval(&block) : block.call(self) if block_given?
-        end
-
-        # Return the "host" class, if this repository is a gateway hosted in another class
-        #
-        # @return [nil, Class]
-        #
-        # @api private
-        #
-        def host
-          options[:host]
-        end
-      end
-
-    end
-  end
-end

data/lib/elasticsearch/persistence/repository/naming.rb

@@ -1,115 +0,0 @@
-module Elasticsearch
-  module Persistence
-    module Repository
-
-      # Wraps all naming-related features of the repository (index name, the domain object class, etc)
-      #
-      module Naming
-
-        # Get or set the class used to initialize domain objects when deserializing them
-        #
-        def klass name=nil
-          @klass = name || @klass
-        end
-
-        # Set the class used to initialize domain objects when deserializing them
-        #
-        def klass=klass
-          @klass = klass
-        end
-
-        # Get or set the index name used when storing and retrieving documents
-        #
-        def index_name name=nil
-          @index_name = name || @index_name || begin
-            if respond_to?(:host) && host && host.is_a?(Module)
-              self.host.to_s.underscore.gsub(/\//, '-')
-            else
-              self.class.to_s.underscore.gsub(/\//, '-')
-            end
-          end
-        end; alias :index :index_name
-
-        # Set the index name used when storing and retrieving documents
-        #
-        def index_name=(name)
-          @index_name = name
-        end; alias :index= :index_name=
-
-        # Get or set the document type used when storing and retrieving documents
-        #
-        def document_type name=nil
-          @document_type = name || @document_type || (klass ? klass.to_s.underscore : nil)
-        end; alias :type :document_type
-
-        # Set the document type used when storing and retrieving documents
-        #
-        def document_type=(name)
-          @document_type = name
-        end; alias :type= :document_type=
-
-        # Get the Ruby class from the Elasticsearch `_type`
-        #
-        # @example
-        #     repository.__get_klass_from_type 'note'
-        #     => Note
-        #
-        # @return [Class] The class corresponding to the passed type
-        # @raise [NameError] if the class cannot be found
-        #
-        # @api private
-        #
-        def __get_klass_from_type(type)
-          klass = type.classify
-          klass.constantize
-        rescue NameError => e
-          raise NameError, "Attempted to get class '#{klass}' from the '#{type}' type, but no such class can be found."
-        end
-
-        # Get the Elasticsearch `_type` from the Ruby class
-        #
-        # @example
-        #     repository.__get_type_from_class Note
-        #     => "note"
-        #
-        # @return [String] The type corresponding to the passed class
-        #
-        # @api private
-        #
-        def __get_type_from_class(klass)
-          klass.to_s.underscore
-        end
-
-        # Get a document ID from the document (assuming Hash or Hash-like object)
-        #
-        # @example
-        #     repository.__get_id_from_document title: 'Test', id: 'abc123'
-        #     => "abc123"
-        #
-        # @api private
-        #
-        def __get_id_from_document(document)
-          document[:id] || document['id'] || document[:_id] || document['_id']
-        end
-
-        # Extract a document ID from the document (assuming Hash or Hash-like object)
-        #
-        # @note Calling this method will *remove* the `id` or `_id` key from the passed object.
-        #
-        # @example
-        #     options = { title: 'Test', id: 'abc123' }
-        #     repository.__extract_id_from_document options
-        #     # => "abc123"
-        #     options
-        #     # => { title: 'Test' }
-        #
-        # @api private
-        #
-        def __extract_id_from_document(document)
-          document.delete(:id) || document.delete('id') || document.delete(:_id) || document.delete('_id')
-        end
-      end
-
-    end
-  end
-end