tty-progressbar 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f04f4c768fd866bf975c789315865b20506ee916
-  data.tar.gz: c50d09a231f989552fb19baa5ea81bcb5cc49a5c
+  metadata.gz: ff767a06ae19986026a9fc6bf8542246a66aa114
+  data.tar.gz: ee1b4fdfcf5e032a0f57b45edfc6076b7e44478f
 SHA512:
-  metadata.gz: 3aa6b1cbcb9d6310900ddadf151cc53147dafbba951d34cca60996c30319df9c3d73a1f9c1cac2547c5c64c921b45cc14137cb880dad69c8b473d55f46d0b957
-  data.tar.gz: bddfaf5c090ef9f0552c1e3162ddc150467496aeb4d93103aafa44b71376e633c96687749d6cce3a7bca4a0cafdf38a84af99fddd0b8f2dea673d48b7dba72c7
+  metadata.gz: 8e30d01509fe132b2af4ae89138723a6e8f3fd55a9cd212b83d7a4bcac299d1ca46bb28051d039c75eaf57f30217bd518e4e2727629a5c954896811c4f199a97
+  data.tar.gz: 023f9de9dc08949e1754ffc1caab86d5ad2d06c9f538577049a658e243a5680ae9fbd04a31a07c64e56d9d7cff8cad1d687a07d18ee2576d75342725901e4963

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.4.0 (December 25, 2014)
+
+* Add :total_byte, :current_byte formatters by @vincentjames501
+* Add current= method for updating progress to a given value by @vincentjames501
+* Add ratio= method for updating progress ratio
+
 0.3.0 (December 21, 2014)
 
 * Catch INT signal and cleanly end progress

data/README.md

@@ -40,9 +40,11 @@ Or install it yourself as:
 
 * [1. Usage](#1-usage)
   * [1.1 advance](#11-advance)
-  * [1.2 finish](#12-finish)
-  * [1.3 complete?](#13-complete)
-  * [1.4 resize](#14-resize)
+  * [1.2 current=](#12-current)
+  * [1.3 ratio=](#13-ratio)
+  * [1.4 finish](#14-finish)
+  * [1.5 complete?](#15-complete)
+  * [1.6 resize](#16-resize)
 * [2. Configuration](#2-configuration)
   * [2.1 Frequency](#21-frequency)
 * [3. Formatting](#3-formatting)
@@ -85,7 +87,25 @@ bar.advance(-1)
 
 Note: If a progress bar has already finished then negative steps will not set it back to desired value.
 
-### 1.2 finish
+### 1.2 current=
+
+**TTY::ProgressBar** allows you to set progress to a given value by calling `current=` method.
+
+```ruby
+bar.current = 50
+```
+
+Note: If a progress bar has already finished then negative steps will not set it back to desired value.
+
+### 1.3 ratio=
+
+In order to update overall completion of a progress bar as an exact percentage use the `ratio=` method. The method accepts values between `0` and `1` inclusive. For example, a ratio of 0.5 will attempt to set the progress bar halfway:
+
+```ruby
+bar.ratio = 0.5
+```
+
+### 1.4 finish
 
 In order to immediately stop and finish the progress call `finish`. This will finish drawing the progress and return to new line.
 
@@ -93,7 +113,7 @@ In order to immediately stop and finish the progress call `finish`. This will fi
 bar.finish
 ```
 
-### 1.3 complete?
+### 1.5 complete?
 
 During progresion you can check if bar is finished or not by calling `complete?`.
 
@@ -101,7 +121,7 @@ During progresion you can check if bar is finished or not by calling `complete?`
 bar.complete? # => false
 ```
 
-### 1.4 resize
+### 1.6 resize
 
 If you wish for a progress bar to change it's current width, you can use `resize` by passing in a new desired length:
 
@@ -155,9 +175,10 @@ Every **TTY::ProgressBar** instance requires a format string, which apart from r
 These are the tokens that are currently supported:
 
 * `:bar` the progress bar
-* `:byte` the current progress in bytes
 * `:current` the current progress number
+* `:current_byte` the current progress in bytes
 * `:total` the total progress number
+* `:total_byte` the total progress in bytes
 * `:percent` the completion percentage
 * `:elapsed` the elapsed time in seconds
 * `:eta` the esitmated time to completion in seconds

data/lib/tty/progressbar.rb

@@ -11,12 +11,13 @@ require 'tty/progressbar/pipeline'
 require 'tty/progressbar/formatter'
 
 require 'tty/progressbar/formatter/bar'
-require 'tty/progressbar/formatter/byte'
 require 'tty/progressbar/formatter/current'
+require 'tty/progressbar/formatter/current_byte'
 require 'tty/progressbar/formatter/elapsed'
 require 'tty/progressbar/formatter/estimated'
 require 'tty/progressbar/formatter/percent'
 require 'tty/progressbar/formatter/total'
+require 'tty/progressbar/formatter/total_byte'
 
 module TTY
   # Used for creating terminal progress bar
@@ -109,6 +110,29 @@ module TTY
       render
     end
 
+    # Advance the progress bar to the updated value
+    #
+    # @param [Number] value
+    #   the desired value to updated to
+    #
+    # @api public
+    def current=(value)
+      value = [0, [value, total].min].max
+      advance(value - @current)
+    end
+
+    # Advance the progress bar to an exact ratio.
+    # The target value is set to the closest available value.
+    #
+    # @param [Float] value
+    #   the ratio between 0 and 1 inclusive
+    #
+    # @api public
+    def ratio=(value)
+      target = (value * total).floor
+      advance(target - @current)
+    end
+
     # Ratio of completed over total steps
     #
     # @return [Float]

data/lib/tty/progressbar/formatter.rb

@@ -18,6 +18,7 @@ module TTY
       def load
         @pipeline.use TTY::ProgressBar::CurrentFormatter
         @pipeline.use TTY::ProgressBar::TotalFormatter
+        @pipeline.use TTY::ProgressBar::TotalByteFormatter
         @pipeline.use TTY::ProgressBar::ElapsedFormatter
         @pipeline.use TTY::ProgressBar::EstimatedFormatter
         @pipeline.use TTY::ProgressBar::PercentFormatter

data/lib/tty/progressbar/formatter/current.rb

@@ -6,7 +6,7 @@ module TTY
     #
     # @api private
     class CurrentFormatter
-      MATCHER = /:current/
+      MATCHER = /:current(?!_)/
 
       def initialize(progress)
         @progress = progress

data/lib/tty/progressbar/formatter/{byte.rb → current_byte.rb}

@@ -3,7 +3,7 @@
 module TTY
   class ProgressBar
     class ByteFormatter
-      MATCHER = /:byte/.freeze
+      MATCHER = /:current_byte|:byte/.freeze
       # Used by {Pipeline} to format :byte token
       #
       # @api private

data/lib/tty/progressbar/formatter/total.rb

@@ -3,7 +3,7 @@
 module TTY
   class ProgressBar
     class TotalFormatter
-      MATCHER = /:total/.freeze
+      MATCHER = /:total(?!_)/.freeze
 
       def initialize(progress, *args, &block)
         @progress = progress

data/lib/tty/progressbar/formatter/total_byte.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+module TTY
+  class ProgressBar
+    # Used by {Pipeline} to format :total_byte token
+    #
+    # @api private
+    class TotalByteFormatter
+      MATCHER = /:total_byte/.freeze
+
+      def initialize(progress, *args, &block)
+        @progress = progress
+        @converter = Converter.new
+      end
+
+      # Determines whether this formatter is applied or not.
+      #
+      # @param [Object] value
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def matches?(value)
+        !!(value.to_s =~ MATCHER)
+      end
+
+      def format(value)
+        bytes = @converter.to_bytes(@progress.total)
+        value.gsub(MATCHER, bytes)
+      end
+    end # TotalByteFormatter
+  end # ProgressBar
+end # TTY

data/lib/tty/progressbar/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class ProgressBar
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end # ProgressBar
 end # TTY

data/spec/unit/formatter/{byte_spec.rb → current_byte_spec.rb}

@@ -2,11 +2,11 @@
 
 require 'spec_helper'
 
-RSpec.describe TTY::ProgressBar, '.new' do
+RSpec.describe TTY::ProgressBar, 'current_byte' do
   let(:output) { StringIO.new('', 'w+') }
 
   it "displays bytes processed" do
-    progress = described_class.new(":byte", output: output, total: 102_400)
+    progress = described_class.new(":current_byte", output: output, total: 102_400)
     5.times { progress.advance(20_480) }
     output.rewind
     expect(output.read).to eq([

data/spec/unit/formatter/estimated_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.describe TTY::ProgressBar, '.new' do
+RSpec.describe TTY::ProgressBar, 'estimated' do
   let(:output) { StringIO.new('', 'w+') }
 
   before { Timecop.safe_mode = false }

data/spec/unit/formatter/total_byte_spec.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'total_byte' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "displays bytes total" do
+    progress = described_class.new(":total_byte", output: output, total: 102_400)
+    5.times { progress.advance(20_480) }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G100.00KB",
+      "\e[1G100.00KB",
+      "\e[1G100.00KB",
+      "\e[1G100.00KB",
+      "\e[1G100.00KB\n"
+    ].join)
+  end
+end

data/spec/unit/formatter/total_spec.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'total' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "displays bytes total" do
+    progress = described_class.new(":total", output: output, total: 102_400)
+    5.times { progress.advance(20_480) }
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G102400",
+      "\e[1G102400",
+      "\e[1G102400",
+      "\e[1G102400",
+      "\e[1G102400\n"
+    ].join)
+  end
+end

data/spec/unit/ratio_spec.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'ratio=' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "allows to set ratio" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
+    progress.ratio = 0.7
+    expect(progress.current).to eq(7)
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[=======   ]"
+    ].join)
+  end
+
+  it "finds closest available step from the ratio" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 3)
+    progress.ratio = 0.5
+    expect(progress.current).to eq(1)
+  end
+end

data/spec/unit/set_current_spec.rb

@@ -0,0 +1,47 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe TTY::ProgressBar, 'current=' do
+  let(:output) { StringIO.new('', 'w+') }
+
+  it "allows to go back" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
+    3.times { progress.advance }
+    progress.current = 5
+    expect(progress.current).to eq(5)
+    output.rewind
+    expect(output.read).to eq([
+      "\e[1G[=         ]",
+      "\e[1G[==        ]",
+      "\e[1G[===       ]",
+      "\e[1G[=====     ]"
+    ].join)
+    progress.current = 0
+    expect(progress.current).to eq(0)
+  end
+
+  it "doesn't allow to go over total" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
+    progress.current = 12
+    expect(progress.current).to eq(10)
+    output.rewind
+    expect(output.read).to eq("\e[1G[==========]\n")
+  end
+
+  it "doesn't allow to go below 0" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
+    progress.current = -1
+    expect(progress.current).to eq(0)
+  end
+
+  it "cannot backtrack on finished" do
+    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
+    progress.current = 10
+    expect(progress.current).to eq(10)
+    progress.current = 5
+    expect(progress.current).to eq(10)
+    output.rewind
+    expect(output.read).to eq("\e[1G[==========]\n")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-progressbar
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2014-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen
@@ -62,12 +62,13 @@ files:
 - lib/tty/progressbar/converter.rb
 - lib/tty/progressbar/formatter.rb
 - lib/tty/progressbar/formatter/bar.rb
-- lib/tty/progressbar/formatter/byte.rb
 - lib/tty/progressbar/formatter/current.rb
+- lib/tty/progressbar/formatter/current_byte.rb
 - lib/tty/progressbar/formatter/elapsed.rb
 - lib/tty/progressbar/formatter/estimated.rb
 - lib/tty/progressbar/formatter/percent.rb
 - lib/tty/progressbar/formatter/total.rb
+- lib/tty/progressbar/formatter/total_byte.rb
 - lib/tty/progressbar/pipeline.rb
 - lib/tty/progressbar/version.rb
 - spec/spec_helper.rb
@@ -78,17 +79,21 @@ files:
 - spec/unit/converter/to_time_spec.rb
 - spec/unit/custom_formatter_spec.rb
 - spec/unit/formatter/bar_spec.rb
-- spec/unit/formatter/byte_spec.rb
+- spec/unit/formatter/current_byte_spec.rb
 - spec/unit/formatter/current_spec.rb
 - spec/unit/formatter/elapsed_spec.rb
 - spec/unit/formatter/estimated_spec.rb
 - spec/unit/formatter/percent_spec.rb
+- spec/unit/formatter/total_byte_spec.rb
+- spec/unit/formatter/total_spec.rb
 - spec/unit/frequency_spec.rb
 - spec/unit/hide_cursor_spec.rb
 - spec/unit/log_spec.rb
 - spec/unit/new_spec.rb
 - spec/unit/pipeline_spec.rb
+- spec/unit/ratio_spec.rb
 - spec/unit/resize_spec.rb
+- spec/unit/set_current_spec.rb
 - spec/unit/width_spec.rb
 - tasks/console.rake
 - tasks/coverage.rake
@@ -127,16 +132,20 @@ test_files:
 - spec/unit/converter/to_time_spec.rb
 - spec/unit/custom_formatter_spec.rb
 - spec/unit/formatter/bar_spec.rb
-- spec/unit/formatter/byte_spec.rb
+- spec/unit/formatter/current_byte_spec.rb
 - spec/unit/formatter/current_spec.rb
 - spec/unit/formatter/elapsed_spec.rb
 - spec/unit/formatter/estimated_spec.rb
 - spec/unit/formatter/percent_spec.rb
+- spec/unit/formatter/total_byte_spec.rb
+- spec/unit/formatter/total_spec.rb
 - spec/unit/frequency_spec.rb
 - spec/unit/hide_cursor_spec.rb
 - spec/unit/log_spec.rb
 - spec/unit/new_spec.rb
 - spec/unit/pipeline_spec.rb
+- spec/unit/ratio_spec.rb
 - spec/unit/resize_spec.rb
+- spec/unit/set_current_spec.rb
 - spec/unit/width_spec.rb
 has_rdoc: