easy-prof 1.0.0 → 1.1.0

data/.gitignore

@@ -1,3 +1,6 @@
 doc
 rdoc
 .yardoc
+pkg
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - ree
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+
+notifications:
+  recipients:
+    - kpumuk@kpumuk.info

data/Gemfile

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

data/README.md

@@ -0,0 +1,239 @@
+# easy-prof
+
+[![Travis-CI build status](https://secure.travis-ci.org/kpumuk/easy-prof.png)](http://travis-ci.org/kpumuk/easy-prof)
+
+Simple and easy to use Ruby code profiler, which could be used
+as a Rails plugin.
+
+## Installation
+
+Add the "easy-prof" gem to your `Gemfile`.
+
+    gem "easy-prof"
+
+And run `bundle install` command.
+
+## Description
+
+The main idea behind the easy-prof is creating check points and your
+code and measuring time needed to execute code blocks. Here is the
+example of easy-prof output:
+
+    [home#index] Benchmark results:
+    [home#index] debug: Logged in user home page
+    [home#index] progress: 0.7002 s [find top videos]
+    [home#index] progress: 0.0452 s [build categories list]
+    [home#index] progress: 0.0019 s [build tag cloud]
+    [home#index] progress: 0.0032 s [find featured videos]
+    [home#index] progress: 0.0324 s [find latest videos]
+    [home#index] debug: VIEW STARTED
+    [home#index] progress: 0.0649 s [top videos render]
+    [home#index] progress: 0.0014 s [categories render]
+    [home#index] progress: 2.5887 s [tag cloud render]
+    [home#index] progress: 0.0488 s [latest videos render]
+    [home#index] progress: 0.1053 s [featured video render]
+    [home#index] results: 3.592 s
+
+From this output you can see what checkpoints takes longer to reach,
+and what code fragments are pretty fast.
+
+## Usage
+
+The library extends `Kernel` with a method `easy_profiler`.
+By default profiling is disabled globally, so you should pass `:enabled`
+parameter to enable profiling of particular code. Also there is a time
+`:limit` option which could be used to skip logging of blocks which are
+fast enough.
+
+For more details see the options description below.
+
+    easy_profiler('sleep', :enabled => true) do |p|
+      sleep 1
+      p.progress('sleep 1')
+      p.debug('checkpoint reached')
+      sleep 2
+      p.progress('sleep 2')
+    end
+
+Method accepts two parameters: profiling session name and a hash of
+options:
+
+* `:enabled` — value indicating whether profiling is enabled.
+* `:limit` — minimum time period which should be reached to
+  print profiling log.
+* `:count_ar_instances` — indicating whether profiler should
+  log an approximate number of instantiated ActiveRecord objects.
+* `:count_memory_usage` — indicating whether profiler should
+  log an approximate amount of memory used.
+* `:logger` — a `Logger` instance.
+
+## Configuration
+
+There are some global configuration options exists:
+
+    EasyProfiler.configure do |config|
+      config.enable_profiling   = false
+      config.print_limit        = 0.01
+      config.count_ar_instances = false
+      config.count_memory_usage = false
+      config.logger             = nil # or Rails.logger or whatever
+      config.colorize_logging   = true
+      config.live_logging       = false
+    end
+
+* `enable_profiling` — used to enable or disable profiling
+  globalle (`false` by default).
+* `print_limit` — used to set a minimum time period in seconds
+  which should be reached to dump profile to the log (`0.01`
+  by default).
+* `count_ar_instances` — indicating whether profiler should
+  log an approximate number of instantiated ActiveRecord objects.
+* `count_memory_usage` — indicating whether profiler should
+  log an approximate amount of memory used.
+* `logger` — a `Logger` instance to dump logs to.
+* `colorize_logging` — when `true`, output will be
+  colorized (useful when dumping profiling information into the
+  Rails log).
+* `live_logging` — when `true`, every profiling info
+  will be pushed to the log immediately (by default everything will
+  be dumped in the end of profiling session).
+
+## Active Record instances number profiling
+
+easy-prof can log a number of instantiated ActiveRecord instances.
+To enable this kind of profiling, use a `:count_ar_instances`
+option or global setting with the same name.
+
+Please note, that easy-prof completely disables garbage collector
+during this kind of profiling. It could hurt your overall application
+performance, so do not use it on production boxes. Also I can't
+guaranty 100% precision, but it is about this value in almost all
+cases.
+
+Further reading:
+* [That’s Not a Memory Leak, It’s Bloat](http://www.engineyard.com/blog/2009/thats-not-a-memory-leak-its-bloat)
+
+## Memory usage profiling
+
+The plugin is able to log an amount of memory used by current Ruby
+process. To enable this kind of profiling, use a `:count_memory_usage`
+option or global setting with the same name.
+
+Please note, that easy-prof completely disables garbage collector
+during this kind of profiling. It could hurt your overall application
+performance, so do not use it on production boxes. Also I can't
+guaranty 100% precision, but it is about this value in almost all
+cases.
+
+## Dumping results to the Firebug console
+
+If you are profiling a Ruby on Rails application, it could be useful
+to get profiling results from production server sometimes. To achieve
+this you can use a `FirebugLogger`, bundled with this plugin.
+In any controller you have a helper called `firebug_logger`,
+so you can pass it to EasyProfiler using `:logger` option:
+
+    easy_profiler('home#index', :logger => firebug_logger, :limit => 2) do |p|
+    end
+
+The idea behind this logger is pretty simple (as everything in this
+plugin): there is an `after_filter` named `dump_firebug_profile`,
+which dumps profiling information after your action finished its work.
+Please note: it will not output any line when profiling session is
+disabled or time limit is not reached.
+
+Do not forget to protect firebug output: it is a bad idea to allow
+anyone to see your profiling session dump. You can allow admin
+users only to use firebug, or restrict this feature by IP address.
+
+BTW, you can use Firebug Console Lite (http://getfirebug.com/lite.html)
+to get this feature working in any browser! By default it works
+perfectly in Firefox with Firebug installed, and in Safari 4.
+
+## Ruby on Rails application profiling
+
+Here is a complete example of a Rails action profiling:
+
+    class HomeController < ApplicationController
+      def index
+        easy_profiler('home#index', :enabled => profile_request?, :limit => 2) do |p|
+          p.progress 'logged in user home page'
+
+          @top_videos = Video.top(:limit => 10)
+          p.progress 'find top videos'
+
+          @categories = Category.all(:order => 'name DESC')
+          p.progress 'build categories list'
+
+          @tag_cloud = Tag.tag_cloud(:limit => 200)
+          p.progress 'build tag cloud'
+
+          @featured_videos = Video.featured(limit => 5)
+          p.progress 'find featured videos'
+
+          @latest_videos = Video.latest(:limit => 5)
+          p.progress 'find latest videos'
+
+          @profiler = p
+          p.debug 'VIEW STARTED'
+        end
+      end
+
+      private
+
+        # Method returns +true+ if current request should ouput profiling information
+        def profile_request?
+          params['_with_profiling'] == 'yes'
+        end
+    end
+
+And a view:
+
+    <div id="top_videos">
+      <%= render :partial => 'top_videos' %>
+      <% @profiler.progress 'top videos render' %>
+    </div>
+
+    <div class="tabs">
+      <ul id="taxonomy">
+        <li><a href="#" id="categories" class="current">Categories</a></li>
+        <li><a href="#" id="tags">Tags</a></li>
+      </ul>
+      <div class="categories_panel">
+        <%= render :partial => 'categories' %>
+        <% @profiler.progress 'categories render' %>
+      </div>
+      <div class="categories_panel hidden">
+        <%= render :partial => 'tag_cloud' %>
+        <% @profiler.progress 'tag cloud render' %>
+      </div>
+    </div>
+
+    <div class="box">
+      <div id="latest">
+        <%= render :partial => 'videos', :videos => @latest_videos %>
+        <% @profiler.progress 'latest videos render' %>
+      </div>
+      <div id="featured">
+        <%= render :partial => 'videos', :videos => @featured_videos %>
+        <% @profiler.progress 'featured video render' %>
+      </div>
+    </div>
+
+As you can see from this example, profiler will be enabled only when
+you pass a _with_profiling parameter with value yes:
+
+    http://example.com/home?_with_profiling=yes
+
+## Who are the authors?
+
+This plugin has been created in Scribd.com for our internal use
+and then the sources were opened for other people to use. All the
+code in this package has been developed by Dmytro Shteflyuk for
+Scribd.com and is released under the MIT license. For more details,
+see the MIT-LICENSE file.
+
+## Credits
+
+* Dmytro Shteflyuk (author) <kpumuk@kpumuk.info> http://kpumuk.info
+* Alexey Kovyrin (contributor) <alexey@kovyrin.net> http://kovyrin.net

data/Rakefile

@@ -1,36 +1,11 @@
-require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name        = 'easy-prof'
-    gemspec.summary     = 'Simple and easy to use Ruby code profiler'
-    gemspec.description = 'Simple Ruby code profiler to use both in Rails applications and generic Ruby scripts.'
-    gemspec.email       = 'kpumuk@kpumuk.info'
-    gemspec.homepage    = 'http://github.com/kpumuk/easy-prof'
-    gemspec.authors     = ['Dmytro Shteflyuk']
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts 'Jeweler not available. Install it with: sudo gem install jeweler'
-end
-
-begin
-  require 'spec/rake/spectask'
-
-  desc 'Default: run unit tests.'
-  task :default => :spec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-  desc 'Test the easy-prof plugin.'
-  Spec::Rake::SpecTask.new(:spec) do |t|
-    t.libs << 'lib'
-    t.pattern = 'spec/**/*_spec.rb'
-    t.verbose = true
-    t.spec_opts = ['-cfs']
-  end
-rescue LoadError
-  puts 'RSpec not available. Install it with: sudo gem install rspec'
-end
+task :test => :spec
+task :default => :spec
 
 begin
   require 'yard'

data/easy-prof.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'easy_prof/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'easy-prof'
+  s.version     = EasyProfiler::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Dmytro Shteflyuk']
+  s.email       = ['kpumuk@kpumuk.info']
+  s.homepage    = 'http://github.com/kpumuk/easy-prof'
+  s.summary     = %q{Simple and easy to use Ruby code profiler.}
+  s.description = %q{Simple Ruby code profiler to use both in Rails applications and generic Ruby scripts.}
+
+  s.add_development_dependency 'activerecord', '~> 3.2.15'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'bluecloth'
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extra_rdoc_files = ['README.md']
+  s.rdoc_options     = ['--charset=UTF-8']
+  s.require_paths    = ['lib']
+end

data/lib/easy-prof.rb

@@ -0,0 +1 @@
+require 'easy_prof'

data/lib/easy_prof.rb

@@ -1,13 +1,13 @@
 require 'logger'
 
 module EasyProfiler
-  autoload :Configuration,              'easy_profiler/configuration'
-  autoload :Profile,                    'easy_profiler/profile'
-  autoload :ProfileInstanceBase,        'easy_profiler/profile_instance_base'
-  autoload :ProfileInstance,            'easy_profiler/profile_instance'
-  autoload :NoProfileInstance,          'easy_profiler/no_profile_instance'
-  autoload :FirebugLogger,              'easy_profiler/firebug_logger'
-  autoload :ActionControllerExtensions, 'easy_profiler/action_controller_extensions'
+  autoload :Configuration,              'easy_prof/configuration'
+  autoload :Profile,                    'easy_prof/profile'
+  autoload :ProfileInstanceBase,        'easy_prof/profile_instance_base'
+  autoload :ProfileInstance,            'easy_prof/profile_instance'
+  autoload :NoProfileInstance,          'easy_prof/no_profile_instance'
+  autoload :FirebugLogger,              'easy_prof/firebug_logger'
+  autoload :ActionControllerExtensions, 'easy_prof/action_controller_extensions'
 
   module ClassMethods
     def configure(force = false)

data/lib/{easy_profiler → easy_prof}/configuration.rb

@@ -2,7 +2,7 @@ module EasyProfiler
   class Configuration
     # Value indicating whether profiling is globally enabled.
     attr_reader :enable_profiling
-    
+
     # Minimum time period which should be reached to dump
     # profile to the log.
     attr_reader :print_limit
@@ -32,10 +32,10 @@ module EasyProfiler
       @count_ar_instances = false
       @count_memory_usage = false
       @logger             = nil
-      @colorize_logging   = true
+      @colorize_logging   = false
       @live_logging       = false
     end
-    
+
     # Sets a value indicating whether profiling is globally enabled.
     def enable_profiling=(value)
       @enable_profiling = !!value
@@ -55,10 +55,10 @@ module EasyProfiler
 
     # Sets a value indicating whether profiler should log an
     # approximate amount of memory used.
-    # 
+    #
     # @param Boolean value
     #   identifies whether memory profiling should be enabled.
-    # 
+    #
     def count_memory_usage=(value)
       @count_memory_usage = !!value
     end
@@ -69,7 +69,7 @@ module EasyProfiler
 
     # Sets a value indicating whether profiler should flush
     # logs on every checkpoint.
-    # 
+    #
     def live_logging=(value)
       @live_logging = !!value
     end
@@ -82,7 +82,7 @@ module EasyProfiler
     # information directly to STDOUT. You can use
     # <tt>EasyProfiler.configuration.logger</tt> to set another
     # logger.
-    # 
+    #
     def logger
       unless @logger
         @logger = if Object.const_defined?(:Rails)
@@ -105,16 +105,26 @@ module EasyProfiler
       config.logger             = options[:logger]             if options.has_key?(:logger)
       config.colorize_logging   = options[:colorize_logging]   if options.has_key?(:colorize_logging)
       config.live_logging       = options[:live_logging]       if options.has_key?(:live_logging)
-      
       config
     end
-    
+
+    def self.parse(config)
+      case config
+        when Hash
+          EasyProfiler.configuration.merge(config)
+        when EasyProfiler::Configuration
+          config
+        else
+          EasyProfiler.configuration
+      end
+    end
+
     def disable_gc?
       count_ar_instances or count_memory_usage
     end
-    
+
     def enabled?
       enable_profiling
     end
   end
-end
+end

data/lib/{easy_profiler → easy_prof}/profile.rb

@@ -21,20 +21,22 @@ module EasyProfiler
     #
     # Returns:
     # * an instance of profiler (descendant of the <tt>EasyProfiler::ProfileInstanceBase</tt> class).
-    def self.start(name, options = {})
+    def self.start(name, config = nil)
       if @@profile_results[name]
         raise ArgumentError.new("EasyProfiler::Profile.start() collision! '#{name}' is already started.")
       end
 
-      config = EasyProfiler.configuration.merge(options)
-
-      # Disable garbage collector to get more precise results
-      GC.disable if config.disable_gc?
+      config = Configuration.parse(config)
 
       klass = config.enabled? ? ProfileInstance : NoProfileInstance
       instance = klass.new(name, config)
 
       @@profile_results[name] = instance
+
+      # Disable garbage collector to get more precise results
+      GC.disable if instance.config.disable_gc?
+
+      instance
     end
 
     # Finishes a profiling session and dumps results to the log.
@@ -53,7 +55,7 @@ module EasyProfiler
     end
 
     def self.reset!
-      @@profile_results    = {}
+      @@profile_results = {}
     end
   end
-end
+end

data/lib/{easy_profiler → easy_prof}/profile_instance.rb

@@ -1,6 +1,8 @@
 module EasyProfiler
   # Class used when profiling is disabled.
   class ProfileInstance < ProfileInstanceBase
+    @@groups_stack       = []
+
     # Sets a profiling checkpoint (block execution time will be printed).
     #
     # Parameters:
@@ -33,15 +35,32 @@ module EasyProfiler
       buffer_checkpoint("debug: #{message}")
     end
 
+    # Start a group with a specified name.
+    #
+    # Parameters:
+    # * name -- a name of the group.
+    #
+    def group(name)
+      progress "Before group '#{name}'"
+      debug 'Started group'
+      @@groups_stack << name
+    end
+
+    def end_group
+      debug "Finished group"
+      @@groups_stack.pop
+    end
+
     # Dumps results to the log.
     def dump_results
+      self.end_group while @@groups_stack.any?
+
       progress('END')
-      t = total
 
-      if config.live_logging || false === config.print_limit || t > config.print_limit.to_f
-        log_header(true)
-        @buffer.each { |message| log_line(message) }
-        log_footer(t)
+      t = total
+      log_footer(t)
+      if false === config.print_limit || t > config.print_limit.to_f
+        @buffer.each { |message| log_line(*message) }
       end
     end
 
@@ -64,20 +83,22 @@ module EasyProfiler
 
       # Buffers a profiling checkpoint.
       def buffer_checkpoint(message)
-        log_header
+        log_header unless @header_printed
+
+        group_name = @@groups_stack.last
+        name = group_name ? "#{@name}: #{group_name}" : @name
+
         if config.live_logging
-          log_line(message)
+          log_line(message, name)
         else
-          @buffer << message
+          @buffer << [message, name]
         end
       end
 
       # Write a header to the log.
-      def log_header(force = false)
-        if (config.live_logging && !@header_printed) || (!config.live_logging && force)
-          log_line("Benchmark results:")
-          @header_printed = true
-        end
+      def log_header
+        @header_printed = true
+        buffer_checkpoint("Benchmark results:")
       end
 
       # Write a footer with summary stats to the log.
@@ -90,11 +111,13 @@ module EasyProfiler
           ", #{format_memory_size(total_memory_usage)}"
         end
 
-        log_line("results: %0.4f s#{ar_instances_count}#{memory_usage_value}" % total_time)
+        buffer_checkpoint("results: %0.4f s#{ar_instances_count}#{memory_usage_value}" % total_time)
       end
 
       # Write a log line.
-      def log_line(line)
+      def log_line(line, name = nil)
+        name ||= @name
+
         if config.colorize_logging
           @@row_even, message_color = if @@row_even
             [false, '4;32;1']
@@ -102,10 +125,10 @@ module EasyProfiler
             [true, '4;33;1']
           end
 
-          config.logger.info("  [\e[#{message_color}m%s\e[0m] %s" % [@name, line])
+          config.logger.info("[\e[#{message_color}m%s\e[0m] %s" % [name, line])
         else
-          config.logger.info("[%s] %s" % [@name, line])
+          config.logger.info("[%s] %s" % [name, line])
         end
       end
     end
-end
+end

data/lib/{easy_profiler → easy_prof}/profile_instance_base.rb

@@ -1,7 +1,7 @@
 module EasyProfiler
   # Base class for profilers.
   class ProfileInstanceBase
-    attr_reader :name, :config
+    attr_reader :name, :config, :buffer
 
     @@row_even = true
 
@@ -12,11 +12,7 @@ module EasyProfiler
     # * options -- a +Hash+ of options (see <tt>EasyProfiler::Profile.start</tt> for details).
     def initialize(name, config = nil)
       @name = name
-      @config = case config
-        when Hash: EasyProfiler.configuration.merge(config)
-        when EasyProfiler::Configuration: config
-        else EasyProfiler.configuration
-      end
+      @config = Configuration.parse(config)
 
       @start = @progress = Time.now.to_f
 
@@ -52,6 +48,18 @@ module EasyProfiler
     def debug(message)
     end
 
+    # Start a group with a specified name.
+    #
+    # Parameters:
+    # * name -- a name of the group.
+    #
+    def group(name, options = {}, &block)
+      self
+    end
+
+    def end_group
+    end
+
     # Dumps results to the log.
     def dump_results
     end

data/lib/easy_prof/version.rb

@@ -0,0 +1,4 @@
+module EasyProfiler
+  VERSION = '1.1.0'
+end
+

data/spec/profile_instance_spec.rb

@@ -6,7 +6,7 @@ describe EasyProfiler::ProfileInstance do
     profiler.name.should == 'myprofiler1'
     profiler.config.should be(EasyProfiler.configuration)
 
-    profiler = EasyProfiler::ProfileInstance.new('myprofiler2', { :print_limit => 100 })
+    profiler = EasyProfiler::ProfileInstance.new('myprofiler2', :print_limit => 100)
     profiler.name.should == 'myprofiler2'
     profiler.config.print_limit.should == 100
 
@@ -17,14 +17,23 @@ describe EasyProfiler::ProfileInstance do
     profiler.config.should be(config)
   end
 
+  it 'should not change global configuration options' do
+    EasyProfiler.config.print_limit = 10
+
+    profiler = EasyProfiler::ProfileInstance.new('myprofiler1', :print_limit => 100)
+    profiler.config.print_limit.should == 100
+
+    EasyProfiler.config.print_limit.should == 10
+  end
+
   it 'should respond to :progress' do
     profiler = EasyProfiler::ProfileInstance.new('myprofiler')
     profiler.should respond_to(:progress)
     lambda {
       profiler.progress('message')
-      buffer = profiler.instance_variable_get(:@buffer)
-      buffer.should have(1).item
-      buffer.first.should match(/progress: \d+\.\d+ s \[message\]/)
+      profiler.buffer.should have(2).items
+      profiler.buffer[1][0].should match(/progress: \d+\.\d+ s \[message\]/)
+      profiler.buffer[1][1].should == 'myprofiler'
     }.should_not raise_error
   end
 
@@ -33,14 +42,14 @@ describe EasyProfiler::ProfileInstance do
     profiler.should respond_to(:debug)
     lambda {
       profiler.debug('message')
-      buffer = profiler.instance_variable_get(:@buffer)
-      buffer.should have(1).item
-      buffer.first.should match(/debug: message/)
+      profiler.buffer.should have(2).item
+      profiler.buffer[1][0].should match(/debug: message/)
+      profiler.buffer[1][1].should == 'myprofiler'
     }.should_not raise_error
   end
 
   it 'should respond to :dump_results' do
-    logger = mock('MockLogger')
+    logger = double('MockLogger')
     profiler = EasyProfiler::ProfileInstance.new('myprofiler', :logger => logger, :enabled => true, :limit => false, :colorize_logging => false)
     profiler.should respond_to(:dump_results)
 
@@ -57,7 +66,7 @@ describe EasyProfiler::ProfileInstance do
   end
 
   it 'should render nothing when time limit not reached' do
-    logger = mock('MockLogger')
+    logger = double('MockLogger')
     profiler = EasyProfiler::ProfileInstance.new('myprofiler', :logger => logger, :enabled => true, :limit => 20)
     logger.should_not_receive(:info)
     profiler.dump_results
@@ -65,7 +74,7 @@ describe EasyProfiler::ProfileInstance do
 
   context 'when live logging is enabled' do
     before :each do
-      @logger = mock('MockLogger').as_null_object
+      @logger = double('MockLogger').as_null_object
       @profiler = EasyProfiler::ProfileInstance.new('myprofiler', :logger => @logger, :enabled => true, :live_logging => true, :colorize_logging => false)
     end
 
@@ -110,4 +119,4 @@ describe EasyProfiler::ProfileInstance do
       @profiler.dump_results
     end
   end
-end
+end

data/spec/profile_spec.rb

@@ -7,10 +7,13 @@ describe EasyProfiler::Profile do
       config.print_limit        = 0.01
       config.count_ar_instances = false
       config.count_memory_usage = false
+      config.logger             = nil
+      config.colorize_logging   = false
+      config.live_logging       = false
     end
     EasyProfiler::Profile.reset!
   end
-  
+
   context '.start' do
     it 'should pass name to profile instance' do
       EasyProfiler::Profile.start('myprofiler').name.should == 'myprofiler'
@@ -21,6 +24,15 @@ describe EasyProfiler::Profile do
       EasyProfiler::Profile.start('myprofiler', options).config.print_limit.should == 100
     end
 
+    it 'should not change global configuration options' do
+      EasyProfiler.config.print_limit = 10
+
+      profiler = EasyProfiler::Profile.start('myprofiler', :print_limit => 100)
+      profiler.config.print_limit.should == 100
+
+      EasyProfiler.config.print_limit.should == 10
+    end
+
     it 'should create a ProfileInstance object when enabled' do
       options = { :enabled => true }
       EasyProfiler::Profile.start('myprofiler', options).class.should == EasyProfiler::ProfileInstance
@@ -63,7 +75,7 @@ describe EasyProfiler::Profile do
     end
 
     it 'should use global :logger value' do
-      logger = mock('MockLogger')
+      logger = double('MockLogger')
       EasyProfiler.config.logger = logger
       EasyProfiler::Profile.start('myprofiler2').config.logger.should be(logger)
     end
@@ -73,7 +85,7 @@ describe EasyProfiler::Profile do
       EasyProfiler.config.live_logging = true
       EasyProfiler::Profile.start('myprofiler2').config.live_logging.should be_true
     end
-    
+
     it 'should disable garbage collector when needed' do
       options = { :enabled => true, :count_ar_instances => true }
       GC.should_receive(:disable)
@@ -100,14 +112,14 @@ describe EasyProfiler::Profile do
 
     it 'should enable back garbage collector when needed' do
       profiler = mock_profile_start('myprofiler1', :enabled => true, :count_ar_instances => true)
-      profiler.stub!(:dump_results)
+      profiler.stub(:dump_results)
       GC.should_receive(:enable)
       EasyProfiler::Profile.stop('myprofiler1')
 
       profiler = mock_profile_start('myprofiler2', :enabled => true, :count_memory_usage => true)
-      profiler.stub!(:dump_results)
+      profiler.stub(:dump_results)
       GC.should_receive(:enable)
       EasyProfiler::Profile.stop('myprofiler2')
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -4,6 +4,6 @@ require File.join(File.dirname(__FILE__), "../lib/easy_prof")
 
 def mock_profile_start(name, options = {})
   config = EasyProfiler.configuration.merge(options)
-  profiler = mock 'MockProfiler', :name => name, :config => config
+  profiler = double('MockProfiler', :name => name, :config => config)
   EasyProfiler::Profile.send(:class_variable_get, :@@profile_results)[name] = profiler
-end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: easy-prof
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Dmytro Shteflyuk
@@ -14,33 +15,109 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-23 00:00:00 +02:00
+date: 2013-11-13 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 3
+        - 2
+        - 15
+        version: 3.2.15
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: Simple Ruby code profiler to use both in Rails applications and generic Ruby scripts.
-email: kpumuk@kpumuk.info
+email: 
+- kpumuk@kpumuk.info
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.md
 files: 
 - .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
-- VERSION.yml
-- init.rb
+- easy-prof.gemspec
+- lib/easy-prof.rb
 - lib/easy_prof.rb
-- lib/easy_profiler/action_controller_extensions.rb
-- lib/easy_profiler/configuration.rb
-- lib/easy_profiler/firebug_logger.rb
-- lib/easy_profiler/no_profile_instance.rb
-- lib/easy_profiler/profile.rb
-- lib/easy_profiler/profile_instance.rb
-- lib/easy_profiler/profile_instance_base.rb
+- lib/easy_prof/action_controller_extensions.rb
+- lib/easy_prof/configuration.rb
+- lib/easy_prof/firebug_logger.rb
+- lib/easy_prof/no_profile_instance.rb
+- lib/easy_prof/profile.rb
+- lib/easy_prof/profile_instance.rb
+- lib/easy_prof/profile_instance_base.rb
+- lib/easy_prof/version.rb
 - spec/easy_profiler_spec.rb
 - spec/no_profile_instance_spec.rb
 - spec/profile_instance_spec.rb
@@ -56,29 +133,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: Simple and easy to use Ruby code profiler
-test_files: 
-- spec/easy_profiler_spec.rb
-- spec/no_profile_instance_spec.rb
-- spec/profile_instance_spec.rb
-- spec/profile_spec.rb
-- spec/spec_helper.rb
+summary: Simple and easy to use Ruby code profiler.
+test_files: []
+

data/README.rdoc

@@ -1,248 +0,0 @@
-= easy-prof
-
-Simple and easy to use Ruby code profiler, which could be used
-as a Rails plugin.
-
-== Installation
-
-There are two options when approaching easy-prof installation:
-
-* using the gem (recommended)
-* install as a Rails plugin
-
-To install as a gem, add this to your environment.rb:
-
-  config.gem 'easy-prof', :lib => 'easy_prof'
-
-And then run the command:
-
-  sudo rake gems:install
-
-To install meta-tags as a Rails plugin use this:
-
-  script/plugin install git://github.com/kpumuk/easy-prof.git
-
-== Description
-
-The main idea behind the easy-prof is creating check points and your
-code and measuring time needed to execute code blocks. Here is the
-example of easy-prof output:
-
-  [home#index] Benchmark results:
-  [home#index] debug: Logged in user home page
-  [home#index] progress: 0.7002 s [find top videos]
-  [home#index] progress: 0.0452 s [build categories list]
-  [home#index] progress: 0.0019 s [build tag cloud]
-  [home#index] progress: 0.0032 s [find featured videos]
-  [home#index] progress: 0.0324 s [find latest videos]
-  [home#index] debug: VIEW STARTED
-  [home#index] progress: 0.0649 s [top videos render]
-  [home#index] progress: 0.0014 s [categories render]
-  [home#index] progress: 2.5887 s [tag cloud render]
-  [home#index] progress: 0.0488 s [latest videos render]
-  [home#index] progress: 0.1053 s [featured video render]
-  [home#index] results: 3.592 s
-
-From this output you can see what checkpoints takes longer to reach,
-and what code fragments are pretty fast.
-
-== Usage
-
-The library extends <tt>Kernel</tt> with a method <tt>easy_profiler</tt>.
-By default profiling is disabled globally, so you should pass :enabled
-parameter to enable profiling of particular code. Also there is a time
-:limit option which could be used to skip logging of blocks which are
-fast enough.
-
-For more details see the options description below.
-
-  easy_profiler('sleep', :enabled => true) do |p|
-    sleep 1
-    p.progress('sleep 1')
-    p.debug('checkpoint reached')
-    sleep 2
-    p.progress('sleep 2')
-  end
-
-Method accepts two parameters: profiling session name and a hash of
-options:
-
-* <tt>:enabled</tt> -- value indicating whether profiling is enabled.
-* <tt>:limit</tt> -- minimum time period which should be reached to
-  print profiling log.
-* <tt>:count_ar_instances</tt> -- indicating whether profiler should
-  log an approximate number of instantiated ActiveRecord objects.
-* <tt>:count_memory_usage</tt> -- indicating whether profiler should
-  log an approximate amount of memory used.
-* <tt>:logger</tt> -- a +Logger+ instance.
-
-== Configuration
-
-There are some global configuration options exists:
-
-  EasyProfiler.configure do |config|
-    config.enable_profiling   = false
-    config.print_limit        = 0.01
-    config.count_ar_instances = false
-    config.count_memory_usage = false
-    config.logger             = nil # or Rails.logger or whatever
-    config.colorize_logging   = true
-    config.live_logging       = false
-  end
-
-* <tt>enable_profiling</tt> -- used to enable or disable profiling
-  globalle (<tt>false</tt> by default).
-* <tt>print_limit</tt> -- used to set a minimum time period in seconds
-  which should be reached to dump profile to the log (<tt>0.01</tt>
-  by default).
-* <tt>count_ar_instances</tt> -- indicating whether profiler should
-  log an approximate number of instantiated ActiveRecord objects.
-* <tt>count_memory_usage</tt> -- indicating whether profiler should
-  log an approximate amount of memory used.
-* <tt>logger</tt> -- a <tt>Logger</tt> instance to dump logs to.
-* <tt>colorize_logging</tt> -- when <tt>true</tt>, output will be
-  colorized (useful when dumping profiling information into the
-  Rails log).
-* <tt>live_logging</tt> -- when <tt>true</tt>, every profiling info
-  will be pushed to the log immediately (by default everything will
-  be dumped in the end of profiling session).
-
-== Active Record instances number profiling
-
-easy-prof can log a number of instantiated ActiveRecord instances.
-To enable this kind of profiling, use a <tt>:count_ar_instances</tt>
-option or global setting with the same name.
-
-Please note, that easy-prof completely disables garbage collector
-during this kind of profiling. It could hurt your overall application
-performance, so do not use it on production boxes. Also I can't
-guaranty 100% precision, but it is about this value in almost all
-cases.
-
-Further reading:
-* That’s Not a Memory Leak, It’s Bloat http://www.engineyard.com/blog/2009/thats-not-a-memory-leak-its-bloat/
-
-== Memory usage profiling
-
-The plugin is able to log an amount of memory used by current Ruby
-process. To enable this kind of profiling, use a <tt>:count_memory_usage</tt>
-option or global setting with the same name.
-
-Please note, that easy-prof completely disables garbage collector
-during this kind of profiling. It could hurt your overall application
-performance, so do not use it on production boxes. Also I can't
-guaranty 100% precision, but it is about this value in almost all
-cases.
-
-== Dumping results to the Firebug console
-
-If you are profiling a Ruby on Rails application, it could be useful
-to get profiling results from production server sometimes. To achieve
-this you can use a <tt>FirebugLogger</tt>, bundled with this plugin.
-In any controller you have a helper called <tt>firebug_logger</tt>,
-so you can pass it to EasyProfiler using <tt>:logger</tt> option:
-
-  easy_profiler('home#index', :logger => firebug_logger, :limit => 2) do |p|
-  end
-
-The idea behind this logger is pretty simple (as everything in this
-plugin): there is an <tt>after_filter</tt> named <tt>dump_firebug_profile</tt>,
-which dumps profiling information after your action finished its work.
-Please note: it will not output any line when profiling session is
-disabled or time limit is not reached.
-
-Do not forget to protect firebug output: it is a bad idea to allow
-anyone to see your profiling session dump. You can allow admin
-users only to use firebug, or restrict this feature by IP address.
-
-BTW, you can use Firebug Console Lite (http://getfirebug.com/lite.html)
-to get this feature working in any browser! By default it works
-perfectly in Firefox with Firebug installed, and in Safari 4.
-
-== Ruby on Rails application profiling
-
-Here is the complete example of a Rails action profiling:
-
-  class HomeController < ApplicationController
-    def index
-      easy_profiler('home#index', :enabled => profile_request?, :limit => 2) do |p|
-        p.progress 'logged in user home page'
-      
-        @top_videos = Video.top(:limit => 10)
-        p.progress 'find top videos'
-
-        @categories = Category.all(:order => 'name DESC')
-        p.progress 'build categories list'
-
-        @tag_cloud = Tag.tag_cloud(:limit => 200)
-        p.progress 'build tag cloud'
-      
-        @featured_videos = Video.featured(limit => 5)
-        p.progress 'find featured videos'
-
-        @latest_videos = Video.latest(:limit => 5)
-        p.progress 'find latest videos'
-      
-        @profiler = p
-        p.debug 'VIEW STARTED'
-      end
-    end
-
-    private
-  
-      # Method returns +true+ if current request should ouput profiling information
-      def profile_request?
-        params['_with_profiling'] == 'yes'
-      end
-  end
-
-And view:
-
-  <div id="top_videos">
-    <%= render :partial => 'top_videos' %>
-    <% @profiler.progress 'top videos render' %>
-  </div>
-  
-  <div class="tabs">
-    <ul id="taxonomy">
-      <li><a href="#" id="categories" class="current">Categories</a></li>
-      <li><a href="#" id="tags">Tags</a></li>
-    </ul>
-    <div class="categories_panel">
-      <%= render :partial => 'categories' %>
-      <% @profiler.progress 'categories render' %>
-    </div>
-    <div class="categories_panel hidden">
-      <%= render :partial => 'tag_cloud' %>
-      <% @profiler.progress 'tag cloud render' %>
-    </div>
-  </div>
-  
-  <div class="box">
-    <div id="latest">
-      <%= render :partial => 'videos', :videos => @latest_videos %>
-      <% @profiler.progress 'latest videos render' %>
-    </div>
-    <div id="featured">
-      <%= render :partial => 'videos', :videos => @featured_videos %>
-      <% @profiler.progress 'featured video render' %>
-    </div>
-  </div>
-  
-As you can see from this example, profiler will be enabled only when
-you pass a _with_profiling parameter with value yes:
-
-  http://example.com/home?_with_profiling=yes
-
-== Who are the authors?
-
-This plugin has been created in Scribd.com for our internal use
-and then the sources were opened for other people to use. All the
-code in this package has been developed by Dmytro Shteflyuk for
-Scribd.com and is released under the MIT license. For more details,
-see the MIT-LICENSE file.
-
-== Credits
-
-* Dmytro Shteflyuk (author) <kpumuk@kpumuk.info> http://kpumuk.info
-* Alexey Kovyrin (contributor) <alexey@kovyrin.net> http://kovyrin.net

data/VERSION.yml

@@ -1,5 +0,0 @@
---- 
-:patch: 0
-:build: 
-:major: 1
-:minor: 0

data/init.rb

@@ -1 +0,0 @@
-require 'easy_prof'