elasticsearch-model-queryable 0.1.5

data/test/integration/active_record_basic_test.rb

@@ -0,0 +1,179 @@
+require 'test_helper'
+require 'active_record'
+
+puts "ActiveRecord #{ActiveRecord::VERSION::STRING}", '-'*80
+
+module Elasticsearch
+  module Model
+    class ActiveRecordBasicIntegrationTest < Elasticsearch::Test::IntegrationTestCase
+      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
+
+          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
+
+          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 "provide access to result" do
+          response = Article.search query: { match: { title: 'test' } }, highlight: { fields: { title: {} } }
+
+          assert_equal 'Test', response.results.first.title
+
+          assert_equal true,  response.results.first.title?
+          assert_equal false, response.results.first.boo?
+
+          assert_equal true,  response.results.first.highlight?
+          assert_equal true,  response.results.first.highlight.title?
+          assert_equal false, response.results.first.highlight.boo?
+        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 "return _id and _type as #id and #type" do
+          response = Article.search('title:test')
+
+          assert_equal '1',       response.results.first.id
+          assert_equal 'article', response.results.first.type
+        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 "preserve the search results order for records" do
+          response = Article.search('title:code')
+
+          response.records.each_with_hit do |r, h|
+            assert_equal h._id, r.id.to_s
+          end
+
+          response.records.map_with_hit do |r, h|
+            assert_equal h._id, r.id.to_s
+          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
+
+        should "allow dot access to response" do
+          response = Article.search query: { match: { title: { query: 'test' } } },
+                                    aggregations: { dates: { date_histogram: { field: 'created_at', interval: 'hour' } } }
+
+          response.response.respond_to?(:aggregations)
+          assert_equal 2, response.response.aggregations.dates.buckets.first.doc_count
+        end
+      end
+
+    end
+  end
+end

data/test/integration/active_record_custom_serialization_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+require 'active_record'
+
+module Elasticsearch
+  module Model
+    class ActiveRecordCustomSerializationTest < Elasticsearch::Test::IntegrationTestCase
+      context "ActiveRecord model with custom JSON serialization" do
+        setup do
+          class ::ArticleWithCustomSerialization < ActiveRecord::Base
+            include Elasticsearch::Model
+            include Elasticsearch::Model::Callbacks
+
+            mapping do
+              indexes :title
+            end
+
+            def as_indexed_json(options={})
+              # as_json(options.merge root: false).slice('title')
+              { title: self.title }
+            end
+          end
+
+          ActiveRecord::Schema.define(:version => 1) do
+            create_table ArticleWithCustomSerialization.table_name do |t|
+              t.string   :title
+              t.string   :status
+            end
+          end
+
+          ArticleWithCustomSerialization.delete_all
+          ArticleWithCustomSerialization.__elasticsearch__.create_index! force: true
+        end
+
+        should "index only the title attribute when creating" do
+          ArticleWithCustomSerialization.create! title: 'Test', status: 'green'
+
+          a = ArticleWithCustomSerialization.__elasticsearch__.client.get \
+                index: 'article_with_custom_serializations',
+                type:  'article_with_custom_serialization',
+                id:    '1'
+
+          assert_equal( { 'title' => 'Test' }, a['_source'] )
+        end
+
+        should "index only the title attribute when updating" do
+          ArticleWithCustomSerialization.create! title: 'Test', status: 'green'
+
+          article = ArticleWithCustomSerialization.first
+          article.update_attributes title: 'UPDATED', status: 'red'
+
+          a = ArticleWithCustomSerialization.__elasticsearch__.client.get \
+                index: 'article_with_custom_serializations',
+                type:  'article_with_custom_serialization',
+                id:    '1'
+
+          assert_equal( { 'title' => 'UPDATED' }, a['_source'] )
+        end
+      end
+
+    end
+  end
+end

