tire-contrib 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in tire-contrib.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Karel Minarik and Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,16 @@
+Tire Contributed Components
+================================
+
+Contributions, additions, extensions and other utilities for the [Tire](http://karmi.github.com/tire/)
+Rubygem for _ElasticSearch_.
+
+See specific files or folders inside the `lib/tire` folder.
+
+rails-logger
+------------
+
+Adds support for displaying Tire related statistics to Rails' log.
+
+-----
+
+[Karel Minarik](http://karmi.cz) and [contributors](http://github.com/karmi/tire-contrib/contributors)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

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

@@ -0,0 +1,34 @@
+require 'active_support/core_ext/module/attr_internal'
+
+module Tire
+  module Rails
+    module ControllerRuntime
+      extend ActiveSupport::Concern
+
+    protected
+
+      attr_internal :tire_runtime
+
+      def cleanup_view_runtime
+        tire_rt_before_render = Tire::Rails::LogSubscriber.reset_runtime
+        runtime = super
+        tire_rt_after_render = Tire::Rails::LogSubscriber.reset_runtime
+        self.tire_runtime = tire_rt_before_render + tire_rt_after_render
+        runtime - tire_rt_after_render
+      end
+
+      def append_info_to_payload(payload)
+        super
+        payload[:tire_runtime] = (tire_runtime || 0) + Tire::Rails::LogSubscriber.reset_runtime
+      end
+
+      module ClassMethods
+        def log_process_action(payload)
+          messages, tire_runtime = super, payload[:tire_runtime]
+          messages << ("Search: %.1fms" % tire_runtime.to_f) if tire_runtime
+          messages
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+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

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

@@ -0,0 +1,35 @@
+module Tire
+  module Rails
+    class LogSubscriber < ActiveSupport::LogSubscriber
+      def self.runtime=(value)
+        Thread.current["tire_search_runtime"] = value
+      end
+
+      def self.runtime
+        Thread.current["tire_search_runtime"] ||= 0
+      end
+
+      def self.reset_runtime
+        rt, self.runtime = runtime, 0
+        rt
+      end
+
+      def search(event)
+        self.class.runtime += event.duration
+        return unless logger.debug?
+
+        payload = event.payload
+
+        name    = "%s (%.1fms)" % [payload[:name], event.duration]
+        query   = payload[:search].to_s.squeeze ' '
+
+        debug "  #{color(name, BLUE, true)}  #{query}"
+      end
+    end
+  end
+end
+
+# Register with namespace 'tire', so event names look like '*.tire',
+# e.g. 'search.tire' will invoke the search method in the LogSubscriber above.
+#
+Tire::Rails::LogSubscriber.attach_to :tire

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

@@ -0,0 +1,25 @@
+module Tire
+  module Rails
+    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'
+
+        # Inject instrumentation into Tire::Search
+        #
+        Tire::Search::Search.module_eval do
+          include Tire::Rails::Instrumentation
+        end
+
+        # Hook into Rails controllers to provide logging
+        #
+        ActiveSupport.on_load(:action_controller) do
+          include Tire::Rails::ControllerRuntime
+        end
+      end
+
+    end
+  end
+end

data/lib/tire/rails-logger.rb

@@ -0,0 +1,30 @@
+# Rails Logger
+# ============
+#
+# Author: Oliver Eilhard <oliver.eilhard@gmail.com>
+#
+#
+# Adds support for displaying Tire related statistics to Rails' log.
+#
+# Hooks into the ActiveSupport instrumentation framework to publish statistics
+# about searches, and display them in the application log.
+#
+# Usage:
+# ------
+#
+# Require the component in your `application.rb`:
+#
+#     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*"}}}
+#       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'

data/lib/tire-contrib/version.rb

@@ -0,0 +1,5 @@
+module Tire
+  module Contrib
+    VERSION = "0.0.1"
+  end
+end

data/lib/tire-contrib.rb

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

data/test/rails-logger/active_record_article.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'active_record'
+
+class ActiveRecordArticle < ActiveRecord::Base
+
+  include Tire::Model::Search
+  include Tire::Model::Callbacks
+
+  tire do
+    mapping do
+      indexes :title,      :type => 'string', :boost => 10, :analyzer => 'snowball'
+      indexes :created_at, :type => 'date'
+    end
+  end
+
+end

data/test/rails-logger/log_subscriber_test.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+require 'active_record'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/log_subscriber/test_helper'
+require 'tire/rails-logger/log_subscriber'
+require 'tire/rails-logger/instrumentation'
+
+require File.expand_path('../active_record_article', __FILE__)
+
+module Tire
+  module Rails
+
+    class LogSubscriberTest < Test::Unit::TestCase
+
+      include ActiveSupport::LogSubscriber::TestHelper
+
+      def setup
+        super
+
+        # Make sure instrumentation wraps the perform method
+        #
+        Tire::Search::Search.module_eval do
+          include Tire::Rails::Instrumentation
+        end
+
+        # Attach log subscriber
+        #
+        Tire::Rails::LogSubscriber.attach_to :tire
+
+        ActiveRecord::Base.establish_connection( :adapter => 'sqlite3', :database => ":memory:" )
+
+        ActiveRecord::Migration.verbose = false
+        ActiveRecord::Schema.define(:version => 1) do
+          create_table :active_record_articles do |t|
+            t.string   :title
+            t.datetime :created_at, :default => 'NOW()'
+          end
+        end
+
+        ActiveRecordArticle.destroy_all
+        Tire.index('active_record_articles').delete
+
+        1.upto(9) { |number| ActiveRecordArticle.create :title => "Test#{number}" }
+        ActiveRecordArticle.index.refresh
+
+        load File.expand_path('../active_record_article.rb', __FILE__)
+      end
+
+      def teardown
+        ActiveRecordArticle.destroy_all
+        Tire.index('active_record_articles').delete
+        super
+      end
+
+      context "Rails notifications" do
+
+        should "log event on search" do
+          ActiveRecordArticle.search '*', :load => true
+          wait
+          assert_equal 1, @logger.logged(:debug).size
+          assert_match /Tire/, @logger.logged(:debug).last
+        end
+
+      end
+
+    end
+
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+
+require 'pathname'
+require 'test/unit'
+
+require 'shoulda'
+require 'turn' unless ENV["TM_FILEPATH"] || ENV["CI"]
+require 'mocha'
+
+require 'tire'
+
+class Test::Unit::TestCase
+
+  def mock_response(body, code=200, headers={})
+    Tire::HTTP::Response.new(body, code, headers)
+  end
+
+  def fixtures_path
+    Pathname( File.expand_path( 'fixtures', File.dirname(__FILE__) ) )
+  end
+
+  def fixture_file(path)
+    File.read File.expand_path( path, fixtures_path )
+  end
+
+end

data/tire-contrib.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tire-contrib/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tire-contrib"
+  s.version     = Tire::Contrib::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Karel Minarik", "Oliver Eilhard"]
+  s.email       = ["karmi@karmi.cz", "oliver.eilhard@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Contributions and additions for the Tire gem}
+
+  s.rubyforge_project = "tire-contrib"
+
+  s.add_dependency "bundler", "~> 1.0.0"
+  s.add_dependency "tire"
+
+  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.extra_rdoc_files  = [ "README.markdown", "MIT-LICENSE" ]
+  s.rdoc_options      = [ "--charset=UTF-8" ]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification 
+name: tire-contrib
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Karel Minarik
+- Oliver Eilhard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-16 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: tire
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: turn
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sdoc
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: 
+email: 
+- karmi@karmi.cz
+- oliver.eilhard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- MIT-LICENSE
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- lib/tire-contrib.rb
+- 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
+- test/test_helper.rb
+- tire-contrib.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: tire-contrib
+rubygems_version: 1.3.6
+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/test_helper.rb