# This code is free software; you can redistribute it and/or modify it under the
# terms of the new BSD License.
#
# Copyright (c) 2009, Sebastian Staudt

module Rubikon

  # A class for displaying and managing progress bars
  class ProgressBar

    # Create a new ProgressBar using the given options.
    #
    # +ostream+:: The output stream where the progress bar should be displayed
    # +options+:: An Hash of options to customize the progress bar
    #
    # Options:
    #
    # +char+::    The character used for progress bar display (default: +#+)
    # +maximum+:: The maximum value of this progress bar (default: +100+)
    # +size+::    The actual size of the progress bar (default: +20+)
    # +start+::   The start value of the progress bar (default: +0+)
    def initialize(options = {})
      if options.is_a? Numeric
        @maximum = options
        options = {}
      else
        @maximum = options[:maximum] || 100
      end
      @maximum.round

      @progress_char = options[:char] || '#'
      @factor   = (options[:size] || 20).round.to_f / @maximum
      @ostream  = options[:ostream] || $stdout
      @progress = 0
      @value    = 0

      self + (options[:start] || 0)
    end

    # Add an amount to the current value of the progress bar
    #
    # This triggers a refresh of the progress bar, if the added value actually
    # changes the displayed bar.
    #
    # Example:
    #
    #  progress_bar + 1 # (will add 1)
    #  progress_bar + 5 # (will add 5)
    #  progress_bar.+   # (will add 1)
    def +(value = 1)
      return if value <= 0
      value = value.round
      old_progress = @progress
      @value += value
      add_progress = (value * @factor).round
      @progress += add_progress

      @progress = 100 if @progress > 100

      difference = @progress - old_progress
      if difference > 0 && @progress <= @maximum
        @ostream << @progress_char * difference
        @ostream.flush
      end
    end

  end

end