| Old | New |
|---|
| .should have_been_told_to | .was told_to |
| .should have_been_asked_for_its | .was asked_for |
| .should have_been_asked_if | .was asked_if |
| .should have_been_initialized_with | .was initialized_with |
If you want to switch over, here is a shell script that should get you pretty far:
find spec -type file |
xargs ruby -p -i.old_syntax \
-e 'gsub /should(_not)?(\s+)have_been_told_to/, "was\\1\\2told_to"' \
-e 'gsub /should(_not)?(\s+)have_been_asked_(if|for)(_its)?/, "was\\1\\2asked_\\3"' \
-e 'gsub /should(_not)(\s+)have_been_initialized_with/, "was\\1\\2initialized_with"' \
Features
========
* Declarative syntax
* Support default values
* Easily override values
* RSpec matchers for asserting what happend (what was invoked, with what args, how many times)
* RSpec matchers for asserting the Mock's interface matches the real object
* Support for exceptions
* Queue return values
* Initialization information is always recorded
Usage
=====
**Endow** a class with surrogate abilities
```ruby
class Mock
Surrogate.endow self
end
```
Define a **class method** by using `define` in the block when endowing your class.
```ruby
class MockClient
Surrogate.endow self do
define(:default_url) { 'http://example.com' }
end
end
MockClient.default_url # => "http://example.com"
```
Define an **instance method** by using `define` outside the block after endowing your class.
```ruby
class MockClient
Surrogate.endow self
define(:request) { ['result1', 'result2'] }
end
MockClient.new.request # => ["result1", "result2"]
```
If you care about the **arguments**, your block can receive them.
```ruby
class MockClient
Surrogate.endow self
define(:request) { |limit| limit.times.map { |i| "result#{i.next}" } }
end
MockClient.new.request 3 # => ["result1", "result2", "result3"]
```
You don't need a **default if you set the ivar** of the same name (replace `?` with `_p` for predicates, since you can't have question marks in ivar names)
```ruby
class MockClient
Surrogate.endow self
define(:initialize) { |id| @id, @connected_p = id, true }
define :id
define :connected?
end
MockClient.new(12).id # => 12
```
**Override defaults** with `will_