Class: Nugrant::Vagrant::V2::Command::Env

Inherits:
Object
  • Object
show all
Defined in:
lib/nugrant/vagrant/v2/command/env.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arguments, environment) ⇒ Env

Returns a new instance of Env.



16
17
18
19
20
21
22
23
 
# File 'lib/nugrant/vagrant/v2/command/env.rb', line 16

def initialize(arguments, environment)
  super(arguments, environment)

  @unset = false
  @format = :terminal
  @script_path = false
  @show_help = false
end

Class Method Details

.synopsis ⇒ Object 



12
13
14
 
# File 'lib/nugrant/vagrant/v2/command/env.rb', line 12

def self.synopsis
  "env utilities to export config.user as environment variables in host machine"
end

Instance Method Details

#create_parser ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/nugrant/vagrant/v2/command/env.rb', line 25

def create_parser()
  return OptionParser.new do |parser|
    parser.banner = "Usage: vagrant user env [<options>]"
    parser.separator ""

    parser.separator "Outputs the commands that should be executed to export\n" +
                     "the various parameter as environment variables. By default,\n" +
                     "existing ones are overridden. The --format argument can be used\n" +
                     "to choose in which format the variables should be displayed.\n" +
                     "Changing the format will also change where they are displayed.\n"
    parser.separator ""

    parser.separator "Available formats:"
    parser.separator "  autoenv  => Write commands to a file named `.env` in the current directory.\n" +
                     "               See https://github.com/kennethreitz/autoenv for more info."
    parser.separator "  terminal => Display commands to terminal so they can be sourced."
    parser.separator "  script   => Write commands to a bash script named `nugrant2env.sh` so it can be sourced."
    parser.separator ""

    parser.separator "Available options:"
    parser.separator ""

    parser.on("-u", "--unset", "Generates commands needed to unset environment variables, default false") do
      @unset = true
    end

    parser.on("-f", "--format FORMAT", "Determines in what format variables are output, default to terminal") do |format|
       @format = format.to_sym()
    end

    parser.on("-s", "--script-path PATH", "Specifies path of the generated bash script, default to #{EnvExporter::DEFAULT_SCRIPT_PATH}") do |path|
       @script_path = path
    end

    parser.on("-h", "--help", "Prints this help") do
      @show_help = true
    end
  end
end

#error(message, parser) ⇒ Object 



65
66
67
68
69
70
71
72
 
# File 'lib/nugrant/vagrant/v2/command/env.rb', line 65

def error(message, parser)
  @env.ui.info("ERROR: #{message}", :prefix => false)
  @env.ui.info("", :prefix => false)

  help(parser)

  return 1
end

#execute ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/nugrant/vagrant/v2/command/env.rb', line 78

def execute
  parser = create_parser()
  arguments = parse_options(parser)

  return error("Invalid format value '#{@format}'", parser) if not EnvExporter.valid?(@format)
  return help(parser) if @show_help

  @logger.debug("Nugrant 'Env'")
  with_target_vms(arguments) do |vm|
    parameters = vm.config.user
    if not parameters
      @env.ui.info("# Vm '#{vm.name}' : unable to retrieve `config.user`, report as bug https://github.com/maoueh/nugrant/issues", :prefix => false)
      next
    end

    bag = parameters.__all

    options = {
      :type => @unset ? :unset : :export,
      :script_path => @script_path
    }

    case
    when @format == :script
      EnvExporter.script_exporter(bag, options)
    when @format == :autoenv
      EnvExporter.autoenv_exporter(bag, options)
    when @format == :terminal
      EnvExporter.terminal_exporter(bag, options)
    end

    # No need to execute for the other VMs
    return 0
  end
end

#help(parser) ⇒ Object 



74
75
76
 
# File 'lib/nugrant/vagrant/v2/command/env.rb', line 74

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