tire 0.4.3 → 0.5.0

data/lib/tire/rubyext/ruby_1_8.rb

@@ -1,7 +1 @@
-require 'rubygems'
-
-# Require URI escape/unescape compatibility layer from Rack
-#
-# See <http://www.ruby-doc.org/stdlib-1.9.3/libdoc/uri/rdoc/URI.html#method-c-encode_www_form_component>
-#
-require 'rack/backports/uri/common_18'
+require 'tire/rubyext/uri_escape'

data/lib/tire/rubyext/uri_escape.rb

@@ -0,0 +1,74 @@
+# Steal the URI escape/unescape compatibility layer from Rack
+#
+# See <http://www.ruby-doc.org/stdlib-1.9.3/libdoc/uri/rdoc/URI.html#method-c-encode_www_form_component>
+
+# :stopdoc:
+
+# Stolen from ruby core's uri/common.rb, with modifications to support 1.8.x
+#
+# https://github.com/ruby/ruby/blob/trunk/lib/uri/common.rb
+#
+#
+
+module URI
+  TBLENCWWWCOMP_ = {} # :nodoc:
+  TBLDECWWWCOMP_ = {} # :nodoc:
+
+  # Encode given +s+ to URL-encoded form data.
+  #
+  # This method doesn't convert *, -, ., 0-9, A-Z, _, a-z, but does convert SP
+  # (ASCII space) to + and converts others to %XX.
+  #
+  # This is an implementation of
+  # http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
+  #
+  # See URI.decode_www_form_component, URI.encode_www_form
+  def self.encode_www_form_component(s)
+    str = s.to_s
+    if RUBY_VERSION < "1.9" && $KCODE =~ /u/i
+      str.gsub(/([^ a-zA-Z0-9_.-]+)/) do
+        '%' + $1.unpack('H2' * Rack::Utils.bytesize($1)).join('%').upcase
+      end.tr(' ', '+')
+    else
+      if TBLENCWWWCOMP_.empty?
+        tbl = {}
+        256.times do |i|
+          tbl[i.chr] = '%%%02X' % i
+        end
+        tbl[' '] = '+'
+        begin
+          TBLENCWWWCOMP_.replace(tbl)
+          TBLENCWWWCOMP_.freeze
+        rescue
+        end
+      end
+      str.gsub(/[^*\-.0-9A-Z_a-z]/) {|m| TBLENCWWWCOMP_[m]}
+    end
+  end
+
+  # Decode given +str+ of URL-encoded form data.
+  #
+  # This decods + to SP.
+  #
+  # See URI.encode_www_form_component, URI.decode_www_form
+  def self.decode_www_form_component(str, enc=nil)
+    if TBLDECWWWCOMP_.empty?
+      tbl = {}
+      256.times do |i|
+        h, l = i>>4, i&15
+        tbl['%%%X%X' % [h, l]] = i.chr
+        tbl['%%%x%X' % [h, l]] = i.chr
+        tbl['%%%X%x' % [h, l]] = i.chr
+        tbl['%%%x%x' % [h, l]] = i.chr
+      end
+      tbl['+'] = ' '
+      begin
+        TBLDECWWWCOMP_.replace(tbl)
+        TBLDECWWWCOMP_.freeze
+      rescue
+      end
+    end
+    raise ArgumentError, "invalid %-encoding (#{str})" unless /\A(?:%[0-9a-fA-F]{2}|[^%])*\z/ =~ str
+    str.gsub(/\+|%[0-9a-fA-F]{2}/) {|m| TBLDECWWWCOMP_[m]}
+  end
+end

data/lib/tire/search.rb

@@ -4,7 +4,7 @@ module Tire
 
     class Search
 
-      attr_reader :indices, :query, :facets, :filters, :options, :explain, :script_fields
+      attr_reader :indices, :types, :query, :facets, :filters, :options, :explain, :script_fields
 
       def initialize(indices=nil, options={}, &block)
         if indices.is_a?(Hash)
@@ -48,7 +48,8 @@ module Tire
       end
 
       def params
