ruby-progressbar 1.6.1 → 1.7.0

data/lib/ruby-progressbar/components/elapsed_timer.rb

@@ -1,25 +0,0 @@
-class ProgressBar
-  module Components
-    class ElapsedTimer
-      include Timer
-
-      def initialize
-        @started_at = nil
-        @stopped_at = nil
-      end
-
-      def to_s
-        "Time: #{elapsed_time}"
-      end
-
-    private
-      def elapsed_time
-        return '--:--:--' unless started?
-
-        hours, minutes, seconds = divide_seconds(elapsed_whole_seconds)
-
-        sprintf TIME_FORMAT, hours, minutes, seconds
-      end
-    end
-  end
-end

data/lib/ruby-progressbar/components/estimated_timer.rb

@@ -1,90 +0,0 @@
-class ProgressBar
-  module Components
-    class EstimatedTimer
-      include Timer
-      include Progressable
-
-      VALID_OOB_TIME_FORMATS = [:unknown, :friendly, nil]
-
-      def initialize(options = {})
-        @out_of_bounds_time_format = nil
-        @starting_at               = nil
-        @stopped_at                = nil
-
-        super
-      end
-
-      def start(options = {})
-        as(Timer).start
-        as(Progressable).start(options)
-      end
-
-      def reset
-        as(Timer).reset
-        as(Progressable).reset
-      end
-
-      def out_of_bounds_time_format=(format)
-        raise "Invalid Out Of Bounds time format.  Valid formats are #{VALID_OOB_TIME_FORMATS.inspect}" unless VALID_OOB_TIME_FORMATS.include? format
-
-        @out_of_bounds_time_format = format
-      end
-
-      def to_s
-        " ETA: #{estimated_time}"
-      end
-
-    private
-      def estimated_time
-        return '??:??:??' if running_average.zero? || total.nil?
-
-        hours, minutes, seconds = *divide_seconds(estimated_seconds_remaining)
-
-        if hours > 99 && @out_of_bounds_time_format
-          out_of_bounds_time
-        else
-          sprintf TIME_FORMAT, hours, minutes, seconds
-        end
-      end
-
-      def estimated_seconds_remaining
-        (elapsed_seconds * (self.total / self.running_average  - 1)).round
-      end
-
-      def out_of_bounds_time
-        case @out_of_bounds_time_format
-        when :unknown
-          '??:??:??'
-        when :friendly
-          '> 4 Days'
-        end
-      end
-
-      def as(ancestor, &blk)
-        @__as ||= {}
-        unless r = @__as[ancestor]
-          r = (@__as[ancestor] = As.new(self, ancestor))
-        end
-        r.instance_eval(&blk) if block_given?
-        r
-      end
-
-      class As
-        private(*instance_methods.select { |m| m !~ /(^__|^\W|^binding$)/ })
-
-        def initialize(subject, ancestor)
-          @subject = subject
-          @ancestor = ancestor
-        end
-
-        def start(*args, &blk)
-          @ancestor.instance_method(:start).bind(@subject).call(*args,&blk)
-        end
-
-        def method_missing(sym, *args, &blk)
-          @ancestor.instance_method(sym).bind(@subject).call(*args,&blk)
-        end
-      end
-    end
-  end
-end

data/lib/ruby-progressbar/components/progressable.rb

