Merge pull request #18 from nodes-vapor/feature/forms

Add Forms support

Author: steffendsommer

Forms/Forms.stencil

@@ -0,0 +1,50 @@
+{# One file per Form #}
+
+{% for type in types.based.Form|!protocol|annotated:"form" %}
+// sourcery:file:Forms/{{ type.localName }}/{{ type.localName }}+Form.generated.swift
+import Forms
+
+extension {{ type.localName }} {
+    {{ type.accessLevel }} var fields: [FieldType] {
+        return [
+{% for variable in type.variables where variable.typeName|hasPrefix:"FormField<" and variable|!annotated:"ignoreField" %}
+            {{ variable.name }}{% if not forloop.last %},{% endif %}
+{% endfor %}
+        ]
+    }
+}
+
+extension {{ type.localName }} {
+{% for variable in type.variables where variable.typeName|hasPrefix:"FormField<" and variable|!annotated:"ignoreField" %}
+    {{ type.accessLevel }} var {{ variable.name|replace:"Field",""}}: {{variable.typeName.name|replace:"FormField<",""|replace:">",""}}? {
+        return {{ variable.name }}.value
+    }
+{% endfor %}
+}
+
+{% if type|!annotated:"ignoreAssertValues" %}
+extension {{ type.localName }} {
+    {{ type.accessLevel }} func assertValues(errorOnNil: Error = Abort(.internalServerError)) throws -> (
+{% for variable in type.variables where variable.typeName|hasPrefix:"FormField<" and variable|!annotated:"ignoreAssertValues" and variable|!annotated:"ignoreField" %}
+        {%if not forloop.last or not forloop.first %}{{ variable.name|replace:"Field",""}}: {% endif %}{{variable.typeName.name|replace:"FormField<",""|replace:">",""}}{% if not forloop.last %},{% endif %}
+{% endfor %}
+    ) {
+        guard
+{% for variable in type.variables where variable.typeName|hasPrefix:"FormField<" and variable|!annotated:"ignoreAssertValues" and variable|!annotated:"ignoreField" %}
+            let {{ variable.name|replace:"Field",""}} = {{ variable.name|replace:"Field",""}}{% if not forloop.last %},{% endif %}
+{% endfor %}
+        else {
+            throw errorOnNil
+        }
+
+        return (
+{% for variable in type.variables where variable.typeName|hasPrefix:"FormField<" and variable|!annotated:"ignoreAssertValues" and variable|!annotated:"ignoreField" %}
+            {{ variable.name|replace:"Field",""}}{% if not forloop.last %},{% endif %}
+{% endfor %}
+        )
+    }
+}
+
+{% endif %}
+// sourcery:end
+{% endfor %}

README.md

@@ -46,12 +46,14 @@ final class User: Model {
 - [Controllers](#controllers)
   - [RouteCollection](#routecollection)
     - [Annotations](#annotations-4)
+- [Forms](#forms)
+    - [Annotations](#annotations-5)
 - [Tests](#tests)
   - [LinuxMain](#linuxmain)
-    - [Annotations](#annotations-5)
+    - [Annotations](#annotations-6)
 - [General](#general)
   - [Enums](#enums)
-    - [Annotations](#annotations-6)
+    - [Annotations](#annotations-7)
 - [Configuration](#configuration)
   - [Options](#options)
 - [Credits](#credits)
@@ -367,6 +369,73 @@ extension UserController: RouteCollection {
 | `method` | The method of the route.                 |
 | `path`   | The path for the route.                  |
 
+## Forms
+
+This template makes working with [Forms](https://github.com/nodes-vapor/forms) more convenient by annotating them with "form".
+
+| Note: Make sure to postfix your field properties with "Field" so that the generated value accessors don't conflict with the field names.
+
+Example:
+
+```swift
+// sourcery: form
+struct UserForm: Form {
+    let nameField: FormField<String>
+    let ageField: FormField<Int>
+
+    ...
+}
+```
+
+Becomes:
+
+```swift
+extension UserForm {
+    var fields: [FieldType] {
+        return [
+            nameField,
+            ageField
+        ]
+    }
+}
+
+extension UserForm {
+    var name: String? {
+        return nameField.value
+    }
+    var age: Int? {
+        return ageField.value
+    }
+}
+
+extension UserForm {
+    internal func assertValues(errorOnNil: Error = Abort(.internalServerError)) throws -> (
+        name: String,
+        age: Int
+    ) {
+        guard
+            let name = name,
+            let age = age
+        else {
+            throw errorOnNil
+        }
+
+        return (
+            name,
+            age
+        )
+    }
+}
+```
+
+### Annotations
+
+| Key | Description |
+| --- | --- |
+| `form` | Opt-in a type conforming to `Form` to use this template. |
+| `ignoreField` | Opt-out a specific field from all extensions |
+| `ignoreAssertValues` | Opt-out a specific field from being included in the `assertValues` function. |
+
 ## Tests
 These templates are related to unit testing with XCTest.