physique 0.3.10 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9472491d580ff36a2b64972a029ae7ab234170f0
-  data.tar.gz: 758027de97668f14a95fb2a528f4a66a118b4416
+  metadata.gz: 4943bcb5b2ca436e794be144a7214e73a66bd3ff
+  data.tar.gz: 39c2a517a15ce2ec2a16be7afcfca8d93e105ad3
 SHA512:
-  metadata.gz: 963c1641603597f126431a2c3a063b195328cfa44d1169b69e321c37e98de2dd8e86576cb0c30ffef18fcd6d6d887f19a91e512b3e0de1355963bd4eda14dba0
-  data.tar.gz: 065593a702d669f69a58c6fcf39fc11875cf8c47d468c4fd26f0cabfd7f6aff4438e649079b4c71b3d18c55eeda81708f880230c0a92301cbc4764bb40c68c34
+  metadata.gz: 36d294b716b6ecfbf65d08c9d0b7f29c0de7b63ddfd10f324331571db5d89186e112fb8a46882c0622a48ceae10b0e7070d395ffc2bde0761bc6581fc23c6629
+  data.tar.gz: 54f5203d65fe75db699109f8035b4da80bf49500a45825692cf44db735dbd4fa34eb2661169409a50d40ac4fab40b14cc6cfcace0b0a3b82398e8a1d0c2296b0

data/FLUENT_MIGRATOR.md

