progress 0.3.0 → 0.4.1

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.1

data/lib/progress.rb

@@ -1,6 +1,3 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
 require 'singleton'
 
 class Progress
@@ -179,15 +176,7 @@ class Progress
   end
 end
 
-require 'progress/with_progress'
-
 require 'progress/enumerable'
 require 'progress/integer'
-
-# like Pathname
-module Kernel
-  def Progress(title = nil, total = nil, &block)
-    Progress.start(title, total, &block)
-  end
-  private :Progress
-end
+require 'progress/kernel'
+require 'progress/active_record'

data/lib/progress/active_record.rb

@@ -0,0 +1,27 @@
+if defined?(ActiveRecord::Base)
+  module ActiveRecord
+    module BatchesWithProgress
+      def find_each_with_progress(options = {})
+        Progress.start(name.tableize, count(options)) do
+          find_each do |model|
+            yield model
+            Progress.step
+          end
+        end
+      end
+
+      def find_in_batches_with_progress(options = {})
+        Progress.start(name.tableize, count(options)) do
+          find_in_batches do |batch|
+            yield batch
+            Progress.step batch.length
+          end
+        end
+      end
+    end
+
+    class Base
+      extend BatchesWithProgress
+    end
+  end
+end

data/lib/progress/enumerable.rb

@@ -1,4 +1,6 @@
 require 'enumerator'
+require 'progress/with_progress'
+
 module Enumerable
   # executes any Enumerable method with progress
   # note that methods which don't necessarily go through all items (like find or any?) will not show 100%
@@ -27,8 +29,7 @@ module Enumerable
   #   [1, 2, 3].each_with_index_and_progress('Numbers') do |number, index|
   #     sleep(number)
   #   end
-  def each_with_index_and_progress(title, &block)
+  def each_with_index_and_progress(title = nil, &block)
     with_progress(title).each_with_index(&block)
   end
-
 end

data/lib/progress/kernel.rb

@@ -0,0 +1,6 @@
+module Kernel
+  def Progress(title = nil, total = nil, &block)
+    Progress.start(title, total, &block)
+  end
+  private :Progress
+end

data/progress.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{progress}
-  s.version = "0.3.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Boba Fat"]
@@ -20,8 +20,10 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/progress.rb",
+     "lib/progress/active_record.rb",
      "lib/progress/enumerable.rb",
      "lib/progress/integer.rb",
+     "lib/progress/kernel.rb",
      "lib/progress/with_progress.rb",
      "progress.gemspec",
      "spec/progress_spec.rb",

data/spec/progress_spec.rb

@@ -22,26 +22,168 @@ describe Progress do
     io_pop.should =~ /100\.0.*\n$/
   end
 
-  it "should show valid output for procedural version" do
-    Progress.start('Test', 1000)
-    1000.times do |i|
-      verify_output_before_step(i)
-      Progress.step
+  describe 'direct usage' do
+    describe 'procedural' do
+      it "should show valid output when called as Progress.start" do
+        Progress.start('Test', 1000)
+        1000.times do |i|
+          verify_output_before_step(i)
+          Progress.step
+        end
+        Progress.stop
+        verify_output_after_stop
+      end
+
+      it "should show valid output when called as Progress" do
+        Progress('Test', 1000)
+        1000.times do |i|
+          verify_output_before_step(i)
+          Progress.step
+        end
+        Progress.stop
+        verify_output_after_stop
+      end
+
+      it "should show valid output when called without title" do
+        Progress(1000)
+        1000.times do |i|
+          verify_output_before_step(i)
+          Progress.step
+        end
+        Progress.stop
+        verify_output_after_stop
+      end
+    end
+
+    describe 'block' do
+      it "should show valid output when called as Progress.start" do
+        Progress.start('Test', 1000) do
+          1000.times do |i|
+            verify_output_before_step(i)
+            Progress.step
+          end
+        end
+        verify_output_after_stop
+      end
+
+      it "should show valid output when called as Progress" do
+        Progress('Test', 1000) do
+          1000.times do |i|
+            verify_output_before_step(i)
+            Progress.step
+          end
+        end
+        verify_output_after_stop
+      end
+
+      it "should show valid output when called without title" do
+        Progress(1000) do
+          1000.times do |i|
+            verify_output_before_step(i)
+            Progress.step
+          end
+        end
+        verify_output_after_stop
+      end
     end
-    Progress.stop
-    verify_output_after_stop
   end
 
-  it "should show valid output for block version" do
-    Progress.start('Test', 1000) do
-      1000.times do |i|
-        verify_output_before_step(i)
-        Progress.step
+  describe 'integrity' do
+    it "should not raise errors on extra Progress.stop" do
+      proc{
+        10.times_with_progress('10') do
+          Progress.start 'simple' do
+            Progress.start 'procedural'
+            Progress.stop
+            Progress.stop
+          end
+          Progress.stop
+        end
+        Progress.stop
+      }.should_not raise_error
+    end
+
+    it "should return result from block" do
+      Progress.start('Test') do
+        'qwerty'
+      end.should == 'qwerty'
+    end
+
+    it "should return 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
+
+    it "should kill progress on cycle break" do
+      2.times do
+        catch(:lalala) do
+          2.times_with_progress('A') do |a|
+            io_pop.should == "A: ......\n"
+            2.times_with_progress('B') do |b|
+              io_pop.should == "A: ...... > B: ......\n"
+              throw(:lalala)
+            end
+          end
+        end
+        io_pop.should == "A: ......\n\n"
+      end
+    end
+
+    [[2, 2000], [20, 200], [200, 20], [2000, 2]].each do |_a, _b|
+      it "should allow enclosed progress [#{_a}, #{_b}]" do
+        _a.times_with_progress('A') do |a|
+          io_pop.should == "A: #{a == 0 ? '......' : '%5.1f%%'}\n" % [a / _a.to_f * 100.0]
+          _b.times_with_progress('B') do |b|
+            io_pop.should == "A: #{a == 0 && b == 0 ? '......' : '%5.1f%%'} > B: #{b == 0 ? '......' : '%5.1f%%'}\n" % [(a + b / _b.to_f) / _a.to_f * 100.0, b / _b.to_f * 100.0]
+          end
+          io_pop.should == "A: %5.1f%% > B: 100.0%%\n" % [(a + 1) / _a.to_f * 100.0]
+        end
+        io_pop.should == "A: 100.0%\nA: 100.0%\n\n"
+      end
+
+      it "should not overlap outer progress if inner exceeds [#{_a}, #{_b}]" do
+        _a.times_with_progress('A') do |a|
+          io_pop.should == "A: #{a == 0 ? '......' : '%5.1f%%'}\n" % [a / _a.to_f * 100.0]
+          Progress.start('B', _b) do
+            (_b * 2).times do |b|
+              io_pop.should == "A: #{a == 0 && b == 0 ? '......' : '%5.1f%%'} > B: #{b == 0 ? '......' : '%5.1f%%'}\n" % [(a + [b / _b.to_f, 1].min) / _a.to_f * 100.0, b / _b.to_f * 100.0]
+              Progress.step
+            end
+          end
+          io_pop.should == "A: %5.1f%% > B: 200.0%%\n" % [(a + 1) / _a.to_f * 100.0]
+        end
+        io_pop.should == "A: 100.0%\nA: 100.0%\n\n"
+      end
+
+      it "should allow step with block to validly count custom progresses [#{_a}, #{_b}]" do
+        a_step = 99
+        Progress.start('A', _a * 100) do
+          io_pop.should == "A: ......\n"
+          _a.times do |a|
+            Progress.step(a_step) do
+              _b.times_with_progress('B') do |b|
+                io_pop.should == "A: #{a == 0 && b == 0 ? '......' : '%5.1f%%'} > B: #{b == 0 ? '......' : '%5.1f%%'}\n" % [(a * a_step + b / _b.to_f * a_step) / (_a * 100).to_f * 100.0, b / _b.to_f * 100.0]
+              end
+              io_pop.should == "A: %5.1f%% > B: 100.0%\n" % [(a + 1) * a_step.to_f / (100.0 * _a.to_f) * 100.0]
+            end
+            io_pop.should == "A: %5.1f%%\n" % [(a + 1) * a_step.to_f / (100.0 * _a.to_f) * 100.0]
+          end
+          Progress.step _a
+        end
+        io_pop.should == "A: 100.0%\nA: 100.0%\n\n"
       end
     end
-    verify_output_after_stop
   end
 
+
+
+
+
+
+
   describe Enumerable do
     before :each do
       @a = (0...1000).to_a
@@ -62,6 +204,13 @@ describe Progress do
         end
         verify_output_after_stop
       end
+
+      it "should show valid output for each_with_progress without title" do
+        @a.each_with_progress do |n|
+          verify_output_before_step(n)
+        end
+        verify_output_after_stop
+      end
     end
 
     describe 'with each_with_index_and_progress' do
@@ -80,6 +229,13 @@ describe Progress do
         end
         verify_output_after_stop
       end
+
+      it "should show valid output for each_with_progress without title" do
+        @a.each_with_index_and_progress do |n, i|
+          verify_output_before_step(n)
+        end
+        verify_output_after_stop
+      end
     end
 
     describe 'with with_progress' do
@@ -132,116 +288,13 @@ describe Progress do
         end
         verify_output_after_stop
       end
