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.
# File lib/aruba/api/environment.rb, line 36
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

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

  self
end
delete_environment_variable(name) click to toggle source

Remove existing environment variable

@param [String] key

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.
# File lib/aruba/api/environment.rb, line 76
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

  aruba.event_bus.notify Events::DeletedEnvironmentVariable.new(:old => old_environment, :new => new_environment, :changed => { :name => name, :value => '' })

  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.
# File lib/aruba/api/environment.rb, line 56
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

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

  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.
# File lib/aruba/api/environment.rb, line 16
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

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

  self
end