progress 0.1.0.3 → 0.1.1.0

data/README.rdoc

@@ -51,6 +51,49 @@ Class to show progress during console script run
     end
   end
 
+or just
+
+  Progress('Input 100 symbols', 100) do
+    while symbols.length < 100
+      input = gets.scan(/\S/)
+      symbols += input
+      Progress.step input.length
+    end
+  end
+
+Note - you will get WRONG progress if you use something like this:
+
+  10.times_with_progress('A') do |time|
+    10.times_with_progress('B'){ … }
+    10.times_with_progress('C'){ … }
+  end
+
+But you can use this:
+
+  10.times_with_progress('A') do |time|
+    Progress('B,C', 2) do
+      Progress.step do
+        10.times_with_progress('B'){ … }
+      end
+      Progress.step do
+        10.times_with_progress('C'){ … }
+      end
+    end
+  end
+
+Or if you know that B runs 10 times faster than C:
+
+  10.times_with_progress('A') do |time|
+    Progress('B,C', 11) do
+      Progress.step 1 do
+        10.times_with_progress('B'){ … }
+      end
+      Progress.step 10 do
+        10.times_with_progress('C'){ … }
+      end
+    end
+  end
+
 == REQUIREMENTS:
 
 * ruby )))

data/VERSION.yml

@@ -1 +1 @@
-[0, 1, 0, 3]
+[0, 1, 1, 0]

data/lib/progress.rb

@@ -8,6 +8,7 @@ class Progress
 
   module InstanceMethods # :nodoc:
     attr_accessor :title, :current, :total
+    attr_reader :current_step
     def initialize(title, total)
       total = Float(total)
       @title, @current, @total = title, 0.0, total == 0.0 ? 1.0 : total
@@ -18,7 +19,16 @@ class Progress
     end
 
     def to_f(inner)
-      (current + (inner < 1.0 ? inner : 1.0)) / total
+      inner = [inner, 1.0].min
+      inner *= current_step if current_step
+      (current + inner) / total
+    end
+
+    def step(steps)
+      @current_step = steps
+      yield
+    ensure
+      @current_step = nil
     end
   end
   include InstanceMethods
@@ -56,16 +66,25 @@ class Progress
       levels << new(title, total)
       print_message
       if block_given?
-        result = yield
-        stop
-        result
+        begin
+          yield
+        ensure
+          stop
+        end
       end
     end
 
     def step(steps = 1)
       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
       end
     end
 
@@ -137,3 +156,11 @@ require 'progress/with_progress'
 
 require 'progress/enumerable'
 require 'progress/integer'
+
+# like Pathname
+module Kernel
+  def Progress(title, total = 1, &block)
+    Progress.start(title, total, &block)
+  end
+  private :Progress
+end

data/progress.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{progress}
-  s.version = "0.1.0.3"
+  s.version = "0.1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["toy"]

data/spec/progress_spec.rb

@@ -140,31 +140,6 @@ describe Progress do
     end
   end
 
-  it "should allow enclosed progress" do
-    10.times_with_progress('A') do |a|
-      io_pop.should =~ /#{Regexp.quote(a == 0 ? '......' : (a * 10.0).to_s)}/
-      10.times_with_progress('B') do |b|
-        io_pop.should =~ /#{Regexp.quote(a == 0 && b == 0 ? '......' : (a * 10.0 + b).to_s)}.*#{Regexp.quote(b == 0 ? '......' : (b * 10.0).to_s)}/
-      end
-      io_pop.should =~ /#{Regexp.quote(((a + 1) * 10.0).to_s)}.*100\.0/
-    end
-    io_pop.should =~ /100\.0.*\n$/
-  end
-
-  it "should not overlap outer progress if inner exceeds" do
-    10.times_with_progress('A') do |a|
-      io_pop.should =~ /#{Regexp.quote(a == 0 ? '......' : (a * 10.0).to_s)}/
-      Progress.start('B', 10) do
-        20.times do |b|
-          io_pop.should =~ /#{Regexp.quote(a == 0 && b == 0 ? '......' : (a * 10.0 + [b, 10].min).to_s)}.*#{Regexp.quote(b == 0 ? '......' : (b * 10.0).to_s)}/
-          Progress.step
-        end
-      end
-      io_pop.should =~ /#{Regexp.quote(((a + 1) * 10.0).to_s)}.*200\.0/
-    end
-    io_pop.should =~ /100\.0.*\n$/
-  end
-
   it "should pipe result from block" do
     Progress.start('Test') do
       'qwerty'
@@ -192,4 +167,86 @@ describe Progress do
       end
     end.should == [[1, 2, 3], [2, 4, 6], [3, 6, 9]]
   end
+
+  it "should kill progress on cycle break" do
+    2.times do
+      catch(:lalala) do
+        2.times_with_progress('A') do |a|
+          io_pop.should == "A: ......\n"
+          2.times_with_progress('B') do |b|
+            io_pop.should == "A: ...... > B: ......\n"
+            throw(:lalala)
+          end
+        end
+      end
+      io_pop.should == "\n"
+    end
+  end
+
+  [[2, 2000], [20, 200], [200, 20], [2000, 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]
+        _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]
+        end
+        io_pop.should == "A: %5.1f%% > B: 100.0%%\n" % [(a + 1) / _a.to_f * 100.0]
+      end
+      io_pop.should == "A: 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]
+        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]
+            Progress.step
+          end
+        end
+        io_pop.should == "A: %5.1f%% > B: 200.0%%\n" % [(a + 1) / _a.to_f * 100.0]
+      end
+      io_pop.should == "A: 100.0%\n\n"
+    end
+
+    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"
+        _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]
+            end
+            io_pop.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]
+        end
+        Progress.step _a
+      end
+      io_pop.should == "A: 100.0%\n\n"
+    end
+  end
+
+  describe "using Progress instead of Progress.start" do
+    it "should show valid output for procedural version" do
+      Progress('Test', 1000)
+      1000.times do |i|
+        verify_output_before_step(i)
+        Progress.step
+      end
+      Progress.stop
+      verify_output_after_stop
+    end
+
+    it "should show valid output for block version" do
+      Progress('Test', 1000) do
+        1000.times do |i|
+          verify_output_before_step(i)
+          Progress.step
+        end
+      end
+      verify_output_after_stop
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: progress
 version: !ruby/object:Gem::Version 
-  version: 0.1.0.3
+  version: 0.1.1.0
 platform: ruby
 authors: 
 - toy