Merge pull request #181 from vapor/storable

[WIP] - Storable

.travis.yml

@@ -4,7 +4,7 @@ os:
 language: generic
 sudo: required
 dist: trusty
-osx_image: xcode8
+osx_image: xcode8.3
 script:
-  - eval "$(curl -sL https://swift.vapor.sh/ci)"
+  - eval "$(curl -sL https://swift.vapor.sh/ci-3.1)"
   - eval "$(curl -sL https://swift.vapor.sh/codecov)"

Sources/Fluent/Entity/Entity.swift

@@ -1,9 +1,43 @@
+public final class Storage {
+    public init() {}
+
+    fileprivate var exists: Bool = false
+    fileprivate var id: Node? = nil
+}
+
+public protocol Storable: class {
+    /// General implementation should just be `let storage = Storage()`
+    var storage: Storage { get }
+}
+
+extension Storable {
+    /// Whether or not entity was retrieved from database.
+    ///
+    /// This value shouldn't be interacted w/ external users
+    /// w/o explicit knowledge.
+    ///
+    public internal(set) var exists: Bool {
+        get {
+            return storage.exists
+        }
+        set {
+            storage.exists = newValue
+        }
+    }
+
+    public var id: Node? {
+        get {
+            return storage.id
+        }
+        set {
+            storage.id = newValue
+        }
+    }
+}
+
 /// Represents an entity that can be
 /// stored and retrieved from the `Database`.
