infobar 0.0.0

data/lib/infobar/timer.rb

@@ -0,0 +1,47 @@
+class Infobar::Timer
+  def initialize
+    @n    = 0
+    @x    = 0.0
+  end
+
+  attr_reader :x
+
+  attr_reader :n
+
+  def add(time, count)
+    case @n
+    when 0
+      @n += 1
+    when 1
+      @n -= 1
+      duration = time - @time_last
+      self << (duration / @count_last)
+      self << (duration / count.to_f)
+    else
+      duration = time - @time_last
+      self << (duration / count.to_f)
+    end
+    @time_last, @count_last = time, count
+    self
+  end
+
+  def rate
+    if @x.zero?
+      0.0
+    else
+      1.0 / @x
+    end
+  end
+
+  def average_time
+    @x
+  end
+
+  protected
+
+  def <<(x)
+    @n +=1
+    @x += (x - @x) / @n
+    self
+  end
+end

data/lib/infobar/version.rb

@@ -0,0 +1,8 @@
+class Infobar
+  # Infobar version
+  VERSION         = '0.0.0'
+  VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
+  VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
+  VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
+  VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
+end

data/spec/config/infobar.yml

@@ -0,0 +1,20 @@
+---
+development:
+  label: Progress
+  message:
+    format: ' %l %c/%t (%P%%) in %te with %r, ETA %e @%E %s '
+    '%s':
+      frames: :braille7
+      message: ✓
+    '%r':
+      format: '%.2f %U/s'
+      unit:   i
+      prefix: 1000
+  style:
+    done_fill:     ░
+    done_fg_color: 22
+    done_bg_color: 40
+    todo_fill:     ' '
+    todo_fg_color: 124
+    todo_bg_color: 214
+  show: <%= STDIN.tty? %>

data/spec/infobar/config_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe 'Infobar config' do
+  before do
+    ComplexConfig::Provider.config_dir =
+      Pathname.new(__FILE__).dirname.dirname + 'config'
+    extend ComplexConfig::Provider::Shortcuts
+    ComplexConfig::Provider.reload
+  end
+
+  after do
+    ComplexConfig::Provider.config_dir = nil
+    ComplexConfig::Provider.reload
+  end
+
+  it 'configuration exists' do
+    expect(cc.infobar?).not_to be_nil
+  end
+
+  it 'configures default infobar' do
+    Infobar(total: 23)
+    expect(infobar.display.output).to receive(:<<).with(?\r)
+    expect(infobar.display.output).to receive(:<<).with(%r(Progress 0/23.*⣽))
+    infobar.update
+    expect(infobar).to be_show
+  end
+end

