init

Author: krthr

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*.cr]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

.gitignore

@@ -0,0 +1,9 @@
+/docs/
+/lib/
+/bin/
+/.shards/
+*.dwarf
+
+# Libraries don't need dependency lock
+# Dependencies will be locked in applications that use them
+/shard.lock

.travis.yml

@@ -0,0 +1,6 @@
+language: crystal
+
+# Uncomment the following if you'd like Travis to run specs and check code formatting
+# script:
+#   - crystal spec
+#   - crystal tool format --check

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 krthr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,61 @@
+# uuidx
+
+A tiny (<1KB), fast, and cryptographically secure UUID (v4) generator for Crystal.
+
+> This is the Crystal version of [@lukeed/uuid](https://github.com/lukeed/uuid)
+
+## Installation
+
+1. Add the dependency to your `shard.yml`:
+
+   ```yaml
+   dependencies:
+     uuix:
+       github: krthr/uuix
+   ```
+
+2. Run `shards install`
+
+## Usage
+
+```crystal
+require "uuix"
+
+puts UUIX.random # bc524cd7-5ec3-48c4-9bcc-e9013c69dd6e
+```
+
+## Benchmarks
+
+```bash
+Crystal 0.33.0 [612825a53] (2020-02-14)
+
+LLVM: 8.0.0
+Default target: x86_64-unknown-linux-gnu
+        UUIX: 920.14k (  1.09µs) (± 9.68%)  880B/op        fastest
+Crystal UUID: 647.32k (  1.54µs) (± 7.53%)  0.0B/op   1.42× slower
+```
+
+## Performance
+
+> Taken from https://github.com/lukeed/uuid
+
+The reason why this UUID.V4 implementation is so much faster is two-fold:
+
+1. It composes an output with hexadecimal pairs (from a cached dictionary) instead of single characters.
+2. It allocates a larger Buffer/ArrayBuffer up front (expensive) and slices off chunks as needed (cheap).
+
+The internal ArrayBuffer is 4096 bytes, which supplies **256** `random` invocations.
+
+A larger buffer would result in higher performance over time, but I found this to be a good balance of performance and memory space.
+
+## Contributing
+
+1. Fork it (<https://github.com/krthr/uuix/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
+
+- [krthr](https://github.com/krthr) - creator and maintainer

shard.yml

@@ -0,0 +1,9 @@
+name: uuid
+version: 0.1.0
+
+authors:
+  - krthr <[email protected]>
+
+crystal: 0.33.0
+
+license: MIT

spec/spec_helper.cr

@@ -0,0 +1,2 @@
+require "spec"
+require "../src/uuid"

spec/uuid_spec.cr

@@ -0,0 +1,9 @@
+require "./spec_helper"
+
+describe Uuid do
+  # TODO: Write tests
+
+  it "works" do
+    false.should eq(true)
+  end
+end

src/benchmark.cr

@@ -0,0 +1,15 @@
+require "benchmark"
+require "uuid"
+require "./uuix.cr"
+
+puts Crystal::DESCRIPTION
+
+Benchmark.ips do |x|
+  x.report("UUIX:") do
+    UUIX.random
+  end
+
+  x.report("Crystal UUID:") do
+    UUID.random
+  end
+end

src/uuix.cr

@@ -0,0 +1,29 @@
+module UUIX
+  VERSION = "0.1.0"
+
+  @@SIZE : Int32 = 4096
+  @@HEX = [] of String
+  @@IDX : Int32 = 0
+  @@BUFFER = [] of UInt8
+
+  i = 0
+  while i < 256
+    @@HEX << (i + 256).to_s(16)[1..]
+    i += 1
+  end
+
+  def self.random
+    if @@BUFFER.empty? || ((@@IDX + 16) > @@SIZE)
+      @@BUFFER = Random.new.random_bytes(@@SIZE).to_a
+      @@IDX = 0
+    end
+
+    arr = @@BUFFER[@@IDX..(@@IDX += 16)]
+
+    @@HEX[arr[0]] + @@HEX[arr[1]] + @@HEX[arr[2]] + @@HEX[arr[3]] +
+      '-' + @@HEX[arr[4]] + @@HEX[arr[5]] +
+      '-' + @@HEX[arr[6] & 15 | 64] + @@HEX[arr[7]] +
+      '-' + @@HEX[arr[8] & 63 | 128] + @@HEX[arr[9]] +
+      '-' + @@HEX[arr[10]] + @@HEX[arr[11]] + @@HEX[arr[12]] + @@HEX[arr[13]] + @@HEX[arr[14]] + @@HEX[arr[15]]
+  end
+end