batch 1.0.2 → 1.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Yzk2NTUwZGY3OGIwZGY0MmM4MmMzZWIwMmMwYjI3YzU3YjA1MzhkYQ==
+  data.tar.gz: !binary |-
+    NmE4NGM0Y2ZkMzNhNDM5N2RjOTI1NWNlZDhmNzY1NDdhMmUwOWQ0NQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODYwOWUyNTA0OGU0Zjc0MGZhMjFkNTI5ZDU1YzUyYjVlNmQ3MjFiMDlhY2Ew
+    ZjFhNDEzMzkxNmRkMWYyOWQwMjRkNWYxYTg5NWE5OGMyYjZmMDJjNzRmZDdj
+    OTI0YjFmZDlmNTA2MTk3OTI0MGRmMjc3YWZkODEyNTU4YWI4ZGQ=
+  data.tar.gz: !binary |-
+    YzVhYjdmN2Q4MTQ5ZDlmN2ZkODQ2NTQzNDkzNDlhZjM5ZDk5M2UzMDFmMzVm
+    YmE4N2I0YWQyYmM2Y2NjYzQwOTBiMjAyNDRmMTBjZDk3MDVjNjAwMWQ2MTMy
+    NjY5MTRlZWM0N2E0N2FiOTg4MWQ4MWU5ZTgwYWEzYmRjMjM4ZDc=

data/README.markdown

@@ -47,6 +47,30 @@ don't get interrupted right after you go to bed:
 You can determine the line width by setting the environment variable
 `BATCH_WIDTH`, which defaults to 75.
 
+Disabling output
+----------------
+
+On some environments, like a non-interactive shell, you probably want Batch
+to still run your stuff and skip errors, but you don't want all the progress
+output. For this purpose you can tweak `BATCH_INTERACTIVE`:
+
+    $ BATCH_INTERACTIVE=0 rake foo
+
+It's probably useful to have `BATCH_INTERACTIVE` set to `0` on your crontabs.
+
+Debugging
+---------
+
+If you want Batch to halt as soon as there's an exception (just like a regular
+`each` loop would do), simply set `$DEBUG` to true. If you're running Ruby
+explicitly, then:
+
+    $ ruby -d <your-batch-script>
+
+If you're running another tool which uses Batch, then set `RUBYOPT`:
+
+    $ RUBYOPT=-d rake foo
+
 Installation
 ------------
 

data/examples/errors.rb

@@ -0,0 +1,9 @@
+require_relative "../lib/batch"
+
+payload = 500.times.to_a
+
+Batch.start("Processing items", payload) do |item|
+  1 / (item % 100)
+
+  sleep(0.01)
+end

data/examples/slow.rb

@@ -0,0 +1,7 @@
+require_relative "../lib/batch"
+
+payload = 500.times.to_a
+
+Batch.start("Big data", payload) do |item|
+  sleep(item / 100.0)
+end

data/examples/start.rb

@@ -0,0 +1,6 @@
+require_relative "../lib/batch"
+
+payload = 500.times.to_a
+
+Batch.start("Working", payload) do |item|
+end

data/lib/batch.rb

@@ -1,5 +1,5 @@
 class Batch
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 
   attr :enumerable
 
@@ -13,35 +13,40 @@ class Batch
     @errors = []
     @current = 0
 
-    report_progress
+    Batch.out do |io|
+      enumerable.each.with_index do |item, index|
+        report_progress(io) if index == 0
 
-    enumerable.each do |item|
-      begin
-        yield(item)
-        print "."
+        begin
+          yield(item)
+          io.print "."
 
-      rescue Interrupt => e
-        report_errors
-        raise e
+        rescue Interrupt => e
+          report_errors
+          raise e
 
-      rescue Exception => e
-        print "E"
-        @errors << [item, e]
+        rescue Exception => e
+          raise e if $DEBUG
+          io.print "E"
+          @errors << [item, e]
 
-      ensure
-        @current += 1
+        ensure
+          @current += 1
 
-        if eol?
-          print "\n"
-          report_progress
+          if eol?
+            io.print "\n"
+            report_progress(io)
+          end
         end
       end
-    end
 
-    print "\n"
-    puts "100% " unless eol?
+      if @current > 0
+        io.print "\n"
+        io.puts "100% " unless eol?
 
-    report_errors
+        report_errors
+      end
+    end
 
     nil
   end