@@ -1,112 +0,0 @@
-require 'ruby-progressbar/errors/invalid_progress_error'
-
-class ProgressBar
-  module Components
-    module Progressable
-      DEFAULT_TOTAL              = 100
-      DEFAULT_BEGINNING_POSITION = 0
-      DEFAULT_SMOOTHING          = 0.1
-
-      attr_reader               :total
-      attr_reader               :progress
-      attr_accessor             :starting_position
-      attr_accessor             :running_average
-      attr_accessor             :smoothing
-      attr_accessor             :autofinish
-      attr_accessor             :finished
-
-      def initialize(options = {})
-        self.total           = options.fetch(:total, DEFAULT_TOTAL)
-        self.smoothing       = options[:smoothing] || DEFAULT_SMOOTHING
-        self.autofinish      = options.fetch(:autofinish, true)
-
-        start :at => DEFAULT_BEGINNING_POSITION
-      end
-
-      def start(options = {})
-        self.finished          = false
-        self.running_average   = 0
-        self.progress          = \
-        self.starting_position = options[:at] || self.progress
-      end
-
-      def started?
-        !!self.starting_position
-      end
-
-      def finished?
-        finished || (autofinish && progress == total)
-      end
-
-      def increment
-        warn "WARNING: Your progress bar is currently at #{progress} out of #{total} and cannot be incremented. In v2.0.0 this will become a ProgressBar::InvalidProgressError." if progress == total
-
-        self.progress += 1 unless progress == total
-      end
-
-      def decrement
-        warn "WARNING: Your progress bar is currently at #{progress} out of #{total} and cannot be decremented. In v2.0.0 this will become a ProgressBar::InvalidProgressError." if progress == 0
-
-        self.progress -= 1 unless progress == 0
-      end
-
-      def reset
-        start :at => self.starting_position
-      end
-
-      def progress=(new_progress)
-        validate_progress(new_progress)
-
-        @progress = new_progress
-
-        update_running_average
-      end
-
-      def total=(new_total)
-        validate_total(new_total)
-        @total = new_total
-      end
-
-      def finish
-        self.finished = true
-        self.progress = total
-      end
-
-      def percentage_completed
-        return 100 if total == 0
-        return 0   if total.nil?
-
-        # progress / total * 100
-        #
-        # Doing this way so we can avoid converting each
-        # number to a float and then back to an integer.
-        #
-        (self.progress * 100 / total).to_i
-      end
-
-      def percentage_completed_with_precision
-        return 100.0  if total == 0
-        return 0.0    if total.nil?
-
-        format('%5.2f', (progress.to_f * 100.0 / total * 100.0).floor / 100.0)
-      end
-
-      def progress_made
-        started? ? self.progress - self.starting_position : 0
-      end
-
-    private
-      def validate_total(new_total)
-        (progress.nil? || new_total.nil? || new_total >= progress) || raise(ProgressBar::InvalidProgressError, "You can't set the item's total value to be less than the current progress.")
-      end
-
-      def validate_progress(new_progress)
-        (total.nil? || new_progress <= total) || raise(ProgressBar::InvalidProgressError, "You can't set the item's current value to be greater than the total.")
-      end
-
-      def update_running_average
-        self.running_average = RunningAverageCalculator.calculate(self.running_average, self.progress_made, self.smoothing)
-      end
-    end
-  end
-end

data/lib/ruby-progressbar/components/throttle.rb

@@ -1,21 +0,0 @@
-class ProgressBar
-  module Components
-    class Throttle
-      include Timer
-
-      def initialize(options = {})
-        @period     = options.delete(:throttle_rate) { 0.01 } || 0.01
-        @started_at = nil
-        @stopped_at = nil
-      end
-
-      def choke(force = false, &block)
-        if !started? || @period.nil? || force || elapsed_seconds >= @period
-          yield
-
-          start
-        end
-      end
-    end
-  end
-end

data/lib/ruby-progressbar/components/timer.rb

@@ -1,69 +0,0 @@
-require 'ruby-progressbar/time'
-
-class ProgressBar
-  module Components
-    module Timer
-      TIME_FORMAT = '%02d:%02d:%02d'
-
-      def start
-        @started_at = stopped? ? now - (@stopped_at - @started_at) : now
-        @stopped_at = nil
-      end
-
-      def stop
-        return unless started?
-
-        @stopped_at = now
-      end
-
-      def pause
-        stop
-      end
-
-      def resume
-        start
-      end
-
-      def started?
-        !!@started_at
-      end
-
-      def stopped?
-        !!@stopped_at
-      end
-
-      def reset
-        @started_at = nil
-        @stopped_at = nil
-      end
-
-    private
-      def now
-        ProgressBar::Time.now
-      end
-
-      def elapsed_seconds
-        ((@stopped_at || now) - @started_at)
-      end
-
-      def elapsed_whole_seconds
-        elapsed_seconds.floor
-      end
-
-      def elapsed_time
-        return '--:--:--' unless started?
-
-        hours, minutes, seconds = *divide_seconds(elapsed_whole_seconds)
-
-        sprintf TIME_FORMAT, hours, minutes, seconds
-      end
-
-      def divide_seconds(seconds)
-        hours, seconds = seconds.divmod(3600)
-        minutes, seconds = seconds.divmod(60)
-
-        [hours, minutes, seconds]
-      end
-    end
-  end
-end

data/lib/ruby-progressbar/format/base.rb