data/spec/infobar/counter_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe Infobar::Counter do
+  let :counter do
+    described_class.new
+  end
+
+  it 'can be initialized' do
+    expect(counter).to be_a described_class
+    expect(counter.current).to eq 0
+    expect(counter.total).to eq 0
+    expect(counter).not_to be_started
+  end
+
+  it 'can progress' do
+    expect(counter.progress).to eq counter
+    expect(counter).to be_started
+    expect(counter.current).to eq 1
+    expect(counter.total).to eq 0
+  end
+
+  it 'can progress by arbitrary value' do
+    expect(counter.progress(by: 23)).to eq counter
+    expect(counter).to be_started
+    expect(counter.current).to eq 23
+    expect(counter.total).to eq 0
+  end
+
+  it 'can be done' do
+    counter.reset(total: 3)
+    expect(counter).not_to be_done
+    expect(counter.progress(by: 2)).to eq counter
+    expect(counter).not_to be_done
+    expect(counter.progress).to eq counter
+    expect(counter).to be_done
+    expect(counter.progress(by: 23)).to eq counter
+    expect(counter).to be_done
+  end
+
+  it 'can be finished' do
+    counter.reset(total: 3)
+    expect(counter).not_to be_started
+    expect(counter).not_to be_finished
+    expect(counter.progress(by: 1)).to eq counter
+    expect(counter).to be_started
+    expect(counter).not_to be_finished
+    expect(counter.finish).to eq counter
+    expect(counter).to be_finished
+  end
+
+  it 'can tell how far it has progressed' do
+    counter.reset(total: 3)
+    expect(counter.progressed).to be_zero
+    expect(counter.progress).to eq counter
+    expect(counter.progressed).to be_within(1e-3).of(1 / 3.0)
+    expect(counter.progress).to eq counter
+    expect(counter.progressed).to be_within(1e-3).of(2 / 3.0)
+    expect(counter.progress).to eq counter
+    expect(counter.progressed).to be_within(1e-3).of(1)
+  end
+
+  it 'cannot progress without knowing how far to go' do
+    expect(counter.progressed).to eq 0.0
+    expect(counter.progress).to eq counter
+    expect(counter.progressed).to eq 0.0
+  end
+
+  it 'can tell how many counts we have' do
+    expect(counter.current).to be_zero
+    expect(counter.progress).to eq counter
+    expect(counter.current).to eq 1
+    expect(counter.progress).to eq counter
+    expect(counter.current).to eq 2
+    expect(counter.progress).to eq counter
+    expect(counter.current).to eq 3
+  end
+
+  it 'can tell how far it still has to go' do
+    counter.reset(total: 3)
+    expect(counter.to_go).to eq 3
+    expect(counter.to_go?).to eq 3
+    expect(counter).to be_to_go
+    expect(counter.progress(by: 2)).to eq counter
+    expect(counter.to_go).to eq 1
+    expect(counter.to_go?).to eq 1
+    expect(counter).to be_to_go
+    expect(counter.progress).to eq counter
+    expect(counter.to_go).to be_zero
+    expect(counter.to_go?).to be_nil
+    expect(counter).not_to be_to_go
+  end
+
+  it 'time_remaining' do
+    counter.reset(total: 3)
+    now = Time.now
+    Time.dummy(now - 2) { counter.progress }
+    Time.dummy(now - 1) { counter.progress }
+    expect(counter.time_remaining).to be_within(1e-3).of 1
+    counter.finish
+    expect(counter.time_remaining).to be_zero
+  end
+
+  it 'time_elapsed' do
+    counter.reset(total: 3)
+    now = Time.now
+    expect(counter.time_elapsed).to be_within(1e-3).of 0
+    Time.dummy(now - 3) { counter.progress }
+    Time.dummy(now - 2) { counter.progress }
+    Time.dummy(now - 1) do
+      expect(counter.time_elapsed).to be_within(1e-3).of 2
+    end
+    counter.finish
+    expect(counter.time_elapsed).to be_within(1e-3).of 3
+  end
+
+  it 'eta' do
+    counter.reset(total: 3)
+    now = Time.now
+    Time.dummy(now - 2) { counter.progress }
+    Time.dummy(now - 1) {
+      counter.progress
+      expect(counter.eta.to_i).to eq now.to_i
+    }
+    counter.finish
+    expect(counter.eta.to_i).to eq now.to_i
+  end
+
+  it 'total_time' do
+    counter.reset(total: 3)
+    now = Time.now
+    Time.dummy(now - 2) { counter.progress }
+    Time.dummy(now - 1) { counter.progress }
+    expect(counter.total_time).to be_within(1e-3).of 3
+  end
+end

data/spec/infobar/display_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Infobar::Display do
+  let :output do
+    StringIO.new
+  end
+
+  let :display do
+    described_class.new
+  end
+
+  before do
+    display.output = output
+    allow(display).to receive(:columns).and_return 40
+  end
+
+  it 'can be updated' do
+    display.update message: 'test', progressed: 0.5
+    expect(output.tap(&:rewind).read).to eq\
+       "\r\e[38;5;22m\e[48;5;40m░░░░░░░░░░░░░░░░░░te\e[0m\e[0m\e[38;5;40m\e[48;5;22mst                  \e[0m\e[0m"
+  end
+
+  it 'update returns carriage first' do
+    expect(display).to receive(:carriage_return).and_call_original
+    display.update message: 'test', progressed: 0.5
+    expect(output.tap(&:rewind).read).to start_with ?\r
+  end
+
+  it 'reset clears and sets to default style' do
+    expect(display).to receive(:clear).and_call_original
+    expect(display).to receive(:style=).with(display.class.default_style)
+    display.reset
+  end
+
+  it 'has style' do
+    test_style = {
+      done_fill:     ?X,
+      done_fg_color: 1,
+      done_bg_color: 9,
+      todo_fill:     ?O,
+      todo_fg_color: 0,
+      todo_bg_color: 8
+    }
+    display.style = test_style
+    display.update message: 'test', progressed: 0.5
+    expect(output.tap(&:rewind).read).to eq\
+      "\r\e[38;5;1m\e[48;5;9mXXXXXXXXXXXXXXXXXXte\e[0m\e[0m\e[38;5;0m\e[48;5;8mstOOOOOOOOOOOOOOOOOO\e[0m\e[0m"
+    expect(display.style).to eq(test_style)
+  end
+
+  it 'can output newline' do
+    expect(display.output).to receive(:<<).with($/)
+    display.newline
+  end
+
+  it 'can be shown' do
+    display.show = true
+    expect(display).to be_show
+    expect(output).to receive(:<<)
+    display.output << 'hello world'
+    expect(display.input).not_to be_nil
+  end
+
+  it 'can be hidden' do
+    display.show = false
+    expect(display).not_to be_show
+    expect(output).not_to receive(:<<)
+    display.output << 'hello world'
+    expect(display.input).to be_nil
+  end
+end

