elastic_mapper 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ef34e64a60623b87c60e8477416604d19138a10
-  data.tar.gz: b55837db1a514c41e356618b1e2681115e08a8fa
+  metadata.gz: 543ec27590a91159027e57f2ebd0f688608982eb
+  data.tar.gz: 6eed8ee0decba2a9bbc29dd013871c1e0065891e
 SHA512:
-  metadata.gz: 1c9bdd0df778f890e22fe167a7eb5c4239ab7cf55e4910bd3661da841c96cb346bef64b633409b178b9b6eea961c70e035af937b905b4bff4c133160df73abf7
-  data.tar.gz: 91ecda07f660e90de9f2f2ab9819154a1f9189b78a8ab25a81e76d14d84ab70d765017d32fe0cbb90bb5493f4cc6ff8c15de0d6383c7c57e5f5a31103e633fbe
+  metadata.gz: a97cdb65e03a481197863a51bb3e471a9fb1af8c63349e0b808e2f73f106ca59e9913c7f9d48eafd7218a2bf68aec8781a32c15eb82561fbcf2e339f7d1e4796
+  data.tar.gz: 3909b4389855d275a7db70aa0ff18232f1e48d6a64dab918c6e9db52f707804ae2bd66821b4b5551ef80566be346ac2a17cfbdaa20ecd55d2f51a789baddc8c1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    elastic_mapper (0.2.1)
+    elastic_mapper (0.3.0)
       faraday (~> 0.8.9)
       stretcher
 
@@ -26,7 +26,7 @@ GEM
     faraday_middleware-multi_json (0.0.6)
       faraday_middleware
       multi_json
-    hashie (2.1.1)
+    hashie (3.3.1)
     i18n (0.6.9)
     json (1.8.1)
     minitest (5.3.4)

data/README.md

