Module: FreshBooks::CLI::Spinner

Defined in:
lib/freshbooks/spinner.rb

Constant Summary collapse

FRAMES = 
%w[⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏].freeze

Class Method Summary collapse

Class Method Details

.interactive=(value) ⇒ Object 



10
11
12
 
# File 'lib/freshbooks/spinner.rb', line 10

def self.interactive=(value)
  @interactive = value
end

.interactive? ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
17
 
# File 'lib/freshbooks/spinner.rb', line 14

def self.interactive?
  return @interactive unless @interactive.nil?
  $stderr.tty?
end

.spin(message) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/freshbooks/spinner.rb', line 19

def self.spin(message)
  result = nil

  unless interactive?
    result = yield
    return result
  end

  done = false
  thread = Thread.new do
    i = 0
    while !done
      $stderr.print "\r#{FRAMES[i % FRAMES.length]} #{message}"
      $stderr.flush
      i += 1
      sleep 0.08
    end
  end

  begin
    result = yield
  ensure
    done = true
    thread.join
    $stderr.print "\r✓ #{message}\n"
  end

  result
end