elasticsearch-model 0.0.1 → 0.1.0.rc1

data/examples/mongoid_article.rb

@@ -0,0 +1,68 @@
+# Mongoid and Elasticsearch
+# =========================
+#
+# http://mongoid.org/en/mongoid/index.html
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'pry'
+Pry.config.history.file = File.expand_path('../../tmp/elasticsearch_development.pry', __FILE__)
+
+require 'benchmark'
+require 'logger'
+require 'ansi/core'
+require 'mongoid'
+
+require 'elasticsearch/model'
+require 'elasticsearch/model/callbacks'
+
+Mongoid.logger.level = Logger::DEBUG
+Moped.logger.level = Logger::DEBUG
+
+Mongoid.connect_to 'articles'
+
+Elasticsearch::Model.client = Elasticsearch::Client.new host: 'localhost:9250', log: true
+
+class Article
+  include Mongoid::Document
+  field :id, type: String
+  field :title, type: String
+  field :published_at, type: DateTime
+  attr_accessible :id, :title, :published_at if respond_to? :attr_accessible
+
+  def as_indexed_json(options={})
+    as_json(except: [:id, :_id])
+  end
+end
+
+# Extend the model with Elasticsearch support
+#
+Article.__send__ :include, Elasticsearch::Model
+# Article.__send__ :include, Elasticsearch::Model::Callbacks
+
+# Store data
+#
+Article.delete_all
+Article.create id: '1', title: 'Foo'
+Article.create id: '2', title: 'Bar'
+Article.create id: '3', title: 'Foo Foo'
+
+# Index data
+#
+client = Elasticsearch::Client.new host:'localhost:9250', log:true
+
+client.indices.delete index: 'articles' rescue nil
+client.bulk index: 'articles',
+            type:  'article',
+            body:  Article.all.map { |a| { index: { _id: a.id, data: a.attributes } } },
+            refresh: true
+
+# puts Benchmark.realtime { 9_875.times { |i| Article.create title: "Foo #{i}" } }
+
+puts '', '-'*Pry::Terminal.width!
+
+response = Article.search 'foo';
+
+Pry.start(binding, prompt: lambda { |obj, nest_level, _| '> ' },
+                   input: StringIO.new('response.records.to_a'),
+                   quiet: true)

data/examples/ohm_article.rb

@@ -0,0 +1,70 @@
+# Ohm for Redis and Elasticsearch
+# ===============================
+#
+# https://github.com/soveran/ohm#example
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'pry'
+Pry.config.history.file = File.expand_path('../../tmp/elasticsearch_development.pry', __FILE__)
+
+require 'logger'
+require 'ansi/core'
+require 'active_model'
+require 'ohm'
+
+require 'elasticsearch/model'
+
+class Article < Ohm::Model
+  # Include JSON serialization from ActiveModel
+  include ActiveModel::Serializers::JSON
+
+  attribute :title
+  attribute :published_at
+end
+
+# Extend the model with Elasticsearch support
+#
+Article.__send__ :include, Elasticsearch::Model
+
+# Register a custom adapter
+#
+module Elasticsearch
+  module Model
+    module Adapter
+      module Ohm
+        Adapter.register self,
+                         lambda { |klass| defined?(::Ohm::Model) and klass.ancestors.include?(::Ohm::Model) }
+        module Records
+          def records
+            klass.fetch(@ids)
+          end
+        end
+      end
+    end
+  end
+end
+
+# Configure the Elasticsearch client to log operations
+#
+Elasticsearch::Model.client = Elasticsearch::Client.new log: true
+
+puts '', '-'*Pry::Terminal.width!
+
+Article.all.map { |a| a.delete }
+Article.create id: '1', title: 'Foo'
+Article.create id: '2', title: 'Bar'
+Article.create id: '3', title: 'Foo Foo'
+
+Article.__elasticsearch__.client.indices.delete index: 'articles' rescue nil
+Article.__elasticsearch__.client.bulk index: 'articles',
+                                      type:  'article',
+                                      body:  Article.all.map { |a| { index: { _id: a.id, data: a.attributes } } },
+                                      refresh: true
+
+
+response = Article.search 'foo', index: 'articles', type: 'article';
+
+Pry.start(binding, prompt: lambda { |obj, nest_level, _| '> ' },
+                   input: StringIO.new('response.records.to_a'),
+                   quiet: true)

