diff --git a/README.markdown b/README.markdown index e6d8a3d..33c1723 100644 --- a/README.markdown +++ b/README.markdown @@ -32,8 +32,6 @@ end ## Supported Databases, Libraries and Strategies -ActiveRecord, DataMapper, Sequel, MongoMapper, Mongoid, CouchPotato, Ohm and Redis are supported. - Here is an overview of the strategies supported for each ORM: Gem | ORM | Truncation | Transaction | Deletion @@ -55,6 +53,8 @@ Gem | ORM | Truncation | Transaction | Deletion Database Cleaner also includes a `null` strategy (that does no cleaning at all) which can be used with any ORM library. You can also explicitly use it by setting your strategy to `nil`. +More details on available configuration options can be found in the README for the specific adapter gem that you're using. + For support or to discuss development please use the [Google Group](http://groups.google.com/group/database_cleaner). ## What strategy is fastest? @@ -94,9 +94,6 @@ DatabaseCleaner.strategy = :truncation, {:only => %w[widgets dogs some_other_tab DatabaseCleaner.strategy = :truncation, {:except => %w[widgets]} ``` -With Ohm and Redis, `:only` and `:except` take a list of strings to be -passed to [`keys`](http://redis.io/commands/keys)). - (I should point out the truncation strategy will never truncate your schema_migrations table.) Some strategies need to be started before tests are run (for example the `:transaction` strategy needs to know to open up a transaction). This can be accomplished by calling `DatabaseCleaner.start` at the beginning of the run, or by running the tests inside a block to `DatabaseCleaner.cleaning`. So you would have: @@ -133,18 +130,6 @@ DatabaseCleaner.strategy = :transaction # then make the DatabaseCleaner.start and DatabaseCleaner.clean calls appropriately ``` -### Additional ActiveRecord options for Truncation - -The following options are available for ActiveRecord's `:truncation` strategy _only_ for MySQL and Postgres. You set them the same as the other truncation options above (e.g. `DatabaseCleaner.strategy = :truncation, {:pre_count => true}`). - -* `:pre_count` - When set to `true` this will check each table for existing rows before truncating it. This can speed up test suites when many of the tables to be truncated are never populated. Defaults to `:false`. (Also, see the section on [What strategy is fastest?](#what-strategy-is-fastest)) -* `:reset_ids` - This only matters when `:pre_count` is used, and it will make sure that a tables auto-incrementing id is reset even if there are no rows in the table (e.g. records were created in the test but also removed before DatabaseCleaner gets to it). Defaults to `true`. - -The following option is available for ActiveRecord's `:truncation` and `:deletion` strategy for any DB. - -* `:cache_tables` - When set to `true` the list of tables to truncate or delete from will only be read from the DB once, otherwise it will be read before each cleanup run. Set this to `false` if (1) you create and drop tables in your tests, or (2) you change Postgres schemas (`ActiveRecord::Base.connection.schema_search_path`) in your tests (for example, in a multitenancy setup with each tenant in a different Postgres schema). Defaults to `true`. - - ### RSpec Example ```ruby @@ -314,68 +299,6 @@ DatabaseCleaner[:active_record, { :model => ModelWithDifferentConnection }] Usage beyond that remains the same with `DatabaseCleaner.start` calling any setup on the different configured connections, and `DatabaseCleaner.clean` executing afterwards. -### Configuration options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ORMHow to accessNotes
Active Record DatabaseCleaner[:active_record] Connection specified as :symbol keys, loaded from config/database.yml. You may also pass in the ActiveRecord model under the :model key.
Data Mapper DatabaseCleaner[:data_mapper] Connection specified as :symbol keys, loaded via Datamapper repositories
Mongo Mapper DatabaseCleaner[:mongo_mapper] Multiple connections not yet supported
Mongoid DatabaseCleaner[:mongoid] Multiple databases supported for Mongoid 3. Specify DatabaseCleaner[:mongoid, {:connection => :db_name}]
Moped DatabaseCleaner[:moped] It is necessary to configure database name with DatabaseCleaner[:moped].db = db_name otherwise name `default` will be used.
Couch Potato DatabaseCleaner[:couch_potato] Multiple connections not yet supported
Sequel DatabaseCleaner[:sequel] Multiple databases supported; specify DatabaseCleaner[:sequel, {:connection => Sequel.connect(uri)}]
RedisDatabaseCleaner[:redis]Connection specified as Redis URI
OhmDatabaseCleaner[:ohm]Connection specified as Redis URI
Neo4jDatabaseCleaner[:neo4j]Database type and path(URI) DatabaseCleaner[:neo4j, connection: {type: :server_db, path: 'http://localhost:7475'}].
- ## Why? One of my motivations for writing this library was to have an easy way to turn on what Rails calls "transactional_fixtures" in my non-rails ActiveRecord projects. @@ -386,15 +309,15 @@ After copying and pasting code to do this several times I decided to package it #### DatabaseCleaner is trying to use the wrong ORM -DatabaseCleaner has an autodetect mechanism where if you do not explicitly define your ORM it will use the first ORM it can detect that is loaded. +DatabaseCleaner has a deprecated autodetect mechanism where if you do not explicitly define your ORM it will use the first ORM it can detect that is loaded. Since ActiveRecord is the most common ORM used that is the first one checked for. -Sometimes other libraries (e.g. ActiveAdmin) will load other ORMs (e.g. ActiveRecord) even though you are using a different ORM. This will result in DatabaseCleaner trying to use the wrong ORM (e.g. ActiveRecord) unless you explicitly define your ORM like so: +Sometimes other libraries (e.g. ActiveAdmin) will load other ORMs (e.g. ActiveRecord) even though you are using a different ORM. This will result in DatabaseCleaner trying to use the wrong ORM (e.g. ActiveRecord) unless you explicitly require the correct adapter gem: ```ruby -# How to setup your ORM explicitly -DatabaseCleaner[:mongoid].strategy = :truncation +# Gemfile +gem "database_cleaner-mongoid" ``` ### STDERR is being flooded when using Postgres @@ -416,23 +339,6 @@ test: min_messages: WARNING -### Nothing happens in JRuby with Sequel using transactions - -Due to an inconsistency in JRuby's implementation of Fibers, Sequel gives a different connection to `DatabaseCleaner.start` than is used for tests run between `.start` and `.clean`. This can be worked around by running your tests in a block like `DatabaseCleaner.cleaning { run_my_tests }` instead, which does not use Fibers. - -### Model fails to load with Neo4j using transactions - -When you are using [neo4j](https://github.com/neo4jrb/neo4j) gem it creates schema and reads indexes upon loading models. These operations can't be done during a transaction. You have to preload your models before DatabaseCleaner starts a transaction. - -Add to your rails_helper or spec_helper after requiring database_cleaner: - -```ruby -require 'database_cleaner-neo4j' -Dir["#{Rails.root}/app/models/**/*.rb"].each do |model| - load model -end -``` - ## Safeguards DatabaseCleaner comes with safeguards against: diff --git a/adapters/database_cleaner-couch_potato/README.md b/adapters/database_cleaner-couch_potato/README.md index 0337074..cc21537 100644 --- a/adapters/database_cleaner-couch_potato/README.md +++ b/adapters/database_cleaner-couch_potato/README.md @@ -22,7 +22,22 @@ Or install it yourself as: ## Usage -TODO: Write usage instructions here +### Configuration options + + + + + + + + + + + + + + +
ORMHow to accessNotes
Couch Potato DatabaseCleaner[:couch_potato] Multiple connections not yet supported
## Development diff --git a/adapters/database_cleaner-data_mapper/README.md b/adapters/database_cleaner-data_mapper/README.md index f25366f..e2d1c23 100644 --- a/adapters/database_cleaner-data_mapper/README.md +++ b/adapters/database_cleaner-data_mapper/README.md @@ -22,7 +22,22 @@ Or install it yourself as: ## Usage -TODO: Write usage instructions here +### Configuration options + + + + + + + + + + + + + + +
ORMHow to accessNotes
Data Mapper DatabaseCleaner[:data_mapper] Connection specified as :symbol keys, loaded via Datamapper repositories
## Development diff --git a/adapters/database_cleaner-mongo_mapper/README.md b/adapters/database_cleaner-mongo_mapper/README.md index 38ad9b7..bc91275 100644 --- a/adapters/database_cleaner-mongo_mapper/README.md +++ b/adapters/database_cleaner-mongo_mapper/README.md @@ -22,7 +22,22 @@ Or install it yourself as: ## Usage -TODO: Write usage instructions here +### Configuration options + + + + + + + + + + + + + + +
ORMHow to accessNotes
Mongo Mapper DatabaseCleaner[:mongo_mapper] Multiple connections not yet supported
## Development diff --git a/adapters/database_cleaner-mongoid/README.md b/adapters/database_cleaner-mongoid/README.md index a509bf3..b0b5b57 100644 --- a/adapters/database_cleaner-mongoid/README.md +++ b/adapters/database_cleaner-mongoid/README.md @@ -22,7 +22,22 @@ Or install it yourself as: ## Usage -TODO: Write usage instructions here +### Configuration options + + + + + + + + + + + + + + +
ORMHow to accessNotes
Mongoid DatabaseCleaner[:mongoid] Multiple databases supported for Mongoid 3. Specify DatabaseCleaner[:mongoid, {:connection => :db_name}]
## Development diff --git a/adapters/database_cleaner-moped/README.md b/adapters/database_cleaner-moped/README.md index 0b25ba8..48e0581 100644 --- a/adapters/database_cleaner-moped/README.md +++ b/adapters/database_cleaner-moped/README.md @@ -22,7 +22,22 @@ Or install it yourself as: ## Usage -TODO: Write usage instructions here +### Configuration options + + + + + + + + + + + + + + +
ORMHow to accessNotes
Moped DatabaseCleaner[:moped] It is necessary to configure database name with DatabaseCleaner[:moped].db = db_name otherwise name `default` will be used.
## Development diff --git a/adapters/database_cleaner-neo4j/README.md b/adapters/database_cleaner-neo4j/README.md index af4108a..fea8662 100644 --- a/adapters/database_cleaner-neo4j/README.md +++ b/adapters/database_cleaner-neo4j/README.md @@ -22,7 +22,39 @@ Or install it yourself as: ## Usage -TODO: Write usage instructions here +Truncation and Deletion strategies for Neo4j will just delete all nodes and relationships from the database. + +### Configuration options + + + + + + + + + + + + + + +
ORMHow to accessNotes
Neo4jDatabaseCleaner[:neo4j]Database type and path(URI) DatabaseCleaner[:neo4j, connection: {type: :server_db, path: 'http://localhost:7475'}].
+ +## Common Errors + +### Model fails to load with Neo4j using transactions + +When you are using [neo4j](https://github.com/neo4jrb/neo4j) gem it creates schema and reads indexes upon loading models. These operations can't be done during a transaction. You have to preload your models before DatabaseCleaner starts a transaction. + +Add to your rails_helper or spec_helper after requiring database_cleaner: + +```ruby +require 'database_cleaner-neo4j' +Dir["#{Rails.root}/app/models/**/*.rb"].each do |model| + load model +end +``` ## Development diff --git a/adapters/database_cleaner-ohm/README.md b/adapters/database_cleaner-ohm/README.md index a62b7c7..116aa04 100644 --- a/adapters/database_cleaner-ohm/README.md +++ b/adapters/database_cleaner-ohm/README.md @@ -22,7 +22,24 @@ Or install it yourself as: ## Usage -TODO: Write usage instructions here +### Configuration options + +`:only` and `:except` take a list of strings to be passed to [`keys`](http://redis.io/commands/keys)). + + + + + + + + + + + + + + +
ORMHow to accessNotes
OhmDatabaseCleaner[:ohm]Connection specified as Redis URI
## Development diff --git a/adapters/database_cleaner-redis/README.md b/adapters/database_cleaner-redis/README.md index fbd37f3..d326d34 100644 --- a/adapters/database_cleaner-redis/README.md +++ b/adapters/database_cleaner-redis/README.md @@ -22,7 +22,24 @@ Or install it yourself as: ## Usage -TODO: Write usage instructions here +### Configuration options + +`:only` and `:except` take a list of strings to be passed to [`keys`](http://redis.io/commands/keys)). + + + + + + + + + + + + + + +
ORMHow to accessNotes
RedisDatabaseCleaner[:redis]Connection specified as Redis URI
## Development diff --git a/adapters/database_cleaner-sequel/README.md b/adapters/database_cleaner-sequel/README.md index 33f02c0..68a6835 100644 --- a/adapters/database_cleaner-sequel/README.md +++ b/adapters/database_cleaner-sequel/README.md @@ -22,7 +22,28 @@ Or install it yourself as: ## Usage -TODO: Write usage instructions here +### Configuration options + + + + + + + + + + + + + + +
ORMHow to accessNotes
Sequel DatabaseCleaner[:sequel] Multiple databases supported; specify DatabaseCleaner[:sequel, {:connection => Sequel.connect(uri)}]
+ +## Common Errors + +### Nothing happens in JRuby with Sequel using transactions + +Due to an inconsistency in JRuby's implementation of Fibers, Sequel gives a different connection to `DatabaseCleaner.start` than is used for tests run between `.start` and `.clean`. This can be worked around by running your tests in a block like `DatabaseCleaner.cleaning { run_my_tests }` instead, which does not use Fibers. ## Development