ulid 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc065154adc250d260ea69bdbf3b4f30a760ab6b
+  data.tar.gz: 0012c1a18390f4e82cdc1a60de330dc2009d89b7
+SHA512:
+  metadata.gz: f019f4a68180707cbc28c4cd5ee3464d7be861997400879b6a6bdb7981991f8c27b385a80ab8b6868a8cd4b4c0d50b30b8d6091874560fa7f8148638589937b1
+  data.tar.gz: 43e5d04f97ed8a34720bf1e41af6f85369a5da471e76b0166965520399e98ec37adf7e710b4f4f6631fed0c6d7a1c0adefc6676bff5c3c3a11f58a613d49e867

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-pg_sync.gemspec
+gemspec
+
+group :development, :test do
+  gem "bundler", "~> 1.12.5"
+  gem "rake", "~> 10.0"
+  gem "pry-byebug"
+end
+
+group :test do
+  gem "minitest"
+  gem "mocha"
+end

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    ulid (0.0.1)
+      sysrandom (>= 1.0.0, < 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.0.5)
+    coderay (1.1.1)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    minitest (5.9.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.0)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    slop (3.6.0)
+    sysrandom (1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12.5)
+  minitest
+  mocha
+  pry-byebug
+  rake (~> 10.0)
+  ulid!
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rafael Sales
+
+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.

data/README.md

@@ -0,0 +1,124 @@
+# ulid
+Universally Unique Lexicographically Sortable Identifier implementation for Ruby
+
+<h1 align="center">
+	<br>
+	<br>
+	<img width="360" src="logo.png" alt="ulid">
+	<br>
+	<br>
+	<br>
+</h1>
+
+# Universally Unique Lexicographically Sortable Identifier
+
+UUID can be suboptimal for many uses-cases because:
+
+- It isn't the most character efficient way of encoding 128 bits of randomness
+- The string format itself is apparently based on the original MAC & time version (UUIDv1 from Wikipedia)
+- It provides no other information than randomness
+
+Instead, herein is proposed ULID:
+
+- 128-bit compatibility with UUID
+- 1.21e+24 unique ULIDs per millisecond
+- Lexicographically sortable!
+- Canonically encoded as a 26 character string, as opposed to the 36 character UUID
+- Uses Crockford's base32 for better efficiency and readability (5 bits per character)
+- Case insensitive
+- No special characters (URL safe)
+
+### Installation
+
+```
+gem install ulid
+```
+
+### Usage
+
+```ruby
+require 'ulid'
+
+ULID.generate // 01ARZ3NDEKTSV4RRFFQ69G5FAV
+```
+
+## Specification
+
+Below is the current specification of ULID as implemented in this repository. *Note: the binary format has not been implemented.*
+
+```
+ 01AN4Z07BY      79KA1307SR9X4MV3
+
+|----------|    |----------------|
+ Timestamp          Randomness
+  10 chars           16 chars
+   48bits             80bits
+   base32             base32
+```
+
+### Components
+
+**Timestamp**
+- 48 bit integer
+- UNIX-time in milliseconds
+- Won't run out of space till the year 10895 AD.
+
+**Randomness**
+- 80 bits
+- Cryptographically secure source of randomness, if possible
+
+### Sorting
+
+The left-most character must be sorted first, and the right-most character sorted last. The default ASCII order is used for sorting.
+
+### Binary Layout and Byte Order
+
+The components are encoded as 16 octets. Each component is encoded with the Most Significant Byte first (network byte order).
+
+```
+0                   1                   2                   3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                      32_bit_uint_time_low                     |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|     16_bit_uint_time_high     |       16_bit_uint_random      |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                       32_bit_uint_random                      |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                       32_bit_uint_random                      |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+```
+
+### String Representation
+
+```
+ttttttttttrrrrrrrrrrrrrrrr
+
+where
+t is Timestamp
+r is Randomness
+```
+
+## Test Suite
+
+```
+# TODO
+```
+
+## Performance
+
+```
+# TODO
+```
+
+```
+ulid
+336,331,131 op/s » encodeTime
+102,041,736 op/s » encodeRandom
+17,408 op/s » generate
+
+
+Suites:  1
+Benches: 3
+Elapsed: 7,285.75 ms
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs += ["spec", "lib"]
+  t.test_files = FileList['spec/**/*_spec.rb']
+end

data/lib/ulid.rb

@@ -0,0 +1,7 @@
+module ULID
+  def self.random_create
+    Generator.new.random_create
+  end
+end
+
+Dir.glob(File.join(File.dirname(__FILE__), "/ulid/**/*.rb")).sort.each { |f| require f }

data/lib/ulid/generator.rb

@@ -0,0 +1,34 @@
+require 'sysrandom'
+
+module ULID
+  class Generator
+    ENCODING = '0123456789ABCDEFGHJKMNPQRSTVWXYZ'
+
+    def random_create
+      encode_time(milliseconds_since_epoch, 10) + encode_random(16)
+    end
+
+    private
+
+    def encode_time(now, length)
+      length.times.reduce("") do |output|
+        mod = now % ENCODING.length
+        now = (now - mod) / ENCODING.length
+
+        output << ENCODING[mod]
+      end
+    end
+
+    def encode_random(length)
+      length.times.reduce("") do |output|
+        random = Sysrandom.random_number(ENCODING.length)
+
+        output << ENCODING[random]
+      end
+    end
+
+    def milliseconds_since_epoch
+      (Time.now.to_f * 1000).to_i
+    end
+  end
+end

data/lib/ulid/version.rb

@@ -0,0 +1,3 @@
+module ULID
+  VERSION = '0.0.1'
+end

data/spec/lib/ulid_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe ULID do
+  it "works" do
+    ulid = ULID.random_create
+    ulid.length.must_equal 26
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'pry'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'mocha/mini_test'
+require 'ulid'

data/ulid.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ulid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ulid"
+  spec.version       = ULID::VERSION
+  spec.authors       = ["Rafael Sales"]
+  spec.email         = ["rafaelcds@gmail.com"]
+  spec.summary       = %q{Universally Unique Lexicographically Sortable Identifier implementation for Ruby}
+  spec.homepage      = "https://github.com/rafaelsales/ulid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sysrandom", ">= 1.0.0", "< 2.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: ulid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rafael Sales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sysrandom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- rafaelcds@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/ulid.rb
+- lib/ulid/generator.rb
+- lib/ulid/version.rb
+- logo.png
+- spec/lib/ulid_spec.rb
+- spec/spec_helper.rb
+- ulid.gemspec
+homepage: https://github.com/rafaelsales/ulid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Universally Unique Lexicographically Sortable Identifier implementation for
+  Ruby
+test_files:
+- spec/lib/ulid_spec.rb
+- spec/spec_helper.rb