ruuid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12955371c15837c3d5bd2ab62753e04852114933
+  data.tar.gz: 154a406dce57289289633ca8107e24c372bde09f
+SHA512:
+  metadata.gz: 520286586d5dc145c9f5872ec9f24c07e16920350175f8541bb93757ea262aab4a91a62f8f06edc3effccd06bc76da4cb6f38c44a714ef391293e628d0b731ad
+  data.tar.gz: f3a64c3fc5840bb2b1bf89d8ebaa76a8f0432829d64ff4e2c713150233519336b84803842ca4b32f887605ebaaf2b7e12c83114204fddc6b01ed5506b0b27e76

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.2.2
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true

data/.yardopts

@@ -0,0 +1,7 @@
+--embed-mixin RUUID::Generator
+--no-private
+--protected
+-
+CODE_OF_CONDUCT.md
+LICENSE.txt
+README.md

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruuid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 HashRabbit, Inc.
+
+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,64 @@
+# RUUID
+
+[![Build Status](https://img.shields.io/travis/hashrabbit/ruuid.svg)][travis]
+
+RUUID (Ruby UUID) parses, generates, and represents [RFC 4122][RFC 4122]
+universally unique identifiers. Currently, only v4 UUIDs can be generated by
+this library.
+
+[travis]: https://travis-ci.org/hashrabbit/ruuid
+[RFC 4122]: https://www.ietf.org/rfc/rfc4122.txt
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruuid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruuid
+
+## Example Usage
+
+```ruby
+require 'ruuid'
+
+uuid = RUUID.generate
+# => <RUUID::UUID:0x70168845476220 data=7cc9f80c-c2e2-4d03-ad35-1e3112dc77de>
+
+uuid.version
+# => 4
+
+uuid.to_s
+# => "7cc9f80c-c2e2-4d03-ad35-1e3112dc77de"
+uuid.to_s(:compact)
+# => "7cc9f80cc2e24d03ad351e3112dc77de"
+```
+
+See [API documentation](http://www.rubydoc.info/docs/ruuid) for
+additional information.
+
+## 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).
+
+## Contributing
+
+1. Fork it ( https://github.com/hashrabbit/ruuid/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,9 @@
+require 'bundler/gem_tasks'
+
+require 'yard'
+YARD::Rake::YardocTask.new(:doc)
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pry'
+require 'ruuid'
+
+Pry.start

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/yard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/bin/yardoc

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yardoc')

data/lib/ruuid.rb

@@ -0,0 +1,23 @@
+require 'ruuid/version'
+
+require 'ruuid/formatter'
+require 'ruuid/generator'
+require 'ruuid/generators/v4'
+require 'ruuid/parser'
+require 'ruuid/uuid'
+
+module RUUID
+  extend self
+
+  class InvalidUUIDError < StandardError; end
+
+  attr_accessor :default_generator
+  self.default_generator = Generators::V4
+
+  attr_accessor :default_format
+  self.default_format = :canonical
+
+  def generate
+    default_generator.generate
+  end
+end

data/lib/ruuid/formatter.rb

@@ -0,0 +1,19 @@
+module RUUID
+  # @private
+  module Formatter
+    extend self
+
+    HEX_FORMAT = 'H8 H4 H4 H4 H12'.freeze
+
+    def format(data, format = RUUID.default_format)
+      parts = data.unpack(HEX_FORMAT)
+
+      case format
+      when :canonical then parts.join('-')
+      when :compact   then parts.join
+      else
+        raise ArgumentError, "`#{format.inspect}' format not supported. Supported formats are: :canonical and :compact"
+      end
+    end
+  end
+end

data/lib/ruuid/generator.rb

@@ -0,0 +1,55 @@
+require 'singleton'
+
+module RUUID
+  # Generator is responsible for generating new UUIDs. Implementors can
+  # include and override methods to provide new UUID variants.
+  module Generator
+    def self.included(base)
+      super
+      base.extend ClassMethods
+      base.include Singleton
+    end
+
+    module ClassMethods
+      def version(value)
+        instance.version = value
+      end
+
+      def source(value)
+        instance.source = value
+      end
+
+      def generate
+        instance.generate
+      end
+    end # ClassMethods
+
+    attr_accessor :version, :source
+
+    def initialize
+      @version = 0
+    end
+
+    def generate
+      UUID.from_data(masked_bytes)
+    end
+
+    private
+
+    def raw_bytes
+      unless source.respond_to?(:call)
+        raise NotImplementedError, "#{self.class} does not specify a data source"
+      end
+      source.call.bytes
+    end
+
+    def masked_bytes
+      raw_bytes.tap { |bytes|
+        # Mask version
+        bytes[6] = (bytes[6] & 0x0f) | (version << 4)
+        # Mask variant
+        bytes[8] = (bytes[8] & 0x3f) | 0x80
+      }.collect(&:chr).join
+    end
+  end # Generator
+end # RUUID

data/lib/ruuid/generators/v4.rb

@@ -0,0 +1,12 @@
+require 'securerandom'
+
+module RUUID
+  module Generators
+    class V4
+      include Generator
+
+      version 4
+      source ->{ SecureRandom.random_bytes(16) }
+    end
+  end
+end

data/lib/ruuid/parser.rb

@@ -0,0 +1,19 @@
+module RUUID
+  # @private
+  module Parser
+    extend self
+
+    BLACKLIST = /[^a-f0-9]/i
+
+    def parse(string)
+      string = sanitize(string)
+      [string].pack('H*')
+    end
+
+    private
+
+    def sanitize(string)
+      string.gsub(BLACKLIST, '')
+    end
+  end # Parser
+end # RUUID

data/lib/ruuid/uuid.rb

@@ -0,0 +1,84 @@
+module RUUID
+  class UUID
+    include Comparable
+
+    # @private
+    def self.from_data(data)
+      uuid = allocate
+      uuid.instance_variable_set :@data, data.dup.freeze
+      uuid.validate
+      uuid
+    end
+
+    def self.parse(string)
+      from_data(Parser.parse(string))
+    end
+
+    # @private
+    def initialize
+      raise RuntimeError, 'RUUID::UUID.new is not allowed. Use RUUID.generate instead.'
+    end
+
+    # @private
+    attr_reader :data
+
+    def to_s(format = RUUID.default_format)
+      Formatter.format(data, format)
+    end
+    alias_method :to_str, :to_s
+
+    def to_json(*args)
+      to_s(*args).to_json
+    end
+
+    def inspect
+      "<#{self.class}:0x#{object_id} data=#{to_s}>"
+    end
+
+    # @private
+    def marshal_dump
+      data
+    end
+
+    # @private
+    def marshal_load(data)
+      @data = data.dup.freeze
+      validate
+    end
+
+    def hash
+      data.hash
+    end
+
+    def ==(other)
+      return super unless other.respond_to?(:data)
+      data == other.data
+    end
+    alias_method :eql?, :==
+
+    def ===(other)
+      return super unless other.respond_to?(:to_str)
+      to_str === other.to_str
+    end
+
+    def <=>(other)
+      return super unless other.respond_to?(:data)
+      data <=> other.data
+    end
+
+    def version
+      data.bytes[6] >> 4
+    end
+
+    # @private
+    def validate
+      unless data.length == 16
+        raise InvalidUUIDError, 'Invalid UUID length'
+      end
+
+      unless data.bytes[8] >> 6 == 2
+        raise InvalidUUIDError, 'Invalid UUID variant'
+      end
+    end
+  end # UUID
+end # RUUID

data/lib/ruuid/version.rb

@@ -0,0 +1,3 @@
+module RUUID
+  VERSION = '0.1.0'.freeze
+end

data/ruuid.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruuid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruuid'
+  spec.version       = RUUID::VERSION
+  spec.authors       = ['Gabe Evans']
+  spec.email         = ['gabe@ga.be']
+
+  spec.summary       = %q{RUUID (Ruby UUID) parses, generates, and represents RFC 4122 universally unique identifiers.}
+  spec.homepage      = 'https://github.com/hashrabbit/ruuid'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = %w[lib]
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'pry', '~> 0.10.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'simplecov', '~> 0.10.0'
+  spec.add_development_dependency 'yard', '~> 0.8.7'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: ruuid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabe Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+description: 
+email:
+- gabe@ga.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- bin/yard
+- bin/yardoc
+- lib/ruuid.rb
+- lib/ruuid/formatter.rb
+- lib/ruuid/generator.rb
+- lib/ruuid/generators/v4.rb
+- lib/ruuid/parser.rb
+- lib/ruuid/uuid.rb
+- lib/ruuid/version.rb
+- ruuid.gemspec
+homepage: https://github.com/hashrabbit/ruuid
+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.5
+signing_key: 
+specification_version: 4
+summary: RUUID (Ruby UUID) parses, generates, and represents RFC 4122 universally
+  unique identifiers.
+test_files: []
+has_rdoc: