tty-progressbar 0.17.0 → 0.18.0

data/examples/multi/width.rb

@@ -1,13 +0,0 @@
-require_relative '../../lib/tty-progressbar'
-
-bars = TTY::ProgressBar::Multi.new("main [:bar] :percent")
-
-bar1 = bars.register "foo [:bar] :percent", total: 150
-bar2 = bars.register "bar [:bar] :percent", total: 250
-bar3 = bars.register "baz [:bar] :percent", total: 100
-
-th1 = Thread.new { 15.times { sleep(0.1); bar1.advance(10) } }
-th2 = Thread.new { 50.times { sleep(0.1); bar2.advance(5)} }
-th3 = Thread.new { 50.times { sleep(0.1); bar3.advance(5) } }
-
-[th1, th2, th3].each(&:join)

data/examples/simple.rb

@@ -1,7 +0,0 @@
-require_relative '../lib/tty-progressbar'
-
-bar = TTY::ProgressBar.new("downloading [:bar] :elapsed :percent", total: 30)
-30.times do
-  sleep(0.1)
-  bar.advance
-end

data/examples/slow_process.rb

@@ -1,29 +0,0 @@
-require_relative '../lib/tty-progressbar'
-
-CONTENT_SIZE = 2048
-CHUNK_SIZE = 255
-
-# Dummy "long responding server"
-def download_from_server(offset, limit)
-  sleep(0.1)
-  "<chunk #{offset}..#{offset + limit}>"
-end
-
-def download_finished?(position)
-  position >= CONTENT_SIZE
-end
-
-downloader = Enumerator.new do |y|
-  start = 0
-  loop do
-    y.yield(download_from_server(start, CHUNK_SIZE))
-    start += CHUNK_SIZE
-    raise StopIteration if download_finished?(start)
-  end
-end
-
-bar = TTY::ProgressBar.new("[:bar] :current_byte/:total_byte", total: CONTENT_SIZE)
-
-response = bar.iterate(downloader, CHUNK_SIZE).to_a.join
-
-puts response

data/examples/speed.rb

@@ -1,11 +0,0 @@
-require_relative '../lib/tty-progressbar'
-
-bar = TTY::ProgressBar.new "downloading [:bar] :rate/s :mean_rate/s" do |conf|
-  conf.total = 100
-  conf.interval = 1
-end
-
-30.times do
-  sleep(0.1)
-  bar.advance(Random.rand(10))
-end

data/examples/threaded.rb

@@ -1,14 +0,0 @@
-require_relative '../lib/tty-progressbar'
-
-threads = []
-
-bar = TTY::ProgressBar.new("[:bar] :percent", total: 30)
-
-threads << Thread.new {
-  15.times { sleep(0.1); bar.update(complete: '-', head: '-'); bar.advance(); }
-}
-threads << Thread.new {
-  15.times { sleep(0.1); bar.update(complete: '+', head: '+'); bar.advance(); }
-}
-
-threads.map(&:join)

data/examples/tokens.rb

@@ -1,12 +0,0 @@
-require_relative '../lib/tty-progressbar'
-
-files = [
-  'file1.txt', 'file2.txt', 'file3.txt', 'file4.txt', 'file5.txt',
-  'file6.txt', 'file7.txt', 'file8.txt', 'file9.txt', 'file10.txt'
-]
-
-bar = TTY::ProgressBar.new("downloading :file :percent", total: files.size)
-10.times do |num|
-  sleep(0.1)
-  bar.advance(file: files[num])
-end

data/examples/unicode.rb

@@ -1,7 +0,0 @@
-require_relative '../lib/tty-progressbar'
-
-bar = TTY::ProgressBar.new("Unicode [:bar]", total: 30, complete: 'あ')
-30.times do
-  sleep(0.1)
-  bar.advance
-end

data/spec/spec_helper.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-if ENV['COVERAGE'] || ENV['TRAVIS']
-  require 'simplecov'
-  require 'coveralls'
-
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ])
-
-  SimpleCov.start do
-    command_name 'spec'
-    add_filter 'spec'
-  end
-end
-
-require 'timecop'
-require 'tty-progressbar'
-
-class StringIO
-  undef_method :tty?
-  def tty?
-    true
-  end
-end
-
-RSpec.configure do |config|
-  config.expect_with :rspec do |expectations|
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  config.mock_with :rspec do |mocks|
-    mocks.verify_partial_doubles = true
-  end
-
-  # Limits the available syntax to the non-monkey patched syntax that is recommended.
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  if config.files_to_run.one?
-    config.default_formatter = 'doc'
-  end
-
-  config.profile_examples = 2
-
-  config.order = :random
-
-  Kernel.srand config.seed
-end

