Class: VagrantPlugins::VBoxSnapshot::Command::Root

Inherits:
Object
  • Object
show all
Defined in:
lib/vagrant-vbox-snapshot/commands/root.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv, env) ⇒ Root

Returns a new instance of Root.



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/vagrant-vbox-snapshot/commands/root.rb', line 9

def initialize(argv, env)
  super 

  @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)

  @subcommands = Vagrant::Registry.new
  @subcommands.register(:take) do
    require_relative('take')
    Take
  end
  @subcommands.register(:list) do
    require_relative('list')
    List
  end
  @subcommands.register(:go) do
    require_relative('go')
    Go
  end
  @subcommands.register(:back) do
    require_relative('back')
    Back
  end
  @subcommands.register(:delete) do
    require_relative('delete')
    Delete
  end
end

Class Method Details

.synopsis ⇒ Object 



5
6
7
 
# File 'lib/vagrant-vbox-snapshot/commands/root.rb', line 5

def self.synopsis
  "manages snapshots of the machine: taking, restoring, deleting, etc."
end

Instance Method Details

#execute ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/vagrant-vbox-snapshot/commands/root.rb', line 37

def execute
  if @main_args.include?("-h") || @main_args.include?("--help")
    # Print the help for all the box commands.
    return help
  end

  # If we reached this far then we must have a subcommand. If not,
  # then we also just print the help and exit.
  command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
  return help if !command_class || !@sub_command
  @logger.debug("Invoking command class: #{command_class} #{@sub_args.inspect}")

  # Initialize and execute the command class
  command_class.new(@sub_args, @env).execute
end

#help ⇒ Object

Prints the help out for this command



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/vagrant-vbox-snapshot/commands/root.rb', line 54

def help
  opts = OptionParser.new do |opts|
    opts.banner = "Usage: vagrant snapshot <command> [<args>]"
    opts.separator ""
    opts.separator "Available subcommands:"

    # Add the available subcommands as separators in order to print them
    # out as well.
    keys = []
    @subcommands.each { |key, value| keys << key.to_s }

    keys.sort.each do |key|
      opts.separator "     #{key}"
    end

    opts.separator ""
    opts.separator "For help on any individual command run `vagrant snapshot <command> -h`"
  end

  @env.ui.info(opts.help, :prefix => false)
end