tqdm 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3dc522c1cd180b959a8c36c2a3f1fb41ffdd51a8
-  data.tar.gz: e17546f682e0adfe9b6970bc02477590b1d355cd
+SHA256:
+  metadata.gz: 72b63925baf593f87124eff5deaba635425475a900dd4432d07c772026488b45
+  data.tar.gz: 036ac2f161ef3fca07351818d0de75ec0a4c932af831f73370d26c318213a5f1
 SHA512:
-  metadata.gz: 2a5aecb337cfec0e565deabd81741aff57c48c1b1b13b562c08c9173ae6b9e520aeb18561734a317ee9ee2943dc0df3869c71495c17ff584580d7787857011b2
-  data.tar.gz: 71e5e62669db44fe2d3b7aa42696c22bf5c34f87f374b48505ea9899536c9a614ae9ce92b874799e3e5df46525f2fc9ea251dea2a5f86c238db7f34468aa291b
+  metadata.gz: ca9b6cec37e773998ab099f6ab57e5c1d16f6fde371d82000d7a8750276ea5b3a018760ec0703a6b02830808d6292c4b387dd2beb733221b3b19f1d20bcd3504
+  data.tar.gz: c8e3a86ac26c82998a792b1b361fd040953a6078397a69c7d4a09d95641b45b61a04ea5288768a0662169f8e557ec6adc47f1bdd7fdfb66bc02e0027f7d6fa03

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+ - "1.9.2"
+ - "1.9.3"
+ - "2.0.0"
+ - "2.1.8"
+ - "2.2.4"
+ - "2.6.5"
+ - "2.7.2"
+ - "3.0.5"
+ - "3.1.3"
+ - rbx

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Theodore Pak
+Copyright (c) 2022 Theodore Pak
 
 MIT License
 

data/README.md

@@ -1,18 +1,18 @@
 # tqdm-ruby
