class RSpec::Core::Configuration
Stores runtime configuration information.
Configuration options are loaded from `~/.rspec`, `.rspec`, `.rspec-local`, command line switches, and the `SPEC_OPTS` environment variable (listed in lowest to highest precedence; for example, an option in `~/.rspec` can be overridden by an option in `.rspec-local`).
@example Standard settings
RSpec.configure do |c| c.drb = true c.drb_port = 1234 c.default_path = 'behavior' end
@example Hooks
RSpec.configure do |c| c.before(:suite) { establish_connection } c.before(:each) { log_in_as :authorized } c.around(:each) { |ex| Database.transaction(&ex) } end
@see RSpec.configure @see Hooks
Constants
- DEFAULT_FORMATTER
@private
- DEFAULT_ORDERING
@private
- RANDOM_ORDERING
@private
Attributes
@private
Public Class Methods
@private
Invoked by the `add_setting` instance method. Use that method on a `Configuration` instance rather than this class method.
# File lib/rspec/core/configuration.rb, line 65 def self.add_setting(name, opts={}) raise "Use the instance add_setting method if you want to set a default" if opts.has_key?(:default) if opts[:alias] deprecate_alias_key define_aliases(opts[:alias], name) else attr_writer name define_reader name define_predicate_for name end [opts[:alias_with]].flatten.compact.each do |alias_name| define_aliases(name, alias_name) end end
@private
# File lib/rspec/core/configuration.rb, line 50 def self.define_aliases(name, alias_name) alias_method alias_name, name alias_method "#{alias_name}=", "#{name}=" define_predicate_for alias_name end
@private
# File lib/rspec/core/configuration.rb, line 57 def self.define_predicate_for(*names) names.each {|name| alias_method "#{name}?", name} end
@private
# File lib/rspec/core/configuration.rb, line 37 def self.define_reader(name) define_method(name) do variable = instance_variable_defined?("@#{name}") ? instance_variable_get("@#{name}") : nil value_for(name, variable) end end
@private
# File lib/rspec/core/configuration.rb, line 45 def self.deprecate_alias_key RSpec.deprecate("add_setting with :alias option", :replacement => ":alias_with") end
# File lib/rspec/core/configuration.rb, line 186 def initialize @expectation_frameworks = [] @include_or_extend_modules = [] @mock_framework = nil @files_to_run = [] @formatters = [] @color = false @pattern = '**/*_spec.rb' @failure_exit_code = 1 @backtrace_cleaner = BacktraceCleaner.new @default_path = 'spec' @deprecation_stream = $stderr @filter_manager = FilterManager.new @preferred_options = {} @seed = srand % 0xFFFF @failure_color = :red @success_color = :green @pending_color = :yellow @default_color = :white @fixed_color = :blue @detail_color = :cyan @profile_examples = false @requires = [] @libs = [] end
Public Instance Methods
@overload #add_formatter(formatter)
Adds a formatter to the formatters collection. `formatter` can be a string representing any of the built-in formatters (see `built_in_formatter`), or a custom formatter class.
### Note
For internal purposes, `add_formatter` also accepts the name of a class and paths to use for output streams, but you should consider that a private api that may change at any time without notice.
# File lib/rspec/core/configuration.rb, line 571 def add_formatter(formatter_to_use, *paths) formatter_class = built_in_formatter(formatter_to_use) || custom_formatter(formatter_to_use) || (raise ArgumentError, "Formatter '#{formatter_to_use}' unknown - maybe you meant 'documentation' or 'progress'?.") paths << output if paths.empty? formatters << formatter_class.new(*paths.map {|p| String === p ? file_at(p) : p}) end
@overload ::add_setting(name) @overload ::add_setting(name, opts) @option opts [Symbol] :default
set a default value for the generated getter and predicate methods: add_setting(:foo, :default => "default value")
@option opts [Symbol] :alias_with
Use %x:alias_with` to alias the setter, getter, and predicate to another name, or names: add_setting(:foo, :alias_with => :bar) add_setting(:foo, :alias_with => [:bar, :baz])
Adds a custom setting to the RSpec.configuration object.
RSpec.configuration.add_setting :foo
Used internally and by extension frameworks like rspec-rails, so they can add config settings that are domain specific. For example:
RSpec.configure do |c| c.add_setting :use_transactional_fixtures, :default => true, :alias_with => :use_transactional_examples end
`add_setting` creates three methods on the configuration object, a setter, a getter, and a predicate:
RSpec.configuration.foo=(value) RSpec.configuration.foo RSpec.configuration.foo? # returns true if foo returns anything but nil or false
# File lib/rspec/core/configuration.rb, line 268 def add_setting(name, opts={}) default = opts.delete(:default) (class << self; self; end).class_eval do add_setting(name, opts) end send("#{name}=", default) if default end
Creates a method that delegates to `example` including the submitted `args`. Used internally to add variants of `example` like `pending`:
@example
alias_example_to :pending, :pending => true # This lets you do this: describe Thing do pending "does something" do thing = Thing.new end end # ... which is the equivalent of describe Thing do it "does something", :pending => true do thing = Thing.new end end
# File lib/rspec/core/configuration.rb, line 636 def alias_example_to(new_name, *args) extra_options = build_metadata_hash_from(args) RSpec::Core::ExampleGroup.alias_example_to(new_name, extra_options) end
Define an alias for it_should_behave_like that allows different language (like “it_has_behavior” or “it_behaves_like”) to be employed when including shared examples.
Example:
alias_it_behaves_like_to(:it_has_behavior, 'has behavior:')
allows the user to include a shared example group like:
describe Entity do it_has_behavior 'sortability' do let(:sortable) { Entity.new } end end
which is reported in the output as:
Entity has behavior: sortability # sortability examples here
# File lib/rspec/core/configuration.rb, line 662 def alias_it_behaves_like_to(new_name, report_label = '') RSpec::Core::ExampleGroup.alias_it_behaves_like_to(new_name, report_label) end
The patterns to discard from backtraces. Deprecated, use #backtrace_exclusion_patterns instead
Defaults to RSpec::Core::BacktraceCleaner::DEFAULT_EXCLUSION_PATTERNS
One can replace the list by using the setter or modify it through the getter
To override this behaviour and display a full backtrace, use `–backtrace`on the command line, in a `.rspec` file, or in the `rspec_options` attribute of RSpec's rake task.
# File lib/rspec/core/configuration.rb, line 298 def backtrace_clean_patterns RSpec.deprecate("RSpec::Core::Configuration#backtrace_clean_patterns", :replacement => "RSpec::Core::Configuration#backtrace_exclusion_patterns") @backtrace_cleaner.exclusion_patterns end
# File lib/rspec/core/configuration.rb, line 304 def backtrace_clean_patterns=(patterns) RSpec.deprecate("RSpec::Core::Configuration#backtrace_clean_patterns", :replacement => "RSpec::Core::Configuration#backtrace_exclusion_patterns") @backtrace_cleaner.exclusion_patterns = patterns end
The patterns to discard from backtraces.
Defaults to RSpec::Core::BacktraceCleaner::DEFAULT_EXCLUSION_PATTERNS
One can replace the list by using the setter or modify it through the getter
To override this behaviour and display a full backtrace, use `–backtrace`on the command line, in a `.rspec` file, or in the `rspec_options` attribute of RSpec's rake task.
# File lib/rspec/core/configuration.rb, line 335 def backtrace_exclusion_patterns @backtrace_cleaner.exclusion_patterns end
# File lib/rspec/core/configuration.rb, line 339 def backtrace_exclusion_patterns=(patterns) @backtrace_cleaner.exclusion_patterns = patterns end
The patterns to always include to backtraces.
Defaults to [Regexp.new Dir.getwd] if the current working directory matches any of the exclusion patterns. Otherwise it defaults to empty.
One can replace the list by using the setter or modify it through the getter
# File lib/rspec/core/configuration.rb, line 317 def backtrace_inclusion_patterns @backtrace_cleaner.inclusion_patterns end
# File lib/rspec/core/configuration.rb, line 321 def backtrace_inclusion_patterns=(patterns) @backtrace_cleaner.inclusion_patterns = patterns end
# File lib/rspec/core/configuration.rb, line 479 def color(output=output_stream) # rspec's built-in formatters all call this with the output argument, # but defaulting to output_stream for backward compatibility with # formatters in extension libs return false unless output_to_tty?(output) value_for(:color, @color) end
# File lib/rspec/core/configuration.rb, line 487 def color=(bool) if bool if RSpec.windows_os? and not ENV['ANSICON'] warn "You must use ANSICON 1.31 or later (http://adoxa.3eeweb.com/ansicon/) to use colour on Windows" @color = false else @color = true end end end
TODO - deprecate #color_enabled - probably not until the last 2.x release before 3.0
@private
# File lib/rspec/core/configuration.rb, line 888 def configure_expectation_framework expectation_frameworks.each do |framework| RSpec::Core::ExampleGroup.send(:include, framework) end end
@private
Used internally to extend a group with modules using `include` and/or `extend`.
# File lib/rspec/core/configuration.rb, line 851 def configure_group(group) include_or_extend_modules.each do |include_or_extend, mod, filters| next unless filters.empty? || group.any_apply?(filters) send("safe_#{include_or_extend}", mod, group) end end
@private
# File lib/rspec/core/configuration.rb, line 883 def configure_mock_framework RSpec::Core::ExampleGroup.send(:include, mock_framework) end
# File lib/rspec/core/configuration.rb, line 518 def debug=(bool) return unless bool begin require 'ruby-debug' Debugger.start rescue LoadError => e raise <<-EOM #{'*'*50} #{e.message} If you have it installed as a ruby gem, then you need to either require 'rubygems' or configure the RUBYOPT environment variable with the value 'rubygems'. #{e.backtrace.join("\n")} #{'*'*50} EOM end end
# File lib/rspec/core/configuration.rb, line 539 def debug? !!defined?(Debugger) end
@private
# File lib/rspec/core/configuration.rb, line 967 def example_ordering_block @example_ordering_block ||= DEFAULT_ORDERING end
Returns the `exclusion_filter`. If none has been set, returns an empty hash.
# File lib/rspec/core/configuration.rb, line 774 def exclusion_filter filter_manager.exclusions end
Clears and reassigns the `exclusion_filter`. Set to `nil` if you don't want any exclusion filter at all.
### Warning
This overrides any exclusion filters/tags set on the command line or in configuration files.
# File lib/rspec/core/configuration.rb, line 768 def exclusion_filter=(filter) filter_manager.exclude! build_metadata_hash_from([filter]) end
Sets the expectation framework module(s) to be included in each example group.
`frameworks` can be `:rspec`, `:stdlib`, a custom module, or any combination thereof:
config.expect_with :rspec config.expect_with :stdlib config.expect_with :rspec, :stdlib config.expect_with OtherExpectationFramework
RSpec will translate `:rspec` and `:stdlib` into the appropriate modules.
If the module responds to `configuration`, `expect_with` will yield the `configuration` object if given a block:
config.expect_with OtherExpectationFramework do |custom_config| custom_config.custom_setting = true end
# File lib/rspec/core/configuration.rb, line 441 def expect_with(*frameworks) modules = frameworks.map do |framework| case framework when Module framework when :rspec require 'rspec/expectations' self.expecting_with_rspec = true ::RSpec::Matchers when :stdlib require 'test/unit/assertions' ::Test::Unit::Assertions else raise ArgumentError, "#{framework.inspect} is not supported" end end if (modules - @expectation_frameworks).any? assert_no_example_groups_defined(:expect_with) end if block_given? raise "expect_with only accepts a block with a single argument. Call expect_with #{modules.length} times, once with each argument, instead." if modules.length > 1 raise "#{modules.first} must respond to `configuration` so that expect_with can yield it." unless modules.first.respond_to?(:configuration) yield modules.first.configuration end @expectation_frameworks.push(*modules) end
Delegates to #expect_with(framework)
# File lib/rspec/core/configuration.rb, line 415 def expectation_framework=(framework) expect_with(framework) end
Returns the configured expectation framework adapter module(s)
# File lib/rspec/core/configuration.rb, line 409 def expectation_frameworks expect_with :rspec if @expectation_frameworks.empty? @expectation_frameworks end
Tells RSpec to extend example groups with `mod`. Methods defined in `mod` are exposed to example groups (not examples). Use `filters` to constrain the groups to extend.
Similar to `include`, but behavior is added to example groups, which are classes, rather than the examples, which are instances of those classes.
@example
module UiHelpers def run_in_browser # ... end end RSpec.configure do |config| config.extend(UiHelpers, :type => :request) end describe "edit profile", :type => :request do run_in_browser it "does stuff in the client" do # ... end end
@see include
# File lib/rspec/core/configuration.rb, line 843 def extend(mod, *filters) include_or_extend_modules << [:extend, mod, build_metadata_hash_from(filters)] end
@private
# File lib/rspec/core/configuration.rb, line 609 def files_or_directories_to_run=(*files) files = files.flatten files << default_path if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty? self.files_to_run = get_files_to_run(files) end
Adds key/value pairs to the `exclusion_filter`. If the `treat_symbols_as_metadata_keys_with_true_values` config option is set to true and `args` excludes any symbols that are not part of a hash, each symbol is treated as a key in the hash with the value `true`.
### Note
Filters set using this method can be overridden from the command line or config files (e.g. `.rspec`).
@example
# given this declaration describe "something", :foo => 'bar' do # ... end # any of the following will exclude that group config.filter_run_excluding :foo => 'bar' config.filter_run_excluding :foo => /^ba/ config.filter_run_excluding :foo => lambda {|v| v == 'bar'} config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'} # given a proc with an arity of 1, the lambda is passed the value related to the key, e.g. config.filter_run_excluding :foo => lambda {|v| v == 'bar'} # given a proc with an arity of 2, the lambda is passed the value related to the key, # and the metadata itself e.g. config.filter_run_excluding :foo => lambda {|v,m| m[:foo] == 'bar'} # with treat_symbols_as_metadata_keys_with_true_values = true filter_run_excluding :foo # same as filter_run_excluding :foo => true
# File lib/rspec/core/configuration.rb, line 757 def filter_run_excluding(*args) filter_manager.exclude_with_low_priority build_metadata_hash_from(args) end
Adds key/value pairs to the `inclusion_filter`. If the `treat_symbols_as_metadata_keys_with_true_values` config option is set to true and `args` includes any symbols that are not part of a hash, each symbol is treated as a key in the hash with the value `true`.
### Note
Filters set using this method can be overridden from the command line or config files (e.g. `.rspec`).
@example
# given this declaration describe "something", :foo => 'bar' do # ... end # any of the following will include that group config.filter_run_including :foo => 'bar' config.filter_run_including :foo => /^ba/ config.filter_run_including :foo => lambda {|v| v == 'bar'} config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'} # given a proc with an arity of 1, the lambda is passed the value related to the key, e.g. config.filter_run_including :foo => lambda {|v| v == 'bar'} # given a proc with an arity of 2, the lambda is passed the value related to the key, # and the metadata itself e.g. config.filter_run_including :foo => lambda {|v,m| m[:foo] == 'bar'} # with treat_symbols_as_metadata_keys_with_true_values = true filter_run_including :foo # same as filter_run_including :foo => true
# File lib/rspec/core/configuration.rb, line 699 def filter_run_including(*args) filter_manager.include_with_low_priority build_metadata_hash_from(args) end
@private
Used to set higher priority option values from the command line.
# File lib/rspec/core/configuration.rb, line 217 def force(hash) if hash.has_key?(:seed) hash[:order], hash[:seed] = order_and_seed_from_seed(hash[:seed]) elsif hash.has_key?(:order) set_order_and_seed(hash) end @preferred_options.merge!(hash) self.warnings = value_for :warnings, nil end
Formats the docstring output using the block provided.
@example
# This will strip the descriptions of both examples and example groups. RSpec.configure do |config| config.format_docstrings { |s| s.strip } end
# File lib/rspec/core/configuration.rb, line 910 def format_docstrings(&block) @format_docstrings_block = block_given? ? block : DEFAULT_FORMATTER end
@private
# File lib/rspec/core/configuration.rb, line 915 def format_docstrings_block @format_docstrings_block ||= DEFAULT_FORMATTER end
# File lib/rspec/core/configuration.rb, line 583 def formatters @formatters ||= [] end
# File lib/rspec/core/configuration.rb, line 475 def full_backtrace=(true_or_false) @backtrace_cleaner.full_backtrace = true_or_false end
# File lib/rspec/core/configuration.rb, line 471 def full_backtrace? @backtrace_cleaner.full_backtrace? end
# File lib/rspec/core/configuration.rb, line 556 def full_description filter.fetch :full_description, nil end
# File lib/rspec/core/configuration.rb, line 552 def full_description=(description) filter_run :full_description => Regexp.union(*Array(description).map {|d| Regexp.new(d) }) end
@private
# File lib/rspec/core/configuration.rb, line 990 def group_ordering_block @group_ordering_block ||= DEFAULT_ORDERING end
Tells RSpec to include `mod` in example groups. Methods defined in `mod` are exposed to examples (not example groups). Use `filters` to constrain the groups in which to include the module.
@example
module AuthenticationHelpers def login_as(user) # ... end end module UserHelpers def users(username) # ... end end RSpec.configure do |config| config.include(UserHelpers) # included in all modules config.include(AuthenticationHelpers, :type => :request) end describe "edit profile", :type => :request do it "can be viewed by owning user" do login_as users(:jdoe) get "/profiles/jdoe" assert_select ".username", :text => 'jdoe' end end
@see extend
# File lib/rspec/core/configuration.rb, line 810 def include(mod, *filters) include_or_extend_modules << [:include, mod, build_metadata_hash_from(filters)] end
Returns the `inclusion_filter`. If none has been set, returns an empty hash.
# File lib/rspec/core/configuration.rb, line 720 def inclusion_filter filter_manager.inclusions end
Clears and reassigns the `inclusion_filter`. Set to `nil` if you don't want any inclusion filter at all.
### Warning
This overrides any inclusion filters/tags set on the command line or in configuration files.
# File lib/rspec/core/configuration.rb, line 712 def inclusion_filter=(filter) filter_manager.include! build_metadata_hash_from([filter]) end
# File lib/rspec/core/configuration.rb, line 504 def libs=(libs) libs.map do |lib| @libs.unshift lib $LOAD_PATH.unshift lib end end
# File lib/rspec/core/configuration.rb, line 548 def line_numbers filter.fetch(:line_numbers,[]) end
Run examples defined on `line_numbers` in all files to run.
# File lib/rspec/core/configuration.rb, line 544 def line_numbers=(line_numbers) filter_run :line_numbers => line_numbers.map{|l| l.to_i} end
@private
# File lib/rspec/core/configuration.rb, line 895 def load_spec_files files_to_run.uniq.each {|f| load File.expand_path(f) } raise_if_rspec_1_is_loaded end
Returns the configured mock framework adapter module
# File lib/rspec/core/configuration.rb, line 277 def mock_framework mock_with :rspec unless @mock_framework @mock_framework end
Delegates to #mock_framework=(framework)
# File lib/rspec/core/configuration.rb, line 283 def mock_framework=(framework) mock_with framework end
Sets the mock framework adapter module.
`framework` can be a Symbol or a Module.
Given any of `:rspec`, `:mocha`, `:flexmock`, or `:rr`, configures the named framework.
Given `:nothing`, configures no framework. Use this if you don't use any mocking framework to save a little bit of overhead.
Given a Module, includes that module in every example group. The module should adhere to RSpec's mock framework adapter API:
setup_mocks_for_rspec - called before each example verify_mocks_for_rspec - called after each example. Framework should raise an exception when expectations fail teardown_mocks_for_rspec - called after verify_mocks_for_rspec (even if there are errors)
If the module responds to `configuration` and `mock_with` receives a block, it will yield the configuration object to the block e.g.
config.mock_with OtherMockFrameworkAdapter do |mod_config| mod_config.custom_setting = true end
# File lib/rspec/core/configuration.rb, line 372 def mock_with(framework) framework_module = case framework when Module framework when String, Symbol require case framework.to_s when /rspec/i 'rspec/core/mocking/with_rspec' when /mocha/i 'rspec/core/mocking/with_mocha' when /rr/i 'rspec/core/mocking/with_rr' when /flexmock/i 'rspec/core/mocking/with_flexmock' else 'rspec/core/mocking/with_absolutely_nothing' end RSpec::Core::MockFrameworkAdapter end new_name, old_name = [framework_module, @mock_framework].map do |mod| mod.respond_to?(:framework_name) ? mod.framework_name : :unnamed end unless new_name == old_name assert_no_example_groups_defined(:mock_framework) end if block_given? raise "#{framework_module} must respond to `configuration` so that mock_with can yield it." unless framework_module.respond_to?(:configuration) yield framework_module.configuration end @mock_framework = framework_module end
@api
Sets the order and, if order is `'rand:<seed>'`, also sets the seed.
# File lib/rspec/core/configuration.rb, line 929 def order=(type) order_and_seed_from_order(type) end
Sets a strategy by which to order examples.
@example
RSpec.configure do |config| config.order_examples do |examples| examples.reverse end end
@see order_groups @see order_groups_and_examples @see order= @see seed=
# File lib/rspec/core/configuration.rb, line 961 def order_examples(&block) @example_ordering_block = block @order = "custom" unless built_in_orderer?(block) end
Sets a strategy by which to order groups.
@example
RSpec.configure do |config| config.order_groups do |groups| groups.reverse end end
@see order_examples @see order_groups_and_examples @see order= @see seed=
# File lib/rspec/core/configuration.rb, line 984 def order_groups(&block) @group_ordering_block = block @order = "custom" unless built_in_orderer?(block) end
Sets a strategy by which to order groups and examples.
@example
RSpec.configure do |config| config.order_groups_and_examples do |groups_or_examples| groups_or_examples.reverse end end
@see order_groups @see order_examples @see order= @see seed=
# File lib/rspec/core/configuration.rb, line 1007 def order_groups_and_examples(&block) order_groups(&block) order_examples(&block) end
@api private
Defaults `profile_examples` to 10 examples when `@profile_examples` is `true`.
# File lib/rspec/core/configuration.rb, line 599 def profile_examples profile = value_for(:profile_examples, @profile_examples) if profile && !profile.is_a?(Integer) 10 else profile end end
# File lib/rspec/core/configuration.rb, line 933 def randomize? order.to_s.match(/rand/) end
# File lib/rspec/core/configuration.rb, line 587 def reporter @reporter ||= begin add_formatter('progress') if formatters.empty? add_formatter(RSpec::Core::Formatters::DeprecationFormatter, deprecation_stream, output_stream) Reporter.new(*formatters) end end
# File lib/rspec/core/configuration.rb, line 511 def requires=(paths) RSpec.deprecate("RSpec::Core::Configuration#requires=(paths)", :replacement => "paths.each {|path| require path}") paths.map {|path| require path} @requires += paths end
@private
# File lib/rspec/core/configuration.rb, line 228 def reset @reporter = nil @formatters.clear end
# File lib/rspec/core/configuration.rb, line 873 def safe_extend(mod, host) host.extend(mod) unless (class << host; self; end) < mod end
@private
# File lib/rspec/core/configuration.rb, line 859 def safe_include(mod, host) host.send(:include,mod) unless host < mod end
@api
Sets the seed value and sets `order='rand'`
# File lib/rspec/core/configuration.rb, line 922 def seed=(seed) order_and_seed_from_seed(seed) end
@private
# File lib/rspec/core/configuration.rb, line 864 def setup_load_path_and_require(paths) directories = ['lib', default_path].select { |p| File.directory? p } RSpec::Core::RubyProject.add_to_load_path(*directories) paths.each {|path| require path} @requires += paths end
# File lib/rspec/core/configuration.rb, line 1017 def warnings $VERBOSE end
Set Ruby warnings on or off
# File lib/rspec/core/configuration.rb, line 1013 def warnings= value $VERBOSE = !!value end
Private Instance Methods
# File lib/rspec/core/configuration.rb, line 1052 def assert_no_example_groups_defined(config_option) if RSpec.world.example_groups.any? raise MustBeConfiguredBeforeExampleGroupsError.new( "RSpec's #{config_option} configuration option must be configured before " + "any example groups are defined, but you have already defined a group." ) end end
# File lib/rspec/core/configuration.rb, line 1081 def built_in_formatter(key) case key.to_s when 'd', 'doc', 'documentation', 's', 'n', 'spec', 'nested' require 'rspec/core/formatters/documentation_formatter' RSpec::Core::Formatters::DocumentationFormatter when 'h', 'html' require 'rspec/core/formatters/html_formatter' RSpec::Core::Formatters::HtmlFormatter when 't', 'textmate' require 'rspec/core/formatters/text_mate_formatter' RSpec::Core::Formatters::TextMateFormatter when 'p', 'progress' require 'rspec/core/formatters/progress_formatter' RSpec::Core::Formatters::ProgressFormatter when 'j', 'json' require 'rspec/core/formatters/json_formatter' RSpec::Core::Formatters::JsonFormatter end end
# File lib/rspec/core/configuration.rb, line 1168 def built_in_orderer?(block) [DEFAULT_ORDERING, RANDOM_ORDERING].include?(block) end
# File lib/rspec/core/configuration.rb, line 1044 def command $0.split(File::SEPARATOR).last end
# File lib/rspec/core/configuration.rb, line 1101 def custom_formatter(formatter_ref) if Class === formatter_ref formatter_ref elsif string_const?(formatter_ref) begin eval(formatter_ref) rescue NameError require path_for(formatter_ref) eval(formatter_ref) end end end
# File lib/rspec/core/configuration.rb, line 1036 def extract_location(path) if path =~ /^(.*?)((?:\:\d+)+)$/ path, lines = $1, $2[1..-1].split(":").map{|n| n.to_i} filter_manager.add_location path, lines end path end
# File lib/rspec/core/configuration.rb, line 1137 def file_at(path) FileUtils.mkdir_p(File.dirname(path)) File.new(path, 'w') end
# File lib/rspec/core/configuration.rb, line 1030 def gather_directories(path) stripped = "{#{pattern.gsub(/\s*,\s*/, ',')}}" files = pattern =~ /^#{Regexp.escape path}/ ? Dir[stripped] : Dir["#{path}/#{stripped}"] files.sort end
# File lib/rspec/core/configuration.rb, line 1023 def get_files_to_run(paths) paths.map do |path| path = path.gsub(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR File.directory?(path) ? gather_directories(path) : extract_location(path) end.flatten.sort end
# File lib/rspec/core/configuration.rb, line 1153 def order_and_seed_from_order(type) order, seed = type.to_s.split(':') @order = order @seed = seed = seed.to_i if seed if randomize? order_groups_and_examples(&RANDOM_ORDERING) elsif order == 'default' @order, @seed = nil, nil order_groups_and_examples(&DEFAULT_ORDERING) end return order, seed end
# File lib/rspec/core/configuration.rb, line 1142 def order_and_seed_from_seed(value) order_groups_and_examples(&RANDOM_ORDERING) @order, @seed = 'rand', value.to_i [@order, @seed] end
# File lib/rspec/core/configuration.rb, line 1077 def output_to_tty?(output=output_stream) tty? || (output.respond_to?(:tty?) && output.tty?) end
# File lib/rspec/core/configuration.rb, line 1118 def path_for(const_ref) underscore_with_fix_for_non_standard_rspec_naming(const_ref) end
# File lib/rspec/core/configuration.rb, line 1061 def raise_if_rspec_1_is_loaded if defined?(Spec) && defined?(Spec::VERSION::MAJOR) && Spec::VERSION::MAJOR == 1 raise <<-MESSAGE #{'*'*80} You are running rspec-2, but it seems as though rspec-1 has been loaded as well. This is likely due to a statement like this somewhere in the specs: require 'spec' Please locate that statement, remove it, and try again. #{'*'*80} MESSAGE end end
# File lib/rspec/core/configuration.rb, line 1148 def set_order_and_seed(hash) hash[:order], seed = order_and_seed_from_order(hash[:order]) hash[:seed] = seed if seed end
# File lib/rspec/core/configuration.rb, line 1114 def string_const?(str) str.is_a?(String) && /\A[A-Z][a-zA-Z0-9_:]*\z/ =~ str end
activesupport/lib/active_support/inflector/methods.rb, line 48
# File lib/rspec/core/configuration.rb, line 1127 def underscore(camel_cased_word) word = camel_cased_word.to_s.dup word.gsub!(/::/, '/') word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2') word.gsub!(/([a-z\d])([A-Z])/,'\1_\2') word.tr!("-", "_") word.downcase! word end
# File lib/rspec/core/configuration.rb, line 1122 def underscore_with_fix_for_non_standard_rspec_naming(string) underscore(string).sub(%r{(^|/)r_spec($|/)}, '\1rspec\2') end
# File lib/rspec/core/configuration.rb, line 1048 def value_for(key, default=nil) @preferred_options.has_key?(key) ? @preferred_options[key] : default end