infobar 0.0.0

data/lib/infobar/display.rb

@@ -0,0 +1,131 @@
+require 'term/ansicolor'
+require 'stringio'
+require 'infobar/frequency'
+
+class Infobar::Display
+  class << self
+    prepend Tins::Delegate
+  end
+  include Term::ANSIColor
+
+  def self.default_style
+    {
+      done_fill:     ?░,
+      done_fg_color: 22,
+      done_bg_color: 40,
+      todo_fill:     ' ',
+      todo_fg_color: 40,
+      todo_bg_color: 22,
+    }
+  end
+
+  def initialize
+    self.output    = $stdout
+    self.input     = $stdin
+    self.frequency = 0.05
+    @show          = true
+    self.style = self.class.default_style
+  end
+
+  def frequency=(duration)
+    @frequency = Infobar::Frequency.new(duration)
+  end
+
+  attr_reader :frequency
+
+  attr_accessor :show
+
+  def show?
+    @show
+  end
+
+  def output=(io)
+    @output = io
+    @output.ask_and_send(:respond_to?, :sync=, true)
+  end
+
+  def output
+    if show?
+      @output
+    else
+      NULL
+    end
+  end
+
+  attr_writer :input
+
+  def input
+    if show?
+      @input
+    else
+      NULL
+    end
+  end
+
+  def style
+    self.class.default_style.each_key.each_with_object({}) do |attribute, h|
+      h[attribute] = instance_variable_get "@#{attribute}"
+    end
+  end
+
+  def style=(new_style)
+    self.class.default_style.each_key do |attribute|
+      value = new_style[attribute]
+      value.nil? and next
+      instance_variable_set "@#{attribute}", value
+    end
+    self
+  end
+
+  def update(message:, progressed:, force: false, **options)
+    force and @frequency.reset
+    @frequency.call do
+      message = Infobar.convert_to_message(message)
+      carriage_return
+      self.style = options
+      cols = columns
+      todo = message.to_str.center cols, replace_character
+      done = todo.slice!(0, (progressed * cols))
+      done.gsub!(replace_character, @done_fill[0])
+      todo.gsub!(replace_character, @todo_fill[0])
+      output << color(@done_fg_color, on_color(@done_bg_color, done)) +
+        color(@todo_fg_color, on_color(@todo_bg_color, todo))
+    end
+  end
+
+  delegate :called, to: :frequency, as: :updates
+
+  def reset
+    clear
+    @frequency.reset
+    self.style = self.class.default_style
+    self
+  end
+
+  def clear
+    carriage_return
+    output << ' ' * columns
+    carriage_return
+    self
+  end
+
+  def carriage_return
+    output << ?\r
+    self
+  end
+
+  def newline
+    output << $/
+    self
+  end
+
+  private
+
+  def replace_character
+    "\uFFFC"
+  end
+
+  def columns
+    Tins::Terminal.columns
+  end
+end

data/lib/infobar/duration.rb

@@ -0,0 +1,15 @@
+class Infobar::Duration
+  def initialize(value, format: nil)
+    duration = Tins::Duration.new(value)
+    @string =
+      if format
+        duration.format(format)
+      else
+        duration
+      end.to_s
+  end
+
+  def to_s
+    @string
+  end
+end

data/lib/infobar/fancy_interface.rb

@@ -0,0 +1,26 @@
+module Infobar::FancyInterface
+  def ~
+    reset
+  end
+
+  def +@
+    progress by: 1
+  end
+
+  def +(by)
+    progress by: by
+  end
+
+  def coerce(other)
+    return self, other
+  end
+
+  def <<(item)
+    progress by: 1
+  end
+
+  def add(*items)
+    progress by: items.size
+  end
+  alias push add
+end

data/lib/infobar/frequency.rb

@@ -0,0 +1,33 @@
+class Infobar::Frequency
+  def initialize(duration)
+    @duration = duration.to_f
+    @called   = 0
+  end
+
+  attr_reader :duration
+
+  attr_reader :called
+
+  def update(now: Time.now)
+    @update = now
+    @called += 1
+  end
+
+  def call(&block)
+    now = Time.now
+    if !@update || now - @update > @duration
+      update now: now
+      block.call
+    end
+  end
+
+  def reset
+    @update = nil
+    @called = 0
+    self
+  end
+
+  def to_s
+    @duration.to_s
+  end
+end

