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 



1047
1048
1049
1050
 
# File 'lib/morpheus/cli/cli_command.rb', line 1047

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

#add_subcommand_alias(alias_cmd_name, cmd_name) ⇒ Object 



1067
1068
1069
1070
 
# File 'lib/morpheus/cli/cli_command.rb', line 1067

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

#alias_subcommand(alias_cmd_name, cmd_name) ⇒ Object

register an alias for a command



1058
1059
1060
1061
 
# File 'lib/morpheus/cli/cli_command.rb', line 1058

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 



996
997
998
 
# File 'lib/morpheus/cli/cli_command.rb', line 996

def command_description
  @command_description
end

#command_name ⇒ Object 



983
984
985
986
 
# File 'lib/morpheus/cli/cli_command.rb', line 983

def command_name
  @command_name ||= default_command_name
  @command_name
end

#default_command_name ⇒ Object 



977
978
979
980
981
 
# File 'lib/morpheus/cli/cli_command.rb', line 977

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

#default_subcommand ⇒ Object 



1034
1035
1036
 
# File 'lib/morpheus/cli/cli_command.rb', line 1034

def default_subcommand
  @default_subcommand
end

#has_subcommand?(cmd_name) ⇒ Boolean

Returns:

  • (Boolean) 


1042
1043
1044
1045
 
# File 'lib/morpheus/cli/cli_command.rb', line 1042

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

#hidden_command ⇒ Object 



992
993
994
 
# File 'lib/morpheus/cli/cli_command.rb', line 992

def hidden_command
  !!@hidden_command
end

#parse_command_result(cmd_result) ⇒ Object

Parse exit_code and err from a command result (object of some type) returns [exit_code, err]



942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'lib/morpheus/cli/cli_command.rb', line 942

def parse_command_result(cmd_result)
  exit_code, err = nil, nil
  if cmd_result.is_a?(Array)
    exit_code, err = cmd_result[0], cmd_result[1]
  elsif cmd_result.is_a?(Hash)
    exit_code, err = cmd_result[:exit_code], (cmd_result[:error] || cmd_result[:err])
  end
  if cmd_result == nil || cmd_result == true
    exit_code = 0
  elsif cmd_result == false
    exit_code = 1
  elsif cmd_result.is_a?(Integer)
    exit_code = cmd_result
  elsif cmd_result.is_a?(Float)
    exit_code = cmd_result.to_i
  elsif cmd_result.is_a?(String)
    exit_code = cmd_result.to_i
  else
    if cmd_result.respond_to?(:to_i)
      exit_code = cmd_result.to_i
    else
      # happens for aliases right now.. and execution flow probably, need to handle Array
      # uncomment to track them down, proceed with exit 0 for now
      #Morpheus::Logging::DarkPrinter.puts "debug: command #{command_name} produced an unexpected result: (#{cmd_result.class}) #{cmd_result}" if Morpheus::Logging.debug?
      exit_code = 0
    end
  end
  return exit_code, err
end

#register_subcommands(*cmds) ⇒ Object

construct map of command name => instance method



1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/morpheus/cli/cli_command.rb', line 1008

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 "Unable to register command of type: #{cmd.class} #{cmd}"
    end
  }
  return
end

#remove_subcommand(cmd_name) ⇒ Object 



1052
1053
1054
1055
 
# File 'lib/morpheus/cli/cli_command.rb', line 1052

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

#remove_subcommand_alias(alias_cmd_name) ⇒ Object 



1072
1073
1074
1075
 
# File 'lib/morpheus/cli/cli_command.rb', line 1072

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

#set_command_description(val) ⇒ Object 



1000
1001
1002
 
# File 'lib/morpheus/cli/cli_command.rb', line 1000

def set_command_description(val)
  @command_description = val
end

#set_command_hidden(val = true) ⇒ Object 



988
989
990
 
# File 'lib/morpheus/cli/cli_command.rb', line 988

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

#set_command_name(cmd_name) ⇒ Object 



972
973
974
975
 
# File 'lib/morpheus/cli/cli_command.rb', line 972

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

#set_default_subcommand(cmd) ⇒ Object 



1030
1031
1032
 
# File 'lib/morpheus/cli/cli_command.rb', line 1030

def set_default_subcommand(cmd)
  @default_subcommand = cmd
end

#subcommand_aliases ⇒ Object 



1063
1064
1065
 
# File 'lib/morpheus/cli/cli_command.rb', line 1063

def subcommand_aliases
  @subcommand_aliases ||= {}
end

#subcommands ⇒ Object 



1038
1039
1040
 
# File 'lib/morpheus/cli/cli_command.rb', line 1038

def subcommands
  @subcommands ||= {}
end