elasticsearch-model 0.0.1 → 0.1.0.rc1

data/Rakefile

@@ -1 +1,53 @@
 require "bundler/gem_tasks"
+
+desc "Run unit tests"
+task :default => 'test:unit'
+task :test    => 'test:unit'
+
+# ----- Test tasks ------------------------------------------------------------
+
+require 'rake/testtask'
+namespace :test do
+  task :ci_reporter do
+    ENV['CI_REPORTS'] ||= 'tmp/reports'
+    require 'ci/reporter/rake/minitest'
+    Rake::Task['ci:setup:minitest'].invoke
+  end
+
+  Rake::TestTask.new(:unit) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/unit/**/*_test.rb"]
+    # test.verbose = true
+    # test.warning = true
+  end
+
+  Rake::TestTask.new(:integration) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/integration/**/*_test.rb"]
+  end
+
+  Rake::TestTask.new(:all) do |test|
+    Rake::Task['test:ci_reporter'].invoke if ENV['CI']
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/unit/**/*_test.rb", "test/integration/**/*_test.rb"]
+  end
+end
+
+# ----- Documentation tasks ---------------------------------------------------
+
+require 'yard'
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.options = %w| --embed-mixins --markup=markdown |
+end
+
+# ----- Code analysis tasks ---------------------------------------------------
+
+if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+  require 'cane/rake_task'
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.abc_max = 15
+    cane.no_style = true
+  end
+end

data/elasticsearch-model.gemspec

@@ -3,21 +3,52 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'elasticsearch/model/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "elasticsearch-model"
-  spec.version       = Elasticsearch::Model::VERSION
-  spec.authors       = ["Karel Minarik"]
-  spec.email         = ["karel.minarik@elasticsearch.org"]
-  spec.description   = %q{Elasticsearch gem integration for ActiveModel/ActiveRecord (WIP)}
-  spec.summary       = spec.description
-  spec.homepage      = ""
-  spec.license       = "Apache 2"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+Gem::Specification.new do |s|
+  s.name          = "elasticsearch-model"
+  s.version       = Elasticsearch::Model::VERSION
+  s.authors       = ["Karel Minarik"]
+  s.email         = ["karel.minarik@elasticsearch.org"]
+  s.description   = "ActiveModel/Record integrations for Elasticsearch."
+  s.summary       = "ActiveModel/Record integrations for Elasticsearch."
+  s.homepage      = "https://github.com/elasticsearch/elasticsearch-rails/"
+  s.license       = "Apache 2"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.extra_rdoc_files  = [ "README.md", "LICENSE.txt" ]
+  s.rdoc_options      = [ "--charset=UTF-8" ]
+
+  s.add_dependency "elasticsearch",       '~> 0.4'
+  s.add_dependency "hashie"
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+
+  s.add_development_dependency "elasticsearch-extensions"
+
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "activesupport", "> 3.0"
+  s.add_development_dependency "activemodel",   "> 3.0"
+  s.add_development_dependency "activerecord",  "> 4.0"
+
+  s.add_development_dependency "oj"
+  s.add_development_dependency "kaminari"
+
+  s.add_development_dependency "shoulda-context"
+  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 "pry"
+  s.add_development_dependency "ci_reporter"
+
+  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+    s.add_development_dependency "simplecov"
+    s.add_development_dependency "cane"
+    s.add_development_dependency "require-prof"
+    s.add_development_dependency "coveralls"
+  end
 end

data/examples/activerecord_article.rb

@@ -0,0 +1,77 @@
+# ActiveRecord and Elasticsearch
+# ==============================
+#
+# https://github.com/rails/rails/tree/master/activerecord
+
+$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_record'
+require 'kaminari'
+
+require 'elasticsearch/model'
+
+ActiveRecord::Base.logger = ActiveSupport::Logger.new(STDOUT)
+ActiveRecord::Base.establish_connection( adapter: 'sqlite3', database: ":memory:" )
+
+ActiveRecord::Schema.define(version: 1) do
+  create_table :articles do |t|
+    t.string :title
+    t.date    :published_at
+    t.timestamps
+  end
+end
+
+Kaminari::Hooks.init
+
+class Article < ActiveRecord::Base
+end
+
+# Store data
+#
+Article.delete_all
+Article.create title: 'Foo'
+Article.create title: 'Bar'
+Article.create title: 'Foo Foo'
+
+# Index data
+#
+client = Elasticsearch::Client.new log:true
+
+# client.indices.delete index: 'articles' rescue nil
+# client.indices.create index: 'articles', body: { mappings: { article: { dynamic: 'strict' }, properties: {} } }
+
+client.indices.delete index: 'articles' rescue nil
+client.bulk index: 'articles',
+            type:  'article',
+            body:  Article.all.as_json.map { |a| { index: { _id: a.delete('id'), data: a } } },
+            refresh: true
+
+# Extend the model with Elasticsearch support
+#
+Article.__send__ :include, Elasticsearch::Model
+# Article.__send__ :include, Elasticsearch::Model::Callbacks
+
+# ActiveRecord::Base.logger.silence do
+#   10_000.times do |i|
+#     Article.create title: "Foo #{i}"
+#   end
+# end
+
+puts '', '-'*Pry::Terminal.width!
+
+Elasticsearch::Model.client = Elasticsearch::Client.new log: true
+
+response = Article.search 'foo';
+
+p response.size
+p response.results.size
+p response.records.size
+
+Pry.start(binding, prompt: lambda { |obj, nest_level, _| '> ' },
+                   input: StringIO.new('response.records.to_a'),
+                   quiet: true)

data/examples/activerecord_associations.rb

@@ -0,0 +1,153 @@
+# ActiveRecord associations and Elasticsearch
+# ===========================================
+#
+# https://github.com/rails/rails/tree/master/activerecord
+# http://guides.rubyonrails.org/association_basics.html
+
+$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_record'
+
+require 'elasticsearch/model'
+
+ActiveRecord::Base.logger = ActiveSupport::Logger.new(STDOUT)
+ActiveRecord::Base.establish_connection( adapter: 'sqlite3', database: ":memory:" )
+
+# ----- Schema definition -------------------------------------------------------------------------
+
+ActiveRecord::Schema.define(version: 1) do
+  create_table :categories do |t|
+    t.string     :title
+    t.timestamps
+  end
+
+  create_table :authors do |t|
+    t.string     :first_name, :last_name
+    t.timestamps
+  end
+
+  create_table :authorships do |t|
+    t.references :article
+    t.references :author
+    t.timestamps
+  end
+
+  create_table :articles do |t|
+    t.string   :title
+    t.timestamps
+  end
+
+  create_table :articles_categories, id: false do |t|
+    t.references :article, :category
+  end
+
+  create_table :comments do |t|
+    t.string     :text
+    t.references :article
+    t.timestamps
+  end
+  add_index(:comments, :article_id)
+end
+
+# ----- Model definitions -------------------------------------------------------------------------
+
+class Category < ActiveRecord::Base
+  has_and_belongs_to_many :articles
+end
+
+class Author < ActiveRecord::Base
+  has_many :authorships
+
+  def full_name
+    [first_name, last_name].compact.join(' ')
+  end
+end
+
+class Authorship < ActiveRecord::Base
+  belongs_to :author
+  belongs_to :article, touch: true
+end
+
+class Article < ActiveRecord::Base
+  has_and_belongs_to_many :categories, after_add:    [ lambda { |a,c| a.__elasticsearch__.index_document } ],
+                                       after_remove: [ lambda { |a,c| a.__elasticsearch__.index_document } ]
+  has_many                :authorships
+  has_many                :authors, through: :authorships
+  has_many                :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :article, touch: true
+end
+
+# ----- Search integration ------------------------------------------------------------------------
+
+module Searchable
+  extend ActiveSupport::Concern
+
+  included do
+    include Elasticsearch::Model
+    include Elasticsearch::Model::Callbacks
+
+    __elasticsearch__.client = Elasticsearch::Client.new log: true
+    __elasticsearch__.client.transport.logger.formatter = proc { |s, d, p, m| "\e[32m#{m}\n\e[0m" }
+
+    include Indexing
+    after_touch() { __elasticsearch__.index_document }
+  end
+
+  module Indexing
+
+    # Customize the JSON serialization for Elasticsearch
+    def as_indexed_json(options={})
+      self.as_json(
+        include: { categories: { only: :title},
+                   authors:    { methods: [:full_name], only: [:full_name] },
+                   comments:   { only: :text }
+                 })
+    end
+  end
+end
+
+Article.__send__ :include, Searchable
+
+# ----- Insert data -------------------------------------------------------------------------------
+
+# Create category
+#
+category = Category.create title: 'One'
+
+# Create author
+#
+author = Author.create first_name: 'John', last_name: 'Smith'
+
+# Create article
+
+article  = Article.create title: 'First Article'
+
+# Assign category
+#
+article.categories << category
+
+# Assign author
+#
+article.authors << author
+
+# Add comment
+#
+article.comments.create text: 'First comment'
+
+# Load
+#
+article = Article.all.includes(:categories, :authors, :comments).first
+
+# ----- Pry ---------------------------------------------------------------------------------------
+
+Pry.start(binding, prompt: lambda { |obj, nest_level, _| '> ' },
+                   input: StringIO.new('puts "\n\narticle.as_indexed_json\n"; article.as_indexed_json'),
+                   quiet: true)

