class Console::Progress

A simple progress indicator

Attributes

current [R]

@attribute [Numeric] The current number of steps completed.

minimum_output_duration [R]

@attribute [Numeric] The minimum duration between outputs.

start_time [R]

@attribute [Time] The time the progress indicator was started.

subject [R]

@attribute [Object] The subject of the progress indicator.

total [R]

@attribute [Numeric] The total number of steps.

Public Class Methods

new (subject, total = 0, minimum_output_duration: 0.1, **options)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/progress.rb, line 23
def initialize(subject, total = 0, minimum_output_duration: 0.1, **options)
        @subject = subject
        @options = options
        
        @start_time = Clock.now
        
        @last_output_time = nil
        @minimum_output_duration = minimum_output_duration
        
        @current = 0
        @total = total
end

Create a new progress indicator.

@parameter subject [Object] The subject of the progress indicator. @parameter total [Integer] The total number of steps. @parameter minimum_output_duration [Numeric] The minimum duration between outputs. @parameter options [Hash] Additional options to customize the output.

now ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/progress.rb, line 13
def self.now
        Clock.now
end

@deprecated Use {Clock.now} instead.

Public Instance Methods

average_duration ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/progress.rb, line 67
def average_duration
        if @current > 0
                duration / @current
        end
end

@returns [Numeric | Nil] The average duration per step, or ‘nil` if no steps have been completed.

duration ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/progress.rb, line 52
def duration
        Clock.now - @start_time
end

@returns [Numeric] The duration since the progress indicator was started.

estimated_remaining_time ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/progress.rb, line 74
def estimated_remaining_time
        if average_duration = self.average_duration
                average_duration * remaining
        end
end

@returns [Numeric | Nil] The estimated remaining time, or ‘nil` if no steps have been completed.

increment (amount = 1)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/progress.rb, line 98
def increment(amount = 1)
        @current += amount
        
        if output?
                Console.call(@subject, self.to_s, event: self.to_hash, **@options)
                @last_output_time = Clock.now
        end
        
        return self
end

Increment the progress indicator by the given amount.

@parameter amount [Numeric] The amount to increment by. @returns [Progress] The progress indicator itself.

mark (*arguments, **options, &block)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/progress.rb, line 127
def mark(*arguments, **options, &block)
        Console.call(@subject, *arguments, **options, **@options, &block)
end

Augment the progress indicator with additional information.

@parameter *arguments [Array] The arguments to log. @parameter **options [Hash] Additional options to log. @parameter &block [Proc] An optional block used to generate the log message.

ratio ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/progress.rb, line 57
def ratio
        Rational(@current.to_f, @total.to_f)
end

@returns [Rational] The ratio of steps completed to total steps.

remaining ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/progress.rb, line 62
def remaining
        @total - @current
end

@returns [Numeric] The number of steps remaining.

resize (total)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/progress.rb, line 113
def resize(total)
        @total = total
        
        Console.call(@subject, self.to_s, event: self.to_hash, **@options)
        @last_output_time = Clock.now
        
        return self
end

Resize the progress indicator to the given total.

@parameter total [Numeric] The new total number of steps. @returns [Progress] The progress indicator itself.

to_hash ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/progress.rb, line 83
def to_hash
        Hash.new.tap do |hash|
                hash[:type] = :progress
                hash[:current] = @current
                hash[:total] = @total
                
                hash[:duration] = self.duration
                hash[:estimated_remaining_time] = self.estimated_remaining_time
        end
end

Generate an appropriate event for the progress indicator.

@returns [Hash] The progress indicator as a hash.

to_s ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/progress.rb, line 132
def to_s
        if estimated_remaining_time = self.estimated_remaining_time
                "#{@current}/#{@total} completed in #{Clock.formatted_duration(self.duration)}, #{Clock.formatted_duration(estimated_remaining_time)} remaining."
        else
                "#{@current}/#{@total} completed, waiting for estimate..."
        end
end

@returns [String] A human-readable representation of the progress indicator.