Merge branch 'feature/todomvc-1' into develop

Author: helje5

Package.swift

@@ -11,20 +11,21 @@ let package = Package(
   ],
 
   products: [
-    .executable(name: "httpd-helloworld",      targets: [ "httpd-helloworld" ]),
-    .executable(name: "connect-static",        targets: [ "connect-static"   ]),
-    .executable(name: "express-simple",        targets: [ "express-simple"   ]),
-    .executable(name    :   "express-simple-lambda", 
+    .executable(name: "httpd-helloworld", targets: [ "httpd-helloworld" ]),
+    .executable(name: "connect-static",   targets: [ "connect-static"   ]),
+    .executable(name: "express-simple",   targets: [ "express-simple"   ]),
+    .executable(name: "todomvc",          targets: [ "todomvc"          ]),
+    .executable(name    :   "express-simple-lambda",
                 targets : [ "express-simple-lambda" ])
   ],
 
   dependencies: [
     // A lot of packages for demonstration purposes, only add what you
     // actually need in your own project.
     .package(url: "https://github.com/Macro-swift/Macro.git",
-             from: "0.6.2"),
+             from: "0.8.7"),
     .package(url: "https://github.com/Macro-swift/MacroExpress.git",
-             from: "0.6.1"),
+             from: "0.8.4"),
     .package(url: "https://github.com/Macro-swift/MacroLambda.git",
              from: "0.2.1"),
     .package(url: "https://github.com/AlwaysRightInstitute/cows",
@@ -35,7 +36,8 @@ let package = Package(
     .target(name: "httpd-helloworld", dependencies: [ "Macro"        ]),
     .target(name: "connect-static",   dependencies: [ "MacroExpress" ]),
     .target(name: "express-simple",   dependencies: [ "MacroExpress", "cows" ]),
-    
+    .target(name: "todomvc",          dependencies: [ "MacroExpress" ]),
+
     .target(name: "express-simple-lambda",
             dependencies: [ "MacroLambda", "cows" ])
   ]

README.md

@@ -13,15 +13,18 @@ This repository contains examples for
 
 ### Running Examples as Scripts
 
-Examples can be run as scripts using [swift-sh](https://github.com/mxcl/swift-sh)
-(can be installed using a simple `brew install mxcl/made/swift-sh`).
+Single file examples can be either run as scripts using 
+[swift-sh](https://github.com/mxcl/swift-sh)
+(install using a simple `brew install mxcl/made/swift-sh`),
+from within Xcode or via `swift run`.
 
 This also contains an example for deploying to AWS Lambda:
 [express-simple-lambda](Sources/express-simple-lambda/).
 
+
 ## Examples
 
-### httpd-helloworld
+### [httpd-helloworld](Sources/httpd-helloworld)
 
 Raw HTTP server w/o Express extras (middleware, templates).
 
@@ -34,7 +37,7 @@ Single source file:
 ```swift
 #!/usr/bin/swift sh
 
-import Macro // @Macro-swift ~> 0.0.12
+import Macro // @Macro-swift
 
 http.createServer { req, res in
     // log request
@@ -60,7 +63,7 @@ http.createServer { req, res in
 }
 ```
 
-### express-simple
+### [express-simple](Sources/express-simple)
 
 ```bash
 $ Sources/express-simple/main.swift
@@ -75,8 +78,8 @@ Forms, cookies, JSON, sessions, templates and cows - you get it all!
 ```swift
 #!/usr/bin/swift sh
 
-import MacroExpress // @Macro-swift          ~> 0.0.4
-import cows         // @AlwaysRightInstitute ~> 1.0.0
+import MacroExpress // @Macro-swift
+import cows         // @AlwaysRightInstitute
 
 let app = express()
 
@@ -148,7 +151,7 @@ Looks like this:
 There is an AWS Lambda variant of this (with minor adjustments):
 [express-simple-lambda](Sources/express-simple-lambda/).
 
-### connect-simple
+### [connect-simple](Sources/connect-simple)
 
 Use the simpler `connect` module, instead of `express`. 
 Probably no need to do this in the real world, just use MacroExpress.
@@ -160,6 +163,15 @@ $ Sources/express-simple/main.swift
 2020-06-03T14:58:59+0200 notice: Server listening on http://localhost:1337
 ```
 
+### [todomvc](Sources/todomvc/)
+
+A MacroExpress implementation of a [Todo-Backend](http://todobackend.com/), 
+a simple JSON API to access and modify a list of todos.
+
+```bash
+$ swift run todomvc
+2020-06-03T14:58:59+0200 notice: Server listening on http://localhost:1337
+```
 
 
 ## Who

Sources/connect-static/README.md

@@ -1,6 +1,6 @@
 <h2>Macro.swift connect-static
-  <img src="http://zeezide.com/img/MicroExpressIcon1024.png"
-       align="right" width="100" height="100" />
+  <img src="http://zeezide.com/img/macro/MacroExpressIcon128.png"
+           align="right" width="100" height="100" />
 </h2>
 
 Demonstrates the use of the `connect.serveStatic` middleware.

Sources/connect-static/main.swift

@@ -1,6 +1,6 @@
 #!/usr/bin/swift sh
 
-import MacroExpress // @Macro-swift ~> 0.5.4
+import MacroExpress // @Macro-swift
 
 let dirname = __dirname()
 

Sources/express-simple-lambda/main.swift

@@ -1,7 +1,7 @@
 #!/usr/bin/swift sh
 
-import MacroLambda // @Macro-swift          ~> 0.1.1
-import cows        // @AlwaysRightInstitute ~> 1.0.0
+import MacroLambda // @Macro-swift
+import cows        // @AlwaysRightInstitute
 
 let app = express()
 

Sources/express-simple/main.swift

@@ -1,7 +1,7 @@
 #!/usr/bin/swift sh
 
-import MacroExpress // @Macro-swift          ~> 0.5.4
-import cows         // @AlwaysRightInstitute ~> 1.0.0
+import MacroExpress // @Macro-swift
+import cows         // @AlwaysRightInstitute
 
 let app = express()
 

Sources/httpd-helloworld/README.md

@@ -1,5 +1,5 @@
 <h2>Macro.swift httpd-helloworld
-  <img src="http://zeezide.com/img/MicroExpressIcon1024.png"
+  <img src="http://zeezide.com/img/macro/MacroExpressIcon128.png"
        align="right" width="100" height="100" />
 </h2>
 

Sources/todomvc/Model.swift

@@ -0,0 +1,35 @@
+//
+//  Model.swift
+//  Noze.io / mod_swift / MacroExpress
+//
+//  Created by Helge Heß on 6/3/16.
+//  Copyright © 2016-2021 ZeeZide GmbH. All rights reserved.
+//
+
+struct Todo: Encodable {
+  // Note: Decodable doesn't work for partial objects and has little to no
+  //       value for the Todo-Backend API.
+  
+  var id        : Int
+  var title     : String
+  var completed : Bool
+  var order     : Int
+  
+  var url       : String { return "\(ourAPI)todos/\(id)" }
+  
+  
+  // Codable is a train wreck. We need all this boilerplate just to emit the
+  // extra `url`.
+  
+  enum CodingKeys: String, CodingKey {
+    case id, title, completed, order, url
+  }
+  func encode(to encoder: Encoder) throws {
+    var values = encoder.container(keyedBy: CodingKeys.self)
+    try values.encode(url,       forKey: .url)
+    try values.encode(id,        forKey: .id)
+    try values.encode(title,     forKey: .title)
+    try values.encode(completed, forKey: .completed)
+    try values.encode(order,     forKey: .order)
+  }
+}

Sources/todomvc/README.md

@@ -0,0 +1,32 @@
+<h2>MacroExpress TodoMVC
+  <img src="http://zeezide.com/img/macro/MacroExpressIcon128.png"
+           align="right" width="100" height="100" />
+</h2>
+
+An implementation of a [Todo-Backend](http://todobackend.com/), 
+a simple JSON API to access and modify a list of todos.
+
+
+## Running the Sample
+
+Use `swift run` or run the sample from within Xcode:
+```
+$ swift run todomvc
+2021-01-30T15:51:41+0100 notice μ.express.app : Listening on 8042
+```
+
+### Who
+
+**Macro** is brought to you by
+the
+[Always Right Institute](http://www.alwaysrightinstitute.com)
+and
+[ZeeZide](http://zeezide.de).
+We like 
+[feedback](https://twitter.com/ar_institute), 
+GitHub stars, 
+cool [contract work](http://zeezide.com/en/services/services.html),
+presumably any form of praise you can think of.
+
+There is a `#microexpress` channel on the 
+[Noze.io Slack](http://slack.noze.io/). Feel free to join!

Sources/todomvc/VolatileStoreCollection.swift

@@ -0,0 +1,62 @@
+//
+//  Storage.swift
+//  Noze.io / mod_swift / MacroExpress
+//
+//  Created by Helge Hess on 03/06/16.
+//  Copyright © 2016-2021 ZeeZide GmbH. All rights reserved.
+//
+
+/// A collection store which just stores everything in memory. Data added will
+/// be gone when the process is stopped.
+///
+/// Note: The operations in here are all synchronous for simplicity. This is not 
+///       how a regular store would usually work.
+///       Check out todo-mvc-redis for a store with async operations.
+///
+class VolatileStoreCollection<T> {
+
+  var sequence      = 1337
+  var changeCounter = 0
+
+  var objects = [ Int : T ]()
+
+  init() {}
+  
+  func nextKey() -> Int {
+    sequence += 1
+    return sequence
+  }
+  
+  func getAll() -> [ T ] {
+    return Array(objects.values)
+  }
+  
+  func get(ids keys: [ Int ]) -> [ T ] {
+    var matches = [T]()
+    for key in keys {
+      if let object = objects[key] {
+        matches.append(object)
+      }
+    }
+    return matches
+  }
+  
+  func get(id key: Int) -> T? {
+    return objects[key]
+  }
+  
+  func delete(id key: Int) {
+    changeCounter += 1
+    objects.removeValue(forKey: key)
+  }
+  
+  func update(id key: Int, value v: T) {
+    changeCounter += 1
+    objects[key] = v // value type!
+  }
+  
+  func deleteAll() {
+    changeCounter += 1
+    objects.removeAll()
+  }
+}