data/spec/infobar/duration_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Infobar::Duration do
+  it 'can convert duration into string' do
+    expect(described_class.new(3661).to_s).to eq '01:01:01'
+  end
+
+  it 'can convert duration into string for format' do
+    expect(described_class.new(3661, format: '%h:%m').to_s).to eq '01:01'
+  end
+end
+

data/spec/infobar/frequency_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Infobar::Frequency do
+  let :frequency do
+    described_class.new 1
+  end
+
+  it 'can be updated' do
+    frequency.call {}
+    expect(frequency.instance_eval { @update }).to be_present
+  end
+
+  it 'can be called' do
+    called = false
+    frequency.call do
+      called = true
+    end
+    expect(called).to eq true
+  end
+
+  it 'does not execute block if called too soon' do
+    Time.dummy(Time.now - 2) do
+      expect(frequency.called).to eq 0
+      frequency.call { }
+      expect(frequency.called).to eq 1
+      frequency.call { }
+      expect(frequency.called).to eq 1
+    end
+    frequency.call { }
+    expect(frequency.called).to eq 2
+  end
+
+  it 'can be reset' do
+    expect(frequency.called).to eq 0
+    frequency.call { }
+    expect(frequency.called).to eq 1
+    frequency.reset
+    expect(frequency.called).to eq 0
+  end
+
+  it 'can be displayed' do
+    expect(frequency.to_s).to eq '1.0'
+  end
+end

data/spec/infobar/input_output_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Infobar::InputOutput do
+  around do |example|
+    infobar.display.output = Object.new
+    infobar.display.input  = Object.new
+    example.run
+    infobar.display.output = $stdout
+    infobar.display.input  = $stdin
+    infobar.reset
+  end
+
+  it 'can puts after clearing' do
+    expect(infobar.display).to receive(:clear)
+    expect(infobar.display.output).to receive(:puts)
+    infobar.puts 'hello'
+  end
+
+  it 'can gets after clearing' do
+    expect(infobar.display).to receive(:clear)
+    expect(infobar.display.input).to receive(:gets)
+    infobar.gets
+  end
+
+  it 'can output newline' do
+    expect(infobar.display).to receive(:newline)
+    infobar.newline
+  end
+
+  it 'can clear the infobar' do
+    expect(infobar.display).to receive(:clear)
+    infobar.clear
+  end
+end

data/spec/infobar/message_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Infobar::Message do
+  let :format do
+    '%c %t %T %l %p %q %P %Q %te %tt %e %E %r %a %s %%'
+  end
+
+  let :message do
+    described_class.new(format: format, '%p' => { format: '%.2f' })
+  end
+
+  let :now do
+    Time.parse('2011-11-11 11:11:11')
+  end
+
+
+  before do
+    Time.dummy(now - 3) do
+      Infobar.(current: 21, total: 42, label: 'Test')
+    end
+    Time.dummy(now - 2) do
+      +infobar
+    end
+    Time.dummy(now - 1) do
+      +infobar
+    end
+  end
+
+  after do
+    infobar.reset
+  end
+
+  it 'can be interpolated' do
+    Time.dummy(now) do
+      expect(message.to_str).to eq(
+        "23 42 19 Test 0.55 0.452 54.76 45.24 00:00:02 00:00:21 00:00:19 11:11:30 1.0 00:01.000000 – %"
+      )
+    end
+  end
+
+  it 'can turn spinner into a message after finishing' do
+    Time.dummy(now) do
+      srand 1
+      message = described_class.new(
+        format: 'hello %s',
+        '%s' => {
+          random: true,
+          message: {
+            format: 'world at %E',
+            '%E' => { format: '%F %T' }
+          }
+        }
+      )
+      expect(message.to_str).to eq 'hello /'
+      infobar.finish
+      expect(message.to_str).to eq 'hello world at 2011-11-11 11:11:11'
+    end
+  end
+
+  it 'can be converted into a format string' do
+    expect(message.to_s).to eq format
+  end
+
+  it 'can be converted into a hash' do
+    expect(message.to_hash).to eq(
+      format: format,
+      '%p' => { format: '%.2f' }
+    )
+  end
+end