progress 1.1.1 → 1.1.2

data/README.rdoc

@@ -65,18 +65,26 @@ or just
 Note - you will get WRONG progress if you use something like this:
 
   10.times_with_progress('A') do |time|
-    10.times_with_progress('B'){ … }
-    10.times_with_progress('C'){ … }
+    10.times_with_progress('B') do
+      # code
+    end
+    10.times_with_progress('C') do
+      # code
+    end
   end
 
 But you can use this:
 
   10.times_with_progress('A') do |time|
     Progress.step 1, 2 do
-      10.times_with_progress('B'){ … }
+      10.times_with_progress('B') do
+        # code
+      end
     end
     Progress.step 1, 2 do
-      10.times_with_progress('C'){ … }
+      10.times_with_progress('C') do
+        # code
+      end
     end
   end
 
@@ -84,10 +92,14 @@ Or if you know that B runs 10 times faster than C:
 
   10.times_with_progress('A') do |time|
     Progress.step 1, 11 do
-      10.times_with_progress('B'){ … }
+      10.times_with_progress('B') do
+        # code
+      end
     end
     Progress.step 10, 11 do
-      10.times_with_progress('C'){ … }
+      10.times_with_progress('C') do
+        # code
+      end
     end
   end
 

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.1.2

data/lib/progress.rb

@@ -1,81 +1,74 @@
 require 'singleton'
 
+# ==== Procedural example
+#   Progress.start('Test', 1000)
+#   1000.times{ Progress.step }
+#   Progress.stop
+# ==== Block example
+#   Progress.start('Test', 1000) do
+#     1000.times{ Progress.step }
+#   end
+# ==== Step must not always be one
+#   symbols = []
+#   Progress.start('Input 100 symbols', 100) do
+#     while symbols.length < 100
+#       input = gets.scan(/\S/)
+#       symbols += input
+#       Progress.step input.length
+#     end
+#   end
+# ==== Enclosed block example
+#   [1, 2, 3].each_with_progress('1 2 3') do |one_of_1_2_3|
+#     10.times_with_progress('10') do |one_of_10|
+#       sleep(0.001)
+#     end
+#   end
 class Progress
   include Singleton
 
-  module InstanceMethods # :nodoc:
-    attr_accessor :title, :current, :total, :note
-    attr_reader :current_step
-    def initialize(title, total)
-      if title.is_a?(Numeric) && total.nil?
-        title, total = nil, title
-      elsif total.nil?
-        total = 1
-      end
-      @title = title
-      @current = 0.0
-      @total = total == 0.0 ? 1.0 : Float(total)
-    end
+  attr_accessor :title, :current, :total, :note
+  attr_reader :current_step
+  def initialize(title, total)
+    if title.is_a?(Numeric) && total.nil?
+      title, total = nil, title
+    elsif total.nil?
+      total = 1
+    end
+    @title = title
+    @current = 0.0
+    @total = total == 0.0 ? 1.0 : Float(total)
+  end
 
-    def step_if_blank
-      if current == 0.0 && total == 1.0
-        self.current = 1.0
-      end
+  def step_if_blank
+    if current == 0.0 && total == 1.0
+      self.current = 1.0
     end
+  end
 
-    def to_f(inner)
-      inner = [inner, 1.0].min
-      if current_step
-        inner *= current_step
-      end
-      (current + inner) / total
+  def to_f(inner)
+    inner = [inner, 1.0].min
+    if current_step
+      inner *= current_step
     end
+    (current + inner) / total
+  end
 
-    def step(steps)
-      @current_step = steps
-      yield
-    ensure
-      @current_step = nil
-    end
+  def step(steps)
+    @current_step = steps
+    yield
+  ensure
+    @current_step = nil
   end
-  include InstanceMethods
 
   class << self
     # start progress indication
-    # ==== Procedural example
-    #   Progress.start('Test', 1000)
-    #   1000.times{ Progress.step }
-    #   Progress.stop
-    # ==== Block example
-    #   Progress.start('Test', 1000) do
-    #     1000.times{ Progress.step }
-    #   end
-    # ==== Step must not always be one
-    #   symbols = []
-    #   Progress.start('Input 100 symbols', 100) do
-    #     while symbols.length < 100
-    #       input = gets.scan(/\S/)
-    #       symbols += input
-    #       Progress.step input.length
-    #     end
-    #   end
-    # ==== Enclosed block example
-    #   [1, 2, 3].each_with_progress('1 2 3') do |one_of_1_2_3|
-    #     10.times_with_progress('10') do |one_of_10|
-    #       sleep(0.001)
-    #     end
-    #   end
-    # ==== To output progress as lines (not trying to stay on line)
-    #   Progress.lines = true
-    # ==== To force highlight
-    #   Progress.highlight = true
     def start(title = nil, total = nil)
       if levels.empty?
         @started_at = Time.now
         @eta = nil
       end
       levels << new(title, total)
-      print_message(true)
+      print_message true
       if block_given?
         begin
           yield
@@ -85,6 +78,7 @@ class Progress
       end
     end
 
+    # step current progress by `num / den`
     def step(num = 1, den = 1, &block)
       if levels.last
         set(levels.last.current + Float(num) / den, &block)
@@ -93,6 +87,7 @@ class Progress
       end
     end
 
+    # set current progress to `value`
     def set(value, &block)
       if levels.last
         ret = if block
@@ -109,11 +104,12 @@ class Progress
       end
     end
 
+    # stop progress
     def stop
       if levels.last
         if levels.last.step_if_blank || levels.length == 1
-          print_message(true)
-          set_title(nil)
+          print_message true
+          set_title nil
         end
         levels.pop
         if levels.empty?
@@ -122,13 +118,20 @@ class Progress
       end
     end
 
+    # set note (will be shown after progress message)
     def note=(s)
       if levels.last
         levels.last.note = s
       end
     end
 
-    attr_writer :lines, :highlight # :nodoc:
+    # output progress as lines (not trying to stay on line)
+    #   Progress.lines = true
+    attr_writer :lines
+
+    # force highlight
+    #   Progress.highlight = true
+    attr_writer :highlight
 
   private
 
@@ -187,26 +190,23 @@ class Progress
 
     def set_title(title)
       if io_tty?
-        io.print("\e]0;#{title}\a")
+        io.print "\e]0;#{title}\a"
       end
     end
 
     def print_message(force = false)
       if force || time_to_print?
         inner = 0
-        parts = []
-        parts_cl = []
-        levels.reverse.each do |l|
-          current = l.to_f(inner)
-          value = current == 0 ? '......' : "#{'%5.1f' % (current * 100.0)}%"
-          inner = current
-
-          title = l.title ? "#{l.title}: " : ''
-          highlighted = "\e[1m#{value}\e[0m"
+        parts, parts_cl = [], []
+        levels.reverse.each do |level|
+          inner = current = level.to_f(inner)
+          value = current.zero? ? '......' : "#{'%5.1f' % (current * 100.0)}%"
+
+          title = level.title ? "#{level.title}: " : nil
           if !highlight? || value == '100.0%'
             parts << "#{title}#{value}"
           else
-            parts << "#{title}#{highlighted}"
+            parts << "#{title}\e[1m#{value}\e[0m"
           end
           parts_cl << "#{title}#{value}"
         end
@@ -220,14 +220,13 @@ class Progress
           message_cl << " - #{note}"
         end
 
-        unless lines?
-          previous_length = @previous_length || 0
-          @previous_length = message_cl.length
-          message << "#{' ' * [previous_length - message_cl.length, 0].max}\r"
+        if lines?
+          io.puts message
+        else
+          io << message << "\e[K\r"
         end
 
-        lines? ? io.puts(message) : io.print(message)
-        set_title(message_cl)
+        set_title message_cl
       end
     end
   end

data/lib/progress/active_record.rb

@@ -1,6 +1,7 @@
 if defined?(ActiveRecord::Base)
   module ActiveRecord
     module BatchesWithProgress
+      # run `find_each` with progress
       def find_each_with_progress(options = {})
         Progress.start(name.tableize, count(options)) do
           find_each do |model|
@@ -11,6 +12,7 @@ if defined?(ActiveRecord::Base)
         end
       end
 
+      # run `find_in_batches` with progress
       def find_in_batches_with_progress(options = {})
         Progress.start(name.tableize, count(options)) do
           find_in_batches do |batch|

data/lib/progress/enumerable.rb

@@ -2,32 +2,32 @@ require 'enumerator'
 require 'progress/with_progress'
 
 module Enumerable
-  # executes any Enumerable method with progress
-  # note that methods which don't necessarily go through all items (like find or any?) will not show 100%
+  # run any Enumerable method with progress
+  # methods which don't necessarily go through all items (like find, any? or all?) will not show 100%
   # ==== Example
   #   [1, 2, 3].with_progress('Numbers').each do |number|
-  #     sleep(number)
+  #     # code
   #   end
   #   [1, 2, 3].with_progress('Numbers').each_cons(2) do |numbers|
-  #     p numbers
+  #     # code
   #   end
   def with_progress(title = nil)
     Progress::WithProgress.new(self, title)
   end
 
-  # note that Progress.step is called automatically
+  # run `each` with progress
   # ==== Example
   #   [1, 2, 3].each_with_progress('Numbers') do |number|
-  #     sleep(number)
+  #     # code
   #   end
   def each_with_progress(title = nil, &block)
     with_progress(title).each(&block)
   end
 
-  # note that Progress.step is called automatically
+  # run `each_with_index` with progress
   # ==== Example
   #   [1, 2, 3].each_with_index_and_progress('Numbers') do |number, index|
-  #     sleep(number)
+  #     # code
   #   end
   def each_with_index_and_progress(title = nil, &block)
     with_progress(title).each_with_index(&block)

data/lib/progress/integer.rb

@@ -1,8 +1,7 @@
 class Integer
-  # note that Progress.step is called automatically
-  # ==== Example
+  # run `times` with progress
   #   100.times_with_progress('Numbers') do |number|
-  #     sleep(number)
+  #     # code
   #   end
   def times_with_progress(title = nil)
     Progress.start(title, self) do

data/progress.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{progress}
-  s.version = "1.1.1"
+  s.version = "1.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Boba Fat"]
-  s.date = %q{2010-12-07}
+  s.date = %q{2010-12-09}
   s.extra_rdoc_files = [
     "README.rdoc"
   ]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: progress
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 1
   - 1
-  - 1
-  version: 1.1.1
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Boba Fat
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-07 00:00:00 +03:00
+date: 2010-12-09 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency