Browse files

Update README

  • Loading branch information...
1 parent 31fcbe4 commit 9fb36276a7f06fbc22298587337e99f4752157e0 @trptcolin committed May 31, 2011
Showing with 16 additions and 11 deletions.
  1. +16 −11 README.md
View
27 README.md
@@ -11,6 +11,10 @@ constraint. You'll need a database-level constraint for cases like these.
consistency\_fail will find your missing unique indexes, so you can add them and
stop ignoring the C in ACID.
+Similar problems arise with `has_one`, so consistency\_fail finds places where
+database-level enforcement is lacking there as well.
+
+
## Installation
gem install consistency_fail
@@ -19,26 +23,27 @@ stop ignoring the C in ACID.
Currently only Rails 2.x is supported. Rails 3 support is coming soon.
-consistency\_fail depends on Rails making all the models available via
-
- Kernel.subclasses_of(ActiveRecord::Base)
-
-If any models are unavailable after the Rails environment boots up (e.g. due to
-being in a nonstandard load path), consistency\_fail will be unable to analyze
-them.
-
+consistency\_fail depends on being able to find all your `ActiveRecord::Base`
+subclasses with some `$LOAD_PATH` trickery. If any models are in a path either
+not on your project's load path or in a path that doesn't include the word
+"models", consistency\_fail won't be able to find or analyze them.
## Usage
-The simplest run mode is to generate a report of the problematic spots in your
-application. From your Rails project directory, run:
+The only run mode for now is to generate a report of the problematic spots in
+your application. From your Rails project directory, run:
consistency_fail
from your terminal / shell. This will spit a report to standard output, which
you can view directly, redirect to a file as evidence to embarrass a teammate,
or simply beam in happiness at your application's perfect record for
-`validates_uniqueness_of` usage.
+`validates_uniqueness_of` and `has_one` usage.
+
+## Coming Soon
+
+* Rails 3 support
+* Super-fail mode that monkey-patches explosions into your naughty models
## License

0 comments on commit 9fb3627

Please sign in to comment.