batch 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+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.

data/README.markdown

@@ -0,0 +1,36 @@
+Batch
+=====
+
+`<%= Faker::Company.bs %>`
+
+Usage
+-----
+
+    require "batch"
+
+    Batch.each(Model.all) do |model|
+      # do something with model
+      # and see the overall progress
+    end
+
+Given that `Model.all` responds to `each` and `size`, you'll get a nice
+progress report:
+
+      0% ...........................................................................
+     25% ...........................................................................
+     50% ...........................................................................
+     75% ...........................................................................
+    100%
+
+If errors occur, they are handled so that your long-running scripts
+don't get interrupted right after you go to bed:
+
+      0% .......E...................................................................
+     25% ..........................................E................................
+     50% ....................E......................................................
+     75% ...........................................................................
+    100%
+
+    Some errors occured:
+
+    # ... detailed exceptions here

data/Rakefile

@@ -0,0 +1,7 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/batch.gemspec

@@ -0,0 +1,9 @@
+Gem::Specification.new do |s|
+  s.name              = "batch"
+  s.version           = "0.0.1"
+  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"]
+end

data/lib/batch.rb

@@ -0,0 +1,68 @@
+class Batch
+  VERSION = "0.0.1"
+
+  attr :enumerable
+
+  def initialize(enumerable)
+    @enumerable = enumerable
+  end
+
+  def each(&block)
+    @errors = []
+    @current = 0
+
+    print "  0% "
+
+    enumerable.each do |item|
+      begin
+        yield(item)
+        print "."
+
+      rescue Exception => e
+        print "E"
+        @errors << [item, e]
+
+      ensure
+        @current += 1
+
+        report_progress if eol?
+      end
+    end
+
+    print "\n"
+
+    report_errors
+
+    nil
+  end
+
+  def report_errors
+    return if @errors.empty?
+
+    $stderr.puts "\nSome errors occured:\n\n"
+
+    @errors.each do |item, error|
+      $stderr.puts "#{item.inspect}: #{error}\n"
+    end
+  end
+
+  def total
+    @enumerable.size
+  end
+
+  def progress
+    @current * 100 / total
+  end
+
+  def report_progress
+    print "\n#{progress.to_s.rjust 3, " "}% "
+  end
+
+  def eol?
+    @current % 75 == 0 || @current == total
+  end
+
+  def self.each(enumerable, &block)
+    new(enumerable).each(&block)
+  end
+end

data/test/batch_test.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class BatchTest < Test::Unit::TestCase
+  should "report" do
+    stdout, _ = capture do
+      Batch.each((1..80).to_a) do |item|
+        item + 1
+      end
+    end
+
+    expected = <<-EOS
+  0% ...........................................................................
+ 93% .....
+100%
+EOS
+
+    assert_equal expected.rstrip, stdout.rstrip
+  end
+
+  should "not halt on errors" do
+    stdout, stderr = capture do
+      Batch.each((1..80).to_a) do |item|
+        raise ArgumentError, "Oops" if item == 3
+      end
+    end
+
+    expected_stdout = <<-EOS
+  0% ..E........................................................................
+ 93% .....
+100%
+EOS
+
+    expected_stderr = <<-EOS
+
+Some errors occured:
+
+3: Oops
+EOS
+
+    assert_equal expected_stdout.rstrip, stdout.rstrip
+    assert_equal expected_stderr.rstrip, stderr.rstrip
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require "stringio"
+require "contest"
+require File.join(File.dirname(__FILE__), "..", "lib", "batch")
+
+def capture
+  stdout, $stdout = $stdout, StringIO.new
+  stderr, $stderr = $stderr, StringIO.new
+  yield
+  [$stdout.string, $stderr.string]
+ensure
+  $stdout = stdout
+  $stderr = stderr
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: batch
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Damian Janowski
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-10 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+- djanowski@dimaion.com
+- michel@soveran.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- 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: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7.pre.1
+signing_key: 
+specification_version: 3
+summary: Iterate Enumerables with progress reporting.
+test_files: []
+