tire 0.4.3 → 0.5.0

data/.gitignore

@@ -11,4 +11,4 @@ examples/*.html
 *.log
 .rvmrc
 .rbenv-version
-tags
+tmp/

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.markdown

@@ -247,7 +247,7 @@ The best thing about `boolean` queries is that we can easily save these partial
 to mix and reuse them later. So, we may define a query for the _tags_ property:
 
 ```ruby
-    tags_query = lambda do
+    tags_query = lambda do |boolean|
       boolean.should { string 'tags:ruby' }
       boolean.should { string 'tags:java' }
     end
@@ -256,7 +256,7 @@ to mix and reuse them later. So, we may define a query for the _tags_ property:
 And a query for the _published_on_ property:
 
 ```ruby
-    published_on_query = lambda do
+    published_on_query = lambda do |boolean|
       boolean.must   { string 'published_on:[2011-01-01 TO 2011-01-02]' }
     end
 ```

data/examples/rails-application-template.rb

@@ -105,7 +105,7 @@ puts
 say_status  "Rubygems", "Adding Rubygems into Gemfile...\n", :yellow
 puts        '-'*80, ''; sleep 1
 
-gem 'tire'
+gem 'tire', :git => 'git://github.com/karmi/tire.git'
 gem 'will_paginate', '~> 3.0'
 
 git :add => '.'
@@ -137,7 +137,7 @@ say_status  "Database", "Seeding the database with data...", :yellow
 puts        '-'*80, ''; sleep 0.25
 
 run "rm -f db/seeds.rb"
-file 'db/seeds.rb', <<-CODE
+file 'db/seeds.rb', %q{
 contents = [
 'Lorem ipsum dolor sit amet.',
 'Consectetur adipisicing elit, sed do eiusmod tempor incididunt.',
@@ -149,11 +149,23 @@ contents = [
 puts "Deleting all articles..."
 Article.delete_all
 
-puts "Creating articles..."
-%w[ One Two Three Four Five ].each_with_index do |title, i|
-  Article.create :title => title, :content => contents[i], :published_on => i.days.ago.utc
+unless ENV['COUNT']
+
+  puts "Creating articles..."
+  %w[ One Two Three Four Five ].each_with_index do |title, i|
+    Article.create :title => title, :content => contents[i], :published_on => i.days.ago.utc
+  end
+
+else
+
+  puts "Creating 10,000 articles..."
+  (1..ENV['COUNT'].to_i).each_with_index do |title, i|
+    Article.create :title => "Title #{title}", :content => 'Lorem', :published_on => i.days.ago.utc
+    print '.'
+  end
+
 end
-CODE
+}
 
 rake "db:seed"
 
@@ -169,6 +181,8 @@ file 'app/models/article.rb', <<-CODE
 class Article < ActiveRecord::Base
   include Tire::Model::Search
   include Tire::Model::Callbacks
+
+  attr_accessible :title, :content, :published_on
 end
 CODE
 

data/lib/tire.rb

@@ -20,12 +20,14 @@ require 'tire/http/response'
 require 'tire/http/client'
 require 'tire/search'
 require 'tire/search/query'
+require 'tire/search/queries/match'
 require 'tire/search/sort'
 require 'tire/search/facet'
 require 'tire/search/filter'
 require 'tire/search/highlight'
 require 'tire/search/scan'
 require 'tire/search/script_field'
+require 'tire/multi_search'
 require 'tire/results/pagination'
 require 'tire/results/collection'
 require 'tire/results/item'

data/lib/tire/alias.rb

@@ -209,7 +209,7 @@ module Tire
 
         if Configuration.logger.level.to_s == 'debug'
           body = if @response
-            defined?(Yajl) ? Yajl::Encoder.encode(@response.body, :pretty => true) : MultiJson.encode(@response.body)
+            MultiJson.encode(@response.body, :pretty => Configuration.pretty)
           else
             error.message rescue ''
           end

data/lib/tire/configuration.rb

@@ -19,6 +19,14 @@ module Tire
       @logger || nil
     end
 
+    def self.pretty(value=nil, options={})
+      if value === false
+        return @pretty = false
+      else
+        @pretty.nil? ? true : @pretty
+      end
+    end
+
     def self.reset(*properties)
       reset_variables = properties.empty? ? instance_variables : instance_variables.map { |p| p.to_s} & \
                                                                  properties.map         { |p| "@#{p}" }

data/lib/tire/dsl.rb

@@ -18,8 +18,11 @@ module Tire
             options
           else raise ArgumentError, "Please pass a Ruby Hash or String with JSON"
         end
-
-        Search::Search.new(indices, :payload => payload)
+        unless options.empty?
+          Search::Search.new(indices, :payload => payload)
+        else
+          Search::Search.new(indices)
+        end
       end
     rescue Exception => error
       STDERR.puts "[REQUEST FAILED] #{error.class} #{error.message rescue nil}\n"
@@ -27,6 +30,70 @@ module Tire
     ensure
     end
 
+    # Build and perform a [multi-search](http://elasticsearch.org/guide/reference/api/multi-search.html)
+    # request.
+    #
+    #     s = Tire.search 'clients' do
+    #           search :names do
+    #             query { match :name, 'carpenter' }
+    #           end
+    #           search :counts, search_type: 'count' do
+    #             query { match [:name, :street, :occupation], 'carpenter' }
+    #           end
+    #           search :vip, index: 'clients-vip' do
+    #             query { string "last_name:carpenter" }
+    #           end
+    #           search() { query {all} }
+    #         end
+    #
+    # The DSL allows you to perform multiple searches and get corresponding results
+    # in a single HTTP request, saving network roundtrips.
+    #
+    # Use the `search` method in the block to define a search request with the
+    # regular Tire's DSL (`query`, `facet`, etc).
+    #
+    # You can pass options such as `search_type`, `routing`, etc.,
+    # as well as a different `index` and/or `type` to individual searches.
+    #
+    # You can give single searches names, to be able to refer to them later.
+    #
+    # The results are returned as an enumerable collection of {Tire::Results::Collection} instances.
+    #
+    # You may simply iterate over them with `each`:
+    #
+    #     s.results.each do |results|
+    #       puts results.map(&:name)
+    #     end
+    #
+    # To iterate over named results, use the `each_pair` method:
+    #
+    #     s.results.each_pair do |name,results|
+    #       puts "Search #{name} got #{results.size} results"
+    #     end
+    #
+    # You can get a specific named result:
+    #
+    #     search.results[:vip]
+    #
+    # You can mix & match named and non-named searches in the definition; the non-named
+    # searches will be zero-based numbered, so you can refer to them:
+    #
+    #     search.results[3] # Results for the last query
+    #
+    # To log the multi-search request, use the standard `to_curl` method (or set up a logger):
+    #
+    #     print search.to_curl
+    #
+    def multi_search(indices=nil, options={}, &block)
+      Search::Multi::Search.new(indices, options, &block)
+    rescue Exception => error
+      STDERR.puts "[REQUEST FAILED] #{error.class} #{error.message rescue nil}\n"
+      raise
+    ensure
+    end
+    alias :multisearch :multi_search
+    alias :msearch     :multi_search
+
     def index(name, &block)
       Index.new(name, &block)
     end

data/lib/tire/index.rb

@@ -36,7 +36,7 @@ module Tire
       @response.success? ? @response : false
 
     ensure
-      curl = %Q|curl -X POST #{url} -d '#{MultiJson.encode(options)}'|
+      curl = %Q|curl -X POST #{url} -d '#{MultiJson.encode(options, :pretty => Configuration.pretty)}'|
       logged('CREATE', curl)
     end
 
@@ -64,22 +64,27 @@ module Tire
 
     def store(*args)
       document, options = args
-      type = get_type_from_document(document)
-
-      if options
-        percolate = options[:percolate]
-        percolate = "*" if percolate === true
-      end
 
       id       = get_id_from_document(document)
+      type     = get_type_from_document(document)
       document = convert_document_to_json(document)
 
-      url  = id ? "#{self.url}/#{type}/#{id}" : "#{self.url}/#{type}/"
-      url += "?percolate=#{percolate}" if percolate
+      options ||= {}
+      params    = {}
+
+      if options[:percolate]
+        params[:percolate] = options[:percolate]
+        params[:percolate] = "*" if params[:percolate] === true
+      end
+
+      params[:parent] = options[:parent] if options[:parent]
+
+      params_encoded = params.empty? ? '' : "?#{params.to_param}"
+
+      url  = id ? "#{self.url}/#{type}/#{id}#{params_encoded}" : "#{self.url}/#{type}/#{params_encoded}"
 
       @response = Configuration.client.post url, document
       MultiJson.decode(@response.body)
-
     ensure
       curl = %Q|curl -X POST "#{url}" -d '#{document}'|
       logged([type, id].join('/'), curl)
@@ -117,7 +122,7 @@ module Tire
         end
 
       ensure
-        curl = %Q|curl -X POST "#{url}/_bulk" -d '{... data omitted ...}'|
+        curl = %Q|curl -X POST "#{url}/_bulk" --data-binary '{... data omitted ...}'|
         logged('BULK', curl)
       end
     end
@@ -184,20 +189,28 @@ module Tire
       logged(id, curl)
     end
 
-    def retrieve(type, id)
+    def retrieve(type, id, options={})
       raise ArgumentError, "Please pass a document ID" unless id
 
       type      = Utils.escape(type)
       url       = "#{self.url}/#{type}/#{id}"
-      @response = Configuration.client.get url
+
+      params    = {}
+      params[:routing]    = options[:routing] if options[:routing]
+      params[:fields]     = options[:fields]  if options[:fields]
+      params[:preference] = options[:preference] if options[:preference]
+      params_encoded      = params.empty? ? '' : "?#{params.to_param}"
+
+      @response = Configuration.client.get "#{url}#{params_encoded}"
 
       h = MultiJson.decode(@response.body)
-      if Configuration.wrapper == Hash then h
+      wrapper = options[:wrapper] || Configuration.wrapper
+      if wrapper == Hash then h
       else
         return nil if h['exists'] == false
         document = h['_source'] || h['fields'] || {}
         document.update('id' => h['_id'], '_type' => h['_type'], '_index' => h['_index'], '_version' => h['_version'])
-        Configuration.wrapper.new(document)
+        wrapper.new(document)
       end
 
     ensure
@@ -217,7 +230,7 @@ module Tire
       MultiJson.decode(@response.body)
 
     ensure
-      curl = %Q|curl -X POST "#{url}" -d '#{MultiJson.encode(payload)}'|
+      curl = %Q|curl -X POST "#{url}" -d '#{MultiJson.encode(payload, :pretty => Configuration.pretty)}'|
       logged(id, curl)
     end
 
@@ -266,7 +279,7 @@ module Tire
       MultiJson.decode(@response.body)['ok']
 
     ensure
-      curl = %Q|curl -X PUT "#{Configuration.url}/_percolator/#{@name}/#{name}?pretty=1" -d '#{MultiJson.encode(options)}'|
+      curl = %Q|curl -X PUT "#{Configuration.url}/_percolator/#{@name}/#{name}?pretty" -d '#{MultiJson.encode(options, :pretty => Configuration.pretty)}'|
       logged('_percolator', curl)
     end
 
@@ -294,7 +307,7 @@ module Tire
       MultiJson.decode(@response.body)['matches']
 
     ensure
-      curl = %Q|curl -X GET "#{url}/#{type}/_percolate?pretty=1" -d '#{payload.to_json}'|
+      curl = %Q|curl -X GET "#{url}/#{type}/_percolate?pretty" -d '#{MultiJson.encode(payload, :pretty => Configuration.pretty)}'|
       logged('_percolate', curl)
     end
 
@@ -308,9 +321,9 @@ module Tire
 
         if Configuration.logger.level.to_s == 'debug'
           body = if @response
-            defined?(Yajl) ? Yajl::Encoder.encode(@response.body, :pretty => true) : MultiJson.encode(@response.body)
+            MultiJson.encode( MultiJson.load(@response.body), :pretty => Configuration.pretty)
           else
-            error.message rescue ''
+            MultiJson.encode( MultiJson.load(error.message), :pretty => Configuration.pretty) rescue ''
           end
         else
           body = ''

data/lib/tire/model/indexing.rb

@@ -105,11 +105,17 @@ module Tire
         #
         def create_elasticsearch_index
           unless index.exists?
-            index.create :mappings => mapping_to_hash, :settings => settings
+            new_index = index
+            unless result = new_index.create(:mappings => mapping_to_hash, :settings => settings)
+              STDERR.puts "[ERROR] There has been an error when creating the index -- elasticsearch returned:",
+                          new_index.response
+              result
+            end
           end
         rescue Errno::ECONNREFUSED => e
           STDERR.puts "Skipping index creation, cannot connect to ElasticSearch",
                       "(The original exception was: #{e.inspect})"
+          false
         end
 
         def mapping_options

data/lib/tire/model/persistence.rb

@@ -11,7 +11,7 @@ module Tire
     #
     #     class Article
     #       include Tire::Model::Persistence
-    #     
+    #
     #       property :title
     #     end
     #
@@ -54,11 +54,14 @@ module Tire
             args.last.update(:wrapper => self, :version => true) if args.last.is_a? Hash
             args << { :wrapper => self, :version => true } unless args.any? { |a| a.is_a? Hash }
 
-            self.__search_without_persistence(*args, &block)
+            self.tire.search(*args, &block)
           end
 
-          def self.__search_without_persistence(*args, &block)
-            self.tire.search(*args, &block)
+          def self.multi_search(*args, &block)
+            args.last.update(:wrapper => self, :version => true) if args.last.is_a? Hash
+            args << { :wrapper => self, :version => true } unless args.any? { |a| a.is_a? Hash }
+
+            self.tire.multi_search(*args, &block)
           end
 
         end

data/lib/tire/model/persistence/attributes.rb

@@ -46,7 +46,7 @@ module Tire
 
             # Save property default value (when relevant):
             unless (default_value = options.delete(:default)).nil?
-              property_defaults[name.to_sym] = default_value
+              property_defaults[name.to_sym] = default_value.respond_to?(:call) ? default_value.call : default_value
             end
 
             # Save property casting (when relevant):

data/lib/tire/model/persistence/finders.rb

@@ -11,12 +11,10 @@ module Tire
 
           def find *args
             # TODO: Options like `sort`
-            old_wrapper = Tire::Configuration.wrapper
-            Tire::Configuration.wrapper self
             options = args.pop if args.last.is_a?(Hash)
             args.flatten!
             if args.size > 1
-              Tire::Search::Search.new(index.name) do |search|
+              Tire::Search::Search.new(index.name, :wrapper => self) do |search|
                 search.query do |query|
                   query.ids(args, document_type)
                 end
@@ -25,35 +23,25 @@ module Tire
             else
               case args = args.pop
                 when Fixnum, String
-                  index.retrieve document_type, args
+                  index.retrieve document_type, args, :wrapper => self
                 when :all, :first
                   send(args)
                 else
                   raise ArgumentError, "Please pass either ID as Fixnum or String, or :all, :first as an argument"
               end
             end
-          ensure
-            Tire::Configuration.wrapper old_wrapper
           end
 
           def all
             # TODO: Options like `sort`; Possibly `filters`
-            old_wrapper = Tire::Configuration.wrapper
-            Tire::Configuration.wrapper self
-            s = Tire::Search::Search.new(index.name).query { all }
+            s = Tire::Search::Search.new(index.name, :type => document_type, :wrapper => self).query { all }
             s.version(true).results
-          ensure
-            Tire::Configuration.wrapper old_wrapper
           end
 
           def first
             # TODO: Options like `sort`; Possibly `filters`
-            old_wrapper = Tire::Configuration.wrapper
-            Tire::Configuration.wrapper self
-            s = Tire::Search::Search.new(index.name).query { all }.size(1)
+            s = Tire::Search::Search.new(index.name, :type => document_type, :wrapper => self).query { all }.size(1)
             s.version(true).results.first
-          ensure
-            Tire::Configuration.wrapper old_wrapper
           end
 
         end

data/lib/tire/model/search.rb

@@ -72,20 +72,26 @@ module Tire
             options ||= {}
           end
 
-          sort      = Array( options[:order] || options[:sort] )
           options   = default_options.update(options)
+          sort      = Array( options.delete(:order) || options.delete(:sort) )
 
           s = Tire::Search::Search.new(options.delete(:index), options)
-          s.size( options[:per_page].to_i ) if options[:per_page]
-          s.from( options[:page].to_i <= 1 ? 0 : (options[:per_page].to_i * (options[:page].to_i-1)) ) if options[:page] && options[:per_page]
+
+          page     = options.delete(:page)
+          per_page = options.delete(:per_page) || Tire::Results::Pagination::default_per_page
+
+          s.size( per_page.to_i ) if per_page
+          s.from( page.to_i <= 1 ? 0 : (per_page.to_i * (page.to_i-1)) ) if page && per_page
+
           s.sort do
             sort.each do |t|
-              field_name, direction = t.split(' ')
+              field_name, direction = t.split(':')
               by field_name, direction
             end
           end unless sort.empty?
 
-          if version = options.delete(:version); s.version(version); end
+          version = options.delete(:version)
+          s.version(version) if version
 
           if block_given?
             block.arity < 1 ? s.instance_eval(&block) : block.call(s)
@@ -99,6 +105,12 @@ module Tire
           s.results
         end
 
+        def multi_search(options={}, &block)
+          default_options = {:type => document_type}
+          options         = default_options.update(options)
+          Tire::Search::Multi::Search.new(index.name, options, &block).results
+        end
+
         # Returns a Tire::Index instance for this model.
         #
         # Example usage: `Article.index.refresh`.
@@ -154,7 +166,7 @@ module Tire
         # declared in the mapping are serialized.
         #
         # For properties declared with the `:as` option, the passed String or Proc
-        # is evaluated in the instance context.
+        # is evaluated in the instance context. Other objects are indexed "as is".
         #
         def to_indexed_json
           if instance.class.tire.mapping.empty?
@@ -172,7 +184,9 @@ module Tire
                   hash[key] = instance.instance_eval(options[:as])
                 when Proc
                   hash[key] = instance.instance_eval(&options[:as])
-              end
+                else
+                  hash[key] = options[:as]
+              end if options[:as]
             end
 
             hash.to_json
@@ -300,7 +314,6 @@ module Tire
         Results::Item.send :include, Loader
       end
 
-      
     end
 
   end