1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
module RSpec
module Rails
# Fake class to document RSpec Rails configuration options. In practice,
# these are dynamically added to the normal RSpec configuration object.
class Configuration
# @!method infer_spec_type_from_file_location!
# Automatically tag specs in conventional directories with matching `type`
# metadata so that they have relevant helpers available to them. See
# `RSpec::Rails::DIRECTORY_MAPPINGS` for details on which metadata is
# applied to each directory.
# @!method render_views=(val)
#
# When set to `true`, controller specs will render the relevant view as
# well. Defaults to `false`.
# @!method render_views(val)
# Enables view rendering for controllers specs.
# @!method render_views?
# Reader for currently value of `render_views` setting.
end
# Mappings used by `infer_spec_type_from_file_location!`.
#
# @api private
DIRECTORY_MAPPINGS = {
channel: %w[spec channels],
controller: %w[spec controllers],
generator: %w[spec generator],
helper: %w[spec helpers],
job: %w[spec jobs],
mailer: %w[spec mailers],
model: %w[spec models],
request: %w[spec (requests|integration|api)],
routing: %w[spec routing],
view: %w[spec views],
feature: %w[spec features],
system: %w[spec system],
mailbox: %w[spec mailboxes]
}
# Sets up the different example group modules for the different spec types
#
# @api private
def self.add_test_type_configurations(config)
config.include RSpec::Rails::ControllerExampleGroup, type: :controller
config.include RSpec::Rails::HelperExampleGroup, type: :helper
config.include RSpec::Rails::ModelExampleGroup, type: :model
config.include RSpec::Rails::RequestExampleGroup, type: :request
config.include RSpec::Rails::RoutingExampleGroup, type: :routing
config.include RSpec::Rails::ViewExampleGroup, type: :view
config.include RSpec::Rails::FeatureExampleGroup, type: :feature
config.include RSpec::Rails::Matchers
config.include RSpec::Rails::SystemExampleGroup, type: :system
end
# @private
def self.initialize_configuration(config) # rubocop:disable Metrics/MethodLength
config.backtrace_exclusion_patterns << /vendor\//
config.backtrace_exclusion_patterns << %r{lib/rspec/rails}
# controller settings
config.add_setting :infer_base_class_for_anonymous_controllers, default: true
# fixture support
config.add_setting :use_active_record, default: true
config.add_setting :use_transactional_fixtures, alias_with: :use_transactional_examples
config.add_setting :use_instantiated_fixtures
config.add_setting :global_fixtures
config.add_setting :fixture_paths
config.include RSpec::Rails::FixtureSupport, :use_fixtures
# We'll need to create a deprecated module in order to properly report to
# gems / projects which are relying on this being loaded globally.
#
# See rspec/rspec-rails#1355 for history
#
# @deprecated Include `RSpec::Rails::RailsExampleGroup` or
# `RSpec::Rails::FixtureSupport` directly instead
config.include RSpec::Rails::FixtureSupport
config.add_setting :file_fixture_path, default: 'spec/fixtures/files'
config.include RSpec::Rails::FileFixtureSupport
# Add support for fixture_paths on fixture_file_upload
config.include RSpec::Rails::FixtureFileUploadSupport
# This allows us to expose `render_views` as a config option even though it
# breaks the convention of other options by using `render_views` as a
# command (i.e. `render_views = true`), where it would normally be used
# as a getter. This makes it easier for rspec-rails users because we use
# `render_views` directly in example groups, so this aligns the two APIs,
# but requires this workaround:
config.add_setting :rendering_views, default: false
config.instance_exec do
def render_views=(val)
self.rendering_views = val
end
def render_views
self.rendering_views = true
end
def render_views?
rendering_views?
end
def infer_spec_type_from_file_location!
DIRECTORY_MAPPINGS.each do |type, dir_parts|
escaped_path = Regexp.compile(dir_parts.join('[\\\/]') + '[\\\/]')
define_derived_metadata(file_path: escaped_path) do |metadata|
metadata[:type] ||= type
end
end
end
# Adds exclusion filters for gems included with Rails
def filter_rails_from_backtrace!
filter_gems_from_backtrace "actionmailer", "actionpack", "actionview"
filter_gems_from_backtrace "activemodel", "activerecord",
"activesupport", "activejob"
end
end
add_test_type_configurations(config)
if defined?(::Rails::Controller::Testing)
[:controller, :view, :request].each do |type|
config.include ::Rails::Controller::Testing::TestProcess, type: type
config.include ::Rails::Controller::Testing::TemplateAssertions, type: type
config.include ::Rails::Controller::Testing::Integration, type: type
end
end
if RSpec::Rails::FeatureCheck.has_action_mailer?
config.include RSpec::Rails::MailerExampleGroup, type: :mailer
config.after { ActionMailer::Base.deliveries.clear }
end
if RSpec::Rails::FeatureCheck.has_active_job?
config.include RSpec::Rails::JobExampleGroup, type: :job
end
if RSpec::Rails::FeatureCheck.has_action_cable_testing?
config.include RSpec::Rails::ChannelExampleGroup, type: :channel
end
if RSpec::Rails::FeatureCheck.has_action_mailbox?
config.include RSpec::Rails::MailboxExampleGroup, type: :mailbox
end
end
initialize_configuration RSpec.configuration
end
end
|
