Class: Chef::Knife::UI
- Inherits:
-
Object
- Object
- Chef::Knife::UI
- Extended by:
- Forwardable
- Defined in:
- lib/chef/knife/core/ui.rb
Overview
Chef::Knife::UI
The User Interaction class used by knife.
Instance Attribute Summary collapse
-
#config ⇒ Object
readonly
Returns the value of attribute config.
-
#presenter ⇒ Object
readonly
Returns the value of attribute presenter.
-
#stderr ⇒ Object
readonly
Returns the value of attribute stderr.
-
#stdin ⇒ Object
readonly
Returns the value of attribute stdin.
-
#stdout ⇒ Object
readonly
Returns the value of attribute stdout.
Instance Method Summary collapse
- #ask(*args, &block) ⇒ Object
- #ask_question(question, opts = {}) ⇒ Object
- #color(string, *colors) ⇒ Object
-
#color? ⇒ Boolean
Should colored output be used? For output to a terminal, this is determined by the value of ‘config`.
-
#confirm(question, append_instructions = true, default_choice = nil) ⇒ Object
Not the ideal signature for a function but we need to stick with this for now until we get a chance to break our API in Chef 12.
-
#confirm_without_exit(question, append_instructions = true, default_choice = nil) ⇒ Object
See confirm method for argument information.
- #confirmation_instructions(default_choice) ⇒ Object
- #edit_data(data, parse_output = true, object_class: nil) ⇒ Object
-
#edit_hash(hash) ⇒ Object
Hash -> Hash Works the same as edit_data but returns a hash rather than a JSON string/Fully inflated object.
- #edit_object(klass, name) ⇒ Object
-
#error(message) ⇒ Object
Print an error message.
-
#fatal(message) ⇒ Object
Print a message describing a fatal error.
- #highline ⇒ Object
-
#initialize(stdout, stderr, stdin, config) ⇒ UI
constructor
A new instance of UI.
-
#interchange? ⇒ Boolean
Determines if the output format is a data interchange format, i.e., JSON or YAML.
- #list(*args) ⇒ Object
-
#log(message) ⇒ Object
(also: #info, #err)
Prints a msg to stderr.
-
#msg(message) ⇒ Object
Prints a message to stdout.
-
#output(data) ⇒ Object
Formats
data
using the configured presenter and outputs the result viamsg
. - #pretty_print(data) ⇒ Object
-
#use_presenter(presenter_class) ⇒ Object
Creates a new
presenter_class
object and uses it to format structured data for display. -
#warn(message) ⇒ Object
Print a warning message.
Constructor Details
#initialize(stdout, stderr, stdin, config) ⇒ UI
Returns a new instance of UI.
46 47 48 49 |
# File 'lib/chef/knife/core/ui.rb', line 46 def initialize(stdout, stderr, stdin, config) @stdout, @stderr, @stdin, @config = stdout, stderr, stdin, config @presenter = Chef::Knife::Core::GenericPresenter.new(self, config) end |
Instance Attribute Details
#config ⇒ Object (readonly)
Returns the value of attribute config.
38 39 40 |
# File 'lib/chef/knife/core/ui.rb', line 38 def config @config end |
#presenter ⇒ Object (readonly)
Returns the value of attribute presenter.
40 41 42 |
# File 'lib/chef/knife/core/ui.rb', line 40 def presenter @presenter end |
#stderr ⇒ Object (readonly)
Returns the value of attribute stderr.
36 37 38 |
# File 'lib/chef/knife/core/ui.rb', line 36 def stderr @stderr end |
#stdin ⇒ Object (readonly)
Returns the value of attribute stdin.
37 38 39 |
# File 'lib/chef/knife/core/ui.rb', line 37 def stdin @stdin end |
#stdout ⇒ Object (readonly)
Returns the value of attribute stdout.
35 36 37 |
# File 'lib/chef/knife/core/ui.rb', line 35 def stdout @stdout end |
Instance Method Details
#ask(*args, &block) ⇒ Object
119 120 121 |
# File 'lib/chef/knife/core/ui.rb', line 119 def ask(*args, &block) highline.ask(*args, &block) end |
#ask_question(question, opts = {}) ⇒ Object
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/chef/knife/core/ui.rb', line 140 def ask_question(question, opts = {}) question = question + "[#{opts[:default]}] " if opts[:default] if opts[:default] && config[:defaults] opts[:default] else stdout.print question a = stdin.readline.strip if opts[:default] a.empty? ? opts[:default] : a else a end end end |
#color(string, *colors) ⇒ Object
104 105 106 107 108 109 110 |
# File 'lib/chef/knife/core/ui.rb', line 104 def color(string, *colors) if color? highline.color(string, *colors) else string end end |
#color? ⇒ Boolean
Should colored output be used? For output to a terminal, this is determined by the value of ‘config`. When output is not to a terminal, colored output is never used
115 116 117 |
# File 'lib/chef/knife/core/ui.rb', line 115 def color? Chef::Config[:color] && stdout.tty? end |
#confirm(question, append_instructions = true, default_choice = nil) ⇒ Object
Not the ideal signature for a function but we need to stick with this for now until we get a chance to break our API in Chef 12.
question => Question to print before asking for confirmation append_instructions => Should print ‘? (Y/N)’ as instructions default_choice => Set to true for ‘Y’, and false for ‘N’ as default answer
275 276 277 278 279 280 |
# File 'lib/chef/knife/core/ui.rb', line 275 def confirm(question, append_instructions = true, default_choice = nil) unless confirm_without_exit(question, append_instructions, default_choice) exit 3 end true end |
#confirm_without_exit(question, append_instructions = true, default_choice = nil) ⇒ Object
See confirm method for argument information
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/chef/knife/core/ui.rb', line 237 def confirm_without_exit(question, append_instructions = true, default_choice = nil) return true if config[:yes] stdout.print question stdout.print confirmation_instructions(default_choice) if append_instructions answer = stdin.readline answer.chomp! case answer when "Y", "y" true when "N", "n" self.msg("You said no, so I'm done here.") false when "" unless default_choice.nil? default_choice else self.msg("I have no idea what to do with '#{answer}'") self.msg("Just say Y or N, please.") confirm_without_exit(question, append_instructions, default_choice) end else self.msg("I have no idea what to do with '#{answer}'") self.msg("Just say Y or N, please.") confirm_without_exit(question, append_instructions, default_choice) end end |
#confirmation_instructions(default_choice) ⇒ Object
225 226 227 228 229 230 231 232 233 234 |
# File 'lib/chef/knife/core/ui.rb', line 225 def confirmation_instructions(default_choice) case default_choice when true "? (Y/n) " when false "? (y/N) " else "? (Y/N) " end end |
#edit_data(data, parse_output = true, object_class: nil) ⇒ Object
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'lib/chef/knife/core/ui.rb', line 174 def edit_data(data, parse_output = true, object_class: nil) output = Chef::JSONCompat.to_json_pretty(data) if !config[:disable_editing] Tempfile.open([ "knife-edit-", ".json" ]) do |tf| tf.sync = true tf.puts output tf.close raise "Please set EDITOR environment variable" unless system("#{config[:editor]} #{tf.path}") output = IO.read(tf.path) end end if parse_output if object_class.nil? Chef.log_deprecation("Auto inflation of JSON data is deprecated. Please pass in the class to inflate or use #edit_hash") Chef::JSONCompat.from_json(output) else object_class.from_hash(Chef::JSONCompat.parse(output)) end else output end end |
#edit_hash(hash) ⇒ Object
Hash -> Hash Works the same as edit_data but returns a hash rather than a JSON string/Fully inflated object
169 170 171 172 |
# File 'lib/chef/knife/core/ui.rb', line 169 def edit_hash(hash) raw = edit_data(hash, false) Chef::JSONCompat.parse(raw) end |
#edit_object(klass, name) ⇒ Object
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/chef/knife/core/ui.rb', line 199 def edit_object(klass, name) object = klass.load(name) output = edit_data(object, object_class: klass) # Only make the save if the user changed the object. # # Output JSON for the original (object) and edited (output), then parse # them without reconstituting the objects into real classes # (create_additions=false). Then, compare the resulting simple objects, # which will be Array/Hash/String/etc. # # We wouldn't have to do these shenanigans if all the editable objects # implemented to_hash, or if to_json against a hash returned a string # with stable key order. object_parsed_again = Chef::JSONCompat.parse(Chef::JSONCompat.to_json(object)) output_parsed_again = Chef::JSONCompat.parse(Chef::JSONCompat.to_json(output)) if object_parsed_again != output_parsed_again output.save self.msg("Saved #{output}") else self.msg("Object unchanged, not saving") end output(format_for_display(object)) if config[:print_after] end |
#error(message) ⇒ Object
Print an error message
95 96 97 |
# File 'lib/chef/knife/core/ui.rb', line 95 def error() log("#{color('ERROR:', :red, :bold)} #{}") end |
#fatal(message) ⇒ Object
Print a message describing a fatal error.
100 101 102 |
# File 'lib/chef/knife/core/ui.rb', line 100 def fatal() log("#{color('FATAL:', :red, :bold)} #{}") end |
#highline ⇒ Object
58 59 60 61 62 63 |
# File 'lib/chef/knife/core/ui.rb', line 58 def highline @highline ||= begin require "highline" HighLine.new end end |
#interchange? ⇒ Boolean
Determines if the output format is a data interchange format, i.e., JSON or YAML
136 137 138 |
# File 'lib/chef/knife/core/ui.rb', line 136 def interchange? @presenter.interchange? end |
#list(*args) ⇒ Object
123 124 125 |
# File 'lib/chef/knife/core/ui.rb', line 123 def list(*args) highline.list(*args) end |
#log(message) ⇒ Object Also known as: info, err
Prints a msg to stderr. Used for info, warn, error, and fatal.
77 78 79 80 81 82 83 84 |
# File 'lib/chef/knife/core/ui.rb', line 77 def log() begin stderr.puts rescue Errno::EPIPE => e raise e if @config[:verbosity] >= 2 exit 0 end end |
#msg(message) ⇒ Object
Prints a message to stdout. Aliased as info
for compatibility with the logger API.
67 68 69 70 71 72 73 74 |
# File 'lib/chef/knife/core/ui.rb', line 67 def msg() begin stdout.puts rescue Errno::EPIPE => e raise e if @config[:verbosity] >= 2 exit 0 end end |
#output(data) ⇒ Object
Formats data
using the configured presenter and outputs the result via msg
. Formatting can be customized by configuring a different presenter. See use_presenter
130 131 132 |
# File 'lib/chef/knife/core/ui.rb', line 130 def output(data) msg @presenter.format(data) end |
#pretty_print(data) ⇒ Object
157 158 159 160 161 162 163 164 |
# File 'lib/chef/knife/core/ui.rb', line 157 def pretty_print(data) begin stdout.puts data rescue Errno::EPIPE => e raise e if @config[:verbosity] >= 2 exit 0 end end |
#use_presenter(presenter_class) ⇒ Object
Creates a new presenter_class
object and uses it to format structured data for display. By default, a Chef::Knife::Core::GenericPresenter object is used.
54 55 56 |
# File 'lib/chef/knife/core/ui.rb', line 54 def use_presenter(presenter_class) @presenter = presenter_class.new(self, config) end |
#warn(message) ⇒ Object
Print a warning message
90 91 92 |
# File 'lib/chef/knife/core/ui.rb', line 90 def warn() log("#{color('WARNING:', :yellow, :bold)} #{}") end |