data/test/integration/active_record_import_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+require 'active_record'
+
+module Elasticsearch
+  module Model
+    class ActiveRecordImportIntegrationTest < Elasticsearch::Test::IntegrationTestCase
+      context "ActiveRecord importing" do
+        setup do
+          ActiveRecord::Schema.define(:version => 1) do
+            create_table :import_articles do |t|
+              t.string   :title
+              t.integer  :views
+              t.string   :numeric # For the sake of invalid data sent to Elasticsearch
+              t.datetime :created_at, :default => 'NOW()'
+            end
+          end
+
+          class ::ImportArticle < ActiveRecord::Base
+            include Elasticsearch::Model
+
+            scope :popular, -> { where('views >= 50') }
+
+            mapping do
+              indexes :title,      type: 'string'
+              indexes :views,      type: 'integer'
+              indexes :numeric,    type: 'integer'
+              indexes :created_at, type: 'date'
+            end
+          end
+
+          ImportArticle.delete_all
+          ImportArticle.__elasticsearch__.create_index! force: true
+          ImportArticle.__elasticsearch__.client.cluster.health wait_for_status: 'yellow'
+
+          100.times { |i| ImportArticle.create! title: "Test #{i}", views: 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 "import only documents from a specific scope" do
+          assert_equal 100, ImportArticle.count
+
+          assert_equal 0, ImportArticle.import(scope: 'popular')
+
+          ImportArticle.__elasticsearch__.refresh_index!
+          assert_equal 50, ImportArticle.search('*').results.total
+        end
+
+        should "report and not store/index invalid documents" do
+          ImportArticle.create! title: "Test INVALID", numeric: "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
+
+        should "transform documents with the option" do
+          assert_equal 100, ImportArticle.count
+
+          assert_equal 0, ImportArticle.import( transform: ->(a) {{ index: { data: { name: a.title, foo: 'BAR' } }}} )
+
+          ImportArticle.__elasticsearch__.refresh_index!
+          assert_contains ImportArticle.search('*').results.first._source.keys, 'name'
+          assert_contains ImportArticle.search('*').results.first._source.keys, 'foo'
+          assert_equal 100, ImportArticle.search('test').results.total
+          assert_equal 100, ImportArticle.search('bar').results.total
+        end
+      end
+
+    end
+  end
+end

data/test/integration/active_record_namespaced_model_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+require 'active_record'
+
+module Elasticsearch
+  module Model
+    class ActiveRecordNamespacedModelIntegrationTest < Elasticsearch::Test::IntegrationTestCase
+      context "Namespaced ActiveRecord model integration" do
+        setup do
+          ActiveRecord::Schema.define(:version => 1) do
+            create_table :articles do |t|
+              t.string   :title
+            end
+          end
+
+          module ::MyNamespace
+            class Article < ActiveRecord::Base
+              include Elasticsearch::Model
+              include Elasticsearch::Model::Callbacks
+
+              mapping { indexes :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,132 @@
+require 'test_helper'
+require 'active_record'
+
+module Elasticsearch
+  module Model
+    class ActiveRecordPaginationTest < Elasticsearch::Test::IntegrationTestCase
+      context "ActiveRecord pagination" do
+        setup do
+          class ::ArticleForPagination < ActiveRecord::Base
+            include Elasticsearch::Model
+
+            scope :published, -> { where(published: true) }
+
+            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
+
+          ActiveRecord::Schema.define(:version => 1) do
+            create_table ::ArticleForPagination.table_name do |t|
+              t.string   :title
+              t.datetime :created_at, :default => 'NOW()'
+              t.boolean  :published
+            end
+          end
+
+          Kaminari::Hooks.init
+
+          ArticleForPagination.delete_all
+          ArticleForPagination.__elasticsearch__.create_index! force: true
+
+          68.times do |i|
+            ::ArticleForPagination.create! title: "Test #{i}", published: (i % 2 == 0)
+          end
+
+          ArticleForPagination.import
+          ArticleForPagination.__elasticsearch__.refresh_index!
+        end
+
+        should "be on the first page by default" do
+          records = ArticleForPagination.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 = ArticleForPagination.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 = ArticleForPagination.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 = ArticleForPagination.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
+
+        should "be combined with scopes" do
+          records = ArticleForPagination.search('title:test').page(2).records.published
+          assert records.all? { |r| r.published? }
+          assert_equal 12, records.size
+        end
+
+        should "set the limit per request" do
+          records = ArticleForPagination.search('title:test').limit(50).page(2).records
+
+          assert_equal 18,  records.size
+          assert_equal 2,   records.current_page
+          assert_equal 1,   records.prev_page
+          assert_equal nil, records.next_page
+          assert_equal 2,   records.total_pages
+
+          assert records.last_page?, "Should be the last page"
+        end
+
+        context "with specific model settings" do
+          teardown do
+            ArticleForPagination.instance_variable_set(:@_default_per_page, nil)
+          end
+
+          should "respect paginates_per" do
+            ArticleForPagination.paginates_per 50
+
+            assert_equal 50, ArticleForPagination.search('*').page(1).records.size
+          end
+        end
+      end
+
+    end
+  end
+end