tire 0.1.14 → 0.1.15

data/README.markdown

@@ -557,4 +557,4 @@ You can send feedback via [e-mail](mailto:karmi@karmi.cz) or via [Github Issues]
 
 -----
 
-[Karel Minarik](http://karmi.cz)
+[Karel Minarik](http://karmi.cz) and [contributors](http://github.com/karmi/tire/contributors)

data/examples/tire-dsl.rb

@@ -61,14 +61,56 @@ Tire.index 'articles' do
   create
 
   # We want to store and index some articles with `title`, `tags` and `published_on` properties.
-  # Simple Hashes are OK.
+  # Simple Hashes are OK. The default type is „document”.
   #
   store :title => 'One',   :tags => ['ruby'],           :published_on => '2011-01-01'
   store :title => 'Two',   :tags => ['ruby', 'python'], :published_on => '2011-01-02'
-  store :title => 'Three', :tags => ['java'],           :published_on => '2011-01-02'
-  store :title => 'Four',  :tags => ['ruby', 'php'],    :published_on => '2011-01-03'
 
-  # We force refreshing the index, so we can query it immediately.
+  # We usually want to set a specific _type_ for the document in _ElasticSearch_.
+  # Simply setting a `type` property is OK.
+  #
+  store :type => 'article',
+        :title => 'Three',
+        :tags => ['java'],
+        :published_on => '2011-01-02'
+
+  # We may want to wrap your data in a Ruby class, and use it when storing data.
+  # The contract required of such a class is very simple.
+  #
+  class Article
+
+    #
+    attr_reader :title, :tags, :published_on
+    def initialize(attributes={})
+      @attributes =  attributes
+      @attributes.each_pair { |name,value| instance_variable_set :"@#{name}", value }
+    end
+
+    # It must provide a `type`, `_type` or `document_type` method for propper mapping.
+    #
+    def type
+      'article'
+    end
+
+    # And it must provide a `to_indexed_json` method for conversion to JSON.
+    #
+    def to_indexed_json
+      @attributes.to_json
+    end
+  end
+
+  # Note: Since our class takes a Hash of attributes on initialization, we may even
+  # wrap the results in instances of this class; we'll see how to do that further below.
+  #
+  article = Article.new :title => 'Four',
+                        :tags => ['ruby', 'php'],
+                        :published_on => '2011-01-03'
+
+  # Let's store the `article`, now.
+  #
+  store article
+
+  # And let's „force refresh“ the index, so we can query it immediately.
   #
   refresh
 end
@@ -77,22 +119,23 @@ end
 # for the index.
 
 Tire.index 'articles' do
-  # To do so, just pass a Hash containing the specified mapping to the `Index#create` method.
+  # To do so, let's just pass a Hash containing the specified mapping to the `Index#create` method.
   #
   create :mappings => {
 
-    # Specify for which type of documents this mapping should be used.
+    # Let's specify for which _type_ of documents this mapping should be used:
+    # „article”, in our case.
     #
     :article => {
       :properties => {
 
-        # Specify the type of the field, whether it should be analyzed, etc.
+        # Let's specify the type of the field, whether it should be analyzed, ...
         #
         :id       => { :type => 'string', :index => 'not_analyzed', :include_in_all => false },
 
-        # Set the boost or analyzer settings for the field, ... The _ElasticSearch_ guide
-        # has [more information](http://elasticsearch.org/guide/reference/mapping/index.html)
-        # about this. Proper mapping is key to efficient and effective search.
+        # ... set the boost or analyzer settings for the field, etc. The _ElasticSearch_ guide
+        # has [more information](http://elasticsearch.org/guide/reference/mapping/index.html).
+        # Don't forget, that proper mapping is key to efficient and effective search.
         # But don't fret about getting the mapping right the first time, you won't.
         # In most cases, the default, dynamic mapping is just fine for prototyping.
         #
@@ -116,10 +159,13 @@ articles = [
 
   # Notice that such objects must have an `id` property!
   #
-  { :id => '1', :title => 'one',   :tags => ['ruby'],           :published_on => '2011-01-01' },
-  { :id => '2', :title => 'two',   :tags => ['ruby', 'python'], :published_on => '2011-01-02' },
-  { :id => '3', :title => 'three', :tags => ['java'],           :published_on => '2011-01-02' },
-  { :id => '4', :title => 'four',  :tags => ['ruby', 'php'],    :published_on => '2011-01-03' }
+  { :id => '1', :type => 'article', :title => 'one',   :tags => ['ruby'],           :published_on => '2011-01-01' },
+
+  # And, of course, they should contain the `type` property for the mapping to work!
+  #
+  { :id => '2', :type => 'article', :title => 'two',   :tags => ['ruby', 'python'], :published_on => '2011-01-02' },
+  { :id => '3', :type => 'article', :title => 'three', :tags => ['java'],           :published_on => '2011-01-02' },
+  { :id => '4', :type => 'article', :title => 'four',  :tags => ['ruby', 'php'],    :published_on => '2011-01-03' }
 ]
 
 # We can just push them into the index in one go.
@@ -209,7 +255,7 @@ end
 # To do that, we have to use a slight variation of the DSL.
 #
 
-# Let's assume we have a plain Article class.
+# Let's assume we have a plain Ruby class, named `Article`.
 #
 class Article
 
@@ -219,7 +265,7 @@ class Article
     "title:T*"
   end
 
-  # ... and wrap the _Tire_ search method.
+  # ... and wrap the _Tire_ search method in another one.
   def self.search
 
     # Notice how we pass the `search` object around as a block argument.
@@ -298,13 +344,14 @@ Tire.configure do
   #
   url "http://search.example.com"
 
-  # Second, we may want to wrap the result items in our own class.
+  # Second, we may want to wrap the result items in our own class, for instance
+  # the `Article` class set above.
   #
-  class MySpecialWrapper; end
-  wrapper MySpecialWrapper
+  wrapper Article
 
   # Finally, we can reset one or all configuration settings to their defaults.
   #
+  reset :url
   reset
 
 end

data/lib/tire/client.rb

@@ -2,25 +2,7 @@ module Tire
 
   module Client
 
-    class Base
-      def get(url, data=nil)
-        raise_no_method_error
-      end
-      def post(url, data)
-        raise_no_method_error
-      end
-      def put(url, data)
-        raise NoMethodError, "Implement this method in your client class"
-      end
-      def delete(url)
-        raise_no_method_error
-      end
-      def raise_no_method_error
-        raise NoMethodError, "Implement this method in your client class"
-      end
-    end
-
-    class RestClient < Base
+    class RestClient
       def self.get(url, data=nil)
         ::RestClient::Request.new(:method => :get, :url => url, :payload => data).execute
       end

data/lib/tire/configuration.rb

@@ -3,7 +3,7 @@ module Tire
   class Configuration
 
     def self.url(value=nil)
-      @url    = value || @url || "http://localhost:9200"
+      @url    = (value ? value.to_s.gsub(%r|/*$|, '') : nil) || @url || "http://localhost:9200"
     end
 
     def self.client(klass=nil)

data/lib/tire/index.rb

@@ -41,13 +41,20 @@ module Tire
     end
 
     def store(*args)
-      # TODO: Infer type from the document (hash property, method)
-      # TODO: Refactor common logic for getting id, JSON, into private methods
-
-      case args.size
-        when 3 then (type, document, options = args)
-        when 2 then (type, document = args)
-        else        (document = args.pop; type = :document)
+      case
+        when ( args.size === 3 && (args.first.is_a?(String) || args.first.is_a?(Symbol)) )
+          Tire.warn "Passing the document type as argument in Index#store has been deprecated, " +
+                    "please pass a Hash with _type/type property, or " +
+                    "an object with _type/type/document_type method."
+          type, document, options = args
+        when ( args.size === 2 && (args.first.is_a?(String) || args.first.is_a?(Symbol)) )
+          Tire.warn "Passing the document type as argument in Index#store has been deprecated" +
+                    "please pass a Hash with _type/type property, or " +
+                    "an object with _type/type/document_type method."
+          type, document = args
+        else
+          document, options = args
+          type = get_type_from_document(document)
       end
 
       if options
@@ -55,18 +62,8 @@ module Tire
         percolate = "*" if percolate === true
       end
 
-      old_verbose, $VERBOSE = $VERBOSE, nil # Silence Object#id deprecation warnings
-      id = case true
-        when document.is_a?(Hash)                                           then document[:id] || document['id']
-        when document.respond_to?(:id) && document.id != document.object_id then document.id
-      end
-      $VERBOSE = old_verbose
-
-      document = case true
-        when document.is_a?(String) then 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
+      id       = get_id_from_document(document)
+      document = convert_document_to_json(document)
 
       url  = id ? "#{Configuration.url}/#{@name}/#{type}/#{id}" : "#{Configuration.url}/#{@name}/#{type}/"
       url += "?percolate=#{percolate}" if percolate
@@ -83,22 +80,14 @@ module Tire
 
     def bulk_store documents
       payload = documents.map do |document|
-        old_verbose, $VERBOSE = $VERBOSE, nil # Silence Object#id deprecation warnings
-        id = case
-          when document.is_a?(Hash)                                           then document[:id] || document['id']
-          when document.respond_to?(:id) && document.id != document.object_id then document.id
-          # TODO: Raise error when no id present
-        end
-        $VERBOSE = old_verbose
+        id   = get_id_from_document(document)
+        type = get_type_from_document(document)
 
-        type = case
-          when document.is_a?(Hash)                 then document[:type] || document['type']
-          when document.respond_to?(:document_type) then document.document_type
-        end || 'document'
+        STDERR.puts "[ERROR] Document #{document.inspect} does not have ID" unless id
 
         output = []
         output << %Q|{"index":{"_index":"#{@name}","_type":"#{type}","_id":"#{id}"}}|
-        output << document.to_indexed_json
+        output << convert_document_to_json(document)
         output.join("\n")
       end
       payload << ""
@@ -107,8 +96,6 @@ module Tire
       count = 0
 
       begin
-        # STDERR.puts "Posting payload..."
-        # STDERR.puts payload.join("\n")
         Configuration.client.post("#{Configuration.url}/_bulk", payload.join("\n"))
       rescue Exception => error
         if count < tries
@@ -127,14 +114,11 @@ module Tire
     end
 
     def import(klass_or_collection, method=nil, options={})
-      # p [klass_or_collection, method, options]
-
       case
-
         when method
           options = {:page => 1, :per_page => 1000}.merge options
           while documents = klass_or_collection.send(method.to_sym, options.merge(:page => options[:page])) \
-                            and not documents.empty?
+                            and documents.size > 0
             documents = yield documents if block_given?
 
             bulk_store documents
@@ -144,34 +128,31 @@ module Tire
         when klass_or_collection.respond_to?(:map)
           documents = block_given? ? yield(klass_or_collection) : klass_or_collection
           bulk_store documents
+
         else
-          raise ArgumentError, "Please pass either a collection of objects, "+
+          raise ArgumentError, "Please pass either a collection of objects, " +
                                "or method for fetching records, or Enumerable compatible class"
       end
     end
 
     def remove(*args)
-      # TODO: Infer type from the document (hash property, method)
-
       if args.size > 1
-        (type, document = args)
+        type, document = args
+        id             = get_id_from_document(document) || document
       else
-        (document = args.pop; type = :document)
+        document = args.pop
+        type     = get_type_from_document(document)
+        id       = get_id_from_document(document) || document
       end
-
-      old_verbose, $VERBOSE = $VERBOSE, nil # Silence Object#id deprecation warnings
-      id = case true
-        when document.is_a?(Hash)                                           then document[:id] || document['id']
-        when document.respond_to?(:id) && document.id != document.object_id then document.id
-        else document
-      end
-      $VERBOSE = old_verbose
+      raise ArgumentError, "Please pass a document ID" unless id
 
       result = Configuration.client.delete "#{Configuration.url}/#{@name}/#{type}/#{id}"
       MultiJson.decode(result) if result
     end
 
     def retrieve(type, id)
+      raise ArgumentError, "Please pass a document ID" unless id
+
       @response = Configuration.client.get "#{Configuration.url}/#{@name}/#{type}/#{id}"
       h = MultiJson.decode(@response.body)
       if Configuration.wrapper == Hash then h
@@ -237,19 +218,17 @@ module Tire
     end
 
     def percolate(*args, &block)
-      # TODO: Infer type from the document (hash property, method)
-
       if args.size > 1
-        (type, document = args)
+        Tire.warn "Passing the document type as argument in Index#percolate has been deprecated, " +
+                  "please pass a Hash with _type/type property, or " +
+                  "an object with _type/type/document_type method."
+        type, document = args
       else
-        (document = args.pop; type = :document)
+        document = args.pop
+        type     = get_type_from_document(document)
       end
 
-      document = case true
-        when document.is_a?(String) then document
-        when document.respond_to?(:to_hash) then document.to_hash
-        else raise ArgumentError, "Please pass a JSON string or object with a 'to_hash' method"
-      end
+      document = MultiJson.decode convert_document_to_json(document)
 
       query = Search::Query.new(&block).to_hash if block_given?
 
@@ -288,5 +267,41 @@ module Tire
       end
     end
 
+    def get_type_from_document(document)
+      old_verbose, $VERBOSE = $VERBOSE, nil # Silence Object#type deprecation warnings
+      type = case
+        when document.respond_to?(:document_type)
+          document.document_type
+        when document.is_a?(Hash)
+          document.delete(:_type) || document.delete('_type') || document.delete(:type) || document.delete('type')
+        when document.respond_to?(:_type)
+          document._type
+        when document.respond_to?(:type) && document.type != document.class
+          document.type
+        end
+      $VERBOSE = old_verbose
+      type ||= :document
+    end
+
+    def get_id_from_document(document)
+      old_verbose, $VERBOSE = $VERBOSE, nil # Silence Object#id deprecation warnings
+      id = case
+        when document.is_a?(Hash)
+          document[:_id] || document['_id'] || document[:id] || document['id']
+        when document.respond_to?(:id) && document.id != document.object_id
+          document.id
+      end
+      $VERBOSE = old_verbose
+      id
+    end
+
+    def convert_document_to_json(document)
+      document = case
+        when document.is_a?(String) then 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
+    end
+
   end
 end

data/lib/tire/model/search.rb

@@ -35,15 +35,14 @@ module Tire
         def search(query=nil, options={}, &block)
           old_wrapper = Tire::Configuration.wrapper
           Tire::Configuration.wrapper self
-          sort  = options[:order] || options[:sort]
-          sort  = Array(sort)
+          sort  = Array( options[:order] || options[:sort] )
           unless block_given?
             s = Tire::Search::Search.new(elasticsearch_index.name, options)
             s.query { string query }
             s.sort do
               sort.each do |t|
                 field_name, direction = t.split(' ')
-                field_name.include?('.') ? field(field_name, direction) : send(field_name, direction)
+                by field_name, direction
               end
             end unless sort.empty?
             s.size( options[:per_page].to_i ) if options[:per_page]
@@ -75,7 +74,7 @@ module Tire
       module InstanceMethods
 
         def score
-          STDERR.puts "DEPRECATED! Please use #{self.class}#_score instead."
+          Tire.warn "#{self.class}#score has been deprecated, please use #{self.class}#_score instead."
           attributes['_score']
         end
 
@@ -86,9 +85,9 @@ module Tire
         def update_elastic_search_index
           _run_update_elastic_search_index_callbacks do
             if destroyed?
-              index.remove document_type, self
+              index.remove self
             else
-              response  = index.store( document_type, self, {:percolate => self.percolator} )
+              response  = index.store( self, {:percolate => self.percolator} )
               self.id ||= response['_id'] if self.respond_to?(:id=)
               self._index   = response['_index']
               self._type    = response['_type']
@@ -98,6 +97,7 @@ module Tire
             end
           end
         end
+        alias :update_elasticsearch_index :update_elastic_search_index
 
         def to_indexed_json
           if self.class.mapping.empty?

data/lib/tire/search/sort.rb

@@ -4,20 +4,19 @@ module Tire
     class Sort
       def initialize(&block)
         @value = []
-        self.instance_eval(&block) if block_given?
+        block.arity < 1 ? self.instance_eval(&block) : block.call(self) if block_given?
       end
 
-      def field(name, direction=nil)
+      def by(name, direction=nil)
         @value << ( direction ? { name => direction } : name )
         self
       end
 
       def method_missing(id, *args, &block)
-        case arg = args.shift
-          when String, Symbol, Hash then @value << { id => arg }
-          else @value << id
-        end
-        self
+        Tire.warn "Using methods when sorting has been deprecated, please use the `by` method: " +
+                  "sort { by :#{id}#{ args.empty? ? '' : ', ' + args.first.inspect } }"
+
+        by id, args.shift
       end
 
       def to_ary

data/lib/tire/version.rb

@@ -1,12 +1,12 @@
 module Tire
-  VERSION          = "0.1.14"
+  VERSION          = "0.1.15"
 
   CHANGELOG =<<-END
     IMPORTANT CHANGES LATELY:
 
-    # Added `<after/before>_update_elastic_search_index` callbacks for models
-    # Added percolator support for DSL and ActiveModel
-    # Lazy loading of ResultsCollection into memory
-    # Fixes for debug logging
+    # 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
   END
 end

data/lib/tire.rb

@@ -7,7 +7,6 @@ require 'tire/rubyext/symbol'
 require 'tire/logger'
 require 'tire/configuration'
 require 'tire/client'
-require 'tire/client'
 require 'tire/search'
 require 'tire/search/query'
 require 'tire/search/sort'
@@ -33,4 +32,10 @@ require 'tire/tasks'
 
 module Tire
   extend DSL
+
+  def warn(message)
+    line = caller.detect { |line| line !~ %r|lib\/tire\/| }.sub(/:in .*/, '')
+    STDERR.puts  "", "\e[31m[DEPRECATION WARNING] #{message}", "(Called from #{line})", "\e[0m"
+  end
+  module_function :warn
 end

data/test/integration/active_record_searchable_test.rb

@@ -132,7 +132,7 @@ module Tire
           should "find first page with five results" do
             results = ActiveRecordArticle.search do |search|
               search.query { |query| query.string @q }
-              search.sort  { title }
+              search.sort  { by :title }
               search.from 0
               search.size 5
             end
@@ -149,7 +149,7 @@ module Tire
           should "find next page with five results" do
             results = ActiveRecordArticle.search do |search|
               search.query { |query| query.string @q }
-              search.sort  { title }
+              search.sort  { by :title }
               search.from 5
               search.size 5
             end
@@ -166,7 +166,7 @@ module Tire
           should "not find a missing page" do
             results = ActiveRecordArticle.search do |search|
               search.query { |query| query.string @q }
-              search.sort  { title }
+              search.sort  { by :title }
               search.from 10
               search.size 5
             end

data/test/integration/index_mapping_test.rb

@@ -12,7 +12,7 @@ module Tire
 
         index = Tire.index 'mapped-index' do
           create
-          store :article, :title => 'One'
+          store :type => :article, :title => 'One'
           refresh
         end
         sleep 1.5

data/test/integration/percolator_test.rb

@@ -83,17 +83,17 @@ module Tire
         end
 
         should "return an empty array when no query matches" do
-          response = @index.store :document, {:message => 'Situation normal'}, {:percolate => true}
+          response = @index.store( {:message => 'Situation normal'}, {:percolate => true} )
           assert_equal [], response['matches']
         end
 
         should "return an array of matching query names" do
-          response = @index.store :document, {:message => 'Severe weather warning'}, {:percolate => true}
+          response = @index.store( {:message => 'Severe weather warning'}, {:percolate => true} )
           assert_equal ['alert','weather'], response['matches'].sort
         end
 
         should "return an array of matching query names for specific percolated queries" do
-          response = @index.store :document, {:message => 'Severe weather warning'}, {:percolate => 'tags:weather'}
+          response = @index.store( {:message => 'Severe weather warning'}, {:percolate => 'tags:weather'} )
           assert_equal ['weather'], response['matches']
         end
       end

data/test/integration/sort_test.rb

@@ -11,7 +11,7 @@ module Tire
         q = '*'
         s = Tire.search('articles-test') do
           query { string q }
-          sort  { title }
+          sort  { by :title }
         end
 
         assert_equal 5, s.results.count
@@ -22,7 +22,7 @@ module Tire
         q = '*'
         s = Tire.search('articles-test') do
           query { string q }
-          sort  { title :desc }
+          sort  { by :title, :desc }
         end
 
         assert_equal 5, s.results.count

data/test/unit/client_test.rb

@@ -4,25 +4,6 @@ module Tire
 
   class ClientTest < Test::Unit::TestCase
 
-    context "Base" do
-      setup { @http ||= Client::Base.new }
-
-      should "have abstract methods" do
-        assert_raise(ArgumentError) { @http.get                }
-        assert_raise(NoMethodError) { @http.get 'URL'          }
-
-        assert_raise(ArgumentError) { @http.post               }
-        assert_raise(ArgumentError) { @http.post 'URL'         }
-        assert_raise(NoMethodError) { @http.post 'URL', 'DATA' }
-
-        assert_raise(ArgumentError) { @http.put               }
-        assert_raise(ArgumentError) { @http.put 'URL'         }
-
-        assert_raise(ArgumentError) { @http.delete       }
-        assert_raise(NoMethodError) { @http.delete 'URL' }
-      end
-    end
-
     context "RestClient" do
 
       should "be default" do

data/test/unit/configuration_test.rb

@@ -27,13 +27,13 @@ module Tire
         assert_equal 'http://example.com', Configuration.url
       end
 
-      should "return default client" do
-        assert_equal Client::RestClient, Configuration.client
+      should "strip trailing slash from the URL" do
+        assert_nothing_raised { Configuration.url 'http://slash.com:9200/' }
+        assert_equal 'http://slash.com:9200', Configuration.url
       end
 
-      should "allow setting and retrieving the client" do
-        assert_nothing_raised { Configuration.client Client::Base }
-        assert_equal Client::Base, Configuration.client
+      should "return default client" do
+        assert_equal Client::RestClient, Configuration.client
       end
 
       should "return nil as logger by default" do
@@ -48,21 +48,18 @@ module Tire
 
       should "allow to reset the configuration for specific property" do
         Configuration.url 'http://example.com'
-        Configuration.client Client::Base
-        assert_equal 'http://example.com', Configuration.url
+        assert_equal      'http://example.com', Configuration.url
         Configuration.reset :url
-        assert_equal 'http://localhost:9200', Configuration.url
-        assert_equal Client::Base, Configuration.client
+        assert_equal      'http://localhost:9200', Configuration.url
       end
 
       should "allow to reset the configuration for all properties" do
-        Configuration.url 'http://example.com'
-        Configuration.client Client::Base
-        assert_equal 'http://example.com', Configuration.url
-        assert_equal Client::Base, Configuration.client
+        Configuration.url     'http://example.com'
+        Configuration.wrapper Hash
+        assert_equal          'http://example.com', Configuration.url
         Configuration.reset
-        assert_equal 'http://localhost:9200', Configuration.url
-        assert_equal Client::RestClient, Configuration.client
+        assert_equal          'http://localhost:9200', Configuration.url
+        assert_equal          Client::RestClient, Configuration.client
       end
     end
 

data/test/unit/index_test.rb

@@ -101,10 +101,42 @@ module Tire
 
       context "when storing" do
 
-        should "properly set type from args" do
-          Configuration.client.expects(:post).with("#{Configuration.url}/dummy/article/", '{"title":"Test"}').returns(mock_response('{"ok":true,"_id":"test"}')).twice
-          @index.store 'article', :title => 'Test'
-          @index.store :article,  :title => 'Test'
+        should "set type from Hash :type property" do
+          Configuration.client.expects(:post).with do |url,document|
+            url == "#{Configuration.url}/dummy/article/"
+          end.returns(mock_response('{"ok":true,"_id":"test"}'))
+          @index.store :type => 'article', :title => 'Test'
+        end
+
+        should "set type from Hash :_type property" do
+          Configuration.client.expects(:post).with do |url,document|
+            url == "#{Configuration.url}/dummy/article/"
+          end.returns(mock_response('{"ok":true,"_id":"test"}'))
+          @index.store :_type => 'article', :title => 'Test'
+        end
+
+        should "set type from Object _type method" do
+          Configuration.client.expects(:post).with do |url,document|
+            url == "#{Configuration.url}/dummy/article/"
+          end.returns(mock_response('{"ok":true,"_id":"test"}'))
+
+          article = Class.new do
+            def _type; 'article'; end
+            def to_indexed_json; "{}"; end
+          end.new
+          @index.store article
+        end
+
+        should "set type from Object type method" do
+          Configuration.client.expects(:post).with do |url,document|
+            url == "#{Configuration.url}/dummy/article/"
+          end.returns(mock_response('{"ok":true,"_id":"test"}'))
+
+          article = Class.new do
+            def type; 'article'; end
+            def to_indexed_json; "{}"; end
+          end.new
+          @index.store article
         end
 
         should "set default type" do
@@ -151,7 +183,7 @@ module Tire
 
           Configuration.client.stubs(:post).with("#{Configuration.url}/dummy/article/", '{"title":"Test"}').
                                             returns(mock_response('{"ok":true,"_id":"id-1"}'))
-          @index.store :article, :title => 'Test'
+          @index.store :type => 'article', :title => 'Test'
         end
 
         should "return document in default wrapper" do
@@ -182,21 +214,27 @@ module Tire
           assert_equal 'Test', article.title
         end
 
+        should "raise error when no ID passed" do
+          assert_raise ArgumentError do
+            @index.retrieve 'article', nil
+          end
+        end
+
       end
 
       context "when removing" do
 
-        should "properly set type from args" do
-          Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/article/").
-                                                returns('{"ok":true,"_id":"test"}').twice
-          @index.remove 'article', :title => 'Test'
-          @index.remove :article,  :title => 'Test'
+        should "get type from document" do
+          Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/article/1").
+                                                returns('{"ok":true,"_id":"1"}').twice
+          @index.remove :id => 1, :type => 'article', :title => 'Test'
+          @index.remove :id => 1, :type => 'article', :title => 'Test'
         end
 
         should "set default type" do
-          Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/document/").
-                                                returns('{"ok":true,"_id":"test"}')
-          @index.remove :title => 'Test'
+          Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/document/1").
+                                                returns('{"ok":true,"_id":"1"}')
+          @index.remove :id => 1, :title => 'Test'
         end
 
         should "get ID from hash" do
@@ -212,10 +250,16 @@ module Tire
           @index.remove document
         end
 
-        should "get ID from arguments" do
-          Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/document/1").
+        should "get type and ID from arguments" do
+          Configuration.client.expects(:delete).with("#{Configuration.url}/dummy/article/1").
                                                 returns('{"ok":true,"_id":"1"}')
-          @index.remove :document, 1
+          @index.remove :article, 1
+        end
+
+        should "raise error when no ID passed" do
+          assert_raise ArgumentError do
+            @index.remove :document, nil
+          end
         end
 
       end
@@ -275,8 +319,12 @@ module Tire
           end
         end
 
-        should_eventually "raise exception when collection item does not have ID" do
-          # TODO: raise exception when collection item does not have ID
+        should "raise exception when collection item does not have ID" do
+          Configuration.client.expects(:post).with { |url, json| url  == "#{Configuration.url}/_bulk" }
+          STDERR.expects(:puts).once
+
+          documents = [ { :title => 'Bogus' }, { :title => 'Real', :id => 1 } ]
+          ActiveModelArticle.elasticsearch_index.bulk_store documents
         end
 
       end
@@ -479,7 +527,7 @@ module Tire
                                               end.
                                returns(mock_response('{"ok":true,"_id":"test","matches":["alerts"]}'))
 
-          matches = @index.percolate :article, :title => 'Test'
+          matches = @index.percolate :type => 'article', :title => 'Test'
           assert_equal ["alerts"], matches
         end
 
@@ -502,13 +550,13 @@ module Tire
           should "percolate document against all registered queries" do
             Configuration.client.expects(:post).with("#{Configuration.url}/dummy/article/?percolate=*", '{"title":"Test"}').
                                  returns(mock_response('{"ok":true,"_id":"test","matches":["alerts"]}'))
-            @index.store :article, {:title => 'Test'}, {:percolate => true}
+            @index.store( {:type => 'article', :title => 'Test'}, {:percolate => true} )
           end
 
           should "percolate document against specific queries" do
             Configuration.client.expects(:post).with("#{Configuration.url}/dummy/article/?percolate=tag:alerts", '{"title":"Test"}').
                                  returns(mock_response('{"ok":true,"_id":"test","matches":["alerts"]}'))
-            response = @index.store :article, {:title => 'Test'}, {:percolate => 'tag:alerts'}
+            response = @index.store( {:type => 'article', :title => 'Test'}, {:percolate => 'tag:alerts'} )
             assert_equal response['matches'], ['alerts']
           end
 

data/test/unit/model_search_test.rb

@@ -96,7 +96,7 @@ module Tire
           document = collection.first
 
           assert_instance_of ActiveModelArticle, document
-          assert_not_nil document.score
+          assert_not_nil document._score
           assert_equal 1, document.id
           assert_equal 'Article', document.title
         end
@@ -139,26 +139,26 @@ module Tire
           end
 
           should "allow to pass :order option" do
-            Tire::Search::Sort.any_instance.expects(:title)
+            Tire::Search::Sort.any_instance.expects(:by).with('title', nil)
 
             ActiveModelArticle.search @q, :order => 'title'
           end
 
           should "allow to pass :sort option as :order option" do
-            Tire::Search::Sort.any_instance.expects(:title)
+            Tire::Search::Sort.any_instance.expects(:by).with('title', nil)
 
             ActiveModelArticle.search @q, :sort => 'title'
           end
 
           should "allow to specify sort direction" do
-            Tire::Search::Sort.any_instance.expects(:title).with('DESC')
+            Tire::Search::Sort.any_instance.expects(:by).with('title', 'DESC')
 
             ActiveModelArticle.search @q, :order => 'title DESC'
           end
 
           should "allow to specify more fields to sort on" do
-            Tire::Search::Sort.any_instance.expects(:title).with('DESC')
-            Tire::Search::Sort.any_instance.expects(:field).with('author.name', nil)
+            Tire::Search::Sort.any_instance.expects(:by).with('title', 'DESC')
+            Tire::Search::Sort.any_instance.expects(:by).with('author.name', nil)
 
             ActiveModelArticle.search @q, :order => ['title DESC', 'author.name']
           end
@@ -417,8 +417,8 @@ module Tire
           should "mark the instance for percolation on index update" do
             @article.percolate = true
 
-            Tire::Index.any_instance.expects(:store).with do |type,doc,options|
-              # p [type,doc,options]
+            Tire::Index.any_instance.expects(:store).with do |doc,options|
+              # p [doc,options]
               options[:percolate] == true
             end.returns(MultiJson.decode('{"ok":true,"_id":"test","matches":["alerts"]}'))
 
@@ -426,8 +426,8 @@ module Tire
           end
 
           should "not percolate document on index update when not set for percolation" do
-            Tire::Index.any_instance.expects(:store).with do |type,doc,options|
-              # p [type,doc,options]
+            Tire::Index.any_instance.expects(:store).with do |doc,options|
+              # p [doc,options]
               options[:percolate] == nil
             end.returns(MultiJson.decode('{"ok":true,"_id":"test"}'))
 
@@ -455,8 +455,8 @@ module Tire
               percolate!
             end
 
-            Tire::Index.any_instance.expects(:store).with do |type,doc,options|
-              # p [type,doc,options]
+            Tire::Index.any_instance.expects(:store).with do |doc,options|
+              # p [doc,options]
               options[:percolate] == true
             end.returns(MultiJson.decode('{"ok":true,"_id":"test","matches":["alerts"]}'))
 
@@ -472,7 +472,7 @@ module Tire
             percolated = ActiveModelArticleWithPercolation.new :title => 'Percolate me!'
 
             Tire::Index.any_instance.expects(:store).
-                                     with do |type,doc,options|
+                                     with do |doc,options|
                                        doc == percolated &&
                                        options[:percolate] == true
                                      end.
@@ -491,7 +491,7 @@ module Tire
             percolated = ActiveModelArticleWithPercolation.new :title => 'Percolate me!'
 
             Tire::Index.any_instance.expects(:store).
-                                     with do |type,doc,options|
+                                     with do |doc,options|
                                        doc == percolated &&
                                        options[:percolate] == 'tags:alert'
                                      end.

data/test/unit/search_sort_test.rb

@@ -6,41 +6,74 @@ module Tire::Search
 
     context "Sort" do
 
-      should "be serialized to JSON" do
-        assert_respond_to Sort.new, :to_json
-      end
+      context "with the old interface" do
 
-      should "encode simple strings" do
-        assert_equal [:foo].to_json, Sort.new.foo.to_json
-      end
+        should "encode simple strings" do
+          assert_equal [:foo].to_json, Sort.new.foo.to_json
+        end
 
-      should "encode method arguments" do
-        assert_equal [:foo => 'desc'].to_json, Sort.new.foo('desc').to_json
-      end
+        should "encode method arguments" do
+          assert_equal [:foo => 'desc'].to_json, Sort.new.foo('desc').to_json
+        end
 
-      should "encode hash" do
-        assert_equal [ :foo => { :reverse => true } ].to_json, Sort.new.foo(:reverse => true).to_json
-      end
+        should "encode hash" do
+          assert_equal [ :foo => { :reverse => true } ].to_json, Sort.new.foo(:reverse => true).to_json
+        end
 
-      should "encode multiple sort fields" do
-        assert_equal [:foo, :bar].to_json, Sort.new.foo.bar.to_json
-      end
+        should "encode multiple sort fields" do
+          assert_equal [:foo, :bar].to_json, Sort.new.foo.bar.to_json
+        end
 
-      should "encode fields when passed as a block to constructor" do
-        s = Sort.new do
-          foo
-          bar 'desc'
-          _score
+        should "encode fields when passed as a block to constructor with deprecated interface" do
+          s = Sort.new do
+            foo
+            bar 'desc'
+            _score
+          end
+          assert_equal [ :foo, {:bar => 'desc'}, :_score ].to_json, s.to_json
         end
-        assert_equal [ :foo, {:bar => 'desc'}, :_score ].to_json, s.to_json
+
       end
 
-      should "encode fields deeper in json" do
-        s = Sort.new { field 'author.name' }
-        assert_equal [ 'author.name' ].to_json, s.to_json
+      context "with the new interface" do
+
+        should "be serialized to JSON" do
+          assert_respond_to Sort.new, :to_json
+        end
+
+        should "encode simple strings" do
+          assert_equal [:foo].to_json, Sort.new.by(:foo).to_json
+        end
+
+        should "encode method arguments" do
+          assert_equal [:foo => 'desc'].to_json, Sort.new.by(:foo, 'desc').to_json
+        end
+
+        should "encode hash" do
+          assert_equal [ :foo => { :reverse => true } ].to_json, Sort.new.by(:foo, :reverse => true).to_json
+        end
+
+        should "encode multiple sort fields in chain" do
+          assert_equal [:foo, :bar].to_json, Sort.new.by(:foo).by(:bar).to_json
+        end
+
+        should "encode fields when passed as a block to constructor" do
+          s = Sort.new do
+            by :foo
+            by :bar, 'desc'
+            by :_score
+          end
+          assert_equal [ :foo, {:bar => 'desc'}, :_score ].to_json, s.to_json
+        end
+
+        should "encode fields deeper in json" do
+          s = Sort.new { by 'author.name' }
+          assert_equal [ 'author.name' ].to_json, s.to_json
+
+          s = Sort.new { by 'author.name', 'desc' }
+          assert_equal [ {'author.name' => 'desc'} ].to_json, s.to_json
+        end
 
-        s = Sort.new { field 'author.name', :desc }
-        assert_equal [ {'author.name' => 'desc'} ].to_json, s.to_json
       end
 
     end

data/test/unit/search_test.rb

@@ -67,7 +67,11 @@ module Tire
 
       should "allow chaining" do
         assert_nothing_raised do
-          Search::Search.new('index').query { }.sort { title 'desc' }.size(5).sort { name 'asc' }.from(1)
+          Search::Search.new('index').query { }.
+                                      sort { by :title, 'desc' }.
+                                      size(5).
+                                      sort { by :name, 'asc' }.
+                                      from(1)
         end
       end
 
@@ -108,8 +112,8 @@ module Tire
         should "allow sorting by multiple fields" do
           s = Search::Search.new('index') do
             sort do
-              title 'desc'
-              _score
+              by :title, 'desc'
+              by :_score
             end
           end
           hash = MultiJson.decode( s.to_json )

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tire
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 1
-  - 14
-  version: 0.1.14
+  - 15
+  version: 0.1.15
 platform: ruby
 authors: 
 - Karel Minarik
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-27 00:00:00 +02:00
-default_executable: 
+date: 2011-07-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -336,7 +335,6 @@ files:
 - test/unit/search_test.rb
 - test/unit/tire_test.rb
 - tire.gemspec
-has_rdoc: true
 homepage: http://github.com/karmi/tire
 licenses: []
 
@@ -349,12 +347,12 @@ post_install_message: |
   
     IMPORTANT CHANGES LATELY:
   
-    # Added `<after/before>_update_elastic_search_index` callbacks for models
-    # Added percolator support for DSL and ActiveModel
-    # Lazy loading of ResultsCollection into memory
-    # Fixes for debug logging
+    # 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
   
-    See the full changelog at <http://github.com/karmi/tire/commits/v0.1.14>.
+    See the full changelog at <http://github.com/karmi/tire/commits/v0.1.15>.
   
   --------------------------------------------------------------------------------
 
@@ -385,7 +383,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: tire
-rubygems_version: 1.5.0
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Ruby client for ElasticSearch