tire 0.4.0.pre → 0.4.0.rc

data/README.markdown

@@ -19,9 +19,9 @@ Installation
 
 OK. First, you need a running _ElasticSearch_ server. Thankfully, it's easy. Let's define easy:
 
-    $ curl -k -L -o elasticsearch-0.17.6.tar.gz http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.17.6.tar.gz
-    $ tar -zxvf elasticsearch-0.17.6.tar.gz
-    $ ./elasticsearch-0.17.6/bin/elasticsearch -f
+    $ curl -k -L -o elasticsearch-0.19.0.tar.gz http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.19.0.tar.gz
+    $ tar -zxvf elasticsearch-0.19.0.tar.gz
+    $ ./elasticsearch-0.19.0/bin/elasticsearch -f
 
 See, easy. On a Mac, you can also use _Homebrew_:
 
@@ -295,7 +295,7 @@ If configuring the search payload with blocks feels somehow too weak for you, yo
 a plain old Ruby `Hash` (or JSON string) with the query declaration to the `search` method:
 
 ```ruby
-    Tire.search 'articles', :query => { :fuzzy => { :title => 'Sour' } }
+    Tire.search 'articles', :query => { :prefix => { :title => 'fou' } }
 ```
 
 If this sounds like a great idea to you, you are probably able to write your application
@@ -688,21 +688,17 @@ Well, things stay mostly the same:
       include Tire::Model::Search
       include Tire::Model::Callbacks
 
-      # Let's use a different index name so stuff doesn't get mixed up.
-      #
-      index_name 'mongo-articles'
-
       # These Mongo guys sure do get funky with their IDs in +serializable_hash+, let's fix it.
       #
       def to_indexed_json
-        self.to_json
+        self.as_json
       end
 
     end
 
     Article.create :title => 'I Love ElasticSearch'
 
