Parent

Files

ProgressBar::Components::Rate

Attributes

rate_scale[RW]

Public Class Methods

new(options = {}) click to toggle source
# File lib/ruby-progressbar/components/rate.rb, line 9
def initialize(options = {})
  self.rate_scale = options[:rate_scale]

  super
end

Public Instance Methods

reset() click to toggle source
# File lib/ruby-progressbar/components/rate.rb, line 20
def reset
  as(Timer).reset
  as(Progressable).reset
end
start(options = {}) click to toggle source
# File lib/ruby-progressbar/components/rate.rb, line 15
def start(options = {})
  as(Timer).start
  as(Progressable).start(options)
end
to_s(format_string = "%i") click to toggle source
# File lib/ruby-progressbar/components/rate.rb, line 25
def to_s(format_string = "%i")
  elapsed = elapsed_whole_seconds.to_f
  return 0 unless elapsed > 0

  base_rate   = (progress_made / elapsed)

  if rate_scale
    scaled_rate = rate_scale.call(base_rate)
  else
    scaled_rate = base_rate
  end

  format_string % scaled_rate
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.