task_progress_bar 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53e1bc827b8d7885c89d980d2433330585da7364
-  data.tar.gz: a63abda8d0d22d3d7d28782d4d7180ac300c40de
+  metadata.gz: 4951398aea0825dace0480f6e313f6365c39d978
+  data.tar.gz: 0351e5f1ca45b52f21ddf1efd1092feaa57aeb17
 SHA512:
-  metadata.gz: 2c0eb9eafefc25073a218240d00030fa8847469e16da8e62c826d4ad49cba5122fa83f68188c58fe7e3db6069567dd99b8ecc44ae0d849d2ee6bdd838d70fd11
-  data.tar.gz: 27cbe91a94ca1e5bb7b253e99e164d4a5461410cd9ba7c2a8a50ea407974f1fdb5d4bfb3be2c1ac5b0d362184b2d15d6b7a238920c538889b624fdc19805e090
+  metadata.gz: bbb158cd59484f899dce00491e57ec29adbb0d7b9e64786c775953a43c105bd64a606fa1737f9dbdfacb634d305cdda2da5ac34b01db7799ab9e10f2be8f1599
+  data.tar.gz: e04dbcec0e6f8476107fcae0194ffc20cd5d22828a0d2615eec3a2c3270ccf1c5a28f28f8e79235203cdf468204a9254e73193be2e56887e3ce08348fb7afa13

data/README.md

@@ -1 +1,23 @@
-# task_progress_bar
+# TaskProgressBar
+
+[![Gem Version](https://badge.fury.io/rb/task_progress_bar.svg)](https://badge.fury.io/rb/task_progress_bar)
+[![Build Status](https://api.travis-ci.org/douglasresende/task_progress_bar.svg?branch=master)](https://travis-ci.org/douglasresende/task_progress_bar)
+
+## Getting started
+
+```ruby
+bar = TaskProgressBar.new( 100 )
+1..10.times{ bar.step() }
+# output
+[10/100][#####                                             ][10%][00:00:01][00:00:15]
+```
+
+### Contributors
+
+https://github.com/douglasresende/task_progress_bar/graphs/contributors
+
+## License
+
+MIT License. Copyright 2017 Douglas Resende. http://github.com/douglasresende/task_progress_bar
+
+You are not granted rights or licenses to the trademarks of Plataformatec, including without limitation the Devise name or logo.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/test_*.rb']
+  t.warning    = true
+  t.verbose    = true
+end
+
+desc "Run tests"
+task :default => [:test]

data/lib/task_progress_bar.rb

@@ -0,0 +1,69 @@
+require 'task_progress_bar/version'
+
+class TaskProgressBar
+  def initialize(total)
+    @total      = total || 1
+    @total_bar  = ( total < 50 ? total : 50 )
+    @start_time = Time.now
+    @i          = 0
+  end
+
+  def step
+    self.count
+    STDOUT.print self.bar
+  end
+
+  def bar
+    "\r[%d/%d][%s][%d%%][%s][%s]" % [@i, @total, green_elapsed_bar, elapsed_percent, elapsed_time_formated, time_left]
+  end
+
+  def count(value = 1)
+    @i += value
+  end
+
+  def symbol
+    '#'
+  end
+
+  def total_progress
+    @total / @total_bar
+  end
+
+  def bar_quantity
+    ((@i*1.00/total_progress).to_i)
+  end
+
+  def green_elapsed_bar
+    "\033[32m#{ elapsed_bar }\033[0m"
+  end
+
+  def elapsed_bar
+    "%-#{@total_bar}s" % [symbol * bar_quantity]
+  end
+
+  def elapsed_percent
+    ((@i*1.00/@total)*100).to_i
+  end
+
+  def elapsed_time
+    Time.now - @start_time
+  end
+
+  def elapsed_time_formated
+    time_formated( elapsed_time )
+  end
+
+  def time_left_in_seconds
+    return 0 if @i == 0
+    ( (elapsed_time / @i) * (@total.to_f - @i) ).to_i
+  end
+
+  def time_left
+    time_formated( time_left_in_seconds )
+  end
+
+  def time_formated( value )
+    Time.at( value ).utc.strftime("%H:%M:%S")
+  end
+end
+

data/lib/task_progress_bar/version.rb

@@ -0,0 +1,3 @@
+class TaskProgressBar
+  VERSION = '1.0.1'
+end

data/task_progress_bar.gemspec

@@ -0,0 +1,18 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'task_progress_bar/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'task_progress_bar'
+  s.version       = TaskProgressBar::VERSION
+  s.authors       = ['Douglas R Camargo']
+  s.email         = ['douglas@maxstudio.com.br']
+  s.homepage      = 'https://github.com/douglasresende/task_progress_bar'
+  s.description   = %q{A simple Ruby gem to show in terminal a progress bar as a task monitor, step by step.}
+  s.summary       = %q{A simple Ruby gem to show in terminal a progress bar as a task monitor, step by step.}
+  s.date          = %q{2017-03-01}
+  s.license       = 'MIT'
+
+  s.require_paths = ['lib']
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require File.dirname(__FILE__) + '/../lib/task_progress_bar'

data/test/test_task_progress_bar.rb

@@ -0,0 +1,154 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+describe TaskProgressBar do
+  parallelize_me!
+
+  let(:total)            { 100 }
+  let(:task_progress_bar){ TaskProgressBar.new( total ) }
+
+  describe '#step' do
+    subject { task_progress_bar.step() }
+
+    it 'returns the output bar string' do
+      expected_result = ''
+      STDOUT.stub :print, expected_result do
+        assert_equal expected_result, subject
+      end
+    end
+  end
+
+  describe '#bar' do
+    subject { task_progress_bar.bar() }
+
+    it 'should return a Bar as a string' do
+      expected_result = "\r[0/100][##   ][0%][00:00:00][00:00:01]"
+
+      task_progress_bar.stub(:green_elapsed_bar, '##   ') do
+        task_progress_bar.stub(:elapsed_percent, 0) do
+          task_progress_bar.stub(:elapsed_time_formated, '00:00:00') do
+            task_progress_bar.stub(:time_left, '00:00:01') do
+              assert_equal expected_result, subject
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe '#count' do
+    describe 'value default' do
+      subject { task_progress_bar.count() }
+
+      it 'should sum @i with 1' do
+        assert_equal 1, subject
+      end
+
+      describe 'many count method called' do
+        it 'it should sum @i many count method called' do
+          task_progress_bar.count()
+          task_progress_bar.count()
+          task_progress_bar.count()
+          task_progress_bar.count()
+          assert_equal 5, subject
+        end
+      end
+    end
+
+    describe 'value by param' do
+      subject { task_progress_bar.count( 3 ) }
+
+      it 'should sum @i with value' do
+        assert_equal 3, subject
+      end
+    end
+  end
+
+  describe '#symbol' do
+    subject { task_progress_bar.symbol }
+
+    it 'should return the default symbol' do
+      assert_equal '#', subject
+    end
+  end
+
+  describe '#green_elapsed_bar' do
+    subject { task_progress_bar.green_elapsed_bar() }
+
+    it 'return the elapsed_bar with green terminal output string' do
+      expected_result = 10
+      task_progress_bar.stub(:elapsed_bar, expected_result) do
+        assert_equal "\033[32m#{ expected_result }\033[0m", subject
+      end
+    end
+  end
+
+  describe '#elapsed_bar' do
+    it 'returns the string with percentage and symbols bar quantity' do
+      task_progress_bar.count()
+      task_progress_bar.stub :bar_quantity, 10 do
+        assert_equal task_progress_bar.elapsed_bar, "##########                                        "
+      end
+    end
+  end
+
+  describe '#elapsed_percent' do
+    it 'returns the integer percentage' do
+      0..(total/2).times { task_progress_bar.count() }
+      assert_equal 50, task_progress_bar.elapsed_percent
+    end
+  end
+
+  describe '#elapsed_time' do
+    it 'should return the Time now less @start_time' do
+      task_progress_bar.count()
+      Time.stub :now, Time.at( Time.now.to_i + 11 ) do
+        assert_equal 10, task_progress_bar.elapsed_time.to_i
+      end
+    end
+  end
+
+  describe '#elapsed_time_formated' do
+    it 'should return the Time now less @start_time formated with %H:%M:%S' do
+      task_progress_bar.count()
+      Time.stub :now, Time.at( Time.now.to_i + 11 ) do
+        assert_equal '00:00:10', task_progress_bar.elapsed_time_formated
+      end
+    end
+  end
+
+  describe '#time_left_in_seconds' do
+    subject { task_progress_bar.time_left_in_seconds }
+
+    describe '@i is zero' do
+      it 'should return 0' do
+        assert_equal 0, subject
+      end
+    end
+
+    describe '@i isnt zero' do
+      it 'should return the time elapsed in seconds' do
+        0..50.times { task_progress_bar.count() }
+
+        Time.stub :now, Time.at( Time.now.to_i + 11 ) do
+          assert_equal 10, subject
+        end
+      end
+    end
+  end
+
+  describe '#time_left' do
+    it 'should return the Time at time_left_in_seconds formated with %H:%M:%S' do
+      task_progress_bar.stub :time_left_in_seconds, 3930 do
+        assert_equal '01:05:30', task_progress_bar.time_left
+      end
+    end
+  end
+
+  describe '#time_formated' do
+    it 'should return the Time formated with %H:%M:%S' do
+      value = Time.at( 3930 )
+      assert_equal '01:05:30', task_progress_bar.time_formated( value )
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: task_progress_bar
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Douglas R Camargo
@@ -20,6 +20,12 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - README.md
+- Rakefile
+- lib/task_progress_bar.rb
+- lib/task_progress_bar/version.rb
+- task_progress_bar.gemspec
+- test/test_helper.rb
+- test/test_task_progress_bar.rb
 homepage: https://github.com/douglasresende/task_progress_bar
 licenses:
 - MIT
@@ -45,4 +51,6 @@ signing_key:
 specification_version: 4
 summary: A simple Ruby gem to show in terminal a progress bar as a task monitor, step
   by step.
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/test_task_progress_bar.rb