README.md in riot-mongoid-2.0.0.beta.2 vs README.md in riot-mongoid-2.1.0
- old
+ new
@@ -2,56 +2,59 @@
Riot assertions for Mongoid
## Examples
- context "Photo Model" do
+```ruby
+context "Photo Model" do
- context 'definition' do
- setup { Photo.new }
-
- # field associations
- asserts_topic.has_field :title, :type => String
- asserts_topic.has_field :caption, :type => String, :default => ""
+ context 'definition' do
+ setup { Photo }
- # association assertions
- asserts_topic.has_association :belongs_to_related, :account
- asserts_topic.has_association :has_many_related, :comments
- asserts_topic.has_association :embedded_in, :person, :inverse_of => :address
-
- # validation assertions
- asserts_topic.has_validation :validates_presence_of, :caption
-
- # key assertions
- asserts_topic.has_key :title, :caption
- end
- end
-
+ # field associations
+ asserts_topic.has_field :title, :type => String
+ asserts_topic.has_field :caption, :type => String, :default => ""
-## Mongoid 1.9.1/ Mongoid2.0.0beta+
+ # association assertions
+ asserts_topic.has_association :referenced_in, :account
+ asserts_topic.has_association :references_many, :comments
+ asserts_topic.has_association :embedded_in, :customer, :class_name => "Person"
-To use riot-mongoid with Mongoid 1.9.1 do:
+ # validation assertions
+ asserts_topic.has_validation :validates_presence_of, :caption
- gem install riot-mongoid
-
-or check out the [legacy branch](http://github.com/thumblemonks/riot-mongoid/tree/legacy)
-
-To use riot-mongoid with Mongoid 2.0.0.beta+ do:
+ # support for custom validators, see the tests for a complete example
+ validates :states, :inclusion_of_set => { :in => [1, 2, 3] }
- gem install riot-mongoid --pre
+ # key assertions
+ asserts_topic.has_key :title, :caption
+ end
+end
+```
-or check out the [master branch](http://github.com/thumblemonks/riot-mongoid)
+## Mongoid 1.9.1
+To use riot-mongoid with Mongoid 1.9.1 check out the [legacy branch](http://github.com/thumblemonks/riot-mongoid/tree/legacy)
+
+## Mongoid 2.1.x
+
+To use riot-mongoid with Mongoid 2.1.x do:
+
+ gem install riot-mongoid
+
+or check out the [master branch](http://github.com/thumblemonks/riot-mongoid/tree/beta20)
+
+
## Note on Patches/Pull Requests
-
+
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
## Copyright
-Copyright (c) 2010 gabrielg. See LICENSE for details.
+Copyright (c) 2011 gabrielg. See LICENSE for details.