Module: Aruba

Defined in:
lib/aruba/api.rb,
lib/aruba/cli.rb,
lib/aruba/hooks.rb,
lib/aruba/setup.rb,
lib/aruba/errors.rb,
lib/aruba/events.rb,
lib/aruba/command.rb,
lib/aruba/console.rb,
lib/aruba/runtime.rb,
lib/aruba/version.rb,
lib/aruba/api/core.rb,
lib/aruba/api/text.rb,
lib/aruba/platform.rb,
lib/aruba/platform.rb,
lib/aruba/platform.rb,
lib/aruba/colorizer.rb,
lib/aruba/colorizer.rb,
lib/aruba/event_bus.rb,
lib/aruba/file_size.rb,
lib/aruba/aruba_path.rb,
lib/aruba/initializer.rb,
lib/aruba/initializer.rb,
lib/aruba/initializer.rb,
lib/aruba/initializer.rb,
lib/aruba/initializer.rb,
lib/aruba/initializer.rb,
lib/aruba/api/commands.rb,
lib/aruba/console/help.rb,
lib/aruba/configuration.rb,
lib/aruba/configuration.rb,
lib/aruba/api/filesystem.rb,
lib/aruba/config_wrapper.rb,
lib/aruba/contracts/enum.rb,
lib/aruba/api/environment.rb,
lib/aruba/in_config_wrapper.rb,
lib/aruba/basic_configuration.rb,
lib/aruba/platforms/announcer.rb,
lib/aruba/platforms/unix_which.rb,
lib/aruba/processes/in_process.rb,
lib/aruba/tasks/docker_helpers.rb,
lib/aruba/generators/script_file.rb,
lib/aruba/platforms/aruba_logger.rb,
lib/aruba/platforms/simple_table.rb,
lib/aruba/contracts/absolute_path.rb,
lib/aruba/contracts/relative_path.rb,
lib/aruba/event_bus/name_resolver.rb,
lib/aruba/matchers/collection/all.rb,
lib/aruba/platforms/unix_platform.rb,
lib/aruba/platforms/windows_which.rb,
lib/aruba/processes/basic_process.rb,
lib/aruba/processes/debug_process.rb,
lib/aruba/processes/spawn_process.rb,
lib/aruba/contracts/is_power_of_two.rb,
lib/aruba/platforms/command_monitor.rb,
lib/aruba/basic_configuration/option.rb,
lib/aruba/matchers/base/base_matcher.rb,
lib/aruba/platforms/windows_platform.rb,
lib/aruba/platforms/filesystem_status.rb,
lib/aruba/platforms/local_environment.rb,
lib/aruba/platforms/aruba_file_creator.rb,
lib/aruba/platforms/determine_file_size.rb,
lib/aruba/platforms/unix_command_string.rb,
lib/aruba/matchers/base/object_formatter.rb,
lib/aruba/platforms/determine_disk_usage.rb,
lib/aruba/platforms/disk_usage_calculator.rb,
lib/aruba/platforms/windows_command_string.rb,
lib/aruba/platforms/unix_environment_variables.rb,
lib/aruba/matchers/collection/include_an_object.rb,
lib/aruba/platforms/aruba_fixed_size_file_creator.rb,
lib/aruba/platforms/windows_environment_variables.rb

Overview

Aruba

Defined Under Namespace

Modules: AnsiColor, Api, Contracts, Events, Initializers, Matchers, Platforms, Processes Classes: ArubaLogger, ArubaPath, BasicConfiguration, Cli, Colorizer, Command, CommandAlreadyStartedError, CommandAlreadyStoppedError, CommandMonitor, CommandNotFoundError, ConfigWrapper, Configuration, Console, DockerBuildCommandLineBuilder, DockerComposeFile, DockerRunCommandLineBuilder, DockerRunInstance, Error, EventBus, EventNameResolveError, FileSize, Hooks, InConfigWrapper, Initializer, LaunchError, NoCommandHasBeenStartedError, NoCommandHasBeenStoppedError, NoEventError, Runtime, ScriptFile, Setup, UnknownOptionError, UserError

Constant Summary collapse

VERSION =
'1.0.0-alpha.2'.freeze
PLATFORM_MUTEX =
Mutex.new
Platform =

Platform

[Platforms::WindowsPlatform, Platforms::UnixPlatform].find(&:match?)

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configObject (readonly)

Returns the value of attribute config


61
62
63
# File 'lib/aruba/configuration.rb', line 61

def config
  @config
end

.platformObject (readonly)

Returns the value of attribute platform


23
24
25
# File 'lib/aruba/platform.rb', line 23

def platform
  @platform
end

Class Method Details

.configure(&block) ⇒ Object

Configure aruba

Examples:

How to configure aruba


Aruba.configure do |config|
  config.<option> = <value>
end

71
72
73
74
75
# File 'lib/aruba/configuration.rb', line 71

def configure(&block)
  @config.configure(&block)

  self
end