elasticsearch-persistence 5.0.2 → 6.1.1

data/Rakefile

@@ -7,24 +7,27 @@ task :test    => 'test:unit'
 # ----- Test tasks ------------------------------------------------------------
 
 require 'rake/testtask'
+require 'rspec/core/rake_task'
+
 namespace :test do
-  Rake::TestTask.new(:unit) do |test|
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/unit/**/*_test.rb"]
-    test.verbose = false
-    test.warning = false
-  end
 
-  Rake::TestTask.new(:integration) do |test|
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/integration/**/*_test.rb"]
+  RSpec::Core::RakeTask.new(:spec)
+
+  Rake::TestTask.new(:all) do |test|
     test.verbose = false
     test.warning = false
+    test.deps = [ :spec ]
   end
+end
 
-  Rake::TestTask.new(:all) do |test|
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/unit/**/*_test.rb", "test/integration/**/*_test.rb"]
+namespace :bundle do
+  desc 'Install gem dependencies'
+  task :install do
+    puts '-'*80
+    Bundler.with_clean_env do
+      sh 'bundle install'
+    end
+    puts '-'*80
   end
 end
 

data/elasticsearch-persistence.gemspec

@@ -21,19 +21,18 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files  = [ "README.md", "LICENSE.txt" ]
   s.rdoc_options      = [ "--charset=UTF-8" ]
 
-  s.required_ruby_version = ">= 1.9.3"
+  s.required_ruby_version = ">= 2.2"
 
-  s.add_dependency "elasticsearch",       '~> 5'
-  s.add_dependency "elasticsearch-model", '~> 5'
+  s.add_dependency "elasticsearch",       '~> 6'
+  s.add_dependency "elasticsearch-model", '>= 5'
   s.add_dependency "activesupport",       '> 4'
   s.add_dependency "activemodel",         '> 4'
   s.add_dependency "hashie"
-  s.add_dependency "virtus"
 
-  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "bundler"
   s.add_development_dependency "rake", "~> 11.1"
 
-  s.add_development_dependency "oj"
+  s.add_development_dependency "oj" unless defined?(JRUBY_VERSION)
 
   s.add_development_dependency "rails", '> 4'
 
@@ -45,7 +44,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "mocha"
   s.add_development_dependency "turn"
   s.add_development_dependency "yard"
-  s.add_development_dependency "ruby-prof"
+  s.add_development_dependency "ruby-prof" unless defined?(JRUBY_VERSION)
   s.add_development_dependency "pry"
 
   s.add_development_dependency "simplecov"

data/examples/notes/application.rb

@@ -54,11 +54,12 @@ end
 
 class NoteRepository
   include Elasticsearch::Persistence::Repository
+  include Elasticsearch::Persistence::Repository::DSL
 
   client Elasticsearch::Client.new url: ENV['ELASTICSEARCH_URL'], log: true
 
-  index :notes
-  type  :note
+  index_name :notes
+  document_type  :note
 
   mapping do
     indexes :text,       analyzer: 'snowball'
@@ -66,8 +67,6 @@ class NoteRepository
     indexes :created_at, type:     'date'
   end
 
-  create_index!
-
   def deserialize(document)
     Note.new document['_source'].merge('id' => document['_id'])
   end

data/lib/elasticsearch/persistence.rb

@@ -1,116 +1,8 @@
 require 'hashie/mash'
 
 require 'elasticsearch'
-
-require 'elasticsearch/model/hash_wrapper'
-require 'elasticsearch/model/indexing'
-require 'elasticsearch/model/searching'
-
-require 'active_support/inflector'
+require 'elasticsearch/model'
 
 require 'elasticsearch/persistence/version'
-
-require 'elasticsearch/persistence/client'
-require 'elasticsearch/persistence/repository/response/results'
-require 'elasticsearch/persistence/repository/naming'
-require 'elasticsearch/persistence/repository/serialize'
-require 'elasticsearch/persistence/repository/store'
-require 'elasticsearch/persistence/repository/find'
-require 'elasticsearch/persistence/repository/search'
-require 'elasticsearch/persistence/repository/class'
 require 'elasticsearch/persistence/repository'
