progress 2.0.0 → 2.1.0

data/README.markdown

@@ -1,42 +1,73 @@
 # progress
 
-http://github.com/toy/progress/tree/master
+Show progress during console script run.
 
-## DESCRIPTION:
+## Installation:
 
-Class to show progress during console script run
+    gem install progress
 
 ## SYNOPSIS:
 
-    1000.times_with_progress('Wait') do |time| # title is optional
-      puts time
+    1000.times_with_progress('Counting to 1000') do |i|
+      # do something with i
     end
 
-    [1, 2, 3].with_progress('Wait').each do |i|
-      puts i
+or without title:
+
+    1000.times_with_progress do |i|
+      # do something with i
     end
 
-    (1..100).with_progress('Wait').each do |i|
-      puts i
+With array:
+
+    [1, 2, 3].with_progress('1…2…3').each do |i|
+      # still counting
     end
 
-    {
-      :a => 'a',
-      :b => 'b',
-      :c => 'c',
-      :d => 'd',
-    }.with_progress('Wait').each do |k, v|
-      puts "#{k} => #{v}"
+`.each` is optional:
+
+    [1, 2, 3].with_progress('1…2…3') do |i|
+      # =||=
     end
 
+Nested progress
+
     (1..10).with_progress('Outer').map do |a|
       (1..10).with_progress('Middle').map do |b|
         (1..10).with_progress('Inner').map do |c|
-          [a, b, c]
+          # do something with a, b and c
         end
       end
     end
 
+You can also show note:
+
+    [1, 2, 3].with_progress do |i|
+      Progress.note = i
+      sleep 5
+    end
+
+You can use any enumerable method:
+
+    [1, 2, 3].with_progress.map{ |i| 'do stuff' }
+    [1, 2, 3].with_progress.each_cons(3){ |i| 'do stuff' }
+    [1, 2, 3].with_progress.each_slice(2){ |i| 'do stuff' }
+    # …
+
+Any enumerable will work:
+
+    (1..100).with_progress('Wait') do |i|
+      # ranges are good
+    end
+
+    Dir.new('.').with_progress do |path|
+      # check path
+    end
+
+NOTE: progress gets number of objects using `length`, `size`, `to_a.length` or just `inject` and if used on objects which needs rewind (like opened File), cycle itself will not work.
+
+Use simple blocks:
+
     symbols = []
     Progress.start('Input 100 symbols', 100) do
       while symbols.length < 100
@@ -57,7 +88,7 @@ or just
       end
     end
 
-Note - you will get WRONG progress if you use something like this:
+NOTE: you will get WRONG progress if you use something like this:
 
     10.times_with_progress('A') do |time|
       10.times_with_progress('B') do
@@ -98,22 +129,6 @@ Or if you know that B runs 10 times faster than C:
       end
     end
 
-You can also show note:
-
-    [1, 2, 3].with_progress('Wait').each do |i|
-      sleep 1
-      Progress.note = i
-    end
-
-
-## REQUIREMENTS:
-
-ruby )))
-
-## INSTALL:
-
-    sudo gem install progress
-
 ## Copyright
 
 Copyright (c) 2010-2011 Ivan Kuchin. See LICENSE.txt for details.

data/lib/progress/with_progress.rb

@@ -4,11 +4,14 @@ class Progress
   class WithProgress
     include Enumerable
 
-    def initialize(enumerable, title, &block)
-      @enumerable, @title = enumerable, title
+    # initialize with object responding to each, title and optional length
+    # if block is provided, it is passed to each
+    def initialize(enumerable, title, length = nil, &block)
+      @enumerable, @title, @length = enumerable, title, length
       each(&block) if block
     end
 
+    # each object with progress
     def each
       Progress.start(@title, length) do
         @enumerable.each do |object|
@@ -19,6 +22,7 @@ class Progress
       end
     end
 
+    # determine number of objects
     def length
       @length ||= if @enumerable.respond_to?(:length) && !@enumerable.is_a?(String)
         @enumerable.length
@@ -31,7 +35,9 @@ class Progress
       end
     end
 
+    # returns self but changes title
     def with_progress(title = nil)
+      @title = title
       self
     end
   end

data/progress.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'progress'
-  s.version     = '2.0.0'
+  s.version     = '2.1.0'
   s.summary     = %q{Show progress of long running tasks}
   s.homepage    = "http://github.com/toy/#{s.name}"
   s.authors     = ['Ivan Kuchin']

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: progress
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: 
   segments: 
   - 2
+  - 1
   - 0
-  - 0
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors: 
 - Ivan Kuchin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-28 00:00:00 Z
+date: 2011-11-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec