tire 0.1.15 → 0.1.16

data/.gitignore

@@ -3,6 +3,8 @@
 Gemfile.lock
 pkg/*
 rdoc/
+doc/
+.yardoc/
 coverage/
 scratch/
 examples/*.html

data/README.markdown

@@ -439,19 +439,25 @@ Any other parameters you provide to the `import` method are passed down to the `
 Are we saying you have to fiddle with this thing in a `rails console` or silly Ruby scripts? No.
 Just call the included _Rake_ task on the commandline:
 
+```bash
     $ rake environment tire:import CLASS='Article'
+```
 
 You can also force-import the data by deleting the index first (and creating it with mapping
 provided by the `mapping` block in your model):
 
+```bash
     $ rake environment tire:import CLASS='Article' FORCE=true
+```
 
 When you'll spend more time with _ElasticSearch_, you'll notice how
 [index aliases](http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases.html)
 are the best idea since the invention of inverted index.
 You can index your data into a fresh index (and possibly update an alias if everything's fine):
 
+```bash
     $ rake environment tire:import CLASS='Article' INDEX='articles-2011-05'
+```
 
 OK. All this time we have been talking about `ActiveRecord` models, since
 it is a reasonable Rails' default for the storage layer.

data/Rakefile

@@ -30,7 +30,7 @@ require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "Tire"
-  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('README.markdown')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 

data/examples/rails-application-template.rb

@@ -213,7 +213,7 @@ gsub_file 'app/views/articles/index.html.erb', %r{<%= link_to 'New Article', new
 CODE
 
 gsub_file 'config/routes.rb', %r{resources :articles}, <<-CODE
-  resources :articles do
+resources :articles do
     collection { get :search }
   end
 CODE

data/examples/tire-dsl.rb

@@ -580,6 +580,7 @@ end
 #
 # * [terms](http://www.elasticsearch.org/guide/reference/api/search/facets/terms-facet.html)
 # * [date](http://www.elasticsearch.org/guide/reference/api/search/facets/date-histogram-facet.html)
+# * [range](http://www.elasticsearch.org/guide/reference/api/search/facets/range-facet.html)
 
 # We have seen that _ElasticSearch_ facets enable us to fetch complex aggregations from our data.
 #

data/lib/tire/dsl.rb

@@ -5,7 +5,7 @@ module Tire
       Configuration.class_eval(&block)
     end
 
-    def search(indices, options={}, &block)
+    def search(indices=nil, options={}, &block)
       if block_given?
         Search::Search.new(indices, options, &block).perform
       else

data/lib/tire/model/indexing.rb

@@ -16,9 +16,23 @@ module Tire
           end
         end
 
-        def indexes(name, options = {})
-          # p "#{self}, SEARCH PROPERTY, #{name}"
-          mapping[name] = options
+        def indexes(name, options = {}, &block)
+          options[:type] ||= 'string'
+
+          if block_given?
+            mapping[name] ||= { :type => 'object', :properties => {} }
+            @_nested_mapping = name
+            nested = yield
+            @_nested_mapping = nil
+            self
+          else
+            if @_nested_mapping
+              mapping[@_nested_mapping][:properties][name] = options
+            else
+              mapping[name] = options
+            end
+            self
+          end
         end
 
         def store_mapping?

data/lib/tire/model/search.rb

@@ -35,7 +35,10 @@ module Tire
         def search(query=nil, options={}, &block)
           old_wrapper = Tire::Configuration.wrapper
           Tire::Configuration.wrapper self
-          sort  = Array( options[:order] || options[:sort] )
+
+          sort    = Array( options[:order] || options[:sort] )
+          options = {:type => document_type}.update(options)
+
           unless block_given?
             s = Tire::Search::Search.new(elasticsearch_index.name, options)
             s.query { string query }

data/lib/tire/results/collection.rb

@@ -24,7 +24,7 @@ module Tire
                document = {}
 
                # Update the document with content and ID
-               document = h['_source'] ? document.update( h['_source'] || {} ) : document.update( h['fields'] || {} )
+               document = h['_source'] ? document.update( h['_source'] || {} ) : document.update( __parse_fields__(h['fields']) )
                document.update( {'id' => h['_id']} )
 
                # Update the document with meta information
@@ -61,6 +61,28 @@ module Tire
         self
       end
 
+      # Handles _source prefixed fields properly: strips the prefix and converts fields to nested Hashes
+      #
+      def __parse_fields__(fields={})
+        ( fields ||= {} ).clone.each_pair do |key,value|
+          next unless key.to_s =~ /_source/                 # Skip regular JSON immediately
+
+          keys = key.to_s.split('.').reject { |n| n == '_source' }
+          fields.delete(key)
+
+          result = {}
+          path = []
+
+          keys.each do |name|
+            path << name
+            eval "result[:#{path.join('][:')}] ||= {}"
+            eval "result[:#{path.join('][:')}] = #{value.inspect}" if keys.last == name
+          end
+          fields.update result
+        end
+        fields
+      end
+
     end
 
   end

data/lib/tire/search.rb

@@ -5,11 +5,17 @@ module Tire
 
       attr_reader :indices, :url, :results, :response, :json, :query, :facets, :filters, :options
 
-      def initialize(*indices, &block)
-        @options = indices.last.is_a?(Hash) ? indices.pop  : {}
-        @indices = indices
-        raise ArgumentError, 'Please pass index or indices to search' if @indices.empty?
+      def initialize(indices=nil, options = {}, &block)
+        Tire.warn "Passing indices as multiple arguments to the `Search.new` method " +
+                  "has been deprecated, please pass them as an Array: " +
+                  "Search.new([#{indices}, #{options}])" if options.is_a?(String)
+        @indices = Array(indices)
+        @options = options
+        @type    = @options[:type]
 
+        @url     = Configuration.url+['/', @indices.join(','), @type, '_search'].compact.join('/').squeeze('/')
+
+        # TODO: Do not allow changing the wrapper here or set it back after yield
         Configuration.wrapper @options[:wrapper] if @options[:wrapper]
         block.arity < 1 ? instance_eval(&block) : block.call(self) if block_given?
       end
@@ -64,7 +70,6 @@ module Tire
       end
 
       def perform
-        @url      = "#{Configuration.url}/#{indices.join(',')}/_search"
         @response = Configuration.client.get(@url, self.to_json)
         @json     = MultiJson.decode(@response.body)
         @results  = Results::Collection.new(@json, @options)
@@ -77,7 +82,7 @@ module Tire
       end
 
       def to_curl
-        %Q|curl -X GET "#{Configuration.url}/#{indices.join(',')}/_search?pretty=true" -d '#{self.to_json}'|
+        %Q|curl -X GET "#{@url}?pretty=true" -d '#{self.to_json}'|
       end
 
       def to_hash

data/lib/tire/version.rb

@@ -1,12 +1,13 @@
 module Tire
-  VERSION          = "0.1.15"
+  VERSION   = "0.1.16"
 
   CHANGELOG =<<-END
     IMPORTANT CHANGES LATELY:
 
-    # Cleanup of code for getting document type, id, JSON serialization
-    # Bunch of deprecations: sorting, passing document type to store/remove
-    # Displaying a warning when no ID is passed when storing in bulk
-    # Correct handling of import for Mongoid/Kaminari combos
+    # Defined mapping for nested fields [#56]
+    # Mapping type is optional and defaults to "string"
+    # Fixed handling of fields returned prefixed by _source from ES [#31]
+    # Allow passing the type to search and added that model passes `document_type` to search [@jonkarna, #38]
+    # Allow leaving index name empty for searching the whole server
   END
 end

data/test/integration/active_model_searchable_test.rb

@@ -36,12 +36,22 @@ module Tire
         a.save
         id = a.id
 
+        # Store document of another type in the index
+        Index.new 'supermodel_articles' do
+          store :type => 'other-thing', :title => 'Title for other thing'
+        end
+
         a.index.refresh
         sleep(1.5)
 
+        # The index should contain 2 documents
+        assert_equal 2, Tire.search('supermodel_articles') { query { all } }.results.size
+
         results = SupermodelArticle.search 'test'
 
+        # The model should find only 1 document
         assert_equal 1, results.count
+
         assert_instance_of SupermodelArticle, results.first
         assert_equal       'Test', results.first.title
         assert_not_nil     results.first._score
@@ -63,14 +73,15 @@ module Tire
 
       should "retrieve sorted documents by IDs returned from search" do
         SupermodelArticle.create! :title => 'foo'
-        SupermodelArticle.create! :title => 'bar'
+        SupermodelArticle.create! :id => 'abc123', :title => 'bar'
 
         SupermodelArticle.elasticsearch_index.refresh
         results = SupermodelArticle.search 'foo OR bar^100'
 
         assert_equal 2, results.count
 
-        assert_equal 'bar', results.first.title
+        assert_equal 'bar',    results.first.title
+        assert_equal 'abc123', results.first.id
       end
 
     end

data/test/unit/model_search_test.rb

@@ -20,6 +20,7 @@ module Tire
 
         setup do
           @stub = stub('search') { stubs(:query).returns(self); stubs(:perform).returns(self); stubs(:results).returns([]) }
+          Tire::Index.any_instance.stubs(:exists?).returns(false)
         end
 
         teardown do
@@ -51,31 +52,36 @@ module Tire
         should_eventually "NOT overload existing top-level instance methods" do
         end
 
-        should "search in index named after class name by default" do
-          i = 'active_model_articles'
-          Tire::Search::Search.expects(:new).with(i, {}).returns(@stub)
+        should "limit searching in index for documents matching the model 'document_type'" do
+          Tire::Search::Search.
+            expects(:new).
+            with(ActiveModelArticle.index_name, { :type => ActiveModelArticle.document_type }).
+            returns(@stub).
+            twice
 
           ActiveModelArticle.search 'foo'
-        end
-
-        should_eventually "search only in document types for this class by default" do
+          ActiveModelArticle.search { query { string 'foo' } }
         end
 
         should "search in custom name" do
           first  = 'custom-index-name'
           second = 'another-custom-index-name'
+          expected_options = { :type => ActiveModelArticleWithCustomIndexName.document_type }
 
-          Tire::Search::Search.expects(:new).with(first, {}).returns(@stub)
-          ActiveModelArticleWithCustomIndexName.index_name 'custom-index-name'
+          Tire::Search::Search.expects(:new).with(first, expected_options).returns(@stub).twice
+          ActiveModelArticleWithCustomIndexName.index_name first
           ActiveModelArticleWithCustomIndexName.search 'foo'
+          ActiveModelArticleWithCustomIndexName.search { query { string 'foo' } }
 
-          Tire::Search::Search.expects(:new).with(second, {}).returns(@stub)
-          ActiveModelArticleWithCustomIndexName.index_name 'another-custom-index-name'
+          Tire::Search::Search.expects(:new).with(second, expected_options).returns(@stub).twice
+          ActiveModelArticleWithCustomIndexName.index_name second
           ActiveModelArticleWithCustomIndexName.search 'foo'
+          ActiveModelArticleWithCustomIndexName.search { query { string 'foo' } }
 
-          Tire::Search::Search.expects(:new).with(first, {}).returns(@stub)
-          ActiveModelArticleWithCustomIndexName.index_name 'custom-index-name'
+          Tire::Search::Search.expects(:new).with(first, expected_options).returns(@stub).twice
+          ActiveModelArticleWithCustomIndexName.index_name first
           ActiveModelArticleWithCustomIndexName.search 'foo'
+          ActiveModelArticleWithCustomIndexName.search { query { string 'foo' } }
         end
 
         should "allow to refresh index" do
@@ -256,6 +262,45 @@ module Tire
             assert_equal 'snowball', ModelWithCustomMapping.mapping[:title][:analyzer]
           end
 
+          should "define mapping for nested properties with a block" do
+            expected_mapping = {
+              :mappings => { :model_with_nested_mapping => {
+                :properties => {
+                  :title =>  { :type => 'string' },
+                  :author => {
+                    :type => 'object',
+                    :properties => {
+                      :first_name => { :type => 'string' },
+                      :last_name  => { :type => 'string', :boost => 100 }
+                    }
+                  }
+                }
+              }
+            }}
+
+            Tire::Index.any_instance.expects(:create).with(expected_mapping)
+
+            class ::ModelWithNestedMapping
+              extend ActiveModel::Naming
+              extend ActiveModel::Callbacks
+
+              include Tire::Model::Search
+              include Tire::Model::Callbacks
+
+              mapping do
+                indexes :title, :type => 'string'
+                indexes :author do
+                  indexes :first_name, :type => 'string'
+                  indexes :last_name,  :type => 'string', :boost => 100
+                end
+              end
+
+            end
+
+            assert_not_nil ModelWithNestedMapping.mapping[:author][:properties][:last_name]
+            assert_equal   100, ModelWithNestedMapping.mapping[:author][:properties][:last_name][:boost]
+          end
+
         end
 
         context "with index update callbacks" do

data/test/unit/results_collection_test.rb

@@ -105,6 +105,44 @@ module Tire
 
       end
 
+      context "wrapping results with selected fields" do
+        # When limiting fields from _source to return ES returns them prefixed, not as "real" Hashes.
+        # Underlying issue: https://github.com/karmi/tire/pull/31#issuecomment-1340967
+        #
+        setup do
+          Configuration.reset :wrapper
+          @default_response = { 'hits' => { 'hits' =>
+            [ { '_id' => 1, '_score' => 0.5, '_index' => 'testing', '_type' => 'article',
+                'fields' => {
+                  'title'       => 'Knee Deep in JSON',
+                  'crazy.field' => 'CRAAAAZY!',
+                  '_source.artist' => {
+                    'name' => 'Elastiq',
+                    'meta' => {
+                      'favorited' => 1000,
+                      'url'       => 'http://first.fm/abc123/xyz567'
+                    }
+                  },
+                  '_source.track.info.duration' => {
+                    'minutes' => 3
+                  }
+                } } ] } }
+          collection = Results::Collection.new(@default_response)
+          @item      = collection.first
+        end
+
+        should "return fields from the first level" do
+          assert_equal 'Knee Deep in JSON', @item.title
+        end
+
+        should "return fields from the _source prefixed and nested fields" do
+          assert_equal 'Elastiq', @item.artist.name
+          assert_equal 1000,      @item.artist.meta.favorited
+          assert_equal 3,         @item.track.info.duration.minutes
+        end
+
+      end
+
       context "while paginating results" do
 
         setup do

data/test/unit/rubyext_test.rb

@@ -36,7 +36,7 @@ module Tire
 
       should "properly serialize Time into JSON" do
         json = { :time => Time.mktime(2011, 01, 01, 11, 00).to_json  }.to_json
-        assert_equal '"2011-01-01T11:00:00+01:00"', MultiJson.decode(json)['time']
+        assert_match /"2011-01-01T11:00:00.*"/, MultiJson.decode(json)['time']
       end
 
     end

data/test/unit/search_test.rb

@@ -7,8 +7,32 @@ module Tire
     context "Search" do
       setup { Configuration.reset :logger }
 
-      should "be initialized with index/indices" do
-        assert_raise(ArgumentError) { Search::Search.new }
+      should "be initialized with single index" do
+        s = Search::Search.new('index') { query { string 'foo' } }
+        assert_match %r|/index/_search|, s.url
+      end
+
+      should "be initialized with multiple indices" do
+        s = Search::Search.new(['index1','index2']) { query { string 'foo' } }
+        assert_match %r|/index1,index2/_search|, s.url
+      end
+
+      should "be initialized with multiple indices as string" do
+        s = Search::Search.new(['index1,index2,index3']) { query { string 'foo' } }
+        assert_match %r|/index1,index2,index3/_search|, s.url
+      end
+
+      should "allow to search all indices by leaving index empty" do
+        s = Search::Search.new { query { string 'foo' } }
+        assert_match %r|localhost:9200/_search|, s.url
+      end
+
+      should "allow to limit results with document type" do
+        s = Search::Search.new('index', :type => 'bar') do
+          query { string 'foo' }
+        end
+
+        assert_match %r|index/bar/_search|, s.url
       end
 
       should "allow to pass block to query" do
@@ -35,7 +59,7 @@ module Tire
         s = Search::Search.new('index1') do;end
         assert_equal ['index1'], s.indices
 
-        s = Search::Search.new('index1', 'index2') do;end
+        s = Search::Search.new(['index1', 'index2']) do;end
         assert_equal ['index1', 'index2'], s.indices
       end
 
@@ -49,14 +73,14 @@ module Tire
       end
 
       should "return curl snippet with multiple indices for debugging" do
-        s = Search::Search.new('index_1', 'index_2') do
+        s = Search::Search.new(['index_1', 'index_2']) do
           query { string 'title:foo' }
         end
         assert_match /index_1,index_2/, s.to_curl
       end
 
       should "return itself as a Hash" do
-        s = Search::Search.new('index_1', 'index_2') do
+        s = Search::Search.new('index') do
           query { string 'title:foo' }
         end
         assert_nothing_raised do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tire
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 59
   prerelease: 
   segments: 
   - 0
   - 1
-  - 15
-  version: 0.1.15
+  - 16
+  version: 0.1.16
 platform: ruby
 authors: 
 - Karel Minarik
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-04 00:00:00 Z
+date: 2011-07-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -255,7 +255,6 @@ files:
 - MIT-LICENSE
 - README.markdown
 - Rakefile
-- examples/dsl.rb
 - examples/rails-application-template.rb
 - examples/tire-dsl.rb
 - lib/tire.rb
@@ -347,12 +346,13 @@ post_install_message: |
   
     IMPORTANT CHANGES LATELY:
   
-    # Cleanup of code for getting document type, id, JSON serialization
-    # Bunch of deprecations: sorting, passing document type to store/remove
-    # Displaying a warning when no ID is passed when storing in bulk
-    # Correct handling of import for Mongoid/Kaminari combos
+    # Defined mapping for nested fields [#56]
+    # Mapping type is optional and defaults to "string"
+    # Fixed handling of fields returned prefixed by _source from ES [#31]
+    # Allow passing the type to search and added that model passes `document_type` to search [@jonkarna, #38]
+    # Allow leaving index name empty for searching the whole server
   
-    See the full changelog at <http://github.com/karmi/tire/commits/v0.1.15>.
+    See the full changelog at <http://github.com/karmi/tire/commits/v0.1.16>.
   
   --------------------------------------------------------------------------------
 

data/examples/dsl.rb

@@ -1,73 +0,0 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-
-require 'rubygems'
-require 'tire'
-
-extend Tire::DSL
-
-configure do
-  url "http://localhost:9200"
-end
-
-index 'articles' do
-  delete
-  create
-
-  puts "Documents:", "-"*80
-  [
-    { :title => 'One',   :tags => ['ruby'] },
-    { :title => 'Two',   :tags => ['ruby', 'python'] },
-    { :title => 'Three', :tags => ['java'] },
-    { :title => 'Four',  :tags => ['ruby', 'php'] }
-  ].each do |article|
-    puts "Indexing article: #{article.to_json}"
-    store article
-  end  
-
-  refresh
-end
-
-s = search 'articles' do
-  query do
-    string 'T*'
-  end
-
-  filter :terms, :tags => ['ruby']
-
-  sort do
-    title 'desc'
-  end
-
-  facet 'global-tags' do
-    terms :tags, :global => true
-  end
-
-  facet 'current-tags' do
-    terms :tags
-  end
-end
-
-puts "", "Query:", "-"*80
-puts s.to_json
-
-puts "", "Raw JSON result:", "-"*80
-puts JSON.pretty_generate(s.response)
-
-puts "", "Try the query in Curl:", "-"*80
-puts s.to_curl
-
-puts "", "Results:", "-"*80
-s.results.each_with_index do |document, i|
-  puts "#{i+1}. #{ document.title.ljust(10) } [id] #{document._id}"
-end
-
-puts "", "Facets: tags distribution across the whole database:", "-"*80
-s.results.facets['global-tags']['terms'].each do |f|
-  puts "#{f['term'].ljust(13)} #{f['count']}"
-end
-
-puts "", "Facets: tags distribution for the current query ",
-         "(Notice that 'java' is included, because of the filter)", "-"*80
-s.results.facets['current-tags']['terms'].each do |f|
-  puts "#{f['term'].ljust(13)} #{f['count']}"
-end