-
-module Elasticsearch
-
-  # Persistence for Ruby domain objects and models in Elasticsearch
-  # ===============================================================
-  #
-  # `Elasticsearch::Persistence` contains modules for storing and retrieving Ruby domain objects and models
-  # in Elasticsearch.
-  #
-  # == Repository
-  #
-  # The repository patterns allows to store and retrieve Ruby objects in Elasticsearch.
-  #
-  #     require 'elasticsearch/persistence'
-  #
-  #     class Note
-  #       def to_hash; {foo: 'bar'}; end
-  #     end
-  #
-  #     repository = Elasticsearch::Persistence::Repository.new
-  #
-  #     repository.save Note.new
-  #     # => {"_index"=>"repository", "_type"=>"note", "_id"=>"mY108X9mSHajxIy2rzH2CA", ...}
-  #
-  # Customize your repository by including the main module in a Ruby class
-  #     class MyRepository
-  #       include Elasticsearch::Persistence::Repository
-  #
-  #       index 'my_notes'
-  #       klass Note
-  #
-  #       client Elasticsearch::Client.new log: true
-  #     end
-  #
-  #     repository = MyRepository.new
-  #
-  #     repository.save Note.new
-  #     # 2014-04-04 22:15:25 +0200: POST http://localhost:9200/my_notes/note [status:201, request:0.009s, query:n/a]
-  #     # 2014-04-04 22:15:25 +0200: > {"foo":"bar"}
-  #     # 2014-04-04 22:15:25 +0200: < {"_index":"my_notes","_type":"note","_id":"-d28yXLFSlusnTxb13WIZQ", ...}
-  #
-  # == Model
-  #
-  # The active record pattern allows to use the interface familiar from ActiveRecord models:
-  #
-  #     require 'elasticsearch/persistence'
-  #
-  #     class Article
-  #       attribute :title, String, mapping: { analyzer: 'snowball' }
-  #     end
-  #
-  #     article = Article.new id: 1, title: 'Test'
-  #     article.save
-  #
-  #     Article.find(1)
-  #
-  #     article.update_attributes title: 'Update'
-  #
-  #     article.destroy
-  #
-  module Persistence
-
-    # :nodoc:
-    module ClassMethods
-
-      # Get or set the default client for all repositories and models
-      #
-      # @example Set and configure the default client
-      #
-      #     Elasticsearch::Persistence.client Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
-      #
-      # @example Perform an API request through the client
-      #
-      #     Elasticsearch::Persistence.client.cluster.health
-      #     # => { "cluster_name" => "elasticsearch" ... }
-      #
-      def client client=nil
-        @client = client || @client || Elasticsearch::Client.new
-      end
-
-      # Set the default client for all repositories and models
-      #
-      # @example Set and configure the default client
-      #
-      #     Elasticsearch::Persistence.client = Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
-      #     => #<Elasticsearch::Transport::Client:0x007f96a6dd0d80 @transport=... >
-      #
-      def client=(client)
-        @client = client
-      end
-    end
-
-    extend ClassMethods
-  end
-end
+require 'elasticsearch/persistence/repository/response/results'

data/lib/elasticsearch/persistence/repository.rb

@@ -1,77 +1,236 @@
+require 'elasticsearch/persistence/repository/dsl'
+require 'elasticsearch/persistence/repository/find'
+require 'elasticsearch/persistence/repository/store'
+require 'elasticsearch/persistence/repository/serialize'
+require 'elasticsearch/persistence/repository/search'
+
 module Elasticsearch
   module Persistence
 
-    # Delegate methods to the repository (acting as a gateway)
+    # The base Repository mixin. This module should be included in classes that
+    # represent an Elasticsearch repository.
     #
-    module GatewayDelegation
-      def method_missing(method_name, *arguments, &block)
-        gateway.respond_to?(method_name) ? gateway.__send__(method_name, *arguments, &block) : super
+    # @since 6.0.0
+    module Repository
+      include Store
+      include Serialize
+      include Find
+      include Search
+      include Elasticsearch::Model::Indexing::ClassMethods
+
+      def self.included(base)
+        base.send(:extend, ClassMethods)
       end
 
