Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify configuration specification #772

Merged
merged 7 commits into from
Jan 3, 2021
Merged

Simplify configuration specification #772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2753cad
Add spec for the contract of a real configuration option
mvz Jan 3, 2021
370e9df
Allow specifying option type just once
mvz Jan 3, 2021
e3d89b4
Start rewriting options
mvz Jan 3, 2021
c2a7bab
Rewrite remaining options to use type instead of contract
mvz Jan 3, 2021
944ac6c
Require contract to be specified through type: option
mvz Jan 3, 2021
bde30a7
Replace options hash with keyword arguments
mvz Jan 3, 2021
53e08b4
Clearly associate contract with defined reader method
mvz Jan 3, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 9 additions & 25 deletions lib/aruba/basic_configuration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,58 +20,42 @@ def known_options
# @param [Symbol] name
# The name of the reader
#
# @param [Hash] opts
# Options
#
# @option [Class, Module] contract
# The contract for the option
# @option [Class, Module] type
# The type contract for the option
#
# @option [Object] default
# The default value
def option_reader(name, opts = {})
contract = opts[:contract]
default = opts[:default]

def option_reader(name, type:, default: nil)
raise ArgumentError, 'Either use block or default value' if block_given? && default
raise ArgumentError, 'contract-options is required' if contract.nil?

Contract contract
add_option(name, block_given? ? yield(InConfigWrapper.new(known_options)) : default)

Contract None => type
define_method(name) { find_option(name).value }

self
end

# Define an option reader and writer
#
# @param [Symbol] name
# The name of the reader
#
# @param [Hash] opts
# Options
#
# @option [Class, Module] contract
# The contract for the option
# @option [Class, Module] type
# The type contract for the option
#
# @option [Object] default
# The default value
#
def option_accessor(name, opts = {})
contract = opts[:contract]
default = opts[:default]

def option_accessor(name, type:, default: nil)
raise ArgumentError, 'Either use block or default value' if block_given? && default
raise ArgumentError, 'contract-options is required' if contract.nil?

# Add writer
add_option(name, block_given? ? yield(InConfigWrapper.new(known_options)) : default)

Contract contract
Contract type => type
define_method("#{name}=") { |v| find_option(name).value = v }

# Add reader
option_reader name, contract: { None => contract.values.first }
option_reader name, type: type
end

private
Expand Down
56 changes: 23 additions & 33 deletions lib/aruba/configuration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,69 +17,59 @@ module Aruba
#
# This defines the configuration options of aruba
class Configuration < BasicConfiguration
option_reader :root_directory, contract: { None => String }, default: Dir.getwd
option_reader :root_directory, type: String, default: Dir.getwd

option_accessor :working_directory,
contract: { Aruba::Contracts::RelativePath =>
Aruba::Contracts::RelativePath },
type: Aruba::Contracts::RelativePath,
default: 'tmp/aruba'

option_reader :fixtures_path_prefix, contract: { None => String }, default: '%'
option_reader :fixtures_path_prefix, type: String, default: '%'

option_accessor :exit_timeout, contract: { Num => Num }, default: 15
option_accessor :stop_signal, contract: { Maybe[String] => Maybe[String] }, default: nil
option_accessor :io_wait_timeout, contract: { Num => Num }, default: 0.1
option_accessor :startup_wait_time, contract: { Num => Num }, default: 0
option_accessor :exit_timeout, type: Num, default: 15
option_accessor :stop_signal, type: Maybe[String], default: nil
option_accessor :io_wait_timeout, type: Num, default: 0.1
option_accessor :startup_wait_time, type: Num, default: 0
option_accessor :fixtures_directories,
contract: { Array => ArrayOf[String] },
type: ArrayOf[String],
default: %w(features/fixtures spec/fixtures test/fixtures fixtures)

option_accessor :command_runtime_environment, contract: { Hash => Hash }, default: {}
option_accessor :command_runtime_environment, type: Hash, default: {}
option_accessor :command_search_paths,
contract: { ArrayOf[String] => ArrayOf[String] } do |config|
type: ArrayOf[String] do |config|
[File.join(config.root_directory.value, 'bin'),
File.join(config.root_directory.value, 'exe')]
end
option_accessor :remove_ansi_escape_sequences, contract: { Bool => Bool }, default: true
option_accessor :remove_ansi_escape_sequences, type: Bool, default: true
option_accessor :command_launcher,
contract: {
Aruba::Contracts::Enum[:in_process, :spawn, :debug] =>
Aruba::Contracts::Enum[:in_process, :spawn, :debug]
},
type: Aruba::Contracts::Enum[:in_process, :spawn, :debug],
default: :spawn
option_accessor :main_class, contract: { Class => Maybe[Class] }, default: nil
option_accessor :main_class, type: Maybe[Class], default: nil

