nanoid.cr

Crystal implementation of original NanoID

Installation

Add this to your application's shard.yml:

dependencies:
  nanoid:
    github: mamantoha/nanoid.cr

Usage

require "nanoid"

Nanoid.generate uses URL-friendly symbols (A-Za-z0-9_-) and returns an ID with 21 characters.

Nanoid.generate
# => 3gFI8yZxcfXsXGhB0036l

If you want to reduce ID length (and increase collisions probability), you can pass the length as an argument.

Nanoid.generate(size: 8, alphabet: "1234567890abcdef")
# => 86984b57

Non-secure API is also available.

Nanoid.generate(secure: false)
# => no0MmiInNcBm9jR2_3sGt

Nanoid.generate(size: 10, alphabet: "1234567890abcdef", secure: false)
# => 2793b2351c

Benchmark

crystal run --release bench/benchmark.cr

Crystal 1.1.0-dev [e7b46c407] (2021-03-30)

LLVM: 10.0.0
Default target: x86_64-unknown-linux-gnu

    Nanoid.simple_generate(21)   1.73  (579.36ms) (±17.97%)  76.3MB/op   3.67× slower
   Nanoid.complex_generate(21)   1.36  (737.33ms) (± 3.89%)  76.3MB/op   4.67× slower
Nanoid.non_secure_generate(21)   6.33  (157.91ms) (± 2.59%)  45.8MB/op        fastest
                       UUID v4   2.31  (432.22ms) (± 0.53%)    0.0B/op   2.74× slower
    Nanoid.simple_generate(16)   1.64  (609.99ms) (±24.13%)  61.3MB/op   5.27× slower
   Nanoid.complex_generate(16)   1.52  (658.34ms) (± 2.80%)  61.1MB/op   5.69× slower
Nanoid.non_secure_generate(16)   8.64  (115.75ms) (± 2.87%)  30.5MB/op        fastest
                          UUID   2.31  (433.02ms) (± 0.89%)    0.0B/op   3.74× slower

Development

Clone this repository and install dependencies:

shards install

Run tests:

crystal spec

Contributing

1. Fork it (https://github.com/mamantoha/nanoid.cr/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• mamantoha Anton Maminov - creator, maintainer

License

Copyright: 2018-2021 Anton Maminov ([email protected])

This library is distributed under the MIT license. Please see the LICENSE file.