# File lib/aruba/basic_configuration.rb, line 14 def known_options @known_options ||= {} end
Create configuration
# File lib/aruba/basic_configuration.rb, line 101 def initialize initialize_configuration 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 [Object] default
The default value
rubocop:disable Metrics/CyclomaticComplexity
# File lib/aruba/basic_configuration.rb, line 61 def option_accessor(name, opts = {}) contract = opts[:contract] default = opts[:default] fail ArgumentError, 'Either use block or default value' if block_given? && default # fail ArgumentError, 'Either use block or default value' if !block_given? && default.nil? && default.to_s.empty? fail ArgumentError, 'contract-options is required' if contract.nil? # Add writer add_option(name, block_given? ? yield(InConfigWrapper.new(known_options)) : default) Contract contract define_method("#{name}=") { |v| find_option(name).value = v } # Add reader option_reader name, :contract => { None => contract.values.first } end
Define an option reader
@param [Symbol] name
The name of the reader
@param [Hash] opts
Options
@option [Class, Module] contract
The contract for the option
@option [Object] default
The default value
# File lib/aruba/basic_configuration.rb, line 31 def option_reader(name, opts = {}) contract = opts[:contract] default = opts[:default] fail ArgumentError, 'Either use block or default value' if block_given? && default fail ArgumentError, 'contract-options is required' if contract.nil? Contract contract add_option(name, block_given? ? yield(InConfigWrapper.new(known_options)) : default) define_method(name) { find_option(name).value } self end
# File lib/aruba/basic_configuration.rb, line 214 def ==(other) local_options.values.map(&:value) == other.local_options.values.map(&:value) end
Define or run after-hook
@param [Symbol, String] name
The name of the hook
@param [Proc] context
The context a hook should run in. This is a runtime only option.
@param [Array] args
Arguments for the run of hook. This is a runtime only option.
@yield
The code block which should be run. This is a configure time only option
# File lib/aruba/basic_configuration.rb, line 180 def after(name, context = proc {}, *args, &block) name = format('%s_%s', 'after_', name.to_s).to_sym if block_given? @hooks.append(name, block) self else @hooks.execute(name, context, *args) end end
Check if after-hook <name> is defined
# File lib/aruba/basic_configuration.rb, line 200 def after?(name) name = format('%s_%s', 'after_', name.to_s).to_sym @hooks.exist? name end
Define or run before-hook
@param [Symbol, String] name
The name of the hook
@param [Proc] context
The context a hook should run in. This is a runtime only option.
@param [Array] args
Arguments for the run of hook. This is a runtime only option.
@yield
The code block which should be run. This is a configure time only option
# File lib/aruba/basic_configuration.rb, line 155 def before(name, context = proc {}, *args, &block) name = format('%s_%s', 'before_', name.to_s).to_sym if block_given? @hooks.append(name, block) self else @hooks.execute(name, context, *args) end end
Check if before-hook <name> is defined
# File lib/aruba/basic_configuration.rb, line 193 def before?(name) name = format('%s_%s', 'before_', name.to_s).to_sym @hooks.exist? name end
@deprecated
# File lib/aruba/basic_configuration.rb, line 136 def before_cmd(&block) Aruba.platform.deprecated 'The use of the "#before_cmd"-hook is deprecated. Please define with "#before(:command) {}" instead' before(:command, &block) end
@yield [Configuration]
Yields self
# File lib/aruba/basic_configuration.rb, line 108 def configure yield self if block_given? end
Get access to hooks
# File lib/aruba/basic_configuration.rb, line 127 def hooks # rubocop:disable Metrics/LineLength Aruba.platform.deprecated 'The use of the "#aruba.config.hooks" is deprecated. Please use "#aruba.config.before(:name) {}" to define and "#aruba.config.before(:name, *args)" to run a hook. This method will become private in the next major version.' # rubocop:enable Metrics/LineLength @hooks end
Make deep dup copy of configuration
# File lib/aruba/basic_configuration.rb, line 118 def make_copy obj = self.dup obj.local_options = Marshal.load(Marshal.dump(local_options)) obj.hooks = @hooks obj end
Check if <name> is option
@param [String, Symbol] name
The name of the option
# File lib/aruba/basic_configuration.rb, line 210 def option?(name) local_options.any? { |_, v| v.name == name.to_sym } end
Reset configuration
# File lib/aruba/basic_configuration.rb, line 113 def reset initialize_configuration end
Set if name is option
# File lib/aruba/basic_configuration.rb, line 219 def set_if_option(name, *args) if RUBY_VERSION < '1.9' send("#{name}=".to_sym, *args) if option? name else public_send("#{name}=".to_sym, *args) if option? name end end