tou 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5d9d7a99bc5ce496500024014a1ecca74ce68002a5073d954fb5f0f25e88b8f
+  data.tar.gz: 7cc1690d42a037b5b9a19f9638185931d7a8cb823d8b00013e6814cf509a9c72
+SHA512:
+  metadata.gz: 5e9ba7d181193702dd51794845ff7d30703ff7ce8e57cce83bbda37e13f3effd9fc8900a6073fdc7330649067c000a23814fdbe29c8b353814560d1594a05ea5
+  data.tar.gz: bca3eee3885888f1ff4b90e790bf0f702066846d416ab285f808b977f5c5a05cd1e08aa497635c432509689894bfc8eb59e6964140e811cce0e15b9af1b5783c

data/.gitignore

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

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 2.7

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@julik.nl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tou.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Julik Tarkhanov
+
+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,117 @@
+# Tou
+
+`Tou`, short for **Time-Ordered-UUID**, is a time-ordered unique identifier scheme. It produces bytes which are compatible with UUIDv4 - the most common UUID format at the moment. While it looks identical to a usual UUIDv4 and will be accepted by all the systems that accept those UUIDs, it has a number of useful properties:
+
+* It starts with the current number of microseconds, packed in network byte order. This means that the UUIDs will sort by byte value in time-ascending order
+* It uses 7 bytes of the whole number of microseconds out of 8, giving enough capacity until year 4253
+* The rest of the UUID is filled with random bits
+* The UUID still has the correct version (4) and variant (1) to be recognized as a UUIDv4
+
+The usage of such UUIDs has some neat properties:
+
+* They sort better in databases using bytes for UUID storage. Iterative SELECTs on large datasets will be much more pleasant.
+* They will likely compose into more efficient B-trees in database indexes
+* They sort chronologically
+* The timestamp can be reconstructed from the UUID, and stays relatively precise
+* Any system that accepts UUIDv4 identifiers will also accept Tou identifiers
+* ...which means that you do not need, say, Postgres extensions to use UUIDv7
+
+## Usage
+
+```ruby
+Tou.uuid #=> "061a417b-0e60-4009-9822-72d241ef27d6"
+```
+
+Not much to it, really.
+
+## Spec, layout in storage/memory
+
+The Tou is laid out as follows (in its byte representation):
+
+```
+ 0                   1                   2                   3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                               mus                             |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|          mus                  |  ver  |  mus  |   random      |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|var|                       random                              |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                           random                              |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+
+mus:
+   56-bit big-endian unsigned number of the Unix Epoch timestamp in
+   microseconds. Occupies 48 bits (0 through 47 in octets 0-5) and
+   4 bits (53 through 57 in octet 6).
+
+ver:
+   The 4-bit version field as defined by Section 4.2 of RFC9562,
+   set to 0b0100 (4). Occupies bits 48 through 52.
+
+random:
+   The 70 bits of pseudorandom data to provide uniqueness as
+   per Section 6.9 of RFC9562 and/or an optional counter to guarantee
+   additional monotonicity as per Section 6.2 of RFC9562. 
+   Occupies bits 49 through 63 and 66 through 127 of
+   octets 7 to 15 
+
+var:
+   The 2-bit variant field as defined by Section 4.1 of RFC9562,
+   set to 0b10. Occupies bits 64 and 65 of octet 8.
+
+```
+
+Compare this to the UUIDv4 layout:
+
+```
+ 0                   1                   2                   3
+ 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                           random_a                            |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|          random_a             |  ver  |       random_b        |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|var|                       random_c                            |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+|                           random_c                            |
++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tou'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install tou
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, which 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 at https://github.com/cheddar-me/tou. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/cheddar-me/tou/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tou project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cheddar-me/tou/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tou"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/tou/generator.rb

@@ -0,0 +1,15 @@
+module Tou
+  # When included into an ActiveRecord, will generate a TOU and prefill it
+  # into the "id" attribute if it is blank. Add this module to your records
+  # to set their IDs using Tou.
+  module Generator
+    def self.included(into)
+      into.before_validation :generate_and_write_touid!
+      super
+    end
+
+    def generate_and_write_touid!
+      write_attribute("id", Tou.uuid) if read_attribute("id").blank?
+    end
+  end
+end

data/lib/tou/version.rb

@@ -0,0 +1,3 @@
+module Tou
+  VERSION = "0.1.0"
+end

data/lib/tou.rb

@@ -0,0 +1,71 @@
+require "tou/version"
+require "securerandom"
+
+# A generator for time-ordered UUIDs
+module Tou
+  autoload :VERSION, __dir__ + "/tou/version.rb"
+  autoload :Generator, __dir__ + "/tou/generator.rb"
+
+  # Generates the bag of 16 bytes with UUID in binary form. This is not the
+  # canonical representation but can be converted into one.
+  #
+  # @param random[#bytes] Source of randomness. Normally SecureRandom will be used, but it can be
+  #   replaced by a mock or a `Random` object with a known seed, for testing or speed.
+  # @param time[#to_f] A time value that is convertible to a floating-point number of seconds since epoch
+  # @return [String] in binary encoding
+  def self.uuid_bytes(random: SecureRandom, time: Time.now)
+    # Use microseconds for the timestamp
+    epoch_micros = (time.to_f * 1_000_000).round
+    # Encode an 8-byte unsigned big-endian uint, and skip the first byte since it's 0, so we're left with 7 bytes.
+    # This gives us sufficient timestamp resolution to last us into year
+    # This will limit our timestamp to the year 4307.
+    # Q> : 64 bit unsigned big-endian int
+    # We want more significant bytes first for better sorting in Postgres
+    epoch_micros_unsigned_uint_bytes = [epoch_micros].pack("Q>")[1..]
+    ts_bytes = epoch_micros_unsigned_uint_bytes
+
+    # Use the remaining bytes for randomness
+    byte_str = ts_bytes + random.bytes(16 - ts_bytes.bytesize)
+
+    # This last part encodes the version, the timecode and the variant.
+    # To prevent we have a variant, 4 bits of random and then the timecode I move up the timecode 4 bits.
+    # We end up with: 4bit variant - 8bit timecode - 4bit random from original byte string, hence 2 bytes in total.
+    #
+    # V4 random UUIDs use 4 bits to indicate a version and another 2-3 bits to indicate a variant.
+    # Most V4s (including these ones) are variant 1, which is 2 bits.
+    version = "4" # version 4, 4 bits.
+    timepart = ts_bytes[-1].unpack1("H*") # last byte of timecode (ts_bytes) as hex, 8 bits.
+    rest = byte_str[7].unpack1("h") # last 4 bits of 7th byte as hex.
+
+    # Our uuid with encoded timestamp will look something like this 16 bytes in total:
+    # ts = timestamp byte
+    # rnd = random byte
+    # |ts| ts, ts, ts, ts, ts, version(4bits) + first half ts(4bits), last half of ts(4bits) + rnd, variant(2bits) + rnd, rnd, rnd, rnd, rnd, rnd, rnd, rnd]
+    byte_str_part_with_time_and_variant = [version + timepart + rest].pack("H*")
+
+    byte_str.setbyte(6, byte_str_part_with_time_and_variant.getbyte(0))
+    byte_str.setbyte(7, byte_str_part_with_time_and_variant.getbyte(1))
+    byte_str.setbyte(8, (byte_str.getbyte(8) & 0x3f) | 0x80) # variant 1 (10 binary)
+
+    byte_str
+  end
+
+  # Generates the bag of 16 bytes with UUID in binary form. This the
+  # canonical representation but can be converted into one.
+  #
+  # @param random[#bytes] Source of randomness. Normally SecureRandom will be used, but it can be
+  #   replaced by a mock or a `Random` object with a known seed, for testing or speed.
+  # @param time[#to_f] A time value that is convertible to a floating-point number of seconds since epoch
+  # @return [String] in binary encoding
+  def self.uuid(**params_for_uuid_bytes)
+    # N : 32 bit unsigned int
+    # n : 16 bit unsigned int
+    # This will separate the whole random bytestring into a couple groups
+    # (as various sized integers) that match the uuid group size
+    # so [32bit int, 16bit int, 16bit int, 16bit int, 16bit int, 32bit int]
+    # Which then can be shown in hex into the string literal to make up the final uuid.
+    ary = uuid_bytes(**params_for_uuid_bytes).unpack("NnnnnN")
+    # format in hex notation with dashes
+    "%08x-%04x-%04x-%04x-%04x%08x" % ary
+  end
+end

data/tou.gemspec

@@ -0,0 +1,30 @@
+require_relative "lib/tou/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "tou"
+  spec.version = Tou::VERSION
+  spec.authors = ["Sebastian van Hesteren", "Julik Tarkhanov"]
+  spec.email = ["me@julik.nl", "sebastian@cheddar.me"]
+
+  spec.summary = "Time-ordered UUIDv4"
+  spec.description = "Time-ordered UUIDv4"
+  spec.homepage = "https://github.com/cheddar-me/tou"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/cheddar-me/tou"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "standard"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: tou
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastian van Hesteren
+- Julik Tarkhanov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: standard
+  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: Time-ordered UUIDv4
+email:
+- me@julik.nl
+- sebastian@cheddar.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".standard.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tou.rb
+- lib/tou/generator.rb
+- lib/tou/version.rb
+- tou.gemspec
+homepage: https://github.com/cheddar-me/tou
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cheddar-me/tou
+  source_code_uri: https://github.com/cheddar-me/tou
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Time-ordered UUIDv4
+test_files: []