class RSpec::Core::ConfigurationOptions
file.
‘$XDG_CONFIG_HOME/rspec/options`, `.rspec-local` or a custom options
whether via the command line, `.rspec`, `~/.rspec`,
Responsible for utilizing externally provided configuration options,
def args_from_options_file(path)
def args_from_options_file(path) return [] unless path && File.exist?(path) config_string = options_file_as_erb_string(path) FlatMap.flat_map(config_string.split(/\n+/), &:shellsplit) end
def command_line_options
def command_line_options @command_line_options ||= Parser.parse(@args) end
def configure(config)
-
config
(Configuration
) -- the configuration instance to update
def configure(config) process_options_into config configure_filter_manager config.filter_manager load_formatters_into config end
def configure_filter_manager(filter_manager)
-
filter_manager
(FilterManager
) -- instance to update
Other tags:
- Api: - private
def configure_filter_manager(filter_manager) @filter_manager_options.each do |command, value| filter_manager.__send__ command, value end end
def custom_options
def custom_options options_from(custom_options_file) end
def custom_options_file
def custom_options_file command_line_options[:custom_options_file] end
def env_options
def env_options return {} unless ENV['SPEC_OPTS'] parse_args_ignoring_files_or_dirs_to_run( Shellwords.split(ENV["SPEC_OPTS"]), "ENV['SPEC_OPTS']" ) end
def file_options
def file_options if custom_options_file [custom_options] else [global_options, project_options, local_options] end end
def force?(key)
def force?(key) !UNFORCED_OPTIONS.include?(key) end
def global_options
def global_options @global_options ||= options_from(global_options_file) end
def global_options_file
def global_options_file xdg_options_file_if_exists || home_options_file_path end
def home_options_file_path
def home_options_file_path File.join(File.expand_path("~"), ".rspec") rescue ArgumentError # :nocov: RSpec.warning "Unable to find ~/.rspec because the HOME environment variable is not set" nil # :nocov: end
def initialize(args)
-
args
(Array
) -- command line arguments
def initialize(args) @args = args.dup organize_options end
def load_formatters_into(config)
def load_formatters_into(config) options[:formatters].each { |pair| config.add_formatter(*pair) } if options[:formatters] end
def local_options
def local_options @local_options ||= options_from(local_options_file) end
def local_options_file
def local_options_file "./.rspec-local" end
def options_file_as_erb_string(path)
def options_file_as_erb_string(path) if RUBY_VERSION >= '2.6' ERB.new(File.read(path), :trim_mode => '-').result(binding) else ERB.new(File.read(path), nil, '-').result(binding) end end
def options_from(path)
def options_from(path) args = args_from_options_file(path) parse_args_ignoring_files_or_dirs_to_run(args, path) end
def order(keys)
def order(keys) OPTIONS_ORDER.reverse_each do |key| keys.unshift(key) if keys.delete(key) end keys end
def organize_options
def organize_options @filter_manager_options = [] @options = (file_options << command_line_options << env_options).each do |opts| @filter_manager_options << [:include, opts.delete(:inclusion_filter)] if opts.key?(:inclusion_filter) @filter_manager_options << [:exclude, opts.delete(:exclusion_filter)] if opts.key?(:exclusion_filter) end @options = @options.inject(:libs => [], :requires => []) do |hash, opts| hash.merge(opts) do |key, oldval, newval| [:libs, :requires].include?(key) ? oldval + newval : newval end end end
def parse_args_ignoring_files_or_dirs_to_run(args, source)
def parse_args_ignoring_files_or_dirs_to_run(args, source) options = Parser.parse(args, source) options.delete(:files_or_directories_to_run) options end
def process_options_into(config)
def process_options_into(config) opts = options.reject { |k, _| UNPROCESSABLE_OPTIONS.include? k } order(opts.keys).each do |key| force?(key) ? config.force(key => opts[key]) : config.__send__("#{key}=", opts[key]) end end
def project_options
def project_options @project_options ||= options_from(project_options_file) end
def project_options_file
def project_options_file "./.rspec" end
def resolve_xdg_config_home
def resolve_xdg_config_home File.expand_path(ENV.fetch("XDG_CONFIG_HOME", "~/.config")) rescue ArgumentError # :nocov: # On Ruby 2.4, `File.expand("~")` works even if `ENV['HOME']` is not set. # But on earlier versions, it fails. nil # :nocov: end
def xdg_options_file_if_exists
def xdg_options_file_if_exists path = xdg_options_file_path if path && File.exist?(path) path end end
def xdg_options_file_path
def xdg_options_file_path xdg_config_home = resolve_xdg_config_home if xdg_config_home File.join(xdg_config_home, "rspec", "options") end end