progress 0.4.1 → 1.0.0

data/VERSION

@@ -1 +1 @@
-0.4.1
+1.0.0

data/lib/progress.rb

@@ -12,17 +12,22 @@ class Progress
       elsif total.nil?
         total = 1
       end
-      total = Float(total)
-      @title, @current, @total = title, 0.0, total == 0.0 ? 1.0 : total
+      @title = title
+      @current = 0.0
+      @total = total == 0.0 ? 1.0 : Float(total)
     end
 
     def step_if_blank
-      self.current = 1.0 if current == 0.0 && total == 1.0
+      if current == 0.0 && total == 1.0
+        self.current = 1.0
+      end
     end
 
     def to_f(inner)
       inner = [inner, 1.0].min
-      inner *= current_step if current_step
+      if current_step
+        inner *= current_step
+      end
       (current + inner) / total
     end
 
@@ -65,6 +70,10 @@ class Progress
     # ==== To force highlight
     #   Progress.highlight = true
     def start(title = nil, total = nil)
+      if levels.empty?
+        @started_at = Time.now
+        @eta = nil
+      end
       levels << new(title, total)
       print_message(true)
       if block_given?
@@ -76,32 +85,37 @@ class Progress
       end
     end
 
-    def step(steps = 1)
+    def step(steps = 1, &block)
       if levels.last
-        if block_given?
-          levels.last.step(steps) do
-            yield
-          end
-        end
-        levels.last.current += Float(steps)
-        print_message
-      elsif block_given?
-        yield
+        set(levels.last.current + Float(steps), &block)
+      elsif block
+        block.call
       end
     end
 
-    def set(value)
+    def set(value, &block)
       if levels.last
+        ret = if block
+          levels.last.step(value - levels.last.current, &block)
+        end
         levels.last.current = Float(value)
         print_message
+        ret
+      elsif block
+        block.call
       end
     end
 
     def stop
       if levels.last
-        print_message(true) if levels.last.step_if_blank || levels.length == 1
+        if levels.last.step_if_blank || levels.length == 1
+          print_message(true)
+          set_title(nil)
+        end
         levels.pop
-        io.puts if levels.empty?
+        if levels.empty?
+          io.puts
+        end
       end
     end
 
@@ -134,43 +148,72 @@ class Progress
     end
 
     def time_to_print?
-      if @previous
-        if @previous < Time.now - 0.3
-          @previous = Time.now
-          true
-        else
-          false
-        end
-      else
+      if !@previous || @previous < Time.now - 0.3
         @previous = Time.now
         true
       end
     end
 
+    def eta(completed)
+      now = Time.now
+      if now > @started_at && completed > 0
+        current_eta = @started_at + (now - @started_at) / completed
+        @eta = @eta ? @eta + (current_eta - @eta) * (1 + completed) * 0.5 : current_eta
+        seconds = @eta - now
+        if seconds > 0
+          left = case seconds
+          when 0...60
+            '%.0fs' % seconds
+          when 60...3600
+            '%.1fm' % (seconds / 60)
+          when 3600...86400
+            '%.1fh' % (seconds / 3600)
+          else
+            '%.1fd' % (seconds / 86400)
+          end
+          eta_string = " (ETA: #{left})"
+        end
+      end
+    end
+
+    def set_title(title)
+      if io_tty?
+        io.print("\e]0;#{title}\a")
+      end
+    end
+
     def print_message(force = false)
       if force || time_to_print?
-        messages = []
         inner = 0
+        parts = []
+        parts_cl = []
         levels.reverse.each do |l|
           current = l.to_f(inner)
           value = current == 0 ? '......' : "#{'%5.1f' % (current * 100.0)}%"
-          messages << "#{"#{l.title}: " if l.title}#{!highlight? || value == '100.0%' ? value : "\e[1m#{value}\e[0m"}"
           inner = current
+
+          title = l.title ? "#{l.title}: " : ''
+          highlighted = "\e[1m#{value}\e[0m"
+          if !highlight? || value == '100.0%'
+            parts << "#{title}#{value}"
+          else
+            parts << "#{title}#{highlighted}"
+          end
+          parts_cl << "#{title}#{value}"
         end
-        message = messages.reverse * ' > '
+
+        eta_string = eta(inner)
+        message = "#{parts.reverse * ' > '}#{eta_string}"
+        message_cl = "#{parts_cl.reverse * ' > '}#{eta_string}"
 
         unless lines?
           previous_length = @previous_length || 0
-          message_cl = if highlight?
-            message.gsub(/\033\[(0|1)m/, '')
-          else
-            message
-          end
           @previous_length = message_cl.length
           message = "#{message}#{' ' * [previous_length - message_cl.length, 0].max}\r"
         end
 
         lines? ? io.puts(message) : io.print(message)
+        set_title(message_cl)
       end
     end
   end

data/progress.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{progress}
-  s.version = "0.4.1"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Boba Fat"]
-  s.date = %q{2010-11-13}
+  s.date = %q{2010-11-14}
   s.extra_rdoc_files = [
     "README.rdoc"
   ]

data/spec/progress_spec.rb

@@ -15,6 +15,10 @@ describe Progress do
     s
   end
 
+  def io_pop_no_eta
+    io_pop.sub(/ \(ETA: \d+.\)$/, '')
+  end
+
   def verify_output_before_step(i)
     io_pop.should =~ /#{Regexp.quote(i == 0 ? '......' : (i / 10.0).to_s)}/
   end
@@ -109,6 +113,18 @@ describe Progress do
       end.should == 'qwerty'
     end
 
+    it "should return result from step" do
+      Progress.start do
+        Progress.step{ 'qwerty' }.should == 'qwerty'
+      end
+    end
+
+    it "should return result from set" do
+      Progress.start do
+        Progress.set(1){ 'qwerty' }.should == 'qwerty'
+      end
+    end
+
     it "should return result from nested block" do
       [1, 2, 3].with_progress('a').map do |a|
         [1, 2, 3].with_progress('b').map do |b|
@@ -132,28 +148,28 @@ describe Progress do
       end
     end
 
-    [[2, 2000], [20, 200], [200, 20], [2000, 2]].each do |_a, _b|
+    [[2, 200], [20, 20], [200, 2]].each do |_a, _b|
       it "should allow enclosed progress [#{_a}, #{_b}]" do
         _a.times_with_progress('A') do |a|
-          io_pop.should == "A: #{a == 0 ? '......' : '%5.1f%%'}\n" % [a / _a.to_f * 100.0]
+          io_pop_no_eta.should == "A: #{a == 0 ? '......' : '%5.1f%%'}\n" % [a / _a.to_f * 100.0]
           _b.times_with_progress('B') do |b|
-            io_pop.should == "A: #{a == 0 && b == 0 ? '......' : '%5.1f%%'} > B: #{b == 0 ? '......' : '%5.1f%%'}\n" % [(a + b / _b.to_f) / _a.to_f * 100.0, b / _b.to_f * 100.0]
+            io_pop_no_eta.should == "A: #{a == 0 && b == 0 ? '......' : '%5.1f%%'} > B: #{b == 0 ? '......' : '%5.1f%%'}\n" % [(a + b / _b.to_f) / _a.to_f * 100.0, b / _b.to_f * 100.0]
           end
-          io_pop.should == "A: %5.1f%% > B: 100.0%%\n" % [(a + 1) / _a.to_f * 100.0]
+          io_pop_no_eta.should == "A: %5.1f%% > B: 100.0%%\n" % [(a + 1) / _a.to_f * 100.0]
         end
         io_pop.should == "A: 100.0%\nA: 100.0%\n\n"
       end
 
       it "should not overlap outer progress if inner exceeds [#{_a}, #{_b}]" do
         _a.times_with_progress('A') do |a|
-          io_pop.should == "A: #{a == 0 ? '......' : '%5.1f%%'}\n" % [a / _a.to_f * 100.0]
+          io_pop_no_eta.should == "A: #{a == 0 ? '......' : '%5.1f%%'}\n" % [a / _a.to_f * 100.0]
           Progress.start('B', _b) do
             (_b * 2).times do |b|
-              io_pop.should == "A: #{a == 0 && b == 0 ? '......' : '%5.1f%%'} > B: #{b == 0 ? '......' : '%5.1f%%'}\n" % [(a + [b / _b.to_f, 1].min) / _a.to_f * 100.0, b / _b.to_f * 100.0]
+              io_pop_no_eta.should == "A: #{a == 0 && b == 0 ? '......' : '%5.1f%%'} > B: #{b == 0 ? '......' : '%5.1f%%'}\n" % [(a + [b / _b.to_f, 1].min) / _a.to_f * 100.0, b / _b.to_f * 100.0]
               Progress.step
             end
           end
-          io_pop.should == "A: %5.1f%% > B: 200.0%%\n" % [(a + 1) / _a.to_f * 100.0]
+          io_pop_no_eta.should == "A: %5.1f%% > B: 200.0%%\n" % [(a + 1) / _a.to_f * 100.0]
         end
         io_pop.should == "A: 100.0%\nA: 100.0%\n\n"
       end
@@ -161,15 +177,15 @@ describe Progress do
       it "should allow step with block to validly count custom progresses [#{_a}, #{_b}]" do
         a_step = 99
         Progress.start('A', _a * 100) do
-          io_pop.should == "A: ......\n"
+          io_pop_no_eta.should == "A: ......\n"
           _a.times do |a|
             Progress.step(a_step) do
               _b.times_with_progress('B') do |b|
-                io_pop.should == "A: #{a == 0 && b == 0 ? '......' : '%5.1f%%'} > B: #{b == 0 ? '......' : '%5.1f%%'}\n" % [(a * a_step + b / _b.to_f * a_step) / (_a * 100).to_f * 100.0, b / _b.to_f * 100.0]
+                io_pop_no_eta.should == "A: #{a == 0 && b == 0 ? '......' : '%5.1f%%'} > B: #{b == 0 ? '......' : '%5.1f%%'}\n" % [(a * a_step + b / _b.to_f * a_step) / (_a * 100).to_f * 100.0, b / _b.to_f * 100.0]
               end
-              io_pop.should == "A: %5.1f%% > B: 100.0%\n" % [(a + 1) * a_step.to_f / (100.0 * _a.to_f) * 100.0]
+              io_pop_no_eta.should == "A: %5.1f%% > B: 100.0%\n" % [(a + 1) * a_step.to_f / (100.0 * _a.to_f) * 100.0]
             end
-            io_pop.should == "A: %5.1f%%\n" % [(a + 1) * a_step.to_f / (100.0 * _a.to_f) * 100.0]
+            io_pop_no_eta.should == "A: %5.1f%%\n" % [(a + 1) * a_step.to_f / (100.0 * _a.to_f) * 100.0]
           end
           Progress.step _a
         end
@@ -178,12 +194,6 @@ describe Progress do
     end
   end
 
-
-
-
-
-
-
   describe Enumerable do
     before :each do
       @a = (0...1000).to_a

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: progress
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 23
   prerelease: false
   segments: 
-  - 0
-  - 4
   - 1
-  version: 0.4.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Boba Fat
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-13 00:00:00 +03:00
+date: 2010-11-14 00:00:00 +03:00
 default_executable: 
 dependencies: []