-    Article.search 'love'
+    Article.tire.search 'love'
 ```
 
 _Tire_ does not care what's your primary data storage solution, if it has an _ActiveModel_-compatible

data/examples/rails-application-template.rb

@@ -62,7 +62,7 @@ file ".gitignore", <<-END.gsub(/  /, '')
   tmp/**/*
   config/database.yml
   db/*.sqlite3
-  vendor/elasticsearch-0.17.6/
+  vendor/elasticsearch-0.19.0/
 END
 
 git :init
@@ -71,11 +71,11 @@ git :commit => "-m 'Initial commit: Clean application'"
 
 unless (RestClient.get('http://localhost:9200') rescue false)
   COMMAND = <<-COMMAND.gsub(/^    /, '')
-    curl -k -L -# -o elasticsearch-0.17.6.tar.gz \
-      "http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.17.6.tar.gz"
-    tar -zxf elasticsearch-0.17.6.tar.gz
-    rm  -f    elasticsearch-0.17.6.tar.gz
-    ./elasticsearch-0.17.6/bin/elasticsearch -p #{destination_root}/tmp/pids/elasticsearch.pid
+    curl -k -L -# -o elasticsearch-0.19.0.tar.gz \
+      "http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.19.0.tar.gz"
+    tar -zxf elasticsearch-0.19.0.tar.gz
+    rm  -f   elasticsearch-0.19.0.tar.gz
+    ./elasticsearch-0.19.0/bin/elasticsearch -p #{destination_root}/tmp/pids/elasticsearch.pid
   COMMAND
 
   puts        "\n"

data/examples/tire-dsl.rb

@@ -45,9 +45,9 @@ require 'tire'
 
  [ERROR] You don’t appear to have ElasticSearch installed. Please install and launch it with the following commands:
 
- curl -k -L -o elasticsearch-0.17.6.tar.gz http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.17.6.tar.gz
- tar -zxvf elasticsearch-0.17.6.tar.gz
- ./elasticsearch-0.17.6/bin/elasticsearch -f
+ curl -k -L -o elasticsearch-0.19.0.tar.gz http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.19.0.tar.gz
+ tar -zxvf elasticsearch-0.19.0.tar.gz
+ ./elasticsearch-0.19.0/bin/elasticsearch -f
 INSTALL
 
 ### Storing and indexing documents
@@ -319,7 +319,7 @@ Tire.configure do
   #     # 2011-04-24 11:34:01:150 [CREATE] ("articles")
   #     #
   #     curl -X POST "http://localhost:9200/articles"
-  #     
+  #
   #     # 2011-04-24 11:34:01:152 [200]
   #
   logger 'elasticsearch.log'
@@ -481,6 +481,7 @@ end
 # * [terms](http://elasticsearch.org/guide/reference/query-dsl/terms-query.html)
 # * [bool](http://www.elasticsearch.org/guide/reference/query-dsl/bool-query.html)
 # * [custom_score](http://www.elasticsearch.org/guide/reference/query-dsl/custom-score-query.html)
+# * [fuzzy](http://www.elasticsearch.org/guide/reference/query-dsl/fuzzy-query.html)
 # * [all](http://www.elasticsearch.org/guide/reference/query-dsl/match-all-query.html)
 # * [ids](http://www.elasticsearch.org/guide/reference/query-dsl/ids-query.html)
 
@@ -606,10 +607,10 @@ end
 # are returned.
 #
 s = Tire.search 'articles' do
-  
+
   # We will use just the same **query** as before.
   #
-  query { string 'title:T*' } 
+  query { string 'title:T*' }
 
   # But we will add a _terms_ **filter** based on tags.
   #
@@ -671,7 +672,7 @@ s = Tire.search 'articles' do
 
   # We will search for articles tagged “ruby”, again, ...
   #
-  query { string 'tags:ruby' } 
+  query { string 'tags:ruby' }
 
    # ... but will sort them by their `title`, in descending order.
    #
@@ -694,7 +695,7 @@ s = Tire.search 'articles' do
 
   # We will just get all articles in this case.
   #
-  query { all } 
+  query { all }
 
   sort do
 
@@ -728,7 +729,7 @@ end
 s = Tire.search 'articles' do
 
   # Let's search for documents containing word “Two” in their titles,
-  query { string 'title:Two' } 
+  query { string 'title:Two' }
 
    # and instruct _ElasticSearch_ to highlight relevant snippets.
    #

data/lib/tire.rb

@@ -2,9 +2,17 @@ require 'rest_client'
 require 'multi_json'
 require 'active_model'
 require 'hashr'
+require 'cgi'
+
+require 'active_support/core_ext/object/to_param'
+require 'active_support/core_ext/object/to_query'
+
+# Ruby 1.8 compatibility
+require 'tire/rubyext/ruby_1_8' if defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
 
 require 'tire/rubyext/hash'
 require 'tire/rubyext/symbol'
+require 'tire/utils'
 require 'tire/logger'
 require 'tire/configuration'
 require 'tire/http/response'

data/lib/tire/dsl.rb

@@ -10,15 +10,16 @@ module Tire
         Search::Search.new(indices, options, &block)
       else
         payload = case options
-          when Hash    then options.to_json
-          when String  then options
+          when Hash    then
+            options
+          when String  then
+            Tire.warn "Passing the payload as a JSON string in Tire.search has been deprecated, " +
+                       "please use the block syntax or pass a plain Hash."
+            options
           else raise ArgumentError, "Please pass a Ruby Hash or String with JSON"
         end
 
-        response = Configuration.client.post( "#{Configuration.url}/#{indices}/_search", payload)
-        raise Tire::Search::SearchRequestFailed, response.to_s if response.failure?
-        json     = MultiJson.decode(response.body)
-        results  = Results::Collection.new(json, options)
+        Search::Search.new(indices, :payload => payload)
       end
     rescue Exception => error
       STDERR.puts "[REQUEST FAILED] #{error.class} #{error.message rescue nil}\n"

data/lib/tire/index.rb

@@ -1,7 +1,7 @@
 module Tire
   class Index
 
-    attr_reader :name
+    attr_reader :name, :response
 
     def initialize(name, &block)
       @name = name
@@ -64,10 +64,10 @@ module Tire
       logged([type, id].join('/'), curl)
     end
 
-    def bulk_store documents
+    def bulk_store(documents, options={})
       payload = documents.map do |document|
+        type = get_type_from_document(document, :escape => false) # Do not URL-escape the _type
         id   = get_id_from_document(document)
-        type = get_type_from_document(document)
 
         STDERR.puts "[ERROR] Document #{document.inspect} does not have ID" unless id
 
@@ -92,6 +92,7 @@ module Tire
           retry
         else
           STDERR.puts "[ERROR] Too many exceptions occured, giving up. The HTTP response was: #{error.message}"
+          raise if options[:raise]
         end
 
       ensure
@@ -100,32 +101,33 @@ module Tire
       end
     end
 
-    def import(klass_or_collection, method=nil, options={})
+    def import(klass_or_collection, options={})
       case
-        when method
+        when method = options.delete(:method)
           options = {:page => 1, :per_page => 1000}.merge options
           while documents = klass_or_collection.send(method.to_sym, options.merge(:page => options[:page])) \
                             and documents.to_a.length > 0
 
             documents = yield documents if block_given?
 
-            bulk_store documents
+            bulk_store documents, options
             options[:page] += 1
           end
 
         when klass_or_collection.respond_to?(:map)
           documents = block_given? ? yield(klass_or_collection) : klass_or_collection
-          bulk_store documents
+          bulk_store documents, options
 
         else
-          raise ArgumentError, "Please pass either a collection of objects, " +
-                               "or method for fetching records, or Enumerable compatible class"
+          raise ArgumentError, "Please pass either an Enumerable compatible class, or a collection object" +
+                               "with a method for fetching records in batches (such as 'paginate')"
       end
     end
 
     def remove(*args)
       if args.size > 1
         type, document = args
+        type           = Utils.escape(type)
         id             = get_id_from_document(document) || document
       else
         document = args.pop
@@ -146,6 +148,7 @@ module Tire
     def retrieve(type, id)
       raise ArgumentError, "Please pass a document ID" unless id
 
+      type      = Utils.escape(type)
       url       = "#{Configuration.url}/#{@name}/#{type}/#{id}"
       @response = Configuration.client.get url
 
@@ -262,7 +265,9 @@ module Tire
       end
     end
 
-    def get_type_from_document(document)
+    def get_type_from_document(document, options={})
+      options = {:escape => true}.merge(options)
+
       old_verbose, $VERBOSE = $VERBOSE, nil # Silence Object#type deprecation warnings
       type = case
         when document.respond_to?(:document_type)
@@ -275,7 +280,9 @@ module Tire
           document.type
         end
       $VERBOSE = old_verbose
-      type || :document
+
+      type ||= 'document'
+      options[:escape] ? Utils.escape(type) : type
     end
 
     def get_id_from_document(document)
@@ -292,7 +299,10 @@ module Tire
 
     def convert_document_to_json(document)
       document = case
-        when document.is_a?(String) then document
+        when document.is_a?(String)
+          Tire.warn "Passing the document as JSON string in Index#store has been deprecated, " +
+                     "please pass an object which responds to `to_indexed_json` or a plain Hash."
+          document
         when document.respond_to?(:to_indexed_json) then document.to_indexed_json
         else raise ArgumentError, "Please pass a JSON string or object with a 'to_indexed_json' method"
       end

data/lib/tire/model/import.rb

@@ -1,3 +1,4 @@
+
 module Tire
   module Model
 
@@ -13,8 +14,8 @@ module Tire
       module ClassMethods
 
         def import options={}, &block
-          method = options.delete(:method) || 'paginate'
-          index.import klass, method, options, &block
+          options = { :method => 'paginate' }.update options
+          index.import klass, options, &block
         end
 
       end

data/lib/tire/model/indexing.rb

@@ -41,6 +41,14 @@ module Tire
         #         indexes :id,    :index    => :not_analyzed
         #         indexes :title, :analyzer => 'snowball', :boost => 100
         #         indexes :words, :as       => 'content.split(/\W/).length'
+        #
+        #         indexes :comments do
+        #           indexes :body
+        #           indexes :author do
+        #             indexes :name
+        #           end
+        #         end
+        #
         #         # ...
         #       end
         #     end
@@ -76,21 +84,21 @@ module Tire
         # for more information.
         #
         def indexes(name, options = {}, &block)
+          mapping[name] = options
+
           if block_given?
-            mapping[name] ||= { :type => 'object', :properties => {} }.update(options)
-            @_nested_mapping = name
-            nested = yield
-            @_nested_mapping = nil
-            self
-          else
-            options[:type] ||= 'string'
-            if @_nested_mapping
-              mapping[@_nested_mapping][:properties][name] = options
-            else
-              mapping[name] = options
-            end
-            self
+            mapping[name][:type]       ||= 'object'
+            mapping[name][:properties] ||= {}
+
+            previous = @mapping
+            @mapping = mapping[name][:properties]
+            yield
+            @mapping = previous
           end
+
+          mapping[name][:type] ||= 'string'
+
+          self
         end
 
         # Creates the corresponding index with desired settings and mappings, when it does not exists yet.

data/lib/tire/model/naming.rb

@@ -30,6 +30,7 @@ module Tire
         def index_name name=nil, &block
           @index_name = name if name
           @index_name = block if block_given?
+          # TODO: Try to get index_name from ancestor classes
           @index_name || [index_prefix, klass.model_name.plural].compact.join('_')
         end
 
@@ -74,7 +75,7 @@ module Tire
         #
         def document_type name=nil
           @document_type = name if name
-          @document_type || klass.model_name.singular
+          @document_type || klass.model_name.underscore
         end
       end
 

data/lib/tire/model/persistence.rb

@@ -45,7 +45,7 @@ module Tire
 
           include Persistence::Storage
 
-          ['_score', '_type', '_index', '_version', 'sort', 'highlight', 'matches'].each do |attr|
+          ['_score', '_type', '_index', '_version', 'sort', 'highlight', 'matches', '_explanation'].each do |attr|
             define_method("#{attr}=") { |value| @attributes ||= {}; @attributes[attr] = value }
             define_method("#{attr}")  { @attributes[attr] }
           end

data/lib/tire/results/collection.rb

@@ -18,7 +18,8 @@ module Tire
 
       def results
         @results ||= begin
-          hits = @response['hits']['hits']
+          hits = @response['hits']['hits'].map { |d| d.update '_type' => Utils.unescape(d['_type']) }
+
           unless @options[:load]
             if @wrapper == Hash
               hits
@@ -31,33 +32,35 @@ module Tire
                  document.update( {'id' => h['_id']} )
 
                  # Update the document with meta information
-                 ['_score', '_type', '_index', '_version', 'sort', 'highlight'].each { |key| document.update( {key => h[key]} || {} ) }
+                 ['_score', '_type', '_index', '_version', 'sort', 'highlight', '_explanation'].each { |key| document.update( {key => h[key]} || {} ) }
 
                  # Return an instance of the "wrapper" class
                  @wrapper.new(document)
               end
             end
+
           else
             return [] if hits.empty?
 
-            type  = @response['hits']['hits'].first['_type']
-            raise NoMethodError, "You have tried to eager load the model instances, " +
-                                 "but Tire cannot find the model class because " +
-                                 "document has no _type property." unless type
-
-            begin
-              klass = type.camelize.constantize
-            rescue NameError => e
-              raise NameError, "You have tried to eager load the model instances, but " +
-                               "Tire cannot find the model class '#{type.camelize}' " +
-                               "based on _type '#{type}'.", e.backtrace
+            records = {}
+            @response['hits']['hits'].group_by { |item| item['_type'] }.each do |type, items|
+              raise NoMethodError, "You have tried to eager load the model instances, " +
+                                   "but Tire cannot find the model class because " +
+                                   "document has no _type property." unless type
+
+              begin
+                klass = type.camelize.constantize
+              rescue NameError => e
+                raise NameError, "You have tried to eager load the model instances, but " +
+                                 "Tire cannot find the model class '#{type.camelize}' " +
+                                 "based on _type '#{type}'.", e.backtrace
+              end
+              ids = items.map { |h| h['_id'] }
+              records[type] = @options[:load] === true ? klass.find(ids) : klass.find(ids, @options[:load])
             end
 
-            ids   = @response['hits']['hits'].map { |h| h['_id'] }
-            records =  @options[:load] === true ? klass.find(ids) : klass.find(ids, @options[:load])
-
             # Reorder records to preserve order from search results
-            ids.map { |id| records.detect { |record| record.id.to_s == id.to_s } }
+            @response['hits']['hits'].map { |item| records[item['_type']].detect { |record| record.id.to_s == item['_id'].to_s } }
           end
         end
       end