Skip to content
This repository was archived by the owner on Nov 30, 2024. It is now read-only.

Refactor config #2188

Merged
merged 4 commits into from
Mar 4, 2016
Merged

Refactor config #2188

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
474e3b0
Privatize config functions that should not be public.
myronmarston Mar 3, 2016
25821d9
Refactor: configure_existing_groups -> on_existing_matching_groups
myronmarston Mar 3, 2016
1079555
Declare explicit `scope` and `meta` arguments.
myronmarston Mar 3, 2016
a7ca029
Reduce the number of args passed to `handle_suite_hook`.
myronmarston Mar 4, 2016
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
126 changes: 60 additions & 66 deletions lib/rspec/core/configuration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1161,7 +1161,7 @@ def exclusion_filter
def include(mod, *filters)
meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)
@include_modules.append(mod, meta)
configure_existing_groups(mod, meta, :safe_include)
on_existing_matching_groups(meta) { |group| safe_include(mod, group) }
end

# Tells RSpec to extend example groups with `mod`. Methods defined in
Expand Down Expand Up @@ -1197,7 +1197,7 @@ def include(mod, *filters)
def extend(mod, *filters)
meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)
@extend_modules.append(mod, meta)
configure_existing_groups(mod, meta, :safe_extend)
on_existing_matching_groups(meta) { |group| safe_extend(mod, group) }
end

if RSpec::Support::RubyFeatures.module_prepends_supported?
Expand Down Expand Up @@ -1236,7 +1236,7 @@ def extend(mod, *filters)
def prepend(mod, *filters)
meta = Metadata.build_hash_from(filters, :warn_about_example_group_filtering)
@prepend_modules.append(mod, meta)
configure_existing_groups(mod, meta, :safe_prepend)
on_existing_matching_groups(meta) { |group| safe_prepend(mod, group) }
end
end

Expand All @@ -1250,21 +1250,6 @@ def configure_group(group)
configure_group_with group, @prepend_modules, :safe_prepend
end

# @private
def configure_group_with(group, module_list, application_method)
module_list.items_for(group.metadata).each do |mod|
__send__(application_method, mod, group)
end
end

# @private
def configure_existing_groups(mod, meta, application_method)
world.all_example_groups.each do |group|
next unless meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)
__send__(application_method, mod, group)
end
end

# @private
#
# Used internally to extend the singleton class of a single example's
Expand All @@ -1284,13 +1269,6 @@ def configure_example(example)
end
end

if RSpec::Support::RubyFeatures.module_prepends_supported?
# @private
def safe_prepend(mod, host)
host.__send__(:prepend, mod) unless host < mod
end
end

# @private
def requires=(paths)
directories = ['lib', default_path].select { |p| File.directory? p }
Expand All @@ -1308,31 +1286,6 @@ def in_project_source_dir_regex
Regexp.union(regexes)
end

# @private
if RUBY_VERSION.to_f >= 1.9
# @private
def safe_include(mod, host)
host.__send__(:include, mod) unless host < mod
end

# @private
def safe_extend(mod, host)
host.extend(mod) unless host.singleton_class < mod
end
else # for 1.8.7
# :nocov:
# @private
def safe_include(mod, host)
host.__send__(:include, mod) unless host.included_modules.include?(mod)
end

# @private
def safe_extend(mod, host)
host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)
end
# :nocov:
end

# @private
def configure_mock_framework
RSpec::Core::ExampleGroup.__send__(:include, mock_framework)
Expand Down Expand Up @@ -1616,9 +1569,10 @@ def apply_derived_metadata_to(metadata)
# @see #prepend_before
# @see #after
# @see #append_after
def before(*args, &block)
handle_suite_hook(args, @before_suite_hooks, :push,
Hooks::BeforeHook, block) || super(*args, &block)
def before(scope=nil, *meta, &block)
handle_suite_hook(scope, meta) do
@before_suite_hooks << Hooks::BeforeHook.new(block, {})
end || super(scope, *meta, &block)
end
alias_method :append_before, :before

