Class: CLI::UI::Spinner::Async

Inherits:
Object
  • Object
show all
Defined in:
lib/cli/ui/spinner/async.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(title) ⇒ Async

Initializes a new asynchronous spinner with no specific end. Must call .stop to end the spinner

Attributes

  • title - Title of the spinner to use

Example Usage:

CLI::UI::Spinner::Async.new('Title')

: (String title) -> void



29
30
31
32
33
34
35
36
 
# File 'lib/cli/ui/spinner/async.rb', line 29

def initialize(title)
  require 'thread'
  sg = CLI::UI::Spinner::SpinGroup.new
  @m = Mutex.new
  @cv = ConditionVariable.new
  sg.add(title) { @m.synchronize { @cv.wait(@m) } }
  @t = Thread.new { sg.wait }
end

Class Method Details

.start(title) ⇒ Object

Convenience method for initialize

: (String title) -> Async



12
13
14
 
# File 'lib/cli/ui/spinner/async.rb', line 12

def start(title)
  new(title)
end

Instance Method Details

#stop ⇒ Object

Stops an asynchronous spinner

: -> bool



41
42
43
44
 
# File 'lib/cli/ui/spinner/async.rb', line 41

def stop
  @m.synchronize { @cv.signal }
  @t.value
end