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 



720
721
722
723
 
# File 'lib/morpheus/cli/cli_command.rb', line 720

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

#add_subcommand_alias(alias_cmd_name, cmd_name) ⇒ Object 



740
741
742
743
 
# File 'lib/morpheus/cli/cli_command.rb', line 740

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



731
732
733
734
 
# File 'lib/morpheus/cli/cli_command.rb', line 731

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

#command_name ⇒ Object 



667
668
669
670
 
# File 'lib/morpheus/cli/cli_command.rb', line 667

def command_name
  @command_name ||= default_command_name
  @command_name
end

#default_command_name ⇒ Object 



663
664
665
 
# File 'lib/morpheus/cli/cli_command.rb', line 663

def default_command_name
  Morpheus::Cli::CliRegistry.cli_ize(self.name.split('::')[-1])
end

#default_subcommand ⇒ Object 



707
708
709
 
# File 'lib/morpheus/cli/cli_command.rb', line 707

def default_subcommand
  @default_subcommand
end

#has_subcommand?(cmd_name) ⇒ Boolean

Returns:

  • (Boolean) 


715
716
717
718
 
# File 'lib/morpheus/cli/cli_command.rb', line 715

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

#hidden_command ⇒ Object 



676
677
678
 
# File 'lib/morpheus/cli/cli_command.rb', line 676

def hidden_command
  !!@hidden_command
end

#register_subcommands(*cmds) ⇒ Object

construct map of command name => instance method



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/morpheus/cli/cli_command.rb', line 681

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 



725
726
727
728
 
# File 'lib/morpheus/cli/cli_command.rb', line 725

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

#remove_subcommand_alias(alias_cmd_name) ⇒ Object 



745
746
747
748
 
# File 'lib/morpheus/cli/cli_command.rb', line 745

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

#set_command_hidden(val = true) ⇒ Object 



672
673
674
 
# File 'lib/morpheus/cli/cli_command.rb', line 672

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

#set_command_name(cmd_name) ⇒ Object 



658
659
660
661
 
# File 'lib/morpheus/cli/cli_command.rb', line 658

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

#set_default_subcommand(cmd) ⇒ Object 



703
704
705
 
# File 'lib/morpheus/cli/cli_command.rb', line 703

def set_default_subcommand(cmd)
  @default_subcommand = cmd
end

#subcommand_aliases ⇒ Object 



736
737
738
 
# File 'lib/morpheus/cli/cli_command.rb', line 736

def subcommand_aliases
  @subcommand_aliases ||= {}
end

#subcommands ⇒ Object 



711
712
713
 
# File 'lib/morpheus/cli/cli_command.rb', line 711

def subcommands
  @subcommands ||= {}
end