speed 0.1.0 → 0.2.0

data/Manifest

@@ -1,4 +1,6 @@
+Manifest
+README.rdoc
 Rakefile
 init.rb
 lib/speed.rb
-Manifest
+spec/speed.rb

data/README.rdoc

@@ -0,0 +1,76 @@
+= Speed
+
+Quick and easy timing for ruby methods which can be used to time code in controllers or models for rails
+
+== Installation
+
+Speed can be installed either as a rails plugin or as a gem.
+
+== Basic Usage
+
+Speed is extremely easy to use, and super light weight. All you need to do is include Speed into the class or module you require timed methods for, and put your code that you need timed into our timer block, and the results can be viewed with the 'speed' method, which is a hash of all your timers.
+
+  require 'rubygems'
+  require 'speed'
+  
+  module TestSpeed
+    include Speed
+    
+    def TimeMe
+      timer(:time_me_method) do
+       sleep(2)
+      end
+      
+      puts speed[:time_me_method]   # Will return the speed in seconds
+    end
+  end
+  
+Speed also allows you to have multiple timers in timers, so you can break your code into different timed blocks.
+
+== Usage in Rails
+
+We created this gem to time how long some of our controllers took to render. This is how we use it:
+
+  class SearchController < ApplicationController
+    include Speed
+    
+    def results
+      timer(:results) do
+        @results = Product.search(params[:keyword])
+      end
+      
+      @timer = speed[:results]
+    end
+  end
+
+If you install this gem as a rails plugin, you wont need to 'include Speed' in your controllers or models. This would be done for you.
+
+
+  
+Follow me on twitter: http://twitter.com/ryan_za
+
+Email: ryan *at* platform45.com
+
+
+== License
+
+Copyright (c) 2009 Platform45
+
+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/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('speed', '0.1.0') do |p|
+Echoe.new('speed', '0.2.0') do |p|
   p.description    = "Quick and easy timing for ruby methods which can be used to time code in controllers or models for rails"
   p.url            = "http://github.com/platform45/speed"
   p.author         = "Platform45"

data/lib/speed.rb

@@ -1,21 +1,14 @@
 module Speed
-  def self.included(base)
-    base.extend ClassMethods
+  @@results = {}
+
+  def timer(name)
+    start_time = Time.now
+    yield
+    result = Time.now - start_time
+    @@results[name.to_sym] = result
   end
-  
-  module ClassMethods
-    
-    @@results = {}
-    
-    def timer(name)
-      start_time = Time.now
-      yield
-      result = Time.now - start_time
-      @@results[name.to_sym] = result
-    end
-    
-    def speed
-      @@results
-    end
+
+  def speed
+    @@results
   end
 end

data/spec/speed.rb

@@ -0,0 +1,22 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'speed'
+ 
+describe "Speed" do
+  before(:each) do
+    module Test
+      include Speed
+    end
+    
+    Test.timer(:test) do
+      sleep(1)
+    end
+  end
+  it "Should time the block" do
+    Test.speed.should_not be_nil
+  end
+  
+  it "should return the timed results in a hash" do
+    Test.speed.class.should == Hash
+  end
+end

data/speed.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{speed}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Platform45"]
   s.date = %q{2010-01-19}
   s.description = %q{Quick and easy timing for ruby methods which can be used to time code in controllers or models for rails}
   s.email = %q{ryan@platform45.com}
-  s.extra_rdoc_files = ["lib/speed.rb"]
-  s.files = ["Rakefile", "init.rb", "lib/speed.rb", "Manifest", "speed.gemspec"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/speed.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "init.rb", "lib/speed.rb", "spec/speed.rb", "speed.gemspec"]
   s.homepage = %q{http://github.com/platform45/speed}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Speed", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: speed
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Platform45
@@ -20,12 +20,15 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- README.rdoc
 - lib/speed.rb
 files: 
+- Manifest
+- README.rdoc
 - Rakefile
 - init.rb
 - lib/speed.rb
-- Manifest
+- spec/speed.rb
 - speed.gemspec
 has_rdoc: true
 homepage: http://github.com/platform45/speed