Expand All @@ -1635,9 +1589,10 @@ def before(*args, &block)
# @see #before
# @see #after
# @see #append_after
def prepend_before(*args, &block)
handle_suite_hook(args, @before_suite_hooks, :unshift,
Hooks::BeforeHook, block) || super(*args, &block)
def prepend_before(scope=nil, *meta, &block)
handle_suite_hook(scope, meta) do
@before_suite_hooks.unshift Hooks::BeforeHook.new(block, {})
end || super(scope, *meta, &block)
end

# Defines a `after` hook. See {Hooks#after} for full docs.
Expand All @@ -1649,9 +1604,10 @@ def prepend_before(*args, &block)
# @see #append_after
# @see #before
# @see #prepend_before
def after(*args, &block)
handle_suite_hook(args, @after_suite_hooks, :unshift,
Hooks::AfterHook, block) || super(*args, &block)
def after(scope=nil, *meta, &block)
handle_suite_hook(scope, meta) do
@after_suite_hooks.unshift Hooks::AfterHook.new(block, {})
end || super(scope, *meta, &block)
end
alias_method :prepend_after, :after

Expand All @@ -1668,9 +1624,10 @@ def after(*args, &block)
# @see #append_after
# @see #before
# @see #prepend_before
def append_after(*args, &block)
handle_suite_hook(args, @after_suite_hooks, :push,
Hooks::AfterHook, block) || super(*args, &block)
def append_after(scope=nil, *meta, &block)
handle_suite_hook(scope, meta) do
@after_suite_hooks << Hooks::AfterHook.new(block, {})
end || super(scope, *meta, &block)
end

# @private
Expand Down Expand Up @@ -1707,11 +1664,10 @@ def on_example_group_definition_callbacks

private

def handle_suite_hook(args, collection, append_or_prepend, hook_type, block)
scope, meta = *args
def handle_suite_hook(scope, meta)
return nil unless scope == :suite

if meta
unless meta.empty?
# TODO: in RSpec 4, consider raising an error here.
# We warn only for backwards compatibility.
RSpec.warn_with "WARNING: `:suite` hooks do not support metadata since " \
Expand All @@ -1720,7 +1676,7 @@ def handle_suite_hook(args, collection, append_or_prepend, hook_type, block)
"The metadata you have provided (#{meta.inspect}) will be ignored."
end

collection.__send__(append_or_prepend, hook_type.new(block, {}))
yield
end

def run_hooks_with(hooks, hook_context)
Expand Down Expand Up @@ -1866,6 +1822,44 @@ def clear_values_derived_from_example_status_persistence_file_path
@last_run_statuses = nil
@spec_files_with_failures = nil
end

def configure_group_with(group, module_list, application_method)
module_list.items_for(group.metadata).each do |mod|
__send__(application_method, mod, group)
end
end

def on_existing_matching_groups(meta)
world.all_example_groups.each do |group|
yield group if meta.empty? || MetadataFilter.apply?(:any?, meta, group.metadata)
end
end

if RSpec::Support::RubyFeatures.module_prepends_supported?
def safe_prepend(mod, host)
host.__send__(:prepend, mod) unless host < mod
end
end

if RUBY_VERSION.to_f >= 1.9
def safe_include(mod, host)
host.__send__(:include, mod) unless host < mod
end

def safe_extend(mod, host)
host.extend(mod) unless host.singleton_class < mod
end
else # for 1.8.7
# :nocov:
def safe_include(mod, host)
host.__send__(:include, mod) unless host.included_modules.include?(mod)
end

def safe_extend(mod, host)
host.extend(mod) unless (class << host; self; end).included_modules.include?(mod)
end
# :nocov:
end
end
# rubocop:enable Metrics/ClassLength
end
Expand Down