Skip to content

Commit

Permalink
Added MIT licence and an initial README.
Browse files Browse the repository at this point in the history
  • Loading branch information
lukeredpath committed Jul 26, 2010
1 parent 7b35be1 commit a2fa37f
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 0 deletions.
20 changes: 20 additions & 0 deletions License.txt
@@ -0,0 +1,20 @@
Copyright (c) 2010 Luke Redpath

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.
57 changes: 57 additions & 0 deletions README.markdown
@@ -0,0 +1,57 @@
# Mocky, an Objective-C mock object library

Mocky is an Objective-C mock object library based on the [jMock](http://jmock.org) Java library. It was built with the following goals in mind:

* An API that matches the jMock API as closely as possible
* Works out of the box with SenTestCase, allow adapters for other testing frameworks
* Support for Objective-C blocks
* Hamcrest matcher support built right in
* Sequences and state support

## A simple example

Mocky is still in the early stages of development; the best way of getting an idea of what features are supported is to take a look at the functional tests. Here's a simple example that expects a method to be called.

- (void)testCanExpectSingleMethodCallAndPass;
{
LRMockery *context = [LRMockery mockeryForSenTestCase:self];
SimpleObject *testObject = [context mock:[SimpleObject class]];

[context checking:^(LRExpectationBuilder *that){
[[that oneOf:testObject] doSomething];
}];

[testObject doSomething];
[context assertSatisfied];
}

Mocks can also be configured to return values:

[context checking:^(LRExpectationBuilder *that){
[[that oneOf:testObject] doSomething]; [that will:returnObject(someObject)];
}];

Or perform a block:

id outsideTheBlock = nil;

[context checking:^(LRExpectationBuilder *that){
[[that oneOf:testObject] doSomething]; [that will:performBlock(^(NSInvocation *invocation) {
outsideTheBlock = @"called the block"
})];
}];

[context assertSatisfied];

assertThat(outsideTheBlock, equalTo(@"called the block"));

## Credits and Licence

This library is licensed under the MIT license.

This library would not exist if it were not for jMock and all of [it's contributors](http://www.jmock.org/team.html), so thanks to them.

Also a massive thanks to Steve Freeman and Nat Pryce for their excellent book [Growing Object Oriented Software, Guided by Tests](http://www.growing-object-oriented-software.com/) which not only introduced me to jMock but is a great example of how to do TDD with mock objects well. I highly recommend you buy this book if you want to improve your TDD skills.

A version of the AuctionSniper application developed in the book that I developed using iOS/Objective-C can be found [here](http://github.com/lukeredpath/iPhoneAuctionSniper).

0 comments on commit a2fa37f

Please sign in to comment.