-public protocol Entity: Preparation, NodeConvertible {
-    // DELETE ME
-    var id: Node? { get set }
-    var exists: Bool { get set }
+public protocol Entity: class, Preparation, NodeConvertible, Storable {
 
     /// The plural relational name of this model.
     /// Used as the collection or table name.
@@ -68,8 +102,8 @@ extension Entity {
 extension Entity {
     /// Persists the entity into the
     /// data store and sets the `id` property.
-    public mutating func save() throws {
-        try Self.query().save(&self)
+    public func save() throws {
+        try Self.query().save(self)
     }
 
     /// Deletes the entity from the data
@@ -98,17 +132,15 @@ extension Entity {
     }
 }
 
-// MARK: Deprecated
+// MARK: Relatable
+
 extension Entity {
-    public var exists: Bool {
-        // TODO: Implement me
-        get { return false }
-        set { }
+    /// See Entity.idKey -- instance implementation of static var
+    public var idKey: String {
+        return type(of: self).idKey
     }
 }
 
-// MARK: Relatable
-
 extension Entity {
     /// See Entity.entity
     public static var entity: String {

Sources/Fluent/Pivot/Pivot.swift

@@ -22,10 +22,9 @@ public final class Pivot<
         return entity
     }
 
-    public var id: Node?
     public var leftId: Node
     public var rightId: Node
-    public var exists = false
+    public let storage = Storage()
 
     public init(_ left: Left, _ right: Right) throws {
         guard left.exists else {
@@ -49,15 +48,15 @@ public final class Pivot<
     }
 
     public init(node: Node, in context: Context) throws {
-        id = try node.extract(type(of: self).idKey)
-
         leftId = try node.extract(Left.foreignIdKey)
         rightId = try node.extract(Right.foreignIdKey)
+
+        id = try node.extract(idKey)
     }
 
     public func makeNode(context: Context) throws -> Node {
         return try Node(node: [
-            type(of: self).idKey: id,
+            idKey: id,
             Left.foreignIdKey: leftId,
             Right.foreignIdKey: rightId,
         ])

Sources/Fluent/Pivot/PivotProtocol.swift

@@ -39,7 +39,7 @@ extension PivotProtocol where Self: Entity {
     public static func attach(_ left: Left, _ right: Right) throws {
         _ = try assertSaved(left, right)
 
-        var pivot = try Pivot<Left, Right>(left, right)
+        let pivot = try Pivot<Left, Right>(left, right)
         try pivot.save()
     }
 

Sources/Fluent/Preparation/Database+Preparation.swift

@@ -43,7 +43,7 @@ extension Database {
 
 
         // record that this preparation has run
-        var migration = Migration(name: preparation.name)
+        let migration = Migration(name: preparation.name)
         try migration.save()
     }
 }

Sources/Fluent/Preparation/Migration.swift

@@ -1,22 +1,20 @@
 final class Migration: Entity {
     static var entity = "fluent"
-    var exists: Bool = false
-
-    var id: Node?
+    let storage = Storage()
     var name: String
 
     init(name: String) {
         self.name = name
     }
 
     init(node: Node, in context: Context) throws {
-        id = try node.extract("id")
         name = try node.extract("name")
+        id = try node.extract(idKey)
     }
 
     func makeNode(context: Context = EmptyNode) throws -> Node {
         return try Node(node: [
-            "id": id,
+            idKey: id,
             "name": name
         ])
     }

Sources/Fluent/Query/Query.swift

@@ -66,7 +66,7 @@ public final class Query<T: Entity> {
 
         for result in array {
             do {
-                var model = try T(node: result, in: _context)
+                let model = try T(node: result, in: _context)
                 if case .object(let dict) = result {
                     model.id = dict[T.idKey]
                 }

Sources/Fluent/Query/QueryRepresentable.swift

@@ -11,7 +11,7 @@ extension QueryRepresentable {
         query.action = .fetch
         query.limit = Limit(count: 1)
 
-        var model = try query.run().first
+        let model = try query.run().first
         model?.exists = true
 
         return model
@@ -25,7 +25,7 @@ extension QueryRepresentable {
 
         let models = try query.run()
         models.forEach { model in
-            var model = model
+            let model = model
             model.exists = true
         }
 
@@ -69,7 +69,7 @@ extension QueryRepresentable {
 
     /// Attempts to save a supplied entity
     /// and updates its identifier if successful.
-    public func save(_ model: inout T) throws {
+    public func save(_ model: T) throws {
         let query = try makeQuery()
 
         if let _ = model.id, model.exists {
@@ -135,7 +135,7 @@ extension QueryRepresentable {
         try query.run()
         model.didDelete()
 
-        var model = model
+        let model = model
         model.exists = false
     }
 }

Sources/FluentTester/Atom.swift

@@ -1,31 +1,30 @@
 import Fluent
 
 public final class Atom: Entity {
-    public var id: Node?
-
     public var name: String
     public var protons: Int
     public var weight: Double
 
-    public var exists: Bool = false
+    public let storage = Storage()
 
     public init(id: Node?, name: String, protons: Int, weight: Double) {
-        self.id = id
         self.name = name
         self.protons = protons
         self.weight = weight
+        self.id = id
     }
 
     public init(node: Node, in context: Context) throws {
-        id = try node.extract(type(of: self).idKey)
         name = try node.extract("name")
         protons = try node.extract("protons")
         weight = try node.extract("weight")
+
+        id = try node.extract(idKey)
     }
 
     public func makeNode(context: Context) throws -> Node {
         return try Node(node: [
-            type(of: self).idKey: id,
+            idKey: id,
             "name": name,
             "protons": protons,
             "weight": weight

Sources/FluentTester/Compound.swift

@@ -1,23 +1,22 @@
 import Fluent
 
 public final class Compound: Entity {
-    public var id: Node?
     public var name: String
-    public var exists = false
+    public let storage = Storage()
 
     public init(id: Node?, name: String) {
-        self.id = id
         self.name = name
+        self.id = id
     }
 
     public init(node: Node, in context: Context) throws {
-        id = try node.extract("id")
         name = try node.extract("name")
+        id = try node.extract(idKey)
     }
 
     public func makeNode(context: Context) throws -> Node {
         return try Node(node: [
-            "id": id,
+            idKey: id,
             "name": name
         ])
     }

Sources/FluentTester/Student.swift

@@ -1,15 +1,13 @@
 import Fluent
 
 final class Student: Entity {
-    var id: Node?
-
     var name: String
     var age: Int
     var ssn: String
     var donor: Bool
     var meta: Node
 
-    var exists = false
+    let storage = Storage()
 
     init(name: String, age: Int, ssn: String, donor: Bool, meta: Node) {
         self.name = name
@@ -20,17 +18,18 @@ final class Student: Entity {
     }
 
     init(node: Node, in context: Context) throws {
-        id = try node.extract("id")
         name = try node.extract("name")
         age = try node.extract("age")
         ssn = try node.extract("ssn")
         donor = try node.extract("donor")
         meta = try node.extract("meta")
+
+        id = try node.extract(idKey)
     }
 
     func makeNode(context: Context) throws -> Node {
         return try Node(node: [
-            "id": id,
+            idKey: id,
             "name": name,
             "age": age,
             "ssn": ssn,

Sources/FluentTester/Tester+InsertAndFind.swift

@@ -8,7 +8,7 @@ extension Tester {
         }
         Atom.database = database
 
-        var hydrogen = Atom(id: nil, name: "Hydrogen", protons: 1, weight: 1.007)
+        let hydrogen = Atom(id: nil, name: "Hydrogen", protons: 1, weight: 1.007)
 
         guard hydrogen.exists == false else {
             throw Error.failed("Exists should be false since not yet saved.")

Sources/FluentTester/Tester+PivotsAndRelations.swift

@@ -16,21 +16,21 @@ extension Tester {
         Compound.database = database
         Pivot<Atom, Compound>.database = database
 
-        var hydrogen = Atom(id: nil, name: "Hydrogen", protons: 1, weight: 1.007)
+        let hydrogen = Atom(id: nil, name: "Hydrogen", protons: 1, weight: 1.007)
         try hydrogen.save()
 
-        var carbon = Atom(id: nil, name: "Carbon", protons: 6, weight: 12.011)
+        let carbon = Atom(id: nil, name: "Carbon", protons: 6, weight: 12.011)
         try carbon.save()
 
-        var oxygen = Atom(id: nil, name: "Oxygen", protons: 8, weight: 15.999)
+        let oxygen = Atom(id: nil, name: "Oxygen", protons: 8, weight: 15.999)
         try oxygen.save()
 
-        var water = Compound(id: nil, name: "Water")
+        let water = Compound(id: nil, name: "Water")
         try water.save()
         try Pivot<Atom, Compound>.attach(hydrogen, water)
         try Pivot<Atom, Compound>.attach(oxygen, water)
 
-        var sugar = Compound(id: nil, name: "Sugar")
+        let sugar = Compound(id: nil, name: "Sugar")
         try sugar.save()
         try Pivot<Atom, Compound>.attach(hydrogen, sugar)
         try Pivot<Atom, Compound>.attach(oxygen, sugar)
@@ -72,13 +72,13 @@ extension Tester {
         Pivot<Atom, Compound>.database = database
         Pivot<Pivot<Atom, Compound>, Student>.database = database
 
-        var hydrogen = Atom(id: nil, name: "Hydrogen", protons: 1, weight: 1.007)
+        let hydrogen = Atom(id: nil, name: "Hydrogen", protons: 1, weight: 1.007)
         try hydrogen.save()
 
-        var water = Compound(id: nil, name: "Water")
+        let water = Compound(id: nil, name: "Water")
         try water.save()
 
-        var vapor = Student(
+        let vapor = Student(
             name: "Vapor",
             age: 2,
             ssn: "123",
@@ -87,10 +87,10 @@ extension Tester {
         )
         try vapor.save()
 
-        var hydrogenWater = try Pivot<Atom, Compound>(hydrogen, water)
+        let hydrogenWater = try Pivot<Atom, Compound>(hydrogen, water)
         try hydrogenWater.save()
 
-        var hwVapor = try Pivot<Pivot<Atom, Compound>, Student>(hydrogenWater, vapor)
+        let hwVapor = try Pivot<Pivot<Atom, Compound>, Student>(hydrogenWater, vapor)
         try hwVapor.save()
 
         let pivot1 = Pivot<Student, Pivot<Atom, Compound>>.self
@@ -113,7 +113,7 @@ extension Tester {
             throw Error.failed("Pivot relation failed.")
         }
 
-        var helium = Atom(id: nil, name: "Helium", protons: 2, weight: 2.007)
+        let helium = Atom(id: nil, name: "Helium", protons: 2, weight: 2.007)
         try helium.save()
 
         let result3 = try pivot1.related(

Sources/FluentTester/Tester+Schema.swift

@@ -9,7 +9,7 @@ extension Tester {
             try? Student.revert(database)
         }
 
-        var bob = Student(
+        let bob = Student(
             name: "Bob",
             age: 22,
             ssn: "382482",