option_accessor :home_directory,
contract: {
Or[Aruba::Contracts::AbsolutePath, Aruba::Contracts::RelativePath] =>
Or[Aruba::Contracts::AbsolutePath, Aruba::Contracts::RelativePath]
} do |config|
File.join(config.root_directory.value, config.working_directory.value)
end
type: Or[Aruba::Contracts::AbsolutePath,
Aruba::Contracts::RelativePath] do |config|
File.join(config.root_directory.value, config.working_directory.value)
end

option_accessor :log_level,
contract: {
Aruba::Contracts::Enum[:fatal, :warn, :debug, :info,
:error, :unknown, :silent] =>
type:
Aruba::Contracts::Enum[:fatal, :warn, :debug, :info,
:error, :unknown, :silent]
},
:error, :unknown, :silent],
default: :info

# TODO: deprecate this value and replace with "filesystem allocation unit"
# equal to 4096 by default. "filesystem allocation unit" would represent
# the actual MINIMUM space taken in bytes by a 1-byte file
option_accessor :physical_block_size,
contract: { Aruba::Contracts::IsPowerOfTwo =>
Aruba::Contracts::IsPowerOfTwo },
type: Aruba::Contracts::IsPowerOfTwo,
default: 512
option_accessor :console_history_file, contract: { String => String },
option_accessor :console_history_file, type: String,
default: '~/.aruba_history'

option_accessor :activate_announcer_on_command_failure,
contract: { ArrayOf[Symbol] => ArrayOf[Symbol] },
type: ArrayOf[Symbol],
default: []
option_accessor :allow_absolute_paths, contract: { Bool => Bool }, default: false
option_accessor :allow_absolute_paths, type: Bool, default: false
end
end

Expand Down
8 changes: 8 additions & 0 deletions spec/aruba/configuration_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,12 @@

RSpec.describe Aruba::Configuration do
it_behaves_like 'a basic configuration'

context 'when is modified' do
let(:config) { described_class.new }

it "won't allow bad values" do
expect { config.fixtures_directories = [1, 2] }.to raise_error ParamContractError
end
end
end
14 changes: 7 additions & 7 deletions spec/support/shared_examples/configuration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
RSpec.shared_examples 'a basic configuration' do
subject(:config) do
Class.new(described_class) do
option_accessor :use_test, contract: { Contracts::Bool => Contracts::Bool },
option_accessor :use_test, type: Contracts::Bool,
default: false
end.new
end
Expand All @@ -14,7 +14,7 @@
let(:config_klass) { Class.new(described_class) }

before do
config_klass.option_reader :new_opt, contract: { Contracts::Num => Contracts::Num },
config_klass.option_reader :new_opt, type: Contracts::Num,
default: 1
end

Expand All @@ -30,7 +30,7 @@
before do
config_klass.option_reader(
:new_opt2,
contract: { Contracts::Num => Contracts::Num }
type: Contracts::Num
) { |c| c.new_opt.value + 1 }
end

Expand All @@ -43,7 +43,7 @@
it 'complains that only one or the other can be specified' do
expect do
config_klass
.option_accessor(:new_opt2, contract: { Contracts::Num => Contracts::Num },
.option_accessor(:new_opt2, type: Contracts::Num,
default: 2) { |c| c.new_opt.value + 1 }
end.to raise_error ArgumentError, 'Either use block or default value'
end
Expand All @@ -56,7 +56,7 @@
let(:config_klass) { Class.new(described_class) }

before do
config_klass.option_accessor :new_opt, contract: { Contracts::Num => Contracts::Num },
config_klass.option_accessor :new_opt, type: Contracts::Num,
default: 1
end

Expand All @@ -73,7 +73,7 @@
context 'when block is defined' do
before do
config_klass.option_accessor(
:new_opt2, contract: { Contracts::Num => Contracts::Num }
:new_opt2, type: Contracts::Num
) do |c|
c.new_opt.value + 1
end
Expand All @@ -88,7 +88,7 @@
it 'complains that only one or the other can be specified' do
expect do
config_klass.option_accessor(:new_opt2,
contract: { Contracts::Num => Contracts::Num },
type: Contracts::Num,
default: 2) { |c| c.new_opt1 + 1 }
end.to raise_error ArgumentError, 'Either use block or default value'
end
Expand Down