elasticsearch-persistence 5.1.0 → 6.0.0.pre

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'pry-nav'
+require 'elasticsearch/persistence'
+
+RSpec.configure do |config|
+  config.formatter = 'documentation'
+  config.color = true
+
+  config.after(:suite) do
+    DEFAULT_CLIENT.indices.delete(index: '_all')
+  end
+end
+
+# The default client to be used by the repositories.
+#
+# @since 6.0.0
+DEFAULT_CLIENT = Elasticsearch::Client.new(host: "localhost:#{(ENV['TEST_CLUSTER_PORT'] || 9250)}",
+                                           tracer: (ENV['QUIET'] ? nil : ::Logger.new(STDERR)))
+
+class MyTestRepository
+  include Elasticsearch::Persistence::Repository
+  include Elasticsearch::Persistence::Repository::DSL
+  client DEFAULT_CLIENT
+end
+
+# The default repository to be used by tests.
+#
+# @since 6.0.0
+DEFAULT_REPOSITORY = MyTestRepository.new(index_name: 'my_test_repository', document_type: 'test')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-persistence
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.0.0.pre
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2018-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -16,26 +16,26 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: elasticsearch-model
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: virtus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -314,6 +300,7 @@ extra_rdoc_files:
 - LICENSE.txt
 files:
 - ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -349,48 +336,21 @@ files:
 - examples/notes/config.ru
 - examples/notes/test.rb
 - lib/elasticsearch/persistence.rb
-- lib/elasticsearch/persistence/client.rb
-- lib/elasticsearch/persistence/model.rb
-- lib/elasticsearch/persistence/model/base.rb
-- lib/elasticsearch/persistence/model/errors.rb
-- lib/elasticsearch/persistence/model/find.rb
-- lib/elasticsearch/persistence/model/rails.rb
-- lib/elasticsearch/persistence/model/store.rb
-- lib/elasticsearch/persistence/model/utils.rb
 - lib/elasticsearch/persistence/repository.rb
-- lib/elasticsearch/persistence/repository/class.rb
+- lib/elasticsearch/persistence/repository/dsl.rb
 - lib/elasticsearch/persistence/repository/find.rb
-- lib/elasticsearch/persistence/repository/naming.rb
 - lib/elasticsearch/persistence/repository/response/results.rb
 - lib/elasticsearch/persistence/repository/search.rb
 - lib/elasticsearch/persistence/repository/serialize.rb
 - lib/elasticsearch/persistence/repository/store.rb
 - lib/elasticsearch/persistence/version.rb
-- lib/rails/generators/elasticsearch/model/model_generator.rb
-- lib/rails/generators/elasticsearch/model/templates/model.rb.tt
-- lib/rails/generators/elasticsearch_generator.rb
-- test/integration/model/model_basic_test.rb
-- test/integration/repository/custom_class_test.rb
-- test/integration/repository/customized_class_test.rb
-- test/integration/repository/default_class_test.rb
-- test/integration/repository/virtus_model_test.rb
-- test/test_helper.rb
-- test/unit/model_base_test.rb
-- test/unit/model_find_test.rb
-- test/unit/model_gateway_test.rb
-- test/unit/model_rails_test.rb
-- test/unit/model_store_test.rb
-- test/unit/persistence_test.rb
-- test/unit/repository_class_test.rb
-- test/unit/repository_client_test.rb
-- test/unit/repository_find_test.rb
-- test/unit/repository_indexing_test.rb
-- test/unit/repository_module_test.rb
-- test/unit/repository_naming_test.rb
-- test/unit/repository_response_results_test.rb
-- test/unit/repository_search_test.rb
-- test/unit/repository_serialize_test.rb
-- test/unit/repository_store_test.rb
+- spec/repository/find_spec.rb
+- spec/repository/response/results_spec.rb
+- spec/repository/search_spec.rb
+- spec/repository/serialize_spec.rb
+- spec/repository/store_spec.rb
+- spec/repository_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/elasticsearch/elasticsearch-rails/
 licenses:
 - Apache 2
@@ -407,35 +367,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Persistence layer for Ruby models and Elasticsearch.
 test_files:
-- test/integration/model/model_basic_test.rb
-- test/integration/repository/custom_class_test.rb
-- test/integration/repository/customized_class_test.rb
-- test/integration/repository/default_class_test.rb
-- test/integration/repository/virtus_model_test.rb
-- test/test_helper.rb
-- test/unit/model_base_test.rb
-- test/unit/model_find_test.rb
-- test/unit/model_gateway_test.rb
-- test/unit/model_rails_test.rb
-- test/unit/model_store_test.rb
-- test/unit/persistence_test.rb
-- test/unit/repository_class_test.rb
-- test/unit/repository_client_test.rb
-- test/unit/repository_find_test.rb
-- test/unit/repository_indexing_test.rb
-- test/unit/repository_module_test.rb
-- test/unit/repository_naming_test.rb
-- test/unit/repository_response_results_test.rb
-- test/unit/repository_search_test.rb
-- test/unit/repository_serialize_test.rb
-- test/unit/repository_store_test.rb
+- spec/repository/find_spec.rb
+- spec/repository/response/results_spec.rb
+- spec/repository/search_spec.rb
+- spec/repository/serialize_spec.rb
+- spec/repository/store_spec.rb
+- spec/repository_spec.rb
+- spec/spec_helper.rb

data/lib/elasticsearch/persistence/client.rb

@@ -1,51 +0,0 @@
-module Elasticsearch
-  module Persistence
-    module Repository
-
-      # Wraps the Elasticsearch Ruby
-      # [client](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch#usage)
-      #
-      module Client
-
-        # Get or set the default client for this repository
-        #
-        # @example Set and configure the client for the repository class
-        #
-        #     class MyRepository
-        #       include Elasticsearch::Persistence::Repository
-        #       client Elasticsearch::Client.new host: 'http://localhost:9200', log: true
-        #     end
-        #
-        # @example Set and configure the client for this repository instance
-        #
-        #     repository.client Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
-        #
-        # @example Perform an API request through the client
-        #
-        #     MyRepository.client.cluster.health
-        #     repository.client.cluster.health
-        #     # => { "cluster_name" => "elasticsearch" ... }
-        #
-        def client client=nil
-          @client = client || @client || Elasticsearch::Persistence.client
-        end
-
-        # Set the default client for this repository
-        #
-        # @example Set and configure the client for the repository class
-        #
-        #     MyRepository.client = Elasticsearch::Client.new host: 'http://localhost:9200', log: true
-        #
-        # @example Set and configure the client for this repository instance
-        #
-        #     repository.client = Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
-        #
-        def client=(client)
-          @client = client
-          @client
-        end
-      end
-
-    end
-  end
-end

data/lib/elasticsearch/persistence/model.rb

