schema tests + docs

Package.swift

@@ -7,6 +7,9 @@ let package = Package(
         .Package(url: "https://github.com/open-swift/C7.git", majorVersion: 0, minor: 9),
 
         // Syntax for easily accessing values from generic data.
-        .Package(url: "https://github.com/qutheory/polymorphic.git", majorVersion: 0, minor: 2)
+        .Package(url: "https://github.com/qutheory/polymorphic.git", majorVersion: 0, minor: 2),
+
+        // Syntax for easily indexing arrays and dictionaries.
+        .Package(url: "https://github.com/qutheory/path-indexable.git", majorVersion: 0, minor: 2)
     ]
 )

Sources/Fluent/Preparation/Database+Preparation.swift

@@ -42,3 +42,10 @@ extension Database {
         try migration.save()
     }
 }
+
+extension Preparation {
+    public static var name: String {
+        let type = "\(self.dynamicType)"
+        return type.components(separatedBy: ".Type").first ?? type
+    }
+}

Sources/Fluent/Preparation/Model+Preparation.swift

@@ -1,6 +1,9 @@
 // MARK: Preparation
 
 extension Model {
+    /**
+        Automates the preparation of a model.
+    */
     public static func prepare(database: Database) throws {
         try database.create(entity) { builder in
             let model = self.init()
@@ -29,6 +32,9 @@ extension Model {
         }
     }
 
+    /**
+        Automates reverting the model's preparation.
+    */
     public static func revert(database: Database) throws {
         try database.delete(entity)
     }
@@ -41,6 +47,9 @@ extension Model {
         self.init(serialized: [:])
     }
 
+    /**
+        Automates the serialization of a model.
+    */
     public func serialize() -> [String: Value?] {
         var serialized: [String: Value?] = [:]
 

Sources/Fluent/Preparation/Preparation.swift

@@ -1,4 +1,20 @@
+/**
+    A preparation prepares the database for
+    any task that it may need to perform during runtime.
+*/
 public protocol Preparation {
+    /**
+        The prepare method should call any methods
+        it needs on the database to prepare.
+    */
     static func prepare(database: Database) throws
+
+    /**
+        The revert method should undo any actions
+        caused by the prepare method.
+     
+        If this is impossible, the `PreparationError.revertImpossible`
+        error should be thrown.
+    */
     static func revert(database: Database) throws
 }