Latest 0.2.0
Homepage https://github.com/pointfreeco/swift-gen
License MIT
Platforms ios 8.0, osx 10.9, tvos 9.0, watchos 2.0
Authors ,

🎱 Gen

Swift 5
iOS/macOS/tvOS/watchOS CI
Linux CI
@pointfreeco

Composable, transformable, controllable randomness.

Table of Contents

Motivation

Swift’s randomness API is powerful and simple to use. It allows us to create random values from many basic types, such as booleans and numeric types, and it allows us to randomly shuffle arrays and pluck random elements from collections.

However, it does not make it easy for us to extend the randomness API, nor does it provide an API that is composable, which would allow us to create complex types of randomness from simpler pieces.

Gen is a lightweight wrapper over Swift’s randomness APIs that makes it easy to build custom generators of any kind of value.

Examples

Gen’s namesake type, Gen, is responsible for producing random values. Most often you will reach for one of the static variables inside Gen to get access to a Gen value:

Gen.bool
// Gen<Bool>

Rather than immediately producing a random value, Gen describes a random value that can be produced by calling its run method:

let myGen = Gen.bool
// Gen<Bool>

myGen.run() // true
myGen.run() // true
myGen.run() // false

Every random function that comes with Swift is also available as a static function on Gen:

Swift’s API Gen’s API
Int.random(in: 0...9) Gen.int(in: 0...9)
Double.random(in: 0...9) Gen.double(in: 0...9)
Bool.random() Gen.bool
[1, 2, 3].randomElement() Gen.element(of: [1, 2, 3])
[1, 2, 3].shuffled() Gen.shuffle([1, 2, 3])

The reason it is powerful to wrap randomness in the Gen type is that we can make the Gen type composable. For example, a generator of integers can be turned into a generator of numeric strings with a simple application of the map function:

let digit = Gen.int(in: 0...9)           // Gen<Int>
let stringDigit = digit.map(String.init) // Gen<String>

stringDigit.run() // "7"
stringDigit.run() // "1"
stringDigit.run() // "3"

Already this is a form of randomness that Swift’s API’s do not provide out of the box.

Gen provides many operators for generating new types of randomness, such as map, flatMap and zip, as well as helper functions for generating random arrays, sets, dictionaries, strings, distributions and more! A random password generator, for example, is just a few operators away.

// Take a generator of random letters and numbers.
let password = Gen.letterOrNumber
  // Generate 6-character strings of them.
  .string(of: .always(6))
  // Generate 3 segments of these strings.
  .array(of: .always(3))
  // And join them.
  .map { $0.joined(separator: "-") }

password.run() // "9BiGYA-fmvsOf-VYDtDv"
password.run() // "dS2MGr-FQSuC4-ZLEicl"
password.run() // "YusZGF-HILrCo-rNGfCA"

This kind of composition makes it simple to generate random values of anything.

// Use `zip` to combine generators together and build structures.

let randomPoint = zip(.int(in: -10...10), .int(in: -10...10))
  .map(CGPoint.init(x:y:))
// Gen<CGPoint>

But composability isn’t the only reason the Gen type shines. By delaying the creation of random values until the run method is invoked, we allow ourselves to control randomness in circumstances where we need determinism, such as tests. The run method has an overload that takes a RandomNumberGenerator value, which is Swift’s protocol that powers their randomness API. By default it uses the SystemRandomNumberGenerator, which is a good source of randomness, but we can also provide a seedable "pseudo" random number generator, so that we can get predictable results in tests:

var lcrng = LCRNG(seed: 0)
Gen.int(in: 0...9).run(using: &lcrng) // "8"
Gen.int(in: 0...9).run(using: &lcrng) // "1"
Gen.int(in: 0...9).run(using: &lcrng) // "7"

lcrng.seed = 0
Gen.int(in: 0...9).run(using: &lcrng) // "8"
Gen.int(in: 0...9).run(using: &lcrng) // "1"
Gen.int(in: 0...9).run(using: &lcrng) // "7"

This means you don’t have to sacrifice testability when leveraging randomness in your application.

For more examples of using Gen to build complex randomness, see our blog post on creating a Zalgo generator and our two-part video series (part 1 and part 2) on creating generative art.

Installation

Carthage

If you use Carthage, you can add the following dependency to your Cartfile:

github "pointfreeco/swift-gen" ~> 0.2

CocoaPods

If your project uses CocoaPods, just add the following to your Podfile:

pod 'PointFree-Gen', '~> 0.2'

SwiftPM

If you want to use Gen in a project that uses SwiftPM, it’s as simple as adding a dependencies clause to your Package.swift:

dependencies: [
  .package(url: "https://github.com/pointfreeco/swift-gen.git", from: "0.2.0")
]

Xcode Sub-project

Submodule, clone, or download Gen, and drag Gen.xcodeproj into your project.

Interested in learning more?

These concepts (and more) are explored thoroughly in Point-Free, a video series exploring functional programming and Swift hosted by Brandon Williams and Stephen Celis.

The design of this library was explored in the following Point-Free episodes:

video poster image

License

All modules are released under the MIT license. See LICENSE for details.

Latest podspec

{
    "name": "PointFree-Gen",
    "module_name": "Gen",
    "version": "0.2.0",
    "summary": "Composable, transformable, controllable randomness.",
    "description": "Swift's randomness API is powerful and simple to use. It allows us to createnrandom values from many basic types, such as booleans and numeric types, andnit allows us to randomly shuffle arrays and pluck random elements fromncollections.nnHowever, it does not make it easy for us to extend the randomness API, norndoes it provide an API that is composable, which would allow us to createncomplex types of randomness from simpler pieces.nnGen is a lightweight wrapper over Swift's randomness APIs that makes it easynto build custom generators of any kind of value.",
    "homepage": "https://github.com/pointfreeco/swift-gen",
    "license": "MIT",
    "authors": {
        "Brandon Williams": "[email protected]",
        "Stephen Celis": "[email protected]"
    },
    "social_media_url": "https://twitter.com/pointfreeco",
    "source": {
        "git": "https://github.com/pointfreeco/swift-gen.git",
        "tag": "0.2.0"
    },
    "swift_versions": "5.0",
    "platforms": {
        "ios": "8.0",
        "osx": "10.9",
        "tvos": "9.0",
        "watchos": "2.0"
    },
    "source_files": [
        "Sources",
        "Sources/Gen/**/*.swift"
    ]
}

Pin It on Pinterest

Share This