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.
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/rspec/rails/configuration.rb', line 7
+
+
+
+
+
+
+
+ #render_views(val) ⇒ Object
+
+
+
Enables view rendering for controllers specs.
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/rspec/rails/configuration.rb', line 18
+
+
+
+
+
+
+
+ #render_views=(val) ⇒ Object
+
+
+
When set to true, controller specs will render the relevant view as
+well. Defaults to false.
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/rspec/rails/configuration.rb', line 13
+
+
+
+
+
+
+
+ #render_views? ⇒ Object
+
+
+
Reader for currently value of render_views setting.
+
+
+
+
+
+
+
+
+
+
+
# File 'lib/rspec/rails/configuration.rb', line 21
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/source/documentation/7.0/rspec-rails/RSpec/Rails/ActiveRecordConfiguration.html b/source/documentation/7.0/rspec-rails/RSpec/Rails/ActiveRecordConfiguration.html
new file mode 100644
index 000000000..ce0c459e6
--- /dev/null
+++ b/source/documentation/7.0/rspec-rails/RSpec/Rails/ActiveRecordConfiguration.html
@@ -0,0 +1,80 @@
+
+
+
+
+
+
+ Class: RSpec::Rails::ActiveRecordConfiguration
+ — Documentation by YARD 0.9.36
+
+
+
+
+
+
+
+
+
+
If method is a named_route, delegates to the RouteSet associated with
+this controller.
+
+
+
+
+
+
+
+172
+173
+174
+175
+176
+177
+178
+
+
+
# File 'lib/rspec/rails/example/controller_example_group.rb', line 172
+defmethod_missing(method,*args,&block)
+ ifroute_available?(method)
+ controller.send(method,*args,&block)
+ else
+ super
+ end
+end
+
+
+
+
+
+
+
Instance Attribute Details
+
+
+
+ #controller ⇒ Object(readonly)
+
+
+
Returns the controller object instance under test.
+
+
+
+
+
+
+
+128
+129
+130
+
+
+
# File 'lib/rspec/rails/example/controller_example_group.rb', line 128
+defcontroller
+ @controller
+end
+
+
+
+
+
+
+
+ #routes ⇒ Object
+
+
+
Returns the Rails routes used for the spec.
+
+
+
+
+
+
+
+132
+133
+134
+
+
+
# File 'lib/rspec/rails/example/controller_example_group.rb', line 132
+defroutes
+ @routes
+end
+
+
+
+
+
+
+
Instance Method Details
+
+
+ #bypass_rescue ⇒ Object
+
+
+
Extends the controller with a module that overrides
+rescue_with_handler to raise the exception passed to it. Use this to
+specify that an action should raise an exception given appropriate
+conditions.
+
+
+
+
+
Examples:
+
describeProfilesControllerdo
+ it"raises a 403 when a non-admin user tries to view another user's profile"do
+ profile=create_profile
+ login_asprofile.user
+ expectdo
+ bypass_rescue
+ get:show,id:profile.id+1
+ end.toraise_error(/403 Forbidden/)
+ end
+end
+
+
+
+
+
+166
+167
+168
+
+
+
# File 'lib/rspec/rails/example/controller_example_group.rb', line 166
+defbypass_rescue
+ controller.extend(BypassRescue)
+end
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/source/documentation/7.0/rspec-rails/RSpec/Rails/ControllerExampleGroup/ClassMethods.html b/source/documentation/7.0/rspec-rails/RSpec/Rails/ControllerExampleGroup/ClassMethods.html
new file mode 100644
index 000000000..fb1600bd0
--- /dev/null
+++ b/source/documentation/7.0/rspec-rails/RSpec/Rails/ControllerExampleGroup/ClassMethods.html
@@ -0,0 +1,277 @@
+
+
+
+
+
+
+ Module: RSpec::Rails::ControllerExampleGroup::ClassMethods
+ — Documentation by YARD 0.9.36
+
+
+
+
+
+
+
+
+
+
Specifies the routeset that will be used for the example group.
+
+
+
+
+
Instance Method Details
+
+
+ #controller(base_class = nil, &body) ⇒ Object
+
+
+
+ Note:
+
Due to Ruby 1.8 scoping rules in anonymous subclasses, constants
+defined in ApplicationController must be fully qualified (e.g.
+ApplicationController::AccessDenied) in the block passed to the
+controller method. Any instance methods, filters, etc, that are
+defined in ApplicationController, however, are accessible from
+within the block.
+
+
+
Supports a simple DSL for specifying behavior of ApplicationController.
+Creates an anonymous subclass of ApplicationController and evals the
+body in that context. Also sets up implicit routes for this
+controller, that are separate from those defined in "config/routes.rb".
+
If you would like to spec a subclass of ApplicationController, call
+controller like so:
describeApplicationControllerdo
+ controllerdo
+ defindex
+ raiseApplicationController::AccessDenied
+ end
+ end
+ describe"handling AccessDenied exceptions"do
+ it"redirects to the /401.html page"do
+ get:index
+ response.shouldredirect_to("/401.html")
+ end
+ end
+end
Shim to check for presence of Capybara. Will delegate if present, raise
+if not. We assume here that in most cases visit will be the first
+Capybara method called in a spec.
+
+
+
+
+
+
+
+27
+28
+29
+30
+31
+32
+33
+
+
+
# File 'lib/rspec/rails/example/feature_example_group.rb', line 27
+defvisit(*)
+ ifdefined?(super)
+ super
+ else
+ raise"Capybara not loaded, please add it to your Gemfile:\n\ngem \"capybara\""
+ end
+end
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/source/documentation/7.0/rspec-rails/RSpec/Rails/HelperExampleGroup.html b/source/documentation/7.0/rspec-rails/RSpec/Rails/HelperExampleGroup.html
new file mode 100644
index 000000000..66ecc765b
--- /dev/null
+++ b/source/documentation/7.0/rspec-rails/RSpec/Rails/HelperExampleGroup.html
@@ -0,0 +1,127 @@
+
+
+
+
+
+
+ Module: RSpec::Rails::HelperExampleGroup
+ — Documentation by YARD 0.9.36
+
+
+
+
+
+
+
+
+
+
Passes if actual is an instance of model_class and returns true for
+new_record?. Typically used to specify instance variables assigned to
+views by controller actions
+
Use the with method to specify the specific attributes to match on the
+new record.
# File 'lib/rspec/rails/matchers/be_a_new.rb', line 78
+defbe_a_new(model_class)
+ BeANew.new(model_class)
+end
+
+
+
+
+
+
+ #be_new_record ⇒ Object
+
+
+
Passes if actual returns true for new_record?.
+
+
+
+
+
Examples:
+
get:new
+expect(assigns(:thing)).tobe_new_record
+
+
+
+
+
+25
+26
+27
+
+
+
# File 'lib/rspec/rails/matchers/be_new_record.rb', line 25
+defbe_new_record
+ BeANewRecord.new
+end
+
+
+
+
+
+
+ #be_valid(*args) ⇒ Object
+
+
+
Passes if the given model instance's valid? method is true, meaning
+all of the ActiveModel::Validations passed and no errors exist. If a
+message is not given, a default message is shown listing each error.
+
+
+
+
+
Examples:
+
thing=Thing.new
+expect(thing).tobe_valid
+
+
+
+
+
+44
+45
+46
+
+
+
# File 'lib/rspec/rails/matchers/be_valid.rb', line 44
+defbe_valid(*args)
+ BeValid.new(*args)
+end
+
+
+
+
+
+
+ #have_been_enqueued ⇒ Object
+
+
+
Passes if a job has been enqueued. May chain at_least, at_most or exactly to specify a number of times.
+ #have_broadcasted_to(target = nil) ⇒ Object
+ Also known as:
+ broadcast_to
+
+
+
+
Passes if a message has been sent to a stream/object inside a block.
+May chain at_least, at_most or exactly to specify a number of times.
+To specify channel from which message has been broadcasted to object use from_channel.
+ #have_enqueued_mail(mailer_class = nil, mail_method_name = nil) ⇒ Object
+ Also known as:
+ have_enqueued_email, enqueue_mail, enqueue_email
+
+
+
+
Passes if an email has been enqueued inside block.
+May chain with to specify expected arguments.
+May chain at_least, at_most or exactly to specify a number of times.
+May chain at to specify a send time.
+May chain on_queue to specify a queue.
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
+
+
+
Returns:
+
+
+ (Boolean)
+
+
+
+
+
+
+31
+32
+33
+
+
+
# File 'lib/rspec/rails/matchers/action_cable/have_streams.rb', line 31
+defdoes_not_match?(subscription)
+ !match(subscription)
+end
+
+
+
+
+
+
+ #failure_message ⇒ String
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
+
+
+
Returns:
+
+
+ (String)
+
+
+
+
+
+
+11
+12
+13
+
+
+
# File 'lib/rspec/rails/matchers/action_cable/have_streams.rb', line 11
+deffailure_message
+ "expected to have #{base_message}"
+end
+
+
+
+
+
+
+ #failure_message_when_negated ⇒ String
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
+
+
+
Returns:
+
+
+ (String)
+
+
+
+
+
+
+17
+18
+19
+
+
+
# File 'lib/rspec/rails/matchers/action_cable/have_streams.rb', line 17
+deffailure_message_when_negated
+ "expected not to have #{base_message}"
+end
+
+
+
+
+
+
+ #matches?(subscription) ⇒ Boolean
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
+
+
+
Returns:
+
+
+ (Boolean)
+
+
+
Raises:
+
+
+ (ArgumentError)
+
+
+
+
+
+
+23
+24
+25
+26
+27
+
+
+
# File 'lib/rspec/rails/matchers/action_cable/have_streams.rb', line 23
+defmatches?(subscription)
+ raise(ArgumentError,"have_streams is used for negated expectations only")ifno_expected?
+ match(subscription)
+end
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/source/documentation/7.0/rspec-rails/RSpec/Rails/Matchers/ActionMailbox.html b/source/documentation/7.0/rspec-rails/RSpec/Rails/Matchers/ActionMailbox.html
new file mode 100644
index 000000000..ea72795b6
--- /dev/null
+++ b/source/documentation/7.0/rspec-rails/RSpec/Rails/Matchers/ActionMailbox.html
@@ -0,0 +1,73 @@
+
+
+
+
+
+
+ Module: RSpec::Rails::Matchers::ActionMailbox
+ — Documentation by YARD 0.9.36
+
+
+
+
+
+
+
+
+
+
Most matchers are value matchers (i.e. meant to work with expect(value)) rather than block matchers (i.e. meant to work with expect { }), so this defaults to false.
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Matchers are not diffable by default. Override this to make your
+subclass diffable.
+
+
+
+
Returns:
+
+
+ (Boolean)
+
+
+
+
+
+
+62
+63
+64
+
+
+
# File 'lib/rspec/rails/matchers/base_matcher.rb', line 62
+defdiffable?
+ false
+end
+
+
+
+
+
+
+ #expects_call_stack_jump? ⇒ Boolean
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
+
+
+
Returns:
+
+
+ (Boolean)
+
+
+
+
+
+
+75
+76
+77
+
+
+
# File 'lib/rspec/rails/matchers/base_matcher.rb', line 75
+defexpects_call_stack_jump?
+ false
+end
+
+
+
+
+
+
+ #match_unless_raises(*exceptions) ⇒ Object
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Used to wrap a block of code that will indicate failure by
+raising one of the named exceptions.
+
This is used by rspec-rails for some of its matchers that
+wrap rails' assertions.
+
+
+
+
+
+
+
+40
+41
+42
+43
+44
+45
+46
+47
+48
+
+
+
# File 'lib/rspec/rails/matchers/base_matcher.rb', line 40
+defmatch_unless_raises(*exceptions)
+ exceptions.unshiftExceptionifexceptions.empty?
+ begin
+ yield
+ true
+ rescue*exceptions=>@rescued_exception
+ false
+ end
+end
+
+
+
+
+
+
+ #matches?(actual) ⇒ Boolean
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Indicates if the match is successful. Delegates to match, which
+should be defined on a subclass. Takes care of consistently
+initializing the actual attribute.
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Most matchers are value matchers (i.e. meant to work with expect(value))
+rather than block matchers (i.e. meant to work with expect { }), so
+this defaults to false. Block matchers must override this to return true.
+
+
+
+
Returns:
+
+
+ (Boolean)
+
+
+
+
+
+
+70
+71
+72
+
+
+
# File 'lib/rspec/rails/matchers/base_matcher.rb', line 70
+defsupports_block_expectations?
+ false
+end
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/source/documentation/7.0/rspec-rails/RSpec/Rails/Matchers/BaseMatcher/DefaultFailureMessages.html b/source/documentation/7.0/rspec-rails/RSpec/Rails/Matchers/BaseMatcher/DefaultFailureMessages.html
new file mode 100644
index 000000000..bb9855731
--- /dev/null
+++ b/source/documentation/7.0/rspec-rails/RSpec/Rails/Matchers/BaseMatcher/DefaultFailureMessages.html
@@ -0,0 +1,178 @@
+
+
+
+
+
+
+ Module: RSpec::Rails::Matchers::BaseMatcher::DefaultFailureMessages
+ — Documentation by YARD 0.9.36
+
+
+
+
+
+
+
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Provides a good generic failure message. Based on description.
+When subclassing, if you are not satisfied with this failure message
+you often only need to override description.
+
+
+
+
Returns:
+
+
+ (String)
+
+
+
+
+
+
+153
+154
+155
+
+
+
# File 'lib/rspec/rails/matchers/base_matcher.rb', line 153
+deffailure_message
+ "expected #{description_of@actual} to #{description}".dup
+end
+
+
+
+
+
+
+ #failure_message_when_negated ⇒ String
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Provides a good generic negative failure message. Based on description.
+When subclassing, if you are not satisfied with this failure message
+you often only need to override description.
+
+
+
+
Returns:
+
+
+ (String)
+
+
+
+
+
+
+162
+163
+164
+
+
+
# File 'lib/rspec/rails/matchers/base_matcher.rb', line 162
+deffailure_message_when_negated
+ "expected #{description_of@actual} not to #{description}".dup
+end
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/source/documentation/7.0/rspec-rails/RSpec/Rails/Matchers/BeANew.html b/source/documentation/7.0/rspec-rails/RSpec/Rails/Matchers/BeANew.html
new file mode 100644
index 000000000..25442bc00
--- /dev/null
+++ b/source/documentation/7.0/rspec-rails/RSpec/Rails/Matchers/BeANew.html
@@ -0,0 +1,143 @@
+
+
+
+
+
+
+ Class: RSpec::Rails::Matchers::BeANew
+ — Documentation by YARD 0.9.36
+
+
+
+
+
+
+
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Returns a formatted failure message if
+@invalid_response is present, nil otherwise.
+
+
+
+
Returns:
+
+
+ (String, nil)
+ —
+
a formatted failure message if
+@invalid_response is present, nil otherwise
+
+
+
+
+
+
+
+60
+61
+62
+63
+64
+65
+
+
+
# File 'lib/rspec/rails/matchers/have_http_status.rb', line 60
+definvalid_response_type_message
+ returnunless@invalid_response
+ "expected a response object, but an instance of " \
+ "#{@invalid_response.class} was received"
+end
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/source/documentation/7.0/rspec-rails/RSpec/Rails/Matchers/HaveHttpStatus/GenericStatus.html b/source/documentation/7.0/rspec-rails/RSpec/Rails/Matchers/HaveHttpStatus/GenericStatus.html
new file mode 100644
index 000000000..ac570b659
--- /dev/null
+++ b/source/documentation/7.0/rspec-rails/RSpec/Rails/Matchers/HaveHttpStatus/GenericStatus.html
@@ -0,0 +1,442 @@
+
+
+
+
+
+
+ Class: RSpec::Rails::Matchers::HaveHttpStatus::GenericStatus
+ — Documentation by YARD 0.9.36
+
+
+
+
+
+
+
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
+
+
+
Returns:
+
+
+ (String)
+
+
+
+
+
+
+273
+274
+275
+
+
+
# File 'lib/rspec/rails/matchers/have_http_status.rb', line 273
+defdescription
+ "respond with #{type_message}"
+end
+
+
+
+
+
+
+ #failure_message ⇒ String
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Returns explaining why the match failed.
+
+
+
+
Returns:
+
+
+ (String)
+ —
+
explaining why the match failed
+
+
+
+
+
+
+
+278
+279
+280
+281
+
+
+
# File 'lib/rspec/rails/matchers/have_http_status.rb', line 278
+deffailure_message
+ invalid_response_type_message||
+ "expected the response to have #{type_message} but it was #{actual}"
+end
+
+
+
+
+
+
+ #failure_message_when_negated ⇒ String
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Returns explaining why the match failed.
+
+
+
+
Returns:
+
+
+ (String)
+ —
+
explaining why the match failed
+
+
+
+
+
+
+
+284
+285
+286
+287
+
+
+
# File 'lib/rspec/rails/matchers/have_http_status.rb', line 284
+deffailure_message_when_negated
+ invalid_response_type_message||
+ "expected the response not to have #{type_message} but it was #{actual}"
+end
+
+
+
+
+
+
+ #matches?(response) ⇒ Boolean
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Returns true if Rack's associated numeric HTTP code matched
+the response code or the named response status.
+
+
+
+
Returns:
+
+
+ (Boolean)
+ —
+
true if Rack's associated numeric HTTP code matched
+the response code or the named response status
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
+
+
+
Returns:
+
+
+ (String)
+
+
+
+
+
+
+98
+99
+100
+
+
+
# File 'lib/rspec/rails/matchers/have_http_status.rb', line 98
+defdescription
+ "respond with numeric status code #{expected}"
+end
+
+
+
+
+
+
+ #failure_message ⇒ String
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Returns explaining why the match failed.
+
+
+
+
Returns:
+
+
+ (String)
+ —
+
explaining why the match failed
+
+
+
+
+
+
+
+103
+104
+105
+106
+107
+
+
+
# File 'lib/rspec/rails/matchers/have_http_status.rb', line 103
+deffailure_message
+ invalid_response_type_message||
+ "expected the response to have status code #{expected.inspect}" \
+ " but it was #{actual.inspect}"
+end
+
+
+
+
+
+
+ #failure_message_when_negated ⇒ String
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Returns explaining why the match failed.
+
+
+
+
Returns:
+
+
+ (String)
+ —
+
explaining why the match failed
+
+
+
+
+
+
+
+110
+111
+112
+113
+114
+
+
+
# File 'lib/rspec/rails/matchers/have_http_status.rb', line 110
+deffailure_message_when_negated
+ invalid_response_type_message||
+ "expected the response not to have status code " \
+ "#{expected.inspect} but it did"
+end
+
+
+
+
+
+
+ #matches?(response) ⇒ Boolean
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Returns true if the numeric code matched the response code.
+
+
+
+
Parameters:
+
+
+ response
+ (Object)
+ —
+
object providing an http code to match
+
+
+
+
Returns:
+
+
+ (Boolean)
+ —
+
true if the numeric code matched the response code
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
+
+
+
Returns:
+
+
+ (String)
+
+
+
+
+
+
+151
+152
+153
+
+
+
# File 'lib/rspec/rails/matchers/have_http_status.rb', line 151
+defdescription
+ "respond with status code #{pp_expected}"
+end
+
+
+
+
+
+
+ #failure_message ⇒ String
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Returns explaining why the match failed.
+
+
+
+
Returns:
+
+
+ (String)
+ —
+
explaining why the match failed
+
+
+
+
+
+
+
+156
+157
+158
+159
+160
+
+
+
# File 'lib/rspec/rails/matchers/have_http_status.rb', line 156
+deffailure_message
+ invalid_response_type_message||
+ "expected the response to have status code #{pp_expected} but it" \
+ " was #{pp_actual}"
+end
+
+
+
+
+
+
+ #failure_message_when_negated ⇒ String
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
+
Returns explaining why the match failed.
+
+
+
+
Returns:
+
+
+ (String)
+ —
+
explaining why the match failed
+
+
+
+
+
+
+
+163
+164
+165
+166
+167
+
+
+
# File 'lib/rspec/rails/matchers/have_http_status.rb', line 163
+deffailure_message_when_negated
+ invalid_response_type_message||
+ "expected the response not to have status code #{pp_expected}" \
+ "but it did"
+end
+
+
+
+
+
+
+ #matches?(response) ⇒ Boolean
+
+
+
+ This method is part of a private API.
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+
Passes if the route expression is recognized by the Rails router based on
+the declarations in config/routes.rb. Delegates to
+RouteSet#recognize_path.
+
+
+
+
+
Examples:
+
You can use route helpers provided by rspec-rails.
# File 'lib/rspec/rails/example/view_example_group.rb', line 111
+defresponse
+ # `assert_template` expects `response` to implement a #body method
+# like an `ActionDispatch::Response` does to force the view to
+# render. For backwards compatibility, we use #response as an alias
+# for #rendered, but it needs to implement #body to avoid
+# `assert_template` raising a `NoMethodError`.
+unlessrendered.respond_to?(:body)
+ defrendered.body
+ self
+ end
+ end
+ rendered
+end
+
+
+
+
+
+
+ #stub_template(hash) ⇒ Object
+
+
+
Simulates the presence of a template on the file system by adding a
+Rails' FixtureResolver to the front of the view_paths list. Designed to
+help isolate view examples from partials rendered by the view template
+that is the subject of the example.
# File 'lib/rspec/rails/view_path_builder.rb', line 5
+definitialize(route_set)
+ self.class.send(:include,route_set.url_helpers)
+end
+
+
+
+
+
+
+
Instance Method Details
+
+
+ #path_for(path_params) ⇒ Object
+
+
+
Given a hash of parameters, build a view path, if possible.
+Returns nil if no path can be built from the given params.
+
+
+
+
+
Examples:
+
# path can be built because all required params are present in the hash
+view_path_builder=ViewPathBuilder.new(::Rails.application.routes)
+view_path_builder.path_for({:controller=>'posts',:action=>'show',:id=>'54'})
+# => "/post/54"
+
# path cannot be built because the params are missing a required element (:id)
+view_path_builder.path_for({:controller=>'posts',:action=>'delete'})
+# => ActionController::UrlGenerationError: No route matches {:action=>"delete", :controller=>"posts"}
Removes methods extra_params= and extra_params from the indicated class.
+
+
+
+
+
Class Method Details
+
+
+ .add_to(klass) ⇒ Object
+
+
+
Adds methods extra_params= and extra_params to the indicated class.
+When class is ::ActionView::TestCase::TestController, these methods
+are exposed in view specs on the controller object.
# File 'lib/rspec/rails/view_spec_methods.rb', line 11
+defadd_to(klass)
+ returnifklass.method_defined?(:extra_params)&&klass.method_defined?(:extra_params=)
+ klass.module_execdo
+ # Set any extra parameters that rendering a URL for this view
+# would require.
+#
+# @example
+#
+# # In "spec/views/widgets/show.html.erb_spec.rb":
+# before do
+# widget = Widget.create!(:name => "slicer")
+# controller.extra_params = { :id => widget.id }
+# end
+defextra_params=(hash)
+ @extra_params=hash
+ request.path=
+ ViewPathBuilder.new(::Rails.application.routes).path_for(
+ extra_params.merge(request.path_parameters)
+ )
+ end
+ # Use to read extra parameters that are set in the view spec.
+#
+# @example
+#
+# # After the before in the above example:
+# controller.extra_params
+# # => { :id => 4 }
+defextra_params
+ @extra_params||={}
+ @extra_params.dup.freeze
+ end
+ end
+end
+
+
+
+
+
+
+ .remove_from(klass) ⇒ Object
+
+
+
Removes methods extra_params= and extra_params from the indicated class.
+
+
+
+
+
+
+
+48
+49
+50
+51
+52
+53
+
+
+
# File 'lib/rspec/rails/view_spec_methods.rb', line 48
+defremove_from(klass)
+ klass.module_execdo
+ undefextra_params=ifklass.method_defined?(:extra_params=)
+ undefextra_paramsifklass.method_defined?(:extra_params)
+ end
+end
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/source/documentation/7.0/rspec-rails/_index.html b/source/documentation/7.0/rspec-rails/_index.html
new file mode 100644
index 000000000..6e7f0284a
--- /dev/null
+++ b/source/documentation/7.0/rspec-rails/_index.html
@@ -0,0 +1,321 @@
+
+
+
+
+
+
+ Documentation by YARD 0.9.36
+
+
+
+
+
+
+
+
+
+
rspec-rails supports integration with Capybara out of the box by adding
+its Capybara::DSL (visit/page) and Capybara::RSpecMatchers to the
+examples in the applicable directories.
+
Capybara::DSL
+
Adds the visit and page methods, which work together to simulate a
+GET request and provide access to the result (via page).
+
Capybara::DSL is added to examples in:
+
+
spec/features
+
+
Capybara::RSpecMatchers
+
Exposes matchers used to specify expected HTML content (e.g. should_not have_selector will work correctly).
Reset ActiveSupport::CurrentAttributes between examples. (Javier Julio, #2752)
+
Fix a broken link in generated mailer previews. (Chiara Núñez, #2764)
+
Fix have_status_code behaviour with deprecated status names by delegating
+to Rack::Utils.status_code/1 to set the expected status code. (Darren Boyd, #2765)
Minor tweak to generated rails_helper.rb to use Rails.root.join.
+(@masato-bkn, Ryo Nakamura, #2640, #2678)
+
Add RSpec::Rails::Configuration.fixture_paths configuration to support
+the matching change to ActiveRecord::TestFixtures, previous singular
+form is deprecated and will be removed in Rails 7.2. (Juan Gueçaimburu, #2673)
+
Add send_email matcher to match emails rather than specific jobs.
+(Andrei Kaleshka, #2670)
+
When using render in view specs, :locals will now be merged into the
+default implicit template, allowing render locals: {...} style calls.
+(Jon Rowe, #2686)
+
Add support for Rails.config.action_mailer.preview_paths on Rails 7.1/
+(Jon Rowe, #2706)
Fix ActionView::PathSet when render_views is off for Rails 7.1.
+(Eugene Kenny, Iliana, #2631)
+
Support Rails 7.1's #fixtures_paths in example groups (removes a deprecation warning).
+(Nicholas Simmons, #2664)
+
Fix have_enqueued_job to properly detect enqueued jobs when other jobs were
+performed inside the expectation block. (Slava Kardakov, Phil Pirozhkov, #2573)
Prevent generated job specs from duplicating _job in filenames.
+(Nick Flückiger, #2496)
+
Fix ActiveRecord::TestFixture#uses_transaction by using example description
+to replace example name rather than example in our monkey patched
+run_in_transaction? method. (Stan Lo, #2495)
+
Prevent keyword arguments being lost when methods are invoked dynamically
+in controller specs. (Josh Cheek, #2509, #2514)
Default to generating request specs rather than controller specs when
+generating a controller (Luka Lüdicke, #2222)
+
Allow ActiveJob matchers #on_queue modifier to take symbolic queue names. (Nils Sommer, #2283)
+
The scaffold generator now generates request specs in preference to controller specs.
+(Luka Lüdicke, #2288)
+
Add configuration option to disable ActiveRecord. (Jon Rowe, Phil Pirozhkov, Hermann Mayer, #2266)
+
Set ActionDispatch::SystemTesting::Server.silence_puma = true when running system specs.
+(ta1kt0me, Benoit Tigeot, #2289)
+
+
Bug Fixes:
+
+
EmptyTemplateHandler.call now needs to support an additional argument in
+Rails 6. (Pavel Rosický, #2089)
+
Suppress warning from SQLite3Adapter.represent_boolean_as_integer which is
+deprecated. (Pavel Rosický, #2092)
+
ActionView::Template#formats has been deprecated and replaced by
+ActionView::Template#format(Seb Jacobs, #2100)
+
Replace before_teardown as well as after_teardown to ensure screenshots
+are generated correctly. (Jon Rowe, #2164)
+
ActionView::FixtureResolver#hash has been renamed to ActionView::FixtureResolver#data.
+(Penelope Phippen, #2076)
+
Prevent driven_by(:selenium) being called due to hook precedence.
+(Takumi Shotoku, #2188)
+
Prevent a WrongScopeError being thrown during loading fixtures on Rails
+6.1 development version. (Edouard Chin, #2215)
+
Fix Mocha mocking support with should. (Phil Pirozhkov, #2256)
+
Restore previous conditional check for setting default_url_options in feature
+specs, prevents a NoMethodError in some scenarios. (Eugene Kenny, #2277)
+
Allow changing ActiveJob::Base.queue_adapter inside a system spec.
+(Jonathan Rochkind, #2242)
+
rails generate generator command now creates related spec file (Joel Azemar, #2217)
+
Relax upper capybara version constraint to allow for Capybara 3.x (Phil Pirozhkov, #2281)
+
Clear ActionMailer test mailbox after each example (Benoit Tigeot, #2293)
Use __dir__ instead of __FILE__ in generated rails_helper.rb where
+supported. (OKURA Masafumi, #2048)
+
Add have_enqueued_mail matcher as a "super" matcher to the ActiveJob matchers
+making it easier to match on ActiveJob delivered emails. (Joel Lubrano, #2047)
+
Add generator for system specs on Rails 5.1 and above. (Andrzej Sliwa, #1933)
+
Add generator for generator specs. (@ConSou, #2085)
+
Add option to generate routes when generating controller specs. (David Revelo, #2134)
+
+
Bug Fixes:
+
+
Make the ActiveJob matchers fail when multiple jobs are queued for negated
+matches. e.g. expect { job; job; }.to_not have_enqueued_job.
+(Emric Istanful, #2069)
Fix issue with generator for preview specs where Mailer would be duplicated
+in the name. (Kohei Sugi, #2037)
+
Fix the request spec generator to handle namespaced files. (Kohei Sugi, #2057)
+
Further truncate system test filenames to handle cases when extra words are
+prepended. (Takumi Kaji, #2058)
+
Backport: Make the ActiveJob matchers fail when multiple jobs are queued
+for negated matches. e.g. `expect { job; job; }.to_not have_enqueued_job
+(Emric Istanful, #2069)
Change generated Rails helper to match Rails standards for Rails.root
+(Alessandro Rodi, #1960)
+
At support for asserting enqueued jobs have no wait period attached.
+(Brad Charna, #1977)
+
Cache instances of ActionView::Template used in stub_template resulting
+in increased performance due to less allocations and setup. (Simon Coffey, #1979)
Only attempt to load ActionDispatch::IntegrationTest::Behavior on Rails 5,
+and above; Prevents possible TypeError when an existing Behaviour class
+is defined. (#1660, Betesh).
Add support for block when using with on have_enqueued_job. (John Schroeder, #1578)
+
Add support for file_fixture(...). (Wojciech Wnętrzak, #1587)
+
Add support for setup and teardown with blocks (Miklós Fazekas, #1598)
+
Add enqueue_job alias for have_enqueued_job, support once/twice/
+thrice, add have_been_enqueued matcher to support use without blocks.
+(Sergey Alexandrovich, #1613)
+
+
Bug fixes:
+
+
Prevent asset helpers from taking precedence over route helpers. (Prem Sichanugrist, #1496)
+
Prevent NoMethodError during failed have_rendered assertions on weird templates.
+(Jon Rowe, #1623).
Include ActionDispatch::IntegrationTest::Behavior in request spec
+example groups when on Rails 5, allowing integration test helpers
+to be used in request specs. (Scott Bronson, #1560)
+
+
Bug fixes:
+
+
Make it possible to use floats in auto generated (scaffold) tests.
+(Alwahsh, #1550)
Improved the failure message for have_rendered matcher on a redirect
+response. (Alex Egan, #1440)
+
Add configuration option to filter out Rails gems from backtraces.
+(Bradley Schaefer, #1458)
+
Enable resolver cache for view specs for a large speed improvement
+(Chris Zetter, #1452)
+
Add have_enqueued_job matcher for checking if a block has queued jobs.
+(Wojciech Wnętrzak, #1464)
+
+
Bug Fixes:
+
+
Fix another load order issued which causes an undefined method fixture_path error
+when loading rspec-rails after a spec has been created. (Nikki Murray, #1430)
+
Removed incorrect surrounding whitespace in the rspec-rails backtrace
+exclusion pattern for its own lib code. (Jam Black, #1439)
Fix regression that caused stubbing abstract ActiveRecord model
+classes to trigger internal errors in rails due the the verifying
+double lifecycle wrongly calling define_attribute_methods on the
+abstract AR class. (Jon Rowe, #1396)
Add support for PATCH to route specs created via scaffold. (Igor Zubkov, #1336)
+
Improve controller and routing spec calls to routes by using yield
+instead of call. (Anton Davydov, #1308)
+
Add support for ActiveJob specs as standard RSpec::Rails::RailsExampleGroups
+via both type: :job and inferring type from spec directory spec/jobs.
+(Gabe Martin-Dempesy, #1361)
+
Include RSpec::Rails::FixtureSupport into example groups using metadata
+use_fixtures: true. (Aaron Kromer, #1372)
+
Include rspec:request generator for generating request specs; this is an
+alias of rspec:integration (Aaron Kromer, #1378)
+
Update rails_helper generator with a default check to abort the spec run
+when the Rails environment is production. (Aaron Kromer, #1383)
Fix auto-including of generic Helper object for view specs sitting in the
+app/views root (David Daniell, #1289)
+
Remove pre-loading of ActionMailer in the Railtie (Aaron Kromer, #1327)
+
Fix undefined method need_auto_run= error when using Ruby 2.1 and Rails 3.2
+without the test-unit gem (Orien Madgwick, #1350)
+
Fix load order issued which causes an undefined method fixture_path error
+when loading rspec-rails after a spec has been created. (Aaron Kromer, #1372)
Separate RSpec configuration in generated spec_helper from Rails setup
+and associated configuration options. Moving Rails specific settings and
+options to rails_helper. (Aaron Kromer)
+
+
Bug Fixes:
+
+
Fix an issue with fixture support when ActiveRecord isn't loaded. (Jon Rowe)
Extracts the mock_model and stub_model methods to the
+rspec-activemodel-mocks gem. (Thomas Holmes)
+
Spec types are no longer inferred by location, they instead need to be
+explicitly tagged. The old behaviour is enabled by
+config.infer_spec_type_from_file_location!, which is still supplied
+in the default generated spec_helper.rb. (Xavier Shay, Myron Marston)
+
controller macro in controller specs no longer mutates
+:described_class metadata. It still overrides the subject and sets
+the controller, though. (Myron Marston)
+
Stop depending on or requiring rspec-collection_matchers. Users who
+want those matchers should add the gem to their Gemfile and require it
+themselves. (Myron Marston)
+
Removes runtime dependency on ActiveModel. (Rodrigo Rosenfeld Rosas)
+
+
Enhancements:
+
+
Supports Rails 4.x reference attribute ids in generated scaffold for view
+specs. (Giovanni Cappellotto)
+
Add have_http_status matcher. (Aaron Kromer)
+
Add spec type metadata to generator templates. (Aaron Kromer)
+
+
Bug Fixes:
+
+
Fix an inconsistency in the generated scaffold specs for a controller. (Andy Waite)
+
Ensure config.before(:all, type: <type>) hooks run before groups
+of the given type, even when the type is inferred by the file
+location. (Jon Rowe, Myron Marston)
+
Switch to parsing params with Rack::Utils::parse_nested_query to match Rails.
+(Tim Watson)
+
Fix incorrect namespacing of anonymous controller routes. (Aaron Kromer)
Removes the --webrat option for the request spec generator (Andy Lindeman)
+
Methods from Capybara::DSL (e.g., visit) are no longer available in
+controller specs. It is more appropriate to use capybara in feature specs
+(spec/features) instead. (Andy Lindeman)
+
infer_base_class_for_anonymous_controllers is
+enabled by default. (Thomas Holmes)
+
Capybara 2.2.0 or above is required for feature specs. (Andy Lindeman)
+
+
Enhancements:
+
+
Improve be_valid matcher for non-ActiveModel::Errors implementations (Ben Hamill)
+
+
Bug Fixes:
+
+
Use __send__ rather than send to prevent naming collisions (Bradley Schaefer)
+
Supports Rails 4.1. (Andy Lindeman)
+
Routes are drawn correctly for anonymous controllers with abstract
+parents. (Billy Chan)
+
Loads ActiveSupport properly to support changes in Rails 4.1. (Andy Lindeman)
+
Anonymous controllers inherit from ActionController::Base if ApplicationController
+is not present. (Jon Rowe)
+
Require rspec/collection_matchers when rspec/rails is required. (Yuji Nakayama)
Deprecates stub_model and mock_model in favor of the
+rspec-activemodel-mocks gem. (Thomas Holmes)
+
Issue a deprecation to instruct users to configure
+config.infer_spec_type_from_file_location! during the
+upgrade process since spec type inference is opt-in in 3.0.
+(Jon Rowe)
+
Issue a deprecation when described_class is accessed in a controller
+example group that has used the controller { } macro to generate an
+anonymous controller class, since in 2.x, described_class would
+return that generated class but in 3.0 it will continue returning the
+class passed to describe. (Myron Marston)
Deprecates the --webrat option to the scaffold and request spec generator (Andy Lindeman)
+
Deprecates the use of Capybara::DSL (e.g., visit) in controller specs.
+It is more appropriate to use capybara in feature specs (spec/features)
+instead. (Andy Lindeman)
+
+
Bug Fixes:
+
+
Use __send__ rather than send to prevent naming collisions (Bradley Schaefer)
+
Supports Rails 4.1. (Andy Lindeman)
+
Loads ActiveSupport properly to support changes in Rails 4.1. (Andy Lindeman)
+
Anonymous controllers inherit from ActionController::Base if ApplicationController
+is not present. (Jon Rowe)
Deprecates autotest integration in favor of the rspec-autotest gem. (Andy
+Lindeman)
+
+
Enhancements:
+
+
Supports Rails 4.1 and Minitest 5. (Patrick Van Stee)
+
+
Bug Fixes:
+
+
Fixes "warning: instance variable @orig_routes not initialized" raised by
+controller specs when --warnings are enabled. (Andy Lindeman)
+
Where possible, check against the version of ActiveRecord, rather than
+Rails. It is possible to use some of rspec-rails without all of Rails.
+(Darryl Pogue)
+
Explicitly depends on activemodel. This allows libraries that do not bring
+in all of rails to use rspec-rails. (John Firebaugh)
Fixes "warning: instance variable @orig_routes not initialized" raised by
+controller specs when --warnings are enabled. (Andy Lindeman)
+
Where possible, check against the version of ActiveRecord, rather than
+Rails. It is possible to use some of rspec-rails without all of Rails.
+(Darryl Pogue)
+
Supports Rails 4.1 and Minitest 5. (Patrick Van Stee, Andy Lindeman)
+
Explicitly depends on activemodel. This allows libraries that do not bring
+in all of rails to use rspec-rails. (John Firebaugh)
+
Use __send__ rather than send to prevent naming collisions (Bradley Schaefer)
let definitions may override methods defined in modules brought in via
+config.include in controller specs. Fixes regression introduced in 2.13.
+(Andy Lindeman, Jon Rowe)
+
Code that checks Rails version numbers is more robust in cases where Rails is
+not fully loaded. (Andy Lindeman)
+
+
Enhancements
+
+
Document how the spec/support directory works. (Sam Phippen)
Reverts earlier fix where anonymous controllers defined the _routes method
+to support testing of redirection and generation of URLs from other contexts.
+The implementation ended up breaking the ability to refer to non-anonymous
+routes in the context of the controller under test.
+
Uses assert_select correctly in view specs generated by scaffolding. (Andy
+Lindeman)
The generated spec/spec_helper.rb sets config.order = "random" so that
+specs run in random order by default.
+
rename render_template to have_rendered (and alias to render_template
+for backward compatibility)
+
The controller spec generated with rails generate scaffold namespaced::model
+matches the spec generated with rails generate scaffold namespaced/model
+(Kohei Hasegawa)
+
+
Bug fixes
+
+
"uninitialized constant" errors are avoided when using using gems like
+rspec-rails-uncommitted that define Rspec::Rails before rspec-rails
+loads (Andy Lindeman)
NOTE: there was a change in rails-3.2.0.rc2 which broke compatibility with
+stub_model in rspec-rails. This release fixes that issue, but it means that
+you'll have to upgrade to rspec-rails-2.8.1 when you upgrade to rails >=
+3.2.0.rc2.
+
+
Bug fixes
+
+
Explicitly stub valid? in stub_model. Fixes stub_model for rails versions
+>= 3.2.0.rc2.
ActiveRecord::Relation can use the =~ matcher (Andy Lindeman)
+
Make generated controller spec more consistent with regard to ids
+(Brent J. Nordquist)
+
Less restrictive autotest mapping between spec and implementation files
+(José Valim)
+
require 'rspec/autorun' from generated spec_helper.rb (David Chelimsky)
+
add bypass_rescue (Lenny Marks)
+
route_to accepts query string (Marc Weil)
+
+
Internal
+
+
Added specs for generators using ammeter (Alex Rothenberg)
+
+
Bug fixes
+
+
Fix configuration/integration bug with rails 3.0 (fixed in 3.1) in which
+fixure_file_upload reads from ActiveSupport::TestCase.fixture_path and
+misses RSpec's configuration (David Chelimsky)
+
Support nested resource in view spec generator (David Chelimsky)
+
Define primary_key on class generated by mock_model("WithAString")
+(David Chelimsky)
include ApplicationHelper in helper object in helper specs
+
include request spec extensions in files in spec/integration
+
include controller spec extensions in groups that use type: :controller
+
same for :model, :view, :helper, :mailer, :request, :routing
+
+
Bug fixes
+
+
restore global config.render_views so you only need to say it once
+
support overriding render_views in nested groups
+
matchers that delegate to Rails' assertions capture
+ActiveSupport::TestCase::Assertion (so they work properly now with
+should_not in Ruby 1.8.7 and 1.9.1)
Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+
+
+
\ No newline at end of file
diff --git a/source/documentation/7.0/rspec-rails/file.README.html b/source/documentation/7.0/rspec-rails/file.README.html
new file mode 100644
index 000000000..2fd765749
--- /dev/null
+++ b/source/documentation/7.0/rspec-rails/file.README.html
@@ -0,0 +1,391 @@
+
+
+
+
+
+
+ File: README
+ — Documentation by YARD 0.9.36
+
+
+
+
+
+
+
+
+
+
rspec-rails brings the RSpec testing framework to Ruby on Rails
+as a drop-in alternative to its default testing framework, Minitest.
+
In RSpec, tests are not just scripts that verify your application code.
+They’re also specifications (or specs, for short):
+detailed explanations of how the application is supposed to behave,
+expressed in plain English.
IMPORTANT This README / branch refers to the 7.0.x stable release series, only bugfixes from this series will
+be added here. See the main branch on Github if you want or
+require the latest unstable features.
+
+
Add rspec-rails to both the :development and :test groups
+of your app’s Gemfile:
+
+
# Run against this stable release
+group:development,:testdo
+ gem'rspec-rails','~> 7.0.0'
+ end
+ # Or, run against the main branch
+# (requires main-branch versions of all related RSpec libraries)
+group:development,:testdo
+ %w[rspec-corerspec-expectationsrspec-mocksrspec-railsrspec-support].eachdo|lib|
+ gemlib,git:"https://github.com/rspec/#{lib}.git",branch:'main'
+ end
+ end
+
+
(Adding it to the :development group is not strictly necessary,
+ but without it, generators and rake tasks must be preceded by RAILS_ENV=test.)
+
+
Then, in your project directory:
+
+
# Download and install
+ $ bundle install
+ # Generate boilerplate configuration files
+ # (check the comments in each generated file for more information)
+ $ rails generate rspec:install
+ create .rspec
+ create spec
+ create spec/spec_helper.rb
+ create spec/rails_helper.rb
+
+
Upgrading
+
If your project is already using an older version of rspec-rails,
+upgrade to the latest version with:
+
$ bundle update rspec-rails
+
+
RSpec follows semantic versioning,
+which means that “major version” upgrades (e.g., 2.x → 3.x)
+come with breaking changes.
+If you’re upgrading from version 2.x or below,
+read the rspec-rails upgrade notes to find out what to watch out for.
# RSpec hooks into built-in generators
+$ rails generate model user
+ invoke active_record
+ create db/migrate/20181017040312_create_users.rb
+ create app/models/user.rb
+ invoke rspec
+ create spec/models/user_spec.rb
+# RSpec also provides its own spec file generators
+$ rails generate rspec:model user
+ create spec/models/user_spec.rb
+# List all RSpec generators
+$ rails generate --help | grep rspec
+
+
Running specs
+
# Default: Run all spec files (i.e., those matching spec/**/*_spec.rb)
+$ bundle exec rspec
+# Run all spec files in a single directory (recursively)
+$ bundle exec rspec spec/models
+# Run a single spec file
+$ bundle exec rspec spec/controllers/accounts_controller_spec.rb
+# Run a single example from a spec file (by line number)
+$ bundle exec rspec spec/controllers/accounts_controller_spec.rb:8
+# See all options for running specs
+$ bundle exec rspec --help
+
+
Optional: If bundle exec rspec is too verbose for you,
+you can generate a binstub at bin/rspec and use that instead:
+
$ bundle binstubs rspec-core
+
+
RSpec DSL Basics (or, how do I write a spec?)
+
In RSpec, application behavior is described
+first in (almost) plain English, then again in test code, like so:
+
RSpec.describe'Post'do#
+context'before publication'do# (almost) plain English
+it'cannot have comments'do#
+expect{Post.create.comments.create!}.toraise_error(ActiveRecord::RecordInvalid)# test code
+end
+ end
+end
+
+
Running rspec will execute this test code,
+and then use the plain-English descriptions
+to generate a report of where the application
+conforms to (or fails to meet) the spec:
+
$ rspec --format documentation spec/models/post_spec.rb
+Post
+ before publication
+ cannot have comments
+Failures:
+ 1) Post before publication cannot have comments
+ Failure/Error: expect { Post.create.comments.create! }.to raise_error(ActiveRecord::RecordInvalid)
+ expected ActiveRecord::RecordInvalid but nothing was raised
+ # ./spec/models/post.rb:4:in `block (3 levels) in <top (required)>'
+Finished in 0.00527 seconds (files took 0.29657 seconds to load)
+1 example, 1 failure
+Failed examples:
+rspec ./spec/models/post_spec.rb:3 # Post before publication cannot have comments
+
+
For an in-depth look at the RSpec DSL, including lots of examples,
+read the official Cucumber documentation for RSpec Core.
+
Helpful Rails Matchers
+
In RSpec, assertions are called expectations,
+and every expectation is built around a matcher.
+When you expect(a).to eq(b), you’re using the eq matcher.
RSpec Rails defines ten different types of specs
+for testing different parts of a typical Rails application.
+Each one inherits from one of Rails’ built-in TestCase classes,
+meaning the helper methods provided by default in Rails tests
+are available in RSpec, as well.
Follow the links above to see examples of each spec type,
+or for official Rails API documentation on the given TestCase class.
+
+
Note: This is not a checklist.
+
Ask a hundred developers how to test an application,
+and you’ll get a hundred different answers.
+
RSpec Rails provides thoughtfully selected features
+to encourage good testing practices, but there’s no “right” way to do it.
+Ultimately, it’s up to you to decide how your test suite will be composed.
+
+
When creating a spec file,
+assign it a type in the top-level describe block, like so:
+
# spec/models/user_spec.rb
+RSpec.describe User, type: :model do
+...
+
+
System specs, feature specs, request specs–what’s the difference?
+
RSpec Rails provides some end-to-end (entire application) testing capability
+to specify the interaction with the client.
+
System specs
+
Also called acceptance tests, browser tests, or end-to-end tests,
+system specs test the application from the perspective of a human client.
+The test code walks through a user’s browser interactions,
+
+
visit '/login'
+
fill_in 'Name', with: 'jdoe'
+
+
and the expectations revolve around page content.
+
+
expect(page).to have_text('Welcome')
+
+
Because system specs are a wrapper around Rails’ built-in SystemTestCase,
+they’re only available on Rails 5.1+.
+(Feature specs serve the same purpose, but without this dependency.)
+
Feature specs
+
Before Rails introduced system testing facilities,
+feature specs were the only spec type for end-to-end testing.
+While the RSpec team now officially recommends system specs instead,
+feature specs are still fully supported, look basically identical,
+and work on older versions of Rails.
+
On the other hand, feature specs require non-trivial configuration
+to get some important features working,
+like JavaScript testing or making sure each test runs with a fresh DB state.
+With system specs, this configuration is provided out-of-the-box.
+
Like system specs, feature specs require the Capybara gem.
+Rails 5.1+ includes it by default as part of system tests,
+but if you don’t have the luxury of upgrading,
+be sure to add it to the :test group of your Gemfile first:
+
group:testdo
+ gem"capybara"
+end
+
+
Request specs
+
Request specs are for testing the application
+from the perspective of a machine client.
+They begin with an HTTP request and end with the HTTP response,
+so they’re faster than feature specs,
+but do not examine your app’s UI or JavaScript.
+
Request specs provide a high-level alternative to controller specs.
+In fact, as of RSpec 3.5, both the Rails and RSpec teams
+discourage directly testing controllers
+in favor of functional tests like request specs.
+
When writing them, try to answer the question,
+“For a given HTTP request (verb + path + parameters),
+what HTTP response should the application return?”
rspec-rails brings the RSpec testing framework to Ruby on Rails
+as a drop-in alternative to its default testing framework, Minitest.
+
In RSpec, tests are not just scripts that verify your application code.
+They’re also specifications (or specs, for short):
+detailed explanations of how the application is supposed to behave,
+expressed in plain English.
IMPORTANT This README / branch refers to the 7.0.x stable release series, only bugfixes from this series will
+be added here. See the main branch on Github if you want or
+require the latest unstable features.
+
+
Add rspec-rails to both the :development and :test groups
+of your app’s Gemfile:
+
+
# Run against this stable release
+group:development,:testdo
+ gem'rspec-rails','~> 7.0.0'
+ end
+ # Or, run against the main branch
+# (requires main-branch versions of all related RSpec libraries)
+group:development,:testdo
+ %w[rspec-corerspec-expectationsrspec-mocksrspec-railsrspec-support].eachdo|lib|
+ gemlib,git:"https://github.com/rspec/#{lib}.git",branch:'main'
+ end
+ end
+
+
(Adding it to the :development group is not strictly necessary,
+ but without it, generators and rake tasks must be preceded by RAILS_ENV=test.)
+
+
Then, in your project directory:
+
+
# Download and install
+ $ bundle install
+ # Generate boilerplate configuration files
+ # (check the comments in each generated file for more information)
+ $ rails generate rspec:install
+ create .rspec
+ create spec
+ create spec/spec_helper.rb
+ create spec/rails_helper.rb
+
+
Upgrading
+
If your project is already using an older version of rspec-rails,
+upgrade to the latest version with:
+
$ bundle update rspec-rails
+
+
RSpec follows semantic versioning,
+which means that “major version” upgrades (e.g., 2.x → 3.x)
+come with breaking changes.
+If you’re upgrading from version 2.x or below,
+read the rspec-rails upgrade notes to find out what to watch out for.
# RSpec hooks into built-in generators
+$ rails generate model user
+ invoke active_record
+ create db/migrate/20181017040312_create_users.rb
+ create app/models/user.rb
+ invoke rspec
+ create spec/models/user_spec.rb
+# RSpec also provides its own spec file generators
+$ rails generate rspec:model user
+ create spec/models/user_spec.rb
+# List all RSpec generators
+$ rails generate --help | grep rspec
+
+
Running specs
+
# Default: Run all spec files (i.e., those matching spec/**/*_spec.rb)
+$ bundle exec rspec
+# Run all spec files in a single directory (recursively)
+$ bundle exec rspec spec/models
+# Run a single spec file
+$ bundle exec rspec spec/controllers/accounts_controller_spec.rb
+# Run a single example from a spec file (by line number)
+$ bundle exec rspec spec/controllers/accounts_controller_spec.rb:8
+# See all options for running specs
+$ bundle exec rspec --help
+
+
Optional: If bundle exec rspec is too verbose for you,
+you can generate a binstub at bin/rspec and use that instead:
+
$ bundle binstubs rspec-core
+
+
RSpec DSL Basics (or, how do I write a spec?)
+
In RSpec, application behavior is described
+first in (almost) plain English, then again in test code, like so:
+
RSpec.describe'Post'do#
+context'before publication'do# (almost) plain English
+it'cannot have comments'do#
+expect{Post.create.comments.create!}.toraise_error(ActiveRecord::RecordInvalid)# test code
+end
+ end
+end
+
+
Running rspec will execute this test code,
+and then use the plain-English descriptions
+to generate a report of where the application
+conforms to (or fails to meet) the spec:
+
$ rspec --format documentation spec/models/post_spec.rb
+Post
+ before publication
+ cannot have comments
+Failures:
+ 1) Post before publication cannot have comments
+ Failure/Error: expect { Post.create.comments.create! }.to raise_error(ActiveRecord::RecordInvalid)
+ expected ActiveRecord::RecordInvalid but nothing was raised
+ # ./spec/models/post.rb:4:in `block (3 levels) in <top (required)>'
+Finished in 0.00527 seconds (files took 0.29657 seconds to load)
+1 example, 1 failure
+Failed examples:
+rspec ./spec/models/post_spec.rb:3 # Post before publication cannot have comments
+
+
For an in-depth look at the RSpec DSL, including lots of examples,
+read the official Cucumber documentation for RSpec Core.
+
Helpful Rails Matchers
+
In RSpec, assertions are called expectations,
+and every expectation is built around a matcher.
+When you expect(a).to eq(b), you’re using the eq matcher.
RSpec Rails defines ten different types of specs
+for testing different parts of a typical Rails application.
+Each one inherits from one of Rails’ built-in TestCase classes,
+meaning the helper methods provided by default in Rails tests
+are available in RSpec, as well.
Follow the links above to see examples of each spec type,
+or for official Rails API documentation on the given TestCase class.
+
+
Note: This is not a checklist.
+
Ask a hundred developers how to test an application,
+and you’ll get a hundred different answers.
+
RSpec Rails provides thoughtfully selected features
+to encourage good testing practices, but there’s no “right” way to do it.
+Ultimately, it’s up to you to decide how your test suite will be composed.
+
+
When creating a spec file,
+assign it a type in the top-level describe block, like so:
+
# spec/models/user_spec.rb
+RSpec.describe User, type: :model do
+...
+
+
System specs, feature specs, request specs–what’s the difference?
+
RSpec Rails provides some end-to-end (entire application) testing capability
+to specify the interaction with the client.
+
System specs
+
Also called acceptance tests, browser tests, or end-to-end tests,
+system specs test the application from the perspective of a human client.
+The test code walks through a user’s browser interactions,
+
+
visit '/login'
+
fill_in 'Name', with: 'jdoe'
+
+
and the expectations revolve around page content.
+
+
expect(page).to have_text('Welcome')
+
+
Because system specs are a wrapper around Rails’ built-in SystemTestCase,
+they’re only available on Rails 5.1+.
+(Feature specs serve the same purpose, but without this dependency.)
+
Feature specs
+
Before Rails introduced system testing facilities,
+feature specs were the only spec type for end-to-end testing.
+While the RSpec team now officially recommends system specs instead,
+feature specs are still fully supported, look basically identical,
+and work on older versions of Rails.
+
On the other hand, feature specs require non-trivial configuration
+to get some important features working,
+like JavaScript testing or making sure each test runs with a fresh DB state.
+With system specs, this configuration is provided out-of-the-box.
+
Like system specs, feature specs require the Capybara gem.
+Rails 5.1+ includes it by default as part of system tests,
+but if you don’t have the luxury of upgrading,
+be sure to add it to the :test group of your Gemfile first:
+
group:testdo
+ gem"capybara"
+end
+
+
Request specs
+
Request specs are for testing the application
+from the perspective of a machine client.
+They begin with an HTTP request and end with the HTTP response,
+so they’re faster than feature specs,
+but do not examine your app’s UI or JavaScript.
+
Request specs provide a high-level alternative to controller specs.
+In fact, as of RSpec 3.5, both the Rails and RSpec teams
+discourage directly testing controllers
+in favor of functional tests like request specs.
+
When writing them, try to answer the question,
+“For a given HTTP request (verb + path + parameters),
+what HTTP response should the application return?”