data/examples/riak_article.rb

@@ -0,0 +1,52 @@
+# Riak and Elasticsearch
+# ======================
+#
+# https://github.com/basho-labs/ripple
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'pry'
+Pry.config.history.file = File.expand_path('../../tmp/elasticsearch_development.pry', __FILE__)
+
+require 'logger'
+require 'ripple'
+
+require 'elasticsearch/model'
+
+# Documents are stored as JSON objects in Riak but have rich
+# semantics, including validations and associations.
+class Article
+  include Ripple::Document
+
+  property :title,        String
+  property :published_at, Time,   :default => proc { Time.now }
+end
+
+# Extend the model with Elasticsearch support
+#
+Article.__send__ :include, Elasticsearch::Model
+
+# Create documents in Riak
+#
+Article.destroy_all
+Article.create id: '1', title: 'Foo'
+Article.create id: '2', title: 'Bar'
+Article.create id: '3', title: 'Foo Foo'
+
+# Index data into Elasticsearch
+#
+client = Elasticsearch::Client.new log:true
+
+client.indices.delete index: 'articles' rescue nil
+client.bulk index: 'articles',
+            type:  'article',
+            body:  Article.all.map { |a|
+                     { index: { _id: a.key, data: JSON.parse(a.robject.raw_data) } }
+                   }.as_json,
+            refresh: true
+
+response = Article.search 'foo';
+
+Pry.start(binding, prompt: lambda { |obj, nest_level, _| '> ' },
+                   input: StringIO.new('response.records.to_a'),
+                   quiet: true)

data/gemfiles/3.gemfile

@@ -0,0 +1,11 @@
+# Usage:
+#
+# $ BUNDLE_GEMFILE=./gemfiles/3.gemfile bundle install
+# $ BUNDLE_GEMFILE=./gemfiles/3.gemfile bundle exec rake test:integration
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 3.2'
+gem 'mongoid',      '>= 3.0'
+
+gemspec path: '../'

data/gemfiles/4.gemfile

@@ -0,0 +1,11 @@
+# Usage:
+#
+# $ BUNDLE_GEMFILE=./gemfiles/4.gemfile bundle install
+# $ BUNDLE_GEMFILE=./gemfiles/4.gemfile bundle exec rake test:integration
+
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 4'
+gem 'mongoid',      '~> 4.0.0.alpha1'
+
+gemspec path: '../'

data/lib/elasticsearch/model.rb

@@ -1,6 +1,156 @@
-require "elasticsearch/model/version"
+require 'forwardable'
+
+require 'elasticsearch'
+
+require 'hashie'
+
+require 'elasticsearch/model/support/forwardable'
+
+require 'elasticsearch/model/client'
+
+require 'elasticsearch/model/adapter'
+require 'elasticsearch/model/adapters/default'
+require 'elasticsearch/model/adapters/active_record'
+require 'elasticsearch/model/adapters/mongoid'
+
+require 'elasticsearch/model/importing'
+require 'elasticsearch/model/indexing'
+require 'elasticsearch/model/naming'
+require 'elasticsearch/model/serializing'
+require 'elasticsearch/model/searching'
+require 'elasticsearch/model/callbacks'
+
+require 'elasticsearch/model/proxy'
+
+require 'elasticsearch/model/response'
+require 'elasticsearch/model/response/base'
+require 'elasticsearch/model/response/result'
+require 'elasticsearch/model/response/results'
+require 'elasticsearch/model/response/records'
+require 'elasticsearch/model/response/pagination'
+
+require 'elasticsearch/model/version'
+
+if defined?(::Kaminari)
+  Elasticsearch::Model::Response::Response.__send__ :include, Elasticsearch::Model::Response::Pagination::Kaminari
+end
 
 module Elasticsearch
