tire 0.2.0 → 0.2.1

data/.travis.yml

@@ -6,7 +6,8 @@ script: "bundle exec rake test:unit"
 
 rvm:
   - 1.8.7
-  - 1.9.2
+  - 1.9.3
+  - ree
 
 notifications:
   disable: true

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.2.tar.gz http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.17.2.tar.gz
-    $ tar -zxvf elasticsearch-0.17.2.tar.gz
-    $ ./elasticsearch-0.17.2/bin/elasticsearch -f
+    $ 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
 
 See, easy. On a Mac, you can also use _Homebrew_:
 
@@ -383,7 +383,7 @@ advanced facet aggregation, highlighting, etc:
 ```
 
 Second, dynamic mapping is a godsend when you're prototyping.
-For serious usage, though, you'll definitely want to define a custom mapping for your models:
+For serious usage, though, you'll definitely want to define a custom _mapping_ for your models:
 
 ```ruby
     class Article < ActiveRecord::Base
@@ -402,17 +402,63 @@ For serious usage, though, you'll definitely want to define a custom mapping for
 
 In this case, _only_ the defined model attributes are indexed. The `mapping` declaration creates the
 index when the class is loaded or when the importing features are used, and _only_ when it does not yet exist.
-(It may well be reasonable to wrap the index creation logic in a class method of your model, so you
-have better control on index creation when bootstrapping your application or when setting up the test suite.)
 
-When you want a tight grip on how the attributes are added to the index, just
-implement the `to_indexed_json` method in your model:
+Chances are, you want to declare also a custom _settings_ for the index, such as set the number of shards,
+replicas, or create elaborate analyzer chains, such as the hipster's choice: [_ngrams_](https://gist.github.com/1160430).
+In this case, just wrap the `mapping` method in a `settings` one, passing it the settings as a Hash:
 
 ```ruby
-    class Article < ActiveRecord::Base
+    class URL < ActiveRecord::Base
       include Tire::Model::Search
       include Tire::Model::Callbacks
 
+      settings :number_of_shards => 1,
+               :number_of_replicas => 1,
+               :analysis => {
+                 :filter => {
+                   :url_ngram  => {
+                     "type"     => "nGram",
+                     "max_gram" => 5,
+                     "min_gram" => 3 }
+                 },
+                 :analyzer => {
+                   :url_analyzer => {
+                      "tokenizer"    => "lowercase",
+                      "filter"       => ["stop", "url_ngram"],
+                      "type"         => "custom" }
+                 }
+               } do
+        mapping { indexes :url, :type => 'string', :analyzer => "url_analyzer" }
+      end
+    end
+```
+
+It may well be reasonable to wrap the index creation logic declared with `Tire.index('urls').create`
+in a class method of your model, in a module method, etc, so have better control on index creation when bootstrapping your application with Rake tasks or when setting up the test suite.
+_Tire_ will not hold that against you.
+
+When you want a tight grip on how the attributes are added to the index, just
+implement the `to_indexed_json` method in your model.
+
+The easiest way is to customize the `to_json` serialization support of your model:
+
+```ruby
+    class Article < ActiveRecord::Base
+      # ...
+
+      include_root_in_json = false
+      def to_indexed_json
+        to_json :except => ['updated_at'], :methods => ['length']
+      end
+    end
+```
+
+Of course, it may well be reasonable to define the indexed JSON from the ground up:
+
+```ruby
+    class Article < ActiveRecord::Base
+      # ...
+
       def to_indexed_json
         names      = author.split(/\W/)
         last_name  = names.pop
@@ -427,7 +473,6 @@ implement the `to_indexed_json` method in your model:
           }
         }.to_json
       end
-
     end
 ```
 
