wix-incubator/nutri-matic

Creates arbitrary instances of scala objects using reflection

Nutri-Matic

He had found a Nutri-Matic machine which had provided him with a plastic cup filled with a liquid that was almost, but not quite, entirely unlike tea

— Douglas Adams, The Hitchhiker's Guide to the Galaxy

Creates arbitrary instances of scala objects using reflection. Currently supports:

• Primitive types
• Boxed Java primitives
• Strings
• Basic scala collections - Seq, List, Set, Map
• Arrays
• Option and Either
• Sealed traits
• Scala enums
• Case classes
• Case objects
• Classes that have a constructor

Usage

You can use the default instance:

import com.wix.nutrimatic.NutriMatic

NutriMatic.makeA[Option[String]]

Or you can configure to your hearts content:

import com.wix.nutrimatic.NutriMatic

val nutriMatic = NutriMatic.builder // the arguments here are the default values
  .withCollectionSizes(0, 3) // created collections and arrays will have a size between these numbers (inclusive)
  .withStringLengths(1, 20) // created strings will have a length between these numbers (inclusive)
  .withCustomGenerators() // use these custom generators
  .withSeed(scala.util.Random.nextLong()) // seed used for getting random instances
  .withMaxCacheSize(10000) // this library relies on caching quite a bit, so if you run into memory issues, try reducing this value
  .build

nutriMatic.makeA[Option[String]]

Custom types and overrides

The main concept behind making values in generators, which are just partial functions.

The most basic are generators that match an exact type. Say you wanted to make sure that the ints you get are really random. You find a good code snippet and get to work:

import com.wix.nutrimatic.{Generators, NutriMatic}

val getRandomNumber = Generators.byExactType[Int] { _ => 4}

val nutriMatic = NutriMatic.builder
  .withCustomGenerators(getRandomNumber)
  .build

nutriMatic.makeA[Int] must_== 4

For generics, you can also match by an erasure of a type. Your function gets called with context which allows you to make other values and get randoms from the same seed.

import com.wix.nutrimatic.{Generators, NutriMatic}

val makeSureWeKnow = Generators.byErasure[Option[_]] {
  case (tpe, context) => Some(context.makeComponent(tpe.typeArgs.head))
}

val theAnswerToLifeTheUniverseAndEverything = Generators.byExactType[Int] { _ => 42 }

val nutriMatic = NutriMatic.builder
  .withCustomGenerators(theAnswerToLifeTheUniverseAndEverything, makeSureWeKnow)
  .build

nutriMatic.makeA[Option[Int]] must beSome(42)

Finally, you can provide your own custom generators. They are attempted before any other generators:

import com.wix.nutrimatic.{Generator, NutriMatic}

val typesStartingWithSAreAlwaysNull: Generator[Any] = {
  case (tpe, context) if tpe.toString.startsWith("S") => null
}

val nutriMatic = NutriMatic.builder
  .withCustomGenerators(typesStartingWithSAreAlwaysNull)
  .build

nutriMatic.makeA[String] must beNull
nutriMatic.makeA[Seq[Int]] must beNull
nutriMatic.makeA[Option[Int]] must not(beNull)

nutri-matic's Issues

Classloading problems

Currently, the default classloader is used. This can cause issues in the case of case objects, as they might get loaded twice

Make it possible to configure actual type used for collection

It seems that specs2 sometimes doesn't think that a list is equal to a vector with the same elements.

Generate generic subclasses of sealed traits if we can match their type arguments

Add posibility to always initialize Options to Some, Strings to nonEmpty

java.time types support

Currently getting:

java.time.Instant.<init>()
java.lang.NoSuchMethodException: 

For unknown types randomisation, I'd suggest to implement some magic that finds type constructors or static methods that are accepting primitive values.

Add support for Any