data/examples/couchbase_article.rb

@@ -0,0 +1,66 @@
+# Couchbase and Elasticsearch
+# ===========================
+#
+# https://github.com/couchbase/couchbase-ruby-model
+
+$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 'couchbase/model'
+
+require 'elasticsearch/model'
+
+# Documents are stored as JSON objects in Riak but have rich
+# semantics, including validations and associations.
+class Article < Couchbase::Model
+  attribute :title
+  attribute :published_at
+
+  # view :all, :limit => 10, :descending => true
+  # TODO: Implement view a la
+  # bucket.save_design_doc <<-JSON
+  #   {
+  #   "_id": "_design/article",
+  #   "language": "javascript",
+  #   "views": {
+  #     "all": {
+  #       "map": "function(doc, meta) { emit(doc.id, doc.title); }"
+  #     }
+  #   }
+  # }
+  # JSON
+
+end
+
+# Extend the model with Elasticsearch support
+#
+Article.__send__ :extend, Elasticsearch::Model::Client::ClassMethods
+Article.__send__ :extend, Elasticsearch::Model::Searching::ClassMethods
+Article.__send__ :extend, Elasticsearch::Model::Naming::ClassMethods
+
+# Create documents in Riak
+#
+Article.create id: '1', title: 'Foo'      rescue nil
+Article.create id: '2', title: 'Bar'      rescue nil
+Article.create id: '3', title: 'Foo Foo'  rescue nil
+
+# 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.find(['1', '2', '3']).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/datamapper_article.rb

@@ -0,0 +1,71 @@
+# DataMapper and Elasticsearch
+# ============================
+#
+# https://github.com/datamapper/dm-core
+# https://github.com/datamapper/dm-active_model
+
+
+$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 'data_mapper'
+require 'dm-active_model'
+
+require 'active_support/all'
+
+require 'elasticsearch/model'
+
+DataMapper::Logger.new(STDOUT, :debug)
+DataMapper.setup(:default, 'sqlite::memory:')
+
+class Article
+  include DataMapper::Resource
+
+  property :id,           Serial
+  property :title,        String
+  property :published_at, DateTime
+end
+
+DataMapper.auto_migrate!
+DataMapper.finalize
+
+Article.create title: 'Foo'
+Article.create title: 'Bar'
+Article.create title: 'Foo Foo'
+
+# Extend the model with Elasticsearch support
+#
+Article.__send__ :include, Elasticsearch::Model
+
+# The DataMapper adapter
+#
+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) }
+)
+
+response = Article.search 'foo';
+
+Pry.start(binding, prompt: lambda { |obj, nest_level, _| '> ' },
+                   input: StringIO.new('response.records.to_a'),
+                   quiet: true)