tqdm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd2cc2ae1f682e5a99a462698ec94a5363752ad2
+  data.tar.gz: ee799a36386c9a151fe555e0d856d56bf0650e66
+SHA512:
+  metadata.gz: be8161fd9956a94aa0bf195b7b1de88c3e063c4438b6ab88ba47019c2948ee1ccb31dfe1442930ac6023a8bdb64feaa9a15368f650c25a819fc39f9390631102
+  data.tar.gz: ae7f1c956f1f10121130909124f4d26794fea5fd94690f6ba8420db3f1b0ac060b7f4728123c4525cd0c1f809445b80d08c7256d078f0297cb9e96fc21945fcc

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Theodore Pak
+
+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,45 @@
+# tqdm-ruby
+
+tqdm-ruby is a small utility to show a progress indicator while iterating through an Enumerable object.
+
+It is a port of the excellent tdqm library for python: <a href="https://github.com/tqdm/tqdm" target="_blank">https://github.com/tqdm/tqdm</a>.
+
+Call #tqdm on any `Enumerable`, which enhances the object so that iterating over it will produce an animated progress bar on `$stderr`.
+
+    require 'tqdm'
+    (0...1000).tqdm.each {|x| sleep 0.01 }
+
+The default output looks like this:
+
+    |####------| 492/1000  49% [elapsed: 00:05 left: 00:05, 88.81 iters/sec]
+
+It works equally well from within [pry](http://pryrepl.org/) and [Jupyter notebooks](https://jupyter.org/).
+
+## Install
+
+Add this line to your application's `Gemfile`:
+
+    gem 'tqdm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tqdm
+
+## Usage
+
+All `Enumerable` objects gain access to the `#tqdm` method, which returns an enhanced object wherein any iteration (by calling `#each` or any of its relatives, e.g., `#each_with_index`, `#each_with_object`, etc.) produces an animated progress bar on $stderr.
+
+    require 'tqdm'
+    (0...100).tqdm.each {|x| sleep 0.01 }
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/core_ext/enumerable.rb

@@ -0,0 +1,20 @@
+require "tqdm"
+
+# This is where the real magic begins
+# All enumerable objects (e.g.) Arrays will have these methods added to them
+module Enumerable
+  
+  # Upgrades an Enumerable so that any subsequent call to .each will spit out a progress bar
+  # opts is a hash that can include:
+  #   desc: Short string, describing the progress, added to the beginning of the line
+  #   total: Expected number of iterations, if not given, self.size is used
+  #   file: A file-like object to output the progress message to, by default, $stderr
+  #   leave: A boolean (default False) should the progress bar should stay on screen after it's done?
+  #   min_interval: See below
+  #   min_iters: If less than min_interval seconds or min_iters iterations have passed since
+  #              the last progress meter update, it is not updated again.
+  def tqdm(opts = {})
+    Tqdm::TqdmDecorator.new(self, opts).enhance
+  end
+  
+end

data/lib/tqdm.rb

@@ -0,0 +1,94 @@
+require "tqdm/version"
+require "tqdm/utils"
+require "core_ext/enumerable"
+
+module Tqdm
+  
+  class << self
+    def enhance_sequel!
+      require "tqdm/sequel"
+    end
+  end
+    
+  class StatusPrinter
+    def initialize(file)
+      @file = file
+      @last_printed_len = 0
+    end
+  
+    def print_status(s)
+      @file.write("\r" + s + ' ' * [@last_printed_len - s.size, 0].max)
+      @file.flush
+      @last_printed_len = s.size
+    end
+  end
+  
+  
+  class TqdmDecorator
+    
+    include Utils
+    
+    def initialize(enumerable, opts={})
+      @enumerable = enumerable
+      @total = opts[:total] || @enumerable.size rescue nil
+      @prefix = opts[:desc] ? opts[:desc] + ': ' : ''
+      @file = opts[:file] || $stderr
+      @sp = StatusPrinter.new(@file)
+      @min_iters = opts[:min_iters] || 1
+      @min_interval = opts[:min_interval] || 0.5
+      @leave = opts[:leave] || false
+    end
+    
+    def start!
+      @start_t = @last_print_t = Time.now
+      @last_print_n = 0
+      @n = 0
+      
+      @sp.print_status(@prefix + format_meter(0, @total, 0))
+    end
+    
+    def increment!
+      @n += 1
+  
+      if @n - @last_print_n >= @min_iters
+        # We check the counter first, to reduce the overhead of time.time()
+        cur_t = Time.now
+        if cur_t - @last_print_t >= @min_interval
+          @sp.print_status(@prefix + format_meter(@n, @total, cur_t - @start_t))
+          @last_print_n = @n
+          @last_print_t = cur_t
+        end
+      end
+    end
+    
+    def finish!
+      if !@leave
+        @sp.print_status('')
+        @file.write("\r")
+      else
+        if @last_print_n < @n
+          @sp.print_status(@prefix + format_meter(@n, @total, Time.now - @start_t))
+        end
+        @file.write("\n")
+      end
+    end
+    
+    def enhance
+      tqdm = self
+      
+      enhanced = @enumerable.clone
+      enhanced.define_singleton_method(:each) do |*args, &block|
+        tqdm.start!
+        super(*args) do |item|
+          block.call item
+          tqdm.increment!
+        end
+        tqdm.finish!
+      end
+      
+      enhanced
+    end
+
+  end
+  
+end

data/lib/tqdm/sequel.rb

@@ -0,0 +1,12 @@
+require "sequel"
+require "tqdm"
+
+module Sequel
+  
+  class Dataset
+    def tqdm(opts = {})
+      Tqdm::TqdmDecorator.new(self, {total: count}.merge!(opts)).enhance
+    end
+  end
+  
+end

data/lib/tqdm/utils.rb

@@ -0,0 +1,46 @@
+require "tqdm"
+
+module Tqdm
+  
+  N_BARS = 10
+  
+  module Utils
+  
+    # Formats a number of seconds into an hh:mm:ss string.
+    def format_interval(t)
+      mins, s = t.to_i.divmod(60)
+      h, m = mins.divmod(60)
+      if h > 0 then '%d:%02d:%02d' % [h, m, s]; else '%02d:%02d' % [m, s]; end
+    end
+  
+    # Formats a count (n) of total items processed + an elapsed time into a
+    # textual progress meter.
+    def format_meter(n, total, elapsed)
+      # n - number of finished iterations
+      # total - total number of iterations, or nil
+      # elapsed - number of seconds passed since start
+      total = (n > total ? nil : total) if total
+  
+      elapsed_str = format_interval(elapsed)
+      rate = elapsed && elapsed > 0 ? ('%5.2f' % (n / elapsed)) : '?'
+  
+      if total
+        frac = n.to_f / total
+    
+        bar_length = (frac * N_BARS).to_i
+        bar = '#' * bar_length + '-' * (N_BARS - bar_length)
+    
+        percentage = '%3d%%' % (frac * 100)
+    
+        left_str = n > 0 ? (format_interval(elapsed / n * (total - n))) : '?'
+    
+        '|%s| %d/%d %s [elapsed: %s left: %s, %s iters/sec]' % [bar, n, total, 
+            percentage, elapsed_str, left_str, rate]
+      else
+        '%d [elapsed: %s, %s iters/sec]' % [n, elapsed_str, rate]
+      end
+    end
+    
+  end
+  
+end

data/lib/tqdm/version.rb

@@ -0,0 +1,3 @@
+module Tqdm
+  VERSION = "0.0.1"
+end

data/tqdm.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tqdm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tqdm"
+  spec.version       = Tqdm::VERSION
+  spec.authors       = ["Theodore Pak"]
+  spec.email         = ["theodore.r.pak@gmail.com"]
+  spec.description   = %q{Enhances Enumerables to show progress while iterating. (Port of tqdm for Python.)}
+  spec.summary       = %q{Enhances Enumerables to show progress while iterating.}
+  spec.homepage      = "https://github.com/powerpak/tqdm-ruby"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: tqdm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Theodore Pak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-20 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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:
+- theodore.r.pak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/core_ext/enumerable.rb
+- lib/tqdm.rb
+- lib/tqdm/sequel.rb
+- lib/tqdm/utils.rb
+- lib/tqdm/version.rb
+- tqdm.gemspec
+homepage: https://github.com/powerpak/tqdm-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Enhances Enumerables to show progress while iterating.
+test_files: []