+
+  # Elasticsearch integration for Ruby models
+  # =========================================
+  #
+  # `Elasticsearch::Model` contains modules for integrating the Elasticsearch search and analytical engine
+  # with ActiveModel-based classes, or models, for the Ruby programming language.
+  #
+  # It facilitates importing your data into an index, automatically updating it when a record changes,
+  # searching the specific index, setting up the index mapping or the model JSON serialization.
+  #
+  # When the `Elasticsearch::Model` module is included in your class, it automatically extends it
+  # with the functionality; see {Elasticsearch::Model.included}. Most methods are available via
+  # the `__elasticsearch__` class and instance method proxies.
+  #
+  # It is possible to include/extend the model with the corresponding
+  # modules directly, if that is desired:
+  #
+  #     MyModel.__send__ :extend,  Elasticsearch::Model::Client::ClassMethods
+  #     MyModel.__send__ :include, Elasticsearch::Model::Client::InstanceMethods
+  #     MyModel.__send__ :extend,  Elasticsearch::Model::Searching::ClassMethods
+  #     # ...
+  #
   module Model
+
+    # Adds the `Elasticsearch::Model` functionality to the including class.
+    #
+    # * Creates the `__elasticsearch__` class and instance methods, pointing to the proxy object
+    # * Includes the necessary modules in the proxy classes
+    # * Sets up delegation for crucial methods such as `search`, etc.
+    #
+    # @example Include the module in the `Article` model definition
+    #
+    #     class Article < ActiveRecord::Base
+    #       include Elasticsearch::Model
+    #     end
+    #
+    # @example Inject the module into the `Article` model during run time
+    #
+    #     Article.__send__ :include, Elasticsearch::Model
+    #
+    #
+    def self.included(base)
+      base.class_eval do
+        include Elasticsearch::Model::Proxy
+
+        Elasticsearch::Model::Proxy::ClassMethodsProxy.class_eval do
+          include Elasticsearch::Model::Client::ClassMethods
+          include Elasticsearch::Model::Naming::ClassMethods
+          include Elasticsearch::Model::Indexing::ClassMethods
+          include Elasticsearch::Model::Searching::ClassMethods
+        end
+
+        Elasticsearch::Model::Proxy::InstanceMethodsProxy.class_eval do
+          include Elasticsearch::Model::Client::InstanceMethods
+          include Elasticsearch::Model::Naming::InstanceMethods
+          include Elasticsearch::Model::Indexing::InstanceMethods
+          include Elasticsearch::Model::Serializing::InstanceMethods
+        end
+
+        Elasticsearch::Model::Proxy::InstanceMethodsProxy.class_eval <<-CODE, __FILE__, __LINE__ + 1
+          def as_indexed_json(options={})
+            target.respond_to?(:as_indexed_json) ? target.__send__(:as_indexed_json, options) : super
+          end
+        CODE
+
+        # Delegate important methods to the `__elasticsearch__` proxy, unless they are defined already
+        #
+        extend  Support::Forwardable
+        forward :'self.__elasticsearch__', :search        unless respond_to?(:search)
+        forward :'self.__elasticsearch__', :mapping       unless respond_to?(:mapping)
+        forward :'self.__elasticsearch__', :mappings      unless respond_to?(:mappings)
+        forward :'self.__elasticsearch__', :settings      unless respond_to?(:settings)
+        forward :'self.__elasticsearch__', :index_name    unless respond_to?(:index_name)
+        forward :'self.__elasticsearch__', :document_type unless respond_to?(:document_type)
+        forward :'self.__elasticsearch__', :import        unless respond_to?(:import)
+
+        # Mix the importing module into the proxy
+        #
+        self.__elasticsearch__.class_eval do
+          include Elasticsearch::Model::Importing::ClassMethods
+          include Adapter.from_class(base).importing_mixin
+        end
+      end
+    end
+
+    module ClassMethods
+
+      # Get the client common for all models
+      #
+      # @example Get the client
+      #
+      #     Elasticsearch::Model.client
+      #     => #<Elasticsearch::Transport::Client:0x007f96a7d0d000 @transport=... >
+      #
+      def client
+        @client ||= Elasticsearch::Client.new
+      end
+
+      # Set the client for all models
+      #
+      # @example Configure (set) the client for all models
+      #
+      #     Elasticsearch::Model.client Elasticsearch::Client.new host: 'http://localhost:9200', tracer: true
+      #     => #<Elasticsearch::Transport::Client:0x007f96a6dd0d80 @transport=... >
+      #
+      # @note You have to set the client before you call Elasticsearch methods on the model,
+      #       or set it directly on the model; see {Elasticsearch::Model::Client::ClassMethods#client}
+      #
+      def client=(client)
+        @client = client
+      end
+
+    end
+    extend ClassMethods
+
+    class NotImplemented < NoMethodError; end
   end
 end