@@ -1,153 +0,0 @@
-require 'active_support/core_ext/module/delegation'
-
-require 'active_model'
-require 'virtus'
-
-require 'elasticsearch/persistence'
-require 'elasticsearch/persistence/model/base'
-require 'elasticsearch/persistence/model/errors'
-require 'elasticsearch/persistence/model/store'
-require 'elasticsearch/persistence/model/find'
-
-module Elasticsearch
-  module Persistence
-
-    # When included, extends a plain Ruby class with persistence-related features via the ActiveRecord pattern
-    #
-    # @example Include the repository in a custom class
-    #
-    #     require 'elasticsearch/persistence/model'
-    #
-    #     class MyObject
-    #       include Elasticsearch::Persistence::Repository
-    #     end
-    #
-    module Model
-      def self.included(base)
-        base.class_eval do
-          include ActiveModel::Naming
-          include ActiveModel::Conversion
-          include ActiveModel::Serialization
-          include ActiveModel::Serializers::JSON
-          include ActiveModel::Validations
-
-          include Virtus.model
-
-          extend  ActiveModel::Callbacks
-          define_model_callbacks :create, :save, :update, :destroy
-          define_model_callbacks :find, :touch, only: :after
-
-          include Elasticsearch::Persistence::Model::Base::InstanceMethods
-
-          extend  Elasticsearch::Persistence::Model::Store::ClassMethods
-          include Elasticsearch::Persistence::Model::Store::InstanceMethods
-
-          extend  Elasticsearch::Persistence::Model::Find::ClassMethods
-
-          class << self
-            # Re-define the Virtus' `attribute` method, to configure Elasticsearch mapping as well
-            #
-            def attribute(name, type=nil, options={}, &block)
-              mapping = options.delete(:mapping) || {}
-              super
-
-              gateway.mapping do
-                indexes name, {type: Utils::lookup_type(type)}.merge(mapping)
-              end
-
-              gateway.mapping(&block) if block_given?
-            end
-
-            # Return the {Repository::Class} instance
-            #
-            def gateway(&block)
-              @gateway ||= Elasticsearch::Persistence::Repository::Class.new host: self
-              block.arity < 1 ? @gateway.instance_eval(&block) : block.call(@gateway) if block_given?
-              @gateway
-            end
-
-            DEPRECATION_WARNING = "This (ActiveRecord) persistence pattern is deprecated. It will be removed in " +
-              "version 6.0 in favor of the Repository pattern. Please see the ReadMe for " +
-              "details on the alternative pattern.\n" +
-              "https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-persistence" +
-              "#the-repository-pattern".freeze
-
-            # Warn that this ActiveRecord persistence pattern is deprecated.
-            #
-            def raise_deprecation_warning!
-              if STDERR.tty?
-                Kernel.warn("\e[31;1m#{DEPRECATION_WARNING}\e[0m")
-              else
-                Kernel.warn(DEPRECATION_WARNING)
-              end
-            end
-
-            # Delegate methods to repository
-            #
-            delegate :settings,
-                     :mappings,
-                     :mapping,
-                     :document_type=,
-                     :index_name,
-                     :index_name=,
-                     :find,
-                     :exists?,
-                     :create_index!,
-                     :refresh_index!,
-              to: :gateway
-
-            # forward document type to mappings when set
-            def document_type(type = nil)
-              return gateway.document_type unless type
-              gateway.document_type type
-              mapping.type = type
-            end
-          end
-
-          # Configure the repository based on the model (set up index_name, etc)
-          #
-          gateway do
-            klass         base
-            index_name    base.model_name.collection.gsub(/\//, '-')
-            document_type base.model_name.element
-
-            def serialize(document)
-              document.to_hash.except(:id, 'id')
-            end
-
-            def deserialize(document)
-              object = klass.new document['_source']
-
-              # Set the meta attributes when fetching the document from Elasticsearch
-              #
-              object.instance_variable_set :@_id,      document['_id']
-              object.instance_variable_set :@_index,   document['_index']
-              object.instance_variable_set :@_type,    document['_type']
-              object.instance_variable_set :@_version, document['_version']
-              object.instance_variable_set :@_source,  document['_source']
-
-              # Store the "hit" information (highlighting, score, ...)
-              #
-              object.instance_variable_set :@hit,
-                 Elasticsearch::Model::HashWrapper.new(document.except('_index', '_type', '_id', '_version', '_source'))
-
-              object.instance_variable_set(:@persisted, true)
-              object
-            end
-          end
-
-          # Set up common attributes
-          #
-          attribute :created_at, Time, default: lambda { |o,a| Time.now.utc }
-          attribute :updated_at, Time, default: lambda { |o,a| Time.now.utc }
-
-          attr_reader :hit
-
-          raise_deprecation_warning!
-        end
-
-      end
-    end
-
-  end
-end

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

@@ -1,87 +0,0 @@
-module Elasticsearch
-  module Persistence
-    module Model
-      # This module contains the base interface for models
-      #
-      module Base
-        module InstanceMethods
-
-          # Model initializer sets the `@id` variable if passed
-          #
-          def initialize(attributes={})
-            @_id = attributes[:id] || attributes['id']
-            super
-          end
-
-          # Return model attributes as a Hash, merging in the `id`
-          #
-          def attributes
-            super.merge id: id
-          end
-
-          # Return the document `_id`
-          #
-          def id
-            @_id
-          end; alias :_id :id
-
-          # Set the document `_id`
-          #
-          def id=(value)
-            @_id = value
-          end; alias :_id= :id=
-
-          # Return the document `_index`
-          #
-          def _index
-            @_index
-          end
-
-          # Return the document `_type`
-          #
-          def _type
-            @_type
-          end
-
-          # Return the document `_version`
-          #
-          def _version
-            @_version
-          end
-
-          # Return the raw document `_source`
-          #
-          def _source
-            @_source
-          end
-
-          def to_s
-            "#<#{self.class} #{attributes.to_hash.inspect.gsub(/:(\w+)=>/, '\1: ')}>"
-          end; alias :inspect :to_s
-        end
-      end
-
-      # Utility methods for {Elasticsearch::Persistence::Model}
-      #
-      module Utils
-
-        # Return Elasticsearch type based on passed Ruby class (used in the `attribute` method)
-        #
-        def lookup_type(type)
-          case
-            when type == String
-              'text'
-            when type == Integer
-              'integer'
-            when type == Float
-              'float'
-            when type == Date || type == Time || type == DateTime
-              'date'
-            when type == Virtus::Attribute::Boolean
-              'boolean'
-          end
-        end; module_function :lookup_type
-      end
-    end
-  end
-end