├── .gitignore
├── .rbenv-version
├── .travis.yml
├── .yardopts
├── Gemfile
├── README.md
├── Rakefile
├── cuid.gemspec
├── doc
├── Cuid.html
├── _index.html
├── class_list.html
├── css
│ ├── common.css
│ ├── full_list.css
│ └── style.css
├── file.README.html
├── file_list.html
├── frames.html
├── index.html
├── js
│ ├── app.js
│ ├── full_list.js
│ └── jquery.js
├── method_list.html
└── top-level-namespace.html
├── lib
├── cuid.rb
└── cuid
│ └── version.rb
└── test
└── test_cuid.rb
/.gitignore:
--------------------------------------------------------------------------------
1 | *.gem
2 | .bundle
3 | Gemfile.lock
4 | pkg/*
5 | vendor/bundle
6 | .yardoc/*
7 |
--------------------------------------------------------------------------------
/.rbenv-version:
--------------------------------------------------------------------------------
1 | 1.9.3-p286
2 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: ruby
2 | rvm:
3 | - 1.8.7
4 | - 1.9.2
5 | - 1.9.3
6 | - jruby-19mode
7 |
--------------------------------------------------------------------------------
/.yardopts:
--------------------------------------------------------------------------------
1 | --no-private
2 | --protected
3 | --markup="markdown" lib/cuid.rb
4 | --main README.md
5 |
--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source "http://rubygems.org"
2 |
3 | group :test do
4 | gem "rake"
5 | end
6 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # cuid.rb - CUID ported to Ruby
2 | Last updated: December 16, 2012
3 |
4 | Version: 1.0.1
5 | [](https://travis-ci.org/iyshannon/cuid)
6 |
7 | Documentation: [http://rubydoc.info/gems/cuid](http://rubydoc.info/gems/cuid)
8 | Repository: [http://github.com/iyshannon/cuid](http://github.com/iyshanonn/cuid)
9 |
10 | ## Introduction
11 |
12 | cuid.rb is a ruby library that provides collision-resistant ids optimized for horizontal scaling and sequential lookup performance.
13 |
14 | This is just going to cover the basics and the Ruby-specific implementation details.
15 |
16 | **Please refer to the [main project site](http://usecuid.org) for the full story.**
17 |
18 | ## Sample CUID
19 |
20 | ch72gsb320000udocl363eofy
21 |
22 | ### Explanation
23 |
24 | `c - h72gsb32 - 0000 - udoc - l363eofy`
25 |
26 | The groups, in order, are:
27 |
28 | * 'c' - identifies this as a cuid, and allows you to use it in html entity ids. The fixed value helps keep the ids sequential.
29 | * Timestamp
30 | * Measured in milliseconds since the epoch
31 | * Will rollover in May 2059
32 | * Counter
33 | * A single process might generate the same random string. The weaker the pseudo-random source, the higher the probability. That problem gets worse as processors get faster.
34 | * The counter will roll over after 1,679,615 cuids are generated by one process.
35 | * Client fingerprint
36 | * In Ruby, the first two characters are based on the process ID and the next two characters are based on the hostname. This is the same method used in the Node implementation.
37 | * Pseudo random number
38 | * By default, Ruby uses the `Kernel#rand` function, a Mersenne Twister PRNG.
39 | * On Ruby 1.9.2 and up, it can optionally use the `SecureRandom` library (which uses OpenSSL), but there is a significant performance cost.
40 |
41 | ## Performance
42 |
43 | My development system runs Ubuntu 12.04 on an Intel Wolfdale E5200 Dual Core 2.5GHz with 4GB RAM.
44 | I did some very unscientific testing and the results were as follows:
45 |
46 | * Ruby 1.9.3-p286 using `Kernel#rand`: Generated 600,000 cuids in 8.16 seconds
47 | * Ruby 1.9.3-p286 using `SecureRandom#random_number` : Generated 600,000 cuids in 20.74 seconds
48 |
49 | *Each test was run three times and the mean is reported.*
50 |
51 | ### Analysis
52 |
53 | The timestamp segment of the cuid is measured in milliseconds. In the faster test result, it generated about 74 cuids per millisecond. Even
54 | without considering the random segment of the cuid, one process could safely generate up to 1,679,615 unique cuids per millisecond (36^4 - 1) without a
55 | collision due to the counter segment.
56 |
57 | ## System Requirements
58 |
59 | This gem was developed under `ruby1.9.3-p286` but is tested under multiple versions thanks to [Travis CI](http://www.travis-ci.org).
60 |
61 | Tested under:
62 |
63 | * Ruby 1.8.7
64 | * Ruby 1.9.2
65 | * Ruby 1.9.3
66 | * JRuby 1.9 (jruby19mode)
67 |
68 | ## Installation
69 |
70 | gem install cuid
71 |
72 | ## Example Usage
73 |
74 | irb(main):001:0> require "cuid"
75 | => true
76 | irb(main):002:0> g = Cuid::generate
77 | => "ch8qypsnz0000a4welw8anyra"
78 | irb(main):003:0> Cuid::validate(g)
79 | => true
80 | irb(main):004:0> Cuid::generate(4)
81 | => ["ch8qyq35f0002a4wekjcwmh30", "ch8qyq35f0003a4weewy22izq", "ch8qyq35f0004a4webzzelvdv", "ch8qyq35f0005a4wesg3tfjk5"]
82 |
83 | ## Credit
84 |
85 | * Ian Shannon [(ported to Ruby)](http://github.com/iyshannon/cuid)
86 | * Eric Elliott [(original JavaScript version)](http://github.com/dilvie/cuid)
87 |
88 | ## MIT Open Source License
89 |
90 | 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:
91 |
92 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
93 |
94 | 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.
95 |
--------------------------------------------------------------------------------
/Rakefile:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env rake
2 | require "bundler/gem_tasks"
3 | require "rake/testtask"
4 | Rake::TestTask.new do |t|
5 | t.libs << 'lib/cuid'
6 | t.verbose = true
7 | end
8 | task :default => :test
9 |
--------------------------------------------------------------------------------
/cuid.gemspec:
--------------------------------------------------------------------------------
1 | # -*- encoding: utf-8 -*-
2 | $:.push File.expand_path("../lib", __FILE__)
3 | require "cuid/version"
4 |
5 | Gem::Specification.new do |s|
6 | s.name = "cuid"
7 | s.version = Cuid::VERSION
8 | s.authors = ["Ian Shannon"]
9 | s.email = ["iyshannon@gmail.com"]
10 | s.homepage = "http://github.com/iyshannon/cuid"
11 | s.summary = %q{Collision-resistant ids optimized for horizontal scaling and performance}
12 | s.description = %q{Ruby implementation of Eric Elliot's javascript cuid}
13 |
14 | s.files = `git ls-files`.split("\n")
15 | s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
16 | s.require_paths = ["lib"]
17 | end
18 |
--------------------------------------------------------------------------------
/doc/Cuid.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 | Module: Cuid
8 |
9 | — Documentation by YARD 0.8.3
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 | Index (C) »
35 |
36 |
37 | Cuid
38 |
39 |
40 |
# File 'lib/cuid.rb', line 79
449 |
450 | defgenerate(quantity=1,secure_random=false)
451 | @use_secure_random=secure_random
452 | @fingerprint=get_fingerprint# only need to get the fingerprint once because it is constant per-run
453 | returnapiunlessquantity>1
454 |
455 | values=Array(1.upto(quantity))# create an array of the correct size
456 | returnvalues.collect{api}# fill array with hashes
457 | end
Validates (minimally) the supplied string is in the correct format to be a hash
475 |
476 |
Validation checks that the first letter is correct and that the rest of the
477 | string is the correct length and consists of lower case letters and numbers.
'c' - identifies this as a cuid, and allows you to use it in html entity ids. The fixed value helps keep the ids sequential.
94 |
Timestamp
95 |
96 |
97 |
Measured in milliseconds since the epoch
98 |
Will rollover in May 2059
99 |
100 |
Counter
101 |
102 |
103 |
A single process might generate the same random string. The weaker the pseudo-random source, the higher the probability. That problem gets worse as processors get faster.
104 |
The counter will roll over after 1,679,615 cuids are generated by one process.
105 |
106 |
Client fingerprint
107 |
108 |
109 |
In Ruby, the first two characters are based on the process ID and the next two characters are based on the hostname. This is the same method used in the Node implementation.
110 |
111 |
Pseudo random number
112 |
113 |
114 |
By default, Ruby uses the Kernel#rand function, a Mersenne Twister PRNG.
115 |
On Ruby 1.9.2 and up, it can optionally use the SecureRandom library (which uses OpenSSL), but there is a significant performance cost.
116 |
117 |
118 |
119 |
Performance
120 |
121 |
My development system runs Ubuntu 12.04 on an Intel Wolfdale E5200 Dual Core 2.5GHz with 4GB RAM.
122 | I did some very unscientific testing and the results were as follows:
123 |
124 |
125 |
Ruby 1.9.3-p286 using Kernel#rand: Generated 600,000 cuids in 8.16 seconds
126 |
Ruby 1.9.3-p286 using SecureRandom#random_number : Generated 600,000 cuids in 20.74 seconds
127 |
128 |
129 |
Each test was run three times and the mean is reported.
130 |
131 |
Analysis
132 |
133 |
The timestamp segment of the cuid is measured in milliseconds. In the faster test result, it generated about 74 cuids per millisecond. Even
134 | without considering the random segment of the cuid, one process could safely generate up to 1,679,615 unique cuids per millisecond (36^4 - 1) without a
135 | collision due to the counter segment.
136 |
137 |
System Requirements
138 |
139 |
This gem was developed under ruby1.9.3-p286 but is tested under multiple versions thanks to Travis CI.
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:
177 |
178 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
179 |
180 |
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.
'c' - identifies this as a cuid, and allows you to use it in html entity ids. The fixed value helps keep the ids sequential.
94 |
Timestamp
95 |
96 |
97 |
Measured in milliseconds since the epoch
98 |
Will rollover in May 2059
99 |
100 |
Counter
101 |
102 |
103 |
A single process might generate the same random string. The weaker the pseudo-random source, the higher the probability. That problem gets worse as processors get faster.
104 |
The counter will roll over after 1,679,615 cuids are generated by one process.
105 |
106 |
Client fingerprint
107 |
108 |
109 |
In Ruby, the first two characters are based on the process ID and the next two characters are based on the hostname. This is the same method used in the Node implementation.
110 |
111 |
Pseudo random number
112 |
113 |
114 |
By default, Ruby uses the Kernel#rand function, a Mersenne Twister PRNG.
115 |
On Ruby 1.9.2 and up, it can optionally use the SecureRandom library (which uses OpenSSL), but there is a significant performance cost.
116 |
117 |
118 |
119 |
Performance
120 |
121 |
My development system runs Ubuntu 12.04 on an Intel Wolfdale E5200 Dual Core 2.5GHz with 4GB RAM.
122 | I did some very unscientific testing and the results were as follows:
123 |
124 |
125 |
Ruby 1.9.3-p286 using Kernel#rand: Generated 600,000 cuids in 8.16 seconds
126 |
Ruby 1.9.3-p286 using SecureRandom#random_number : Generated 600,000 cuids in 20.74 seconds
127 |
128 |
129 |
Each test was run three times and the mean is reported.
130 |
131 |
Analysis
132 |
133 |
The timestamp segment of the cuid is measured in milliseconds. In the faster test result, it generated about 74 cuids per millisecond. Even
134 | without considering the random segment of the cuid, one process could safely generate up to 1,679,615 unique cuids per millisecond (36^4 - 1) without a
135 | collision due to the counter segment.
136 |
137 |
System Requirements
138 |
139 |
This gem was developed under ruby1.9.3-p286 but is tested under multiple versions thanks to Travis CI.
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:
177 |
178 |
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
179 |
180 |
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.