-      def respond_to?(method_name, include_private=false)
-        gateway.respond_to?(method_name) || super
+      module ClassMethods
+
+        # Initialize a repository instance. Optionally provide a block to define index mappings or
+        #   settings on the repository instance.
+        #
+        # @example Create a new repository.
+        #   MyRepository.create(index_name: 'notes', klass: Note)
+        #
+        # @example Create a new repository and evaluate a block on it.
+        #   MyRepository.create(index_name: 'notes', klass: Note) do
+        #     mapping dynamic: 'strict' do
+        #       indexes :title
+        #     end
+        #   end
+        #
+        # @param [ Hash ] options The options to use.
+        # @param [ Proc ] block A block to evaluate on the new repository instance.
+        #
+        # @option options [ Symbol, String ] :index_name The name of the index.
+        # @option options [ Symbol, String ] :document_type The type of documents persisted in this repository.
+        # @option options [ Symbol, String ] :client The client used to handle requests to and from Elasticsearch.
+        # @option options [ Symbol, String ] :klass The class used to instantiate an object when documents are
+        #   deserialized. The default is nil, in which case the raw document will be returned as a Hash.
+        # @option options [ Elasticsearch::Model::Indexing::Mappings, Hash ] :mapping The mapping for this index.
+        # @option options [ Elasticsearch::Model::Indexing::Settings, Hash ] :settings The settings for this index.
+        #
+        # @since 6.0.0
+        def create(options = {}, &block)
+          new(options).tap do |obj|
+            obj.instance_eval(&block) if block_given?
+          end
+        end
       end
 
-      def respond_to_missing?(method_name, *)
-        gateway.respond_to?(method_name) || super
+      # The default index name.
+      #
+      # @return [ String ] The default index name.
+      #
+      # @since 6.0.0
+      DEFAULT_INDEX_NAME = 'repository'.freeze
+
+      # The default document type.
+      #
+      # @return [ String ] The default document type.
+      #
+      # @note the document type will no longer be configurable in future versions
+      #   of Elasticsearch.
+      #
+      # @since 6.0.0
+      DEFAULT_DOC_TYPE = '_doc'.freeze
+
+      # The repository options.
+      #
+      # @return [ Hash ]
+      #
+      # @since 6.0.0
+      attr_reader :options
+
+      # Initialize a repository instance.
+      #
+      # @example Initialize the repository.
+      #   MyRepository.new(index_name: 'notes', klass: Note)
+      #
+      # @param [ Hash ] options The options to use.
+      #
+      # @option options [ Symbol, String ] :index_name The name of the index.
+      # @option options [ Symbol, String ] :document_type The type of documents persisted in this repository.
+      # @option options [ Symbol, String ] :client The client used to handle requests to and from Elasticsearch.
+      # @option options [ Symbol, String ] :klass The class used to instantiate an object when documents are
+      #   deserialized. The default is nil, in which case the raw document will be returned as a Hash.
+      # @option options [ Elasticsearch::Model::Indexing::Mappings, Hash ] :mapping The mapping for this index.
+      # @option options [ Elasticsearch::Model::Indexing::Settings, Hash ] :settings The settings for this index.
+      #
+      # @since 6.0.0
+      def initialize(options = {})
+        @options = options
       end
-    end
 
-    # When included, creates an instance of the {Repository::Class Repository} class as a "gateway"
-    #
-    # @example Include the repository in a custom class
-    #
-    #     require 'elasticsearch/persistence'
-    #
-    #     class MyRepository
-    #       include Elasticsearch::Persistence::Repository
-    #     end
-    #
-    module Repository
-      def self.included(base)
-        gateway = Elasticsearch::Persistence::Repository::Class.new host: base
+      # Get the client used by the repository.
+      #
+      # @example
+      #   repository.client
+      #
+      # @return [ Elasticsearch::Client ] The repository's client.
+      #
+      # @since 6.0.0
+      def client
+        @client ||= @options[:client] ||
+                      __get_class_value(:client) ||
+                      Elasticsearch::Client.new
+      end
 
-        # Define the instance level gateway
-        #
-        base.class_eval do
-          define_method :gateway do
-            @gateway ||= gateway
-          end
+      # Get the document type used by the repository object.
+      #
+      # @example
+      #   repository.document_type
+      #
+      # @return [ String, Symbol ] The repository's document type.
+      #
+      # @since 6.0.0
+      def document_type
+        @document_type ||= @options[:document_type] ||
+                             __get_class_value(:document_type) ||
+                             DEFAULT_DOC_TYPE
+      end
 