@@ -71,11 +76,11 @@ class Batch
     @current * 100 / @size
   end
 
-  def report_progress
+  def report_progress(io)
     if progress
-      print "#{progress.to_s.rjust 3, " "}% "
+      io.print "#{progress.to_s.rjust 3, " "}% "
     else
-      print "   ? "
+      io.print "   ? "
     end
   end
 
@@ -88,9 +93,26 @@ class Batch
   end
 
   def self.start(title, enumerable, &block)
-    puts
-    puts(title)
-    puts
+    begin
+      enumerable.each.next
+    rescue StopIteration
+      return
+    end
+
+    out do |io|
+      io.puts
+      io.puts(title)
+      io.puts
+    end
+
     each(enumerable, &block)
   end
+
+  def self.out(&block)
+    interactive? ? yield($stdout) : File.open("/dev/null", "w", &block)
+  end
+
+  def self.interactive?
+    (ENV["BATCH_INTERACTIVE"] || 1).to_i == 1
+  end
 end

data/test/batch_test.rb

@@ -3,10 +3,6 @@
 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|
@@ -48,11 +44,11 @@ EOS
   end
 
   should "use BATCH_WIDTH" do
-    ENV["BATCH_WIDTH"] = "40"
-
-    stdout, _ = capture do
-      Batch.each((1..80).to_a) do |item|
-        item + 1
+    stdout, _ = with_env("BATCH_WIDTH" => "40") do
+      capture do
+        Batch.each((1..80).to_a) do |item|
+          item + 1
+        end
       end
     end
 
@@ -96,15 +92,82 @@ EOS
     assert_equal expected.rstrip, stdout.rstrip
   end
 
-  should "work with empty enumerables" do
-    stdout, _ = capture do
+  should "not print anything when there's nothing to do" do
+    stdout, stderr = capture do
       Batch.each([]) { }
     end
 
-    expected = <<-EOS
-  0%
-EOS
+    assert_empty stdout.rstrip
+    assert_empty stderr.rstrip
 
-    assert_equal expected.rstrip, stdout.rstrip
+    stdout, stderr = capture do
+      Batch.start("Not much work", []) { }
+    end
+
+    assert_empty stdout.rstrip
+    assert_empty stderr.rstrip
+  end
+
+  should "be silent when BATCH_INTERACTIVE is 0" do
+    stdout, stderr = with_env("BATCH_INTERACTIVE" => "0") do
+      capture do
+        Batch.each((1..80).to_a) do |item|
+          item + 1
+        end
+      end
+    end
+
+    assert_empty stdout.rstrip
+    assert_empty stderr.rstrip
+
+    stdout, stderr = with_env("BATCH_INTERACTIVE" => "0") do
+      capture do
+        Batch.start("Silent actually", (1..80).to_a) do |item|
+          item + 1
+        end
+      end
+    end
+
+    assert_empty stdout.rstrip
+    assert_empty stderr.rstrip
+  end
+
+  should "halt when $DEBUG is set to true" do
+    items = []
+
+    stdout, stderr = capture do
+      begin
+        $DEBUG = true
+
+        assert_raises(ArgumentError) do
+          Batch.each((1..80).to_a) do |item|
+            items << item
+            raise ArgumentError, "Two is bad." if item == 2
+          end
+        end
+      ensure
+        $DEBUG = false
+      end
+    end
+
+    assert_equal [1, 2], items
+    assert_equal "  0% .", stdout
+  end
+
+  def with_env(env)
+    old = {}
+
+    begin
+      env.each do |key, value|
+        old[key] = ENV[key]
+        ENV[key] = value
+      end
+
+      yield
+    ensure
+      old.each do |key, value|
+        ENV[key] = value
+      end
+    end
   end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: batch
 version: !ruby/object:Gem::Version
-  version: 1.0.2
-  prerelease: 
+  version: 1.0.3
 platform: ruby
 authors:
 - Damian Janowski
@@ -10,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-21 00:00:00.000000000 Z
+date: 2013-06-10 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -27,31 +26,33 @@ files:
 - UNLICENSE
 - batch.gemspec
 - batch.gemspec.erb
+- examples/errors.rb
+- examples/slow.rb
+- examples/start.rb
 - lib/batch.rb
 - test/batch_test.rb
 - test/test_helper.rb
 homepage: http://github.com/djanowski/batch
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Iterate Enumerables with progress reporting.
 test_files: []