module Aruba::Api::Environment

Environment methods of aruba

Public Instance Methods

append_environment_variable(name, value) click to toggle source

Append environment variable

@param [String] name

The name of the environment variable as string, e.g. 'HOME'

@param [String] value

The value of the environment variable. Needs to be a string.

@return [self]

# File lib/aruba/api/environment.rb, line 43
def append_environment_variable(name, value)
  name = name.to_s
  value = value.to_s

  old_environment = aruba.environment.to_h
  aruba.environment.append name, value
  new_environment = aruba.environment.to_h

  environment_change = { old: old_environment,
                         new: new_environment,
                         changed: { name: name, value: value } }
  aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)

  self
end
delete_environment_variable(name) click to toggle source

Remove existing environment variable

@param [String] name

The name of the environment variable as string, e.g. 'HOME'

@return [self]

# File lib/aruba/api/environment.rb, line 90
def delete_environment_variable(name)
  name = name.to_s

  old_environment = aruba.environment.to_h
  aruba.environment.delete name
  new_environment = aruba.environment.to_h

  environment_change = { old: old_environment,
                         new: new_environment,
                         changed: { name: name, value: "" } }
  aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)

  self
end
prepend_environment_variable(name, value) click to toggle source

Prepend environment variable

@param [String] name

The name of the environment variable as string, e.g. 'HOME'

@param [String] value

The value of the environment variable. Needs to be a string.

@return [self]

# File lib/aruba/api/environment.rb, line 68
def prepend_environment_variable(name, value)
  name = name.to_s
  value = value.to_s

  old_environment = aruba.environment.to_h
  aruba.environment.prepend name, value
  new_environment = aruba.environment.to_h

  environment_change = { old: old_environment,
                         new: new_environment,
                         changed: { name: name, value: value } }
  aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)

  self
end
set_environment_variable(name, value) click to toggle source

Set environment variable

@param [String] name

The name of the environment variable as string, e.g. 'HOME'

@param [String] value

The value of the environment variable. Needs to be a string.

@return [self]

# File lib/aruba/api/environment.rb, line 18
def set_environment_variable(name, value)
  name = name.to_s
  value = value.to_s

  old_environment = aruba.environment.to_h
  aruba.environment[name] = value
  new_environment = aruba.environment.to_h

  environment_change = { old: old_environment,
                         new: new_environment,
                         changed: { name: name, value: value } }
  aruba.event_bus.notify Events::AddedEnvironmentVariable.new(environment_change)

  self
end