data/lib/elasticsearch/model/adapter.rb

@@ -0,0 +1,145 @@
+module Elasticsearch
+  module Model
+
+    # Contains an adapter which provides OxM-specific implementations for common behaviour:
+    #
+    # * {Adapter::Adapter#records_mixin   Fetching records from the database}
+    # * {Adapter::Adapter#callbacks_mixin Model callbacks for automatic index updates}
+    # * {Adapter::Adapter#importing_mixin Efficient bulk loading from the database}
+    #
+    # @see Elasticsearch::Model::Adapter::Default
+    # @see Elasticsearch::Model::Adapter::ActiveRecord
+    # @see Elasticsearch::Model::Adapter::Mongoid
+    #
+    module Adapter
+
+      # Returns an adapter based on the Ruby class passed
+      #
+      # @example Create an adapter for an ActiveRecord-based model
+      #
+      #     class Article < ActiveRecord::Base; end
+      #
+      #     myadapter = Elasticsearch::Model::Adapter.from_class(Article)
+      #     myadapter.adapter
+      #     # => Elasticsearch::Model::Adapter::ActiveRecord
+      #
+      # @see Adapter.adapters The list of included adapters
+      # @see Adapter.register Register a custom adapter
+      #
+      def from_class(klass)
+        Adapter.new(klass)
+      end; module_function :from_class
+
+      # Returns registered adapters
+      #
+      # @see ::Elasticsearch::Model::Adapter::Adapter.adapters
+      #
+      def adapters
+        Adapter.adapters
+      end; module_function :adapters
+
+      # Registers an adapter
+      #
+      # @see ::Elasticsearch::Model::Adapter::Adapter.register
+      #
+      def register(name, condition)
+        Adapter.register(name, condition)
+      end; module_function :register
+
+      # Contains an adapter for specific OxM or architecture.
+      #
+      class Adapter
+        attr_reader :klass
+
+        def initialize(klass)
+          @klass = klass
+        end
+
+        # Registers an adapter for specific condition
+        #
+        # @param name      [Module] The module containing the implemented interface
+        # @param condition [Proc]   An object with a `call` method which is evaluated in {.adapter}
+        #
+        # @example Register an adapter for DataMapper
+        #
+        #     module DataMapperAdapter
+        #
+        #       # Implement the interface for fetching records
+        #       #
+        #       module Records
+        #         def records
+        #           klass.all(id: @ids)
+        #         end
+        #
+        #         # ...
+        #       end
+        #     end
+        #
+        #     # Register the adapter
+        #     #
+        #     Elasticsearch::Model::Adapter.register(
+        #       DataMapperAdapter,
+        #       lambda { |klass|
+        #         defined?(::DataMapper::Resource) and klass.ancestors.include?(::DataMapper::Resource)
+        #       }
+        #     )
+        #
+        def self.register(name, condition)
+          self.adapters[name] = condition
+        end
+
+        # Return the collection of registered adapters
+        #
+        # @example Return the currently registered adapters
+        #
+        #     Elasticsearch::Model::Adapter.adapters
+        #     # => {
+        #     #  Elasticsearch::Model::Adapter::ActiveRecord => #<Proc:0x007...(lambda)>,
+        #     #  Elasticsearch::Model::Adapter::Mongoid => #<Proc:0x007... (lambda)>,
+        #     # }
+        #
+        # @return [Hash] The collection of adapters
+        #
+        def self.adapters
+          @adapters ||= {}
+        end
+
+        # Return the module with {Default::Records} interface implementation
+        #
+        # @api private
+        #
+        def records_mixin
+          adapter.const_get(:Records)
+        end
+
+        # Return the module with {Default::Callbacks} interface implementation
+        #
+        # @api private
+        #
+        def callbacks_mixin
+          adapter.const_get(:Callbacks)
+        end
+
+        # Return the module with {Default::Importing} interface implementation
+        #
+        # @api private
+        #
+        def importing_mixin
+          adapter.const_get(:Importing)
+        end
+
+        # Returns the adapter module
+        #
+        # @api private
+        #
+        def adapter
+          @adapter ||= begin
+            self.class.adapters.find( lambda {[]} ) { |name, condition| condition.call(klass) }.first \
+            || Elasticsearch::Model::Adapter::Default
+          end
+        end
+
+      end
+    end
+  end
+end