README.md in mongoid-minitest-0.1.5 vs README.md in mongoid-minitest-1.0.0
- old
+ new
@@ -1,37 +1,50 @@
-# mongoid-minitest
+mongoid-minitest
+================
MiniTest matchers for Mongoid.
[](http://travis-ci.org/frodsan/mongoid-minitest)
+[](https://gemnasium.com/frodsan/mongoid-minitest)
+[](https://codeclimate.com/github/frodsan/mongoid-minitest)
-## Support
+Support
+-------
This gem supports:
-* Ruby 1.9.3, 2.0.0
-* Mongoid ~>3.0
-* MiniTest ~>4.1
+* Ruby 1.9.3, 2.0.0, ruby-head, rbx-19mode, jruby-19mode.
+* Mongoid ~>3.0, Mongoid 4.0 edge (Use mongoid/mongoid Github repository).
+* MiniTest ~>4.1.
-If you're using Mongoid 2.4.x, you should use [0.0.3.1 version](https://github.com/frodsan/mongoid-minitest/tree/274976e8814cc9bfb3f1c83eba1bed21fa3cf26b).
+**NOTE:** Version 2.0.x will remove support for Mongoid 3.x.
-## Installation
+Installation
+------------
Add this line to your application's Gemfile:
- gem 'mongoid-minitest'
+ gem 'mongoid-minitest', group: :test
And then execute:
$ bundle
Or install it yourself as:
$ gem install mongoid-minitest
-## Usage
+Usage
+-----
+Require `mongoid-minitest` in your `test_helper.rb` or
+`spec_helper.rb` file:
+
+ require 'minitest/autorun'
+ require 'mongoid'
+ require 'mongoid-minitest'
+
Matchers are available at `Mongoid::Matchers` module.
Setup matchers according to your testing preference:
### minitest/unit
@@ -67,33 +80,37 @@
describe Dummy
it { must have_field(:name) }
it { wont have_field(:none) }
end
-## Matchers
+Matchers
+--------
`Mongoid::Matchers` include the following modules:
Module Mongoid
Module Matchers
include Document
- include Validations
include Associations
+ include MiniTest::Matchers::ActiveModel
end
end
+**NOTE:** [minitest-activemodel](https://github.com/frodsan/minitest-activemodel)
+gem is a dependency of this gem.
+
### Document Matchers
describe Mongoid::Matchers::Document do
subject { Person }
it { must be_document } # if model includes Mongoid::Document
- it { must be_paranoid } # if model includes Mongoid::Paranoia
- it { must be_versioned } # if model includes Mongoid::Versioning
+ it { must be_paranoid } # if model includes Mongoid::Paranoia (Only in Mongoid <= 4.0.0)
+ it { must be_versioned } # if model includes Mongoid::Versioning (Only in Mongoid <= 4.0.0)
it { must be_timestamped } # if model includes Mongoid::Timestamps
- it { must be_stored_in(:people) } # checks the collection for model's document
+ it { must be_stored_in(:people) } # checks the collection for model's document
it { must have_field(:name) }
it { must have_field(:name).of_type(String) }
it { must have_field(:name).with_default_value("me") }
it { must have_field(:name).of_type(String).with_default_value("me") }
@@ -105,44 +122,10 @@
it { must have_index_for(:name) }
it { must have_index_for(:account_id, :email) }
end
-### Validation Matchers
-
- describe Mongoid::Matchers::Validations do
- subject { Person }
-
- it { must validate_presence_of(:name) }
-
- it { must validate_uniqueness_of(:login).case_insensitive }
- it { must validate_uniqueness_of(:login).scoped_to(:site) }
-
- it { must validate_length_of(:login).in(5..12) }
- it { must validate_length_of(:login).within(5..12) }
-
- it { must validate_length_of(:password).with_min(8) }
- it { must validate_length_of(:password).with_minimum(8) }
- it { must validate_length_of(:password).with_max(16) }
- it { must validate_length_of(:password).with_maximum(16) }
-
- it { must validate_format_of(:email).to_allow("foo@bar.com") }
- it { must validate_format_of(:email).to_not_allow("foo_bar_com") }
-
- it { must validate_inclusion_of(:role).to_allow("user", "admin") }
- it { must validate_exclusion_of(:email).to_not_allow("foo@bar.com", "fizz@buzz.com") }
-
- it { must validate_confirmation_of(:password) }
- it { must validate_acceptance_of(:terms_of_use).accept_with("1") }
-
- it { must validate_associated(:pets) }
-
- # Testing validators custom messages
- it { must validate_presence_of(:role).with_message("no role") }
- it { must validate_length_of(:password).with_min(8).with_message("len >= 8") }
- end
-
### Association Matchers
describe Mongoid::Matchers::Associations do
describe Person do
subject { Person }
@@ -166,27 +149,37 @@
it { must embedded_in(:person) }
end
end
-## Contributing
+### Validation Matchers
+Check [minitest-activemodel](https://github.com/frodsan/minitest-activemodel)
+gem for more information.
+
+Contributing
+------------
+
1. Fork it.
2. Create your feature branch (`git checkout -b my-new-feature`).
3. Commit your changes (`git commit -am 'Added some feature'`).
4. Push to the branch (`git push origin my-new-feature`).
5. Create new Pull Request.
-## Unit Tests
+Unit Tests
+----------
-To run unit tests, run `bundle exec rake`.
+To run unit tests, run `rake test`.
-## Maintainers
+Maintainers
+-----------
* Francesco Rodriguez (https://github.com/frodsan/).
* Sascha Wessel (https://github.com/gr4y).
* Godfrey Chan (https://github.com/chancancode).
+* Ryan McGeary (https://github.com/rmm5t).
-## License
+License
+-------
MIT License. Copyright 2012 Francesco Rodriguez. See [LICENSE](https://github.com/frodsan/lego/blob/master/LICENSE)
for more information.