Module: Clif::Helper

Included in:
Clif
Defined in:
lib/clif/helper.rb

Instance Method Summary collapse

Instance Method Details

#ask(question, options = {}) ⇒ Object Also known as: prompt 



18
19
20
 
# File 'lib/clif/helper.rb', line 18

def ask(question, options = {})
  ::Clif::Questioner.new(options).ask(question)
end

#explain(action, message) ⇒ Object 



28
29
30
 
# File 'lib/clif/helper.rb', line 28

def explain(action, message)
  say "#{title_for_action(action)}: #{message}"
end

#no?(question) ⇒ Boolean

Returns:

  • (Boolean) 


10
11
12
 
# File 'lib/clif/helper.rb', line 10

def no?(question)
  !yes?(question)
end

#perform_action(action, message, &block) ⇒ Object 



23
24
25
26
 
# File 'lib/clif/helper.rb', line 23

def perform_action(action, message, &block)
  explain(action, message)
  yield unless pretend?
end

#pretend? ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/clif/helper.rb', line 36

def pretend?
  @options[:pretend] || false
end

#quiet? ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
 
# File 'lib/clif/helper.rb', line 32

def quiet?
  @options[:quiet] || false
end

#say(message) ⇒ Object 



6
7
8
 
# File 'lib/clif/helper.rb', line 6

def say(message)
  $stdout.puts(message) unless quiet?
end

#yes?(question) ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
 
# File 'lib/clif/helper.rb', line 14

def yes?(question)
  !!ask(question)
end