README.rdoc in state_machine-0.8.0 vs README.rdoc in state_machine-0.8.1
- old
+ new
@@ -425,10 +425,20 @@
For example,
rake state_machine:draw:rails CLASS=Vehicle
+If you are using this library as a gem, the following must be added to the end
+of your application's Rakefile in order for the above task to work:
+
+ require 'tasks/state_machine'
+
+If you are using Rails 3.0+, you must also add the following to your
+application's Gemfile:
+
+ gem 'ruby-graphviz', :require => 'graphviz'
+
==== Merb Integration
Like Ruby on Rails, there is a special integration Rake task for generating
state machines for classes used in a Merb application. This task will load the
application environment, meaning that it's unnecessary to specify the actual
@@ -452,15 +462,25 @@
rake test
Target specific versions of integrations like so:
- rake test AR_VERSION=2.1.0 DM_VERSION=0.9.4 SEQUEL_VERSION=2.8.0
+ rake test AR_VERSION=2.0.0 DM_VERSION=0.9.4 SEQUEL_VERSION=2.8.0
+== Caveats
+
+The following caveats should be noted when using state_machine:
+
+* DataMapper: dm-validations 0.9.4 - 0.9.6 causes +after+ callbacks for
+attribute-based event transitions to fail
+* Overridden event methods won't get invoked when using attribute-based event
+transitions
+
== Dependencies
-By default, there are no dependencies. If using specific integrations, those
-dependencies are listed below.
+* Ruby 1.8.6 or later
-* ActiveRecord[http://rubyonrails.org] integration: 2.1.0 or later
+If using specific integrations:
+
+* ActiveRecord[http://rubyonrails.org] integration: 2.0.0 or later
* DataMapper[http://datamapper.org] integration: 0.9.4 or later
* Sequel[http://sequel.rubyforge.org] integration: 2.8.0 or later