README.markdown in mm-devise-1.1.10 vs README.markdown in mm-devise-1.2

- old
+ new

@@ -1,13 +1,17 @@ # MongoMapper for Devise *mm-devise* will let you use [devise](http://github.com/plataformatec/devise) with [MongoMapper](http://github.com/jnunemaker/mongomapper). -*mm-devise* is intended for use with *Rails 3* and *Devise 1.1.5* and above. It may work with earlier versions of devise. +*mm-devise* is intended for use with *Rails 3+* and *Devise 1.2* and above. It may work with earlier versions of devise. This README only covers *mm-devise* specifics. Make sure to read the [devise README](http://github.com/plataformatec/devise/blob/master/README.rdoc) +## Status update, June 2011 + +Recently upgraded to (hopefully!) support Devise > 1.2 and MongoMapper 0.9.0. + ## Usage options The gem gives you the options of 2 ORM setups depending on what library you wish to use for validations: * *mongo_mapper* - Uses MongoMapper validations @@ -23,23 +27,18 @@ ## Installation Add *devise*, *mm-devise* and *MongoMapper* gems to your Gemfile (your Rails app Gemfile). The following gems are required -<pre> gem 'mongo_mapper', '>= 0.8.2' +<pre> gem 'mongo_mapper', '>= 0.9.0' gem 'jnunemaker-validatable', '>= 1.8.4' - gem 'bson_ext', '>= 1.0.9' - gem 'devise', '>= 1.1.1' - gem 'mm-devise', '>= 1.1.8' - # gem 'rails3-generators', '>= 0.14.0' # optional</pre> + gem 'devise', '>= 1.2' + gem 'mm-devise', '>= 1.2' +</pre> -You can install [rails3-generators](http://github.com/indirect/rails3-generators) which includes a *mongo_mapper* Model generator +Use bundler to install all required gems in your Rails 3 app -<pre>gem install rails3-generators</pre> - -Alternatively use bundler to install all required gems in your Rails 3 app - <pre>bundle install</pre> Run the generator: <pre>rails generate devise:install</pre> @@ -47,10 +46,12 @@ The generator will install an initializer which describes ALL Devise's configuration options and you MUST take a look at it. Make sure to specify either <code>mongo_mapper</code> or <code>mongo_mapper_active_model</code> (ActiveModel::Validations) as the orm in the configuration file. +Note: Is this still required in recent versions of Devise > 1.2 ? + <pre>require 'devise/orm/mongo_mapper'</pre> Note: The model generator should do this automatically. To add Devise to any of your models using the generator: @@ -75,13 +76,18 @@ git clone http://github.com/plataformatec/devise.git cd mm-devise bundle install rake test</pre> -When you run <code>rake test</code>, you will (as of Aug 6, 2010) still get a few errors and failures. -This is NOT due to any errors in <code>mm-devise</code> but rather due to a few "issues" with a few of the devise tests themselves IMO. +## Gem install +<pre>$ rake install</pre> + +## Gem release (push to RubyGems) + +<pre>$ gem push pkg/mm-devis-xxxx.gem</pre> + ## 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 @@ -94,9 +100,10 @@ *Kristian Mandrup* ## Contributors +*bmarini* - Updated to support MongoMapper 0.9 (June 2011) *bhbryant* - Fixed some issues and updated gem (Jan 2011) *Jared Morgan* - Created the dm-devise gem which was used as a template for the development of this gem. Also made suggestions for a few critical fixes and improvements in the code. Thanks :) ## Bugs and Feedback