lsuuid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc6dd220066b3a608eeaaccf05b8d2e5004c24f587bb34748d74af42a030a1e0
+  data.tar.gz: 85dfc3291c452dec71a775744599b45da7e4d3ce3626f1352becd92269c688fb
+SHA512:
+  metadata.gz: 804a0e9517a4505fd41b8b4f111ed185051ede0b21e72a0eeda35b80ddaa900d94a68e81b2ee88b2866c3ef5dce73903931a3d3d86d9cce0d4be0be61c1018c5
+  data.tar.gz: e5a03f3d374062219cf11681661f9dd5a88259a0f7b82fdca2bd6d3373ae5e1364e60f01bd4b1843f8897e864f2afa3de5f28a4948d38399c051930c679d3e49

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/ClassAndModuleChildren:
+  Enabled: true
+  EnforcedStyle: compact
+
+Style/RedundantSelf:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 20

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-11-21
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lsuuid.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.7'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Karthick
+
+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,113 @@
+# LSUUID (Lexicographically Sortable Universally Unique Identifier)
+
+LSUUID is a lexicographically sortable identifier with format similar to UUIDv4. 
+UUID has some limitations which are already listed and addressed by [ULID](https://github.com/ulid/spec).
+
+LSUUID provides the following improvements over ulid :-
+- The timestamp component in ulid is in milliseconds whereas LSUUID uses nanoseconds so that chance of collision is reduced 1000 times
+- Ability to bucket the generated identifiers with a prefix is provided by LSUUID
+- LSUUID adheres to the UUIDv4 format there by allowing the storage of the identifier in the UUID datatype of data stores which is more efficient than a string which is required for ulid.
+
+*Note: For use cases where format of the identifier is not a matter of concern, using ULID over LSUUID might be a better choice.*
+
+## Specification
+Below is the structure of LSUUID.
+
+**Without Prefix:**
+```
+ Sample LSUUID: 619bd0ef-2a04-5068-d3c4-f6fac6809edb
+
+ 619bd0ef-2a04-5068-      d3c4-f6fac6809edb
+
+|------------------|     |-----------------|
+     Timestamp                Randomness
+       64bits                   64bits
+```
+
+**With Prefix:**
+```
+ Sample LSUUID: 619bd0ef-2a04-5068-d3c4-f6fac6809edb
+
+ 619bd0      ef-2a04-5068-d3c4-f6      fac6809edb
+
+|------|    |--------------------|    |----------|
+ Prefix            Timestamp           Randomness
+ 24bits             64bits               40bits
+```
+
+### Components:
+
+**Timestamp**
+- 64 bit integer
+- UNIX-time in nanoseconds
+
+**Randomness**
+- 64 bits (40 bits in case a prefix is specified)
+- Cryptographically secure source of randomness, if possible
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lsuuid'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install lsuuid
+
+## Usage
+
+### Generate a UUID:
+```ruby
+irb(main):001:0> LSUUID.generate
+=> "619bd0ef-2a04-5068-d3c4-f6fac6809edb"
+```
+Generates a UUID based on the method call time.
+### Timestamp specific UUIDs:
+```ruby
+irb(main):001:0> t = Time.now     
+=> 2021-11-22 22:49:02 +0530
+irb(main):002:0> LSUUID.generate(time: t)
+=> "619bd106-0c6b-ba28-7811-f5787dab02d4"
+```
+### Modes:
+#### **ceil**
+```ruby
+irb(main):001:0> LSUUID.generate(time: t, mode: :ceil)
+=> "619bd106-0c6b-ba28-ffff-ffffffffffff"
+irb(main):002:0>  LSUUID.generate(time: t, mode: :ceil, prefix: 0)
+=> "00000061-9bd1-060c-6bba-28ffffffffff"
+```
+
+#### **floor**
+```ruby
+irb(main):001:0> LSUUID.generate(time: t, mode: :floor)
+=> "619bd106-0c6b-ba28-0000-000000000000"
+irb(main):002:0>  LSUUID.generate(time: t, mode: :ceil, prefix: 0)
+=> "00000061-9bd1-060c-6bba-280000000000"
+```
+
+### Prefix
+```ruby
+irb(main):001:0> LSUUID.generate(prefix: 0, time: t)
+=> "00000061-9bd1-060c-6bba-28428c7e196d"
+irb(main):002:0> LSUUID.generate(prefix: 1000, time: t)
+=> "0003e861-9bd1-060c-6bba-28d9cb973352"
+irb(main):003:0> LSUUID.generate(prefix: 16_777_215, time: t)
+=> "ffffff61-9bd1-060c-6bba-2826264c51e0"
+```
+**Note:** Prefix can be an integer between 0 and 16,777,215
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hwslabs/lsuuid.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'lsuuid'
+
+# 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/lsuuid/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LSUUID
+  VERSION = '0.1.0'
+end

data/lib/lsuuid.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'lsuuid/version'
+
+if RUBY_VERSION >= '2.5'
+  require 'securerandom'
+else
+  require 'sysrandom/securerandom'
+end
+
+module LSUUID # :nodoc:
+  PREFIX_LEN = 6
+  PAD_CHAR = '0'
+  FLOOR_CHAR = '0'
+  CEIL_CHAR = 'f'
+  DEFAULT_RAND_LEN = 16
+
+  class << self
+    # We allow 6 chars (24 bits) of UUID to be customizable as per requirement.
+    def generate(prefix: nil, time: Time.now, mode: :random)
+      prefix_hex = validate_prefix_and_get_hex(prefix)
+      result = prefix_hex +
+               time.to_i.to_s(16).rjust(8, PAD_CHAR) + time.nsec.to_s(16).rjust(8, PAD_CHAR) +
+               random_hex(prefix_hex, mode)
+      [result[0..7], result[8..11], result[12..15], result[16..19], result[20..31]].join('-')
+    end
+
+    private
+
+    def random_hex(prefix_hex, mode)
+      rand_len = DEFAULT_RAND_LEN - prefix_hex.size
+      case mode
+      when :random then SecureRandom.hex(rand_len / 2)
+      when :ceil then ''.rjust(rand_len, CEIL_CHAR)
+      when :floor then ''.rjust(rand_len, FLOOR_CHAR)
+      else raise "Unknown mode [#{mode}]"
+      end
+    end
+
+    def validate_prefix_and_get_hex(prefix)
+      return '' if prefix.nil?
+
+      raise "Expecting integer Got #{prefix.class.name}" unless prefix.is_a? Integer
+
+      if (prefix > 16_777_215) || prefix.negative?
+        raise "Integer prefix out of range. Allowed: min - 0, max - 16,777,215 (hex: ffffff). Got: #{prefix}."
+      end
+
+      prefix.to_s(16).rjust(PREFIX_LEN, PAD_CHAR)
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: lsuuid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hypto Engineering Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-11-25 00:00:00.000000000 Z
+dependencies: []
+description: Universally Unique Lexicographically Sortable Identifier
+email:
+- engineering@hypto.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lsuuid.rb
+- lib/lsuuid/version.rb
+homepage: https://github.com/hwslabs/lsuuid
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hwslabs/lsuuid
+  source_code_uri: https://github.com/hwslabs/lsuuid
+  changelog_uri: https://github.com/hwslabs/lsuuid/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Universally Unique Lexicographically Sortable Identifier
+test_files: []