Module: Morpheus::Cli::CliCommand::ClassMethods

Defined in:
lib/morpheus/cli/cli_command.rb

Instance Method Summary collapse

Instance Method Details

#add_subcommand(cmd_name, method) ⇒ Object 



1427
1428
1429
1430
 
# File 'lib/morpheus/cli/cli_command.rb', line 1427

def add_subcommand(cmd_name, method)
  @subcommands ||= {}
  @subcommands[cmd_name.to_s] = method
end

#add_subcommand_alias(alias_cmd_name, cmd_name) ⇒ Object 



1447
1448
1449
1450
 
# File 'lib/morpheus/cli/cli_command.rb', line 1447

def add_subcommand_alias(alias_cmd_name, cmd_name)
  @subcommand_aliases ||= {}
  @subcommand_aliases[alias_cmd_name.to_s] = cmd_name
end

#add_subcommand_description(cmd_name, description) ⇒ Object 



1461
1462
1463
1464
 
# File 'lib/morpheus/cli/cli_command.rb', line 1461

def add_subcommand_description(cmd_name, description)
  @subcommand_descriptions ||= {}
  @subcommand_descriptions[cmd_name.to_s.gsub('_', '-')] = description
end

#alias_subcommand(alias_cmd_name, cmd_name) ⇒ Object

register an alias for a command



1438
1439
1440
1441
 
# File 'lib/morpheus/cli/cli_command.rb', line 1438

def alias_subcommand(alias_cmd_name, cmd_name)
  add_subcommand_alias(alias_cmd_name.to_s, cmd_name.to_s.gsub('_', '-'))
  return
end

#command_description ⇒ Object 



1323
1324
1325
 
# File 'lib/morpheus/cli/cli_command.rb', line 1323

def command_description
  @command_description
end

#command_name ⇒ Object 



1301
1302
1303
1304
 
# File 'lib/morpheus/cli/cli_command.rb', line 1301

def command_name
  @command_name ||= default_command_name
  @command_name
end

#default_command_name ⇒ Object 



1295
1296
1297
1298
1299
 
# File 'lib/morpheus/cli/cli_command.rb', line 1295

def default_command_name
  class_name = self.name.split('::')[-1]
  #class_name.sub!(/Command$/, '')
  Morpheus::Cli::CliRegistry.cli_ize(class_name)
end

#default_refresh_interval ⇒ Object

alias :command_description= :set_command_description



1332
1333
1334
 
# File 'lib/morpheus/cli/cli_command.rb', line 1332

def default_refresh_interval
  @default_refresh_interval ||= 30
end

#default_subcommand ⇒ Object 



1403
1404
1405
 
# File 'lib/morpheus/cli/cli_command.rb', line 1403

def default_subcommand
  @default_subcommand
end

#get_subcommand_description(cmd_name) ⇒ Object 



1466
1467
1468
1469
1470
1471
1472
1473
1474
 
# File 'lib/morpheus/cli/cli_command.rb', line 1466

def get_subcommand_description(cmd_name)
  desc = subcommand_descriptions[cmd_name.to_s.gsub('_', '-')]
  if desc
    return desc
  else
    cmd_method = subcommands.key(cmd_name)
    return cmd_method ? subcommand_descriptions[cmd_method.to_s.gsub('_', '-')] : nil
  end
end

#has_subcommand?(cmd_name) ⇒ Boolean

Returns:

  • (Boolean) 


1422
1423
1424
1425
 
# File 'lib/morpheus/cli/cli_command.rb', line 1422

def has_subcommand?(cmd_name)
  return false if cmd_name.empty?
  @subcommands && @subcommands[cmd_name.to_s]
end

#hidden_command ⇒ Object

alias :command_name= :set_command_name



1311
1312
1313
 
# File 'lib/morpheus/cli/cli_command.rb', line 1311

def hidden_command
  !!@hidden_command
end

#register_subcommand(*args) ⇒ Object

this might be the new hotness register_subcommand(:show) # do not do this, always define a description! register_subcommand(:list, “List things”) register_subcommand(“update-all”, “update_all”, “Update all things”) If the command name =~ method, no need to pass both command names will have “-” swapped in for “_” and vice versa for method names.



1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
 
# File 'lib/morpheus/cli/cli_command.rb', line 1371

def register_subcommand(*args)
  args = args.flatten
  cmd_name = args[0]
  cmd_method = nil
  cmd_desc = nil
  if args.count == 1
    cmd_method = cmd_name
  elsif args.count == 2
    if args[1].is_a?(Symbol)
      cmd_method = args[1]
    else
      cmd_method = cmd_name
      cmd_desc = args[1]
    end
  elsif args.count == 3
    cmd_method = args[1]
    cmd_desc = args[2]
  else
    raise Morpheus::Cli::CliRegistry::BadCommandDefinition.new("register_subcommand expects 1-3 arguments, got #{args.size} #{args.inspect}")
  end
  cmd_name = cmd_name.to_s.gsub("_", "-").to_sym
  cmd_method = (cmd_method || cmd_name).to_s.gsub("-", "_").to_sym
  cmd_definition = {(cmd_name) => cmd_method}
  register_subcommands(cmd_definition)
  add_subcommand_description(cmd_name, cmd_desc)
  return
