tire-contrib 0.0.3.6 → 0.1.0

data/README.markdown

@@ -1,15 +1,27 @@
 Tire Contributed Components
 ================================
 
-Contributions, additions, extensions and other utilities for the [Tire](http://karmi.github.com/tire/)
-Rubygem for _ElasticSearch_.
+Extension, additions, other utilities for the [_Tire_](http://karmi.github.com/tire/)
+Rubygem for [_ElasticSearch_](http://www.elasticsearch.org/).
 
-See specific files or folders inside the `lib/tire` folder.
+Add this to your _Gemfile_:
 
-rails-logger
-------------
+    gem 'tire-contrib'
 
-Adds support for displaying Tire related statistics to Rails' log.
+Then require the component you want to use in your application initializer. For example:
+
+    require 'tire/rails/logger'
+
+See specific files and folders inside the `lib/tire` folder for instructions and documentation.
+
+
+### More Like This Queries ###
+
+Adds support for [“more like this”](http://www.elasticsearch.org/guide/reference/query-dsl/mlt-query.html) queries.
+
+### Rails Logger ###
+
+Adds support for displaying Tire related statistics in the Rails' log.
 
 -----
 

data/Rakefile

@@ -1,2 +1,10 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/**/*_test.rb']
+  test.verbose = true
+  # test.warning = true
+end

data/lib/tire/README.markdown

@@ -0,0 +1,3 @@
+This directory contains the extensions to [_Tire_](http://github.com/karmi/tire).
+
+Please refer to the relevant Ruby files for instructions on usage and other documentation.

data/lib/tire/queries/more_like_this/more_like_this.rb

@@ -0,0 +1,30 @@
+module Tire
+  module Search
+    module MoreLikeThis
+      def more_like_this(like_text, options = {})
+        @value = {:mlt => {:like_text => like_text}}
+        @value[:mlt].update(validate_more_like_this_options(options))
+        @value
+      end
+
+      def more_like_this_field(field, like_text, options = {})
+        @value = {:mlt_field => {field => {:like_text => like_text}}}
+        # :fields is invalid in this context. Better than doing some kind of meta-black magic.
+        options.delete(:fields)
+        @value[:mlt_field][field].update(validate_more_like_this_options(options))
+        @value
+      end
+
+      alias_method :mlt, :more_like_this
+      alias_method :mlt_field, :more_like_this_field
+
+      private
+      def validate_more_like_this_options(options)
+        valid_options = [:fields, :percent_terms_to_match, :min_term_freq,
+                         :max_query_terms, :stop_words, :min_doc_freq, :max_doc_freq,
+                         :min_word_len, :max_word_len, :boost_terms, :boost, :analyzer]
+        options.delete_if { |key, value| !valid_options.member? key }
+      end
+    end
+  end
+end

data/lib/tire/queries/more_like_this.rb

@@ -0,0 +1,43 @@
+# More Like This
+# ==============
+#
+# Author: Mereghost <marcello.rocha@gmail.com>
+#
+#
+# Adds support for "more_like_this" and "more_like_this_field" queries in Tire DSL.
+#
+# It hooks into the Query class and inserts the more_like_this and more_like_this_field query types.
+#
+#
+# Usage:
+# ------
+#
+# Require the component:
+#
+#     require 'tire/queries/more_like_this'
+#
+# From that point on you should have the more_like_this (aliased to mlt) and
+# the more_like_this_field (aliased to mlt_field) queries available.
+#
+#
+# Example:
+# -------
+#
+#     Tire.search 'articles' do
+#       query do
+#          more_like_this 'search for similar text'
+#          more_like_this_field :field_name, 'similar text'
+#       end
+#     end
+#
+# For available options for these queries see:
+#
+# * <http://www.elasticsearch.org/guide/reference/query-dsl/mlt-query.html>
+# * <http://www.elasticsearch.org/guide/reference/query-dsl/mlt-field-query.html>
+#
+#
+require 'tire/queries/more_like_this/more_like_this'
+
+Tire::Search::Query.class_eval do
+  include Tire::Search::MoreLikeThis
+end

data/lib/tire/rails/logger/instrumentation.rb

@@ -0,0 +1,19 @@
+module Tire
+  module Rails
+    module Instrumentation
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method_chain :perform, :instrumentation
+      end
+
+      def perform_with_instrumentation
+        # Wrapper around the Search.perform method that logs search times.
+        #
+        ActiveSupport::Notifications.instrument("search.tire", :name => 'Search', :search => self.to_json) do
+          perform_without_instrumentation
+        end
+      end
+    end
+  end
+end

data/lib/tire/{rails-logger → rails/logger}/railtie.rb

@@ -3,9 +3,9 @@ module Tire
     class Railtie < ::Rails::Railtie
 
       initializer "tire.initializer" do |app|
-        require 'tire/rails-logger/instrumentation'
-        require 'tire/rails-logger/log_subscriber'
-        require 'tire/rails-logger/controller_runtime'
+        require 'tire/rails/logger/instrumentation'
+        require 'tire/rails/logger/log_subscriber'
+        require 'tire/rails/logger/controller_runtime'
 
         # Inject instrumentation into Tire::Search
         #

data/lib/tire/{rails-logger.rb → rails/logger.rb}

@@ -14,17 +14,17 @@
 #
 # Require the component in your `application.rb`:
 #
-#     require 'tire/rails-logger'
+#     require 'tire/rails/logger'
 #
 # You should see an output like this in your application log:
 #
 #     Started GET "/articles?utf8=%E2%9C%93&q=bull*&commit=search" for 127.0.0.1 at 2011-09-15 19:07:00 +0200
 #       Processing by ArticlesController#index as HTML
 #       Parameters: {"utf8"=>"✓", "q"=>"bull*", "commit"=>"search"}
-#       Tire search (6.7ms)  {"query":{"query_string":{"query":"bull*"}}}
+#       Search (6.7ms)  {"query":{"query_string":{"query":"bull*"}}}
 #       Article Load (0.3ms)  SELECT `articles`.* FROM `articles` WHERE `articles`.`id` IN (104126575)
 #     Rendered articles/index.html.erb within layouts/application (13.0ms)
 #     Completed 200 OK in 63ms (Views: 53.7ms | ActiveRecord: 1.8ms | Tire: 6.7ms)
 #
 #
-require 'tire/rails-logger/railtie'
+require 'tire/rails/logger/railtie'

data/lib/tire-contrib/README.markdown

@@ -0,0 +1,2 @@
+The `tire-contrib` namespace is **not** used for any code.
+See the `tire` directory.

data/lib/tire-contrib/version.rb

@@ -1,5 +1,5 @@
 module Tire
   module Contrib
-    VERSION = "0.0.3.6"
+    VERSION = "0.1.0"
   end
 end

data/lib/tire-contrib.rb

@@ -1,5 +1,4 @@
-# Require all Tire::Contrib components
-#
-Dir[ File.join File.expand_path('../', __FILE__), 'tire', '*.rb' ].each do |component|
-  # require component
+module Tire
+  module Contrib
+  end
 end

data/test/queries/more_like_this/more_like_this_test.rb

@@ -0,0 +1,37 @@
+require 'tire'
+require 'tire/queries/more_like_this'
+require 'shoulda'
+
+module Tire
+  module Search
+    class MoreLikeThisTest < Test::Unit::TestCase
+      context "More Like This queries" do
+        should "search for similar documents" do
+          assert_equal({:mlt => {:like_text => 'similar text'}}, Query.new.mlt('similar text'))
+        end
+
+        should "allow to pass a list of fields to a mlt query" do
+          assert_equal({:mlt => {:like_text => 'similar text', :fields => ['foo', 'bar.baz']}},
+                       Query.new.mlt('similar text', :fields => ['foo', 'bar.baz']))
+          assert_equal({:mlt => {:like_text => 'similar text', :fields => ['foo', 'bar.baz'], :min_term_freq => 3}},
+                       Query.new.mlt('similar text', :fields => ['foo', 'bar.baz'], :min_term_freq => 3))
+        end
+
+        should "search for similar text on a selected field (mlt_field)" do
+          assert_equal({:mlt_field => {:foo => {:like_text => 'similar text'}}},
+                       Query.new.mlt_field(:foo, 'similar text'))
+          assert_equal({:mlt_field => {:foo => {:like_text => 'similar text', :min_term_freq => 1}}},
+                       Query.new.mlt_field(:foo, 'similar text', :min_term_freq => 1))
+        end
+      end
+      context "validate the options passed" do
+        should "drop all the invalid keys" do
+          assert_equal({:mlt => {:like_text => 'similar text', :fields => ['foo', 'bar.baz']}},
+                       Query.new.mlt('similar text', :fields => ['foo', 'bar.baz'], :foo => :bar))
+          assert_equal({:mlt_field => {:foo => {:like_text => 'similar text'}}},
+                       Query.new.mlt_field(:foo, 'similar text', :fields => [:bar]))
+        end
+      end
+    end
+  end
+end

data/test/{rails-logger → rails/logger}/log_subscriber_test.rb

@@ -58,7 +58,7 @@ module Tire
           ActiveRecordArticle.search '*', :load => true
           wait
           assert_equal 1, @logger.logged(:debug).size
-          assert_match /Tire/, @logger.logged(:debug).last
+          assert_match /Search \(\d+\.?\d*ms\)/, @logger.logged(:debug).last
         end
 
       end

data/tire-contrib.gemspec

@@ -19,8 +19,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency "turn"
   s.add_development_dependency "shoulda"
   s.add_development_dependency "mocha"
-  s.add_development_dependency "sdoc"
-  s.add_development_dependency "rcov"
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "activesupport"
+  s.add_development_dependency "sqlite3"
 
   s.extra_rdoc_files  = [ "README.markdown", "MIT-LICENSE" ]
   s.rdoc_options      = [ "--charset=UTF-8" ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tire-contrib
 version: !ruby/object:Gem::Version
-  version: 0.0.3.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-13 00:00:00.000000000 Z
+date: 2012-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tire
-  requirement: &70127244984360 !ruby/object:Gem::Requirement
+  requirement: &70240919138540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70127244984360
+  version_requirements: *70240919138540
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70127244980560 !ruby/object:Gem::Requirement
+  requirement: &70240919135160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70127244980560
+  version_requirements: *70240919135160
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &70127244977360 !ruby/object:Gem::Requirement
+  requirement: &70240919151640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127244977360
+  version_requirements: *70240919151640
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70127244990880 !ruby/object:Gem::Requirement
+  requirement: &70240919149000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127244990880
+  version_requirements: *70240919149000
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70127244987900 !ruby/object:Gem::Requirement
+  requirement: &70240919148260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127244987900
+  version_requirements: *70240919148260
 - !ruby/object:Gem::Dependency
-  name: sdoc
-  requirement: &70127245027000 !ruby/object:Gem::Requirement
+  name: activerecord
+  requirement: &70240919146940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127245027000
+  version_requirements: *70240919146940
 - !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &70127245058320 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: &70240919160100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127245058320
+  version_requirements: *70240919160100
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70240919157720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70240919157720
 description: 
 email:
 - karmi@karmi.cz
@@ -105,14 +116,19 @@ files:
 - README.markdown
 - Rakefile
 - lib/tire-contrib.rb
+- lib/tire-contrib/README.markdown
 - lib/tire-contrib/version.rb
-- lib/tire/rails-logger.rb
-- lib/tire/rails-logger/controller_runtime.rb
-- lib/tire/rails-logger/instrumentation.rb
-- lib/tire/rails-logger/log_subscriber.rb
-- lib/tire/rails-logger/railtie.rb
-- test/rails-logger/active_record_article.rb
-- test/rails-logger/log_subscriber_test.rb
+- lib/tire/README.markdown
+- lib/tire/queries/more_like_this.rb
+- lib/tire/queries/more_like_this/more_like_this.rb
+- lib/tire/rails/logger.rb
+- lib/tire/rails/logger/controller_runtime.rb
+- lib/tire/rails/logger/instrumentation.rb
+- lib/tire/rails/logger/log_subscriber.rb
+- lib/tire/rails/logger/railtie.rb
+- test/queries/more_like_this/more_like_this_test.rb
+- test/rails/logger/active_record_article.rb
+- test/rails/logger/log_subscriber_test.rb
 - test/test_helper.rb
 - tire-contrib.gemspec
 homepage: ''
@@ -141,7 +157,8 @@ signing_key:
 specification_version: 3
 summary: Contributions and additions for the Tire gem
 test_files:
-- test/rails-logger/active_record_article.rb
-- test/rails-logger/log_subscriber_test.rb
+- test/queries/more_like_this/more_like_this_test.rb
+- test/rails/logger/active_record_article.rb
+- test/rails/logger/log_subscriber_test.rb
 - test/test_helper.rb
 has_rdoc: 

data/lib/tire/rails-logger/instrumentation.rb

@@ -1,21 +0,0 @@
-module Tire
-  module Rails
-    module Instrumentation
-      extend ActiveSupport::Concern
-
-      included do
-        alias_method_chain :perform, :instrumentation
-      end
-
-      module InstanceMethods
-        def perform_with_instrumentation
-          # Wrapper around the Search.perform method that logs search times.
-          #
-          ActiveSupport::Notifications.instrument("search.tire", :name => 'Search', :search => self.to_json) do
-            perform_without_instrumentation
-          end
-        end
-      end
-    end
-  end
-end