data/lib/infobar/input_output.rb

@@ -0,0 +1,25 @@
+module Infobar::InputOutput
+  def newline
+    @display.newline
+    self
+  end
+
+  def clear
+    @display.clear
+    self
+  end
+
+  %i[ print printf putc puts ].each do |method|
+    define_method(method) do |*a, &b|
+      @display.clear
+      @display.output.__send__(method, *a, &b)
+    end
+  end
+
+  %i[ gets readline readlines ].each do |method|
+    define_method(method) do |*a, &b|
+      @display.clear
+      @display.input.__send__(method, *a, &b)
+    end
+  end
+end

data/lib/infobar/message.rb

@@ -0,0 +1,154 @@
+require 'infobar/spinner'
+require 'infobar/duration'
+require 'infobar/number'
+
+class Infobar::Message
+  class << self
+    prepend Tins::Delegate
+
+    def register(directive, **opts, &block)
+      directives.key?(directive) and
+        warn "Overwriting old directive #{directive}."
+      directives[directive]                = block
+      directive_default_options[directive] = opts
+      self
+    end
+
+    def directives
+      @directives ||= {}
+    end
+
+    def directive_default_options
+      @directive_default_options ||= {}
+    end
+  end
+
+  # current counter value of items
+  register '%c' do
+    Infobar.counter.current
+  end
+
+  # total counter value of items
+  register '%t' do
+    Infobar.counter.total
+  end
+
+  # number of items to go
+  register '%T' do
+    Infobar.counter.to_go
+  end
+
+  # label of progress bar
+  register '%l' do
+    Infobar.label
+  end
+
+  # progressed so far as a float in 0..1
+  register('%p', format: '%.3f') do |directive, opts|
+    Infobar::Number.new(Infobar.counter.progressed, **opts)
+  end
+
+  # not yet progressed as a float in 0..1
+  register('%q', format: '%1.3f') do |directive, opts|
+    Infobar::Number.new(1 - Infobar.counter.progressed, **opts)
+  end
+
+  # progressed as a percentage float in 0..100
+  register('%P', format: '%3.2f') do |directive, opts|
+    Infobar::Number.new(100 * Infobar.counter.progressed, **opts)
+  end
+
+  # not yet progressed as a percentage float in 0..100
+  register('%Q', format: '%2.2f') do |directive, opts|
+    Infobar::Number.new(100 - 100 * Infobar.counter.progressed, **opts)
+  end
+
+  # time elapsed as a duration
+  register('%te', format: '%h:%m:%s') do |directive, opts|
+    Infobar::Duration.new(Infobar.counter.time_elapsed, **opts)
+  end
+
+  # total time as a duration
+  register('%tt', format: '%h:%m:%s') do |directive, opts|
+    Infobar::Duration.new(Infobar.counter.total_time, **opts)
+  end
+
+  # ETA as a duration
+  register('%e', format: '%h:%m:%s') do |directive, opts|
+    Infobar::Duration.new(Infobar.counter.time_remaining, **opts)
+  end
+
+  # ETA as a datetime
+  register('%E', format: '%T') do |directive, opts|
+    if format = opts[:format]
+      Infobar.counter.eta.strftime(format)
+    else
+      Infobar.counter.eta
+    end
+  end
+
+  # rate with or without units
+  register('%r', unit: nil, prefix: 1000, format: '%f %U') do |directive, opts|
+    if opts[:unit]
+      Tins::Unit.format(Infobar.counter.rate, **opts)
+    else
+      Infobar.counter.rate
+    end
+  end
+
+  # average time as a duration
+  register('%a', format: '%m:%s.%f') do |directive, opts|
+    Infobar::Duration.new(Infobar.counter.average_time, **opts)
+  end
+
+  # spinner
+  register('%s', frames: :pipe, message: ?✓) do |directive, opts|
+    if Infobar.finished?
+      if message = opts[:message]
+        Infobar.convert_to_message(message).to_str
+      end
+    elsif opts[:random]
+      Infobar::Spinner.new(opts[:frames]).spin(:random)
+    else
+      Infobar::Spinner.new(opts[:frames]).spin(Infobar.display.updates)
+    end
+  end
+
+  # literal percentag character
+  register '%%' do
+    ?%
+  end
+
+  def initialize(opts = {})
+    @format = opts.delete(:format) or
+      raise ArgumentError, 'format option required'
+    @opts = opts.each_with_object({}) { |(k, v), h| h[k.to_s] = v }
+  end
+
+  attr_reader :opts
+
+  delegate :directives, to: self
+
+  delegate :directive_default_options, to: self
+
+  def opts_for(directive)
+    @opts.fetch(directive, directive_default_options[directive])
+  end
+
+  def to_str
+    keys = directives.keys.sort_by { |k| -k.size }
+    @format.gsub(/(?<!%)(#{keys * ?|})/) do
+      directives[$1].call($1, opts_for($1))
+    end
+  end
+
+  attr_reader :format
+
+  alias to_s format
+
+  def to_hash
+    {
+      format: format,
+    }.merge(@opts)
+  end
+end

data/lib/infobar/number.rb

@@ -0,0 +1,10 @@
+class Infobar::Number
+  def initialize(value, format: nil)
+    duration = Tins::Duration.new(value)
+    @string = format ? (format % value) : value.to_s
+  end
+
+  def to_s
+    @string
+  end
+end

data/lib/infobar/spinner.rb

@@ -0,0 +1,51 @@
+class Infobar::Spinner
+  PREDEFINED = {
+    pipe:      %w[ | / – \\ ],
+    arrow:     %w[ ↑ ↗ → ↘ ↓ ↙ ← ↖ ],
+    bar1:      %w[ ▁ ▂ ▃ ▄ ▅ ▆ ▇ █ ▇ ▆ ▅ ▄ ▃ ▂ ],
+    bar2:      %w[ █ ▉ ▊ ▋ ▌ ▍ ▎ ▏ ▎ ▍ ▌ ▋ ▊ ▉ ],
+    braille7:  %w[ ⣾ ⣽ ⣻ ⢿ ⡿ ⣟ ⣯ ⣷ ],
+    braille1:  %w[ ⠁ ⠂ ⠄ ⡀ ⢀ ⠠ ⠐ ⠈ ],
+    square1:   %w[ ▖ ▘ ▝ ▗ ],
+    square2:   %w[ ◰ ◳ ◲ ◱ ],
+    tetris:    %w[ ▌ ▀ ▐▄ ],
+    eyes:      %w[ ◡◡ ⊙⊙ ◠◠ ],
+    corners:   %w[ ┤ ┘ ┴ └ ├ ┌ ┬ ┐ ],
+    triangle:  %w[ ◢ ◣ ◤ ◥ ],
+    circle1:   %w[ ◴ ◷ ◶ ◵ ],
+    circle2:   %w[ ◐ ◓ ◑ ◒ ],
+    circle3:   %w[ ◜ ◝ ◞ ◟ ],
+    cross:     %w[ + × ],
+    cylon:     [ '●  ', ' ● ', '  ●', ' ● ' ],
+    pacman:    [ 'ᗧ∙∙∙∙●', ' O∙∙∙●', '  ᗧ∙∙●','   O∙●', '    ᗧ●', 'ᗣ    O', ' ᗣ   ᗤ', ' ᗣ  O ', ' ᗣ ᗤ  ', ' ᗣO   ', ' ᗤ    ', 'O ∞   ', 'ᗧ   ∞ ', 'O     ' ],
+    asteroids: [ 'ᐊ  ◍', 'ᐃ  ◍', 'ᐓ  ◍', 'ᐅ· ◍', 'ᐅ ·◍', 'ᐅ  ○', 'ᐅ  ◌', 'ᐁ   ' ],
+  }
+
+  def initialize(frames = nil)
+    @frames =
+      case frames
+      when Array
+        frames
+      when Symbol
+        PREDEFINED.fetch(frames) do
+          |k| raise KeyError, "frames #{k} not predefined"
+        end
+      when nil
+        PREDEFINED[:pipe]
+      end
+  end
+
+  def spin(count)
+    @string =
+      if count == :random
+        @frames[rand(@frames.size)]
+      else
+        @frames[count % @frames.size]
+      end
+    self
+  end
+
+  def to_s
+    @string
+  end
+end