@@ -1,55 +0,0 @@
-class ProgressBar
-  module Format
-    class Base
-      attr_reader :molecules
-
-      def initialize(format_string)
-        @format_string = format_string
-        @molecules     = parse(format_string)
-      end
-
-      def process(environment)
-        processed_string = @format_string.dup
-        ansi_sgr_codes   = %r{\e\[[\d;]+m}
-
-        non_bar_molecules.each do |molecule|
-          processed_string.gsub!("%#{molecule.key}", environment.send(molecule.method_name).to_s)
-        end
-
-        remaining_molecules = bar_molecules.size
-        placeholder_length  = remaining_molecules * 2
-
-        processed_string.gsub! '%%', '%'
-
-        processed_string_length = processed_string.gsub(ansi_sgr_codes, '').length
-        leftover_bar_length     = environment.send(:length) - processed_string_length + placeholder_length
-        leftover_bar_length     = leftover_bar_length < 0 ? 0 : leftover_bar_length
-
-        bar_molecules.each do |molecule|
-          processed_string.gsub!("%#{molecule.key}", environment.send(molecule.method_name, leftover_bar_length).to_s)
-        end
-
-        processed_string
-      end
-
-    private
-      def non_bar_molecules
-        @non_bar_molecules ||= molecules.select { |molecule| !molecule.bar_molecule? }
-      end
-
-      def bar_molecules
-        @bar_molecules     ||= molecules.select { |molecule| molecule.bar_molecule? }
-      end
-
-      def parse(format_string)
-        molecules        = []
-
-        format_string.scan(/%[a-zA-Z]/) do |match|
-          molecules << Molecule.new(match[1,1])
-        end
-
-        molecules
-      end
-    end
-  end
-end

data/lib/ruby-progressbar/formatter.rb

@@ -1,112 +0,0 @@
-class ProgressBar
-  module Formatter
-    DEFAULT_FORMAT_STRING         = '%t: |%B|'
-    DEFAULT_NON_TTY_FORMAT_STRING = '%t: |%b|'
-    DEFAULT_TITLE                 = 'Progress'
-
-    def initialize(options)
-      @format_string     = nil
-      self.format_string = options[:format] || DEFAULT_FORMAT_STRING
-      @title             = options[:title]  || DEFAULT_TITLE
-
-      super(options)
-    end
-
-    def format(new_format_string = DEFAULT_FORMAT_STRING)
-      self.format_string = new_format_string
-      @format.process(self)
-    end
-
-    def title=(title)
-      @title = title
-    end
-
-    def progress
-      @bar.progress
-    end
-
-    def total
-      @bar.total
-    end
-
-  private
-    def format_string=(format_string)
-      if @format_string != format_string
-        @format_string = format_string
-        @format        = ProgressBar::Format::Base.new(format_string)
-      end
-    end
-
-    # Format Methods
-    def title
-      @title
-    end
-
-    def percentage
-      @bar.percentage_completed
-    end
-
-    def justified_percentage
-      @bar.percentage_completed.to_s.rjust(3)
-    end
-
-    def percentage_with_precision
-      @bar.percentage_completed_with_precision
-    end
-
-    def justified_percentage_with_precision
-      @bar.percentage_completed_with_precision.to_s.rjust(6)
-    end
-
-    def elapsed_time
-      @elapsed_time
-    end
-
-    def estimated_time_with_no_oob
-      @estimated_time.out_of_bounds_time_format = nil
-      estimated_time
-    end
-
-    def estimated_time_with_unknown_oob
-      @estimated_time.out_of_bounds_time_format = :unknown
-      estimated_time
-    end
-
-    def estimated_time_with_friendly_oob
-      @estimated_time.out_of_bounds_time_format = :friendly
-      estimated_time
-    end
-
-    def bar(length)
-      @bar.length = length
-      @bar.standard_complete_string
-    end
-
-    def complete_bar(length)
-      @bar.length = length
-      @bar.to_s
-    end
-
-    def incomplete_space(length)
-      @bar.length = length
-      @bar.empty_string
-    end
-
-    def bar_with_percentage(length)
-      @bar.length = length
-      @bar.integrated_percentage_complete_string
-    end
-
-    def estimated_time
-      finished? ? @elapsed_time : @estimated_time
-    end
-
-    def rate_of_change
-      @rate.to_s
-    end
-
-    def rate_of_change_with_precision
-      @rate.to_s("%.2f")
-    end
-  end
-end