-        @options.empty? ? '' : '?' + @options.to_param
+        options = @options.except(:wrapper)
+        options.empty? ? '' : '?' + options.to_param
       end
 
       def query(&block)
@@ -106,6 +107,11 @@ module Tire
         self
       end
 
+      def partial_field(name, options)
+        @partial_fields ||= {}
+        @partial_fields[name] = options
+      end
+
       def explain(value)
         @explain = value
         self
@@ -116,6 +122,16 @@ module Tire
         self
       end
 
+      def min_score(value)
+        @min_score = value
+        self
+      end
+
+      def track_scores(value)
+        @track_scores = value
+        self
+      end
+
       def perform
         @response = Configuration.client.get(self.url + self.params, self.to_json)
         if @response.failure?
@@ -130,11 +146,11 @@ module Tire
       end
 
       def to_curl
-        %Q|curl -X GET "#{url}#{params.empty? ? '?' : params.to_s + '&'}pretty=true" -d '#{to_json}'|
+        %Q|curl -X GET '#{url}#{params.empty? ? '?' : params.to_s + '&'}pretty' -d '#{to_json}'|
       end
 
       def to_hash
-        @options.delete(:payload) || begin
+        @options[:payload] || begin
           request = {}
           request.update( { :indices_boost => @indices_boost } ) if @indices_boost
           request.update( { :query  => @query.to_hash } )    if @query
@@ -146,33 +162,39 @@ module Tire
           request.update( { :size => @size } )               if @size
           request.update( { :from => @from } )               if @from
           request.update( { :fields => @fields } )           if @fields
+          request.update( { :partial_fields => @partial_fields } ) if @partial_fields
           request.update( { :script_fields => @script_fields } ) if @script_fields
           request.update( { :version => @version } )         if @version
           request.update( { :explain => @explain } )         if @explain
+          request.update( { :min_score => @min_score } )     if @min_score
+          request.update( { :track_scores => @track_scores } ) if @track_scores
           request
         end
       end
 
-      def to_json
+      def to_json(options={})
         payload = to_hash
         # TODO: Remove when deprecated interface is removed
-        payload.is_a?(String) ? payload : payload.to_json
+        if payload.is_a?(String)
+          payload
+        else
+          MultiJson.encode(payload, :pretty => Configuration.pretty)
+        end
       end
 
-      def logged(error=nil)
+      def logged(endpoint='_search')
         if Configuration.logger
 
-          Configuration.logger.log_request '_search', indices, to_curl
+          Configuration.logger.log_request endpoint, indices, to_curl
 
           took = @json['took']  rescue nil
           code = @response.code rescue nil
 
           if Configuration.logger.level.to_s == 'debug'
-            # FIXME: Depends on RestClient implementation
             body = if @json
-              defined?(Yajl) ? Yajl::Encoder.encode(@json, :pretty => true) : MultiJson.encode(@json)
+              MultiJson.encode( @json, :pretty => Configuration.pretty)
             else
-              @response.body rescue nil
+              MultiJson.encode( MultiJson.load(@response.body), :pretty => Configuration.pretty) rescue ''
             end
           else
             body = ''

data/lib/tire/search/facet.rb

@@ -55,12 +55,17 @@ module Tire
         @value = { :query => Query.new(&block).to_hash }
       end
 
-      def filter(field, value, options={})
-        @value = { :filter => { :term => { field => value }}.update(options) }
+      def filter(type, options={})
+        @value = { :filter => Filter.new(type, options) }
         self
       end
 
-      def to_json
+      def facet_filter(type, *options)
+        @value[:facet_filter] = Filter.new(type, *options).to_hash
+        self
+      end
+
+      def to_json(options={})
         to_hash.to_json
       end
 

data/lib/tire/search/filter.rb

@@ -15,7 +15,7 @@ module Tire
         @hash = { type => value }
       end
 
-      def to_json
+      def to_json(options={})
         to_hash.to_json
       end
 

data/lib/tire/search/highlight.rb

@@ -13,7 +13,7 @@ module Tire
         end
       end
 
-      def to_json
+      def to_json(options={})
         to_hash.to_json
       end
 

