Class: Morpheus::Cli::AliasCommand
- Inherits:
-
Object
- Object
- Morpheus::Cli::AliasCommand
show all
- Includes:
- CliCommand
- Defined in:
- lib/morpheus/cli/commands/standard/alias_command.rb
Overview
This command allows the creation of an alias these aliases are stored in the $MORPHEUS_CLI_HOME/.morpheusrc See Morpheus::Cli::DotFile
Instance Attribute Summary
Attributes included from CliCommand
#no_prompt
Instance Method Summary
collapse
Methods included from CliCommand
#apply_options, #build_common_options, #build_option_type_options, #build_standard_add_options, #build_standard_delete_options, #build_standard_get_options, #build_standard_list_options, #build_standard_post_options, #build_standard_put_options, #build_standard_remove_options, #build_standard_update_options, #command_name, #default_refresh_interval, #default_subcommand, #establish_remote_appliance_connection, #full_command_usage, #get_subcommand_description, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_bytes_param, #parse_id_list, #parse_list_options, #parse_list_subtitles, #parse_passed_options, #parse_payload, #parse_query_options, #print, #print_error, #println, #puts, #puts_error, #raise_args_error, #raise_command_error, #render_response, #render_with_format, #run_command_for_each_arg, #subcommand_aliases, #subcommand_description, #subcommand_usage, #subcommands, #usage, #verify_args!, #visible_subcommands
Constructor Details
set_default_subcommand :add
17
18
|
# File 'lib/morpheus/cli/commands/standard/alias_command.rb', line 17
def initialize()
end
|
Instance Method Details
#add(args) ⇒ Object
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
# File 'lib/morpheus/cli/commands/standard/alias_command.rb', line 36
def add(args)
options = {}
do_export = false
optparse = Morpheus::Cli::OptionParser.new do|opts|
opts.banner = subcommand_usage("[name]='[command]'")
opts.on( '-e', '--export', "Export this alias to your .morpheus_profile for future use" ) do
do_export = true
end
opts.on('-h', '--help', "Print this help" ) do
puts opts
exit
end
formatted_commands_map = " " + subcommands.sort.collect {|cmd| "\t#{cmd}" }.join("\n")
opts. = <<-EOT
Define a new alias.
[name] is required. This is the alias name. It should be one word.
[command] is required. This is the full command wrapped in quotes.
Aliases can be exported for future use with the -e option.
The `alias add` command can be invoked with `alias [name]=[command]`
Examples:
alias cloud=clouds
alias ij='instances get -j'
alias new-hosts='hosts list -S id -D'
For more information, see https://github.com/gomorpheus/morpheus-cli/wiki/Alias
EOT
end
optparse.parse!(args)
verify_args!(args:args, optparse:optparse, min: 1)
if (args.count == 1)
alias_definition = args[0]
elsif (args.count == 2)
alias_definition = "#{args[0]}='#{args[1]}'"
else
args_alias_str = ""
alias_parts = args.join(' ').split('=')
left_side = alias_parts[0]
right_side = alias_parts[1..-1].join(' ')
args_alias_str = ""
alias_definition = "#{left_side}='#{right_side}'"
end
begin
alias_name, command_string = Morpheus::Cli::CliRegistry.parse_alias_definition(alias_definition)
if alias_name.empty? || command_string.empty?
print_red_alert "invalid alias syntax: #{alias_definition}"
return false
end
Morpheus::Cli::CliRegistry.instance.add_alias(alias_name, command_string)
if do_export
morpheus_profile = Morpheus::Cli::DotFile.new(Morpheus::Cli::DotFile.morpheus_profile_filename)
morpheus_profile.export_aliases({(alias_name) => command_string})
end
rescue Morpheus::Cli::CliRegistry::BadAlias => err
print_red_alert "#{err.message}"
return false
rescue => err
print_red_alert "#{err.message}"
return false
end
if Morpheus::Cli::Shell.has_instance?
Morpheus::Cli::Shell.instance.recalculate_auto_complete_commands()
end
end
|
#export(args) ⇒ Object
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
# File 'lib/morpheus/cli/commands/standard/alias_command.rb', line 115
def export(args)
options = {}
do_export = false
optparse = Morpheus::Cli::OptionParser.new do|opts|
opts.banner = subcommand_usage("[alias] [alias2] [alias3]")
build_common_options(opts, options, [])
opts. = "Export an alias, saving it to your .morpheus_profile for future use"
end
optparse.parse!(args)
verify_args!(args:args, optparse:optparse, min: 1)
alias_names = args
alias_names.each do |arg|
if !Morpheus::Cli::CliRegistry.has_alias?(arg)
print_red_alert "alias not found by name '#{arg}'"
return false
end
end
alias_definitions = {}
alias_names.each do |alias_name|
alias_definitions[alias_name] = Morpheus::Cli::CliRegistry.instance.get_alias(alias_name)
end
morpheus_profile = Morpheus::Cli::DotFile.new(Morpheus::Cli::DotFile.morpheus_profile_filename)
morpheus_profile.export_aliases(alias_definitions)
end
|
#handle(args) ⇒ Object
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
# File 'lib/morpheus/cli/commands/standard/alias_command.rb', line 20
def handle(args)
if args.empty?
list(args)
elsif self.class.has_subcommand?(args[0])
handle_subcommand(args)
elsif (args.count == 1) && (args[0] == '-h' || args[0] == '--help')
handle_subcommand(args)
elsif (args.count == 1) || (args.count == 2 && args.include?('-e'))
add(args)
else
handle_subcommand(args)
end
end
|
#list(args) ⇒ Object
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
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
224
225
226
227
228
229
230
231
232
233
234
235
236
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
|
# File 'lib/morpheus/cli/commands/standard/alias_command.rb', line 181
def list(args)
options = {format:'table', sort:'name'}
do_export = false
optparse = Morpheus::Cli::OptionParser.new do|opts|
opts.banner = subcommand_usage()
opts.on( '-f', '--format FORMAT', "The format for the output: export, json, list, table (default)." ) do |val|
options[:format] = val
end
opts.on( '-e', '--export', "Include the '-e' switch after each alias in the output. This implies --format export." ) do
options[:format] = 'export'
do_export = true
end
build_common_options(opts, options, [:list, :json])
opts. = <<-EOT
Print list of defined aliases.
Use the --format option to vary output.
The `alias list` command can be abbreviated as just `alias`.
For more information, see https://github.com/gomorpheus/morpheus-cli/wiki/Alias
EOT
end
optparse.parse!(args)
my_aliases = Morpheus::Cli::CliRegistry.all_aliases.collect {|k,v|
{name: k, command: v}
}
if options[:phrase]
match_regex = /#{Regexp.escape(options[:phrase])}/
my_aliases = my_aliases.select {|it|
it[:name].to_s =~ match_regex || it[:command].to_s =~ match_regex
}
end
options[:sort] ||= 'name'
options[:direction] ||= 'asc'
if options[:sort]
if options[:sort].to_s == 'name' || options[:sort].to_s == 'alias'
my_aliases = my_aliases.sort {|x,y| x[:name].to_s.downcase <=> y[:name].to_s.downcase }
elsif options[:sort].to_s == 'command' || options[:sort].to_s == 'command_string'
my_aliases = my_aliases.sort {|x,y| x[:command].to_s.downcase <=> y[:command].to_s.downcase }
else
end
end
if options[:direction] == 'desc'
my_aliases = my_aliases.reverse
end
if options[:offset]
my_aliases = my_aliases.slice(options[:offset].to_i, my_aliases.size)
end
if options[:max]
my_aliases = my_aliases.first(options[:max].to_i)
end
num_aliases = my_aliases.size
out = ""
if options[:json]
options[:format] = 'json'
end
if options[:format] == 'json' || options[:json]
alias_json = {}
my_aliases.each do |it|
alias_json[it[:name]] = it[:command]
end
out << JSON.pretty_generate({aliases: alias_json})
out << "\n"
elsif options[:format] == 'export' || options[:format] == 'e' || options[:format] == 'config'
my_aliases.each do |it|
out << "alias #{it[:name]}='#{it[:command]}'"
if do_export
out << " -e"
end
out << "\n"
end
elsif options[:format] == 'list'
my_aliases.each do |it|
out << "#{cyan}#{it[:name]}#{reset}='#{it[:command]}'"
out << "\n"
end
out << reset
else
alias_columns = {
"ALIAS" => lambda {|it| it[:name] },
"COMMAND" => lambda {|it| it[:command] }
}
out << "\n"
out << cyan
out << as_pretty_table(my_aliases, alias_columns, {:border_style => :thin}.merge(options))
out << ({size:my_aliases.size,total:my_aliases.size.to_i})
out << reset
out << "\n"
end
print out
end
|
#remove(args) ⇒ Object
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
# File 'lib/morpheus/cli/commands/standard/alias_command.rb', line 143
def remove(args)
options = {}
optparse = Morpheus::Cli::OptionParser.new do|opts|
opts.banner = subcommand_usage("[alias1] [alias2]")
build_common_options(opts, options, [])
opts. = "This is how you remove alias definitions from your .morpheus_profile" + "\n"
"Pass one or more alias names to remove."
end
optparse.parse!(args)
if args.count < 1
puts optparse
exit 1
end
alias_names = args
alias_names.each do |arg|
if !Morpheus::Cli::CliRegistry.has_alias?(arg)
print_red_alert "alias not found by name '#{arg}'"
return false
end
end
morpheus_profile = Morpheus::Cli::DotFile.new(Morpheus::Cli::DotFile.morpheus_profile_filename)
morpheus_profile.remove_aliases(alias_names)
alias_names.each do |alias_name|
Morpheus::Cli::CliRegistry.instance.remove_alias(alias_name)
end
Morpheus::Cli::Shell.instance.recalculate_auto_complete_commands() if Morpheus::Cli::Shell.instance
end
|