es-elasticity 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34c481f8fef0f48b348e3c487aea2f38992fd83f
-  data.tar.gz: 9fce147cb9df7c2ae369d795dc4d31a6777ce2a4
+  metadata.gz: fe85514d61fcf6a3e0fe8154a2bcf9abf13efae4
+  data.tar.gz: aa8fb32667cbf72c30ee881c906b24908cb369cf
 SHA512:
-  metadata.gz: 2b2f8782e944c7adfcd11023829d0031657bc669945f65794e04cbd6389f6043569dd06d776e1b39b9589b227f5d1a653c8b594e9f92e6a6ec471c6bd605d1f5
-  data.tar.gz: 5c7abac9d356d50d60617231fef6ccc7746be8106aa3ad356b49873143f2ccd6815e568334f8c118fe5229339089f27778d0bc51022c696a9159ca062c284bc9
+  metadata.gz: b2c0f4c966b6ea8aa54946901fc99c27498b73af2b00388dd6a2b098aec6f88c79e1cb140ac5f0f3af36d025bc85b9b0a6d2f0c8d7c6730a4802a13f876df321
+  data.tar.gz: 266c4a46686ed27aa7cbb8eee58cb128f193c41f30612036e541c5a14f1feba659dd080c13c62fb083d126920208efbdd5d127eb5aaf3e2ad4b33c53b34c14e5

data/CHANGELOG

@@ -1,3 +1,12 @@
+v0.6.0
+	- Change documents to be able to define indexes with multiple doc types.  A
+	Document class can define subclasses which are of different doc_types and
+	all live in the same index's mappings.
+	- updated search queries to pass either a list of document types or a single
+	document type.
+	- Update documents to generate a default document_type from the class name
+	so that Documents always have a document type. You'll still usually want to
+	manually define the document type, but it's no longer necessary.
 v0.5.2
   - Add aggregations to multi_search
 v0.5.1

data/lib/elasticity/base_document.rb

@@ -8,7 +8,7 @@ module Elasticity
     # Configure the given klass, changing default parameters and resetting
     # some of the internal state.
     def self.configure(&block)
-      self.config = IndexConfig.new(Elasticity.config, &block)
+      self.config = IndexConfig.new(Elasticity.config, self.name.underscore, &block)
     end
 
     # Define common attributes for all documents

data/lib/elasticity/index_config.rb

@@ -1,9 +1,12 @@
 module Elasticity
   class IndexConfig
-    ATTRS = [:index_base_name, :document_type, :mapping, :strategy].freeze
+    ATTRS = [:index_base_name, :document_type, :mapping, :strategy, :subclasses].freeze
+    VALIDATABLE_ATTRS = [:index_base_name, :document_type, :strategy].freeze
+
     attr_accessor *ATTRS
 
-    def initialize(elasticity_config)
+    def initialize(elasticity_config, default_document_type)
+      @document_type = default_document_type
       @elasticity_config = elasticity_config
       yield(self)
       validate!
@@ -20,7 +23,16 @@ module Elasticity
     end
 
     def definition
-      { settings: @elasticity_config.settings, mappings: { @document_type => @mapping } }
+      return @definition if defined?(@definition)
+      @definition = { settings: @elasticity_config.settings, mappings: { @document_type => @mapping || {} } }
+      subclasses.each do |doc_type, subclass|
+        @definition[:mappings][doc_type] = subclass.constantize.mapping
+      end if subclasses.present?
+      @definition
+    end
+
+    def document_types
+      @document_types ||= definition[:mappings].collect { |doc_type, mapping| doc_type }
     end
 
     def fq_index_base_name
@@ -42,7 +54,7 @@ module Elasticity
     private
 
     def validate!
-      ATTRS.each do |attr|
+      VALIDATABLE_ATTRS.each do |attr|
         raise "#{attr} is not set" if public_send(attr).nil?
       end
     end

data/lib/elasticity/index_mapper.rb

@@ -32,6 +32,7 @@ module Elasticity
 
     delegate(
       :document_type,
+      :document_types,
       :mapping,
       :ref_index_name,
       to: :@index_config
@@ -82,7 +83,7 @@ module Elasticity
     # structure Elasticsearch expects.
     # Returns a DocumentSearch object.
     def search(body)
-      search_obj = Search.build(@index_config.client, @strategy.search_index, document_type, body)
+      search_obj = Search.build(@index_config.client, @strategy.search_index, document_types, body)
       Search::DocumentProxy.new(search_obj, self.method(:map_hit))
     end
 
@@ -152,8 +153,11 @@ module Elasticity
 
         highlighted = @document_klass.new(highlighted_attrs)
       end
-
-      @document_klass.new(attrs.merge(highlighted: highlighted))
+      if @document_klass.config.subclasses.present?
+        @document_klass.config.subclasses[hit["_type"].to_sym].constantize.new(attrs.merge(highlighted: highlighted))
+      else
+        @document_klass.new(attrs.merge(highlighted: highlighted))
+      end
     end
   end
 end

data/lib/elasticity/search.rb

@@ -1,38 +1,38 @@
 module Elasticity
   module Search
-    def self.build(client, index_name, document_type, body)
-      search_def = Search::Definition.new(index_name, document_type, body)
+    def self.build(client, index_name, document_types, body)
+      search_def = Search::Definition.new(index_name, document_types, body)
       Search::Facade.new(client, search_def)
     end
 
     # Elasticity::Search::Definition is a struct that encapsulates all the data specific to one
     # ElasticSearch search.
     class Definition
-      attr_accessor :index_name, :document_type, :body
+      attr_accessor :index_name, :document_types, :body
 
-      def initialize(index_name, document_type, body)
+      def initialize(index_name, document_types, body)
         @index_name    = index_name
-        @document_type = document_type
+        @document_types = document_types
         @body          = body.deep_symbolize_keys!
       end
 
       def update(body_changes)
-        self.class.new(@index_name, @document_type, @body.deep_merge(body_changes))
+        self.class.new(@index_name, @document_types, @body.deep_merge(body_changes))
       end
 
       def to_count_args
-        { index: @index_name, type: @document_type}.tap do |args|
+        { index: @index_name, type: @document_types}.tap do |args|
           body = @body.slice(:query)
           args[:body] = body if body.present?
         end
       end
 
       def to_search_args
-        { index: @index_name, type: @document_type, body: @body }
+        { index: @index_name, type: @document_types, body: @body }
       end
 
       def to_msearch_args
-        { index: @index_name, type: @document_type, search: @body }
+        { index: @index_name, type: @document_types, search: @body }
       end
     end
 

data/lib/elasticity/version.rb

@@ -1,3 +1,3 @@
 module Elasticity
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/spec/functional/persistence_spec.rb

@@ -2,6 +2,10 @@ RSpec.describe "Persistence", elasticsearch: true do
   describe "single index strategy" do
     subject do
       Class.new(Elasticity::Document) do
+        def self.name
+          'SomeClass'
+        end
+
         configure do |c|
           c.index_base_name = "users"
           c.document_type   = "user"
@@ -66,9 +70,93 @@ RSpec.describe "Persistence", elasticsearch: true do
     end
   end
 
+  describe 'multi mapping index' do
+    class Animal < Elasticity::Document
+      configure do |c|
+        c.index_base_name = "cats_and_dogs"
+        c.strategy = Elasticity::Strategies::SingleIndex
+        c.subclasses = { cat: "Cat", dog: "Dog" }
+      end
+    end
+
+    class Cat < Animal
+      configure do |c|
+        c.index_base_name = "cats_and_dogs"
+        c.strategy = Elasticity::Strategies::SingleIndex
+        c.document_type  = "cat"
+        c.mapping = { properties: {
+          name: { type: "string" },
+          age: { type: "integer" }
+        } }
+      end
+
+      attr_accessor :name, :age
+
+      def to_document
+        { name: name, age: age }
+      end
+    end
+
+    class Dog < Animal
+      configure do |c|
+        c.index_base_name = "cats_and_dogs"
+        c.strategy = Elasticity::Strategies::SingleIndex
+        c.document_type = "dog"
+        c.mapping = { properties: {
+          name: { type: "string" },
+          age: { type: "integer" },
+          hungry: { type: "boolean" }
+        } }
+      end
+      attr_accessor :name, :age, :hungry
+
+      def to_document
+        { name: name, age: age, hungry: hungry }
+      end
+    end
+
+    before do
+      Animal.recreate_index
+      @elastic_search_client.cluster.health wait_for_status: 'yellow'
+    end
+
+    it "successful index, update, search, count and deletes" do
+      cat = Cat.new(name: "felix", age: 10)
+      dog = Dog.new(name: "fido", age: 4, hungry: true)
+
+      cat.update
+      dog.update
+
+      Animal.flush_index
+
+      results = Animal.search({})
+      expect(results.total).to eq 2
+      expect(results.map(&:class)).to include(Cat, Dog)
+
+      results = Cat.search({})
+      expect(results.total).to eq 1
+      expect(results.first.class).to eq Cat
+
+      results = Dog.search({})
+      expect(results.total).to eq 1
+      expect(results.first.class).to eq Dog
+
+      cat.delete
+      Animal.flush_index
+
+      results = Animal.search({})
+      expect(results.total).to eq 1
+      expect(results.map(&:class)).to include(Dog)
+    end
+  end
+
   describe "alias index strategy" do
     subject do
       Class.new(Elasticity::Document) do
+        def self.name
+          "SomeClass"
+        end
+
         configure do |c|
           c.index_base_name = "users"
           c.document_type   = "user"

data/spec/functional/segmented_spec.rb

@@ -1,6 +1,10 @@
 RSpec.describe "Segmented indexes", elasticsearch: true do
   subject do
     Class.new(Elasticity::SegmentedDocument) do
+      def self.name
+        "SomeClass"
+      end
+
       configure do |c|
         c.index_base_name = "people"
         c.document_type = "person"

data/spec/units/document_spec.rb

@@ -16,6 +16,10 @@ RSpec.describe Elasticity::Document do
 
   let :klass do
     Class.new(described_class) do
+      def self.name
+        "SomeClass"
+      end
+
       configure do |c|
         c.index_base_name = "class_names"
         c.document_type   = "class_name"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: es-elasticity
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Rodrigo Kochenburger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -230,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: ActiveModel-based library for working with Elasticsearch
@@ -243,3 +243,4 @@ test_files:
 - spec/units/multi_search_spec.rb
 - spec/units/search_spec.rb
 - spec/units/strategies/single_index_spec.rb
+has_rdoc: