rom-elasticsearch 0.1.0

data/lib/rom/elasticsearch/schema.rb

@@ -0,0 +1,26 @@
+require 'rom/types'
+require 'rom/schema'
+
+module ROM
+  module Elasticsearch
+    # Elasticsearch relation schema
+    #
+    # @api public
+    class Schema < ROM::Schema
+      # Return a hash with mapping properties
+      #
+      # @api private
+      def to_properties
+        select(&:properties?).map { |attr| [attr.name, attr.properties] }.to_h
+      end
+
+      # Customized output hash constructor which symbolizes keys
+      # and optionally applies custom read-type coercions
+      #
+      # @api private
+      def to_output_hash
+        Types::Hash.symbolized(map { |attr| [attr.key, attr.to_read_type] }.to_h)
+      end
+    end
+  end
+end

data/lib/rom/elasticsearch/types.rb

@@ -0,0 +1,33 @@
+require 'rom/types'
+
+module ROM
+  module Elasticsearch
+    # Elasticsearch types use by schema attributes
+    #
+    # @api public
+    module Types
+      include ROM::Types
+
+      # Default integer primary key
+      ID = Int.meta(primary_key: true)
+
+      # Define a keywoard attribute type
+      #
+      # @return [Dry::Types::Type]
+      #
+      # @api public
+      def self.Keyword(meta = {})
+        String.meta(type: "keyword").meta(meta)
+      end
+
+      # Define a keywoard attribute type
+      #
+      # @return [Dry::Types::Type]
+      #
+      # @api public
+      def self.Text(meta = {})
+        String.meta(type: "text").meta(meta)
+      end
+    end
+  end
+end

data/lib/rom/elasticsearch/version.rb

@@ -0,0 +1,5 @@
+module ROM
+  module Elasticsearch
+    VERSION = '0.1.0'.freeze
+  end
+end

data/rom-elasticsearch.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rom/elasticsearch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rom-elasticsearch'
+  spec.version       = ROM::Elasticsearch::VERSION
+  spec.authors       = ['Hannes Nevalainen', 'Piotr Solnica']
+  spec.email         = ['hannes.nevalainen@me.com', 'piotr.solnica+oss@gmail.com']
+  spec.summary       = %q{ROM adapter for Elasticsearch}
+  spec.description   = %q{}
+  spec.homepage      = 'http://rom-rb.org'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency 'rom-core', '~> 4.1'
+  spec.add_runtime_dependency 'elasticsearch', '~> 6.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/spec/integration/rom/elasticsearch/relation/command_spec.rb

@@ -0,0 +1,47 @@
+RSpec.describe ROM::Elasticsearch::Relation, '#command' do
+  subject(:relation) { relations[:users] }
+
+  include_context 'setup'
+
+  before do
+    conf.relation(:users) do
+      schema(:users) do
+        attribute :id,   ROM::Elasticsearch::Types::ID
+        attribute :name, ROM::Types::String
+      end
+    end
+  end
+
+  describe ':create' do
+    it 'returns a create command' do
+      command = relation.command(:create, result: :one)
+
+      expect(command.call(id: 1, name: 'Jane')).to eql(id: 1, name: 'Jane')
+    end
+
+    it 'applies input function' do
+      command = relation.command(:create, result: :one)
+
+      input = double(:user, to_hash: { id: 1, name: 'Jane' })
+
+      expect(command.call(input)).to eql(id: 1, name: 'Jane')
+    end
+  end
+
+  describe ':delete' do
+    before do
+      relation.command(:create).call(id: 1, name: 'Jane')
+      relation.command(:create).call(id: 2, name: 'John')
+
+      relation.refresh
+    end
+
+    it 'deletes matching data' do
+      relation.get(2).command(:delete).call
+
+      relation.refresh
+
+      expect(relation.to_a).to eql([{ id: 1, name: 'Jane' }])
+    end
+  end
+end

data/spec/shared/setup.rb

@@ -0,0 +1,16 @@
+RSpec.shared_context 'setup' do
+  let(:uri) { "http://127.0.0.1:9200" }
+
+  let(:conf) { ROM::Configuration.new(:elasticsearch, uri) }
+  let(:container) { ROM.container(conf) }
+
+  let(:gateway) { conf.gateways[:default] }
+  let(:client) { gateway.client }
+
+  let(:relations) { container[:relations] }
+  let(:commands) { container[:commands] }
+
+  after do
+    client.indices.delete(index: :users) if gateway.index?(:users)
+  end
+end

