rom-elasticsearch 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 647ee55a0a3fab8ec9b20787922a1b94e4254ed54a9eacff365bfc9516662523
-  data.tar.gz: b522b81b7944c512495062ba3dd6243c7da932ca39b0efbec8935c6027df6fdb
+  metadata.gz: aa9cb00a1c12ce6fe7272e59acb19a5a1cb473b4a31c5fd9355bebd4e3993234
+  data.tar.gz: 2c1338c63fe76a413386fb48c5b7afba3602f8b51b7c8473422c2f9e996966f7
 SHA512:
-  metadata.gz: d717a78441c7777e2871fb177dcafdde2420ba039a358aaa9403d1aa0bad4a9d6e7936e1446f44ce0b4ee5dc7b1c0d92853816a470b3a25c03ebe046c5a6d767
-  data.tar.gz: '0379f5ac4de1ede62a6cf21cd5412595bb18674a537a84672b91f667f1179420fcd9d4a30b3220f413eb6215e0e7abaa55cc2c1487b109a32bf648ea71816346'
+  metadata.gz: 7984f2495ca0645cbbe39a7a34f2b6015f16c1c54c7736f96abda000a0669175b28e6a1ee6eefe89e452c33656f40d785562ccf536bd2938c180a84867bc8f04
+  data.tar.gz: 5f8a73f4038e26f8173739bafa40af575b8599e2318e947943b31d91c21d5b0ea36847f69eb25d094b5202128a81dc8ebb3dac33be64a33ce9ec9c02da435d99

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v0.3.0 2018-03-12
+
+### Added
+
+* Support for multi-index relations via `schema(multi: true)` (solnic)
+* Datasets can be configured to include `_metadata` in resulting tuples (solnic)
+
+[Compare v0.2.1...v0.3.0](https://github.com/rom-rb/rom-elasticsearch/compare/v0.2.1...v0.3.0)
+
 # v0.2.1 2018-02-06
 
 ### Fixed

data/lib/rom/elasticsearch/dataset.rb

@@ -41,10 +41,31 @@ module ROM
       #   @return [Hash] default body
       option :body, default: -> { EMPTY_HASH }
 
+      # @!attribute [r] include_metadata
+      #   @return [Bool]
+      option :include_metadata, default: -> { false }
+
       # @!attribute [r] response
       #   @return [Hash] memoized response from the client
       option :response, optional: true, reader: false
 
+      # @!attribute [r] tuple_proc
+      #   @return [Proc] low-level tuple processing function used in #each
+      attr_reader :tuple_proc
+
+      # default tuple proc which extracts raw source data from response item
+      TUPLE_PROC = -> t { t[SOURCE_KEY] }
+
+      # tuple proc used when :include_metadata is enabled, resulting tuples
+      # will include raw response hash under _metadata key
+      TUPLE_PROC_WITH_METADATA = -> t { TUPLE_PROC[t].merge(_metadata: t) }
+
+      # @api private
+      def initialize(*args)
+        super
+        @tuple_proc = options[:include_metadata] ? TUPLE_PROC_WITH_METADATA : TUPLE_PROC
+      end
+
       # Put new data under configured index
       #
       # @param [Hash] data
@@ -109,9 +130,7 @@ module ROM
       # @api public
       def each
         return to_enum unless block_given?
-        view.each do |result|
-          yield(result[SOURCE_KEY])
-        end
+        view.each { |result| yield(tuple_proc[result]) }
       rescue ::Elasticsearch::Transport::Transport::Error => e
         raise SearchError.new(e, options)
       end

data/lib/rom/elasticsearch/gateway.rb

@@ -4,6 +4,7 @@ require 'uri'
 require 'rom/gateway'
 require 'rom/support/inflector'
 require 'rom/elasticsearch/dataset'
+require 'rom/elasticsearch/index_name'
 
 module ROM
   module Elasticsearch
@@ -73,7 +74,8 @@ module ROM
       #
       # @api public
       def dataset(index)
-        Dataset.new(client, params: { index: index, type: Inflector.singularize(index).to_sym })
+        idx_name = IndexName[index]
+        Dataset.new(client, params: { index: idx_name.to_sym, type: idx_name.type })
       end
       alias_method :[], :dataset
     end

data/lib/rom/elasticsearch/index_name.rb

@@ -0,0 +1,40 @@
+require 'rom/support/inflector'
+
+module ROM
+  module Elasticsearch
+    # @api private
+    class IndexName
+      # @api private
+      attr_reader :name
+
+      # @api private
+      attr_reader :types
+
+      def self.[](name, types = nil)
+        if name.is_a?(self)
+          name
+        else
+          new(name, types)
+        end
+      end
+
+      # @api private
+      def initialize(name, types = nil)
+        @name = name
+        @types = types
+        freeze
+      end
+
+      # @api private
+      def type
+        types ? Array(types).join(',') : Inflector.singularize(name).to_sym
+      end
+
+      # @api private
+      def to_sym
+        name
+      end
+    end
+
+  end
+end

data/lib/rom/elasticsearch/relation.rb

@@ -1,4 +1,6 @@
 require 'rom/relation'
+
+require 'rom/elasticsearch/index_name'
 require 'rom/elasticsearch/relation/loaded'
 require 'rom/elasticsearch/types'
 require 'rom/elasticsearch/schema'
@@ -90,6 +92,25 @@ module ROM
       #     @param [Hash] index_settings_hash
       defines :index_settings
 
+      # @!method self.multi_index_types
+      #   Manage index types for multi-index search
+      #
+      #   @overload multi_index_types
+      #     @return [Array<Symbol>] a list of index types
+      #
+      #   @overload multi_index_types(types)
+      #     @return [Array<Symbol>] a list of index types
+      #
+      #     @example
+      #       class Search < ROM::Relation[:elasticsearch]
+      #         multi_index_types :pages, :posts
+      #
+      #         schema(multi: true) do
+      #           # define your schema
+      #         end
+      #       end
+      defines :multi_index_types
+
       schema_class Elasticsearch::Schema
       schema_attr_class Elasticsearch::Attribute
 
@@ -120,6 +141,17 @@ module ROM
           } }.freeze
       )
 
