https://github.com/clovellytech/shortcodes

A basic random unique word string generator and codec
https://github.com/clovellytech/shortcodes

cats-effect fs2 scala

Last synced: about 2 months ago
JSON representation

A basic random unique word string generator and codec

• Host: GitHub
• URL: https://github.com/clovellytech/shortcodes
• Owner: clovellytech
• Created: 2020-03-29T02:26:45.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2020-07-06T20:47:39.000Z (over 4 years ago)
• Last Synced: 2024-04-18T10:16:46.201Z (9 months ago)
• Topics: cats-effect, fs2, scala
• Language: Scala
• Size: 46.9 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Short codes for Scala [![Build Status][travis-badge]][travis-url] [![Sonatype Release][sonatype-badge]][sonatype-url]

===

This project uses a dictionary of words to generate random short sequences. These are intended for generating site invitation codes, but could probably be used for other purposes.

For now this is only using the [bip-39 word list](https://github.com/bitcoin/bips/blob/master/bip-0039/english.txt). The dictionary has 2048 words, and the sequence generator chooses with replacement, so the randomness for length n is 2048n. So there are 1.8 x 1013 combinations of 4 words for example. A string of n words will have about the same randomness as an alphanumeric string of length 2n.

Use

---

Published to sonatype for scala 2.12 and 2.13:

```

libraryDependencies += "com.clovellytech" %% "shortcodes" % version // look at nexus badge for recent version ^^

```

Example

---

```scala

scala> val sc = new ShortCode[IO](blocker)

sc: com.clovellytech.shortcode.ShortCode[cats.effect.IO] = com.clovellytech.shortcode.ShortCode@2f738d7f

scala> sc.getRandom(4).value.unsafeRunSync.get

res0: (cats.data.NonEmptyVector[String], Array[Byte]) = (NonEmptyVector(join, jewel, practice, mixture, inhale),Array(3, -63, 3, -65, 5, 75, 4, 114, 3, -99))

scala> sc.bytesToWords(res0._2).value.unsafeRunSync().get

res1: cats.data.NonEmptyVector[String] = NonEmptyVector(join, jewel, practice, mixture, inhale)

```

[travis-badge]: https://travis-ci.com/clovellytech/shortcodes.svg?branch=master "Build Status"

[travis-url]: https://travis-ci.com/clovellytech/shortcodes "Build Status"

[sonatype-badge]: https://img.shields.io/nexus/r/com.clovellytech/shortcodes_2.13.svg?server=https://oss.sonatype.org "Sonatype Releases"

[sonatype-url]: https://oss.sonatype.org/content/groups/public/com/clovellytech/ "Sonatype Releases"