Contents

=begin
                  Arachni
  Copyright (c) 2010-2012 Tasos "Zapotek" Laskos <[e-mail]>

  This is free software; you can copy and distribute and modify
  this program under the term of the GPL v2.0 License
  (See LICENSE file for details)

=end

module Arachni

module Mixins

#
# Progress bar and ETA methods
#
module ProgressBar

    #
    # Formats elapsed time to hour:min:sec
    #
    def format_time( t )
        t = t.to_i
        sec = t % 60
        min = ( t / 60 ) % 60
        hour = t / 3600
        sprintf( "%02d:%02d:%02d", hour, min, sec )
    end

    #
    # Calculates ETA (Estimated Time of Arrival) based on current progress
    # and the start time of the operation.
    #
    # @param    [Float]   prog         current progress percentage
    # @param    [Time]   start_time    start time of the operation
    #
    # @return   [String]    ETA: hour:min:sec
    #
    def eta( prog, start_time )
        @last_prog ||= prog
        @last_eta  ||= "--:--:--"

        if @last_prog != prog
            elapsed = Time.now - start_time
            eta     = elapsed * 100 / prog - elapsed
            eta_str = format_time( eta )
        else
            eta_str = @last_eta
            prog = @last_prog
        end

        @last_prog = prog
        @last_eta  = eta_str
    end

    #
    # Returns an ASCII progress bar based on the current progress percentage
    #
    # @param    [Float]     progress     progress percentage
    # @param    [Integer]   width        width of the progressbar in characters
    #
    # @return   [String]    70% [=======>  ] 100%
    #
    def progress_bar( progress, width = 100 )
        progress = 100.0 if progress > 100

        bar_prog = progress * width / 100

        bar  = '=' * ( bar_prog.ceil - 1 ).abs + '>'
        pad = ( width - bar_prog )
        bar += ' ' * pad if pad > 0

        "#{progress}% [#{bar}] 100% "
    end

    extend self
end

end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
arachni-0.4.0.4	lib/arachni/mixins/progress_bar.rb
arachni-0.4.0.3	lib/arachni/mixins/progress_bar.rb
arachni-0.4.0.2	lib/arachni/mixins/progress_bar.rb
arachni-0.4.0.1	lib/arachni/mixins/progress_bar.rb
arachni-0.4	lib/arachni/mixins/progress_bar.rb