lazy-uuid 0.5.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2
+  - jruby-9
+before_install: gem install bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Gem dependencies and information defined in lazy-uuid.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,17 @@
+The MIT License (MIT)
+=====================
+
+*Copyright (c) 2016*
+
+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,100 @@
+Lazy UUID
+=========
+
+[![Travis CI](https://travis-ci.org/bluepixelmike/lazy-uuid.svg)](https://travis-ci.org/bluepixelmike/lazy-uuid)
+[![Code Climate](https://codeclimate.com/github/bluepixelmike/lazy-uuid/badges/gpa.svg)](https://codeclimate.com/github/bluepixelmike/lazy-uuid)
+[![Test Coverage](https://codeclimate.com/github/bluepixelmike/lazy-uuid/badges/coverage.svg)](https://codeclimate.com/github/bluepixelmike/lazy-uuid/coverage)
+[![Issue Count](https://codeclimate.com/github/bluepixelmike/lazy-uuid/badges/issue_count.svg)](https://codeclimate.com/github/bluepixelmike/lazy-uuid)
+[![Documentation](https://inch-ci.org/github/bluepixelmike/lazy-uuid.svg?branch=master)](http://www.rubydoc.info/github/bluepixelmike/lazy-uuid/master)
+
+Small gem for creating and using UUIDs (universally unique identifier).
+It has no external dependencies.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lazy-uuid'
+```
+
+Or to your gemspec:
+
+```ruby
+spec.add_dependency 'lazy-uuid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lazy-uuid
+
+Usage
+-----
+
+### Script Usage
+
+Include the `Uuid` class by doing:
+
+```ruby
+require 'lazy-uuid'
+```
+
+To generate a new UUID:
+
+```ruby
+uuid = Uuid.generate
+```
+
+To create a new UUID from a value:
+
+```ruby
+value = "\xde\x30\x5d\x54\x75\xb4\x43\x1b\xad\xb2\xeb\x6b\x9e\x54\x60\x14"
+uuid = Uuid.new(value)
+```
+
+To parse an existing UUID string:
+```ruby
+str = 'de305d54-75b4-431b-adb2-eb6b9e546014'
+uuid = Uuid.parse(str)
+```
+
+Use `#to_s` to generate a human-readable representation of the UUID.
+
+### Command-line Usage
+
+Run the `generate-uuid` script to generate and output a UUID.
+
+    $ generate-uuid
+    c06b98c9-4cd6-4265-97ef-3299027cde88
+
+Or pass a number as an argument to generate multiple UUIDs.
+
+    $ generate-uuid 5
+    cf803c2a-a04b-45ff-be3b-294b70a5d8d5
+    4e5a5172-79f4-4cd2-9649-fc5f6b682679
+    62b4226d-23fb-4e5f-856b-1dfbf0448719
+    2d259f9d-bd4d-4c56-b3d2-71305f5f73d9
+    6d5755b0-78fa-4bfe-a8e5-0b16fb941e8a
+
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install developer dependencies.
+Then, run `bundle exec rake test` to run the tests.
+It's recommended that you run `bundle exec rake inspect` to run inspections.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+`bundle exec rake doc` will generate documentation.
+
+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`.
+This will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Contributing
+------------
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/bluepixelmike/lazy-uuid).

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler/gem_tasks'
+require 'reek/rake/task'
+require 'rubocop/rake_task'
+require 'rubocop'
+require 'rspec/core/rake_task'
+require 'yard'
+
+task :default => [:build, :test]
+task :inspect => [:reek, :rubocop]
+
+RSpec::Core::RakeTask.new(:spec)
+task :test => :spec
+
+Reek::Rake::Task.new do |task| # :reek
+  task.name = :reek
+  task.source_files = 'lib/**/*.rb'
+  task.fail_on_error = false
+end
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  task.fail_on_error = false
+end
+
+YARD::Rake::YardocTask.new do |task| # :yard
+  task.files = %w(lib/**/*.rb - *.md)
+end
+task :doc => :yard

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'lazy-uuid'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/generate-uuid

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'lazy-uuid'
+
+count = ARGV.any? ? ARGV.first.to_i : 1
+count.times { puts Uuid.generate.to_s }

data/bin/setup

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

data/lazy-uuid.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lazy-uuid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lazy-uuid'
+  spec.version       = LazyUuid::VERSION
+  spec.authors       = ['Michael Miller']
+  spec.email         = ['bluepixelmike@gmail.com']
+
+  spec.summary       = %q{Small gem for creating and using UUIDs (universally unique identifier).}
+  spec.description   = %q{Generates RFC 4122 compliant UUIDs.
+These UUIDs can be treated as their raw byte representation or as human-readable strings.}
+  spec.homepage      = 'https://github.com/bluepixelmike/lazy-uuid'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'bin'
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(%r{^bin/.*uuid}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'factory_girl', '~> 4.0'
+  spec.add_development_dependency 'reek', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.38.0'
+  spec.add_development_dependency 'codeclimate-test-reporter' unless RUBY_PLATFORM == 'java'
+  spec.add_development_dependency 'yard'
+end

data/lib/lazy-uuid.rb

@@ -0,0 +1,6 @@
+# Simple UUID functionality.
+module LazyUuid
+end
+
+require_relative 'lazy-uuid/version'
+require_relative 'lazy-uuid/uuid'

data/lib/lazy-uuid/uuid.rb

@@ -0,0 +1,251 @@
+require 'securerandom' # For generating new UUIDs.
+
+# Universally unique identifier.
+# Items with distinct different UUIDs should be different entities.
+# Items with the same UUID should be the same entity.
+# @note The naming scheme used for this class is as follows:
+#   * +uuid+     - An instance of this class.
+#   * +value+    - Packed string, not human readable. 16 bytes in length.
+#   * +uuid_str+ - Formatted string, human readable. Formatted as xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (8-4-4-4-12).
+class Uuid
+  include Comparable
+
+  # Raw, packed byte string containing the UUID's value.
+  # @return [String] Packed string, 16 bytes in length.
+  attr_reader :value
+
+  # Creates a UUID or one from an existing value.
+  # @param value [String] Packed bytes with the UUID's value.
+  #   The value must be a string of 16 bytes (128 bits).
+  # @see generate
+  def initialize(value)
+    value_str = value.to_s
+    fail ArgumentError, 'Packed UUID value must be 16 bytes.' unless value_str.length == 16
+
+    # Get a copy to prevent external processes modifying the value.
+    @value = value_str.dup
+
+    # Prevent modification.
+    @value.freeze
+  end
+
+  class << self
+
+    # Generates a new (and random) UUID
+    # @return [UUID] Newly generated UUID.
+    def generate
+      # A built-in method from Ruby to generate a valid UUID is SecureRandom.uuid.
+      # However, it returns it as a formatted string.
+      # The formatted string has to be converted to a packed string before it can be used.
+      uuid_str = SecureRandom.uuid
+      value    = pack_uuid_str(uuid_str)
+      Uuid.new(value)
+    end
+
+    # Determines whether a string contains a valid formatted UUID.
+    # @param uuid_str [String] String to check.
+    # @return [true] The string contains a valid formatted UUID.
+    # @return [false] The string does not contain a valid UUID.
+    def valid_str?(uuid_str)
+      if uuid_str.is_a? String
+        # Check the formatting.
+        # Note that the validity of the UUID isn't checked.
+        !!/^\A[0-9a-f]{8}(-?)[0-9a-f]{4}\1[0-9a-f]{4}\1[0-9a-f]{4}\1[0-9a-f]{12}\z$/i.match(uuid_str)
+      else
+        # A string wasn't passed in.
+        fail ArgumentError
+      end
+    end
+
+    # Converts a UUID formatted as a string into its packed byte representation.
+    # @param uuid_str [String] UUID in string form.
+    # @return [String] Packed string, 16 bytes in length.
+    # @!visibility private
+    def pack_uuid_str(uuid_str)
+      # 1) Strip hyphens.
+      # 2) Collect 2 characters.
+      # 3) Convert 2 characters from hex to numeric.
+      # 4) Pack the numeric values into bytes in a string.
+      uuid_str.delete('-').scan(/../).map(&:hex).pack('C16')
+    end
+
+    # Creates a UUID object from its string representation.
+    # @param uuid_str [String] UUID in string form.
+    #   The string must be in the form: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (8-4-4-4-12)
+    # @note Casing does not matter for a-f.
+    # @return [Uuid] Parsed UUID from the string.
+    # @return [nil] The string doesn't have a properly formatted UUID.
+    # @note Dashes may be omitted from the string.
+    #   This allows strings of 32 hexadecimal characters.
+    def parse(uuid_str)
+      if valid_str?(uuid_str)
+        # Properly formatted UUID string.
+        # Pack the UUID into a byte string and return a new instance.
+        value = pack_uuid_str(uuid_str)
+        Uuid.new(value)
+      else
+        # Not properly formatted.
+        nil
+      end
+    end
+  end
+
+  # Checks for hash equality of two UUIDs.
+  # @param other [Uuid] Other UUID to compare against.
+  # @return [true] The UUIDs are equal.
+  # @return [false] The UUIDs are different.
+  # @note This method compares only {Uuid} instances.
+  #   +false+ will be returned if +other+ is not a {Uuid}.
+  def eql?(other)
+    other.is_a?(Uuid) && eq_packed(other.value)
+  end
+
+  # Checks if two UUIDs have the same value.
+  # @param other [Uuid, String] Other object to check against.
+  # @return [true] The UUIDs are equal.
+  # @return [false] The UUIDs are different.
+  def ==(other)
+    case other
+      when Uuid
+        # Compare two UUID instances.
+        eq_packed(other.value)
+
+      when String
+        if other.length == 16
+          # Compare against a packed string
+          eq_packed(other)
+
+        else
+          # Compare against a formatted string
+          eq_formatted(other)
+        end
+
+      else
+        # Everything else can't be equated.
+        false
+    end
+  end
+
+  # Compares two UUIDs to each other to determine which is lower.
+  # @param other [Uuid, String] Other object to compare against.
+  # @return [-1] The left UUID is smaller.
+  # @return [0] The UUIDs are the same.
+  # @return [1] The right UUID is smaller.
+  # @return [nil] The right side isn't a UUID.
+  def <=>(other)
+    case other
+      when Uuid
+        # Compare two UUID instances.
+        cmp_packed(other.value)
+
+      when String
+        if other.length == 16
+          # Compare against a packed string
+          cmp_packed(other)
+
+        else
+          # Compare against a formatted string
+          cmp_formatted(other)
+        end
+
+      else
+        # Everything else can't be compared.
+        nil
+    end
+  end
+
+  # Produces a hash value of the UUID.
+  # @return [Fixnum]
+  def hash
+    @value.hash
+  end
+
+  # Produces the string representation of the UUID.
+  # @param dashes [Boolean] +true+ to put dashes in the output (standard format),
+  #   +false+ to not put dashes.
+  # @return [String] UUID in string form: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (8-4-4-4-12)
+  def to_s(dashes = true)
+    bytes = @value.bytes
+    if dashes
+      sprintf('%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x', *bytes)
+    else
+      sprintf('%02x' * 16, *bytes)
+    end
+  end
+
+  # Empty UUID.
+  # @return [Uuid] UUID with the value 00000000-0000-0000-0000-000000000000.
+  DEFAULT = Uuid.new("\x0" * 16).freeze
+
+  private
+
+  # Checks for equality with a packed string.
+  # @param value [String] Packed string.
+  # @return [true] The packed string contains an identical value.
+  # @return [false] The packed string contains a different value.
+  def eq_packed(value)
+    # Compare the bytes in each string.
+    # Byte comparison *must* be used, since == uses character comparison.
+    # Bytes != characters when encoding is involved.
+    @value.each_byte.with_index do |byte_a, index|
+      byte_b = value.getbyte(index)
+      break false if byte_a != byte_b # Abort enumeration with false value.
+      break true if index == 15 # Return true on last iteration when bytes are the same.
+    end
+  end
+
+  # Checks for equality with a UUID formatted as a string.
+  # @param uuid_str [String] UUID formatted as a string.
+  # @return [true] The formatted string contains an identical value.
+  # @return [false] The formatted string contains a different value.
+  def eq_formatted(uuid_str)
+    klass = self.class
+    if klass.valid_str?(uuid_str)
+      # Format is valid.
+      # Compare it to packed string.
+      value = klass.pack_uuid_str(uuid_str)
+      eq_packed(value)
+    else
+      # Invalid format can't be equal.
+      false
+    end
+  end
+
+  # Compares the ordering with a packed string.
+  # @param value [String] Packed string.
+  # @return [-1] The left UUID is smaller.
+  # @return [0] The UUIDs are the same.
+  # @return [1] The right UUID is smaller.
+  # @return [nil] The right side isn't a UUID.
+  def cmp_packed(value)
+    # Compare the bytes in each string.
+    # Byte comparison *must* be used, since <=> uses character comparison.
+    # Bytes != characters when encoding is involved.
+    @value.bytes.each_with_index do |byte_a, index|
+      byte_b = value.getbyte(index)
+      result = byte_a <=> byte_b
+      break result if result != 0 # Abort enumeration with result.
+      break 0 if index == 15 # Return 0 on last byte if they're the same.
+    end
+  end
+
+  # Checks for equality with a UUID formatted as a string.
+  # @param uuid_str [String] UUID formatted as a string.
+  # @return [-1] The left UUID is smaller.
+  # @return [0] The UUIDs are the same.
+  # @return [1] The right UUID is smaller.
+  # @return [nil] The right side isn't a UUID.
+  def cmp_formatted(uuid_str)
+    klass = self.class
+    if klass.valid_str?(uuid_str)
+      # Format is valid.
+      # Compare it to packed string.
+      value = klass.pack_uuid_str(uuid_str)
+      cmp_packed(value)
+    else
+      # Invalid format can't be equal.
+      nil
+    end
+  end
+
+end