progress_bar 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63c44738d941428ab4348be03ab2f1744343fb7b
-  data.tar.gz: a78ec7e3bd7e45e56ae9fb9d07d7269d3b05dbda
+  metadata.gz: 3103cdc1290b5ec50f1da7fbc7062081bae5c16b
+  data.tar.gz: 87a155b6d6d4c62892f3842061e0ffb59e9311a1
 SHA512:
-  metadata.gz: 913cb8e575f72ff88aaf39d32e54e67abbe83ab6aa19540295b512641c898a038ad91b1b845604bb4fd19abc5cc4436e64a63ada61faf0dbaf27b982b83863d1
-  data.tar.gz: 5a483c2f3cc1e5b41949644463c8da98ecdb9509c18ab2d117971cd72fc71589b44bdba59ec08f5c59910904e211ac66f1dd8069df9d3e17aeaf8d011d4a60d8
+  metadata.gz: 27f9fe545c96fcd393e0c2daf0b91fa91ca4a630f5872979845797519adfdaa46539e44b4aa1e83b46b2f2b9e9902b1b12fa57aff0fb9baec154d4e9a8a1961d
+  data.tar.gz: 8e841687bcfa71a84763b7827b3387dd5cb77980774762be90b5e7199b77ec127adb0d0e8b37ec4c826cae01760243444ea8930c7f1de62083c7b7cd2fcf38c3

data/.travis.yml

@@ -1,16 +1,12 @@
 script: rake spec
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.2
+  - 2.2
+  - 2.3
+  - 2.4.0-preview3
   - ruby-head
-  - jruby-19mode
-  - jruby-head
-  - rbx-2
 
 matrix:
   allow_failures:
     - rvm:
-      - rbx-2.1.1
-      - jruby-head
+      - 2.4.0-preview3
       - ruby-head

data/README.mkd

@@ -81,6 +81,32 @@ gem install --development progress_bar
 rspec spec/*_spec.rb
 ```
 
+## Using ProgressBar on Enumerable-alikes.
 
+If you do a lot of progresses, you can shorten your way with this:
 
+```ruby
+class Array
+  include ProgressBar::WithProgress
+end
 
+[1,2,3].each_with_progress{do_something}
+
+# or any other Enumerable's methods:
+
+(1..1000).to_a.with_progress.select{|i| (i % 2).zero?}
+```
+
+You can include `ProgressBar::WithProgress` in any class, having methods
+`#count` and `#each`, like some DB datasets and so on.
+
+If you are using progress_bar regularly on plain arrays, you may want to
+do:
+
+```ruby
+require 'progress_bar/core_ext/enumerable_with_progress'
+
+# it adds each_with_progress/with_progress to Array/Hash/Range
+
+(1..400).with_progress.select{|i| (i % 2).zero?}
+```

data/examples/enumerable.rb

@@ -0,0 +1,4 @@
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib/progress_bar/enumerable'))
+
+p (20...34).with_progress.select{|i| sleep 0.1; (i % 2).zero?}

data/lib/progress_bar.rb

@@ -15,7 +15,7 @@ class ProgressBar
     @meters     = [:bar, :counter, :percentage, :elapsed, :eta, :rate]
 
     @max        = args.shift if args.first.is_a? Numeric
-    raise ArgumentError, "Max must be a positive integer" unless @max > 0
+    raise ArgumentError, "Max must be a positive integer" unless @max >= 0
 
     @meters     = args unless args.empty?
 
@@ -190,3 +190,5 @@ class ProgressBar
   end
 
 end
+
+require_relative 'progress_bar/with_progress'

data/lib/progress_bar/core_ext/enumerable_with_progress.rb

@@ -0,0 +1,6 @@
+require_relative '../../progress_bar'
+
+# FIXME: should there be a better method?..
+[Enumerable, Array, Hash, Range].each do |mod|
+  mod.send :include, ProgressBar::WithProgress
+end

data/lib/progress_bar/version.rb

@@ -1,3 +1,3 @@
 class ProgressBar
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/lib/progress_bar/with_progress.rb

@@ -0,0 +1,18 @@
+class ProgressBar
+  module WithProgress
+    def each_with_progress(&block)
+      bar = ProgressBar.new(count)
+      if block
+        each{|obj| yield(obj).tap{bar.increment!}}
+      else
+        Enumerator.new{|yielder|
+          self.each do |obj|
+            (yielder << obj).tap{bar.increment!}
+          end
+        }
+      end
+    end
+
+    alias_method :with_progress, :each_with_progress
+  end
+end

data/spec/arguments_spec.rb

@@ -32,7 +32,7 @@ describe 'ProgressBar arguments' do
 
   it "should raise an error when initial max is nonsense" do
     lambda {
-      bar = ProgressBar.new(0)
+      bar = ProgressBar.new(-1)
     }.should raise_error(ProgressBar::ArgumentError)
   end
 

data/spec/with_progress_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe ProgressBar::WithProgress do
+  context 'with block' do
+    let!(:bar){ProgressBar.new}
+    before{
+      Range.send(:include, ProgressBar::WithProgress)
+      allow(ProgressBar).to receive(:new){|max| bar.max = max; bar}
+    }
+    it 'should set max and increment on each iteration' do
+      (1..20).each_with_progress do |i|
+        break if i > 10
+      end
+      expect(bar.max).to eq 20
+      expect(bar.count).to eq 10
+    end
+  end
+
+  context 'without block' do
+    let!(:bar){ProgressBar.new}
+    before{
+      Range.send(:include, ProgressBar::WithProgress)
+      allow(ProgressBar).to receive(:new){|max| bar.max = max; bar}
+    }
+    it 'should give Enumerator' do
+      enum = (1..20).each_with_progress
+      expect(enum).to be_kind_of(Enumerator)
+      expect(bar.max).to eq 20
+      expect(bar.count).to eq 0
+
+      res = enum.map{|i| i + 1}
+      expect(res).to eq (2..21).to_a
+      expect(bar.count).to eq 20
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: progress_bar
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul Sadauskas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2016-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: options
@@ -95,9 +95,12 @@ files:
 - LICENSE
 - README.mkd
 - Rakefile
+- examples/enumerable.rb
 - examples/simple.rb
 - lib/progress_bar.rb
+- lib/progress_bar/core_ext/enumerable_with_progress.rb
 - lib/progress_bar/version.rb
+- lib/progress_bar/with_progress.rb
 - profile/shell_every_update
 - profile/shell_every_update.gif
 - profile/shell_once
@@ -112,6 +115,7 @@ files:
 - spec/progress_bar_spec.rb
 - spec/rate_spec.rb
 - spec/spec_helper.rb
+- spec/with_progress_spec.rb
 homepage: http://github.com/paul/progress_bar
 licenses: []
 metadata: {}
@@ -131,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: progress_bar
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Simple Progress Bar for output to a terminal
@@ -145,3 +149,4 @@ test_files:
 - spec/progress_bar_spec.rb
 - spec/rate_spec.rb
 - spec/spec_helper.rb
+- spec/with_progress_spec.rb