data/spec/shared/unit/user_fixtures.rb

@@ -0,0 +1,15 @@
+RSpec.shared_context 'user fixtures' do
+  include_context 'setup'
+
+  before do
+    dataset.put(username: 'eve')
+    dataset.put(username: 'bob')
+    dataset.put(username: 'alice')
+
+    dataset.refresh
+  end
+
+  after do
+    gateway[:users].refresh.delete
+  end
+end

data/spec/shared/unit/users.rb

@@ -0,0 +1,18 @@
+RSpec.shared_context 'users' do
+  include_context 'setup'
+
+  before do
+    conf.relation(:users) do
+      schema(:users) do
+        attribute :id, ROM::Types::Int
+        attribute :name, ROM::Types::String
+
+        primary_key :id
+      end
+    end
+  end
+
+  after do
+    gateway[:users].refresh.delete
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'bundler'
+Bundler.setup
+
+if RUBY_ENGINE == 'ruby' && ENV['COVERAGE'] == 'true'
+  require 'yaml'
+  rubies = YAML.load(File.read(File.join(__dir__, '..', '.travis.yml')))['rvm']
+  latest_mri = rubies.select { |v| v =~ /\A\d+\.\d+.\d+\z/ }.max
+
+  if RUBY_VERSION == latest_mri
+    require 'simplecov'
+    SimpleCov.start do
+      add_filter '/spec/'
+    end
+  end
+end
+
+begin
+  require 'pry-byebug'
+rescue LoadError
+  require 'pry'
+end
+
+require 'rom-elasticsearch'
+
+SPEC_ROOT = Pathname(__FILE__).dirname
+
+Dir[SPEC_ROOT.join('shared/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+
+  # elasticsearch-dsl warnings are killing me - solnic
+  config.warnings = false
+
+  config.before do
+    module Test
+    end
+  end
+
+  config.after do
+    Object.send(:remove_const, :Test)
+  end
+end

data/spec/unit/rom/elasticsearch/dataset/body_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe ROM::Elasticsearch::Dataset, '#body' do
+  subject(:dataset) do
+    ROM::Elasticsearch::Dataset.new(client, params: { index: :users, type: :user })
+  end
+
+  include_context 'user fixtures'
+
+  it 'returns a new dataset with updated body' do
+    new_ds = dataset.body(id: 1)
+
+    expect(new_ds.body).to eql(id: 1)
+  end
+end

data/spec/unit/rom/elasticsearch/dataset/delete_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe ROM::Elasticsearch::Dataset, '#delete' do
+  subject(:dataset) do
+    ROM::Elasticsearch::Dataset.new(client, params: { index: :users, type: :user })
+  end
+
+  include_context 'user fixtures'
+
+  it 'deletes data' do
+    expect(dataset.to_a.size).to eql(3)
+
+    dataset.refresh.delete
+
+    dataset.refresh
+
+    expect(dataset.to_a.size).to eql(0)
+  end
+end

data/spec/unit/rom/elasticsearch/dataset/params_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe ROM::Elasticsearch::Dataset, '#params' do
+  subject(:dataset) do
+    ROM::Elasticsearch::Dataset.new(client, params: { index: :users, type: :user })
+  end
+
+  include_context 'user fixtures'
+
+  it 'returns a new dataset with updated params' do
+    new_ds = dataset.params(size: 100)
+
+    expect(new_ds.params).to eql(size: 100, index: :users, type: :user)
+  end
+end

data/spec/unit/rom/elasticsearch/dataset/put_spec.rb

@@ -0,0 +1,14 @@
+RSpec.describe ROM::Elasticsearch::Dataset, '#put' do
+  subject(:dataset) do
+    ROM::Elasticsearch::Dataset.new(client, params: { index: :users, type: :user })
+  end
+
+  include_context 'setup'
+
+  it 'puts new data' do
+    result = dataset.put(username: 'eve')
+
+    expect(result['_id']).to_not be(nil)
+    expect(result['result']).to eql('created')
+  end
+end

data/spec/unit/rom/elasticsearch/dataset/query_string_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe ROM::Elasticsearch::Dataset, '#query_string' do
+  subject(:dataset) do
+    ROM::Elasticsearch::Dataset.new(client, params: { index: :users, type: :user })
+  end
+
+  include_context 'user fixtures'
+
+  it 'returns data matching query string' do
+    expect(dataset.query_string('username:alice').to_a).to eql([{'username' => 'alice'}])
+    expect(dataset.query_string('username:nisse').to_a).to eql([])
+  end
+end

data/spec/unit/rom/elasticsearch/dataset/search_spec.rb

@@ -0,0 +1,20 @@
+RSpec.describe ROM::Elasticsearch::Dataset, '#search' do
+  subject(:dataset) do
+    ROM::Elasticsearch::Dataset.new(client, params: { index: :users, type: :user })
+  end
+
+  include_context 'setup'
+
+  before do
+    dataset.put(username: 'eve')
+    dataset.put(username: 'bob')
+    dataset.put(username: 'alice')
+
+    dataset.refresh
+  end
+
+  it 'returns data matching query options' do
+    expect(dataset.search(query: {query_string: {query: 'username:eve'}}).to_a).
+      to eql([{'username' => 'eve'}])
+  end
+end

data/spec/unit/rom/elasticsearch/gateway_spec.rb

@@ -0,0 +1,10 @@
+require 'rom/lint/spec'
+
+RSpec.describe ROM::Elasticsearch::Gateway do
+  let(:uri) { 'http://localhost:9200/rom-test' }
+
+  it_behaves_like 'a rom gateway' do
+    let(:identifier) { :elasticsearch }
+    let(:gateway) { ROM::Elasticsearch::Gateway }
+  end
+end

data/spec/unit/rom/elasticsearch/plugins/relation/query_dsl_spec.rb

@@ -0,0 +1,34 @@
+require 'rom/elasticsearch/plugins/relation/query_dsl'
+require 'rom/elasticsearch/relation'
+
+RSpec.describe ROM::Elasticsearch::Relation, '#search' do
+  subject(:relation) { relations[:users] }
+
+  include_context 'setup'
+
+  before do
+    conf.relation(:users) do
+      schema do
+        attribute :id, ROM::Types::Int.meta(type: "integer")
+        attribute :name, ROM::Types::Int.meta(type: "text")
+      end
+
+      use :query_dsl
+    end
+
+    relation.command(:create).(id: 1, name: 'Jane')
+    relation.command(:create).(id: 2, name: 'John')
+
+    relation.refresh
+  end
+
+  it 'builds a query using a block-based DSL' do
+    result = relation.search do
+      query do
+        match name: 'Jane'
+      end
+    end
+
+    expect(result.to_a).to eql([{ id: 1, name: 'Jane' }])
+  end
+end

data/spec/unit/rom/elasticsearch/relation/create_index_spec.rb

@@ -0,0 +1,75 @@
+require 'rom/elasticsearch/relation'
+
+RSpec.describe ROM::Elasticsearch::Relation, '#create_index' do
+  subject(:relation) { relations[:users] }
+
+  include_context 'setup'
+
+  context 'when custom :index is configured' do
+    after do
+      relation.delete_index
+    end
+
+    context 'with default settings' do
+      before do
+        conf.relation(:users) do
+          schema do
+            attribute :id, ROM::Elasticsearch::Types::ID
+            attribute :name, ROM::Types::String
+          end
+        end
+      end
+
+      it 'creates an index' do
+        relation.create_index
+
+        expect(gateway.index?(:users)).to be(true)
+      end
+    end
+
+    context 'with customized settings' do
+      before do
+        conf.relation(:users) do
+          schema do
+            attribute :id, ROM::Types::Int
+            attribute :name, ROM::Types::String
+          end
+
+          index_settings number_of_shards: 2
+        end
+      end
+
+      it 'creates an index' do
+        relation.create_index
+
+        expect(gateway.index?(:users)).to be(true)
+        expect(relation.dataset.settings['number_of_shards']).to eql("2")
+      end
+    end
+
+    context 'with customized attribute mappings' do
+      before do
+        conf.relation(:users) do
+          schema do
+            attribute :id, ROM::Elasticsearch::Types::ID
+            attribute :name, ROM::Elasticsearch::Types.Keyword
+            attribute :desc, ROM::Elasticsearch::Types.Text(analyzer: "snowball")
+          end
+
+          index_settings number_of_shards: 2
+        end
+      end
+
+      it 'creates an index' do
+        relation.create_index
+
+        expect(gateway.index?(:users)).to be(true)
+
+        expect(relation.dataset.mappings).
+          to eql("properties" => {
+                   "name" => { "type" => "keyword" },
+                   "desc" => { "type" => "text", "analyzer" => "snowball" }})
+      end
+    end
+  end
+end