elasticsearch-persistence 0.0.0 → 0.0.1

data/test/integration/repository/customized_class_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Persistence
+    class RepositoryCustomizedClassIntegrationTest < Elasticsearch::Test::IntegrationTestCase
+
+      module ::My
+        class Note
+          attr_reader :attributes
+
+          def initialize(attributes={})
+            @attributes = attributes
+          end
+
+          def to_hash
+            @attributes
+          end
+        end
+      end
+
+      context "A custom repository class" do
+        setup do
+          @repository = Elasticsearch::Persistence::Repository.new do
+            index 'my_notes'
+            type  'my_note'
+            klass My::Note
+
+            settings number_of_shards: 1 do
+              mapping do
+                indexes :title, analyzer: 'snowball'
+              end
+            end
+
+            create_index!
+          end
+
+          @repository.client.cluster.health wait_for_status: 'yellow'
+        end
+
+        should "save the object under a correct index and type" do
+          @repository.save My::Note.new(id: '1', title: 'Test')
+
+          assert_instance_of My::Note, @repository.find(1)
+          assert_not_nil Elasticsearch::Persistence.client.get index: 'my_notes', type: 'my_note', id: '1'
+        end
+
+        should "update the document" do
+          @repository.save Note.new(id: 1, title: 'Test')
+
+          @repository.update 1, doc: { title: 'UPDATED' }
+          assert_equal 'UPDATED', @repository.find(1).attributes['title']
+        end
+
+        should "update the document with a script" do
+          @repository.save Note.new(id: 1, title: 'Test')
+
+          @repository.update 1, script: 'ctx._source.title = "UPDATED"'
+          assert_equal 'UPDATED', @repository.find(1).attributes['title']
+        end
+
+        should "delete the object" do
+          note = My::Note.new id: 1, title: 'Test'
+          @repository.save note
+
+          assert_not_nil @repository.find(1)
+
+          @repository.delete(note)
+          assert_raise(Elasticsearch::Persistence::Repository::DocumentNotFound) { @repository.find(1) }
+        end
+
+        should "create the index with correct mapping" do
+          note = My::Note.new title: 'Testing'
+          @repository.save note, refresh: true
+
+          results = @repository.search query: { match: { title: 'Test' } }
+          assert_equal 'Testing', results.first.attributes['title']
+        end
+      end
+
+    end
+  end
+end

data/test/integration/repository/default_class_test.rb

@@ -0,0 +1,108 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Persistence
+    class RepositoryDefaultClassIntegrationTest < Elasticsearch::Test::IntegrationTestCase
+
+      class ::Note
+        attr_reader :attributes
+
+        def initialize(attributes={})
+          @attributes = attributes
+        end
+
+        def to_hash
+          @attributes
+        end
+      end
+
+      context "The default repository class" do
+        setup do
+          @repository = Elasticsearch::Persistence::Repository.new
+          @repository.client.cluster.health wait_for_status: 'yellow'
+        end
+
+        should "save the object with a custom ID and find it" do
+          @repository.save Note.new(id: '1', title: 'Test')
+
+          assert_equal 'Test', @repository.find(1).attributes['title']
+        end
+
+        should "save the object with an auto-generated ID and find it" do
+          response = @repository.save Note.new(title: 'Test')
+
+          assert_equal 'Test', @repository.find(response['_id']).attributes['title']
+        end
+
+        should "update the document" do
+          @repository.save Note.new(id: 1, title: 'Test')
+
+          @repository.update 1, type: 'note', doc: { title: 'UPDATED' }
+          assert_equal 'UPDATED', @repository.find(1).attributes['title']
+        end
+
+        should "update the document with a script" do
+          @repository.save Note.new(id: 1, title: 'Test')
+
+          @repository.update 1, type: 'note', script: 'ctx._source.title = "UPDATED"'
+          assert_equal 'UPDATED', @repository.find(1).attributes['title']
+        end
+
+        should "save the document with an upsert" do
+          @repository.update 1, type: 'note', script: 'ctx._source.clicks += 1', upsert: { clicks: 1 }
+          assert_equal 1, @repository.find(1).attributes['clicks']
+        end
+
+        should "delete an object" do
+          note = Note.new(id: '1', title: 'Test')
+
+          @repository.save(note)
+          assert_not_nil @repository.find(1)
+          @repository.delete(note)
+          assert_raise(Elasticsearch::Persistence::Repository::DocumentNotFound) { @repository.find(1) }
+        end
+
+        should "find multiple objects" do
+          (1..5).each { |i| @repository.save Note.new(id: i, title: "Test #{i}") }
+
+          assert_equal 5, @repository.find(1, 2, 3, 4, 5).size
+          assert_equal 5, @repository.find([1, 2, 3, 4, 5]).size
+        end
+
+        should "pass options to save and find" do
+          note = Note.new(id: '1', title: 'Test')
+          @repository.save note, routing: 'ABC'
+
+          assert_raise Elasticsearch::Persistence::Repository::DocumentNotFound do
+            @repository.find(1, routing: 'DEF')
+          end
+
+          assert_nothing_raised do
+            note = @repository.find(1, routing: 'ABC')
+            assert_instance_of Note, note
+          end
+        end
+
+        should "find notes with full text search" do
+          @repository.save Note.new(title: 'Test')
+          @repository.save Note.new(title: 'Test Test')
+          @repository.save Note.new(title: 'Crust')
+          @repository.client.indices.refresh index: @repository.index_name
+
+          results = @repository.search 'test'
+          assert_equal 2, results.size
+
+          results = @repository.search query: { match: { title: 'Test' } }
+          assert_equal 2, results.size
+        end
+
+        should "save and find a plain hash" do
+          @repository.save id: 1, title: 'Hash'
+          result = @repository.find(1)
+          assert_equal 'Hash', result['_source']['title']
+        end
+      end
+
+    end
+  end
+end