-[![Gem Version](https://badge.fury.io/rb/tqdm.svg)](https://badge.fury.io/rb/tqdm)
+[![Build Status](https://travis-ci.org/powerpak/tqdm-ruby.svg?branch=master)](https://travis-ci.org/powerpak/tqdm-ruby) [![Gem Version](https://badge.fury.io/rb/tqdm.svg)](https://badge.fury.io/rb/tqdm)
 
 tqdm-ruby allows you to add a progress indicator to your loops with minimal effort.
 
 It is a port of the excellent [tqdm library][tqdm] for python. tqdm (read taqadum, تقدّم) means "progress" in Arabic.
 
-Calling `#tqdm` (or its readable but longer alias `#with_progress`) on any `Enumerable` returns an enhanced clone that animates a meter on `$stderr` during iteration.
+Calling `#tqdm` (or `#with_progress`) on any `Enumerable` returns an enhanced clone that animates a meter during iteration.
 
 ```ruby
 require 'tqdm'
 (0...1000).tqdm.each { |x| sleep 0.01 }
 ```
 
-The default output looks like this:
+The default output is sent to `$stderr` and looks like this:
 
 ![|####------| 492/1000  49% [elapsed: 00:05 left: 00:05, 88.81 iters/sec]](http://i.imgur.com/6y0t7XS.gif)
 
@@ -29,7 +29,7 @@ It works equally well from within irb, [pry](http://pryrepl.org/), and [iRuby no
 
 Install it globally from [Rubygems](https://rubygems.org/gems/tqdm):
 
-    $ gem install tqdm    # (might need sudo on OS X)
+    $ gem install tqdm    # (might need sudo for a system ruby)
 
 *or* add this line to your application's Gemfile:
 
@@ -82,7 +82,7 @@ DB[:items].where{ price > 10 }.with_progress.each { |row| "do some processing he
 ## TODO
 
 1. Performance improvements
-2. Test/benchmark suite
+2. Add benchmark suite, expand test coverage
 3. Add smoothing for speed estimates
 4. Support unicode output (smooth blocks)
 5. By default, resize to the apparent width of the output terminal

data/Rakefile

@@ -1 +1,8 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+end
+
+task :default => :spec

data/lib/tqdm/decorator.rb

@@ -12,6 +12,8 @@ module Tqdm
   #   arr_tqdm = Decorator.new(arr).enhance
   #   arr_tqdm.each { |x| sleep 0.01 }
   class Decorator
+    
+    extend Forwardable
 
     attr_reader :printer, :enumerable, :iteration, :start_time
 
@@ -42,13 +44,13 @@ module Tqdm
       @min_iterations = options[:min_iters] || 1
       @min_interval = options[:min_interval] || 0.5
       @leave = options[:leave] || false
+      @force_refreeze = false
     end
 
     # Starts the textual progress bar.
     def start!
-      @iteration = 0
-      @start_time = Time.now
-      printer.start
+      @iteration = @last_printed_iteration = 0
+      @start_time = @last_print_time = current_time!
     end
 
     # Called everytime the textual progress bar might need to be updated (i.e. on
@@ -63,8 +65,9 @@ module Tqdm
       return unless (iteration - last_printed_iteration) >= @min_iterations
       # We check the counter first, to reduce the overhead of Time.now
       return unless (current_time! - last_print_time) >= @min_interval
+      return if iteration == total && !@leave
 
-      printer.status(iteration, elapsed_time!)
+      printer.status(iteration, elapsed_time!) 
       @last_printed_iteration = iteration
       @last_print_time = current_time
     end
@@ -85,6 +88,7 @@ module Tqdm
     #   progress bar.
     def enhance
       decorate_enumerable_each
+      enhanced.freeze if @force_refreeze
       enhanced
     end
 
@@ -94,8 +98,8 @@ module Tqdm
       tqdm = self
       enhanced.define_singleton_method(:each) do |*args, &block|
         tqdm.start!
-        result = super(*args) do |item|
-          block.call item if block
+        result = super(*args) do |*items|
+          block.call *items if block
           tqdm.increment!
         end
         tqdm.finish!
@@ -104,7 +108,20 @@ module Tqdm
     end
 
     def enhanced
-      @enhanced ||= enumerable.clone
+      @enhanced ||= enumerable_unfrozen
+    end
+
+    # Uses progressively more invasive techniques to return an unfrozen copy of @enumerable
+    # Significantly, for some classes like Sequel::Dataset, both #clone and #dup re-freeze
+    #    the object, so we have to drop back to Object#clone
+    def enumerable_unfrozen
+      unfrozen = enumerable.clone(freeze: false)
+      return unfrozen unless unfrozen.frozen?
+      unfrozen = enumerable.dup
+      return unfrozen unless unfrozen.frozen?
+      @force_refreeze = true
+      unfrozen = Object.instance_method(:clone).bind(enumerable).call(freeze: false)
+      unfrozen
     end
 
     def total!
@@ -134,5 +151,7 @@ module Tqdm
     def reprint?
       last_printed_iteration < iteration
     end
+    
+    def_delegator :printer, :total
   end
 end

data/lib/tqdm/printer/default_format.rb

@@ -39,7 +39,7 @@ module Tqdm
         elapsed_str = interval(elapsed)
         rate = elapsed && elapsed > 0 ? ('%5.2f' % (n / elapsed)) : '?'
 
-        if total
+        if total && total > 0
           frac = n.to_f / total
 
           bar_length = (frac * PROGRESS_BAR_WIDTH).to_i
@@ -62,7 +62,7 @@ module Tqdm
 
       # Formats a number of seconds into an hh:mm:ss string.
       #
-      # @param t [Integer] a number of seconds
+      # @param seconds [Integer] a number of seconds
       # @return [String] an hh:mm:ss string
       def interval(seconds)
         m, s = seconds.to_i.divmod(60)

data/lib/tqdm/printer.rb

@@ -23,10 +23,6 @@ module Tqdm
       @file = options[:file] || $stderr
       @last_printed_length = 0
     end
-
-    def start
-      line(0, 0.0)
-    end
     
     # Pads a status line so that it is long enough to overwrite the previously written line
     #

data/lib/tqdm/version.rb

@@ -1,4 +1,4 @@
 module Tqdm
   # The version of this module and gem by the same name.
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/spec/enumerable_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+require 'timecop'
+require_relative '../lib/tqdm'
+
+describe 'When enumerating over an object' do
+  before { Timecop.freeze }
+  after  { Timecop.return }
+
+  def with_stderr(&block)
+    old_stderr = $stderr
+    $stderr    = StringIO.new
+
+    block.call
+
+    return $stderr.string
+  ensure
+    $stderr = old_stderr
+  end
+  
+  def timecop_loop(enumerable, options = {})
+    enumerable.tqdm(options).each do |x|
+      Timecop.travel 1
+    end
+  end
+
+  context 'that has zero elements' do
+    let(:enumerable) { (0...0) }
+    
+    context 'with default options' do
+      it 'never displays a progress bar' do
+        final_stderr = with_stderr { timecop_loop(enumerable) }
+        expect(final_stderr).to eq "\r\r"
+      end
+    end
+    
+    context 'with leave: true' do
+      it 'never displays a progress bar' do
+        final_stderr = with_stderr { timecop_loop(enumerable, leave: true) }
+        expect(final_stderr).to eq "\n"
+      end
+    end
+  end
+
+  context 'that has one element' do
+    let(:enumerable) { (0...1) }
+    
+    context 'with default options' do
+      it 'never displays a progress bar' do
+        final_stderr = with_stderr { timecop_loop(enumerable) }
+        expect(final_stderr).to eq "\r\r"
+      end
+    end
+    
+    context 'with leave: true' do
+      it 'displays a progress bar once at 100%' do
+        final_stderr = with_stderr { timecop_loop(enumerable, leave: true) }
+        expect(final_stderr).to eq "" \
+          "\r|##########| 1/1 100% [elapsed: 00:01 left: 00:00,  1.00 iters/sec]" \
+          "\n"
+      end
+    end
+
+  end
+
+  context 'that has several (five) elements' do
+    let(:enumerable) { (0...5) }
+    
+    context 'with default options' do
+      it 'displays a progress bar for the first four steps and deletes it' do
+        final_stderr = with_stderr { timecop_loop(enumerable) }
+
+        expect(final_stderr).to eq "" \
+          "\r|##--------| 1/5  20% [elapsed: 00:01 left: 00:04,  1.00 iters/sec]" \
+          "\r|####------| 2/5  40% [elapsed: 00:02 left: 00:03,  1.00 iters/sec]" \
+          "\r|######----| 3/5  60% [elapsed: 00:03 left: 00:02,  1.00 iters/sec]" \
+          "\r|########--| 4/5  80% [elapsed: 00:04 left: 00:01,  1.00 iters/sec]" \
+          "\r                                                                   " \
+          "\r"
+      end
+    end
+    
+    context 'with leave: true' do
+      it 'displays a progress bar with as many steps as elements and leaves it' do
+        final_stderr = with_stderr { timecop_loop(enumerable, leave: true) }
+
+        expect(final_stderr).to eq "" \
+          "\r|##--------| 1/5  20% [elapsed: 00:01 left: 00:04,  1.00 iters/sec]" \
+          "\r|####------| 2/5  40% [elapsed: 00:02 left: 00:03,  1.00 iters/sec]" \
+          "\r|######----| 3/5  60% [elapsed: 00:03 left: 00:02,  1.00 iters/sec]" \
+          "\r|########--| 4/5  80% [elapsed: 00:04 left: 00:01,  1.00 iters/sec]" \
+          "\r|##########| 5/5 100% [elapsed: 00:05 left: 00:00,  1.00 iters/sec]" \
+          "\n"
+      end
+    end
+  end
+end

data/spec/sequel_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'timecop'
+require_relative '../lib/tqdm'
+require_relative '../lib/tqdm/sequel'
+
+describe 'When enumerating over a Sequel dataset' do
+  before { Timecop.freeze }
+  after  { Timecop.return }
+    
+  def timecop_loop(dataset, options = {})
+    dataset.tqdm(options).each do |x|
+      Timecop.travel 1
+    end
+  end
+
+  context 'that has several (five) elements' do
+    let(:database) do
+      db = Sequel.sqlite
+      db.create_table :items do
+        primary_key :id
+        Float :price
+      end
+    
+      (0...5).each { db[:items].insert(price: rand * 100) }
+    
+      db
+    end
+    
+    context 'with default options' do
+      it 'displays a progress bar for the first four steps and deletes it' do
+        final_stderr = with_stderr { timecop_loop(database[:items]) }
+
+        expect(final_stderr).to eq "" \
+          "\r|##--------| 1/5  20% [elapsed: 00:01 left: 00:04,  1.00 iters/sec]" \
+          "\r|####------| 2/5  40% [elapsed: 00:02 left: 00:03,  1.00 iters/sec]" \
+          "\r|######----| 3/5  60% [elapsed: 00:03 left: 00:02,  1.00 iters/sec]" \
+          "\r|########--| 4/5  80% [elapsed: 00:04 left: 00:01,  1.00 iters/sec]" \
+          "\r                                                                   " \
+          "\r"
+      end
+
+      it 'returns a re-frozen object' do
+        enhanced = timecop_loop(database[:items])
+        expect(enhanced.frozen?).to be_truthy
+      end
+
+      it 'returns an object inheriting from Sequel::Dataset' do
+        enhanced = timecop_loop(database[:items])
+        expect(enhanced).to be_kind_of(Sequel::Dataset)
+      end
+    end
+    
+    context 'with leave: true' do
+      it 'displays a progress bar with as many steps as elements and leaves it' do
+        final_stderr = with_stderr { timecop_loop(database[:items], leave: true) }
+
+        expect(final_stderr).to eq "" \
+          "\r|##--------| 1/5  20% [elapsed: 00:01 left: 00:04,  1.00 iters/sec]" \
+          "\r|####------| 2/5  40% [elapsed: 00:02 left: 00:03,  1.00 iters/sec]" \
+          "\r|######----| 3/5  60% [elapsed: 00:03 left: 00:02,  1.00 iters/sec]" \
+          "\r|########--| 4/5  80% [elapsed: 00:04 left: 00:01,  1.00 iters/sec]" \
+          "\r|##########| 5/5 100% [elapsed: 00:05 left: 00:00,  1.00 iters/sec]" \
+          "\n"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end
+
+def with_stderr(&block)
+  old_stderr = $stderr
+  $stderr    = StringIO.new
+
+  block.call
+
+  return $stderr.string
+ensure
+  $stderr = old_stderr
+end

data/tqdm.gemspec

@@ -18,8 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "sequel"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "timecop"
 
   spec.required_ruby_version = '>= 1.9.2'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: tqdm
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Theodore Pak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2022-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Enhances Enumerables to show progress while iterating. (Port of tqdm
   for Python.)
 email:
@@ -47,6 +103,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - ".yardopts"
 - Gemfile
 - LICENSE.txt
@@ -59,6 +117,9 @@ files:
 - lib/tqdm/printer/default_format.rb
 - lib/tqdm/sequel.rb
 - lib/tqdm/version.rb
+- spec/enumerable_spec.rb
+- spec/sequel_spec.rb
+- spec/spec_helper.rb
 - tqdm.gemspec
 homepage: https://github.com/powerpak/tqdm-ruby
 licenses:
@@ -79,9 +140,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Enhances Enumerables to show progress while iterating.
-test_files: []
+test_files:
+- spec/enumerable_spec.rb
+- spec/sequel_spec.rb
+- spec/spec_helper.rb