data/spec/unit/advance_spec.rb

@@ -1,25 +0,0 @@
-RSpec.describe TTY::ProgressBar, '#advance' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  it "advances by custom value" do
-    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
-    progress.advance(8)
-    expect(progress.current).to eq(8)
-  end
-
-  it "allows to go back" do
-    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
-    5.times { progress.advance(1) }
-    expect(progress.current).to eq(5)
-    5.times { progress.advance(-1) }
-    expect(progress.current).to eq(0)
-  end
-
-  it "cannot backtrack on finished" do
-    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
-    10.times { progress.advance(1) }
-    expect(progress.current).to eq(10)
-    5.times { progress.advance(-1) }
-    expect(progress.current).to eq(10)
-  end
-end

data/spec/unit/clear_spec.rb

@@ -1,17 +0,0 @@
-RSpec.describe TTY::ProgressBar, 'clear' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  it "clears progress bar when finished" do
-    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 5,
-     clear: true)
-    5.times { progress.advance }
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G[=    ]",
-      "\e[1G[==   ]",
-      "\e[1G[===  ]",
-      "\e[1G[==== ]",
-      "\e[1G[=====]\e[0m\e[2K\e[1G"
-    ].join)
-  end
-end

data/spec/unit/complete_spec.rb

@@ -1,16 +0,0 @@
-RSpec.describe TTY::ProgressBar, '#complete?' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  it "checks for completness" do
-    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 3)
-    completes = []
-    3.times do
-      completes << progress.complete?
-      progress.advance
-    end
-    completes << progress.complete?
-    expect(completes).to eq([
-      false, false, false, true
-    ])
-  end
-end

data/spec/unit/converter/to_bytes_spec.rb

@@ -1,47 +0,0 @@
-RSpec.describe TTY::ProgressBar::Converter, '#to_bytes' do
-  subject(:converter) { described_class }
-
-  it "converts 1000 to bytes" do
-    expect(converter.to_bytes(1000)).to eq('1000B')
-  end
-
-  it "converts 1024 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
-
-  it "convert 10_000_000_000 to bytes" do
-    expect(converter.to_bytes(10_000_000_000)).to eq('9.31GB')
-  end
-end

data/spec/unit/converter/to_seconds_spec.rb

@@ -1,15 +0,0 @@
-RSpec.describe TTY::ProgressBar::Converter, '#to_seconds' do
-  subject(:converter) { described_class }
-
-  it "ensure 5 digit precision for < 1" do
-    expect(converter.to_seconds(0.000005)).to eq("0.00001")
-  end
-
-  it "rounds 0 to 0.00" do
-    expect(converter.to_seconds(0)).to eq(" 0.00")
-  end
-
-  it "ensures 2 digit precision for > 1" do
-    expect(converter.to_seconds(11.2)).to eq("11.20")
-  end
-end

data/spec/unit/converter/to_time_spec.rb

@@ -1,19 +0,0 @@
-RSpec.describe TTY::ProgressBar::Converter, '#to_time' do
-  subject(:converter) { described_class }
-
-  it "converts seconds to seconds" do
-    expect(converter.to_time(15)).to eq("15s")
-  end
-
-  it "converts seconds to minutes" do
-    expect(converter.to_time(100)).to eq(" 1m40s")
-  end
-
-  it "converts seconds to small hours" do
-    expect(converter.to_time(3600)).to eq(" 1h 0m")
-  end
-
-  it "converts secodns to hours" do
-    expect(converter.to_time(100 * 3600)).to eq("100h")
-  end
-end

data/spec/unit/custom_formatter_spec.rb

@@ -1,26 +0,0 @@
-RSpec.describe TTY::ProgressBar, 'custom formatter' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  it "allows for custom tag" do
-    progress = TTY::ProgressBar.new(":hi", output: output, total: 10)
-
-    stub_const("HiFormatter", Class.new do
-      def initialize(progress)
-        @progress = progress
-      end
-
-      def matches?(value)
-        value.to_s =~ /:hi/
-      end
-
-      def format(value)
-        value.gsub(/:hi/, "Hello")
-      end
-    end)
-
-    progress.use(HiFormatter)
-    progress.advance
-    output.rewind
-    expect(output.read).to eq("\e[1GHello")
-  end
-end

data/spec/unit/custom_token_spec.rb

@@ -1,14 +0,0 @@
-RSpec.describe TTY::ProgressBar, 'custom token' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  it "allows to specify custom tokens" do
-    progress = TTY::ProgressBar.new("(:current) :title", output: output, total: 4)
-    progress.advance(title: 'Hello Piotr!')
-    progress.advance(3, title: 'Bye Piotr!')
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G(1) Hello Piotr!",
-      "\e[1G(4) Bye Piotr!  \n"
-    ].join)
-  end
-end

data/spec/unit/events_spec.rb

@@ -1,33 +0,0 @@
-RSpec.describe TTY::ProgressBar, 'events' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  it "emits :progress event when advancing" do
-    events = []
-    bar = TTY::ProgressBar.new("[:bar]", output: output, total: 5)
-    bar.on(:progress) { events << :progress }
-
-    bar.advance
-
-    expect(events).to eq([:progress])
-  end
-
-  it "emits :done event when finished" do
-    events = []
-    bar = TTY::ProgressBar.new("[:bar]", output: output, total: 5)
-    bar.on(:done) { events << :done }
-
-    bar.finish
-
-    expect(events).to eq([:done])
-  end
-
-  it "emits :stopped event" do
-    events = []
-    bar = TTY::ProgressBar.new("[:bar]", output: output, total: 5)
-    bar.on(:stopped) { events << :stopped }
-
-    bar.stop
-
-    expect(events).to eq([:stopped])
-  end
-end

data/spec/unit/finish_spec.rb

@@ -1,15 +0,0 @@
-RSpec.describe TTY::ProgressBar, '#finish' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  it 'finishes progress' do
-    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 10)
-    progress.advance
-    progress.finish
-    expect(progress.complete?).to be(true)
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G[=         ]",
-      "\e[1G[==========]\n"
-    ].join)
-  end
-end

data/spec/unit/formatter/bar_spec.rb

@@ -1,33 +0,0 @@
-RSpec.describe TTY::ProgressBar, ':bar token' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  it "animates bar" do
-    progress = TTY::ProgressBar.new("[:bar]", output: output, total: 5)
-    5.times { progress.advance }
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G[=    ]",
-      "\e[1G[==   ]",
-      "\e[1G[===  ]",
-      "\e[1G[==== ]",
-      "\e[1G[=====]\n"
-    ].join)
-  end
-
-  it "animates colors correctly" do
-    red = "\e[31m \e[0m"
-    green = "\e[32m \e[0m"
-    progress = TTY::ProgressBar.new("[:bar]", total: 5, complete: green,
-                                    incomplete: red, output: output)
-
-    5.times { progress.advance }
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G[#{green}#{red}#{red}#{red}#{red}]",
-      "\e[1G[#{green}#{green}#{red}#{red}#{red}]",
-      "\e[1G[#{green}#{green}#{green}#{red}#{red}]",
-      "\e[1G[#{green}#{green}#{green}#{green}#{red}]",
-      "\e[1G[#{green}#{green}#{green}#{green}#{green}]\n",
-    ].join)
-  end
-end

data/spec/unit/formatter/byte_rate_spec.rb

@@ -1,32 +0,0 @@
-RSpec.describe TTY::ProgressBar, ':byte_rate token' do
-  let(:output) { StringIO.new('', 'w+') }
-
-  before { Timecop.safe_mode = false }
-
-  it "shows current rate in bytes per sec" do
-    time_now = Time.local(2014, 10, 5, 12, 0, 0)
-    Timecop.freeze(time_now)
-    progress = TTY::ProgressBar.new(":byte_rate", output: output, total: 10000, interval: 1)
-    # Generate a serie of advances at 2s intervals
-    #   t+0     advance=0         total=0
-    #   t+2     advance=1000      total=1000
-    #   t+4     advance=2000      total=3000
-    #   t+6     advance=3000      total=6000
-    #   t+8     advance=4000      total=10_000
-    # NOTE: mean_byte uses 1024 for the scale in K, M ...
-    5.times do |i|
-      time_now = Time.local(2014, 10, 5, 12, 0, i * 2)
-      Timecop.freeze(time_now)
-      progress.advance(i * 1000)
-    end
-    output.rewind
-    expect(output.read).to eq([
-      "\e[1G0B",
-      "\e[1G500B",
-      "\e[1G1000B",
-      "\e[1G1.46KB",
-      "\e[1G1.95KB\n"
-    ].join)
-    Timecop.return
-  end
-end