batch 0.0.3 → 1.0.0

data/README.markdown

@@ -7,7 +7,7 @@ Description
 -----------
 
 Say you have a thousand images to process. You write a script, fire it and go
-to bed, only to realize the morning after that and exception was raised and the
+to bed, only to realize the morning after that an exception was raised and the
 script was aborted. Well, no more frustration: now you can use Batch to make
 sure your script continues working despite those exceptions, and you can now
 get a nice report to read while you drink your morning coffee.

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS 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.
+
+For more information, please refer to <http://unlicense.org/>

data/batch.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name              = "batch"
-  s.version           = "0.0.3"
+  s.version           = "1.0.0"
   s.summary           = "Iterate Enumerables with progress reporting."
   s.authors           = ["Damian Janowski", "Michel Martens"]
   s.email             = ["djanowski@dimaion.com", "michel@soveran.com"]
   s.homepage          = "http://github.com/djanowski/batch"
-  s.files = ["LICENSE", "README.markdown", "Rakefile", "lib/batch.rb", "batch.gemspec", "test/batch_test.rb", "test/test_helper.rb"]
+  s.files = ["UNLICENSE", "README.markdown", "Rakefile", "lib/batch.rb", "batch.gemspec", "test/batch_test.rb", "test/test_helper.rb"]
 end

data/lib/batch.rb

@@ -6,21 +6,22 @@ class Batch
   def initialize(enumerable)
     @enumerable = enumerable
     @width = (ENV["BATCH_WIDTH"] || 75).to_i
+    @size = enumerable.size if enumerable.respond_to?(:size)
   end
 
   def each(&block)
     @errors = []
     @current = 0
 
-    print "  0% "
+    report_progress
 
     enumerable.each do |item|
       begin
         yield(item)
         print "."
 
-      rescue Interrupt
-        break
+      rescue Interrupt => e
+        raise e
 
       rescue Exception => e
         print "E"
@@ -29,11 +30,15 @@ class Batch
       ensure
         @current += 1
 
-        report_progress if eol?
+        if eol?
+          print "\n"
+          report_progress
+        end
       end
     end
 
     print "\n"
+    puts "100% " unless eol?
 
     report_errors
 
@@ -55,22 +60,35 @@ class Batch
   end
 
   def total
-    @enumerable.size
+    @size
   end
 
   def progress
-    @current * 100 / total
+    return unless @size
+
+    @current * 100 / @size
   end
 
   def report_progress
-    print "\n#{progress.to_s.rjust 3, " "}% "
+    if progress
+      print "#{progress.to_s.rjust 3, " "}% "
+    else
+      print "   ? "
+    end
   end
 
   def eol?
-    @current % @width == 0 || @current == total
+    @current % @width == 0
   end
 
   def self.each(enumerable, &block)
     new(enumerable).each(&block)
   end
+
+  def self.start(title, enumerable, &block)
+    puts
+    puts(title)
+    puts
+    each(enumerable, &block)
+  end
 end

data/test/batch_test.rb

@@ -3,6 +3,10 @@
 require File.expand_path("./test_helper", File.dirname(__FILE__))
 
 class BatchTest < Test::Unit::TestCase
+  setup do
+    ENV["BATCH_WIDTH"] = nil
+  end
+
   should "report" do
     stdout, _ = capture do
       Batch.each((1..80).to_a) do |item|
@@ -45,6 +49,7 @@ EOS
 
   should "use BATCH_WIDTH" do
     ENV["BATCH_WIDTH"] = "40"
+
     stdout, _ = capture do
       Batch.each((1..80).to_a) do |item|
         item + 1
@@ -55,6 +60,37 @@ EOS
   0% ........................................
  50% ........................................
 100%
+EOS
+
+    assert_equal expected.rstrip, stdout.rstrip
+  end
+
+  should "print a title" do
+    stdout, _ = capture do
+      Batch.start("Printing numbers", [1]) do |item|
+      end
+    end
+
+    expected = <<-EOS
+
+Printing numbers
+
+  0% .
+100%
+EOS
+
+    assert_equal expected.rstrip, stdout.rstrip
+  end
+
+  should "work with unknown sizes" do
+    stdout, _ = capture do
+      Batch.each(1..80) { }
+    end
+
+    expected = <<-EOS
+   ? ...........................................................................
+   ? .....
+100%
 EOS
 
     assert_equal expected.rstrip, stdout.rstrip

metadata

@@ -1,73 +1,54 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: batch
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Damian Janowski
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-09-20 00:00:00 -03:00
-default_executable: 
+date: 2012-12-07 00:00:00.000000000 Z
 dependencies: []
-
 description: 
-email: 
+email:
 - djanowski@dimaion.com
 - michel@soveran.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- LICENSE
+files:
+- UNLICENSE
 - README.markdown
 - Rakefile
 - lib/batch.rb
 - batch.gemspec
 - test/batch_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/djanowski/batch
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Iterate Enumerables with progress reporting.
 test_files: []
-

data/LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) 2010 Michel Martens & Damian Janowski
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.