with_progress 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  data.tar.gz: 3f2f0e11796ce29a15547e9b4999764f68690902
+  metadata.gz: 2344dd81e4e3ff3c673ae204b7f099df34a21377
+SHA512: 
+  data.tar.gz: 435603621abd935122315fad2a8834847596d3c7fc27d188d8b402f9bf92a2b529ff31e14bbc2ea3ccdf8a85dd191ce4e5241e96e403111f04fbc5949c47bbba
+  metadata.gz: 4438efe9f53a6e0e919b643bd01b3cf7e158d296745753233bfe0bb85639ce1bea31965fde7e8f30a686a4e945b98e940beaaac874b4f43899c9df1dc6d83696

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+  - ruby-head
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-2.1.1

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+= with_progress --- History
+
+== Version 1.0 - February 3rd, 2014
+
+=== Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in with_progress.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Marc-Andre Lafortune
+
+MIT License
+
+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.md

@@ -0,0 +1,38 @@
+# with_progress [<img src="https://travis-ci.org/marcandre/with_progress.png?branch=master">](https://travis-ci.org/marcandre/with_progress) [<img src="https://badge.fury.io/rb/with_progress.png" alt="Gem Version" />](http://badge.fury.io/rb/with_progress)
+
+Brings the great [ruby-progressbar](https://github.com/jfelchner/ruby-progressbar) to `Enumerable`.
+
+## Usage
+
+This gem adds the method `Enumerable#with_progress`.
+
+Calling `with_progress` displays a progress bar while the iteration takes place.
+
+It uses the [ruby-progressbar](https://github.com/jfelchner/ruby-progressbar) gem and accepts the same options.
+
+In Ruby 2.0+, most enumerables return a size, so `with_progress` uses that to deduce the `total`, there's no need to specify it:
+
+	42.times.with_progress { do_something } # Will provide {total: 42} option in Ruby 2.0+ and show the right progression
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'with_progress'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install with_progress
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/with_progress/extensions/enumerable.rb

@@ -0,0 +1,19 @@
+module Enumerable
+  def with_progress(options = {})
+    return to_enum(:with_progress, options) { size rescue nil } unless block_given?
+
+    options = WithProgress::DEFAULTS.merge(options)
+    unless options.has_key?(:total)
+      options[:total] = size rescue self.end - self.begin + (exclude_end? ? 0 : 1) rescue nil
+    end
+
+    bar = ProgressBar.create(options)
+    each do |*args|
+      result = yield *args
+      bar.increment
+      result
+    end
+  ensure
+    bar.stop if bar
+  end
+end

data/lib/with_progress/version.rb

@@ -0,0 +1,3 @@
+module WithProgress
+  VERSION = "1.0.0"
+end

data/lib/with_progress.rb

@@ -0,0 +1,9 @@
+require 'with_progress/version'
+require 'with_progress/extensions/enumerable'
+require 'ruby-progressbar'
+require 'backports/2.0.0/range/size'
+
+module WithProgress
+  DEFAULTS = {:format => ENV['RUBY_WITH_PROGRESS'] || '%t: |%B| %E'}
+end
+

data/spec/manual_spec.rb

@@ -0,0 +1,10 @@
+require 'with_progress'
+
+describe "Progress" do
+  it "looks good" do
+    (0...10).with_progress do
+      sleep 0.5
+    end
+    puts "Did it look good?"
+  end
+end

data/spec/with_progress_spec.rb

@@ -0,0 +1,28 @@
+require 'with_progress'
+
+Enumerator = Enumerable::Enumerator unless Object.const_defined? :Enumerator
+
+describe "with_progress" do
+  subject { 42.times.to_enum(:map).with_progress(&block) }
+
+  describe 'when called without a block' do
+    let(:block) { nil }
+
+    it { should be_instance_of(Enumerator) }
+    if Enumerator.respond_to? :size
+      its(:size) { should == 42 }
+    end
+    it "works" do
+      subject.each{|i| i + 10}.should == [*10...52]
+    end
+    it "can be interrupted" do
+      subject.each{|i| break -i if i >= 4; sleep 0.1; i + 10}.should == -4
+    end
+  end
+
+  describe 'when called with a block' do
+    let(:block) {Proc.new{|i| i + 10} }
+
+    it { should == [*10...52] }
+  end
+end

data/with_progress.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'with_progress/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "with_progress"
+  spec.version       = WithProgress::VERSION
+  spec.authors       = ["Marc-Andre Lafortune"]
+  spec.email         = ["github@marc-andre.ca"]
+  spec.description   = %q{progressbar for enumerables}
+  spec.summary       = %q{progressbar for enumerables}
+  spec.homepage      = "http://github.com/marcandre/with_progress"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'ruby-progressbar', '~> 1.4'
+  spec.add_dependency 'backports', '~> 3.5'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: with_progress
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Marc-Andre Lafortune
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-02-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-progressbar
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.4"
+  prerelease: false
+  requirement: *id001
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  name: backports
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.5"
+  prerelease: false
+  requirement: *id002
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  prerelease: false
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id005 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  prerelease: false
+  requirement: *id004
+  type: :development
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id005
+  prerelease: false
+  requirement: *id006
+  type: :development
+description: progressbar for enumerables
+email: 
+- github@marc-andre.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- CHANGELOG.rdoc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/with_progress.rb
+- lib/with_progress/extensions/enumerable.rb
+- lib/with_progress/version.rb
+- spec/manual_spec.rb
+- spec/with_progress_spec.rb
+- with_progress.gemspec
+homepage: http://github.com/marcandre/with_progress
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id005
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id005
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: progressbar for enumerables
+test_files: 
+- spec/manual_spec.rb
+- spec/with_progress_spec.rb