tracer_bullets 0.0.4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tracer_bullets.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 nate
+
+MIT License
+
+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.md

@@ -0,0 +1,102 @@
+Tracer Bullets
+===========
+
+> Tracer ammunition (tracers) are bullets or cannon caliber projectiles that are built with a small pyrotechnic charge in their base. Ignited by the burning powder, the pyrotechnic composition burns very brightly, making the projectile visible to the naked eye. This enables the shooter to follow the projectile trajectory to make aiming corrections.
+
+> [Wikipedia](http://en.wikipedia.org/wiki/Tracer_ammunition)
+
+Tracer Bullet is also an alter ego of Calvin in the comic strip Calvin and Hobbes. :)
+
+-----------------------
+
+The *Tracer Bullets* gem makes studying the performance of your Rails app from its development log file a lot easier.
+
+
+## Background
+
+Performance tuning a Rails app is still pretty damn hard. There are great tools out there like New Relic, and even Rails own performance tests, but still, I find areas where I'm tearing my hair out looking for slow bits. 
+
+On the Obama re-election campaign, I did a ton of performance engineering, and the tool that helped me out the most was simply something I built to add "tracer bullets" to my code. These bullets were just method calls to log the current location of the program and how much time had elapsed since the last time it was called. 
+
+I keep finding myself reinventing this same type of performance logging tool to solve performance bottlenecks in things I work on today, like **[Draft (an app to help people write better)](http://draftin.com)** 
+ 
+So here's a really simple version I made for everyone to use. It gives you a method to call:
+
+```ruby
+tracer_bullet
+```
+
+in your controllers and views. When you request an action from your Rails app, that method will log the elapsed time since the last time it was called as well as its location in your controller or view. 
+
+As you intermix them with your code, you'll notice it becomes a lot easier to narrow your focus on the slow parts of the request.
+
+## Syntax
+
+In a controller, just call the method:  
+
+```ruby
+tracer_bullet
+```
+
+In a view, call it with: 
+
+```erb
+<%= tracer_bullet %>
+```
+
+To save keystrokes, you can also use the alias: 
+
+```ruby
+tb
+```
+
+## Example Log
+
+The output of your development.log file will look like: 
+
+```
+Elapsed: 4.505ms /Users/nate/git/afternoon/app/views/documents/edit.html.erb:482
+
+# Other things in your log file
+
+Elapsed: 7.096ms /Users/nate/git/afternoon/app/views/documents/edit.html.erb:539
+```
+
+Letting you know that between line 482 of my edit.html.erb file and line 539, 7ms had passed. That isn't my slow section. 
+
+Now if it was obviously a lot slower like 200ms, I might take a good look at what's happening in that block of code. 
+
+## Development Only
+
+These traces only run in Development mode. So you can leave them in your code if you really want to. I prefer to remove them, once I've got my problem solved.
+
+
+Installation
+------------
+
+1) Add 'tracer_bullet' to your Gemfile. Probably best to just add it to your development group: 
+
+```
+group :development do 
+gem 'tracer_bullet'
+end
+```
+
+2) Run `bundle install`.
+3) Restart your server
+4) Call the tracer_bullet method in your actions:
+
+```ruby
+tracer_bullet
+```
+
+or view code:
+
+```erb
+<%= tracer_bullet %>
+```
+
+
+Feedback
+--------
+[Source code available on Github](https://github.com/n8/tracer_bullets). Feedback and pull requests are greatly appreciated.  Let me know if I can improve this.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tracer_bullets/version.rb

@@ -0,0 +1,3 @@
+module TracerBullets
+  VERSION = "0.0.4"
+end

data/lib/tracer_bullets.rb

@@ -0,0 +1,54 @@
+require "tracer_bullets/version"
+
+module TracerBullets
+
+  module Methods
+    def tracer_bullet
+      if Rails.env.development?
+        Rails.logger.debug( "Elapsed: #{((Time.now - @tracer_bullet_start_time)*1000).to_i}ms #{caller(0)[1]}" ) 
+        @tracer_bullet_start_time = Time.now
+      end
+    end
+    alias_method :tb, :tracer_bullet
+  end
+
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :setup_tracer_bullet_start_time
+    end
+
+    module InstanceMethods
+      include Methods
+
+      def setup_tracer_bullet_start_time
+        @tracer_bullet_start_time = Time.now
+      end
+    end
+  end
+
+  module View
+    extend ActiveSupport::Concern
+
+    module InstanceMethods
+      include Methods
+    end
+  end
+
+
+  class Railtie < Rails::Railtie
+    initializer "tracer_bullet.action_controller" do
+      ActiveSupport.on_load(:action_controller) do
+        include TracerBullets::Controller
+      end
+    end
+
+    initializer "tracer_bullet.action_view" do
+      ActiveSupport.on_load(:action_view) do
+        include TracerBullets::View
+      end
+    end
+  end
+
+end

data/tracer_bullets.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tracer_bullets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tracer_bullets"
+  spec.version       = TracerBullets::VERSION
+  spec.authors       = ["nate"]
+  spec.email         = ["nate@cityposh.com"]
+  spec.description   = %q{A simple way to see time expiration in your Rails log files}
+  spec.summary       = %q{A simple way to see time expiration in your Rails log files}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: tracer_bullets
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- nate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple way to see time expiration in your Rails log files
+email:
+- nate@cityposh.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tracer_bullets.rb
+- lib/tracer_bullets/version.rb
+- tracer_bullets.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple way to see time expiration in your Rails log files
+test_files: []