Enhancement in restful controller stub

[hsharghi]

I want to add a piece of code to RestController.stub and make it testable and usable out of the box.

struct {{name}}: RouteCollection {

  func boot(routes: RoutesBuilder) throws {  
      let routeGroup = routes.grouped("{{routeName}}")
      routeGroup.get(use: index)
      routeGroup.get("create", use: create)
      routeGroup.post(use: store)
      routeGroup.group(":ID") { rotue in
          rotue.get("edit", use: edit)
          rotue.get(use: show)
          rotue.put(use: update)
          rotue.delete(use: destroy)
      }
}

Any idea how to generate {{routeName}} from name?
e.g generate players string from PlayersController

As it is for making controllers testable, and for sure in most cases developers will change the generated string for the route collection, maybe just generating a simple string like this would be sufficient.

"PlayersController".replacingOccurrences(of: "Controller", with: "").lowercased()      // players

[Lloople]

That would be enough for now, sure 👍

But I don't quite like that kind of controller, hiding routes inside the controllers is a pattern that prevents you to see your routes well organized in a single file.

I would like to have a flag for this, like vapor run make:controller PlayersController --boot and use a new BootController.stub.

What do you think about that?

[hsharghi]

I like the idea of having a flag for this kind of controller.
But I would like having a testable generated code for all kinds of controllers too.

I don't think there is a single preferred approach for defining routes in Vapor as it's for Laravel.

I think creating single routes file for each controller will bloat the project structure, What do you think about adding routes to routes.swift file?

[Lloople]

The command can drop a message on how to add this bootable controller into the routes.swift file, I don't think the command should edit that file, it's beyond the scope of the project and also the user would like to order the routes or split them into separate files as they want.

I would like to have tests too! But first I need to figure out a way for my tests to detect the resources shared via Packages.swift. I tried adding the resources: [ .copy("Resources")] key to the testTarget but no luck 😅

[Lloople]

@hsharghi I pushed a commit regarding this feature, feel free to suggest any change via pull request as before 🙂

Still investigating the tests topic, not easy for me since I'm new to both Swift and Vapor 😅