Skip to content
This repository has been archived by the owner on Apr 20, 2024. It is now read-only.

Commit

Permalink
Retabbed README
Browse files Browse the repository at this point in the history
  • Loading branch information
BrettRToomey committed Oct 5, 2017
1 parent 0861df6 commit 2fd82c5
Showing 1 changed file with 60 additions and 60 deletions.
120 changes: 60 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ Automatically generates an initializer and an enum for MySQL enum types.
Example:
```swift
final class User: Model {
var name: String
var age: Int?
var name: String
var age: Int?
}
```

Becomes:
```swift
// sourcery: model
final class User: Model {
var name: String
var age: Int?
var name: String
var age: Int?

// sourcery:inline:auto:User.Models
let storage = Storage()
Expand Down Expand Up @@ -52,8 +52,8 @@ Generates a list of database keys, automates `prepare` and `revert` functions.
Example:
```swift
final class User: Model {
var name: String
var age: Int?
var name: String
var age: Int?
}
```

Expand All @@ -63,25 +63,25 @@ import Vapor
import Fluent

extension User: Preparation {
internal enum DatabaseKeys {
static let id = User.idKey
static let name = "name"
static let age = "age"
}

// MARK: - Preparations (User)
internal static func prepare(_ database: Database) throws {
try database.create(self) {
$0.id()
$0.string(DatabaseKeys.name)
$0.int(DatabaseKeys.age, optional: true)
}

}

internal static func revert(_ database: Database) throws {
try database.delete(self)
}
internal enum DatabaseKeys {
static let id = User.idKey
static let name = "name"
static let age = "age"
}

// MARK: - Preparations (User)
internal static func prepare(_ database: Database) throws {
try database.create(self) {
$0.id()
$0.string(DatabaseKeys.name)
$0.int(DatabaseKeys.age, optional: true)
}

}

internal static func revert(_ database: Database) throws {
try database.delete(self)
}
}

```
Expand All @@ -108,8 +108,8 @@ Automates `init (row: Row)` and `makeRow` boilerplate.
Example:
```swift
final class User: Model {
var name: String
var age: Int?
var name: String
var age: Int?
}
```

Expand All @@ -119,22 +119,22 @@ import Vapor
import Fluent

extension User: RowConvertible {
// MARK: - RowConvertible (User)
convenience internal init (row: Row) throws {
try self.init(
name: row.get(DatabaseKeys.name),
age: row.get(DatabaseKeys.age)
)
}

internal func makeRow() throws -> Row {
var row = Row()

try row.set(DatabaseKeys.name, name)
try row.set(DatabaseKeys.age, age)

return row
}
// MARK: - RowConvertible (User)
convenience internal init (row: Row) throws {
try self.init(
name: row.get(DatabaseKeys.name),
age: row.get(DatabaseKeys.age)
)
}

internal func makeRow() throws -> Row {
var row = Row()

try row.set(DatabaseKeys.name, name)
try row.set(DatabaseKeys.age, age)

return row
}
}
```

Expand All @@ -152,8 +152,8 @@ Generates a list of node keys and `makeNode(in context: Context?)`.
Example:
```swift
final class User: Model {
var name: String
var age: Int?
var name: String
var age: Int?
}
```

Expand All @@ -163,21 +163,21 @@ import Vapor
import Fluent

extension User: NodeRepresentable {
internal enum NodeKeys: String {
case name
case age
}
internal enum NodeKeys: String {
case name
case age
}

// MARK: - NodeRepresentable (User)
func makeNode(in context: Context?) throws -> Node {
var node = Node([:])
// MARK: - NodeRepresentable (User)
func makeNode(in context: Context?) throws -> Node {
var node = Node([:])

try node.set(User.idKey, id)
try node.set(NodeKeys.name.rawValue, name)
try node.set(NodeKeys.age.rawValue, age)
try node.set(User.idKey, id)
try node.set(NodeKeys.name.rawValue, name)
try node.set(NodeKeys.age.rawValue, age)

return node
}
return node
}
}
```

Expand All @@ -195,8 +195,8 @@ Generates a list of JSON keys, `init(json: JSON)` and `makeJSON`.
Example:
```swift
final class User: Model {
var name: String
var age: Int?
var name: String
var age: Int?
}
```

Expand Down Expand Up @@ -269,4 +269,4 @@ The package owner for this project is [Steffen](https://github.com/steffendsomme

## 📄 License

This package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
This package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

0 comments on commit 2fd82c5

Please sign in to comment.