elasticsearch-model 0.0.1 → 0.1.0.rc1

data/test/integration/active_record_basic_test.rb

@@ -0,0 +1,139 @@
+require 'test_helper'
+
+puts "ActiveRecord #{ActiveRecord::VERSION::STRING}", '-'*80
+
+module Elasticsearch
+  module Model
+    class ActiveRecordBasicIntegrationTest < Elasticsearch::Test::IntegrationTestCase
+
+      class ::Article < ActiveRecord::Base
+        include Elasticsearch::Model
+        include Elasticsearch::Model::Callbacks
+
+        settings index: { number_of_shards: 1, number_of_replicas: 0 } do
+          mapping do
+            indexes :title,      type: 'string', analyzer: 'snowball'
+            indexes :created_at, type: 'date'
+          end
+        end
+      end
+
+      context "ActiveRecord basic integration" do
+        setup do
+          ActiveRecord::Schema.define(:version => 1) do
+            create_table :articles do |t|
+              t.string   :title
+              t.datetime :created_at, :default => 'NOW()'
+            end
+          end
+
+          Article.delete_all
+          Article.__elasticsearch__.create_index! force: true
+
+          ::Article.create! title: 'Test'
+          ::Article.create! title: 'Testing Coding'
+          ::Article.create! title: 'Coding'
+
+          Article.__elasticsearch__.refresh_index!
+        end
+
+        should "index and find a document" do
+          response = Article.search('title:test')
+
+          assert response.any?, "Response should not be empty: #{response.to_a.inspect}"
+
+          assert_equal 2, response.results.size
+          assert_equal 2, response.records.size
+
+          assert_instance_of Elasticsearch::Model::Response::Result, response.results.first
+          assert_instance_of Article, response.records.first
+
+          assert_equal 'Test', response.results.first.title
+          assert_equal 'Test', response.records.first.title
+        end
+
+        should "iterate over results" do
+          response = Article.search('title:test')
+
+          assert_equal ['1', '2'], response.results.map(&:_id)
+          assert_equal [1, 2],     response.records.map(&:id)
+        end
+
+        should "access results from records" do
+          response = Article.search('title:test')
+
+          response.records.each_with_hit do |r, h|
+            assert_not_nil h._score
+            assert_not_nil h._source.title
+          end
+        end
+
+        should "remove document from index on destroy" do
+          article = Article.first
+
+          article.destroy
+          assert_equal 2, Article.count
+
+          Article.__elasticsearch__.refresh_index!
+
+          response = Article.search 'title:test'
+
+          assert_equal 1, response.results.size
+          assert_equal 1, response.records.size
+        end
+
+        should "index updates to the document" do
+          article = Article.first
+
+          article.title = 'Writing'
+          article.save
+
+          Article.__elasticsearch__.refresh_index!
+
+          response = Article.search 'title:write'
+
+          assert_equal 1, response.results.size
+          assert_equal 1, response.records.size
+        end
+
+        should "return results for a DSL search" do
+          response = Article.search query: { match: { title: { query: 'test' } } }
+
+          assert_equal 2, response.results.size
+          assert_equal 2, response.records.size
+        end
+
+        should "return a paged collection" do
+          response = Article.search query: { match: { title: { query: 'test' } } },
+                                    size: 2,
+                                    from: 1
+
+          assert_equal 1, response.results.size
+          assert_equal 1, response.records.size
+
+          assert_equal 'Testing Coding', response.results.first.title
+          assert_equal 'Testing Coding', response.records.first.title
+        end
+
+        should "allow chaining SQL commands on response.records" do
+          response = Article.search query: { match: { title: { query: 'test' } } }
+
+          assert_equal 2,      response.records.size
+          assert_equal 1,      response.records.where(title: 'Test').size
+          assert_equal 'Test', response.records.where(title: 'Test').first.title
+        end
+
+        should "allow ordering response.records in SQL" do
+          response = Article.search query: { match: { title: { query: 'test' } } }
+
+          if defined?(::ActiveRecord) && ::ActiveRecord::VERSION::MAJOR >= 4
+            assert_equal 'Testing Coding', response.records.order(title: :desc).first.title
+          else
+            assert_equal 'Testing Coding', response.records.order('title DESC').first.title
+          end
+        end
+      end
+
+    end
+  end
+end

data/test/integration/active_record_import_test.rb

@@ -0,0 +1,74 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Model
+    class ActiveRecordImportIntegrationTest < Elasticsearch::Test::IntegrationTestCase
+
+      class ::ImportArticle < ActiveRecord::Base
+        include Elasticsearch::Model
+
+        mapping do
+          indexes :title,      type: 'string'
+          indexes :views,      type: 'integer'
+          indexes :created_at, type: 'date'
+        end
+      end
+
+      context "ActiveRecord importing" do
+        setup do
+          ActiveRecord::Schema.define(:version => 1) do
+            create_table :import_articles do |t|
+              t.string   :title
+              t.string   :views # For the sake of invalid data sent to Elasticsearch
+              t.datetime :created_at, :default => 'NOW()'
+            end
+          end
+
+          ImportArticle.delete_all
+          ImportArticle.__elasticsearch__.create_index! force: true
+
+          100.times { |i| ImportArticle.create! title: "Test #{i}" }
+        end
+
+        should "import all the documents" do
+          assert_equal 100, ImportArticle.count
+
+          ImportArticle.__elasticsearch__.refresh_index!
+          assert_equal 0, ImportArticle.search('*').results.total
+
+          batches = 0
+          errors  = ImportArticle.import(batch_size: 10) do |response|
+            batches += 1
+          end
+
+          assert_equal 0, errors
+          assert_equal 10, batches
+
+          ImportArticle.__elasticsearch__.refresh_index!
+          assert_equal 100, ImportArticle.search('*').results.total
+        end
+
+        should "report and not store/index invalid documents" do
+          ImportArticle.create! title: "Test INVALID", views: "INVALID"
+
+          assert_equal 101, ImportArticle.count
+
+          ImportArticle.__elasticsearch__.refresh_index!
+          assert_equal 0, ImportArticle.search('*').results.total
+
+          batches = 0
+          errors  = ImportArticle.__elasticsearch__.import(batch_size: 10) do |response|
+            batches += 1
+          end
+
+          assert_equal 1, errors
+          assert_equal 11, batches
+
+          ImportArticle.__elasticsearch__.refresh_index!
+          assert_equal 100, ImportArticle.search('*').results.total
+        end
+      end
+
+    end
+  end
+end

data/test/integration/active_record_namespaced_model_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Model
+    class ActiveRecordNamespacedModelIntegrationTest < Elasticsearch::Test::IntegrationTestCase
+
+      module ::MyNamespace
+        class Article < ActiveRecord::Base
+          include Elasticsearch::Model
+          include Elasticsearch::Model::Callbacks
+
+          mapping { indexes :title }
+        end
+      end
+
+      context "Namespaced ActiveRecord model integration" do
+        setup do
+          ActiveRecord::Schema.define(:version => 1) do
+            create_table :articles do |t|
+              t.string   :title
+            end
+          end
+
+          MyNamespace::Article.delete_all
+          MyNamespace::Article.__elasticsearch__.create_index! force: true
+
+          MyNamespace::Article.create! title: 'Test'
+
+          MyNamespace::Article.__elasticsearch__.refresh_index!
+        end
+
+        should "have proper index name and document type" do
+          assert_equal "my_namespace-articles", MyNamespace::Article.index_name
+          assert_equal "article",               MyNamespace::Article.document_type
+        end
+
+        should "save document into index on save and find it" do
+          response = MyNamespace::Article.search 'title:test'
+
+          assert       response.any?, "No results returned: #{response.inspect}"
+          assert_equal 1, response.size
+
+          assert_equal 'Test', response.results.first.title
+        end
+      end
+
+    end
+  end
+end

data/test/integration/active_record_pagination_test.rb

