Class: Aidp::Interfaces::TtyUI

Inherits:

Object

• Object
• Aidp::Interfaces::TtyUI

Includes:

UiInterface

Defined in:

lib/aidp/interfaces/ui_interface.rb

Overview

TtyUI wraps TTY::Prompt and TTY::Spinner for UI operations. This is the standard implementation used by AIDP.

Examples:

Creating a TtyUI

ui = TtyUI.new
ui.say("Hello", type: :success)
ui.with_spinner(title: "Working") { sleep(1) }

Constant Summary

COLOR_MAP =

{
  info: :blue,
  success: :green,
  warning: :yellow,
  error: :red,
  highlight: :cyan,
  muted: :bright_black
}.freeze

CRITICAL_TYPES =

[:error, :warning, :success].freeze

Constants included from UiInterface

UiInterface::MESSAGE_TYPES

Instance Method Summary

• #initialize(prompt: nil, quiet: false) ⇒ TtyUI constructor

  A new instance of TtyUI.

• #quiet? ⇒ Boolean
• #say(message, type: :info) ⇒ Object
• #spinner(title:) ⇒ Object
• #with_spinner(title:) ⇒ Object

Constructor Details

#initialize(prompt: nil, quiet: false) ⇒ TtyUI

Returns a new instance of TtyUI.

Parameters:

• prompt (TTY::Prompt, nil) (defaults to: nil) —

  optional pre-configured prompt

• quiet (Boolean) (defaults to: false) —

  whether to suppress non-critical messages

# File 'lib/aidp/interfaces/ui_interface.rb', line 181

def initialize(prompt: nil, quiet: false)
  @prompt = prompt
  @quiet = quiet
end

Instance Method Details

#quiet? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/aidp/interfaces/ui_interface.rb', line 212

def quiet?
  @quiet
end

#say(message, type: :info) ⇒ Object

# File 'lib/aidp/interfaces/ui_interface.rb', line 186

def say(message, type: :info)
  return if @quiet && !CRITICAL_TYPES.include?(type)

  prompt.say(message.to_s, color: COLOR_MAP.fetch(type, :white))
end

#spinner(title:) ⇒ Object

# File 'lib/aidp/interfaces/ui_interface.rb', line 207

def spinner(title:)
  require "tty-spinner"
  TtySpinnerWrapper.new(title: title)
end

#with_spinner(title:) ⇒ Object

# File 'lib/aidp/interfaces/ui_interface.rb', line 192

def with_spinner(title:)
  require "tty-spinner"
  spin = TTY::Spinner.new("[:spinner] #{title}", format: :dots, hide_cursor: true)
  spin.auto_spin

  begin
    result = yield
    spin.success("done")
    result
  rescue
    spin.error("failed")
    raise
  end
end