README.md in mongoid-locker-0.2.1 vs README.md in mongoid-locker-0.3.0
- old
+ new
@@ -1,10 +1,10 @@
-# mongoid-locker [](http://travis-ci.org/afeld/mongoid-locker)
+# mongoid-locker [](http://travis-ci.org/afeld/mongoid-locker) [](https://codeclimate.com/github/afeld/mongoid-locker)
Document-level locking for MongoDB via Mongoid. The need arose at [Jux](https://jux.com) from multiple processes on multiple servers trying to act upon the same document and stepping on each other's toes. Mongoid-Locker is an easy way to ensure only one process can perform a certain operation on a document at a time.
-[Tested](http://travis-ci.org/afeld/mongoid-locker) against MRI 1.8.7, 1.9.2 and 1.9.3, Rubinius 1.8 and 1.9, and JRuby 1.8 and 1.9 with Mongoid 2 and 3 ([where supported](http://travis-ci.org/#!/afeld/mongoid-locker)).
+[Tested](http://travis-ci.org/afeld/mongoid-locker) against MRI 1.9.3, 2.0.0 and 2.1.2, Rubinius 2.x, and JRuby 1.9 with Mongoid 2, 3 and 4 ([where supported](http://travis-ci.org/#!/afeld/mongoid-locker)).
## Usage
Add to your `Gemfile`:
@@ -33,15 +33,12 @@
queue_item.completed_at = Time.now
queue_item.save!
end
```
-`#with_lock` takes a couple options as a hash:
+`#with_lock` takes an optional [handful of options around retrying](http://rdoc.info/github/afeld/mongoid-locker/Mongoid/Locker:with_lock), so make sure to take a look.
-* `timeout`: The amount of time until a lock expires, in seconds. Defaults to `5`.
-* `wait`: If a lock exists on the document, wait until that lock expires and try again. Defaults to `false`.
-
The default timeout can also be set on a per-class basis:
```ruby
class QueueItem
# ...
@@ -50,17 +47,5 @@
```
Note that these locks are only enforced when using `#with_lock`, not at the database level. It is useful for transactional operations, where you can make atomic modification of the document with checks. For exmple, you could deduct a purchase from a user's balance... _unless_ they are broke.
More in-depth method documentation can be found at [rdoc.info](http://rdoc.info/github/afeld/mongoid-locker/frames). Enjoy!
-
-## Contributing
-
-Pull requests are welcome. To run tests:
-
- $ bundle install
- $ rake
-
-To auto-run tests as you code:
-
- $ bundle install
- $ guard