Module: RSpec::Core::Pending
- Included in:
- ExampleGroup
- Defined in:
- lib/rspec/core/pending.rb
Overview
Provides methods to mark examples as pending. These methods are available to be called from within any example or hook.
Defined Under Namespace
Classes: SkipDeclaredInExample
Instance Method Summary collapse
-
#pending(message = nil) ⇒ void
Marks an example as pending.
-
#skip(message = nil) ⇒ void
Marks an example as pending and skips execution.
Instance Method Details
#pending ⇒ void #pending(message) ⇒ void
When using pending
inside an example body using this method
hooks, such as before(:example)
, have already be run. This means that
a failure from the code in the before
hook will prevent the example
from being considered pending, as the example body would not be
executed. If you need to consider hooks as pending as well you can use
the pending metadata as an alternative, e.g.
it "does something", pending: "message"
.
Marks an example as pending. The rest of the example will still be executed, and if it passes the example will fail to indicate that the pending can be removed.
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 |
# File 'lib/rspec/core/pending.rb', line 62 def pending(=nil) current_example = RSpec.current_example if block_given? raise ArgumentError, <<-EOS.gsub(/^\s+\|/, '') |The semantics of `RSpec::Core::Pending#pending` have changed in |RSpec 3. In RSpec 2.x, it caused the example to be skipped. In |RSpec 3, the rest of the example is still run but is expected to |fail, and will be marked as a failure (rather than as pending) if |the example passes. | |Passing a block within an example is now deprecated. Marking the |example as pending provides the same behavior in RSpec 3 which was |provided only by the block in RSpec 2.x. | |Move the code in the block provided to `pending` into the rest of |the example body. | |Called from #{CallerFilter.first_non_rspec_line}. | EOS elsif current_example Pending.mark_pending! current_example, else raise "`pending` may not be used outside of examples, such as in " \ "before(:context). Maybe you want `skip`?" end end |
#skip ⇒ void #skip(message) ⇒ void
Marks an example as pending and skips execution.
110 111 112 113 114 115 116 |
# File 'lib/rspec/core/pending.rb', line 110 def skip(=nil) current_example = RSpec.current_example Pending.mark_skipped!(current_example, ) if current_example raise SkipDeclaredInExample.new() end |