tty-progressbar 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 356470af4dabd6c724cfbd789049429e2e000a0c
-  data.tar.gz: f4cdce3fbfeaa7b2bced0ffb067982a850fb7358
+  metadata.gz: 2eaaf2c7343d9acdfb829ee31ce58673a0e57874
+  data.tar.gz: 6b7b3f3e8ccef0d0ce4eadb728404b11113330b3
 SHA512:
-  metadata.gz: 2e5ab9947f5627d78b9bb1d9471b8c166dc856c35ec224b19fd37481938bf00c1efda00dfce1ab6de056d5da7f56c72b6a5ec1acdb7008b36833adfc7f917dd1
-  data.tar.gz: 8ff67c8713892e9ed15b7c046ce0d48c3f88fb6fae7153895d56faa9bc2f7c38c4b0ab127f6d5ceab6dd9292c81fdd55ffb3af11755a4206917bce5962d46412
+  metadata.gz: c51b18a4f26219bf19628fd1c406e2cfd94d6857fb236c304a535a68723828b21e86f851d8ef524453c77761cada81e1804162d5278f06149921b31c66964ffe
+  data.tar.gz: b6b3f6800919a9b5dbc31edf85b35c23da38760c3dd580aa611febd0870fa42424bfcb7e44b61dbdd7a14d02d08f05ccd915fb1e5a4e1399b3840e33897c1c1d

data/.travis.yml

@@ -6,9 +6,10 @@ script: "bundle exec rake ci"
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - 2.3.0
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
   - ruby-head
   - jruby-9000
   - jruby-head

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change log
 
+## [v0.11.0] - 2017-04-04
+
+### Added
+* Add :decimals, :separator, :unit_separator to Converter#to_bytes
+* Add ability to Converter#to_bytes to calculate higher sizes TB, PB & EB
+
+### Changed
+* Change files loading
+* Change Converter to be a module
+
+### Fixed
+* Fix :byte_rate token to correctly format bytes
+
 ## [v0.10.1] - 2016-12-26
 
 ### Fixed
@@ -95,6 +108,7 @@
 
 * Initial implementation and release
 