@@ -0,0 +1,109 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Model
+    class ActiveRecordPaginationTest < Elasticsearch::Test::IntegrationTestCase
+
+      class ::Article < ActiveRecord::Base
+        include Elasticsearch::Model
+
+        settings index: { number_of_shards: 1, number_of_replicas: 0 } do
+          mapping do
+            indexes :title,      type: 'string', analyzer: 'snowball'
+            indexes :created_at, type: 'date'
+          end
+        end
+      end
+
+      Kaminari::Hooks.init
+
+      context "ActiveRecord pagination" do
+        setup do
+          ActiveRecord::Schema.define(:version => 1) do
+            create_table :articles do |t|
+              t.string   :title
+              t.datetime :created_at, :default => 'NOW()'
+            end
+          end
+
+          Article.delete_all
+          Article.__elasticsearch__.create_index! force: true
+
+          68.times do |i| ::Article.create! title: "Test #{i}" end
+
+          Article.import
+          Article.__elasticsearch__.refresh_index!
+        end
+
+        should "be on the first page by default" do
+          records = Article.search('title:test').page(1).records
+
+          assert_equal 25, records.size
+          assert_equal 1, records.current_page
+          assert_equal nil, records.prev_page
+          assert_equal 2, records.next_page
+          assert_equal 3, records.total_pages
+
+          assert   records.first_page?,   "Should be the first page"
+          assert ! records.last_page?,    "Should NOT be the last page"
+          assert ! records.out_of_range?, "Should NOT be out of range"
+        end
+
+        should "load next page" do
+          records = Article.search('title:test').page(2).records
+
+          assert_equal 25, records.size
+          assert_equal 2, records.current_page
+          assert_equal 1, records.prev_page
+          assert_equal 3, records.next_page
+          assert_equal 3, records.total_pages
+
+          assert ! records.first_page?,   "Should NOT be the first page"
+          assert ! records.last_page?,    "Should NOT be the last page"
+          assert ! records.out_of_range?, "Should NOT be out of range"
+        end
+
+        should "load last page" do
+          records = Article.search('title:test').page(3).records
+
+          assert_equal 18, records.size
+          assert_equal 3, records.current_page
+          assert_equal 2, records.prev_page
+          assert_equal nil, records.next_page
+          assert_equal 3, records.total_pages
+
+          assert ! records.first_page?,   "Should NOT be the first page"
+          assert   records.last_page?,    "Should be the last page"
+          assert ! records.out_of_range?, "Should NOT be out of range"
+        end
+
+        should "not load invalid page" do
+          records = Article.search('title:test').page(6).records
+
+          assert_equal 0, records.size
+          assert_equal 6, records.current_page
+          assert_equal 5, records.prev_page
+          assert_equal nil, records.next_page
+          assert_equal 3, records.total_pages
+
+          assert ! records.first_page?,   "Should NOT be the first page"
+          assert   records.last_page?,    "Should be the last page"
+          assert   records.out_of_range?, "Should be out of range"
+        end
+
+        context "with specific model settings" do
+          teardown do
+            Article.instance_variable_set(:@_default_per_page, nil)
+          end
+        end
+
+        should "respect paginates_per" do
+          Article.paginates_per 50
+
+          assert_equal 50, Article.search('*').page(1).records.size
+        end
+      end
+
+    end
+  end
+end

data/test/integration/mongoid_basic_test.rb

