README.md

Rogue

Rogue is a type-safe internal Scala DSL for constructing and executing find and modify commands in MongoDB. Originally developed by Foursquare, then re-published as a part of Foursquare [monorepo]((http://github.com/foursquare/fsqio)

#Sgrouples changes to the original

1. Mongo scala driver - updated to version 4.3.x to support MongoDB version 3.2 and up
2. Support for non-blocking IO via async functions like getAsync, fetchAsync etc. Note that for really non-blocking io, using reactive drive
3. Build is standard sbt instead of pants

#Building and installing Standard sbt build, so just sbt package; sbt publish-local is enough.

#Usage

1. define model as case class, with the same features supported as in shapeless version. Enumerations serializers are swiched by @EnumSerializeValue annotation on enum itself

case class Entity(_id: ObjectId, str: String, optInt: Option[Int], list:List[Int])

2. create class describing your cc

  import me.sgrouples.rogue.cc.macros._

  trait Metas {
    class EntityMeta extends  MCcMeta[Entity, EntityMeta]("entity_coll_name") {
    val id = ObjectIdField("id")("id")
    val str = StringField("str")
    val optInt = OptIntField("optInt")
    val list = ListField[Int]("list")
    }
  }

3. provide implicit database connection and use your meta

 import me.sgrouples.rogue.cc.CcRogue._
 import org.bson.types.ObjectId
 import scala.concurrent.ExecutionContext.Implicits.global

 class MetaUsage extends Metas {
   implicit val db =  org.mongodb.scala.MongoClient("mongodb://localhost:27001")
   val EntityRepo = new EntityMeta

   def test() = {
     for {
      _ <- EntityRepo.insertOneAsync(Entity(new ObjectId(), "Str", Some(42), List(4,6,7)))
      entities <- EntityRepo.select(_.str).fetchAsync()
    } yield entities
   }
 }

more examples in tests