tuid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f43c78e9fec58f4a0b33b62750bd2396e4d147c
+  data.tar.gz: 1c3de5f090b9126f04f62580201003327c453d7d
+SHA512:
+  metadata.gz: ec762736d6404dd98e10ece8a37ab3770077c708a57e4f3dae668d81d0b4d1d644b92b6e2f18e6555fdb8c988533d143395b3be02f795bc0507022151c58c3ba
+  data.tar.gz: 8e7d1dcdeb10e9bba783f7a0502be43c33f1f277a675274976eaf4cabaeef2a1eebf38c4250066ea6fadc0e8d5a68348e9d0d45488d5a9ee5a455216a22a81ec

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,17 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - jruby
+  - ruby-head
+  - jruby-head
+before_install: gem install bundler -v 1.10.6
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+addons:
+  code_climate:
+    repo_token: 3967a141e0a4910cba7c8b82d2dab094939483528ef42a9ab57ea4fdc50f4716

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, ethnicity, 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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tuid.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Seba Gamboa
+
+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 @@
+# Time based Unique IDentifiers
+
+[![Build Status](https://travis-ci.org/sagmor/tuid.svg?branch=master)](https://travis-ci.org/sagmor/tuid)
+[![Test Coverage](https://codeclimate.com/github/sagmor/tuid/badges/coverage.svg)](https://codeclimate.com/github/sagmor/tuid/coverage)
+[![Code Climate](https://codeclimate.com/github/sagmor/tuid/badges/gpa.svg)](https://codeclimate.com/github/sagmor/tuid)
+[![Inline docs](http://inch-ci.org/github/sagmor/tuid.svg?branch=master)](http://inch-ci.org/github/sagmor/tuid)
+
+TUIDs are values compatible with UUIDs
+
+They share the same base formati, so can be used instead of them.
+The main property of TUIDs is that they are prefixed by the time they
+were generated. Which allow them to be sorted and behave better on database
+indexes.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tuid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tuid
+
+## Usage
+
+```ruby
+# Generate a random TUID
+tuid = TUID.new
+#=> #<TUID 56342da3-7cc0-280d-f0b8-507634551518(2015-10-30 23:55:31 -0300)>
+
+# Get its generation time
+tuid.time
+#=> 2015-10-30 23:55:31 -0300
+
+# Turn it into a String
+tuid.to_s
+#=> "56342da3-7cc0-280d-f0b8-507634551518"
+
+# Generate a TUID from a UUID formated string
+tuid2 = TUID.new("56342da3-7cc0-280d-f0b8-507634551518")
+#=> #<TUID 56342da3-7cc0-280d-f0b8-507634551518(2015-10-30 23:55:31 -0300)>
+
+# And they can be compared
+tuid == tuid2
+#=> true
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sagmor/tuid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tuid"
+
+# 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/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/lib/tuid.rb

@@ -0,0 +1,108 @@
+require "tuid/version"
+require "securerandom"
+
+# TUID value.
+#
+# TUIDs are values compatible with UUID
+#
+# They share the same base format so can be used instead of them.
+# The main property of them is that they are prefixed by the time they
+# were generated. This allow them to be sorted and behave better on database
+# indexes.
+#
+class TUID
+
+  # TUID binary representation
+  attr_reader :bytes
+  include Comparable
+
+  # Initialize a new TUID
+  #
+  # @overload initialize
+  #     @return Random TUID based on the current time
+  #
+  # @overload initialize(data)
+  #     @param data [String] TUID string representation.
+  #     @return TUID object equivalent to the passed string
+  #
+  # @overload initialize(time)
+  #     @param time [Time] Reference time.
+  #     @return Random TUID using the given generation time.
+  def initialize(data=nil)
+    @bytes = case data
+    when TUID
+      data.bytes
+    when String
+      bytes_from_string(data)
+    when Time, NilClass
+      random_bytes_with_time(data || Time.now)
+    else
+      raise type_error(data, "invalid type")
+    end.freeze
+  end
+
+  # Compares two TUIDs.
+  #
+  # @return [-1,0,1] the compare result.
+  def <=>(other)
+    self.bytes <=> other.bytes
+  end
+
+  # Console friendly representation
+  def inspect
+    "#<#{self.class.name} #{to_s} (#{time.utc})>"
+  end
+
+  # Get the TUID in UUID string format.
+  #
+  # @return [String] formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
+  def to_s
+    "%08x-%04x-%04x-%04x-%04x%08x" % bytes.unpack("NnnnnN")
+  end
+  alias :to_str :to_s
+
+  # Extract the time at which the TUID was generated.
+  #
+  # @return [Time] the generation time.
+  def time
+    Time.at(*bytes.unpack("N"))
+  end
+
+  # Compare two TUID objects
+  def eql?(other)
+    other.instance_of?(self.class) && self == other
+  end
+
+  private
+
+    # Parse bytes from String
+    def bytes_from_string(string)
+      case string.length
+      when 16
+        string.frozen? ? string : string.dup
+      when 36
+        elements = string.split("-")
+        raise type_error(string, "malformed UUID representation") if elements.size != 5
+        [elements.join].pack('H32')
+      else
+        raise type_error(string, "invalid bytecount")
+      end
+    end
+
+    # Generate bytes string with the given time
+    def random_bytes_with_time(time)
+      bytes = [
+        time.to_i
+      ] + SecureRandom.random_bytes(12).unpack("nnnnN")
+      bytes[2] = (bytes[2] & 0x0fff) | 0x4000
+      bytes[3] = (bytes[3] & 0x3fff) | 0x8000
+
+      bytes.pack("NnnnnN")
+    end
+
+    # Create a formatted type error.
+    def type_error(source,error)
+      TypeError.new("Expected #{source.inspect} to cast to a #{self.class} (#{error})")
+    end
+
+end

data/lib/tuid/version.rb

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

data/tuid.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tuid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tuid"
+  spec.version       = TUID::VERSION
+  spec.authors       = ["Seba Gamboa"]
+  spec.email         = ["me@sagmor.com"]
+
+  spec.summary       = %q{Time based Unique IDentifierss}
+  spec.description   = %q{UUID compatible objects prefixed by time}
+  spec.homepage      = "https://github.com/sagmor/tuid"
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: tuid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Seba Gamboa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: UUID compatible objects prefixed by time
+email:
+- me@sagmor.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tuid.rb
+- lib/tuid/version.rb
+- tuid.gemspec
+homepage: https://github.com/sagmor/tuid
+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.1
+signing_key: 
+specification_version: 4
+summary: Time based Unique IDentifierss
+test_files: []