data/test/integration/repository/virtus_model_test.rb

@@ -0,0 +1,114 @@
+require 'test_helper'
+
+require 'virtus'
+
+module Elasticsearch
+  module Persistence
+    class RepositoryWithVirtusIntegrationTest < Elasticsearch::Test::IntegrationTestCase
+
+      class ::Page
+        include Virtus.model
+
+        attribute :id,        String, writer: :private
+        attribute :title,     String
+        attribute :views,     Integer, default: 0
+        attribute :published, Boolean, default: false
+        attribute :slug,      String,  default: lambda { |page, attr| page.title.downcase.gsub(' ', '-') }
+
+        def set_id(id)
+          self.id = id
+        end
+      end
+
+      context "The repository with a Virtus model" do
+        setup do
+          @repository = Elasticsearch::Persistence::Repository.new do
+            index :pages
+            klass Page
+
+            def deserialize(document)
+              page = klass.new document['_source']
+              page.set_id document['_id']
+              page
+            end
+          end
+        end
+
+        should "save and find the object" do
+          page = Page.new title: 'Test Page'
+
+          response = @repository.save page
+          id = response['_id']
+
+          result = @repository.find(id)
+
+          assert_instance_of Page,  result
+          assert_equal 'Test Page', result.title
+          assert_equal 0,           result.views
+
+          assert_not_nil Elasticsearch::Persistence.client.get index: 'pages',
+                                                               type: 'page',
+                                                               id: id
+        end
+
+        should "update the object with a partial document" do
+          response = @repository.save Page.new(title: 'Test')
+          id = response['_id']
+
+          page = @repository.find(id)
+
+          assert_equal 'Test', page.title
+
+          @repository.update page.id, doc: { title: 'UPDATE' }
+
+          page = @repository.find(id)
+          assert_equal 'UPDATE', page.title
+        end
+
+        should "update the object with a Hash" do
+          response = @repository.save Page.new(title: 'Test')
+          id = response['_id']
+
+          page = @repository.find(id)
+
+          assert_equal 'Test', page.title
+
+          @repository.update id: page.id, title: 'UPDATE'
+
+          page = @repository.find(id)
+          assert_equal 'UPDATE', page.title
+        end
+
+        should "update the object with a script" do
+          response = @repository.save Page.new(title: 'Test Page')
+          id = response['_id']
+
+          page = @repository.find(id)
+
+          assert_not_nil page.id
+          assert_equal 0, page.views
+
+          @repository.update page.id, script: 'ctx._source.views += 1'
+
+          page = @repository.find(id)
+          assert_equal 1, page.views
+
+          @repository.update id: page.id, script: 'ctx._source.views += 1'
+
+          page = @repository.find(id)
+          assert_equal 2, page.views
+        end
+
+        should "update the object with a script and params" do
+          response = @repository.save Page.new(title: 'Test Page')
+
+          @repository.update id: response['_id'], script: 'ctx._source.views += count', params: { count: 3 }
+
+          page = @repository.find(response['_id'])
+          assert_equal 3, page.views
+        end
+      end
+
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,46 @@
+RUBY_1_8 = defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
+
+exit(0) if RUBY_1_8
+
+require 'simplecov' and SimpleCov.start { add_filter "/test|test_/" } if ENV["COVERAGE"]
+
+# Register `at_exit` handler for integration tests shutdown.
+# MUST be called before requiring `test/unit`.
+at_exit { Elasticsearch::Test::IntegrationTestCase.__run_at_exit_hooks } if ENV['SERVER']
+
+require 'test/unit'
+require 'shoulda-context'
+require 'mocha/setup'
+require 'turn' unless ENV["TM_FILEPATH"] || ENV["NOTURN"] || RUBY_1_8
+
+require 'ansi'
+require 'oj'
+
+require 'elasticsearch/extensions/test/cluster'
+require 'elasticsearch/extensions/test/startup_shutdown'
+
+require 'elasticsearch/persistence'
+
+module Elasticsearch
+  module Test
+    class IntegrationTestCase < ::Test::Unit::TestCase
+      extend Elasticsearch::Extensions::Test::StartupShutdown
+
+      startup  { Elasticsearch::Extensions::Test::Cluster.start(nodes: 1) if ENV['SERVER'] and not Elasticsearch::Extensions::Test::Cluster.running? }
+      shutdown { Elasticsearch::Extensions::Test::Cluster.stop if ENV['SERVER'] && started? }
+      context "IntegrationTest" do; should "noop on Ruby 1.8" do; end; end if RUBY_1_8
+
+      def setup
+        tracer = ::Logger.new(STDERR)
+        tracer.formatter = lambda { |s, d, p, m| "#{m.gsub(/^.*$/) { |n| '   ' + n }.ansi(:faint)}\n" }
+        Elasticsearch::Persistence.client = Elasticsearch::Client.new \
+                                              host: "localhost:#{(ENV['TEST_CLUSTER_PORT'] || 9250)}",
+                                              tracer: (ENV['QUIET'] ? nil : tracer)
+      end
+
+      def teardown
+        Elasticsearch::Persistence.client.indices.delete index: '_all'
+      end
+    end
+  end
+end

