Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

doc updates

  • Loading branch information...
commit d7be9de9005084f5eb6d1a86162470ae56ac6c23 1 parent 423f09a
@mperham mperham authored
Showing with 12 additions and 11 deletions.
  1. +9 −8 README.rdoc
  2. +3 −3 TESTING.rdoc
View
17 README.rdoc
@@ -21,6 +21,11 @@ then in config/environment.rb, add a config.gem entry:
...
config.gem 'data_fabric'
+or add data_fabric to your Gemfile:
+
+ gem 'data_fabric'
+
+data_fabric has been tested with Rails 2.3.10, 3.0.0 and 3.0.3.
== How does it work?
@@ -69,19 +74,17 @@ ActionController around_filter based on the user as follows:
== Warnings
* Sharded models should never be placed in the session store or you will get "Shard not set" errors when the session is persisted.
-* DataFabric does not support running with ActiveRecord's allow_concurrency = true in AR 2.0 and 2.1. allow_concurrency is gone in AR 2.2.
* DataFabric does not work in development mode with cache_classes = false. You will get an error in ActiveRecord's clear_reloadable_connections! method.
== Testing and Bug Reports
-If you think you've found a problem with data_fabric, please use the example application to reproduce the bug and send me the diff. The example application is a stock Rails 2.1 application which uses data_fabric in the expected fashion.
+If you think you've found a problem with data_fabric, please use the example23 or example30 application to reproduce the bug and send me the diff.
== Thanks to...
Rick Olsen of Rails Core:: for the Masochism plugin, which showed me how to bend AR's connection handling to my will
Bradley Taylor of RailsMachine:: for the advice to shard while at acts_as_conference
-FiveRuns:: for paying me to develop this code and allowing its release
== Author
@@ -92,11 +95,9 @@ http://twitter.com/mperham
== LICENSE:
-
-(The FiveRuns License)
-
-Copyright (c) 2008 FiveRuns Corporation
-
+
+Copyright (c) 2010 Mike Perham
+
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
View
6 TESTING.rdoc
@@ -16,9 +16,9 @@ data_fabric ships with an example application which shows an actual Rails applic
using data_fabric. You can customize config/database.yml but by default it uses a local
Sqlite3 database so there should be no customization necessary.
-Run the Rake task to prepare the application for testing. This will copy the latest data_fabric code
-to vendor/plugins, delete existing databases and migrate all the databases from scratch. You should
-then be able to run the example application's tests.
+Run the Rake task to prepare the application for testing. This will delete existing SQLite
+databases and migrate all the databases from scratch. You should then be able to run the
+example application's tests.
cd example
rake app:prepare
Please sign in to comment.
Something went wrong with that request. Please try again.