progress 0.0.9.3 → 0.1.0.0

data/README.rdoc

@@ -42,9 +42,18 @@ Class to show progress during console script run
     end
   end
 
+  symbols = []
+  Progress.start('Input 100 symbols', 100) do
+    while symbols.length < 100
+      input = gets.scan(/\S/)
+      symbols += input
+      Progress.step input.length
+    end
+  end
+
 == REQUIREMENTS:
 
-* ruby
+* ruby )))
 
 == INSTALL:
 
@@ -73,4 +82,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/VERSION.yml

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

data/lib/progress.rb

@@ -6,123 +6,112 @@ require 'singleton'
 class Progress
   include Singleton
 
-  # start progress indication
-  # ==== Procedural example
-  #   Progress.start('Test', 1000)
-  #   1000.times{ Progress.step }
-  #   Progress.stop
-  # ==== Block example
-  #   Progress.start('Test', 1000) do
-  #     1000.times{ Progress.step }
-  #   end
-  # ==== Step must not always be one
-  #   Progress.start('Test', 10) do
-  #     (1..10).to_a.each_slice do |slice|
-  #       Progress.step(slice.length)
-  #     end
-  #   end
-  # ==== Enclosed block example
-  #   [1, 2, 3].each_with_progress('1 2 3') do |one_of_1_2_3|
-  #     10.times_with_progress('10') do |one_of_10|
-  #       sleep(0.001)
-  #     end
-  #   end
-  # ==== To output progress as lines (not trying to stay on line)
-  #   Progress.lines = true
-  # ==== To force highlight
-  #   Progress.highlight = true
-  def self.start(title, total = 1, options = {})
-    levels << new(title, total, levels.length, options)
-    print_message
-    if block_given?
-      result = yield
-      stop
-      result
+  module InstanceMethods # :nodoc:
+    attr_accessor :title, :current, :total
+    def initialize(title, total)
+      @title, @current, @total = title, 0, total.to_f
     end
-  end
-
-  attr_reader :message, :options
-  def initialize(title, total, level, options) # :nodoc:
-    @title = title + ': %s'
-    @total = total
-    @level = level
-    @options = options
-    @current = 0
-    start
-  end
-
-  def start # :nodoc:
-    self.message = '.' * 6
-  end
-
-  def step(steps) # :nodoc:
-    @current += steps
-    self.message = percent
-  end
-
-  def stop # :nodoc:
-    self.message = percent
-  end
-
-protected
 
-  def percent
-    '%5.1f%%' % (@current * 100.0 / @total)
-  end
+    def step_if_blank
+      self.current = 1 if current == 0 && total == 1
+    end
 
-  def message=(s)
-    formatted = s.ljust(6)[0, 6]
-    @message = @title % formatted
+    def to_f(inner)
+      (current + [inner, 1].min) / total
+    end
   end
+  include InstanceMethods
+
+  class << self
+    # start progress indication
+    # ==== Procedural example
+    #   Progress.start('Test', 1000)
+    #   1000.times{ Progress.step }
+    #   Progress.stop
+    # ==== Block example
+    #   Progress.start('Test', 1000) do
+    #     1000.times{ Progress.step }
+    #   end
+    # ==== Step must not always be one
+    #   symbols = []
+    #   Progress.start('Input 100 symbols', 100) do
+    #     while symbols.length < 100
+    #       input = gets.scan(/\S/)
+    #       symbols += input
+    #       Progress.step input.length
+    #     end
+    #   end
+    # ==== Enclosed block example
+    #   [1, 2, 3].each_with_progress('1 2 3') do |one_of_1_2_3|
+    #     10.times_with_progress('10') do |one_of_10|
+    #       sleep(0.001)
+    #     end
+    #   end
+    # ==== To output progress as lines (not trying to stay on line)
+    #   Progress.lines = true
+    # ==== To force highlight
+    #   Progress.highlight = true
+    def start(title, total = 1)
+      levels << new(title, total)
+      print_message
+      if block_given?
+        result = yield
+        stop
+        result
+      end
+    end
 
-  module ClassMethods
     def step(steps = 1)
-      levels[-1].step(steps)
+      levels.last.current += steps
+      print_message
+    end
+
+    def set(value)
+      levels.last.current = value
       print_message
     end
 
     def stop
