tire 0.3.4 → 0.3.5

data/.gitignore

@@ -10,4 +10,5 @@ scratch/
 examples/*.html
 *.log
 .rvmrc
+.rbenv-version
 tags

data/README.markdown

@@ -382,9 +382,6 @@ When you now save a record:
 ```
 
 it is automatically added into an index called 'articles', because of the included callbacks.
-(You may want to skip them in special cases, like when your records are indexed via some external
-mechanism, let's say a _CouchDB_ or _RabbitMQ_
-[river](http://www.elasticsearch.org/blog/2010/09/28/the_river.html).
 
 The document attributes are indexed exactly as when you call the `Article#to_json` method.
 
@@ -459,8 +456,8 @@ In this case, just wrap the `mapping` method in a `settings` one, passing it the
 ```
 
 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.
+in a class method of your model, in a module method, etc, to have better control on index creation when
+bootstrapping the application with Rake tasks or when setting up the test suite.
 _Tire_ will not hold that against you.
 
 You may have just stopped wondering: what if I have my own `settings` class method defined?
@@ -545,6 +542,21 @@ Of course, it may well be reasonable to define the indexed JSON from the ground
     end
 ```
 
+Notice, that you may want to skip including the `Tire::Model::Callbacks` module in special cases,
+like when your records are indexed via some external mechanism, let's say a _CouchDB_ or _RabbitMQ_
+[river](http://www.elasticsearch.org/blog/2010/09/28/the_river.html), or when you need better
+control on how the documents are added to or removed from the index:
+
+```ruby
+    class Article < ActiveRecord::Base
+      include Tire::Model::Search
+
+      after_save do
+        update_index if state == 'published'
+      end
+    end
+```
+
 The results returned by `Article.search` are wrapped in the aforementioned `Item` class, by default.
 This way, we have a fast and flexible access to the properties returned from _ElasticSearch_ (via the
 `_source` or `fields` JSON properties). This way, we can index whatever JSON we like in _ElasticSearch_,

data/examples/tire-dsl.rb

@@ -582,6 +582,7 @@ end
 # * [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)
+# * [query](http://www.elasticsearch.org/guide/reference/api/search/facets/query-facet.html)
 
 # We have seen that _ElasticSearch_ facets enable us to fetch complex aggregations from our data.
 #

data/lib/tire/search/facet.rb

@@ -37,6 +37,10 @@ module Tire
         self
       end
 
+      def query(&block)
+        @value = { :query => Query.new(&block).to_hash }
+      end
+
       def to_json
         to_hash.to_json
       end

data/lib/tire/version.rb

@@ -1,14 +1,10 @@
 module Tire
-  VERSION   = "0.3.4"
+  VERSION   = "0.3.5"
 
   CHANGELOG =<<-END
     IMPORTANT CHANGES LATELY:
 
-    0.3.4
-    ---------------------------------------------------------
-    # Added documentation (RDoc annotations and README)
-    # Kaminari pagination support
-    # Bugfixes (dependency on ES running, callbacks, bogus exceptions)
+    # Added a "query" facet for free-form aggregations
 
   END
 end

data/test/fixtures/articles/1.json

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

data/test/integration/facets_test.rb

@@ -77,6 +77,7 @@ module Tire
       end
 
       context "histogram" do
+
         should "return aggregated values for all results" do
           s = Tire.search('articles-test') do
             query { all }
@@ -91,6 +92,53 @@ module Tire
           assert_equal({"key" => 200, "count" => 2}, facets.entries[1], facets.inspect)
           assert_equal({"key" => 300, "count" => 1}, facets.entries[2], facets.inspect)
         end
+
+      end
+
+      context "query facets" do
+
+        should "return aggregated values for a string query" do
+          s = Tire.search('articles-test') do
+            facet 'tees' do
+              query { string 'T*' }
+            end
+          end
+
+          count = s.results.facets['tees']['count']
+          assert_equal 2, count, s.results.facets['tees'].inspect
+        end
+
+        should "return aggregated values for _exists_ string query" do
+          s = Tire.search('articles-test') do
+            facet 'drafts' do
+              query { string '_exists_:draft' }
+            end
+          end
+
+          count = s.results.facets['drafts']['count']
+          assert_equal 1, count, s.results.facets['drafts'].inspect
+        end
+
+        should "return aggregated values for a terms query" do
+          s = Tire.search('articles-test') do
+            facet 'friends' do
+              query { terms :tags, ['ruby', 'python'] }
+            end
+          end
+
+          count = s.results.facets['friends']['count']
+          assert_equal 2, count, s.results.facets['friends'].inspect
+
+          s = Tire.search('articles-test') do
+            facet 'friends' do
+              query { terms :tags, ['ruby', 'python'], :minimum_match => 2 }
+            end
+          end
+
+          count = s.results.facets['friends']['count']
+          assert_equal 1, count, s.results.facets['friends'].inspect
+        end
+
       end
 
     end

data/test/unit/search_facet_test.rb

@@ -81,6 +81,15 @@ module Tire::Search
         end
       end
 
+      context "query facet" do
+        should "encode facet options" do
+          f = Facet.new('q_facet') do
+            query { string '_exists_:foo' }
+          end
+          assert_equal({ :q_facet => { :query => { :query_string => { :query => '_exists_:foo' } } } }.to_json, f.to_json)
+        end
+      end
+
     end
 
   end

data/tire.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
 
   # = Library dependencies
   #
-  s.add_dependency "rake",        ">= 0.8.0"
+  s.add_dependency "rake",        "~> 0.9.2"
   s.add_dependency "rest-client", "~> 1.6.0"
   s.add_dependency "multi_json",  "~> 1.0"
   s.add_dependency "activemodel", "~> 3.0"

metadata

@@ -1,238 +1,207 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tire
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 4
-  version: 0.3.4
+version: !ruby/object:Gem::Version
+  version: 0.3.5
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-29 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 8
-        - 0
-        version: 0.8.0
+  requirement: &70362722303360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rest-client
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: *70362722303360
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70362722302860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 6
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.6.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: multi_json
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: *70362722302860
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70362722302360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: activemodel
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: *70362722302360
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &70362722301880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: *70362722301880
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70362722301400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: yajl-ruby
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: *70362722301400
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70362722300940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 8
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.8.0
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *70362722300940
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70362722300540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *70362722300540
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70362722300080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: *70362722300080
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70362722299560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - 7
+      - !ruby/object:Gem::Version
         version: 3.0.7
   type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: mongoid
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: *70362722299560
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70362722288980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 2
-        - 1
+      - !ruby/object:Gem::Version
         version: 2.2.1
   type: :development
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *70362722288980
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70362722288600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id011
-- !ruby/object:Gem::Dependency 
-  name: supermodel
   prerelease: false
-  requirement: &id012 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *70362722288600
+- !ruby/object:Gem::Dependency
+  name: supermodel
+  requirement: &70362722288140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id012
-- !ruby/object:Gem::Dependency 
-  name: sdoc
   prerelease: false
-  requirement: &id013 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *70362722288140
+- !ruby/object:Gem::Dependency
+  name: sdoc
+  requirement: &70362722287700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id013
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id014 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *70362722287700
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70362722287280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id014
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id015 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *70362722287280
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70362722286860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id015
-- !ruby/object:Gem::Dependency 
-  name: turn
   prerelease: false
-  requirement: &id016 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *70362722286860
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &70362722286440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id016
-description: "   Tire is a Ruby client for the ElasticSearch search engine/database.\n\n   It provides Ruby-like API for fluent communication with the ElasticSearch server\n   and blends with ActiveModel class for convenient usage in Rails applications.\n\n   It allows to delete and create indices, define mapping for them, supports\n   the bulk API, and presents an easy-to-use DSL for constructing your queries.\n\n   It has full ActiveRecord/ActiveModel compatibility, allowing you to index\n   your models (incrementally upon saving, or in bulk), searching and\n   paginating the results.\n\n   Please check the documentation at <http://karmi.github.com/tire/>.\n"
+  prerelease: false
+  version_requirements: *70362722286440
+description: ! "   Tire is a Ruby client for the ElasticSearch search engine/database.\n\n
+  \  It provides Ruby-like API for fluent communication with the ElasticSearch server\n
+  \  and blends with ActiveModel class for convenient usage in Rails applications.\n\n
+  \  It allows to delete and create indices, define mapping for them, supports\n   the
+  bulk API, and presents an easy-to-use DSL for constructing your queries.\n\n   It
+  has full ActiveRecord/ActiveModel compatibility, allowing you to index\n   your
+  models (incrementally upon saving, or in bulk), searching and\n   paginating the
+  results.\n\n   Please check the documentation at <http://karmi.github.com/tire/>.\n"
 email: karmi@karmi.cz
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
 - MIT-LICENSE
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -324,58 +293,35 @@ files:
 - test/unit/search_test.rb
 - test/unit/tire_test.rb
 - tire.gemspec
-has_rdoc: true
 homepage: http://github.com/karmi/tire
 licenses: []
-
-post_install_message: |
-  ================================================================================
-  
-    Please check the documentation at <http://karmi.github.com/tire/>.
-  
-  --------------------------------------------------------------------------------
-  
-    IMPORTANT CHANGES LATELY:
-  
-    0.3.4
-    ---------------------------------------------------------
-    # Added documentation (RDoc annotations and README)
-    # Kaminari pagination support
-    # Bugfixes (dependency on ES running, callbacks, bogus exceptions)
-  
-  
-    See the full changelog at <http://github.com/karmi/tire/commits/v0.3.4>.
-  
-  --------------------------------------------------------------------------------
-
-rdoc_options: 
+post_install_message: ! "================================================================================\n\n
+  \ Please check the documentation at <http://karmi.github.com/tire/>.\n\n--------------------------------------------------------------------------------\n\n
+  \ IMPORTANT CHANGES LATELY:\n\n  # Added a \"query\" facet for free-form aggregations\n\n\n
+  \ See the full changelog at <http://github.com/karmi/tire/commits/v0.3.5>.\n\n--------------------------------------------------------------------------------\n"
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: tire
-rubygems_version: 1.3.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby client for ElasticSearch
-test_files: 
+test_files:
 - test/fixtures/articles/1.json
 - test/fixtures/articles/2.json
 - test/fixtures/articles/3.json