data/lib/tire/search/queries/match.rb

@@ -0,0 +1,40 @@
+module Tire
+  module Search
+    class Query
+
+      def match(field, value, options={})
+        if @value.empty?
+          @value = MatchQuery.new(field, value, options).to_hash
+        else
+          MatchQuery.add(self, field, value, options)
+        end
+        @value
+      end
+    end
+
+    class MatchQuery
+      def initialize(field, value, options={})
+        query_options = { :query => value }.merge(options)
+
+        if field.is_a?(Array)
+          @value = { :multi_match => query_options.merge( :fields => field ) }
+        else
+          @value = { :match => { field => query_options } }
+        end
+      end
+
+      def self.add(query, field, value, options={})
+        unless query.value[:bool]
+          original_value = query.value.dup
+          query.value = { :bool => {} }
+          (query.value[:bool][:must] ||= []) << original_value
+        end
+        query.value[:bool][:must] << MatchQuery.new(field, value, options).to_hash
+      end
+
+      def to_hash
+        @value
+      end
+    end
+  end
+end

data/lib/tire/search/query.rb

@@ -2,13 +2,19 @@ module Tire
   module Search
 
     class Query
+      attr_accessor :value
+
       def initialize(&block)
         @value = {}
         block.arity < 1 ? self.instance_eval(&block) : block.call(self) if block_given?
       end
 
       def term(field, value, options={})
-        query = { field => { :term => value }.update(options) }
+        query = if value.is_a?(Hash)
+          { field => value.to_hash }
+        else
+          { field => { :term => value }.update(options) }
+        end
         @value = { :term => query }
       end
 
@@ -23,6 +29,7 @@ module Tire
       end
 
       def text(field, value, options={})
+        Tire.warn "The 'text' query has been deprecated, please use a 'match' query."
         query_options = { :query => value }.update(options)
         @value = { :text => { field => query_options } }
         @value
@@ -75,8 +82,8 @@ module Tire
         @value
       end
 
-      def all
-        @value = { :match_all => {} }
+      def all(options = {})
+        @value = { :match_all => options }
         @value
       end
 
@@ -84,11 +91,18 @@ module Tire
         @value = { :ids => { :values => values, :type => type }  }
       end
 
+      def boosting(options={}, &block)
+        @boosting ||= BoostingQuery.new(options)
+        block.arity < 1 ? @boosting.instance_eval(&block) : block.call(@boosting) if block_given?
+        @value[:boosting] = @boosting.to_hash
+        @value
+      end
+
       def to_hash
         @value
       end
 
-      def to_json
+      def to_json(options={})
         to_hash.to_json
       end
 
@@ -156,7 +170,7 @@ module Tire
         @value
       end
 
-      def to_json
+      def to_json(options={})
         to_hash.to_json
       end
     end
@@ -177,10 +191,32 @@ module Tire
         @value.update(@options)
       end
 
-      def to_json
+      def to_json(options={})
         to_hash.to_json
       end
     end
 
+    class BoostingQuery
+      def initialize(options={}, &block)
+        @options = options
+        @value   = {}
+        block.arity < 1 ? self.instance_eval(&block) : block.call(self) if block_given?
+      end
+
+      def positive(&block)
+        (@value[:positive] ||= []) << Query.new(&block).to_hash
+        @value
+      end
+
+      def negative(&block)
+        (@value[:negative] ||= []) << Query.new(&block).to_hash
+        @value
+      end
+
+      def to_hash
+        @value.update(@options)
+      end
+    end
+
   end
 end

data/lib/tire/search/scan.rb

@@ -94,7 +94,7 @@ module Tire
       end
 
       def to_a;        results; end; alias :to_ary :to_a
-      def to_curl;     %Q|curl -X GET "#{url}?pretty=true" -d '#{@scroll_id}'|; end
+      def to_curl;     %Q|curl -X GET '#{url}?pretty' -d '#{@scroll_id}'|; end
 
       def __logged(error=nil)
         if Configuration.logger

data/lib/tire/search/script_field.rb

@@ -10,7 +10,7 @@ module Tire
         @hash = { name => options }
       end
 
