infobar 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efa40cb4c4b4763c56296e96a24358e46cef3a73
+  data.tar.gz: 3350e61f29a337276e17b84d1f3ee81eb91fc78f
+SHA512:
+  metadata.gz: '079be8e48a1234be9d2e018939cb34fba2b87b84ad1c55e78ccee3ee7c19c67d93dad11f31c1117e8a5151671bd1e8d5eb7965c3c5aeedd898c88b775f9d9b81'
+  data.tar.gz: 00fc996234f4c637db4b1f0c79cd193e54eb49a3f6d2032f4bc8dd4b837753ba9619cf1aa4bfeab59f3c6e3c35c93fbed073bf6c8a1f281a0bc8909c1c403465

data/.gitignore

@@ -0,0 +1,10 @@
+.*.sw[pon]
+.AppleDouble
+.DS_Store
+.byebug_history
+.rvmrc
+Gemfile.lock
+coverage
+errors.lst
+pkg
+tags

data/.rspec

@@ -0,0 +1,2 @@
+-fd
+-c

data/.utilsrc

@@ -0,0 +1,26 @@
+# vim: set ft=ruby:
+
+search do
+  prune_dirs /\A(\.svn|\.git|CVS|tmp|tags|coverage|pkg)\z/
+  skip_files /(\A\.|\.sw[pon]\z|\.(log|fnm|jpg|jpeg|png|pdf|svg)\z|tags|~\z)/i
+end
+
+discover do
+  prune_dirs /\A(\.svn|\.git|CVS|tmp|tags|coverage|pkg)\z/
+  skip_files /(\A\.|\.sw[pon]\z|\.log\z|~\z)/
+  binary false
+end
+
+strip_spaces do
+  prune_dirs /\A(\..*|CVS|pkg)\z/
+  skip_files /(\A\.|\.sw[pon]\z|\.log\z|~\z)/
+end
+
+probe do
+  test_framework :rspec
+  #include_dirs 'features'
+end
+
+ssh_tunnel do
+  terminal_multiplexer :tmux
+end

data/Gemfile

@@ -0,0 +1,5 @@
+# vim: set filetype=ruby et sw=2 ts=2:
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,38 @@
+# Infobar
+
+## Description
+
+Display progress of computations and additional information to the terminal.
+
+## Installation
+
+    # gem install infobar
+
+## Usage
+
+    > Infobar(total: 23)
+    ░░░░░░░░░░ Infobar 6/23 in 00:00:05, ETA 00:00:17 @17:43:37 –
+    > 23.times { +infobar; sleep 1 }
+    ░░░░░░░░░░░Infobar 23/23 in 00:00:22, ETA 00:00:00 @17:43:37 ✓░░░░░░░░░░ 
+
+    or alternatively
+
+    > (1..23).with_infobar.each { |i| +infobar; sleep 1 }
+
+## Changes
+
+* 2017-02-08 Release 0.0.0
+
+## Download
+
+The homepage of this library is located at
+
+* https://github.com/flori/infobar
+
+## Author
+
+[Florian Frank](mailto:flori@ping.de)
+
+## License
+
+This software is licensed under the Apache 2.0 license.

data/Rakefile

@@ -0,0 +1,28 @@
+# vim: set filetype=ruby et sw=2 ts=2:
+
+require 'gem_hadar'
+
+GemHadar do
+  name        'infobar'
+  author      'Florian Frank'
+  email       'flori@ping.de'
+  homepage    "http://flori.github.com/#{name}"
+  summary     'Gem to display information about computations.'
+  description 'This gem displays progress of computations and additional information to the terminal.'
+  module_type :class
+  test_dir    'spec'
+  ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc',
+    '.AppleDouble', 'tags', '.byebug_history', '.DS_Store', 'errors.lst'
+  readme      'README.md'
+  title       "#{name.camelize}"
+
+  required_ruby_version '>= 2.3'
+  dependency 'tins',           '~> 1.0', '>= 1.13.2'
+  dependency 'term-ansicolor', '~> 1.4'
+  dependency 'complex_config', '~> 0.10'
+  development_dependency 'rake'
+  development_dependency 'simplecov'
+  development_dependency 'rspec'
+end
+
+task :default => :spec

data/TODO.md

@@ -0,0 +1,22 @@
+# TODO
+
+- add color gradients?
+- cumulative counters to summarize several progress bars
+- more documentation, lol
+
+## DONE
+
+- units
+- configuration file?
+- add finished directive
+- add nicer `Message#to_s` method
+- add output methods that clear b4 printing to allow output while progressing
+- elapsed time as duration
+- ETA as duration
+- ETA as datetime
+- rate
+- better average idea
+- Update Frequency
+- spinner animation
+- newline method
+- Easily switch on/off output

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/infobar.gemspec

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+# stub: infobar 0.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "infobar".freeze
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Florian Frank".freeze]
+  s.date = "2017-02-08"
+  s.description = "This gem displays progress of computations and additional information to the terminal.".freeze
+  s.email = "flori@ping.de".freeze
+  s.extra_rdoc_files = ["README.md".freeze, "lib/infobar.rb".freeze, "lib/infobar/counter.rb".freeze, "lib/infobar/display.rb".freeze, "lib/infobar/duration.rb".freeze, "lib/infobar/fancy_interface.rb".freeze, "lib/infobar/frequency.rb".freeze, "lib/infobar/input_output.rb".freeze, "lib/infobar/message.rb".freeze, "lib/infobar/number.rb".freeze, "lib/infobar/spinner.rb".freeze, "lib/infobar/timer.rb".freeze, "lib/infobar/version.rb".freeze]
+  s.files = [".gitignore".freeze, ".rspec".freeze, ".utilsrc".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "TODO.md".freeze, "VERSION".freeze, "infobar.gemspec".freeze, "lib/infobar.rb".freeze, "lib/infobar/counter.rb".freeze, "lib/infobar/display.rb".freeze, "lib/infobar/duration.rb".freeze, "lib/infobar/fancy_interface.rb".freeze, "lib/infobar/frequency.rb".freeze, "lib/infobar/input_output.rb".freeze, "lib/infobar/message.rb".freeze, "lib/infobar/number.rb".freeze, "lib/infobar/spinner.rb".freeze, "lib/infobar/timer.rb".freeze, "lib/infobar/version.rb".freeze, "spec/config/infobar.yml".freeze, "spec/infobar/config_spec.rb".freeze, "spec/infobar/counter_spec.rb".freeze, "spec/infobar/display_spec.rb".freeze, "spec/infobar/duration_spec.rb".freeze, "spec/infobar/frequency_spec.rb".freeze, "spec/infobar/input_output_spec.rb".freeze, "spec/infobar/message_spec.rb".freeze, "spec/infobar/number_spec.rb".freeze, "spec/infobar/spinner_spec.rb".freeze, "spec/infobar/timer_spec.rb".freeze, "spec/infobar_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.homepage = "http://flori.github.com/infobar".freeze
+  s.rdoc_options = ["--title".freeze, "Infobar".freeze, "--main".freeze, "README.md".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.3".freeze)
+  s.rubygems_version = "2.6.8".freeze
+  s.summary = "Gem to display information about computations.".freeze
+  s.test_files = ["spec/infobar/config_spec.rb".freeze, "spec/infobar/counter_spec.rb".freeze, "spec/infobar/display_spec.rb".freeze, "spec/infobar/duration_spec.rb".freeze, "spec/infobar/frequency_spec.rb".freeze, "spec/infobar/input_output_spec.rb".freeze, "spec/infobar/message_spec.rb".freeze, "spec/infobar/number_spec.rb".freeze, "spec/infobar/spinner_spec.rb".freeze, "spec/infobar/timer_spec.rb".freeze, "spec/infobar_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
+      s.add_development_dependency(%q<rake>.freeze, [">= 0"])
+      s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<tins>.freeze, [">= 1.13.2", "~> 1.0"])
+      s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.4"])
+      s.add_runtime_dependency(%q<complex_config>.freeze, ["~> 0.10"])
+    else
+      s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
+      s.add_dependency(%q<rake>.freeze, [">= 0"])
+      s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_dependency(%q<tins>.freeze, [">= 1.13.2", "~> 1.0"])
+      s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.4"])
+      s.add_dependency(%q<complex_config>.freeze, ["~> 0.10"])
+    end
+  else
+    s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
+    s.add_dependency(%q<rake>.freeze, [">= 0"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_dependency(%q<tins>.freeze, [">= 1.13.2", "~> 1.0"])
+    s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.4"])
+    s.add_dependency(%q<complex_config>.freeze, ["~> 0.10"])
+  end
+end

data/lib/infobar.rb

@@ -0,0 +1,139 @@
+require 'tins/xt'
+require 'complex_config'
+
+class Infobar
+end
+
+require 'infobar/version'
+require 'infobar/counter'
+require 'infobar/display'
+require 'infobar/message'
+require 'infobar/fancy_interface'
+require 'infobar/input_output'
+
+class Infobar
+  class << self
+    prepend Tins::Delegate
+  end
+  include Tins::SexySingleton
+  include Infobar::FancyInterface
+  prepend Infobar::InputOutput
+  include ComplexConfig::Provider::Shortcuts
+
+  def initialize
+    @counter = Infobar::Counter.new
+    @display = Infobar::Display.new
+    reset
+  end
+
+  def self.display
+    Infobar.instance.display
+  end
+
+  attr_reader :message
+
+  attr_reader :counter
+
+  attr_reader :display
+
+  attr_accessor :label
+
+  delegate :started?, to: :@counter
+
+  delegate :done?, to: :@counter
+
+  delegate :finished?, to: :@counter
+
+  delegate :show?, to: :@display
+
+  delegate :show=, to: :@display
+
+  delegate :style=, to: :@display
+
+  def call(
+    total:,
+    current:   0,
+    label:     cc.infobar?&.label || 'Infobar',
+    message:   cc.infobar?&.message?&.to_h,
+    show:      cc.infobar?&.show?,
+    style:     cc.infobar?&.style?&.to_h,
+    frequency: cc.infobar?&.frequency?,
+    update:    false,
+    finish:    nil
+  )
+    self.label = label
+    @counter.reset(total: total, current: current)
+    @message = convert_to_message(message)
+    show.nil? or self.show = show
+    if update
+      update(message: @message)
+    else
+      @display.reset
+    end
+    frequency.nil? or display.frequency = frequency
+    style.nil? or self.style = style
+    self
+  end
+
+  def reset
+    @message = convert_to_message('%l %c/%t in %te, ETA %e @%E %s')
+    @counter.reset(total: 0, current: 0)
+    @display.reset
+    self
+  end
+
+  def update(message: nil)
+    @message = convert_to_message(message)
+    @display.update(message: @message, progressed: @counter.progressed)
+    self
+  end
+
+  def progress(by: 1, message: nil, finish: true, force: false)
+    @counter.progress(by: by)
+    @message = convert_to_message(message)
+    @display.update(message: @message, force: force, progressed: @counter.progressed)
+    finish && @counter.done? and finish(message: finish)
+    self
+  end
+
+  def finish(message: nil)
+    @counter.finish
+    @message = convert_to_message(message)
+    @display.update(message: @message, force: true, progressed: @counter.progressed)
+    self
+  end
+
+  def convert_to_message(message)
+    case message
+    when Message
+      message
+    when Hash
+      Message.new(message)
+    when String
+      Message.new format: message
+    else
+      @message
+    end
+  end
+end
+
+def Infobar(**opts)
+  Infobar.(**opts)
+end
+
+class ::Object
+  def infobar
+    ::Infobar.instance
+  end
+
+  def with_infobar(**opts)
+    case
+    when total = opts[:total].ask_and_send(:to_sym)
+      opts[:total] = __send__(total)
+    when opts[:total].nil?
+      opts[:total] = size
+    end
+    Infobar.(**opts)
+    self
+  end
+end

data/lib/infobar/counter.rb

@@ -0,0 +1,101 @@
+require 'infobar/timer'
+
+class Infobar::Counter
+  class <<
+    prepend Tins::Delegate
+  end
+
+  def initialize
+    reset
+  end
+
+  attr_reader :current
+
+  attr_reader :total
+
+  def reset(total: 0, current: 0)
+    @current  = current
+    @total    = total
+    @start    = nil
+    @finished = false
+    @timer    = Infobar::Timer.new
+  end
+
+  delegate :rate, to: :@timer
+
+  delegate :average_time, to: :@timer
+
+  def started?
+    @start
+  end
+
+  def finished?
+    @finished
+  end
+
+  def finish
+    @finished = Time.now
+    self
+  end
+
+  def progress(by: 1)
+    if !finished? && by >= 1
+      now = Time.now
+      @start ||= now
+      @timer.add(now, by)
+      @current += by
+    end
+    self
+  end
+
+  def done?
+    @current >= @total
+  end
+
+  def to_go
+    [ total - current, 0 ].max
+  end
+
+  def to_go?
+    to_go.nonzero?
+  end
+
+  def time_remaining
+    if @finished
+      0.0
+    else
+      average_time * to_go
+    end
+  end
+
+  def eta
+    if @finished
+      @finished
+    else
+      Time.now + time_remaining
+    end
+  end
+
+  def time_elapsed
+    case
+    when @finished && @start
+      @finished - @start
+    when @start
+      Time.now - @start
+    else
+      0.0
+    end
+  end
+
+  def total_time
+    time_elapsed + time_remaining
+  end
+
+  def progressed
+    if @total.zero?
+      0.0
+    else
+      @current / @total.to_f
+    end
+  end
+end