Swiftpack.co - Package - OpenKitten/MeowVapor

🐈 MeowVapor

MeowVapor bridges Meow to Vapor and provides awesome helpers for creating a Meow based Vapor app/API.

Add the dependency

.package(url: "https://github.com/OpenKitten/MeowVapor.git", from: "2.0.0")

Add MeowVapor as a dependency via SPM and run swift package update.

Setting up

Add Meow to your Vapor services. Be sure to change the MongoDB URI to point to your server.

let meow = try MeowProvider(uri: "mongodb://localhost/MyDatabase")
try services.register(meow)

Using MeowVapor

router.get { request -> Future<[User]> in
   let context = try request.make(Meow.Context.self)
   return context.find(User.self).getAllResults()
}

Creating models

When creating a Model you need to conform your class to Model. The only requirement is that you add a property to your model with a key of _id and is not a computed property.

final class User: Model {
  var _id = ObjectId()
  
  ...
}

You can use any type for the _id key as long as it's a standard BSON Primitive type including:

  • ObjectId
  • String
  • Double
  • Int
  • Int32
  • Binary / Data

The following is completely legitimate:

// Stores the username in _id
final class User: Model {
  var _id: String
  
  var username: String {
    return _id
  }
  
  ...

By default the model name will be used for the collection name. You can customize this with a static let collectionName: String

final class User: Model {
  // Changes the collection name from `User` to `users`
  static let collectionName = "users"

  var _id = ObjectId()
  
  ...

Queries

Queries reside within the Context.

References

final class Article: Model {
  var _id = ObjectId()
  let creator: Reference<User>
  var title: String
  var text: String
  
  ...

The above demonstrates how a simple reference can be created to another model. In this case a User model. And below demonstrates resolving the reference.

let resolvedUser = article.creator.resolve(in: context)

The result in this case is an EventLoopFuture<User>, but if you wish to resolve the reference's target to nil if it doesn't exist you can simply do article.creator.resolveIfPresent(in: context).

You're also able to delete the target of the reference using reference.deleteTarget(in: context). This implies that resolving the normal way (not with ifPresent) will result in a failure.

Unsupported MongoDB features

If a feature is unsupported by Meow, for example when it can't be type-safe, you can always fall back to MongoKitten.

let database: MongoKitten.Database = context.manager.database

🐈 Community

Join our slack here and become a part of the welcoming community.

⭐️ Features

  • [x] Boilerplate-free
  • [x] So easy it will make you purr, or have your money back!
  • [x] Awesome type-safe and autocompleted queries
  • [x] Support for custom MongoDB queries
  • [x] Easy migrations to a new model version
  • [x] Supports your own types (like structs and enums) and common types (like String, Int and Date) out of the box using Codable

Github

link
Stars: 13
Help us keep the lights on

Releases

2.1.2 - Mar 28, 2019

  • Loosen requirement of update on ContentContainer from QueryableModel to KeyPathQueryable

2.1.1 - Mar 21, 2019

This release fixes a bug that caused models as resolved parameters to be resolved using the wrong Meow.Context when using a lazy connection and synchronous context making.

2.1.0 - Feb 26, 2019

  • Support for lazily connecting to MongoDB databases
    • This means you can now synchronously make a context using request.context()
      • This replaces request.meow(), which is now deprecated
    • To use it, just switch to the new init. The old one is now deprecated. If you don't want to lazily connect, you can still opt-out of lazy connections.
  • Added support for a configure closure on MeowProvider. By setting it, you can perform configuration on the made Context instances
  • Removes Set: ReflectionDecodable and adds a dependency of Vapor Core 3.5.0. Since that version, the conformance is implemented in Vapor Core, and causes a compiler warning in MeowVapor

2.0.1 - Feb 8, 2019

  • MeowVaporError is now public (#3)
  • Added a case to MeowVaporError to indicate that it is not a frozen enum (#3)
  • Catch ObjectId initialisation errors in resolveParameter and re-throw them as MeowVaporError to improve error handling logic (#3)

2.0.0 - Jan 14, 2019