+      # Define a schema for the relation
+      #
+      # @return [self]
+      def self.schema(dataset = nil, multi: false, **opts, &block)
+        if multi
+          super(IndexName[:_all, multi_index_types], **opts, &block)
+        else
+          super(dataset, **opts, &block)
+        end
+      end
+
       # Load a relation
       #
       # @return [Loaded]
@@ -286,7 +318,7 @@ module ROM
       #
       # @api private
       def index_params
-        { index: name.dataset,
+        { index: name.dataset.to_sym,
           body: {
             settings: self.class.index_settings,
             mappings: { dataset.type => { properties: schema.to_properties } } } }

data/lib/rom/elasticsearch/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module Elasticsearch
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

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

@@ -0,0 +1,60 @@
+RSpec.describe ROM::Elasticsearch::Relation, '.schema' do
+  subject(:relation) { relations[:search] }
+
+  include_context 'setup'
+
+  let(:posts) { relations[:posts] }
+  let(:pages) { relations[:pages] }
+
+  before do
+    conf.relation(:posts) do
+      schema(:posts) do
+        attribute :id, ROM::Elasticsearch::Types::ID
+        attribute :title, ROM::Elasticsearch::Types.Text
+      end
+    end
+
+    conf.relation(:pages) do
+      schema(:pages) do
+        attribute :id, ROM::Elasticsearch::Types::ID
+        attribute :title, ROM::Elasticsearch::Types.Text
+      end
+    end
+
+    conf.relation(:search) do
+      multi_index_types %i[post page]
+
+      schema(multi: true) do
+        attribute :id, ROM::Elasticsearch::Types::ID
+        attribute :title, ROM::Elasticsearch::Types.Text
+      end
+    end
+
+    posts.create_index
+    pages.create_index
+  end
+
+  after do
+    posts.delete_index
+    pages.delete_index
+  end
+
+  it 'search through specified indices' do
+    posts.command(:create).call(id: 1, title: 'Post 1')
+    posts.command(:create).call(id: 2, title: 'Post 2')
+
+    pages.command(:create).call(id: 1, title: 'Page 1')
+    pages.command(:create).call(id: 2, title: 'Page 2')
+
+    posts.refresh
+    pages.refresh
+
+    result = relation.query(match: { title: 'Post'})
+
+    expect(result.to_a).to eql([{ id: 1, title: 'Post 1'}, { id: 2, title: 'Post 2'}])
+
+    result = relation.query(match: { title: '1'})
+
+    expect(result.to_a).to eql([{ id: 1, title: 'Page 1'}, { id: 1, title: 'Post 1'}])
+  end
+end

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

@@ -23,4 +23,29 @@ RSpec.describe ROM::Elasticsearch::Relation, '#dataset' do
       expect(relation.dataset.type).to eql(:user)
     end
   end
+
+  context 'overridding default dataset object' do
+    let(:users) { relations[:users] }
+
+    before do
+      conf.relation(:users) do
+        dataset do
+          with(include_metadata: true)
+        end
+
+        schema do
+          attribute :id, ROM::Types::Int
+          attribute :name, ROM::Types::String
+          attribute :_metadata, ROM::Types::Hash.symbolized(_index: 'string')
+        end
+      end
+
+      users.create_index
+      users.command(:create).call(id: 1, name: 'Jane')
+    end
+
+    it 'uses customized dataset' do
+      expect(relation.to_a).to eql([{ id: 1, name: 'Jane', _metadata: { _index: 'users' } }])
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rom-elasticsearch
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Hannes Nevalainen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rom-core
@@ -108,6 +108,7 @@ files:
 - lib/rom/elasticsearch/dataset.rb
 - lib/rom/elasticsearch/errors.rb
 - lib/rom/elasticsearch/gateway.rb
+- lib/rom/elasticsearch/index_name.rb
 - lib/rom/elasticsearch/plugins/relation/query_dsl.rb
 - lib/rom/elasticsearch/query_methods.rb
 - lib/rom/elasticsearch/relation.rb
@@ -117,6 +118,7 @@ files:
 - lib/rom/elasticsearch/version.rb
 - rom-elasticsearch.gemspec
 - spec/integration/rom/elasticsearch/relation/command_spec.rb
+- spec/integration/rom/elasticsearch/relation/multi_index_spec.rb
 - spec/integration/rom/elasticsearch/relation/schema_spec.rb
 - spec/shared/setup.rb
 - spec/shared/unit/user_fixtures.rb
@@ -169,6 +171,7 @@ specification_version: 4
 summary: ROM adapter for Elasticsearch
 test_files:
 - spec/integration/rom/elasticsearch/relation/command_spec.rb
+- spec/integration/rom/elasticsearch/relation/multi_index_spec.rb
 - spec/integration/rom/elasticsearch/relation/schema_spec.rb
 - spec/shared/setup.rb
 - spec/shared/unit/user_fixtures.rb