-      levels.pop.stop
-      @io.puts if levels.empty?
+      print_message if levels.last.step_if_blank
+      levels.pop
+      io.puts if levels.empty?
+    end
+
+    attr_writer :io, :lines, :highlight # :nodoc:
+
+  private
+
+    def levels
+      @levels ||= []
     end
 
     def io
       @io ||= $stderr
+      @io.sync = true
+      @io
     end
 
     def io_tty?
-      ENV['PROGRESS_TTY'] || io.tty?
+      io.tty? || ENV['PROGRESS_TTY']
     end
 
-    def io=(io)
-      @io = io
-    end
-
-    def lines=(value)
-      @lines = value
-    end
     def lines?
-      if @lines.nil?
-        @lines = !io_tty?
-      end
-      @lines
+      @lines.nil? ? !io_tty? : @lines
     end
 
-    def highlight=(value)
-      @highlight = value
-    end
     def highlight?
-      if @highlight.nil?
-        @highlight = io_tty?
-      end
-      @highlight
+      @highlight.nil? ? io_tty? : @highlight
     end
 
-  protected
-
     def print_message
-      message = levels.map{ |level| level.message } * ' > '
-      io.sync = true
+      messages = []
+      inner = 0
+      levels.reverse.each do |l|
+        current = l.to_f(inner)
+        messages << "#{l.title}: #{(current == 0 ? '......' : '%5.1f%%' % (current * 100.0))[0, 6]}"
+        inner = current
+      end
+      message = messages.reverse * ' > '
 
       unless lines?
         previous_length = @previous_length || 0
@@ -130,22 +119,11 @@ protected
         message = message.ljust(previous_length, ' ') + "\r"
       end
 
-      if highlight?
-        message.gsub!(/\d+\.\d+/){ |s| s == '100.0' ? s : "\e[1m#{s}\e[0m" }
-      end
-
-      unless lines?
-        io.print message
-      else
-        io.puts message
-      end
-    end
+      message.gsub!(/\d+\.\d+/){ |s| s == '100.0' ? s : "\e[1m#{s}\e[0m" } if highlight?
 
-    def levels
-      @levels ||= []
+      lines? ? io.puts(message) : io.print(message)
     end
   end
-  extend ClassMethods
 end
 
 require 'progress/with_progress'

data/lib/progress/integer.rb

@@ -4,8 +4,8 @@ class Integer
   #   100.times_with_progress('Numbers') do |number|
   #     sleep(number)
   #   end
-  def times_with_progress(name, options = {})
-    Progress.start(name, self, options) do
+  def times_with_progress(name)
+    Progress.start(name, self) do
       times do |i|
         yield i
         Progress.step

data/progress.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{progress}
-  s.version = "0.0.9.3"
+  s.version = "0.1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["toy"]
-  s.date = %q{2009-08-06}
+  s.date = %q{2009-08-19}
   s.description = %q{A library to show progress of long running tasks.}
   s.email = %q{}
   s.extra_rdoc_files = ["CHANGELOG", "lib/progress/enumerable.rb", "lib/progress/integer.rb", "lib/progress/with_progress.rb", "lib/progress.rb", "README.rdoc", "tasks/rspec.rake"]

data/spec/progress_spec.rb

@@ -1,5 +1,11 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
+Progress.start('Test') do
+  Progress.start('Test') do
+    'qwerty'
+  end
+end
+
 describe Progress do
   before :each do
     @io = StringIO.new
@@ -138,9 +144,23 @@ describe 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 ? '......' : (a * 10.0).to_s)}.*#{Regexp.quote(b == 0 ? '......' : (b * 10.0).to_s)}/
+        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 == 0 ? '......' : (a * 10.0).to_s)}.*100\.0/
+      io_pop.should =~ /#{Regexp.quote(((a + 1) * 10.0).to_s)}.*200\.0/
     end
     io_pop.should =~ /100\.0.*\n$/
   end
@@ -150,4 +170,12 @@ describe Progress do
       'qwerty'
     end.should == 'qwerty'
   end
+
+  it "should pipe result from nested block" do
+    [1, 2, 3].with_progress('a').map do |a|
+      [1, 2, 3].with_progress('b').map do |b|
+        a * b
+      end
+    end.should == [[1, 2, 3], [2, 4, 6], [3, 6, 9]]
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: progress
 version: !ruby/object:Gem::Version 
-  version: 0.0.9.3
+  version: 0.1.0.0
 platform: ruby
 authors: 
 - toy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-06 00:00:00 +04:00
+date: 2009-08-19 00:00:00 +04:00
 default_executable: 
 dependencies: []