@@ -1,301 +1,301 @@
-# Using Physique with Fluent Migrator
-
-Physique paired with FluentMigrator creates a great developer workflow for managing databases as part of your build.
-
-## Prerequisites
-
-For the purposes of this guide we are making the following assumptions:
-
-* You have already configured your solution to use Physique.
-
-* You are using a SQL Server database.
-
-  NOTE: Physique currently only works with SQL Server. Support for other databases is certainly possible, but not yet implemented.
-
-* You have SQL Client Tools installed and available on your `PATH`.
-
-  Physique uses `SQLCMD.exe` to execute scripts on the command line.
-
-## Creating a FluentMigrator Project
-
-Create a new database project and add the following files and folders:
-
-    ├─ MyProject.Database
-    │  ├─ _Scripts
-    │  │   ├─ create.sql
-    │  │   ├─ drop.sql
-    │  │   └─ seed.sql
-    │  └─ Migrations
-    └─ MyProject.Database.csproj
-
-In the `create.sql` script add the following:
-
-```sql
--- Create the database
-CREATE DATABASE $(DATABASE_NAME)
-GO
-```
-
-In the `drop.sql` script add the following:
-
-```sql
--- Drop the database
-if EXISTS(select name from master.dbo.sysdatabases where name = '$(DATABASE_NAME)') begin
-    drop database $(DATABASE_NAME)
-end
-GO
-```
-
-As you can see we are not specifying the database name in the scripts.  Instead, we are using a variable that will be substituted by Physique when we run our tasks.
-
-## Configuring your Rakefile to use FluentMigrator
-
-Open your Rakefile and add the following to your solution's config:
-
-```ruby
-Physique::Solution.new do |s|
-  #...
-  s.fluently_migrate do |db|
-    db.instance = ENV['DATABASE_SERVER'] || '(local)'
-    db.name = ENV['DATABASE_NAME'] || 'MyDatabase'
-    db.project = 'src/MyProject.Database/MyProject.Database.csproj'
-    db.scripts_dir = '_Scripts'
-  end
-end
-```
-
-Here we are telling Physique:
-
-* We will be managing a database named 'MyDatabase' on the '(local)' instance.
-
-  These settings can be overridden when the DATABASE_NAME and DATABASE_INSTANCE variables are present.  This is particularly useful when incorporating Physique into your continuous integration or automated deployment process.
-
-* The path to the project file where are migrations will be implemented.
-
-* The folder within the migrations project that contains our workflow scripts.
-
-## FluentMigrator Tasks
-
-Now we can run `bundle exec rake -T` to examine the tasks Physique has created for us.  It should look something like this:
-
-```
-rake compile                             # Builds the solution
-rake compile:build                       # Builds the solution using the Bu...
-rake compile:clean                       # Builds the solution using the Cl...
-rake compile:rebuild                     # Builds the solution using the Re...
-rake db:create                           # Create the database
-rake db:drop                             # Drop the database
-rake db:migrate                          # Migrate database to the latest v...
-rake db:new_migration[name,description]  # Create a new migration file with...
-rake db:rebuild                          # Drop and recreate the database
-rake db:rollback                         # Rollback the database to the pre...
-rake db:seed                             # Seed the database with test data
-rake db:setup                            # Create the database and run all ...
-rake db:try                              # Migrate and then immediately rol...
-rake restore                             # Restores all nugets as per the p...
-rake test                                # Run unit tests
-```
-
-Look at all of our shiny database tasks!
-
-In case it wasn't obvious, all of the FluentMigrator tasks are prefixed with `db`. Here's a breakdown of what each task does.
-
-### Basic Tasks
-
-* `db:create` - Creates the database.
-* `db:drop` - Drops the database.
-* `db:seed` - Seeds the database with test data.
-
-As you might have guessed, these three tasks simply execute the SQL scripts in your project's `_Scripts` folder.  You probably won't call these directly too often but they are required by the other tasks.
-
-If you don't create these files in your project, FluentMigrator will provide a default implementation for you.  However, it's recommended that you create the scripts so that you have fine grained control over these steps.
-
-#### A Note About Seed Data
-
-The seed script is the place for you to place all of the test data you will need for local development.  It's also a great way to provide a consistent set of test data that can be used during integration testing.
-
-### Migration Tasks
-
-* `db:migrate` - Builds the migrations DLL and migrates the database to the latest version.
-* `db:rollback` - Builds the migrations DLL and rolls back the most recent migration.
-* `db:try` - A `db:migrate` followed by a `db:rollback`.  With this task, you can test a migration that you are working on, then roll it back so that you can continue to add to it.
-
-One of the more annoying things I run into when developing migrations is forgetting to build my migrations project before attempting to migrate the database.  Physique will make sure the migrations assembly is built before running it.
-
-### Build Tasks
-
-* `db:setup` - This task creates the DB, migrates it to the latest version, and executes the seed script to populate it with test data.
-* `db:rebuild` - Drops the database, then executes a `db:setup`.  This task is useful in your Continuous Integration process for testing the integrity of your migrations.
-
-### New Migration Task
-
-* `db:new_migration[name,description]` - Creates a new migration class and adds it to the migrations project. We'll talk more about this in the following section.
-
-## Developer Workflow
-
-### Starting Fresh
-
-Let's say I'm a new developer and it's my first day on the job working on an existing project.  The team I joined (in their infinite wisdom) is using Physique to manage their build process.  The first thing I want to do is checkout the source, build it, build all of the databases locally and then run all of the unit tests to make sure my local copy is configured correctly.
-
-Assuming I have ruby installed on my machine, all I need to do is run the following:
-
-```
-$ git checkout repo-url
-$ bundle install
-$ bundle exec rake test
-```
-
-Thats it!
-
-"But I didn't run any of the database tasks," you might be asking.  That's true.  And therein lies the power behind Physique's build phases.  When you configure a migrations project in Physique, the `db:rebuild` step is automatically registered as a dependency of the `test` phase of the build.  So when you run your tests, all of your databases are built too.
-
-There will be times when you will want to delete and rebuild your local databases: for example, if there were data model changes since your last pull, or if you were experimenting with some db changes on one branch, and need to switch to a different branch to work on something new.
-
-To rebuild the databases:
-
-```
-bundle exec rake db:rebuild
-```
-
-### Creating a New Migration
-
-To create a new migration inside your project, run the following:
-
-```
-rake db:new_migration[migration_name,"migration description"]
-```
-
-This will create a new FluentMigrator class and add it to the migrations project.  It will automatically add a timestamp to the filename and `MigrationAttribute` to ensure that your migrations are run in sequential order and don’t conflict with anyone else on your team.
-
-NOTE: Because this task actually edits the project file, you should make sure that all of your changes are saved to disk before running it.
-
-As you can see this task takes a few parameters.
-
-* `migration_name` - This is the name of the Migration class you want to create.
-* `migration_description` - (Optional) A description that will be stored in the VersionInfo table after the migration is applied.
-
-As a hypothetical example, let’s say we wanted to create a new migration to add a new status column to our Order table.  The command might look something like this.
-
-```
-rake db:new_migration[AddStatusToOrder, "Add a new status column to the order table"]
-```
-
-After running this task, the IDE will alert you that the project file has been modified.  Select Reload and you should see the new migration in the Migrations folder.  At this point, all that’s left to do is add your migration code to the `Up` method.
-
-### Running Your Migrations
-
-After creating a new migration, you will want to apply it to your local database.  Unsurprisingly, this is done by running:
-
-```
-bundle exec rake db:migrate
-```
-
-This will execute any migrations that have not yet been applied.
-
-If you want to rollback the last migration applied, the following command will do the trick.
-
-```
-bundle exec rake db:rollback
-```
-
-It’s common (at least for me) that while you are working on a migration, you might want to test it then continue working on it.  Physique provides a convenience task that will run a migration, then immediately roll it back so that you can continue modifying it.
-
-```
-bundle exec rake db:try
-```
-
-## Working With Multiple Databases
-
-Physique also supports solutions with multiple migrations projects.  To configure multiple databases, simply add the migrations projects to your `Rakefile`.  In this hypothetical example, I have configured two migrations projects for a client and server database.
-
-```ruby
-Physique::Solution.new do |s|
-  #...
-  s.fluently_migrate do |db|
-    db.task_alias = 'client'
-    db.instance = ENV['DATABASE_SERVER'] || '(local)'
-    db.name = ENV['DATABASE_NAME_CLIENT'] || 'MyClientDatabase'
-    db.project = 'src/MyProject.Client.Database/MyProject.Client.Database.csproj'
-    db.scripts_dir = '_Scripts'
-  end
-
-  s.fluently_migrate do |db|
-    db.task_alias = 'server'
-    db.instance = ENV['DATABASE_SERVER'] || '(local)'
-    db.name = ENV['DATABASE_NAME_SERVER'] || 'MyServerDatabase'
-    db.project = 'src/MyProject.Server.Database/MyProject.Server.Database.csproj'
-    db.scripts_dir = '_Scripts'
-  end
-end
-```
-
-A couple of things to note here:
-
-* I have specified a task alias for each migrations project.  This alias will be used when constructing your rake task names.  If no alias is provided, the database name is used.
-* I have added some additional environment variables to override the target database server from my continuous integration or deployment builds.
-
-Running `bundle exec rake -T` will now yield:
-
-```
-rake compile                                    # Builds the solution
-rake compile:build                              # Builds the solution using...
-rake compile:clean                              # Builds the solution using...
-rake compile:rebuild                            # Builds the solution using...
-rake db:client:create                           # Create the database
-rake db:client:drop                             # Drop the database
-rake db:client:migrate                          # Migrate database to the l...
-rake db:client:new_migration[name,description]  # Create a new migration fi...
-rake db:client:rebuild                          # Drop and recreate the dat...
-rake db:client:rollback                         # Rollback the database to ...
-rake db:client:seed                             # Seed the database with te...
-rake db:client:setup                            # Create the database and r...
-rake db:client:try                              # Migrate and then immediat...
-rake db:create                                  # Create all databases
-rake db:drop                                    # Drop all databases
-rake db:migrate                                 # Migrates all databases to...
-rake db:rebuild                                 # Drop and recreate all dat...
-rake db:seed                                    # Seed all databases with t...
-rake db:server:create                           # Create the database
-rake db:server:drop                             # Drop the database
-rake db:server:migrate                          # Migrate database to the l...
-rake db:server:new_migration[name,description]  # Create a new migration fi...
-rake db:server:rebuild                          # Drop and recreate the dat...
-rake db:server:rollback                         # Rollback the database to ...
-rake db:server:seed                             # Seed the database with te...
-rake db:server:setup                            # Create the database and r...
-rake db:server:try                              # Migrate and then immediat...
-rake db:setup                                   # Build all databases and m...
-rake restore                                    # Restores all nugets as pe...
-rake test                                       # Run unit tests
-```
-
-We now have tasks that operate on each database individually as well as tasks that operate on all databases at once.
-
-### Database Specific Tasks
-
-The naming convention for db specific tasks is `db:{db_alias}:{task}`.  In this example, if you wanted to rebuild just the client database, you would run the following:
-
-```
-bundle exec rake db:client:rebuild
-```
-
-Some tasks, like `rollback` and `new_migration` only make sense in the context of a specific database, so remember to add the alias to your task name when running them.
-
-```
-bundle exec rake db:client:rollback
-```
-
-### Global Tasks
-
-The following tasks operate on all databases at once.
-
-* `db:create` - Create all databases.
-* `db:drop` - Drop all databases.
-* `db:seed` - Seed all databases with test data.
-* `db:migrate` - Migrate all databases to the latest version.
-* `db:setup` - Create all databases, migrate them to the latest version and populate them with seed data.
-* `db:rebuild` - Drop and setup all databases.
-
-## Happy Migrating!
-
+# Using Physique with Fluent Migrator
+
+Physique paired with FluentMigrator creates a great developer workflow for managing databases as part of your build.
+
+## Prerequisites
+
+For the purposes of this guide we are making the following assumptions:
+
+* You have already configured your solution to use Physique.
+
+* You are using a SQL Server database.
+
+  NOTE: Physique currently only works with SQL Server. Support for other databases is certainly possible, but not yet implemented.
+
+* You have SQL Client Tools installed and available on your `PATH`.
+
+  Physique uses `SQLCMD.exe` to execute scripts on the command line.
+
+## Creating a FluentMigrator Project
+
+Create a new database project and add the following files and folders:
+
+    ├─ MyProject.Database
+    │  ├─ _Scripts
+    │  │   ├─ create.sql
+    │  │   ├─ drop.sql
+    │  │   └─ seed.sql
+    │  └─ Migrations
+    └─ MyProject.Database.csproj
+
+In the `create.sql` script add the following:
+
+```sql
+-- Create the database
+CREATE DATABASE $(DATABASE_NAME)
+GO
+```
+
+In the `drop.sql` script add the following:
+
+```sql
+-- Drop the database
+if EXISTS(select name from master.dbo.sysdatabases where name = '$(DATABASE_NAME)') begin
+    drop database $(DATABASE_NAME)
+end
+GO
+```
+
+As you can see we are not specifying the database name in the scripts.  Instead, we are using a variable that will be substituted by Physique when we run our tasks.
+
+## Configuring your Rakefile to use FluentMigrator
+
+Open your Rakefile and add the following to your solution's config:
+
+```ruby
+Physique::Solution.new do |s|
+  #...
+  s.fluently_migrate do |db|
+    db.instance = ENV['DATABASE_SERVER'] || '(local)'
+    db.name = ENV['DATABASE_NAME'] || 'MyDatabase'
+    db.project = 'src/MyProject.Database/MyProject.Database.csproj'
+    db.scripts_dir = '_Scripts'
+  end
+end
+```
+
+Here we are telling Physique:
+
+* We will be managing a database named 'MyDatabase' on the '(local)' instance.
+
+  These settings can be overridden when the DATABASE_NAME and DATABASE_INSTANCE variables are present.  This is particularly useful when incorporating Physique into your continuous integration or automated deployment process.
+
+* The path to the project file where are migrations will be implemented.
+
+* The folder within the migrations project that contains our workflow scripts.
+
+## FluentMigrator Tasks
+
+Now we can run `bundle exec rake -T` to examine the tasks Physique has created for us.  It should look something like this:
+
+```
+rake compile                             # Builds the solution
+rake compile:build                       # Builds the solution using the Bu...
+rake compile:clean                       # Builds the solution using the Cl...
+rake compile:rebuild                     # Builds the solution using the Re...
+rake db:create                           # Create the database
+rake db:drop                             # Drop the database
+rake db:migrate                          # Migrate database to the latest v...
+rake db:new_migration[name,description]  # Create a new migration file with...
+rake db:rebuild                          # Drop and recreate the database
+rake db:rollback                         # Rollback the database to the pre...
+rake db:seed                             # Seed the database with test data
+rake db:setup                            # Create the database and run all ...
+rake db:try                              # Migrate and then immediately rol...
+rake restore                             # Restores all nugets as per the p...
+rake test                                # Run unit tests
+```
+
+Look at all of our shiny database tasks!
+
+In case it wasn't obvious, all of the FluentMigrator tasks are prefixed with `db`. Here's a breakdown of what each task does.
+
+### Basic Tasks
+
+* `db:create` - Creates the database.
+* `db:drop` - Drops the database.
+* `db:seed` - Seeds the database with test data.
+
+As you might have guessed, these three tasks simply execute the SQL scripts in your project's `_Scripts` folder.  You probably won't call these directly too often but they are required by the other tasks.
+
+If you don't create these files in your project, FluentMigrator will provide a default implementation for you.  However, it's recommended that you create the scripts so that you have fine grained control over these steps.
+
+#### A Note About Seed Data
+
+The seed script is the place for you to place all of the test data you will need for local development.  It's also a great way to provide a consistent set of test data that can be used during integration testing.
+
+### Migration Tasks
+
+* `db:migrate` - Builds the migrations DLL and migrates the database to the latest version.
+* `db:rollback` - Builds the migrations DLL and rolls back the most recent migration.
+* `db:try` - A `db:migrate` followed by a `db:rollback`.  With this task, you can test a migration that you are working on, then roll it back so that you can continue to add to it.
+
+One of the more annoying things I run into when developing migrations is forgetting to build my migrations project before attempting to migrate the database.  Physique will make sure the migrations assembly is built before running it.
+
+### Build Tasks
+
+* `db:setup` - This task creates the DB, migrates it to the latest version, and executes the seed script to populate it with test data.
+* `db:rebuild` - Drops the database, then executes a `db:setup`.  This task is useful in your Continuous Integration process for testing the integrity of your migrations.
+
+### New Migration Task
+
+* `db:new_migration[name,description]` - Creates a new migration class and adds it to the migrations project. We'll talk more about this in the following section.
+
+## Developer Workflow
+
+### Starting Fresh
+
+Let's say I'm a new developer and it's my first day on the job working on an existing project.  The team I joined (in their infinite wisdom) is using Physique to manage their build process.  The first thing I want to do is checkout the source, build it, build all of the databases locally and then run all of the unit tests to make sure my local copy is configured correctly.
+
+Assuming I have ruby installed on my machine, all I need to do is run the following:
+
+```
+$ git checkout repo-url
+$ bundle install
+$ bundle exec rake test
+```
+
+Thats it!
+
+"But I didn't run any of the database tasks," you might be asking.  That's true.  And therein lies the power behind Physique's build phases.  When you configure a migrations project in Physique, the `db:rebuild` step is automatically registered as a dependency of the `test` phase of the build.  So when you run your tests, all of your databases are built too.
+
+There will be times when you will want to delete and rebuild your local databases: for example, if there were data model changes since your last pull, or if you were experimenting with some db changes on one branch, and need to switch to a different branch to work on something new.
+
+To rebuild the databases:
+
+```
+bundle exec rake db:rebuild
+```
+
+### Creating a New Migration
+
+To create a new migration inside your project, run the following:
+
+```
+rake db:new_migration[migration_name,"migration description"]
+```
+
+This will create a new FluentMigrator class and add it to the migrations project.  It will automatically add a timestamp to the filename and `MigrationAttribute` to ensure that your migrations are run in sequential order and don’t conflict with anyone else on your team.
+
+NOTE: Because this task actually edits the project file, you should make sure that all of your changes are saved to disk before running it.
+
+As you can see this task takes a few parameters.
+
+* `migration_name` - This is the name of the Migration class you want to create.
+* `migration_description` - (Optional) A description that will be stored in the VersionInfo table after the migration is applied.
+
+As a hypothetical example, let’s say we wanted to create a new migration to add a new status column to our Order table.  The command might look something like this.
+
+```
+rake db:new_migration[AddStatusToOrder, "Add a new status column to the order table"]
+```
+
+After running this task, the IDE will alert you that the project file has been modified.  Select Reload and you should see the new migration in the Migrations folder.  At this point, all that’s left to do is add your migration code to the `Up` method.
+
+### Running Your Migrations
+
+After creating a new migration, you will want to apply it to your local database.  Unsurprisingly, this is done by running:
+
+```
+bundle exec rake db:migrate
+```
+
+This will execute any migrations that have not yet been applied.
+
+If you want to rollback the last migration applied, the following command will do the trick.
+
+```
+bundle exec rake db:rollback
+```
+
+It’s common (at least for me) that while you are working on a migration, you might want to test it then continue working on it.  Physique provides a convenience task that will run a migration, then immediately roll it back so that you can continue modifying it.
+
+```
+bundle exec rake db:try
+```
+
+## Working With Multiple Databases
+
+Physique also supports solutions with multiple migrations projects.  To configure multiple databases, simply add the migrations projects to your `Rakefile`.  In this hypothetical example, I have configured two migrations projects for a client and server database.
+
+```ruby
+Physique::Solution.new do |s|
+  #...
+  s.fluently_migrate do |db|
+    db.task_alias = 'client'
+    db.instance = ENV['DATABASE_SERVER'] || '(local)'
+    db.name = ENV['DATABASE_NAME_CLIENT'] || 'MyClientDatabase'
+    db.project = 'src/MyProject.Client.Database/MyProject.Client.Database.csproj'
+    db.scripts_dir = '_Scripts'
+  end
+
+  s.fluently_migrate do |db|
+    db.task_alias = 'server'
+    db.instance = ENV['DATABASE_SERVER'] || '(local)'
+    db.name = ENV['DATABASE_NAME_SERVER'] || 'MyServerDatabase'
+    db.project = 'src/MyProject.Server.Database/MyProject.Server.Database.csproj'
+    db.scripts_dir = '_Scripts'
+  end
+end
+```
+
+A couple of things to note here:
+
+* I have specified a task alias for each migrations project.  This alias will be used when constructing your rake task names.  If no alias is provided, the database name is used.
+* I have added some additional environment variables to override the target database server from my continuous integration or deployment builds.
+
+Running `bundle exec rake -T` will now yield:
+
+```
+rake compile                                    # Builds the solution
+rake compile:build                              # Builds the solution using...
+rake compile:clean                              # Builds the solution using...
+rake compile:rebuild                            # Builds the solution using...
+rake db:client:create                           # Create the database
+rake db:client:drop                             # Drop the database
+rake db:client:migrate                          # Migrate database to the l...
+rake db:client:new_migration[name,description]  # Create a new migration fi...
+rake db:client:rebuild                          # Drop and recreate the dat...
+rake db:client:rollback                         # Rollback the database to ...
+rake db:client:seed                             # Seed the database with te...
+rake db:client:setup                            # Create the database and r...
+rake db:client:try                              # Migrate and then immediat...
+rake db:create                                  # Create all databases
+rake db:drop                                    # Drop all databases
+rake db:migrate                                 # Migrates all databases to...
+rake db:rebuild                                 # Drop and recreate all dat...
+rake db:seed                                    # Seed all databases with t...
+rake db:server:create                           # Create the database
+rake db:server:drop                             # Drop the database
+rake db:server:migrate                          # Migrate database to the l...
+rake db:server:new_migration[name,description]  # Create a new migration fi...
+rake db:server:rebuild                          # Drop and recreate the dat...
+rake db:server:rollback                         # Rollback the database to ...
+rake db:server:seed                             # Seed the database with te...
+rake db:server:setup                            # Create the database and r...
+rake db:server:try                              # Migrate and then immediat...
+rake db:setup                                   # Build all databases and m...
+rake restore                                    # Restores all nugets as pe...
+rake test                                       # Run unit tests
+```
+
+We now have tasks that operate on each database individually as well as tasks that operate on all databases at once.
+
+### Database Specific Tasks
+
+The naming convention for db specific tasks is `db:{db_alias}:{task}`.  In this example, if you wanted to rebuild just the client database, you would run the following:
+
+```
+bundle exec rake db:client:rebuild
+```
+
+Some tasks, like `rollback` and `new_migration` only make sense in the context of a specific database, so remember to add the alias to your task name when running them.
+
+```
+bundle exec rake db:client:rollback
+```
+
+### Global Tasks
+
+The following tasks operate on all databases at once.
+
+* `db:create` - Create all databases.
+* `db:drop` - Drop all databases.
+* `db:seed` - Seed all databases with test data.
+* `db:migrate` - Migrate all databases to the latest version.
+* `db:setup` - Create all databases, migrate them to the latest version and populate them with seed data.
+* `db:rebuild` - Drop and setup all databases.
+
+## Happy Migrating!
+
 At this point you should be a Physique migration pro!  Feel free to contact me [@scardetto](https://twitter.com/scardetto) if you have any questions.