tqdm 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18fbbebb6aadc15bb9b2cea3caf012e49e087908
-  data.tar.gz: 3da06e2b16e451592014ebdf94b0012ad165d589
+  metadata.gz: 3dc522c1cd180b959a8c36c2a3f1fb41ffdd51a8
+  data.tar.gz: e17546f682e0adfe9b6970bc02477590b1d355cd
 SHA512:
-  metadata.gz: 0aefc092a3fb9a925107689fe03eaf8196393a60331fcb41031bca5159423693e65db4bd5cf60a333cb0d16c1cb0eaf9dfe5682003955665d1bdedcf0ea49d70
-  data.tar.gz: 7bdd329b81bca2cc2951753815c7459f58ac6009b8dffa8e5a650cbb921f67cc7ac7b4e976478a5fd9d09fcbcea82842757dc80d1f8b83a28ebd55adc711abca
+  metadata.gz: 2a5aecb337cfec0e565deabd81741aff57c48c1b1b13b562c08c9173ae6b9e520aeb18561734a317ee9ee2943dc0df3869c71495c17ff584580d7787857011b2
+  data.tar.gz: 71e5e62669db44fe2d3b7aa42696c22bf5c34f87f374b48505ea9899536c9a614ae9ce92b874799e3e5df46525f2fc9ea251dea2a5f86c238db7f34468aa291b

data/.yardopts

@@ -1,4 +1,4 @@
 --readme README.md
 --charset utf-8
 --markup markdown
-'lib/**/*.rb'
+'lib/**/*.rb'

data/README.md

@@ -1,10 +1,11 @@
 # tqdm-ruby