end

#register_subcommands(*cmds) ⇒ Object

construct map of command name => instance method



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
 
# File 'lib/morpheus/cli/cli_command.rb', line 1343

def register_subcommands(*cmds)
  @subcommands ||= {}
  cmds.flatten.each {|cmd| 
    if cmd.is_a?(Hash)
      cmd.each {|k,v| 
        # @subcommands[k] = v
        add_subcommand(k.to_s, v.to_s)
      }
    elsif cmd.is_a?(Array) 
      cmd.each {|it| register_subcommands(it) }
    elsif cmd.is_a?(String) || cmd.is_a?(Symbol)
      #k = Morpheus::Cli::CliRegistry.cli_ize(cmd)
      k = cmd.to_s.gsub('_', '-')
      v = cmd.to_s.gsub('-', '_')
      register_subcommands({(k) => v})
    else
      raise Morpheus::Cli::CliRegistry::BadCommandDefinition.new("Unable to register command of type: #{cmd.class} #{cmd}")
    end
  }
  return
end

#remove_subcommand(cmd_name) ⇒ Object 



1432
1433
1434
1435
 
# File 'lib/morpheus/cli/cli_command.rb', line 1432

def remove_subcommand(cmd_name)
  @subcommands ||= {}
  @subcommands.delete(cmd_name.to_s)
end

#remove_subcommand_alias(alias_cmd_name) ⇒ Object 



1452
1453
1454
1455
 
# File 'lib/morpheus/cli/cli_command.rb', line 1452

def remove_subcommand_alias(alias_cmd_name)
  @subcommand_aliases ||= {}
  @subcommand_aliases.delete(alias_cmd_name.to_s)
end

#set_command_description(val) ⇒ Object 



1327
1328
1329
 
# File 'lib/morpheus/cli/cli_command.rb', line 1327

def set_command_description(val)
  @command_description = val
end

#set_command_hidden(val = true) ⇒ Object 



1306
1307
1308
 
# File 'lib/morpheus/cli/cli_command.rb', line 1306

def set_command_hidden(val=true)
  @hidden_command = val
end

#set_command_name(cmd_name) ⇒ Object 



1290
1291
1292
1293
 
# File 'lib/morpheus/cli/cli_command.rb', line 1290

def set_command_name(cmd_name)
  @command_name = cmd_name
  Morpheus::Cli::CliRegistry.add(self, self.command_name)
end

#set_default_refresh_interval(seconds) ⇒ Object 



1336
1337
1338
 
# File 'lib/morpheus/cli/cli_command.rb', line 1336

def set_default_refresh_interval(seconds)
  @default_refresh_interval = seconds
end

#set_default_subcommand(cmd) ⇒ Object 



1399
1400
1401
 
# File 'lib/morpheus/cli/cli_command.rb', line 1399

def set_default_subcommand(cmd)
  @default_subcommand = cmd
end

#set_subcommand_descriptions(cmd_map) ⇒ Object 



1476
1477
1478
1479
1480
 
# File 'lib/morpheus/cli/cli_command.rb', line 1476

def set_subcommand_descriptions(cmd_map)
  cmd_map.each do |cmd_name, description|
    add_subcommand_description(cmd_name, description)
  end
end

#set_subcommands_hidden(*cmds) ⇒ Object 



1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/morpheus/cli/cli_command.rb', line 1315

def set_subcommands_hidden(*cmds)
  @hidden_subcommands ||= []
  cmds.flatten.each do |cmd|
    @hidden_subcommands << cmd.to_sym
  end
  @hidden_subcommands
end

#subcommand_aliases ⇒ Object 



1443
1444
1445
 
# File 'lib/morpheus/cli/cli_command.rb', line 1443

def subcommand_aliases
  @subcommand_aliases ||= {}
end

#subcommand_descriptions ⇒ Object 



1457
1458
1459
 
# File 'lib/morpheus/cli/cli_command.rb', line 1457

def subcommand_descriptions
  @subcommand_descriptions ||= {}
end

#subcommands ⇒ Object 



1407
1408
1409
 
# File 'lib/morpheus/cli/cli_command.rb', line 1407

def subcommands
  @subcommands ||= {}
end

#visible_subcommands ⇒ Object 



1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
 
# File 'lib/morpheus/cli/cli_command.rb', line 1411

def visible_subcommands
  cmds = subcommands.clone
  if @hidden_subcommands && !@hidden_subcommands.empty?
    @hidden_subcommands.each do |hidden_cmd|
      cmds.delete(hidden_cmd.to_s)
      cmds.delete(hidden_cmd.to_sym)
    end
  end
  cmds
end