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 



1549
1550
1551
1552
 
# File 'lib/morpheus/cli/cli_command.rb', line 1549

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

#add_subcommand_alias(alias_cmd_name, cmd_name) ⇒ Object 



1569
1570
1571
1572
 
# File 'lib/morpheus/cli/cli_command.rb', line 1569

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 



1583
1584
1585
1586
 
# File 'lib/morpheus/cli/cli_command.rb', line 1583

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



1560
1561
1562
1563
 
# File 'lib/morpheus/cli/cli_command.rb', line 1560

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 



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

def command_description
  @command_description
end

#command_name ⇒ Object 



1424
1425
1426
1427
 
# File 'lib/morpheus/cli/cli_command.rb', line 1424

def command_name
  @command_name ||= default_command_name
  @command_name
end

#default_command_name ⇒ Object 



1418
1419
1420
1421
1422
 
# File 'lib/morpheus/cli/cli_command.rb', line 1418

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



1455
1456
1457
 
# File 'lib/morpheus/cli/cli_command.rb', line 1455

def default_refresh_interval
  @default_refresh_interval ||= 30
end

#default_subcommand ⇒ Object 



1526
1527
1528
 
# File 'lib/morpheus/cli/cli_command.rb', line 1526

def default_subcommand
  @default_subcommand
end

#get_subcommand_description(cmd_name) ⇒ Object 



1588
1589
1590
1591
1592
1593
1594
1595
1596
 
# File 'lib/morpheus/cli/cli_command.rb', line 1588

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) 


1544
1545
1546
1547
 
# File 'lib/morpheus/cli/cli_command.rb', line 1544

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



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

def hidden_command
  !!@hidden_command
end

#prog_name ⇒ Object 



1409
1410
1411
 
# File 'lib/morpheus/cli/cli_command.rb', line 1409

def prog_name
  "morpheus"
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.



1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
 
# File 'lib/morpheus/cli/cli_command.rb', line 1494

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



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
 
# File 'lib/morpheus/cli/cli_command.rb', line 1466

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 



1554
1555
1556
1557
 
# File 'lib/morpheus/cli/cli_command.rb', line 1554

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

#remove_subcommand_alias(alias_cmd_name) ⇒ Object 



1574
1575
1576
1577
 
# File 'lib/morpheus/cli/cli_command.rb', line 1574

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

#set_command_description(val) ⇒ Object 



1450
1451
1452
 
# File 'lib/morpheus/cli/cli_command.rb', line 1450

def set_command_description(val)
  @command_description = val
end

#set_command_hidden(val = true) ⇒ Object 



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

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

#set_command_name(cmd_name) ⇒ Object 



1413
1414
1415
1416
 
# File 'lib/morpheus/cli/cli_command.rb', line 1413

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 



1459
1460
1461
 
# File 'lib/morpheus/cli/cli_command.rb', line 1459

def set_default_refresh_interval(seconds)
  @default_refresh_interval = seconds
end

#set_default_subcommand(cmd) ⇒ Object 



1522
1523
1524
 
# File 'lib/morpheus/cli/cli_command.rb', line 1522

def set_default_subcommand(cmd)
  @default_subcommand = cmd
end

#set_subcommand_descriptions(cmd_map) ⇒ Object 



1598
1599
1600
1601
1602
 
# File 'lib/morpheus/cli/cli_command.rb', line 1598

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 



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

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

#subcommand_aliases ⇒ Object 



1565
1566
1567
 
# File 'lib/morpheus/cli/cli_command.rb', line 1565

def subcommand_aliases
  @subcommand_aliases ||= {}
end

#subcommand_descriptions ⇒ Object 



1579
1580
1581
 
# File 'lib/morpheus/cli/cli_command.rb', line 1579

def subcommand_descriptions
  @subcommand_descriptions ||= {}
end

#subcommands ⇒ Object 



1530
1531
1532
 
# File 'lib/morpheus/cli/cli_command.rb', line 1530

def subcommands
  @subcommands ||= {}
end

#visible_subcommands ⇒ Object 



1534
1535
1536
1537
1538
1539
1540
1541
1542
 
# File 'lib/morpheus/cli/cli_command.rb', line 1534

def visible_subcommands
  cmds = subcommands.clone
  if @hidden_subcommands && !@hidden_subcommands.empty?
    @hidden_subcommands.each do |hidden_cmd|
      cmds.delete(hidden_cmd.to_s.gsub('_', '-'))
    end
  end
  cmds
end