hakusho 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 413f789eff55357b7cdd8780d423b0a8f7c59853
+  data.tar.gz: 422b2240659bbc27b93678c1aeb58d2d3e673355
+SHA512:
+  metadata.gz: bc3301a98f0aa9f00880f0751e75ba20a986752c51340f648ee2bf07ed3aba145f11ea7b51e2c3ef9a428753ac165f0cc915841aca5dfa85f3c2a7ef0dbc5260
+  data.tar.gz: ccc6b93a5d1f039548e603397a5c0e5daf6aa77422dc27e2604d247bdad25324c89e1499c703c59fc83177bb664261d79b82163aca1d3574ea916c194cbcae40

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc/
+/_yardoc/
+/Gemfile.lock
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :benchmark do
+  # the champions
+  gem "ruby-uuid"
+  gem "uuidtools"
+  gem "uuid4r"
+
+  # the ref
+  gem "benchmark-ips"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Blake Imsland
+
+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,144 @@
+# Hakusho
+
+A fast uuid generation and parsing library.  Currently supports UUID versions 3, 4, and 5.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "hakusho"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hakusho
+
+## Usage
+
+### Parsing
+
+```ruby
+uuid = Hakusho.parse("6ba7b811-9dad-11d1-80b4-00c04fd430c8")
+```
+
+### Generation
+
+#### Version 3 (MD5)
+
+```ruby
+ns   = Hakusho.parse("6ba7b811-9dad-11d1-80b4-00c04fd430c8")
+uuid = Hakusho.create_md5(ns, "this is a pretty rad stirng")
+```
+
+### Version 4 (Random)
+
+```ruby
+uuid = Hakusho.create_random
+```
+
+### Version 5 (SHA1)
+
+```ruby
+ns   = Hakusho.parse("6ba7b811-9dad-11d1-80b4-00c04fd430c8")
+uuid = Hakusho.create_sha1(ns, "this is a pretty rad stirng")
+```
+
+## Benchmarks
+
+These were created by running `bin/benchmark`.
+
+### UUID Version 3
+
+```
+Calculating -------------------------------------
+             hakusho     7.672k i/100ms
+           uuidtools     1.056k i/100ms
+           ruby-uuid     1.709k i/100ms
+              uuid4r     2.045k i/100ms
+-------------------------------------------------
+             hakusho     86.471k (± 3.3%) i/s -    437.304k
+           uuidtools     10.852k (± 3.5%) i/s -     54.912k
+           ruby-uuid     17.866k (± 3.4%) i/s -     90.577k
+              uuid4r     21.429k (± 3.1%) i/s -    108.385k
+
+Comparison:
+             hakusho:    86471.2 i/s
+              uuid4r:    21429.2 i/s - 4.04x slower
+           ruby-uuid:    17865.8 i/s - 4.84x slower
+           uuidtools:    10852.4 i/s - 7.97x slower
+```
+
+### UUID Version 4
+
+```
+Calculating -------------------------------------
+           fast_uuid    12.581k i/100ms
+           uuidtools     2.584k i/100ms
+           ruby-uuid     2.829k i/100ms
+              uuid4r     3.396k i/100ms
+        securerandom    10.522k i/100ms
+-------------------------------------------------
+           fast_uuid    156.784k (± 3.3%) i/s -    792.603k
+           uuidtools     27.215k (± 3.1%) i/s -    136.952k
+           ruby-uuid     29.793k (± 3.9%) i/s -    149.937k
+              uuid4r     36.125k (± 3.1%) i/s -    183.384k
+        securerandom    129.485k (± 3.2%) i/s -    652.364k
+
+Comparison:
+           fast_uuid:   156783.6 i/s
+        securerandom:   129485.5 i/s - 1.21x slower
+              uuid4r:    36125.3 i/s - 4.34x slower
+           ruby-uuid:    29792.8 i/s - 5.26x slower
+           uuidtools:    27214.7 i/s - 5.76x slower
+```
+
+### UUID Version 5
+
+```
+Calculating -------------------------------------
+             hakusho     7.406k i/100ms
+           uuidtools     1.032k i/100ms
+           ruby-uuid     1.662k i/100ms
+              uuid4r     2.029k i/100ms
+-------------------------------------------------
+             hakusho     82.308k (± 2.9%) i/s -    414.736k
+           uuidtools     10.669k (± 3.0%) i/s -     53.664k
+           ruby-uuid     17.515k (± 3.1%) i/s -     88.086k
+              uuid4r     21.395k (± 2.6%) i/s -    107.537k
+
+Comparison:
+             hakusho:    82308.0 i/s
+              uuid4r:    21394.9 i/s - 3.85x slower
+           ruby-uuid:    17514.8 i/s - 4.70x slower
+           uuidtools:    10669.1 i/s - 7.71x slower
+```
+
+## TODO
+
+* Tests (non-existant)
+* Better documentation
+* Version 1 & 2 UUIDs
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Credits
+
+* [Matthew Callis](https://github.com/matthewcallis) -- For his inspiring name and design input
+* [Ruby on Ales](https://twitter.com/rbonales) -- For the liquid courage to get this done
+
+## Contributing
+
+1. Fork it ( https://github.com/robotblake/hakusho/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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/benchmark

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+# the champions
+require "uuid"
+require "uuidtools"
+require "uuid4r"
+
+# the challenger
+require "hakusho"
+
+# the referee
+require "benchmark/ips"
+
+# setup
+uuid = "6ba7b811-9dad-11d1-80b4-00c04fd430c8"
+str  = "benchmarking things"
+
+# v3 benchmark
+puts "UUID Version 3\n"
+Benchmark.ips do |x|
+  # Version 3
+  x.report("hakusho")   { Hakusho.create_md5(Hakusho.parse(uuid), str).to_s }
+  x.report("uuidtools") { UUIDTools::UUID.md5_create(UUIDTools::UUID.parse(uuid), str).to_s }
+  x.report("ruby-uuid") { UUID.create_md5(str, UUID.parse(uuid)).to_s }
+  x.report("uuid4r")    { UUID4R.uuid_v3("ns:URL", str) }
+  x.compare!
+end
+
+# v4 benchmark
+puts "UUID Version 4\n"
+Benchmark.ips do |x|
+  # Version 4
+  x.report("fast_uuid")    { Hakusho.create_random.to_s }
+  x.report("uuidtools")    { UUIDTools::UUID.random_create.to_s }
+  x.report("ruby-uuid")    { UUID.create_random.to_s }
+  x.report("uuid4r")       { UUID4R.uuid_v4 }
+  x.report("securerandom") { SecureRandom.uuid }
+  x.compare!
+end
+
+# v5 benchmark
+puts "UUID Version 5\n"
+Benchmark.ips do |x|
+  # Version 5
+  x.report("hakusho")   { Hakusho.create_sha1(Hakusho.parse(uuid), str).to_s }
+  x.report("uuidtools") { UUIDTools::UUID.sha1_create(UUIDTools::UUID.parse(uuid), str).to_s }
+  x.report("ruby-uuid") { UUID.create_sha1(str, UUID.parse(uuid)).to_s }
+  x.report("uuid4r")    { UUID4R.uuid_v5("ns:URL", str) }
+  x.compare!
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+require "hakusho"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -euo pipefail
+
+bundle install --path vendor/bundle --binstubs vendor/bundle/bin

data/hakusho.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hakusho/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hakusho"
+  spec.version       = Hakusho::VERSION
+  spec.authors       = ["Blake Imsland"]
+  spec.email         = ["blake@retroco.de"]
+
+  spec.summary       = "fast uuid generation and parsing library"
+  spec.description   = "fast uuid generation and parsing library"
+  spec.homepage      = "https://github.com/robotblake/hakusho"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.4"
+
+  spec.add_development_dependency "pry-byebug", "~> 3.0.1"
+  spec.add_development_dependency "guard-rspec", "~> 4.5.0"
+end

data/lib/hakusho.rb

@@ -0,0 +1,69 @@
+require "hakusho/version"
+require "securerandom"
+
+class Hakusho
+  FORMAT = /\A(\h{8})-(\h{4})-([1-5]\h{3})-(\h{4})-(\h{12})\Z/i
+  VERSIONS = [1, 2, 3, 4, 5]
+
+  attr_reader :raw
+
+  def initialize(bytes)
+    @raw = bytes
+  end
+
+  def version
+    @raw.getbyte(6) >> 4
+  end
+
+  def variant
+    byte = @raw.getbyte(8)
+    return "Reserved"  if byte & 0x80 == 0x00
+    return "RFC4122"   if byte & 0xc0 == 0x80
+    return "Microsoft" if byte & 0xe0 == 0xc0
+    return "Future"    if byte & 0xe0 == 0xe0
+  end
+
+  def valid?
+    VERSIONS.include?(version) && variant
+  end
+
+  def to_s
+    @raw.unpack('H8H4H4H4H12').join(?-)
+  end
+
+  def self.parse(str)
+    if FORMAT =~ str
+      self.new([
+        str.byteslice(0, 8),
+        str.byteslice(9, 4),
+        str.byteslice(14, 4),
+        str.byteslice(19, 4),
+        str.byteslice(24, 12),
+      ].pack('H8H4H4H4H12'))
+    end
+  end
+
+  def self.create_md5(ns, str)
+    create_hash(Digest::MD5, ns, str, 0x30)
+  end
+
+  def self.create_random
+    create(SecureRandom.random_bytes(16), 0x40)
+  end
+
+  def self.create_sha1(ns, str)
+    create_hash(Digest::SHA1, ns, str, 0x50)
+  end
+
+  private
+
+  def self.create_hash(klass, ns, str, version)
+    create(klass.digest("#{ns.raw}#{str}").byteslice(0, 16), version)
+  end
+
+  def self.create(bytes, version)
+    bytes.setbyte(6, (bytes.getbyte(6) & 0x0f) | version)
+    bytes.setbyte(8, (bytes.getbyte(8) & 0x3f) | 0x80)
+    self.new(bytes)
+  end
+end

data/lib/hakusho/version.rb

@@ -0,0 +1,3 @@
+class Hakusho
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: hakusho
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Blake Imsland
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+description: fast uuid generation and parsing library
+email:
+- blake@retroco.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/benchmark
+- bin/console
+- bin/setup
+- hakusho.gemspec
+- lib/hakusho.rb
+- lib/hakusho/version.rb
+homepage: https://github.com/robotblake/hakusho
+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.4.6
+signing_key: 
+specification_version: 4
+summary: fast uuid generation and parsing library
+test_files: []