progress 3.0.2 → 3.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTRkZThiZjMwMWU0ZmRiNGE4NDNmYTdiNWQyNjkxYmEzYjNjYjEzNA==
+    YmExNzc5ZGQ5Mzc1ZGQzY2Y4Zjg0N2ExNGMyZGNlNzQ0NDhmZTIyYQ==
   data.tar.gz: !binary |-
-    ODhlNTFhZTNmMTdlNzI1MTUwN2YzZTU2ODk5OWI2YTAzZmZhYzAyZQ==
+    MThiNTU2Yzc1MTAzMGI3ZDY5M2UwNDBhZmZhOTM1ZWI0YzMyNDEyNg==
 SHA512:
   metadata.gz: !binary |-
-    NTNjMGYwYTYwODAxNWZkODE4MWY3ZmExZTNjNWRkMWEyZTFhMDZkMmJmNTUy
-    M2EwMjRmYmVlNDQwMTliMmEzNTdjMGE0ZGVlMmE5Mjk5YjQ1MWEwZGUwZGVm
-    YTg3OTFiZDBlMjFmMjY3ODFmMjYwNzk0YzZkZjc5YzMzOWI2NTY=
+    MjIxMGI1Y2Q3OGI1MzJhZDZmMzJmNTllZDFjMTE1ODhjZTM0OTliZWQwODhm
+    MDdmOWM1NWU5NGM2Y2I1OTFkMjJkYjdhZTE5ZmRlOThmZGNhZDdjYzRhYTJj
+    NGNjOTM2YmNkMjdiOThlYWE1ZDNhM2EyZWRhMTgyYTVjMjJlMGU=
   data.tar.gz: !binary |-
-    NmI1NTEwOTNjNmFkMDc0OTYwNWE4MzI0ZTFiNzNmODQyM2FlYzEzMjE1YmY5
-    NDljZDNjOWM5ZWFjZmViZGI0ODMwYmRiZGM0ZDNjNDcyNWMzZDgzNDk4OGQ2
-    ZGQzODI3ZDVjYmJiZjZhZTZhN2Q0MWE3YTJlMzJmYWNlM2RmOTg=
+    ZmE3MDVkNDgxOTY4NmUxMGY1MjAzMjMwMzEwNTkwYmFhYzA3ZmExYjExZGZm
+    YjYyZDRiMzc4MDBjOGQ1ZWRiYWZjNDA2NzkwNDk4NjU5NTM0NjljNTE0MjM4
+    OTcxOGRlY2U4NjhmZWQzZDUyZDNlNzFkNDljZWIwOWQzYWVkZTI=

data/.rubocop.yml

@@ -0,0 +1,65 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/IfUnlessModifier:
+  MaxLineLength: 40
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+    '%W': '[]'
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/SpaceBeforeBlockBraces:
+  EnforcedStyle: no_space
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -3,8 +3,19 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - 2.0.0
+  - '2.0'
+  - '2.1'
   - jruby-18mode
   - jruby-19mode
   - ree
-script: "bundle exec rspec"
+script:
+  if [ -z "$RUBOCOP" ]; then
+    bundle exec rspec
+  ; else
+    bundle exec rubocop
+  ; fi
+matrix:
+  fast_finish: true
+  include:
+    - env: RUBOCOP=true
+      rvm: default

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/README.markdown

@@ -1,9 +1,13 @@
+[![Gem Version](https://img.shields.io/gem/v/progress.svg?style=flat)](https://rubygems.org/gems/progress)
+[![Build Status](https://img.shields.io/travis/toy/progress/master.svg?style=flat)](https://travis-ci.org/toy/progress)
+[![Code Climate](https://img.shields.io/codeclimate/github/toy/progress.svg?style=flat)](https://codeclimate.com/github/toy/progress)
+[![Dependency Status](https://img.shields.io/gemnasium/toy/progress.svg?style=flat)](https://gemnasium.com/toy/progress)
+[![Inch CI](http://inch-ci.org/github/toy/progress.svg?branch=master&style=flat)](http://inch-ci.org/github/toy/progress)
+
 # progress
 
 Show progress during console script run.
 
-[![Build Status](https://travis-ci.org/toy/progress.png?branch=master)](https://travis-ci.org/toy/progress)
-
 ## Installation
 
     gem install progress

data/lib/progress.rb

@@ -3,6 +3,15 @@
 require 'singleton'
 require 'thread'
 
+require 'progress/class_methods'
+require 'progress/beeper'
+require 'progress/eta'
+
+require 'progress/kernel'
+require 'progress/enumerable'
+require 'progress/integer'
+require 'progress/active_record' if defined?(ActiveRecord::Base)
+
 # ==== Procedural example
 #   Progress.start('Test', 1000)
 #   1000.times do
@@ -36,13 +45,14 @@ require 'thread'
 #   end
 class Progress
   include Singleton
+  extend ClassMethods
 
   attr_reader :total
   attr_reader :current
   attr_reader :title
   attr_accessor :note
   def initialize(total, title)
-    if !total.kind_of?(Numeric) && (title.nil? || title.kind_of?(Numeric))
+    if !total.is_a?(Numeric) && (title.nil? || title.is_a?(Numeric))
       total, title = title, total
     end
     total = total && total != 0 ? Float(total) : 1.0
@@ -59,7 +69,7 @@ class Progress
   end
 
   def step(step, note)
-    if !step.kind_of?(Numeric)
+    unless step.is_a?(Numeric)
       step, note = nil, step
     end
     step = 1 if step.nil?
@@ -82,223 +92,4 @@ class Progress
     end
     ret
   end
-
-  @lock = Mutex.new
-  class << self
-
-    # start progress indication
-    def start(total = nil, title = nil)
-      lock do
-        if running?
-          unless @started_in == Thread.current
-            warn 'Can\'t start inner progress in different thread'
-            if block_given?
-              return yield
-            else
-              return
-            end
-          end
-        else
-          @started_in = Thread.current
-          @eta = Eta.new
-          start_beeper
-        end
-        @levels ||= []
-        @levels.push new(total, title)
-      end
-      print_message :force => true
-      if block_given?
-        begin
-          yield
-        ensure
-          stop
-        end
-      end
-    end
-
-    # step current progress
-    def step(step = nil, note = nil, &block)
-      if running?
-        ret = @levels.last.step(step, note, &block)
-        print_message
-        ret
-      elsif block
-        block.call
-      end
-    end
-
-    # set value of current progress
-    def set(new_current, note = nil, &block)
-      if running?
-        ret = @levels.last.set(new_current, note, &block)
-        print_message
-        ret
-      elsif block
-        block.call
-      end
-    end
-
-    # stop progress
-    def stop
-      if running?
-        if @levels.length == 1
-          print_message :force => true, :finish => true
-          stop_beeper
-        end
-        @levels.pop
-      end
-    end
-
-    # check if progress was started
-    def running?
-      @levels && !@levels.empty?
-    end
-
-    # set note
-    def note=(note)
-      if running?
-        @levels.last.note = note
-      end
-    end
-
-    # stay on one line
-    def stay_on_line?
-      @stay_on_line.nil? ? io_tty? : @stay_on_line
-    end
-
-    # explicitly set staying on one line [true/false/nil]
-    def stay_on_line=(value)
-      @stay_on_line = true && value
-    end
-
-    # highlight output using control characters
-    def highlight?
-      @highlight.nil? ? io_tty? : @highlight
-    end
-
-    # explicitly set highlighting [true/false/nil]
-    def highlight=(value)
-      @highlight = true && value
-    end
-
-    # show progerss in terminal title
-    def set_terminal_title?
-      @set_terminal_title.nil? ? io_tty? : @set_terminal_title
-    end
-
-    # explicitly set showing progress in terminal title [true/false/nil]
-    def set_terminal_title=(value)
-      @set_terminal_title = true && value
-    end
-
-  private
-
-    def lock(force = true)
-      if force ? @lock.lock : @lock.try_lock
-        begin
-          yield
-        ensure
-          @lock.unlock
-        end
-      end
-    end
-
-    def io
-      @io || $stderr
-    end
-
-    def io_tty?
-      io.tty? || ENV['PROGRESS_TTY']
-    end
-
-    def start_beeper
-      @beeper = Beeper.new(10) do
-        print_message
-      end
-    end
-
-    def stop_beeper
-      @beeper.stop if @beeper
-    end
-
-    def restart_beeper
-      @beeper.restart if @beeper
-    end
-
-    def time_to_print?
-      !@next_time_to_print || @next_time_to_print <= Time.now
-    end
-
-    def eta(current)
-      @eta.left(current)
-    end
-
-    def elapsed
-      @eta.elapsed
-    end
-
-    def print_message(options = {})
-      force = options[:force]
-      lock force do
-        if force || time_to_print?
-          @next_time_to_print = Time.now + 0.3
-          restart_beeper
-
-          current = 0
-          parts = []
-          title_parts = []
-          @levels.reverse.each do |level|
-            current = level.to_f(current)
-
-            percent = current == 0 ? '......' : "#{'%5.1f' % (current * 100.0)}%"
-            title = level.title && "#{level.title}: "
-            if !highlight? || percent == '100.0%'
-              parts << "#{title}#{percent}"
-            else
-              parts << "#{title}\e[1m#{percent}\e[0m"
-            end
-            title_parts << "#{title}#{percent}"
-          end
-
-          timing = if options[:finish]
-            " (elapsed: #{elapsed})"
-          elsif eta_ = eta(current)
-            " (ETA: #{eta_})"
-          end
-
-          message = "#{parts.reverse * ' > '}#{timing}"
-          text_message = "#{title_parts.reverse * ' > '}#{timing}"
-
-          if note = running? && @levels.last.note
-            message << " - #{note}"
-            text_message << " - #{note}"
-          end
-
-          message = "\r#{message}\e[K" if stay_on_line?
-          message << "\n" if !stay_on_line? || options[:finish]
-          io << message
-
-          if set_terminal_title?
-            title = options[:finish] ? nil : text_message.to_s.gsub("\a", '␇')
-            io << "\e]0;#{title}\a"
-          end
-        end
-      end
-    end
-
-  end
-end
-
-require 'progress/beeper'
-require 'progress/eta'
-
-require 'progress/enumerable'
-require 'progress/integer'
-require 'progress/active_record' if defined?(ActiveRecord::Base)
-
-module Kernel
-  def Progress(*args, &block)
-    Progress.start(*args, &block)
-  end
-  private :Progress
 end

data/lib/progress/active_record.rb

@@ -1,7 +1,9 @@
 require 'progress'
 
 module ActiveRecord
-  module BatchesWithProgress
+  # Add find_each_with_progress and find_in_batches_with_progress method to
+  # ActiveRecord::Base
+  class Base
     # run `find_each` with progress
     def find_each_with_progress(options = {})
       Progress.start(name.tableize, count(options)) do
@@ -24,8 +26,4 @@ module ActiveRecord
       end
     end
   end
-
-  class Base
-    extend BatchesWithProgress
-  end
 end

data/lib/progress/beeper.rb

@@ -1,4 +1,5 @@
 class Progress
+  # Repeatedly run block of code after time interval
   class Beeper
     def initialize(time, &block)
       @thread = Thread.new do

data/lib/progress/class_methods.rb

@@ -0,0 +1,214 @@
+# encoding: UTF-8
+
+class Progress
+  # Class methods of Progress
+  module ClassMethods
+    def self.extended(klass)
+      klass.instance_variable_set(:@lock, Mutex.new)
+    end
+
+    # start progress indication
+    def start(total = nil, title = nil)
+      init(total, title)
+      print_message :force => true
+      return unless block_given?
+      begin
+        yield
+      ensure
+        stop
+      end
+    end
+
+    # step current progress
+    def step(step = nil, note = nil, &block)
+      if running?
+        ret = @levels.last.step(step, note, &block)
+        print_message
+        ret
+      elsif block
+        block.call
+      end
+    end
+
+    # set value of current progress
+    def set(new_current, note = nil, &block)
+      if running?
+        ret = @levels.last.set(new_current, note, &block)
+        print_message
+        ret
+      elsif block
+        block.call
+      end
+    end
+
+    # stop progress
+    def stop
+      return unless running?
+      if @levels.length == 1
+        print_message :force => true, :finish => true
+        stop_beeper
+      end
+      @levels.pop
+    end
+
+    # check if progress was started
+    def running?
+      @levels && !@levels.empty?
+    end
+
+    # set note
+    def note=(note)
+      return unless running?
+      @levels.last.note = note
+    end
+
+    # stay on one line
+    def stay_on_line?
+      @stay_on_line.nil? ? io_tty? : @stay_on_line
+    end
+
+    # explicitly set staying on one line [true/false/nil]
+    def stay_on_line=(value)
+      @stay_on_line = true && value
+    end
+
+    # highlight output using control characters
+    def highlight?
+      @highlight.nil? ? io_tty? : @highlight
+    end
+
+    # explicitly set highlighting [true/false/nil]
+    def highlight=(value)
+      @highlight = true && value
+    end
+
+    # show progerss in terminal title
+    def terminal_title?
+      @terminal_title.nil? ? io_tty? : @terminal_title
+    end
+
+    # explicitly set showing progress in terminal title [true/false/nil]
+    def terminal_title=(value)
+      @terminal_title = true && value
+    end
+
+  private
+
+    attr_reader :eta
+
+    def init(total = nil, title = nil)
+      lock do
+        if running?
+          unless @started_in == Thread.current
+            warn 'Can\'t start inner progress in different thread'
+            return block_given? ? yield : nil
+          end
+        else
+          @started_in = Thread.current
+          @eta = Eta.new
+          start_beeper
+        end
+        @levels ||= []
+        @levels.push new(total, title)
+      end
+    end
+
+    def lock(force = true)
+      if force
+        @lock.lock
+      else
+        return unless @lock.try_lock
+      end
+
+      begin
+        yield
+      ensure
+        @lock.unlock
+      end
+    end
+
+    def io
+      @io || $stderr
+    end
+
+    def io_tty?
+      io.tty? || ENV['PROGRESS_TTY']
+    end
+
+    def start_beeper
+      @beeper = Beeper.new(10) do
+        print_message
+      end
+    end
+
+    def stop_beeper
+      @beeper.stop if @beeper
+    end
+
+    def restart_beeper
+      @beeper.restart if @beeper
+    end
+
+    def time_to_print?
+      !@next_time_to_print || @next_time_to_print <= Time.now
+    end
+
+    def print_message(options = {})
+      force = options[:force]
+      lock force do
+        if force || time_to_print?
+          @next_time_to_print = Time.now + 0.3
+          restart_beeper
+          io << message_for_output(options)
+        end
+      end
+    end
+
+    def message_for_output(options)
+      message = build_message(options)
+
+      out = ''
+      out << "\r" if stay_on_line?
+      out << message
+      out << "\e[K" if stay_on_line?
+      out << "\n" if !stay_on_line? || options[:finish]
+
+      if terminal_title?
+        out << "\e]0;"
+        unless options[:finish]
+          out << message.gsub(/\e\[\dm/, '').gsub("\a", '␇')
+        end
+        out << "\a"
+      end
+
+      out
+    end
+
+    def build_message(options)
+      current = 0
+      message = @levels.reverse.map do |level|
+        current = level.to_f(current)
+
+        part = current.zero? ? '......' : format('%5.1f%%', current * 100.0)
+
+        if highlight? && part != '100.0%'
+          part = "\e[1m#{part}\e[0m"
+        end
+
+        level.title ? "#{level.title}: #{part}" : part
+      end.reverse * ' > '
+
+      if options[:finish]
+        message << " (elapsed: #{eta.elapsed})"
+      elsif (left = eta.left(current))
+        message << " (ETA: #{left})"
+      end
+
+      if running? && (note = @levels.last.note)
+        message << " - #{note}"
+      end
+
+      message
+    end
+  end
+end