@@ -118,6 +118,27 @@ articles = Article.search({ "query_string" => { "query" => 'alpha' } })
 results = SearchModel.search('* OR alpha', size: 10, from: 10)
 ```
 
+Searching Across Multiple Models
+--------------------------------
+
+Suppose you have two mappings in ElasticSearch, for instance an `article` and
+a `user`. There are times when you might want to search across both models
+at the same time.
+
+This can be facilitated with ElasticMapper's `MultiSearch` class:
+
+```ruby
+multi = ElasticMapper::MultiSearch.new({
+	index_models: SearchModel,
+	index_models_two: SearchModelTwo
+})
+
+results = multi.search('* OR alpha', size: 1)
+```
+
+* a multi-search instance accepts a hash into the constructor, which maps ElasticSearch mappings to model classes.
+* once you have a `MultiSearch` instance, search works the same as it does when using the ActiveModel mixin.
+
 That's It
 ---------
 

data/lib/elastic_mapper.rb

@@ -4,6 +4,7 @@ require "elastic_mapper/version"
 require "elastic_mapper/mapping"
 require "elastic_mapper/index"
 require "elastic_mapper/search"
+require "elastic_mapper/multi_search"
 
 module ElasticMapper
 

data/lib/elastic_mapper/multi_search.rb

@@ -0,0 +1,35 @@
+# search across multiple models at the same
+# time. NO WAY!
+class ElasticMapper::MultiSearch
+
+  # takes a hash lookup which maps from
+  # a mapping name on to an ActiveRecord model.
+  def initialize(obj_map)
+    @obj_map = obj_map # used to create classes from mappings.
+    @_mapping_name = @obj_map.keys.join(',')
+    self.extend(ElasticMapper::Search::ClassMethods)
+  end
+
+  # receives queries in the form:
+  # {
+  #  id: "#{obj._type}_#{obj.id}",
+  #  obj_id: obj.id,
+  #  type: obj._type
+  # }
+  def find(ids_hash)
+    results = {}
+
+    # 1. iterate over each active model we care about.
+    # 2. perform a bulk lookup based on id.
+    # 3. map everything onto results hash, so that we can maintain sort order.
+    @obj_map.keys.each do |key|
+      ids = ids_hash.select {|id_hash| id_hash[:type] == key.to_s}.map {|obj| obj[:obj_id]}
+      next unless ids.count > 0
+      @obj_map[key].find(ids).each do |record|
+        results["#{key}_#{record.id}"] = record
+      end
+    end
+
+    results
+  end
+end

data/lib/elastic_mapper/search.rb

@@ -55,8 +55,24 @@ module ElasticMapper::Search
         end
       end
 
+      # if a search is being performed across multiple
+      # models, we must include the type along with id:
+      documents = if self.class.name =~ /MultiSearch/
+        ids = res.results.map do |obj|
+          {
+            id: "#{obj._type}_#{obj.id}",
+            obj_id: obj.id,
+            type: obj._type
+          }
+        end
+
+        ordered_results_multi(ids)
+      else
+        ordered_results(res.results.map(&:id))
+      end
+
       Hashie::Mash.new({
-        documents: ordered_results(res.results.map(&:id)),
+        documents: documents,
         from: opts[:from],
         total: res.total
       })
@@ -91,11 +107,20 @@ module ElasticMapper::Search
         h[m.id] = m
         h
       end
-      
+
       ids.map { |id| model_lookup[id] }
     end
     private :ordered_results
 
+    # Note: the multi-search functionality kicks along a
+    # type value which is used to perform lookups on the
+    # appropriate underlying model.
+    def ordered_results_multi(ids_hash)
+      model_lookup = self.find(ids_hash)
+      ids_hash.map { |id_hash| model_lookup[id_hash[:id]] }
+    end
+    private :ordered_results_multi
+
     # sanitize a search query for Lucene. Useful if the original
     # query raises an exception due to invalid DSL parse.
     #

data/lib/elastic_mapper/version.rb

@@ -1,3 +1,3 @@
 module ElasticMapper
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/elastic_mapper/multi_search_spec.rb

@@ -0,0 +1,124 @@
+#encoding: UTF-8
+
+require 'spec_helper'
+
+describe ElasticMapper::MultiSearch do
+
+  class SearchModel < ActiveHash::Base
+    include ElasticMapper
+    attr_accessor :foo, :bar
+
+    mapping :foo, :bar
+    mapping_name :index_models
+  end
+
+  class SearchModelTwo < ActiveHash::Base
+    include ElasticMapper
+    attr_accessor :foo, :bar
+
+    mapping :foo, :bar
+    mapping_name :index_models_two
+  end
+
+  describe "search" do
+    before(:each) do
+      reset_index
+      SearchModel.put_mapping
+      SearchModelTwo.put_mapping
+    end
+    let(:d1) { SearchModel.create(foo: 'hello world', bar: 'goodnight moon') }
+    let(:d2) { SearchModelTwo.create(foo: 'alpha century', bar: 'mars') }
+    let(:d3) { SearchModel.create(foo: 'cat lover') }
+    before(:each) do
+      index(d1)
+      index(d2)
+      index(d3)
+    end
+
+    context "search by query string" do
+      it "returns documents matching a query string" do
+        multi = ElasticMapper::MultiSearch.new({
+          index_models: SearchModel,
+          index_models_two: SearchModelTwo
+        })
+
+        results = multi.search('alpha')
+        results.documents.count.should == 1
+        results.documents.first.foo.should == 'alpha century'
+        results.documents.first.should be_a(SearchModelTwo)
+      end
+
+      it "supports elasticsearch query DSL" do
+        multi = ElasticMapper::MultiSearch.new({
+          index_models: SearchModel,
+          index_models_two: SearchModelTwo
+        })
+
+        results = multi.search('*')
+        results.documents.count.should == 3
+      end
+    end
+
+    context "sort" do
+      it "can sort in descending order" do
+        multi = ElasticMapper::MultiSearch.new({
+          index_models: SearchModel,
+          index_models_two: SearchModelTwo
+        })
+
+        results = multi.search('*', sort: { :foo => :desc })
+        results.documents.first.foo.should == 'hello world'
+        results.documents.first.should be_a(SearchModel)
+
+        results.documents.second.foo.should == 'cat lover'
+        results.documents.second.should be_a(SearchModel)
+
+        results.documents.third.foo.should == 'alpha century'
+        results.documents.third.should be_a(SearchModelTwo)
+      end
+
+      it "can sort in ascending order" do
+        multi = ElasticMapper::MultiSearch.new({
+          index_models: SearchModel,
+          index_models_two: SearchModelTwo
+        })
+
+        results = multi.search('*', sort: { :foo => :asc })
+        results.documents.first.foo.should == 'alpha century'
+        results.documents.first.should be_a(SearchModelTwo)
+
+        results.documents.second.foo.should == 'cat lover'
+        results.documents.second.should be_a(SearchModel)
+      end
+    end
+
+    context "pagination" do
+      it "allows result size to be set with size" do
+        multi = ElasticMapper::MultiSearch.new({
+          index_models: SearchModel,
+          index_models_two: SearchModelTwo
+        })
+
+        results = multi.search('* OR alpha', size: 1)
+        results.documents.count.should == 1
+        results.documents.first.foo.should == 'alpha century'
+        results.documents.first.should be_a(SearchModelTwo)
+      end
+
+      it "allows documents to be skipped with from" do
+        multi = ElasticMapper::MultiSearch.new({
+          index_models: SearchModel,
+          index_models_two: SearchModelTwo
+        })
+
+        results = multi.search({ "query_string" => { "query" => '* OR alpha' } }, size: 1, from: 1)
+        results.total.should == 3
+        results.from.should == 1
+        results.documents.count.should == 1
+        results.documents.first.foo.should == 'hello world'
+        results.documents.first.should be_a(SearchModel)
+      end
+    end
+
+  end
+end

data/spec/elastic_mapper/search_spec.rb

@@ -15,7 +15,7 @@ describe ElasticMapper::Search do
   describe "search" do
     before(:each) do
       reset_index
-      IndexModel.put_mapping
+      SearchModel.put_mapping
     end
     let(:d1) { SearchModel.create(foo: 'hello world', bar: 'goodnight moon') }
     let(:d2) { SearchModel.create(foo: 'alpha century', bar: 'mars') }
@@ -50,7 +50,7 @@ describe ElasticMapper::Search do
       it "returns documents matching the hash query" do
         results = SearchModel.search({ "query_string" => { "query" => 'alpha' } })
         results.documents.count.should == 1
-        results.documents.first.foo.should == 'alpha century'        
+        results.documents.first.foo.should == 'alpha century'
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_mapper
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Benjamin Coe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-26 00:00:00.000000000 Z
+date: 2014-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stretcher
@@ -140,10 +140,12 @@ files:
 - lib/elastic_mapper.rb
 - lib/elastic_mapper/index.rb
 - lib/elastic_mapper/mapping.rb
+- lib/elastic_mapper/multi_search.rb
 - lib/elastic_mapper/search.rb
 - lib/elastic_mapper/version.rb
 - spec/elastic_mapper/index_spec.rb
 - spec/elastic_mapper/mapping_spec.rb
+- spec/elastic_mapper/multi_search_spec.rb
 - spec/elastic_mapper/search_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -173,5 +175,6 @@ summary: A dead simple DSL for integrating ActiveModel with ElasticSearch.
 test_files:
 - spec/elastic_mapper/index_spec.rb
 - spec/elastic_mapper/mapping_spec.rb
+- spec/elastic_mapper/multi_search_spec.rb
 - spec/elastic_mapper/search_spec.rb
 - spec/spec_helper.rb