+[v0.11.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.10.1...v0.11.0
 [v0.10.1]: https://github.com/peter-murach/tty-progressbar/compare/v0.10.0...v0.10.1
 [v0.10.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.9.0...v0.10.0
 [v0.9.0]: https://github.com/peter-murach/tty-progressbar/compare/v0.8.2...v0.9.0

data/Gemfile

@@ -3,15 +3,15 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'rspec',   '~> 3.4.0'
-  gem 'yard',    '~> 0.8.7'
-  gem 'timecop', '~> 0.7.1'
-  gem 'pastel',  '~> 0.6.0'
+  gem 'rspec',   '~> 3.5.0'
+  gem 'timecop', '~> 0.8.1'
+  gem 'pastel',  '~> 0.7.0'
   gem 'coveralls', '~> 0.8.13'
   gem 'simplecov', '~> 0.11.2'
   gem 'term-ansicolor', '=1.3.2'
 end
 
 group :metrics do
+  gem 'yard',      '~> 0.8.7'
   gem 'yardstick', '~> 0.9.9'
 end

data/README.md

@@ -386,4 +386,4 @@ downloading [=======================       ] 4.12MB/s
 
 ## Copyright
 
-Copyright (c) 2014-2016 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2014-2017 Piotr Murach. See LICENSE for further details.

data/lib/tty-progressbar.rb

@@ -1,27 +1,3 @@
 # coding: utf-8
 
-require 'io/console'
-require 'forwardable'
-require 'tty-screen'
-
-require 'tty/progressbar/configuration'
-require 'tty/progressbar/converter'
-require 'tty/progressbar/version'
-require 'tty/progressbar/pipeline'
-require 'tty/progressbar/formatter'
-require 'tty/progressbar/meter'
-
-require 'tty/progressbar/formatter/bar'
-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/rate'
-require 'tty/progressbar/formatter/byte_rate'
-require 'tty/progressbar/formatter/mean_rate'
-require 'tty/progressbar/formatter/mean_byte'
-require 'tty/progressbar/formatter/total'
-require 'tty/progressbar/formatter/total_byte'
-
 require 'tty/progressbar'

data/lib/tty/progressbar.rb

@@ -1,5 +1,14 @@
 # coding: utf-8
 
+require 'io/console'
+require 'forwardable'
+require 'tty-screen'
+
+require_relative 'progressbar/configuration'
+require_relative 'progressbar/formatter'
+require_relative 'progressbar/meter'
+require_relative 'progressbar/version'
+
 module TTY
   # Used for creating terminal progress bar
   #
@@ -57,7 +66,7 @@ module TTY
     # @api public
     def initialize(format, options = {})
       @format        = format
-      @configuration = Configuration.new(options)
+      @configuration = TTY::ProgressBar::Configuration.new(options)
       yield @configuration if block_given?
 
       @width             = 0 if no_width
@@ -71,7 +80,7 @@ module TTY
       @started           = false
       @tokens            = {}
       @formatter         = TTY::ProgressBar::Formatter.new
-      @meter             = Meter.new(options.fetch(:interval, 1))
+      @meter             = TTY::ProgressBar::Meter.new(options.fetch(:interval, 1))
 
       @formatter.load
     end

data/lib/tty/progressbar/converter.rb

@@ -5,7 +5,7 @@ module TTY
     # Responsible for converting values to different formats
     #
     # @api public
-    class Converter
+    module Converter
       HOURSECONDS = 3600
 
       # Convert seconds to time notation
@@ -30,6 +30,7 @@ module TTY
           sprintf('%2ds', seconds)
         end
       end
+      module_function :to_time
 
       # Convert seconds to set precision
       #
@@ -44,30 +45,45 @@ module TTY
         precision ||= (seconds < 1 && !seconds.zero?) ? 5 : 2
         sprintf "%5.#{precision}f", seconds
       end
+      module_function :to_seconds
 
-      KILOBYTE = 1024
-      MEGABYTE = KILOBYTE * 1024
-      GIGABYTE = MEGABYTE * 1024
+      BYTE_UNITS = %w(b kb mb gb tb pb eb).freeze
 
       # Convert value to bytes
       #
       # @param [Numeric] value
       #   the value to convert to bytes
+      # @param [Hash[Symbol]] options
+      # @option [Integer] :decimals
+      #   the number of decimals parts
+      # @option [String] :separator
+      #   the separator to use for thousands in a number
+      # @option [String] :unit_separator
+      #   the separtor to use between number and unit
       #
       # @return [String]
       #
       # @api public
-      def to_bytes(value)
-        if value >= GIGABYTE
-          sprintf('%.2f', value / GIGABYTE.to_f) + 'GB'
-        elsif value >= MEGABYTE
-          sprintf('%.2f', value / MEGABYTE.to_f) + 'MB'
-        elsif value >= KILOBYTE
-          sprintf('%.2f', value / KILOBYTE.to_f) + 'KB'
+      def to_bytes(value, options = {})
+        decimals       = options.fetch(:decimals) { 2 }
+        separator      = options.fetch(:separator) { '.' }
+        unit_separator = options.fetch(:unit_separator) { '' }
+
+        base    = 1024
+        pattern = "%.#{decimals}f"
+
+        unit = BYTE_UNITS.find.with_index { |_, i| value < base ** (i + 1) }
+
+        if value < base
+          formatted_value = value.to_i.to_s
         else
-          value.to_s + 'B'
+          value_to_size = value / (base ** BYTE_UNITS.index(unit)).to_f
+          formatted_value = format(pattern, value_to_size)
         end
+
+        formatted_value.gsub(/\./, separator) + unit_separator + unit.to_s.upcase
       end
+      module_function :to_bytes
     end # Converter
   end # ProgressBar
 end # TTY

data/lib/tty/progressbar/formatter.rb

@@ -1,5 +1,20 @@
 # coding: utf-8
 
+require_relative 'pipeline'
+
+require_relative 'formatter/bar'
+require_relative 'formatter/current'
+require_relative 'formatter/current_byte'
+require_relative 'formatter/elapsed'
+require_relative 'formatter/estimated'
+require_relative 'formatter/percent'
+require_relative 'formatter/rate'
+require_relative 'formatter/byte_rate'
+require_relative 'formatter/mean_rate'
+require_relative 'formatter/mean_byte'
+require_relative 'formatter/total'
+require_relative 'formatter/total_byte'
+
 module TTY
   class ProgressBar
     class Formatter

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

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require_relative '../converter'
+
 module TTY
   class ProgressBar
     # Used by {Pipeline} to format :byte_rate token
@@ -9,8 +11,7 @@ module TTY
       MATCHER = /:byte_rate/i
 
       def initialize(progress)
-        @progress  = progress
-        @converter = Converter.new
+        @progress = progress
       end
 
       # Determines whether this formatter is applied or not.
@@ -31,7 +32,7 @@ module TTY
       #
       # @api public
       def format(value)
-        formatted = @converter.to_bytes(@progress.rate)
+        formatted = Converter.to_bytes(@progress.rate)
         value.gsub(MATCHER, formatted)
       end
     end # ByteRateFormatter

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

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require_relative '../converter'
+
 module TTY
   class ProgressBar
     # Used by {Pipeline} to format :byte and :current_byte tokens
@@ -10,7 +12,6 @@ module TTY
 
       def initialize(progress)
         @progress = progress
-        @converter = Converter.new
       end
 
       # Determines whether this formatter is applied or not.
@@ -25,7 +26,7 @@ module TTY
       end
 
       def format(value)
-        bytes = @converter.to_bytes(@progress.current)
+        bytes = Converter.to_bytes(@progress.current)
         value.gsub(MATCHER, bytes)
       end
     end # ByteFormatter

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

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require_relative '../converter'
+
 module TTY
   class ProgressBar
     # Used by {Pipeline} to format :elapsed token
@@ -10,7 +12,6 @@ module TTY
 
       def initialize(progress)
         @progress  = progress
-        @converter = Converter.new
       end
 
       # Determines whether this formatter is applied or not.
@@ -26,7 +27,7 @@ module TTY
 
       def format(value)
         elapsed = (Time.now - @progress.start_at)
-        value.gsub(MATCHER, @converter.to_time(elapsed))
+        value.gsub(MATCHER, Converter.to_time(elapsed))
       end
     end # ElapsedFormatter
   end # ProgressBar

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

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require_relative '../converter'
+
 module TTY
   class ProgressBar
     # Used by {Pipeline} to format :eta token
@@ -10,7 +12,6 @@ module TTY
 
       def initialize(progress)
         @progress  = progress
-        @converter = Converter.new
       end
 
       # Determines whether this formatter is applied or not.
@@ -28,7 +29,7 @@ module TTY
         elapsed   = Time.now - @progress.start_at
         estimated = (elapsed / @progress.ratio).to_f - elapsed
         estimated = (estimated.infinite? || estimated < 0) ? 0.0 : estimated
-        value.gsub(MATCHER, @converter.to_time(estimated))
+        value.gsub(MATCHER, Converter.to_time(estimated))
       end
     end # ElapsedFormatter
   end # ProgressBar

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

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require_relative '../converter'
+
 module TTY
   class ProgressBar
     # Used by {Pipeline} to format :mean_byte token
@@ -10,7 +12,6 @@ module TTY
 
       def initialize(progress)
         @progress  = progress
-        @converter = Converter.new
       end
 
       # Determines whether this formatter is applied or not.
@@ -31,7 +32,7 @@ module TTY
       #
       # @api public
       def format(value)
-        formatted = @converter.to_bytes(@progress.mean_rate)
+        formatted = Converter.to_bytes(@progress.mean_rate)
         value.gsub(MATCHER, formatted)
       end
     end # MeanByteFormatter

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

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require_relative '../converter'
+
 module TTY
   class ProgressBar
     # Used by {Pipeline} to format :mean_rate token
@@ -10,7 +12,6 @@ module TTY
 
       def initialize(progress)
         @progress  = progress
-        @converter = Converter.new
       end
 
       # Determines whether this formatter is applied or not.
@@ -31,7 +32,7 @@ module TTY
       #
       # @api public
       def format(value)
-        formatted = @converter.to_seconds(@progress.mean_rate)
+        formatted = Converter.to_seconds(@progress.mean_rate)
         value.gsub(MATCHER, formatted)
       end
     end # MeanRateFormatter

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

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require_relative '../converter'
+
 module TTY
   class ProgressBar
     # Used by {Pipeline} to format :rate token
@@ -10,7 +12,6 @@ module TTY
 
       def initialize(progress)
         @progress  = progress
-        @converter = Converter.new
       end
 
       # Determines whether this formatter is applied or not.
@@ -31,7 +32,7 @@ module TTY
       #
       # @api public
       def format(value)
-        formatted = @converter.to_seconds(@progress.rate)
+        formatted = Converter.to_seconds(@progress.rate)
         value.gsub(MATCHER, formatted)
       end
     end # RateFormatter

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

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require_relative '../converter'
+
 module TTY
   class ProgressBar
     # Used by {Pipeline} to format :total_byte token
@@ -10,7 +12,6 @@ module TTY
 
       def initialize(progress, *args, &block)
         @progress = progress
-        @converter = Converter.new
       end
 
       # Determines whether this formatter is applied or not.
@@ -25,7 +26,7 @@ module TTY
       end
 
       def format(value)
-        bytes = @converter.to_bytes(@progress.total)
+        bytes = Converter.to_bytes(@progress.total)
         value.gsub(MATCHER, bytes)
       end
     end # TotalByteFormatter

data/lib/tty/progressbar/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class ProgressBar
-    VERSION = '0.10.1'
+    VERSION = '0.11.0'
   end # ProgressBar
 end # TTY

data/spec/unit/converter/to_bytes_spec.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 RSpec.describe TTY::ProgressBar::Converter, '#to_bytes' do
-  subject(:converter) { described_class.new }
+  subject(:converter) { described_class }
 
   it "converts 1000 to bytes" do
     expect(converter.to_bytes(1000)).to eq('1000B')
@@ -11,10 +11,34 @@ RSpec.describe TTY::ProgressBar::Converter, '#to_bytes' do
     expect(converter.to_bytes(1024)).to eq('1.00KB')
   end
 
+  it "converts 1234 to bytes" do
+    expect(converter.to_bytes(1234)).to eq('1.21KB')
+  end
+
+  it "converts 12345 to bytes" do
+    expect(converter.to_bytes(12345)).to eq('12.06KB')
+  end
+
   it "converts 2000 to bytes" do
     expect(converter.to_bytes(2000)).to eq('1.95KB')
   end
 
+  it "converts 1234567 to bytes" do
+    expect(converter.to_bytes(1234567)).to eq('1.18MB')
+  end
+
+  it "converts 1234567 to bytes with :separator" do
+    expect(converter.to_bytes(1234567, separator: ',')).to eq('1,18MB')
+  end
+
+  it "converts 1234567 to bytes with :unit_separator" do
+    expect(converter.to_bytes(1234567, unit_separator: ' ')).to eq('1.18 MB')
+  end
+
+  it "converts 1234567 to bytes with comma as a separator" do
+    expect(converter.to_bytes(1234567, decimals: 1)).to eq('1.2MB')
+  end
+
   it "converts 10_000_000 to bytes" do
     expect(converter.to_bytes(10_000_000)).to eq('9.54MB')
   end

data/spec/unit/converter/to_seconds_spec.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 RSpec.describe TTY::ProgressBar::Converter, '#to_seconds' do
-  subject(:converter) { described_class.new }
+  subject(:converter) { described_class }
 
   it "ensure 5 digit precision for < 1" do
     expect(converter.to_seconds(0.000005)).to eq("0.00001")

data/spec/unit/converter/to_time_spec.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 RSpec.describe TTY::ProgressBar::Converter, '#to_time' do
-  subject(:converter) { described_class.new }
+  subject(:converter) { described_class }
 
   it "converts seconds to seconds" do
     expect(converter.to_time(15)).to eq("15s")

data/spec/unit/formatter/byte_rate_spec.rb

@@ -24,8 +24,8 @@ RSpec.describe TTY::ProgressBar, ':byte_rate token' do
     output.rewind
     expect(output.read).to eq([
       "\e[1G0B",
-      "\e[1G500.0B",
-      "\e[1G1000.0B",
+      "\e[1G500B",
+      "\e[1G1000B",
       "\e[1G1.46KB",
       "\e[1G1.95KB\n"
     ].join)

data/spec/unit/formatter/mean_byte_spec.rb

@@ -24,9 +24,9 @@ RSpec.describe TTY::ProgressBar, ':mean_byte token' do
     output.rewind
     expect(output.read).to eq([
       "\e[1G0B",
-      "\e[1G500.0B",
-      "\e[1G750.0B",
-      "\e[1G1000.0B",
+      "\e[1G500B",
+      "\e[1G750B",
+      "\e[1G1000B",
       "\e[1G1.22KB\n"
     ].join)
     Timecop.return

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-progressbar
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-26 00:00:00.000000000 Z
+date: 2017-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-screen