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 



821
822
823
824
 
# File 'lib/morpheus/cli/cli_command.rb', line 821

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

#add_subcommand_alias(alias_cmd_name, cmd_name) ⇒ Object 



841
842
843
844
 
# File 'lib/morpheus/cli/cli_command.rb', line 841

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



832
833
834
835
 
# File 'lib/morpheus/cli/cli_command.rb', line 832

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 



768
769
770
771
 
# File 'lib/morpheus/cli/cli_command.rb', line 768

def command_name
  @command_name ||= default_command_name
  @command_name
end

#default_command_name ⇒ Object 



764
765
766
 
# File 'lib/morpheus/cli/cli_command.rb', line 764

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

#default_subcommand ⇒ Object 



808
809
810
 
# File 'lib/morpheus/cli/cli_command.rb', line 808

def default_subcommand
  @default_subcommand
end

#has_subcommand?(cmd_name) ⇒ Boolean

Returns:

  • (Boolean) 


816
817
818
819
 
# File 'lib/morpheus/cli/cli_command.rb', line 816

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

#hidden_command ⇒ Object 



777
778
779
 
# File 'lib/morpheus/cli/cli_command.rb', line 777

def hidden_command
  !!@hidden_command
end

#register_subcommands(*cmds) ⇒ Object

construct map of command name => instance method



782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'lib/morpheus/cli/cli_command.rb', line 782

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 



826
827
828
829
 
# File 'lib/morpheus/cli/cli_command.rb', line 826

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

#remove_subcommand_alias(alias_cmd_name) ⇒ Object 



846
847
848
849
 
# File 'lib/morpheus/cli/cli_command.rb', line 846

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

#set_command_hidden(val = true) ⇒ Object 



773
774
775
 
# File 'lib/morpheus/cli/cli_command.rb', line 773

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

#set_command_name(cmd_name) ⇒ Object 



759
760
761
762
 
# File 'lib/morpheus/cli/cli_command.rb', line 759

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

#set_default_subcommand(cmd) ⇒ Object 



804
805
806
 
# File 'lib/morpheus/cli/cli_command.rb', line 804

def set_default_subcommand(cmd)
  @default_subcommand = cmd
end

#subcommand_aliases ⇒ Object 



837
838
839
 
# File 'lib/morpheus/cli/cli_command.rb', line 837

def subcommand_aliases
  @subcommand_aliases ||= {}
end

#subcommands ⇒ Object 



812
813
814
 
# File 'lib/morpheus/cli/cli_command.rb', line 812

def subcommands
  @subcommands ||= {}
end