Merge pull request #16 from nodes-vapor/enum-all-cases

Allcases support for enums

Author: steffendsommer

Controllers/RouteCollection.stencil

@@ -1,30 +1,20 @@
 {# One route file per model #}
 
 {% for type in types.all|!protocol|annotated:"controller" %}
-// sourcery:file:Routes/{{ type.localName|replace:"Controller","" }}Routes/{{ type.localName|replace:"Controller","" }}Routes.generated.swift
+// sourcery:file:Routes/{{ type.localName }}/{{ type.localName }}+RouteCollection.generated.swift
 
 import Vapor
 
-final class {{ type.localName|replace:"Controller","" }}Routes: RouteCollection {
-    private let controller: {{ type.localName }}
-    private let middlewares: [Middleware]
-
-    internal init(
-        controller: {{ type.localName }},
-        middlewares: [Middleware] = []
-    ) {
-        self.controller = controller
-        self.middlewares = middlewares
-    }
-
+extension {{ type.localName }}: RouteCollection {
     func build(_ builder: RouteBuilder) throws {
-        builder.grouped("{{ type.annotations.group }}").group(middleware: middlewares) { routes in
+        builder.group("{{ type.annotations.group }}") { routes in
             {% for func in type.methods where func|annotated:"route" %}
             // {{ func.annotations.method|uppercase }} /{{ type.annotations.group }}{{ func.annotations.path }}
-            routes.{{ func.annotations.method }}("{{ func.annotations.path }}", handler: controller.{{ func.shortName }})
+            routes.{{ func.annotations.method }}("{{ func.annotations.path }}", handler: {{ func.shortName }})
             {% endfor %}
         }
     }
 }
+
 // sourcery:end
 {% endfor %}

General/Enum.stencil

@@ -0,0 +1,66 @@
+import Node
+import Vapor
+
+/// Enables an enumeration to be convertable to-and-from a Node implicitly,
+/// without having to use `Enum.case.rawValue`.
+///
+/// Example:
+/// ```
+///     enum State: String, RawStringConvertible {
+///         case pending
+///         case accepted
+///     }
+///
+///     let state: State = .pending
+///
+///     node["state"] = state
+///
+///     let stateFromNode: State = try node.extract("state")
+///
+/// ```
+public protocol RawStringConvertible: NodeConvertible {
+    init?(rawValue: String)
+    var rawValue: String { get }
+}
+
+extension RawStringConvertible  {
+    public init(node: Node) throws {
+        guard let string = node.string else {
+            throw Abort(
+                .internalServerError,
+                metadata: nil,
+                reason: "Expected a String"
+            )
+        }
+        
+        guard let state = Self.init(rawValue: string) else {
+            throw Abort(
+                .internalServerError,
+                metadata: nil,
+                reason: "Invalid case: \(string)"
+            )
+        }
+        
+        self = state
+    }
+    
+    public func makeNode(in context: Context?) throws -> Node {
+        return .string(self.rawValue)
+    }
+}
+
+// MARK: Enums
+
+{% for enum in types.enums|!annotated:"ignore" where arguments.enumOptOut or enum.annotations.enum or enum.based.RawStringConvertible %}
+
+extension {{ enum.name }} {
+    static var all: [{{ enum.name }}] = [
+        {% for case in enum.cases %}
+            .{{ case.name }},
+        {% endfor %}
+    ]
+
+    static let allRaw = {{ enum.name }}.all.map { $0.rawValue }
+}
+
+{% endfor %}

Models/JSONConvertible.stencil

@@ -16,15 +16,15 @@ import {{ var }}
 extension {{ type.localName }}: JSONConvertible {
     internal enum JSONKeys: String {
         {% for var in type.storedVariables|!annotated:"ignore"|!annotated:"ignoreJSONConvertible" %}
-        case {% if var.annotations.jsonKey %}{{ var.annotations.jsonKey }}{% else %}{{ var.name }}{% endif %}
+        static let {{ var.annotations.jsonKey|default:var.name }} = "{{ var.annotations.jsonKey|default:var.name }}"
         {% endfor %}
     }
 
     // MARK: - JSONConvertible ({{ type.name }})
     internal convenience init(json: JSON) throws {
         try self.init(
             {% for var in type.storedVariables|!annotated:"ignore"|!annotated:"ignoreJSONConvertible" %}
-            {{ var.name }}: json.get(JSONKeys.{{ var.annotations.jsonKey|default:var.name }}.rawValue){% if not forloop.last %},{% endif %}
+            {{ var.name }}: json.get(JSONKeys.{{ var.annotations.jsonKey|default:var.name }}){% if not forloop.last %},{% endif %}
             {% endfor %}
         )
     }
@@ -34,7 +34,7 @@ extension {{ type.localName }}: JSONConvertible {
 
         try json.set({{ type.name }}.idKey, id)
         {% for var in type.storedVariables|!annotated:"ignore"|!annotated:"ignoreJSONConvertible" %}
-        try json.set(JSONKeys.{{ var.annotations.jsonKey|default:var.name }}.rawValue, {{ var.annotations.jsonValue|default:var.name}})
+        try json.set(JSONKeys.{{ var.annotations.jsonKey|default:var.name }}, {{ var.annotations.jsonValue|default:var.name}})
         {% endfor %}
 
         return json

Models/Model.stencil

@@ -2,18 +2,7 @@
 
 {% for type in types.based.Model|!protocol|annotated:"model" %}
     // sourcery:inline:auto:{{ type.name }}.Models
-    let storage = Storage()
-
-    {% for var in type.storedVariables|!annotated:"ignore"|annotated:"enumName" %}
-    enum {{ var.annotations.enumName }}: {{ var.annotations.enumType }}, RawStringConvertible {
-        {% for case in var.annotations.enumCase %}
-        case {{ case }}
-        {% endfor %}
-
-        static let all = [{% for case in var.annotations.enumCase %}{{ var.annotations.enumName }}.{{ case }}{% if not forloop.last %}, {% endif %}{% endfor %}]
-        static let allDescription = {{ var.annotations.enumName }}.all.map { $0.rawValue }
-    }
-    {% endfor %}
+    internal let storage = Storage()
 
     internal init(
         {% for var in type.storedVariables|!annotated:"ignore" %}

Models/NodeRepresentable.stencil

@@ -15,8 +15,8 @@ import {{ var }}
 
 extension {{ type.localName }}: NodeRepresentable {
     internal enum NodeKeys: String {
-        {% for var in type.storedVariables|!annotated:"ignore" %}
-        case {{ var.annotations.nodeKey|default:var.name }}
+        {% for var in type.storedVariables|!annotated:"ignore"|!annotated:"ignoreNodeRepresentable" %}
+        static let {{ var.annotations.nodeKey|default:var.name }} = "{{ var.annotations.nodeKey|default:var.name }}"
         {% endfor %}
     }
 
@@ -25,8 +25,8 @@ extension {{ type.localName }}: NodeRepresentable {
         var node = Node([:])
 
         try node.set({{ type.name }}.idKey, id)
-        {% for var in type.storedVariables|!annotated:"ignore" %}
-        try node.set(NodeKeys.{{ var.annotations.nodeKey|default:var.name }}.rawValue, {{ var.annotations.nodeValue|default:var.name }})
+        {% for var in type.storedVariables|!annotated:"ignore"|!annotated:"ignoreNodeRepresentable" %}
+        try node.set(NodeKeys.{{ var.annotations.nodeKey|default:var.name }}, {{ var.annotations.nodeValue|default:var.name }})
         {% endfor %}
         {% if type.based.Timestampable %}
         try node.set({{ type.localName }}.createdAtKey, createdAt)

Models/Preparation.stencil

@@ -26,12 +26,12 @@ extension {{ type.localName }}: Preparation {
         try database.create(self) {
             $0.id()
             {% for var in type.storedVariables|!annotated:"ignore"|!annotated:"ignorePreparation" %}
-            $0.{% if var|annotated:"preparation" %}{{ var.annotations.preparation }}{% elif var|annotated:"enumName" %}enum{% else %}{{ var.typeName.description|lowercase|replace:"?","" }}{% endif %}{% if var.annotations.preparation == "foreignId" %}(for: {{ var.annotations.foreignTable }}.self, optional: {% if var.isOptional %}true{% else %}false{% endif %}, unique: {{ var.annotations.unique }}, foreignIdKey: {% if var.annotations.foreignIdKey %}"{{ var.annotations.foreignIdKey }}"{% else %}DatabaseKeys.{{ var.name }}{% if var.annotations.foreignKeyName %}, foreignKeyName: "{{ var.annotations.foreignKeyName }}"{% endif %}{% endif %}){% elif var.annotations.enumName %}(DatabaseKeys.{% if var.annotations.databaseKey %}{{ var.annotations.databaseKey }}{% else %}{{ var.name }}{% endif %}, options: {{ var.annotations.enumName }}.allDescription){% else %}(DatabaseKeys.{% if var.annotations.databaseKey %}{{ var.annotations.databaseKey }}{% else %}{{ var.name }}{% endif %}{% if var.annotations.type %}, type: "{{ var.annotations.type }}"{% endif %}{% if var.isOptional %}, optional: true{% endif %}{% if var.annotations.unique %}, unique: true{% endif %}){% endif %}
+            $0.{% if var|annotated:"preparation" %}{{ var.annotations.preparation }}{% elif var.type.based.RawStringConvertible %}enum{% else %}{{ var.typeName.description|lowercase|replace:"?","" }}{% endif %}{% if var.annotations.preparation == "foreignId" %}(for: {{ var.annotations.foreignTable }}.self, optional: {{ var.isOptional }}, unique: {{ var.annotations.unique }}, foreignIdKey: {% if var.annotations.foreignIdKey %}"{{ var.annotations.foreignIdKey }}"{% else %}DatabaseKeys.{{ var.name }}{% if var.annotations.foreignKeyName %}, foreignKeyName: "{{ var.annotations.foreignKeyName }}"{% endif %}{% endif %}){% elif var.type.based.RawStringConvertible %}(DatabaseKeys.{% if var.annotations.databaseKey %}{{ var.annotations.databaseKey }}{% else %}{{ var.name }}{% endif %}, options: {{ var.typeName }}.allRaw){% else %}(DatabaseKeys.{% if var.annotations.databaseKey %}{{ var.annotations.databaseKey }}{% else %}{{ var.name }}{% endif %}{% if var.annotations.type %}, type: "{{ var.annotations.type }}"{% endif %}{% if var.isOptional %}, optional: true{% endif %}{% if var.annotations.unique %}, unique: true{% endif %}){% endif %}
             {% endfor %}
         }
 
         {% for var in type.storedVariables|!annotated:"ignore"|!annotated:"ignorePreparation"|annotated:"index" %}
-        try database.index(DatabaseKeys.{% if var.annotations.databaseKey %}{{ var.annotations.databaseKey }}{% else %}{{ var.name }}{% endif %}, for: {{ type.name }}.self)
+        try database.index(DatabaseKeys.{{ var.annotations.databaseKey|default:var.name }}, for: {{ type.name }}.self)
         {% endfor %}
     }