data/test/unit/persistence_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class Elasticsearch::Persistence::ModuleTest < Test::Unit::TestCase
+  context "The Persistence module" do
+
+    context "client" do
+      should "have a default client" do
+        client = Elasticsearch::Persistence.client
+        assert_not_nil     client
+        assert_instance_of Elasticsearch::Transport::Client, client
+      end
+
+      should "allow to set a client" do
+        begin
+          Elasticsearch::Persistence.client = "Foobar"
+          assert_equal "Foobar", Elasticsearch::Persistence.client
+        ensure
+          Elasticsearch::Persistence.client = nil
+        end
+      end
+
+      should "allow to set a client with DSL" do
+        begin
+          Elasticsearch::Persistence.client "Foobar"
+          assert_equal "Foobar", Elasticsearch::Persistence.client
+        ensure
+          Elasticsearch::Persistence.client = nil
+        end
+      end
+    end
+  end
+end

data/test/unit/repository_class_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+class Elasticsearch::Persistence::RepositoryClassTest < Test::Unit::TestCase
+  context "The default repository class" do
+
+    context "when initialized" do
+      should "be created from the module" do
+        repository = Elasticsearch::Persistence::Repository.new
+        assert_instance_of Elasticsearch::Persistence::Repository::Class, repository
+      end
+
+      should "store and access the options" do
+        repository = Elasticsearch::Persistence::Repository::Class.new foo: 'bar'
+        assert_equal 'bar', repository.options[:foo]
+      end
+
+      should "instance eval a passed block" do
+        $foo = 100
+        repository = Elasticsearch::Persistence::Repository::Class.new() { $foo += 1 }
+        assert_equal 101, $foo
+      end
+
+      should "call a passed block with self" do
+        foo = 100
+        repository = Elasticsearch::Persistence::Repository::Class.new do |r|
+          assert_instance_of Elasticsearch::Persistence::Repository::Class, r
+          foo += 1
+        end
+        assert_equal 101, foo
+      end
+
+      should "configure the index name based on options" do
+        repository = Elasticsearch::Persistence::Repository::Class.new index: 'foobar'
+        assert_equal 'foobar', repository.index_name
+      end
+    end
+
+    should "include the repository methods" do
+      repository = Elasticsearch::Persistence::Repository::Class.new
+
+      %w( index_name  document_type  klass
+          mappings  settings  client  client=
+          create_index!  delete_index!  refresh_index!
+          save  delete  serialize  deserialize
+          exists?  find  search ).each do |method|
+        assert_respond_to repository, method
+      end
+    end
+
+  end
+end

data/test/unit/repository_client_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class Elasticsearch::Persistence::RepositoryClientTest < Test::Unit::TestCase
+  context "The repository client" do
+    setup do
+      @shoulda_subject = Class.new() { include Elasticsearch::Persistence::Repository::Client }.new
+    end
+
+    should "have a default client" do
+      assert_not_nil     subject.client
+      assert_instance_of Elasticsearch::Transport::Client, subject.client
+    end
+
+    should "allow to set a client" do
+      begin
+        subject.client = "Foobar"
+        assert_equal "Foobar", subject.client
+      ensure
+        subject.client = nil
+      end
+    end
+
+    should "allow to set the client with DSL" do
+      begin
+        subject.client "Foobar"
+        assert_equal "Foobar", subject.client
+      ensure
+        subject.client = nil
+      end
+    end
+  end
+end