@@ -0,0 +1,178 @@
+require 'test_helper'
+
+begin
+  require "mongoid"
+  session = Moped::Connection.new("localhost", 27017, 0.5)
+  session.connect
+  ENV["MONGODB_AVAILABLE"] = 'yes'
+rescue LoadError, Moped::Errors::ConnectionFailure => e
+end
+
+if ENV["MONGODB_AVAILABLE"]
+  puts "Mongoid #{Mongoid::VERSION}", '-'*80
+
+  logger = ::Logger.new(STDERR)
+  logger.formatter = lambda { |s, d, p, m| " #{m.ansi(:faint, :cyan)}\n" }
+  logger.level = ::Logger::DEBUG
+
+  Mongoid.logger = logger unless ENV['QUIET']
+  Moped.logger   = logger unless ENV['QUIET']
+
+  Mongoid.connect_to 'mongoid_articles'
+
+  module Elasticsearch
+    module Model
+      class MongoidBasicIntegrationTest < Elasticsearch::Test::IntegrationTestCase
+
+        class ::MongoidArticle
+          include Mongoid::Document
+          include Elasticsearch::Model
+          include Elasticsearch::Model::Callbacks
+
+          field :id, type: String
+          field :title, type: String
+          attr_accessible :title if respond_to? :attr_accessible
+
+          settings index: { number_of_shards: 1, number_of_replicas: 0 } do
+            mapping do
+              indexes :title,      type: 'string', analyzer: 'snowball'
+              indexes :created_at, type: 'date'
+            end
+          end
+
+          def as_indexed_json(options={})
+            as_json(except: [:id, :_id])
+          end
+        end
+
+        context "Mongoid integration" do
+          setup do
+            Elasticsearch::Model::Adapter.register \
+              Elasticsearch::Model::Adapter::Mongoid,
+              lambda { |klass| !!defined?(::Mongoid::Document) && klass.ancestors.include?(::Mongoid::Document) }
+
+            MongoidArticle.__elasticsearch__.create_index! force: true
+
+            MongoidArticle.delete_all
+
+            MongoidArticle.create! title: 'Test'
+            MongoidArticle.create! title: 'Testing Coding'
+            MongoidArticle.create! title: 'Coding'
+
+            MongoidArticle.__elasticsearch__.refresh_index!
+          end
+
+          should "index and find a document" do
+            response = MongoidArticle.search('title:test')
+
+            assert response.any?
+
+            assert_equal 2, response.results.size
+            assert_equal 2, response.records.size
+
+            assert_instance_of Elasticsearch::Model::Response::Result, response.results.first
+            assert_instance_of MongoidArticle, response.records.first
+
+            assert_equal 'Test', response.results.first.title
+            assert_equal 'Test', response.records.first.title
+          end
+
+          should "iterate over results" do
+            response = MongoidArticle.search('title:test')
+
+            assert_equal ['Test', 'Testing Coding'], response.results.map(&:title)
+            assert_equal ['Test', 'Testing Coding'], response.records.map(&:title)
+          end
+
+          should "access results from records" do
+            response = MongoidArticle.search('title:test')
+
+            response.records.each_with_hit do |r, h|
+              assert_not_nil h._score
+              assert_not_nil h._source.title
+            end
+          end
+
+          should "remove document from index on destroy" do
+            article = MongoidArticle.first
+
+            article.destroy
+            assert_equal 2, MongoidArticle.count
+
+            MongoidArticle.__elasticsearch__.refresh_index!
+
+            response = MongoidArticle.search 'title:test'
+
+            assert_equal 1, response.results.size
+            assert_equal 1, response.records.size
+          end
+
+          should "index updates to the document" do
+            article = MongoidArticle.first
+
+            article.title = 'Writing'
+            article.save
+
+            MongoidArticle.__elasticsearch__.refresh_index!
+
+            response = MongoidArticle.search 'title:write'
+
+            assert_equal 1, response.results.size
+            assert_equal 1, response.records.size
+          end
+
+          should "return results for a DSL search" do
+            response = MongoidArticle.search query: { match: { title: { query: 'test' } } }
+
+            assert_equal 2, response.results.size
+            assert_equal 2, response.records.size
+          end
+
+          should "return a paged collection" do
+            response = MongoidArticle.search query: { match: { title: { query: 'test' } } },
+                                      size: 2,
+                                      from: 1
+
+            assert_equal 1, response.results.size
+            assert_equal 1, response.records.size
+
+            assert_equal 'Testing Coding', response.results.first.title
+            assert_equal 'Testing Coding', response.records.first.title
+          end
+
+
+          context "importing" do
+            setup do
+              MongoidArticle.delete_all
+              97.times { |i| MongoidArticle.create! title: "Test #{i}" }
+              MongoidArticle.__elasticsearch__.create_index! force: true
+            end
+
+            should "import all the documents" do
+              assert_equal 97, MongoidArticle.count
+
+              MongoidArticle.__elasticsearch__.refresh_index!
+              assert_equal 0, MongoidArticle.search('*').results.total
+
+              batches = 0
+              errors  = MongoidArticle.import(batch_size: 10) do |response|
+                batches += 1
+              end
+
+              assert_equal 0, errors
+              assert_equal 10, batches
+
+              MongoidArticle.__elasticsearch__.refresh_index!
+              assert_equal 97, MongoidArticle.search('*').results.total
+
+              response = MongoidArticle.search('test')
+              assert response.results.any?, "Search has not returned results: #{response.to_a}"
+            end
+          end
+        end
+
+      end
+    end
+  end
+
+end