-          include GatewayDelegation
-        end
+      # Get the index name used by the repository.
+      #
+      # @example
+      #   repository.index_name
+      #
+      # @return [ String, Symbol ] The repository's index name.
+      #
+      # @since 6.0.0
+      def index_name
+        @index_name ||= @options[:index_name] ||
+                          __get_class_value(:index_name) ||
+                          DEFAULT_INDEX_NAME
+      end
 
-        # Define the class level gateway
-        #
-        (class << base; self; end).class_eval do
-          define_method :gateway do |&block|
-            @gateway ||= gateway
-            @gateway.instance_eval(&block) if block
-            @gateway
+      # Get the class used by the repository when deserializing.
+      #
+      # @example
+      #   repository.klass
+      #
+      # @return [ Class ] The repository's klass for deserializing.
+      #
+      # @since 6.0.0
+      def klass
+        @klass ||= @options[:klass] || __get_class_value(:klass)
+      end
+
+      # Get the index mapping. Optionally pass a block to define the mappings.
+      #
+      # @example
+      #   repository.mapping
+      #
+      # @example Set the mappings with a block.
+      #     repository.mapping dynamic: 'strict' do
+      #       indexes :foo
+      #     end
+      #   end
+      #
+      # @note If mappings were set when the repository was created, a block passed to this
+      #   method will not be evaluated.
+      #
+      # @return [ Elasticsearch::Model::Indexing::Mappings ] The index mappings.
+      #
+      # @since 6.0.0
+      def mapping(*args)
+        @memoized_mapping ||= @options[:mapping] || (begin
+          if _mapping = __get_class_value(:mapping)
+            _mapping.instance_variable_set(:@type, document_type)
+            _mapping
           end
+        end) || (super && @mapping)
+      end
+      alias :mappings :mapping
 
-          include GatewayDelegation
-        end
+      # Get the index settings.
+      #
+      # @example
+      #   repository.settings
+      #
+      # @example Set the settings with a block.
+      #   repository.settings number_of_shards: 1, number_of_replicas: 0 do
+      #     mapping dynamic: 'strict' do
+      #       indexes :foo do
+      #         indexes :bar
+      #       end
+      #     end
+      #   end
+      #
+      # @return [ Elasticsearch::Model::Indexing::Settings ] The index settings.
+      #
+      # @since 6.0.0
+      def settings(*args)
+        @memoized_settings ||= @options[:settings] || __get_class_value(:settings) || (super && @settings)
+      end
 
-        # Catch repository methods (such as `serialize` and others) defined in the receiving class,
-        # and overload the default definition in the gateway
-        #
-        def base.method_added(name)
-          if :gateway != name && respond_to?(:gateway) && (gateway.public_methods - Object.public_methods).include?(name)
-            gateway.define_singleton_method(name, self.new.method(name).to_proc)
-          end
-        end
+      # Determine whether the index with this repository's index name exists.
+      #
+      # @example
+      #   repository.index_exists?
+      #
+      # @return [ true, false ] Whether the index exists.
+      #
+      # @since 6.0.0
+      def index_exists?(*args)
+        super
       end
 
-      # Shortcut method to allow concise repository initialization
+      # Get the nicer formatted string for use in inspection.
       #
-      # @example Create a new default repository
+      # @example Inspect the repository.
+      #   repository.inspect
       #
-      #     repository = Elasticsearch::Persistence::Repository.new
+      # @return [ String ] The repository inspection.
       #
-      def new(options={}, &block)
-        Elasticsearch::Persistence::Repository::Class.new( {index: 'repository'}.merge(options), &block )
-      end; module_function :new
+      # @since 6.0.0
+      def inspect
+        "#<#{self.class}:0x#{object_id} index_name=#{index_name} document_type=#{document_type} klass=#{klass}>"
+      end
+
+      private
+
+      def __get_class_value(_method_)
+        self.class.send(_method_) if self.class.respond_to?(_method_)
+      end
     end
   end
 end