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 



723
724
725
726
 
# File 'lib/morpheus/cli/cli_command.rb', line 723

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

#add_subcommand_alias(alias_cmd_name, cmd_name) ⇒ Object 



743
744
745
746
 
# File 'lib/morpheus/cli/cli_command.rb', line 743

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



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

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 



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

def command_name
  @command_name ||= default_command_name
  @command_name
end

#default_command_name ⇒ Object 



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

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

#default_subcommand ⇒ Object 



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

def default_subcommand
  @default_subcommand
end

#has_subcommand?(cmd_name) ⇒ Boolean

Returns:

  • (Boolean) 


718
719
720
721
 
# File 'lib/morpheus/cli/cli_command.rb', line 718

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

#hidden_command ⇒ Object 



679
680
681
 
# File 'lib/morpheus/cli/cli_command.rb', line 679

def hidden_command
  !!@hidden_command
end

#register_subcommands(*cmds) ⇒ Object

construct map of command name => instance method



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

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 



728
729
730
731
 
# File 'lib/morpheus/cli/cli_command.rb', line 728

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

#remove_subcommand_alias(alias_cmd_name) ⇒ Object 



748
749
750
751
 
# File 'lib/morpheus/cli/cli_command.rb', line 748

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

#set_command_hidden(val = true) ⇒ Object 



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

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

#set_command_name(cmd_name) ⇒ Object 



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

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

#set_default_subcommand(cmd) ⇒ Object 



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

def set_default_subcommand(cmd)
  @default_subcommand = cmd
end

#subcommand_aliases ⇒ Object 



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

def subcommand_aliases
  @subcommand_aliases ||= {}
end

#subcommands ⇒ Object 



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

def subcommands
  @subcommands ||= {}
end