benchmark_helper.rb 1.2 KB
Newer Older
1 2 3 4
require 'benchmark'

module ActionView
  module Helpers
5 6
    # This helper offers a method to measure the execution time of a block 
    # in a template.
7
    module BenchmarkHelper
8 9 10 11 12
      # Allows you to measure the execution time of a block 
      # in a template and records the result to the log. Wrap this block around
      # expensive operations or possible bottlenecks to get a time reading
      # for the operation.  For example, let's say you thought your file 
      # processing method was taking too long; you could wrap it in a benchmark block.
13
      #
14 15
      #  <% benchmark "Process data files" do %>
      #    <%= expensive_files_operation %>
16 17
      #  <% end %>
      #
18 19
      # That would add something like "Process data files (0.34523)" to the log,
      # which you can then use to compare timings when optimizing your code.
20 21
      #
      # You may give an optional logger level as the second argument
22
      # (:debug, :info, :warn, :error); the default value is :info.
23 24 25 26
      def benchmark(message = "Benchmarking", level = :info)
        if @logger
          real = Benchmark.realtime { yield }
          @logger.send level, "#{message} (#{'%.5f' % real})"
27 28 29 30
        end
      end
    end
  end
31
end