@@ -611,7 +656,6 @@ There are todos, plans and ideas, some of which are listed below, in the order o
 * Wrap all Tire functionality mixed into a model in a "forwardable" object, and proxy everything via this object. (The immediate problem: [Mongoid](http://mongoid.org/docs/indexing.html))
 * If we're not stepping on other's toes, bring Tire methods like `index`, `search`, `mapping` also to the class/instance top-level namespace.
 * Proper RDoc annotations for the source code
-* [Histogram](http://www.elasticsearch.org/guide/reference/api/search/facets/histogram-facet.html) facets
 * [Statistical](http://www.elasticsearch.org/guide/reference/api/search/facets/statistical-facet.html) facets
 * [Geo Distance](http://www.elasticsearch.org/guide/reference/api/search/facets/geo-distance-facet.html) facets
 * [Index aliases](http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases.html) management

data/Rakefile

@@ -14,24 +14,30 @@ end
 namespace :test do
   Rake::TestTask.new(:unit) do |test|
     test.libs << 'lib' << 'test'
-    test.pattern = 'test/unit/*_test.rb'
+    test.test_files = FileList["test/unit/*_test.rb"]
     test.verbose = true
   end
   Rake::TestTask.new(:integration) do |test|
     test.libs << 'lib' << 'test'
-    test.pattern = 'test/integration/*_test.rb'
+    test.test_files = FileList["test/integration/*_test.rb"]
     test.verbose = true
   end
 end
 
 # Generate documentation
-begin; require 'sdoc'; rescue LoadError; end
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "Tire"
-  rdoc.rdoc_files.include('README.markdown')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+begin
+  begin; require 'sdoc'; rescue LoadError; end
+  require 'rdoc/task'
+  Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "Tire"
+    rdoc.rdoc_files.include('README.markdown')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+rescue LoadError
+  task :rdoc do
+    abort "[!] RDoc gem is not available."
+  end
 end
 
 # Generate coverage reports
@@ -45,7 +51,7 @@ begin
   end
 rescue LoadError
   task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install rcov"
+    abort "[!] RCov gem is not available."
   end
 end
 

data/examples/rails-application-template.rb

@@ -62,7 +62,7 @@ file ".gitignore", <<-END.gsub(/  /, '')
   tmp/**/*
   config/database.yml
   db/*.sqlite3
-  vendor/elasticsearch-0.16.0/
+  vendor/elasticsearch-0.17.6/
 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.16.0.tar.gz \
-      "http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.16.0.tar.gz"
-    tar -zxf elasticsearch-0.16.0.tar.gz
-    rm  -f    elasticsearch-0.16.0.tar.gz
-    ./elasticsearch-0.16.0/bin/elasticsearch -p #{destination_root}/tmp/pids/elasticsearch.pid
+    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
   COMMAND
 
   puts        "\n"

data/examples/tire-dsl.rb

@@ -43,9 +43,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.2.tar.gz http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.17.2.tar.gz
- tar -zxvf elasticsearch-0.17.2.tar.gz
- ./elasticsearch-0.17.2/bin/elasticsearch -f
+ 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
 INSTALL
 
 ### Storing and indexing documents
@@ -581,6 +581,7 @@ end
 # * [terms](http://www.elasticsearch.org/guide/reference/api/search/facets/terms-facet.html)
 # * [date](http://www.elasticsearch.org/guide/reference/api/search/facets/date-histogram-facet.html)
 # * [range](http://www.elasticsearch.org/guide/reference/api/search/facets/range-facet.html)
+# * [histogram](http://www.elasticsearch.org/guide/reference/api/search/facets/histogram-facet.html)
 
 # We have seen that _ElasticSearch_ facets enable us to fetch complex aggregations from our data.
 #

data/lib/tire/client.rb

@@ -15,6 +15,9 @@ module Tire
       def self.delete(url)
         ::RestClient.delete url rescue nil
       end
+      def self.head(url)
+        ::RestClient.head url
+      end
     end
 
   end

data/lib/tire/index.rb

@@ -9,7 +9,7 @@ module Tire
     end
 
     def exists?
-      !!Configuration.client.get("#{Configuration.url}/#{@name}/_status")
+      !!Configuration.client.head("#{Configuration.url}/#{@name}")
     rescue Exception => error
       false
     end
@@ -105,7 +105,8 @@ module Tire
         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.to_a.length > 0
+
             documents = yield documents if block_given?
 
             bulk_store documents
@@ -205,7 +206,7 @@ module Tire
     end
 
     def percolate(*args, &block)
-      document = args.pop
+      document = args.shift
       type     = get_type_from_document(document)
 
       document = MultiJson.decode convert_document_to_json(document)

data/lib/tire/model/indexing.rb

@@ -5,14 +5,19 @@ module Tire
 
       module ClassMethods
 
+        def settings(*args)
+          @settings ||= {}
+          args.empty?  ? (return @settings) : @settings = args.pop
+          yield if block_given?
+        end
+
         def mapping
+          @mapping ||= {}
           if block_given?
-            @store_mapping = true
-            yield
-            @store_mapping = false
-            create_index_or_update_mapping
+            @store_mapping = true and yield and @store_mapping = false
+            create_elasticsearch_index
           else
-            @mapping ||= {}
+            @mapping
           end
         end
 
@@ -39,17 +44,10 @@ module Tire
           @store_mapping || false
         end
 
-        def create_index_or_update_mapping
-          # STDERR.puts "Creating index with mapping", mapping_to_hash.inspect
-          # STDERR.puts "Index exists?, #{index.exists?}"
+        def create_elasticsearch_index
           unless elasticsearch_index.exists?
-            elasticsearch_index.create :mappings => mapping_to_hash
-          else
-            # TODO: Update mapping
+            elasticsearch_index.create :mappings => mapping_to_hash, :settings => settings
           end
-        rescue Exception => e
-          # TODO: STDERR + logger
-          raise
         end
 
         def mapping_to_hash

data/lib/tire/model/percolate.rb

@@ -10,7 +10,7 @@ module Tire
         end
 
         def on_percolate(pattern=true,&block)
-          self.percolate!(pattern)
+          percolate!(pattern)
           after_update_elastic_search_index(block)
         end
 
@@ -22,7 +22,7 @@ module Tire
       module InstanceMethods
 
         def percolate(&block)
-          index.percolate document_type, self, block
+          index.percolate self, block
         end
 
         def percolate=(pattern)

data/lib/tire/model/search.rb

@@ -60,7 +60,7 @@ module Tire
         #
         #
         def search(*args, &block)
-          default_options = {:type => document_type}
+          default_options = {:type => document_type, :index => elasticsearch_index.name}
 
           if block_given?
             options = args.shift || {}
@@ -72,7 +72,7 @@ module Tire
           sort      = Array( options[:order] || options[:sort] )
           options   = default_options.update(options)
 
-          s = Tire::Search::Search.new(elasticsearch_index.name, options)
+          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]
           s.sort do

data/lib/tire/results/collection.rb

@@ -36,25 +36,26 @@ module Tire
                end
             end
           else
-            begin
-              return [] if @response['hits']['total'] == 0
+            return [] if @response['hits']['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
+            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
-              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 } }
             rescue NameError => e
-              raise NameError, "You have tried to eager load the model instances, but" +
+              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   = @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 } }
           end
         end
       end
@@ -70,6 +71,7 @@ module Tire
       def size
         results.size
       end
+      alias :length :size
 
       def [](index)
         results[index]

data/lib/tire/search/facet.rb

@@ -29,6 +29,12 @@ module Tire
 
       def range(field, ranges=[], options={})
         @value = { :range => { :field => field, :ranges => ranges }.update(options) }
+        self
+      end
+
+      def histogram(field, options={})
+        @value = { :histogram => (options.delete(:histogram) || {:field => field}.update(options)) }
+        self
       end
 
       def to_json

data/lib/tire/version.rb

@@ -1,13 +1,21 @@
 module Tire
-  VERSION   = "0.2.0"
+  VERSION   = "0.2.1"
 
   CHANGELOG =<<-END
     IMPORTANT CHANGES LATELY:
 
-    # By default, results are wrapped in Item class (05a1331)
+    0.2.0
+    ---------------------------------------------------------
+    # By default, results are wrapped in Item class
     # Completely rewritten ActiveModel/ActiveRecord support
-    # Added method to items for loading the "real" model from database (f9273bc)
-    # Added the ':load' option to eagerly load results from database (1e34cde)
-    # Deprecated the dynamic sort methods, use the 'sort { by :field_name }' syntax
+    # Added infrastructure for loading "real" models from database (eagerly or in runtime)
+    # Deprecated the dynamic sort methods in favour of the 'sort { by :field_name }' syntax
+
+    0.2.1
+    ---------------------------------------------------------
+    # Lighweight check for index presence
+    # Added the 'settings' method for models to define index settings
+    # Fixed errors when importing data with will_paginate vs Kaminari (MongoDB)
+    # Added support for histogram facets [Paco Guzman]
   END
 end

data/test/fixtures/articles/1.json

@@ -1 +1 @@
-{"title" : "One", "tags" : ["ruby"], "published_on" : "2011-01-01"}
+{"title" : "One", "tags" : ["ruby"], "published_on" : "2011-01-01", "words" : 125}

data/test/fixtures/articles/2.json

@@ -1 +1 @@
-{"title" : "Two", "tags" : ["ruby", "python"], "published_on" : "2011-01-02"}
+{"title" : "Two", "tags" : ["ruby", "python"], "published_on" : "2011-01-02", "words" : 250}

data/test/fixtures/articles/3.json

@@ -1 +1 @@
-{"title" : "Three", "tags" : ["java"], "published_on" : "2011-01-02"}
+{"title" : "Three", "tags" : ["java"], "published_on" : "2011-01-02", "words" : 375}

data/test/fixtures/articles/4.json

@@ -1 +1 @@
-{"title" : "Four", "tags" : ["erlang"], "published_on" : "2011-01-03"}
+{"title" : "Four", "tags" : ["erlang"], "published_on" : "2011-01-03", "words" : 250}

data/test/fixtures/articles/5.json

@@ -1 +1 @@
-{"title" : "Five", "tags" : ["javascript", "java"], "published_on" : "2011-01-04"}
+{"title" : "Five", "tags" : ["javascript", "java"], "published_on" : "2011-01-04", "words" : 125}

data/test/integration/facets_test.rb

@@ -76,6 +76,23 @@ module Tire
 
       end
 
+      context "histogram" do
+        should "return aggregated values for all results" do
+          s = Tire.search('articles-test') do
+            query { all }
+            facet 'words' do
+              histogram :words, :interval => 100
+            end
+          end
+
+          facets = s.results.facets['words']['entries']
+          assert_equal 3, facets.size, facets.inspect
+          assert_equal({"key" => 100, "count" => 2}, facets.entries[0], facets.inspect)
+          assert_equal({"key" => 200, "count" => 2}, facets.entries[1], facets.inspect)
+          assert_equal({"key" => 300, "count" => 1}, facets.entries[2], facets.inspect)
+        end
+      end
+
     end
 
   end

data/test/test_helper.rb

@@ -7,7 +7,7 @@ require 'yajl/json_gem'
 require 'sqlite3'
 
 require 'shoulda'
-require 'turn' unless ENV["TM_FILEPATH"]
+require 'turn' unless ENV["TM_FILEPATH"] || ENV["CI"]
 require 'mocha'
 
 require 'tire'

data/test/unit/client_test.rb

@@ -15,6 +15,7 @@ module Tire
         assert_respond_to Client::RestClient, :post
         assert_respond_to Client::RestClient, :put
         assert_respond_to Client::RestClient, :delete
+        assert_respond_to Client::RestClient, :head
       end
       
     end

data/test/unit/index_test.rb

@@ -15,12 +15,12 @@ module Tire
       end
 
       should "return true when exists" do
-        Configuration.client.expects(:get).returns(mock_response('{"dummy":{"document":{"properties":{}}}}'))
+        Configuration.client.expects(:head).returns(mock_response(''))
         assert @index.exists?
       end
 
       should "return false when does not exist" do
-        Configuration.client.expects(:get).raises(RestClient::ResourceNotFound)
+        Configuration.client.expects(:head).raises(RestClient::ResourceNotFound)
         assert ! @index.exists?
       end
 

data/test/unit/model_persistence_test.rb

@@ -247,16 +247,16 @@ module Tire
 
         context "when creating" do
 
-          # TODO: Find a way to mock JSON paylod for Mocha with disregard to Hash entries ordering.
-          #       Ruby 1.9 brings ordered Hashes, so tests were failing.
-
           should "save the document with generated ID in the database" do
-            Configuration.client.expects(:post).with("#{Configuration.url}/persistent_articles/persistent_article/",
-                                                     RUBY_VERSION < "1.9" ?
-                                                     '{"title":"Test","tags":["one","two"],"published_on":null}' :
-                                                     '{"published_on":null,"tags":["one","two"],"title":"Test"}'
-                                                     ).
-                                                returns(mock_response('{"ok":true,"_id":"abc123"}'))
+            Configuration.client.expects(:post).
+                                 with do |url, payload|
+                                  doc = MultiJson.decode(payload)
+                                  url == "#{Configuration.url}/persistent_articles/persistent_article/" &&
+                                  doc['title'] == 'Test' &&
+                                  doc['tags']  == ['one', 'two']
+                                  doc['published_on'] == nil
+                                end.
+                                returns(mock_response('{"ok":true,"_id":"abc123"}'))
             article = PersistentArticle.create :title => 'Test', :tags => [:one, :two]
 
             assert article.persisted?, "#{article.inspect} should be `persisted?`"
@@ -264,12 +264,15 @@ module Tire
           end
 
           should "save the document with custom ID in the database" do
-            Configuration.client.expects(:post).with("#{Configuration.url}/persistent_articles/persistent_article/r2d2",
-                                                     RUBY_VERSION < "1.9" ?
-                                                     '{"title":"Test","id":"r2d2","tags":null,"published_on":null}' :
-                                                     '{"id":"r2d2","published_on":null,"tags":null,"title":"Test"}'
-                                                     ).
-                                                returns(mock_response('{"ok":true,"_id":"r2d2"}'))
+            Configuration.client.expects(:post).
+                                 with do |url, payload|
+                                   doc = MultiJson.decode(payload)
+                                   url == "#{Configuration.url}/persistent_articles/persistent_article/r2d2" &&
+                                   doc['id'] == 'r2d2' &&
+                                   doc['title'] == 'Test' &&
+                                   doc['published_on'] == nil
+                                 end.
+                                 returns(mock_response('{"ok":true,"_id":"r2d2"}'))
             article = PersistentArticle.create :id => 'r2d2', :title => 'Test'
 
             assert_equal 'r2d2', article.id
@@ -286,24 +289,29 @@ module Tire
         context "when creating" do
 
           should "set the id property" do
-            Configuration.client.expects(:post).with("#{Configuration.url}/persistent_articles/persistent_article/",
-                                                     RUBY_VERSION < "1.9" ?
-                                                     {:title => 'Test', :tags => nil, :published_on => nil}.to_json :
-                                                     {:published_on => nil, :tags => nil, :title => 'Test'}.to_json
-                                                     ).
-                                                returns(mock_response('{"ok":true,"_id":"1"}'))
+            Configuration.client.expects(:post).
+                                 with do |url, payload|
+                                   doc = MultiJson.decode(payload)
+                                   url == "#{Configuration.url}/persistent_articles/persistent_article/" &&
+                                   doc['id'] == nil &&
+                                   doc['title'] == 'Test'
+                                 end.
+                                 returns(mock_response('{"ok":true,"_id":"1"}'))
 
             article = PersistentArticle.create :title => 'Test'
             assert_equal '1', article.id
           end
 
           should "not set the id property if already set" do
-            Configuration.client.expects(:post).with("#{Configuration.url}/persistent_articles/persistent_article/123",
-                                                     RUBY_VERSION < "1.9" ?
-                                                     '{"title":"Test","id":"123","tags":null,"published_on":null}' :
-                                                     '{"id":"123","published_on":null,"tags":null,"title":"Test"}'
-                                                     ).
-                                                returns(mock_response('{"ok":true, "_id":"XXX"}'))
+            Configuration.client.expects(:post).
+                                  with do |url, payload|
+                                    doc = MultiJson.decode(payload)
+                                    url == "#{Configuration.url}/persistent_articles/persistent_article/123" &&
+                                    doc['id'] == '123' &&
+                                    doc['title'] == 'Test' &&
+                                    doc['published_on'] == nil
+                                  end.
+                                  returns(mock_response('{"ok":true, "_id":"XXX"}'))
 
             article = PersistentArticle.create :id => '123', :title => 'Test'
             assert_equal '123', article.id
@@ -314,23 +322,30 @@ module Tire
         context "when saving" do
 
           should "save the document with updated attribute" do
-            article = PersistentArticle.new :id => 1, :title => 'Test'
-
-            Configuration.client.expects(:post).with("#{Configuration.url}/persistent_articles/persistent_article/1",
-                                                     RUBY_VERSION < "1.9" ?
-                                                     '{"title":"Test","id":1,"tags":null,"published_on":null}' :
-                                                     '{"id":1,"published_on":null,"tags":null,"title":"Test"}'
-                                                     ).
-                                                returns(mock_response('{"ok":true,"_id":"1"}'))
+            article = PersistentArticle.new :id => '1', :title => 'Test'
+
+            Configuration.client.expects(:post).
+                                 with do |url, payload|
+                                   doc = MultiJson.decode(payload)
+                                   url == "#{Configuration.url}/persistent_articles/persistent_article/1" &&
+                                   doc['id'] == '1' &&
+                                   doc['title'] == 'Test' &&
+                                   doc['published_on'] == nil
+                                 end.
+                                 returns(mock_response('{"ok":true,"_id":"1"}'))
             assert article.save
 
             article.title = 'Updated'
-            Configuration.client.expects(:post).with("#{Configuration.url}/persistent_articles/persistent_article/1",
-                                                     RUBY_VERSION < "1.9" ?
-                                                     '{"title":"Updated","id":1,"tags":null,"published_on":null}' :
-                                                     '{"id":1,"published_on":null,"tags":null,"title":"Updated"}'
-                                                     ).
-                                                returns(mock_response('{"ok":true,"_id":"1"}'))
+
+            Configuration.client.expects(:post).
+                                 with do |url, payload|
+                                   doc = MultiJson.decode(payload)
+                                   p doc
+                                   url == "#{Configuration.url}/persistent_articles/persistent_article/1" &&
+                                   doc['id'] == '1' &&
+                                   doc['title'] == 'Updated'
+                                 end.
+                                 returns(mock_response('{"ok":true,"_id":"1"}'))
             assert article.save
           end
 
@@ -352,17 +367,19 @@ module Tire
 
           should "not set the id property if already set" do
             article = PersistentArticle.new
-            article.id    = '123'
+            article.id    = '456'
             article.title = 'Test'
 
-            Configuration.client.expects(:post).with("#{Configuration.url}/persistent_articles/persistent_article/123",
-                                                     RUBY_VERSION < "1.9" ?
-                                                     '{"title":"Test","id":"123","tags":null,"published_on":null}' :
-                                                     '{"id":"123","published_on":null,"tags":null,"title":"Test"}'
-                                                     ).
-                                                returns(mock_response('{"ok":true,"_id":"XXX"}'))
+            Configuration.client.expects(:post).
+                                 with do |url, payload|
+                                   doc = MultiJson.decode(payload)
+                                   url == "#{Configuration.url}/persistent_articles/persistent_article/456" &&
+                                   doc['id'] == '456' &&
+                                   doc['title'] == 'Test'
+                                 end.
+                                 returns(mock_response('{"ok":true,"_id":"XXX"}'))
              assert article.save
-             assert_equal '123', article.id
+             assert_equal '456', article.id
           end
 
         end
@@ -370,13 +387,16 @@ module Tire
         context "when destroying" do
 
           should "delete the document from the database" do
-            Configuration.client.expects(:post).with("#{Configuration.url}/persistent_articles/persistent_article/123",
-                                                     RUBY_VERSION < "1.9" ?
-                                                     '{"title":"Test","id":"123","tags":null,"published_on":null}' :
-                                                     '{"id":"123","published_on":null,"tags":null,"title":"Test"}'
-                                                     ).
-                                                returns(mock_response('{"ok":true,"_id":"123"}'))
-            Configuration.client.expects(:delete).with("#{Configuration.url}/persistent_articles/persistent_article/123")
+            Configuration.client.expects(:post).
+                                 with do |url, payload|
+                                   doc = MultiJson.decode(payload)
+                                   url == "#{Configuration.url}/persistent_articles/persistent_article/123" &&
+                                   doc['id'] == '123' &&
+                                   doc['title'] == 'Test'
+                                 end.returns(mock_response('{"ok":true,"_id":"123"}'))
+
+            Configuration.client.expects(:delete).
+                                 with("#{Configuration.url}/persistent_articles/persistent_article/123")
 
             article = PersistentArticle.new :id => '123', :title => 'Test'
             article.save
@@ -409,13 +429,14 @@ module Tire
       context "Persistent model with mapping definition" do
 
         should "create the index with mapping" do
-          expected_mapping = {
+          expected = {
+            :settings => {},
             :mappings => { :persistent_article_with_mapping => {
               :properties => { :title => { :type => 'string', :analyzer => 'snowball', :boost => 10 } }
             }}
           }
 
-          Tire::Index.any_instance.expects(:create).with(expected_mapping)
+          Tire::Index.any_instance.expects(:create).with(expected)
 
           class ::PersistentArticleWithMapping
 

data/test/unit/model_search_test.rb

@@ -84,6 +84,30 @@ module Tire
           ActiveModelArticleWithCustomIndexName.search { query { string 'foo' } }
         end
 
+        should "allow to pass custom document type" do
+          Tire::Search::Search.
+            expects(:new).
+            with(ActiveModelArticle.index_name, { :type => 'custom_type' }).
+            returns(@stub).
+            twice
+
+          ActiveModelArticle.search 'foo', :type => 'custom_type'
+          ActiveModelArticle.search( :type => 'custom_type' ) { query { string 'foo' } }
+        end
+
+        should "allow to pass custom index name" do
+          Tire::Search::Search.
+            expects(:new).
+            with('custom_index', { :type => ActiveModelArticle.document_type }).
+            returns(@stub).
+            twice
+
+          ActiveModelArticle.search 'foo', :index => 'custom_index'
+          ActiveModelArticle.search( :index => 'custom_index' ) do
+            query { string 'foo' }
+          end
+        end
+
         should "allow to refresh index" do
           Index.any_instance.expects(:refresh)
 
@@ -106,9 +130,11 @@ module Tire
         end
 
         context "searching with a block" do
+          setup do
+            Tire::Search::Search.any_instance.expects(:perform).returns(@stub)
+          end
 
           should "pass on whatever block it received" do
-            Tire::Search::Search.any_instance.expects(:perform).returns(@stub)
             Tire::Search::Query.any_instance.expects(:string).with('foo').returns(@stub)
 
             ActiveModelArticle.search { query { string 'foo' } }
@@ -116,7 +142,6 @@ module Tire
 
           should "allow to pass block with argument to query, allowing to use local variables from outer scope" do
             Tire::Search::Query.any_instance.expects(:instance_eval).never
-            Tire::Search::Search.any_instance.expects(:perform).returns(@stub)
             Tire::Search::Query.any_instance.expects(:string).with('foo').returns(@stub)
 
             my_query = 'foo'
@@ -245,13 +270,14 @@ module Tire
         context "with custom mapping" do
 
           should "create the index with mapping" do
-            expected_mapping = {
+            expected = {
+              :settings => {},
               :mappings => { :model_with_custom_mapping => {
                 :properties => { :title => { :type => 'string', :analyzer => 'snowball', :boost => 10 } }
               }}
             }
 
-            Tire::Index.any_instance.expects(:create).with(expected_mapping)
+            Tire::Index.any_instance.expects(:create).with(expected)
 
             class ::ModelWithCustomMapping
               extend ActiveModel::Naming
@@ -270,7 +296,8 @@ module Tire
           end
 
           should "define mapping for nested properties with a block" do
-            expected_mapping = {
+            expected = {
+              :settings => {},
               :mappings => { :model_with_nested_mapping => {
                 :properties => {
                   :title =>  { :type => 'string' },
@@ -285,7 +312,7 @@ module Tire
               }
             }}
 
-            Tire::Index.any_instance.expects(:create).with(expected_mapping)
+            Tire::Index.any_instance.expects(:create).with(expected)
 
             class ::ModelWithNestedMapping
               extend ActiveModel::Naming
@@ -310,6 +337,39 @@ module Tire
 
         end
 
+        context "with settings" do
+
+          should "create the index with settings and mappings" do
+            expected_settings = {
+              :settings => { :number_of_shards => 1, :number_of_replicas => 1 }
+            }
+
+            Tire::Index.any_instance.expects(:create).with do |expected|
+              expected[:settings][:number_of_shards] == 1 &&
+              expected[:mappings].size > 0
+            end
+
+            class ::ModelWithCustomSettings
+              extend ActiveModel::Naming
+              extend ActiveModel::Callbacks
+
+              include Tire::Model::Search
+              include Tire::Model::Callbacks
+
+              settings :number_of_shards => 1, :number_of_replicas => 1 do
+                mapping do
+                  indexes :title, :type => 'string'
+                end
+              end
+
+            end
+
+            assert_instance_of Hash, ModelWithCustomSettings.settings
+            assert_equal 1, ModelWithCustomSettings.settings[:number_of_shards]
+          end
+
+        end
+
         context "with index update callbacks" do
           setup do
             class ::ModelWithIndexCallbacks
@@ -456,9 +516,8 @@ module Tire
           should "pass the arguments to percolate" do
             filter   = lambda { string 'tag:alerts' }
 
-            Tire::Index.any_instance.expects(:percolate).with do |type,doc,query|
-              # p [type,doc,query]
-              type  == 'active_model_article_with_callbacks' &&
+            Tire::Index.any_instance.expects(:percolate).with do |doc,query|
+              # p [doc,query]
               doc   == @article &&
               query == filter
             end.returns(["alert"])

data/test/unit/results_collection_test.rb

@@ -22,8 +22,9 @@ module Tire
         end
       end
 
-      should "have size" do
+      should "have size/length" do
         assert_equal 3, Results::Collection.new(@default_response).size
+        assert_equal 3, Results::Collection.new(@default_response).length
       end
 
       should "allow access to items" do
@@ -151,8 +152,8 @@ module Tire
                                                        {'_id' => 2},
                                                        {'_id' => 3},
                                                        {'_id' => 4}],
-                                            'total' => 4,
-                                            'took'  => 1 } }
+                                            'total' => 4 },
+                                'took' => 1 }
           @collection = Results::Collection.new( @default_response, :per_page => 1, :page => 2 )
         end
 
@@ -234,6 +235,18 @@ module Tire
           end
         end
 
+        should "return empty array for empty hits" do
+          response = { 'hits'  => {
+                         'hits' => [],
+                         'total' => 4
+                       },
+                       'took'  => 1 }
+          @collection = Results::Collection.new( response, :load => true )
+          assert @collection.empty?, 'Collection should be empty'
+          assert @collection.results.empty?, 'Collection results should be empty'
+          assert_equal 0, @collection.size
+        end
+
       end
 
     end

data/test/unit/rubyext_test.rb

@@ -22,8 +22,7 @@ module Tire
 
       end
 
-      should "have a to_json method from Yajl" do
-        assert defined?(Yajl)
+      should "have a to_json method from a JSON serialization library" do
         assert_respond_to( {}, :to_json )
         assert_equal '{"one":1}', { :one => 1}.to_json
       end

data/test/unit/search_facet_test.rb

@@ -69,6 +69,18 @@ module Tire::Search
         end
       end
 
+      context "histogram facet" do
+        should "encode facet options with default key" do
+          f = Facet.new('histogram') { histogram :age, {:interval => 5} }
+          assert_equal({ :histogram => { :histogram => { :field => 'age', :interval => 5 } } }.to_json, f.to_json)
+        end
+
+        should "encode the JSON if define an histogram" do
+          f = Facet.new('histogram') { histogram :age, {:histogram => {:key_field => "age", :value_field => "age", :interval => 100}} }
+          assert_equal({ :histogram => { :histogram => {:key_field => "age", :value_field => "age", :interval => 100} } }.to_json, f.to_json)
+        end
+      end
+
     end
 
   end

data/tire.gemspec

@@ -24,22 +24,31 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = ">= 1.3.6"
 
+  # = Library dependencies
+  #
   s.add_dependency "rake",        ">= 0.8.0"
   s.add_dependency "rest-client", "~> 1.6.0"
   s.add_dependency "multi_json",  "~> 1.0"
   s.add_dependency "activemodel", "~> 3.0"
 
+  # = Development dependencies
+  #
   s.add_development_dependency "bundler",     "~> 1.0.0"
   s.add_development_dependency "yajl-ruby",   "~> 0.8.0"
-  s.add_development_dependency "turn"
   s.add_development_dependency "shoulda"
   s.add_development_dependency "mocha"
-  s.add_development_dependency "rdoc"
-  s.add_development_dependency "sdoc"
-  s.add_development_dependency "rcov"
   s.add_development_dependency "activerecord", "~> 3.0.7"
-  s.add_development_dependency "supermodel"
   s.add_development_dependency "sqlite3"
+  s.add_development_dependency "supermodel"
+
+  # These gems are not needed for CI at <http://travis-ci.org/#!/karmi/tire>
+  #
+  unless ENV["CI"]
+    s.add_development_dependency "sdoc"
+    s.add_development_dependency "rdoc"
+    s.add_development_dependency "rcov"
+    s.add_development_dependency "turn"
+  end
 
   s.description = <<-DESC
    Tire is a Ruby client for the ElasticSearch search engine/database.

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Karel Minarik
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-21 00:00:00 +02:00
+date: 2011-09-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,7 +100,7 @@ dependencies:
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: turn
+  name: shoulda
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     requirements: 
@@ -112,7 +112,7 @@ dependencies:
   type: :development
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: mocha
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     requirements: 
@@ -124,19 +124,21 @@ dependencies:
   type: :development
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  name: mocha
+  name: activerecord
   prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
+        - 3
         - 0
-        version: "0"
+        - 7
+        version: 3.0.7
   type: :development
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  name: rdoc
+  name: sqlite3
   prerelease: false
   requirement: &id010 !ruby/object:Gem::Requirement 
     requirements: 
@@ -148,7 +150,7 @@ dependencies:
   type: :development
   version_requirements: *id010
 - !ruby/object:Gem::Dependency 
-  name: sdoc
+  name: supermodel
   prerelease: false
   requirement: &id011 !ruby/object:Gem::Requirement 
     requirements: 
@@ -160,7 +162,7 @@ dependencies:
   type: :development
   version_requirements: *id011
 - !ruby/object:Gem::Dependency 
-  name: rcov
+  name: sdoc
   prerelease: false
   requirement: &id012 !ruby/object:Gem::Requirement 
     requirements: 
@@ -172,21 +174,19 @@ dependencies:
   type: :development
   version_requirements: *id012
 - !ruby/object:Gem::Dependency 
-  name: activerecord
+  name: rdoc
   prerelease: false
   requirement: &id013 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 3
         - 0
-        - 7
-        version: 3.0.7
+        version: "0"
   type: :development
   version_requirements: *id013
 - !ruby/object:Gem::Dependency 
-  name: supermodel
+  name: rcov
   prerelease: false
   requirement: &id014 !ruby/object:Gem::Requirement 
     requirements: 
@@ -198,7 +198,7 @@ dependencies:
   type: :development
   version_requirements: *id014
 - !ruby/object:Gem::Dependency 
-  name: sqlite3
+  name: turn
   prerelease: false
   requirement: &id015 !ruby/object:Gem::Requirement 
     requirements: 
@@ -317,13 +317,21 @@ post_install_message: |
   
     IMPORTANT CHANGES LATELY:
   
-    # By default, results are wrapped in Item class (05a1331)
+    0.2.0
+    ---------------------------------------------------------
+    # By default, results are wrapped in Item class
     # Completely rewritten ActiveModel/ActiveRecord support
-    # Added method to items for loading the "real" model from database (f9273bc)
-    # Added the ':load' option to eagerly load results from database (1e34cde)
-    # Deprecated the dynamic sort methods, use the 'sort { by :field_name }' syntax
+    # Added infrastructure for loading "real" models from database (eagerly or in runtime)
+    # Deprecated the dynamic sort methods in favour of the 'sort { by :field_name }' syntax
+  
+    0.2.1
+    ---------------------------------------------------------
+    # Lighweight check for index presence
+    # Added the 'settings' method for models to define index settings
+    # Fixed errors when importing data with will_paginate vs Kaminari (MongoDB)
+    # Added support for histogram facets [Paco Guzman]
   
-    See the full changelog at <http://github.com/karmi/tire/commits/v0.2.0>.
+    See the full changelog at <http://github.com/karmi/tire/commits/v0.2.1>.
   
   --------------------------------------------------------------------------------