Contents

module Vedeu

  # Measure the duration. Used for debugging.
  #
  class Timer

    class << self

      # @example
      #   Vedeu.timer 'message' do
      #     # ... code to be measured
      #   end
      #
      # @param message [String]
      # @param block [Proc]
      # @return [void] The return value of the executed block.
      def timer(message = '', &block)
        new(message).measure(&block)
      end

    end # Eigenclass

    # Returns a new instance of Vedeu::Timer.
    #
    # @param message [String]
    # @return [Vedeu::Timer]
    def initialize(message = '')
      @message = message
      @started = Time.now.to_f
    end

    # Write an entry to the log file stating how long a section of code took in
    # milliseconds. Useful for debugging performance.
    #
    # @return [void] The return value of the executed block.
    def measure
      work = yield

      Vedeu.log(type: :timer, message: "#{message} took #{elapsed}ms.")

      work
    end

    protected

    # @!attribute [r] started
    # @return [Time]
    attr_reader :started

    # @!attribute [r] message
    # @return [String]
    attr_reader :message

    # Returns the elapsed time in milliseconds with 3 decimal places.
    #
    # @return [Float]
    def elapsed
      ((Time.now.to_f - started) * 1000).round(3)
    end

  end # Timer

end # Vedeu

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
vedeu-0.6.7	lib/vedeu/log/timer.rb