-    end
-  end
-
-  it "should pipe result from block" do
-    Progress.start('Test') do
-      'qwerty'
-    end.should == 'qwerty'
-  end
-
-  it "should not raise errors on extra Progress.stop" do
-    proc{
-      10.times_with_progress('10') do
-        Progress.start 'simple' do
-          Progress.start 'procedural'
-          Progress.stop
-          Progress.stop
-        end
-        Progress.stop
-      end
-      Progress.stop
-    }.should_not raise_error
-  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
 
-  it "should kill progress on cycle break" do
-    2.times do
-      catch(:lalala) do
-        2.times_with_progress('A') do |a|
-          io_pop.should == "A: ......\n"
-          2.times_with_progress('B') do |b|
-            io_pop.should == "A: ...... > B: ......\n"
-            throw(:lalala)
-          end
-        end
-      end
-      io_pop.should == "A: ......\n\n"
-    end
-  end
-
-  [[2, 2000], [20, 200], [200, 20], [2000, 2]].each do |_a, _b|
-    it "should allow enclosed progress [#{_a}, #{_b}]" do
-      _a.times_with_progress('A') do |a|
-        io_pop.should == "A: #{a == 0 ? '......' : '%5.1f%%'}\n" % [a / _a.to_f * 100.0]
-        _b.times_with_progress('B') do |b|
-          io_pop.should == "A: #{a == 0 && b == 0 ? '......' : '%5.1f%%'} > B: #{b == 0 ? '......' : '%5.1f%%'}\n" % [(a + b / _b.to_f) / _a.to_f * 100.0, b / _b.to_f * 100.0]
-        end
-        io_pop.should == "A: %5.1f%% > B: 100.0%%\n" % [(a + 1) / _a.to_f * 100.0]
-      end
-      io_pop.should == "A: 100.0%\nA: 100.0%\n\n"
-    end
-
-    it "should not overlap outer progress if inner exceeds [#{_a}, #{_b}]" do
-      _a.times_with_progress('A') do |a|
-        io_pop.should == "A: #{a == 0 ? '......' : '%5.1f%%'}\n" % [a / _a.to_f * 100.0]
-        Progress.start('B', _b) do
-          (_b * 2).times do |b|
-            io_pop.should == "A: #{a == 0 && b == 0 ? '......' : '%5.1f%%'} > B: #{b == 0 ? '......' : '%5.1f%%'}\n" % [(a + [b / _b.to_f, 1].min) / _a.to_f * 100.0, b / _b.to_f * 100.0]
-            Progress.step
-          end
-        end
-        io_pop.should == "A: %5.1f%% > B: 200.0%%\n" % [(a + 1) / _a.to_f * 100.0]
-      end
-      io_pop.should == "A: 100.0%\nA: 100.0%\n\n"
-    end
-
-    it "should allow step with block to validly count custom progresses [#{_a}, #{_b}]" do
-      a_step = 99
-      Progress.start('A', _a * 100) do
-        io_pop.should == "A: ......\n"
-        _a.times do |a|
-          Progress.step(a_step) do
-            _b.times_with_progress('B') do |b|
-              io_pop.should == "A: #{a == 0 && b == 0 ? '......' : '%5.1f%%'} > B: #{b == 0 ? '......' : '%5.1f%%'}\n" % [(a * a_step + b / _b.to_f * a_step) / (_a * 100).to_f * 100.0, b / _b.to_f * 100.0]
-            end
-            io_pop.should == "A: %5.1f%% > B: 100.0%\n" % [(a + 1) * a_step.to_f / (100.0 * _a.to_f) * 100.0]
-          end
-          io_pop.should == "A: %5.1f%%\n" % [(a + 1) * a_step.to_f / (100.0 * _a.to_f) * 100.0]
-        end
-        Progress.step _a
-      end
-      io_pop.should == "A: 100.0%\nA: 100.0%\n\n"
-    end
-  end
-
-  describe "using Progress instead of Progress.start" do
-    it "should show valid output for procedural version" do
-      Progress('Test', 1000)
-      1000.times do |i|
-        verify_output_before_step(i)
-        Progress.step
-      end
-      Progress.stop
-      verify_output_after_stop
-    end
-
-    it "should show valid output for block version" do
-      Progress('Test', 1000) do
-        1000.times do |i|
+      it "should show valid output for each_with_progress without title" do
+        1000.times_with_progress do |i|
           verify_output_before_step(i)
-          Progress.step
         end
+        verify_output_after_stop
       end
-      verify_output_after_stop
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: progress
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 13
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 0
-  version: 0.3.0
+  - 4
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Boba Fat
@@ -34,8 +34,10 @@ files:
 - Rakefile
 - VERSION
 - lib/progress.rb
+- lib/progress/active_record.rb
 - lib/progress/enumerable.rb
 - lib/progress/integer.rb
+- lib/progress/kernel.rb
 - lib/progress/with_progress.rb
 - progress.gemspec
 - spec/progress_spec.rb