+[![Gem Version](https://badge.fury.io/rb/tqdm.svg)](https://badge.fury.io/rb/tqdm)
 
-tqdm-ruby is a small utility to show a progress indicator while iterating through an Enumerable object.
+tqdm-ruby allows you to add a progress indicator to your loops with minimal effort.
 
-It is a port of the excellent [tdqm library][tqdm] for python.
+It is a port of the excellent [tqdm library][tqdm] for python. tqdm (read taqadum, تقدّم) means "progress" in Arabic.
 
-Call `#tqdm` on any `Enumerable`, which enhances the object so that iterating over it will produce an animated progress bar on `$stderr`.
+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.
 
 ```ruby
 require 'tqdm'
@@ -15,11 +16,14 @@ The default output looks like this:
 
 ![|####------| 492/1000  49% [elapsed: 00:05 left: 00:05, 88.81 iters/sec]](http://i.imgur.com/6y0t7XS.gif)
 
-It works equally well from within irb, [pry](http://pryrepl.org/), and [Jupyter notebooks](https://jupyter.org/).
+It works equally well from within irb, [pry](http://pryrepl.org/), and [iRuby notebooks](https://github.com/SciRuby/iruby) as seen here:
 
-*Why not progressbar, ruby-progressbar, etc.?* These have a bazillion formatting options and you typically have to update the progressbar object throughout other code. tqdm pleasantly encourages the laziest imaginable usage, in that you "set it and forget it".
+![iRuby notebook screencap](http://i.imgur.com/DilrHuX.gif)
+
+*Why not progressbar, ruby-progressbar, powerbar, or any of the [other gems][]?* These typically have a bucketload of formatting options and you have to manually send updates to the progressbar object to use them. tqdm pleasantly encourages the laziest usage scenario, in that you "set it and forget it".
 
 [tqdm]: https://github.com/tqdm/tqdm
+[other gems]: https://www.ruby-toolbox.com/categories/CLI_Progress_Bars
 
 ## Install
 
@@ -37,22 +41,23 @@ And then execute:
 
 ## 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`.
-
-Options can be provided for `#tqdm`:
+All `Enumerable` objects gain access to the `#with_progress` method (aliased as `#tqdm`), which returns an enhanced object wherein any iteration (by calling `#each` or any of its relatives: `#each_with_index`, `#map`, `#select`, etc.) produces an animated progress bar on `$stderr`.
 
 ```ruby
 require 'tqdm'
-Hash[*(1..1000)].tqdm(desc: "working on it", leave: true).each { |x| sleep 0.01 }
+num = 1629241972611353
+(2..Math.sqrt(num)).with_progress.reject { |x| num % x > 0 }.map { |x| [x, num/x] }
+# ... Animates a progress bar while calculating...
+# => [[32599913, 49976881]]
 ```
 
-The following options are available:
+Options can be provided as a hash, e.g., `.with_progress(desc: "copying", leave: true)`. The following options are available:
 
 - `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
+- `total`: Expected number of iterations, if not given, `self.size || self.count` 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`: Default is `0.5`. If less than `min_interval` seconds or `min_iters` iterations have passed since the last progress meter update, it is not re-printed (decreases IO thrashing).
+- `leave`: A boolean (default `false`). Should the progress bar should stay on screen after it's done?
+- `min_interval`: Default is `0.5`. If less than `min_interval` seconds or `min_iters` iterations have passed since the last progress meter update, it is not re-printed (decreasing IO thrashing).
 - `min_iters`: Default is `1`. See previous.
 
 [Sequel](http://sequel.jeremyevans.net/) is an amazing database library for Ruby. tqdm can enhance its [`Dataset`](http://sequel.jeremyevans.net/rdoc/classes/Sequel/Dataset.html) objects to show progress while iterating (same options as above):
@@ -68,12 +73,20 @@ DB.create_table :items do
 end
 
 # Show progress during big inserts (this isn't new)
-(0..100000).tqdm.each { DB[:items].insert(price: rand * 100) }
+(0..100000).with_progress.each { DB[:items].insert(price: rand * 100) }
 
 # Show progress during long SELECT queries
-DB[:items].where{ price > 10 }.tqdm.each { |row| "do some processing here" }
+DB[:items].where{ price > 10 }.with_progress.each { |row| "do some processing here" }
 ```
 
+## TODO
+
+1. Performance improvements
+2. Test/benchmark suite
+3. Add smoothing for speed estimates
+4. Support unicode output (smooth blocks)
+5. By default, resize to the apparent width of the output terminal
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/lib/core_ext/enumerable.rb

@@ -1,25 +1,26 @@
-require "tqdm"
+require 'tqdm'
 
 # We enhance all enumerable objects (e.g. `Array`, `Hash`, `Range`, ...) by extending the `Enumerable` module.
 # This mixin is only supposed to be present on objects that provide an `#each` method.
 #
 # @see http://ruby-doc.org/core-2.2.3/Enumerable.html
 module Enumerable
-  
-  # Returns a clone of `self` where all calls to `#each` and related methods will print an animated progress bar 
+
+  # Returns a *clone* of `self` where all calls to `#each` and related methods will print an animated progress bar 
   # while iterating.
   #
-  # @param opts [Hash] more options used to control behavior of the progress bar
-  # @option opts [String] :desc a short description added to the beginning of the progress bar
-  # @option opts [Integer] :total (self.size) the expected number of iterations
-  # @option opts [File, IO] :file ($stderr) a file-like object to output the progress bar to
-  # @option opts [Boolean] :leave (false) should the progress bar should stay on screen after it's done?
-  # @option opts [Integer] :min_iters see `:min_interval`
-  # @option opts [Float] :min_interval If less than min_interval seconds or min_iters iterations have passed since
+  # @param options [Hash] more options used to control behavior of the progress bar
+  # @option options [String] :desc a short description added to the beginning of the progress bar
+  # @option options [Integer] :total (self.size) the expected number of iterations
+  # @option options [File, IO] :file ($stderr) a file-like object to output the progress bar to
+  # @option options [Boolean] :leave (false) should the progress bar should stay on screen after it's done?
+  # @option options [Integer] :min_iters see `:min_interval`
+  # @option options [Float] :min_interval If less than min_interval seconds or min_iters iterations have passed since
   #              the last progress meter update, it is not updated again.
   # @return [Enumerable] `self` with the `#each` method wrapped as described above
-  def tqdm(opts = {})
-    Tqdm::TqdmDecorator.new(self, opts).enhance
+  def with_progress(options = {})
+    Tqdm::Decorator.new(self, options).enhance
   end
-  
-end
+  alias :tqdm :with_progress
+
+end

data/lib/tqdm.rb

@@ -1,163 +1,24 @@
-require "tqdm/version"
-require "tqdm/utils"
-require "core_ext/enumerable"
+require 'tqdm/version'
+require 'tqdm/decorator'
+require 'core_ext/enumerable'
 
 # Add a progress bar to your loops in a second.
-# A port of Python's [tqdm library](https://github.com/tqdm/tqdm), although we're currently 
+# A port of Python's [tqdm library](https://github.com/tqdm/tqdm), although we're currently
 # closer to the feature set of [@noamraph's original release](https://github.com/noamraph/tqdm).
 #
-# Specifically, `Tqdm` enhances `Enumerable` by printing a progress indicator whenever 
+# Specifically, `Tqdm` enhances `Enumerable` by printing a progress indicator whenever
 # iterating with `#each` or its close relatives.
 #
 # @author Theodore Pak
 # @see https://github.com/tqdm/tqdm
 module Tqdm
-  
-  # The default width of the progress bar, in characters.
-  N_BARS = 10
-  
+
   class << self
-    # Upgrades `Sequel::Datasets` with the #tqdm method.
-    # @see Enumerable#tqdm
+    # Upgrades `Sequel::Datasets` with the #with_progress method.
+    # @see Enumerable#with_progress
     def enhance_sequel!
-      require "tqdm/sequel"
-    end
-  end
-  
-  # Prints a status line, handling the deletion of previously printed lines with carriage 
-  # returns as necessary. Instantiated by a `TqdmDecorator`.
-  #
-  # @private
-  class StatusPrinter
-    # Initialize a new StatusPrinter.
-    #
-    # @param file [File, IO] the status will be printed to this via `#write` and `#flush`
-    def initialize(file)
-      @file = file
-      @last_printed_len = 0
-    end
-  
-    # Prints a line of text to @file, after deleting the previously printed line
-    #
-    # @param line [String] a line of text to be printed
-    # @return [Integer] the number of bytes written
-    def print_status(line)
-      @file.write("\r" + line + ' ' * [@last_printed_len - line.size, 0].max)
-      @file.flush
-      @last_printed_len = line.size
+      require 'tqdm/sequel'
     end
   end
-  
-  
-  # Decorates the #each method of an `Enumerable` by wrapping it so that each
-  # iteration produces a pretty progress bar printed to the console or a file handle.
-  #
-  # @note The `Enumerable` is cloned before it is enhanced; it is not modified directly.
-  #
-  # @example Enhances `arr` so that an animated progress bar prints while iterating.
-  #   arr = (0...1000)
-  #   arr_tqdm = TqdmDecorator.new(arr).enhance
-  #   arr_tqdm.each { |x| sleep 0.01 }
-  class TqdmDecorator
-    
-    include Utils
 
-    # Initialize a new TqdmDecorator. Typically you wouldn't use this object, but
-    # would immediately call `#enhance` to retrieve the enhanced `Enumerable`.
-    #
-    # @param enumerable [Enumerable] the Enumerable object to be enhanced
-    # @param opts [Hash] more options used to control behavior of the progress bar
-    # @option opts [String] :desc a short description added to the beginning of the progress bar
-    # @option opts [Integer] :total (self.size) the expected number of iterations
-    # @option opts [File, IO] :file ($stderr) a file-like object to output the progress bar to
-    # @option opts [Boolean] :leave (false) should the progress bar should stay on screen after it's done?
-    # @option opts [Integer] :min_iters see `:min_interval`
-    # @option opts [Float] :min_interval If less than min_interval seconds or min_iters iterations have passed since
-    #              the last progress meter update, it is not updated again.
-    #
-    # @example
-    #   a = (1...1000)
-    #   TqdmDecorator.new(a).enhance.each { |x| sleep 0.01 }
-    #
-    # @example
-    #   a = [1, 2, 3, 4]
-    #   TqdmDecorator.new(a, file: $stdout, leave: true)
-    def initialize(enumerable, opts={})
-      @enumerable = enumerable
-      @total = opts[:total] || @enumerable.size rescue @enumerable.count 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
-    
-    # Starts the textual progress bar.
-    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
-    
-    # Called everytime the textual progress bar might need to be updated (i.e. on
-    # every iteration). We still check whether the update is appropriate to print to
-    # the progress bar before doing so, according to the `:min_iters` and `:min_interval`
-    # options.
-    #
-    # @see #initialize
-    def increment!
-      @n += 1
-  
-      if @n - @last_print_n >= @min_iters
-        # We check the counter first, to reduce the overhead of Time.now
-        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
-    
-    # Prints the final state of the textual progress bar. Based on the `:leave` option, this
-    # may include deleting it entirely.
-    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
-    
-    # Enhances the wrapped `Enumerable`.
-    #
-    # @note The `Enumerable` is cloned (shallow copied) before it is enhanced; it is not modified directly.
-    #
-    # @return [Enumerable] a clone of Enumerable enhanced so that every call to `#each` animates the
-    #   progress bar.
-    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/decorator.rb

@@ -0,0 +1,138 @@
+require 'tqdm/printer'
+
+module Tqdm
+
+  # Decorates the #each method of an `Enumerable` by wrapping it so that each
+  # iteration produces a pretty progress bar printed to the console or a file handle.
+  #
+  # @note The `Enumerable` is cloned before it is enhanced; it is not modified directly.
+  #
+  # @example Enhances `arr` so that an animated progress bar prints while iterating.
+  #   arr = (0...1000)
+  #   arr_tqdm = Decorator.new(arr).enhance
+  #   arr_tqdm.each { |x| sleep 0.01 }
+  class Decorator
+
+    attr_reader :printer, :enumerable, :iteration, :start_time
+
+    # Initialize a new Decorator. Typically you wouldn't use this object, but
+    # would immediately call `#enhance` to retrieve the enhanced `Enumerable`.
+    #
+    # @param enumerable [Enumerable] the Enumerable object to be enhanced
+    # @param options [Hash] more options used to control behavior of the progress bar
+    # @option options [String] :desc a short description added to the beginning of the progress bar
+    # @option options [Integer] :total (self.size) the expected number of iterations
+    # @option options [File, IO] :file ($stderr) a file-like object to output the progress bar to
+    # @option options [Boolean] :leave (false) should the progress bar should stay on screen after it's done?
+    # @option options [Integer] :min_iters see `:min_interval`
+    # @option options [Float] :min_interval If less than min_interval seconds or min_iters iterations have passed since
+    #              the last progress meter update, it is not updated again.
+    #
+    # @example
+    #   a = (1...1000)
+    #   Decorator.new(a).enhance.each { |x| sleep 0.01 }
+    #
+    # @example
+    #   a = [1, 2, 3, 4]
+    #   Decorator.new(a, file: $stdout, leave: true)
+    def initialize(enumerable, options={})
+      @enumerable = enumerable
+      options.merge!(total: total!) unless options[:total]
+      @printer = Printer.new(options)
+      @min_iterations = options[:min_iters] || 1
+      @min_interval = options[:min_interval] || 0.5
+      @leave = options[:leave] || false
+    end
+
+    # Starts the textual progress bar.
+    def start!
+      @iteration = 0
+      @start_time = Time.now
+      printer.start
+    end
+
+    # Called everytime the textual progress bar might need to be updated (i.e. on
+    # every iteration). We still check whether the update is appropriate to print to
+    # the progress bar before doing so, according to the `:min_iters` and `:min_interval`
+    # options.
+    #
+    # @see #initialize
+    def increment!
+      @iteration += 1
+
+      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
+
+      printer.status(iteration, elapsed_time!)
+      @last_printed_iteration = iteration
+      @last_print_time = current_time
+    end
+
+    # Prints the final state of the textual progress bar. Based on the `:leave` option, this
+    # may include deleting it entirely.
+    def finish!
+      return printer.null_finish unless @leave
+
+      printer.finish(iteration, elapsed_time!, reprint?)
+    end
+
+    # Enhances the wrapped `Enumerable`.
+    #
+    # @note The `Enumerable` is cloned (shallow copied) before it is enhanced; it is not modified directly.
+    #
+    # @return [Enumerable] a clone of Enumerable enhanced so that every call to `#each` animates the
+    #   progress bar.
+    def enhance
+      decorate_enumerable_each
+      enhanced
+    end
+
+    private
+
+    def decorate_enumerable_each
+      tqdm = self
+      enhanced.define_singleton_method(:each) do |*args, &block|
+        tqdm.start!
+        result = super(*args) do |item|
+          block.call item if block
+          tqdm.increment!
+        end
+        tqdm.finish!
+        result
+      end
+    end
+
+    def enhanced
+      @enhanced ||= enumerable.clone
+    end
+
+    def total!
+      enumerable.size rescue enumerable.count rescue nil
+    end
+
+    def last_printed_iteration
+      @last_printed_iteration ||= iteration
+    end
+
+    def last_print_time
+      @last_print_time ||= start_time
+    end
+
+    def current_time
+      @current_time ||= current_time!
+    end
+
+    def current_time!
+      @current_time = Time.now
+    end
+
+    def elapsed_time!
+      current_time! - start_time
+    end
+
+    def reprint?
+      last_printed_iteration < iteration
+    end
+  end
+end

data/lib/tqdm/printer.rb

@@ -0,0 +1,70 @@
+require 'tqdm/printer/default_format'
+require 'forwardable'
+
+module Tqdm
+
+  # Prints a status line, handling the deletion of previously printed lines with carriage
+  # returns as necessary. Instantiated by a `Decorator`.
+  #
+  # @private
+  class Printer
+    extend Forwardable
+
+    attr_reader :total, :format, :file
+
+    # Initialize a new Printer.
+    #
+    # @param options [Hash] the options for the instantiating Tqdm::Decorator
+    #
+    # @see Tqdm::Decorator#initialize
+    def initialize(options)
+      @total = options[:total]
+      @format = Printer::DefaultFormat.new(options)
+      @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
+    #
+    # @param iteration [Integer] number of iterations, out of the total, that are completed
+    # @param elapsed_time [Float] number of seconds passed since start
+    # @return [String] the padded line
+    def padded_line(iteration, elapsed_time)
+      meter_line = line(iteration, elapsed_time)
+      pad_size = [@last_printed_length - meter_line.size, 0].max
+      @last_printed_length = meter_line.size
+      meter_line + ' ' * pad_size
+    end
+
+    # Prints a line of text to @file, after deleting the previously printed line
+    #
+    # @param iteration [Integer] number of iterations, out of the total, that are completed
+    # @param elapsed_time [Float] number of seconds passed since start
+    def status(iteration, elapsed_time)
+      file.write("\r" + padded_line(iteration, elapsed_time))
+      file.flush
+    end
+
+    # Prints a line of text to @file, after deleting the previously printed line
+    #
+    # @param iteration [Integer] number of iterations, out of the total, that are completed
+    # @param elapsed_time [Float] number of seconds passed since start
+    # @param reprint [Boolean] do we need to reprint the line one last time?
+    def finish(iteration, elapsed_time, reprint)
+      file.write("\r" + padded_line(iteration, elapsed_time)) if reprint
+      file.write("\n")
+      file.flush
+    end
+
+    # Disappear without a trace.
+    def null_finish
+      file.write("\r" + ' ' * @last_printed_length + "\r")
+    end
+
+    def_delegators :format, :line, :meter
+  end
+end

data/lib/tqdm/printer/default_format.rb

@@ -0,0 +1,74 @@
+module Tqdm
+  class Printer
+    class DefaultFormat
+      PROGRESS_BAR_WIDTH = 10
+      SPACE = '-'
+      PROGRESS = '#'
+
+      # Initialize a new DefaultFormat.
+      #
+      # @param options [Hash] the options for the Tqdm::Decorator
+      #
+      # @see Tqdm::Decorator#initialize
+      def initialize(options)
+        @total = options[:total]
+        @prefix = options[:desc] ? options[:desc] + ': ' : ''
+      end
+
+      # Formats the prefix, progress bar and meter as a complete line to be printed
+      #
+      # @param iteration [Integer] number of finished iterations
+      # @param elapsed_time [Float] total number of seconds passed since start
+      # @return [String] the complete line to print
+      #
+      # @see #meter
+      def line(iteration, elapsed_time)
+        prefix + meter(iteration, total, elapsed_time)
+      end
+
+      # Formats a count (n) of total items processed + an elapsed time into a
+      # textual progress bar + meter.
+      #
+      # @param n [Integer] number of finished iterations
+      # @param total [Integer, nil] total number of iterations, or nil
+      # @param elapsed [Float] number of seconds passed since start
+      # @return [String] a textual progress bar + meter
+      def meter(n, total, elapsed)
+        total = (n > total ? nil : total) if total
+
+        elapsed_str = interval(elapsed)
+        rate = elapsed && elapsed > 0 ? ('%5.2f' % (n / elapsed)) : '?'
+
+        if total
+          frac = n.to_f / total
+
+          bar_length = (frac * PROGRESS_BAR_WIDTH).to_i
+          bar = PROGRESS * bar_length + SPACE * (PROGRESS_BAR_WIDTH - bar_length)
+
+          percentage = '%3d%%' % (frac * 100)
+
+          left_str = n > 0 ? (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
+
+      private
+
+      attr_reader :total, :prefix
+
+      # Formats a number of seconds into an hh:mm:ss string.
+      #
+      # @param t [Integer] a number of seconds
+      # @return [String] an hh:mm:ss string
+      def interval(seconds)
+        m, s = seconds.to_i.divmod(60)
+        h, m = m.divmod(60)
+        if h > 0 then '%d:%02d:%02d' % [h, m, s]; else '%02d:%02d' % [m, s]; end
+      end
+    end
+  end
+end

data/lib/tqdm/sequel.rb

@@ -1,25 +1,28 @@
-require "sequel"
-require "tqdm"
+require 'sequel'
+require 'tqdm'
 
 # @see Sequel::Dataset
 module Sequel
-  
+
   # In order to use `Tqdm` with Sequel Datasets, we can simply extend `Sequel::Dataset`
-  # with the same `#tqdm` method 
+  # with the same `#with_progress` method
   #
-  # @see Enumerable#tqdm
+  # @see Enumerable#with_progress
   # @see http://sequel.jeremyevans.net/
   # @see http://sequel.jeremyevans.net/rdoc/classes/Sequel/Dataset.html
   class Dataset
-    
-    # Returns a clone of `self` where all calls to `#each` and related methods will print an animated progress bar 
+
+    # Returns a clone of `self` where all calls to `#each` and related methods will print an animated progress bar
     # while iterating.
     #
-    # @see Enumerable#tqdm
-    def tqdm(opts = {})
-      Tqdm::TqdmDecorator.new(self, opts).enhance
+    # @param options [Hash] options are the same as Enumerable#with_progress
+    #
+    # @see Enumerable#with_progress
+    def with_progress(options = {})
+      Tqdm::Decorator.new(self, options).enhance
     end
-    
+    alias :tqdm :with_progress
+
   end
-  
-end
+
+end

data/lib/tqdm/version.rb

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

data/tqdm.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  
+
   spec.required_ruby_version = '>= 1.9.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tqdm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Theodore Pak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,8 +54,10 @@ files:
 - Rakefile
 - lib/core_ext/enumerable.rb
 - lib/tqdm.rb
+- lib/tqdm/decorator.rb
+- lib/tqdm/printer.rb
+- lib/tqdm/printer/default_format.rb
 - lib/tqdm/sequel.rb
-- lib/tqdm/utils.rb
 - lib/tqdm/version.rb
 - tqdm.gemspec
 homepage: https://github.com/powerpak/tqdm-ruby

data/lib/tqdm/utils.rb

@@ -1,50 +0,0 @@
-require "tqdm"
-
-module Tqdm
-  
-  # Utility functions related to `Tqdm`.
-  module Utils
-  
-    # Formats a number of seconds into an hh:mm:ss string.
-    #
-    # @param t [Integer] a number of seconds
-    # @return [String] 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 bar + meter.
-    #
-    # @param n [Integer] number of finished iterations
-    # @param total [Integer, nil] total number of iterations, or nil
-    # @param elapsed [Integer] number of seconds passed since start
-    # @return [String] a textual progress bar + meter
-    def format_meter(n, total, elapsed)
-      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