-      def to_json
+      def to_json(options={})
         to_hash.to_json
       end
 

data/lib/tire/search/sort.rb

@@ -16,7 +16,7 @@ module Tire
         @value
       end
 
-      def to_json
+      def to_json(options={})
         @value.to_json
       end
     end

data/lib/tire/tasks.rb

@@ -3,7 +3,7 @@ require 'benchmark'
 
 namespace :tire do
 
-  full_comment = <<-DESC.gsub(/    /, '')
+  full_comment_import = <<-DESC.gsub(/    /, '')
     Import data from your model using paginate: rake environment tire:import CLASS='MyModel'.
 
     Pass params for the `paginate` method:
@@ -15,7 +15,7 @@ namespace :tire do
     Set target index name:
       $ rake environment tire:import CLASS='Article' INDEX='articles-new'
   DESC
-  desc full_comment
+  desc full_comment_import
   task :import do |t|
 
     def elapsed_to_human(elapsed)
@@ -24,18 +24,18 @@ namespace :tire do
 
       case elapsed
       when 0..59
-        "#{sprintf("%1.5f", elapsed)} seconds"
+        "#{sprintf("%1.2f", elapsed)} seconds"
       when 60..hour-1
-        "#{elapsed/60} minutes and #{elapsed % 60} seconds"
+        "#{(elapsed/60).floor} minutes and #{(elapsed % 60).floor} seconds"
       when hour..day
-        "#{elapsed/hour} hours and #{elapsed % hour} minutes"
+        "#{(elapsed/hour).floor} hours and #{(elapsed/60 % hour).floor} minutes"
       else
-        "#{elapsed/hour} hours"
+        "#{(elapsed/hour).round} hours"
       end
     end
 
     if ENV['CLASS'].to_s == ''
-      puts '='*90, 'USAGE', '='*90, full_comment, ""
+      puts '='*90, 'USAGE', '='*90, full_comment_import, ""
       exit(1)
     end
 
@@ -52,16 +52,19 @@ namespace :tire do
     end
 
     unless index.exists?
-      mapping = defined?(Yajl) ? Yajl::Encoder.encode(klass.tire.mapping_to_hash, :pretty => true) :
-                                 MultiJson.encode(klass.tire.mapping_to_hash)
+      mapping = MultiJson.encode(klass.tire.mapping_to_hash, :pretty => Tire::Configuration.pretty)
       puts "[IMPORT] Creating index '#{index.name}' with mapping:", mapping
-      index.create :mappings => klass.tire.mapping_to_hash, :settings => klass.tire.settings
+      unless index.create( :mappings => klass.tire.mapping_to_hash, :settings => klass.tire.settings )
+        STDERR.puts "[ERROR] There has been an error when creating the index -- elasticsearch returned:",
+                    index.response
+        exit(1)
+      end
     end
 
     STDOUT.sync = true
     puts "[IMPORT] Starting import for the '#{ENV['CLASS']}' class"
     tty_cols = 80
-    total    = klass.all.count rescue nil
+    total    = klass.count rescue nil
     offset   = (total.to_s.size*2)+8
     done     = 0
 
@@ -101,7 +104,7 @@ namespace :tire do
 
   namespace :index do
 
-    full_comment = <<-DESC.gsub(/      /, '')
+    full_comment_drop = <<-DESC.gsub(/      /, '')
       Delete indices passed in the INDEX environment variable; separate multiple indices by comma.
 
       Pass name of a single index to drop in the INDEX environmnet variable:
@@ -111,12 +114,12 @@ namespace :tire do
         $ rake environment tire:index:drop INDICES=articles-2011-01,articles-2011-02
 
     DESC
-    desc full_comment
+    desc full_comment_drop
     task :drop do
       index_names = (ENV['INDEX'] || ENV['INDICES']).to_s.split(/,\s*/)
 
       if index_names.empty?
-        puts '='*90, 'USAGE', '='*90, full_comment, ""
+        puts '='*90, 'USAGE', '='*90, full_comment_drop, ""
         exit(1)
       end