redis_int52_autoincrement 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be347a0e6721c196136980f15f5fcb895cb1770955795a7e802dcdb8d80a8f3a
+  data.tar.gz: 4d7ed637481c0369ef22d169f71a5a8f5c9bb230c662fc6910fd979d410e56f1
+SHA512:
+  metadata.gz: 55b7e45781f9e8eafe092e9350e3a85c9c6198882fa94e7e222f7a8c6c2089d2a0ab891bc54c2d7daa09dd479fbb6edd6cf5f1d3553970ac9f567ee65ff4bb74
+  data.tar.gz: c0fb76237341a72b1ae47417c572499568a752c9122c0a56a8b4707082fcdbc0efa384cdc375a02ebae1fd1bf4f9d2ca8c149c40f8c2e698eb25aefafa10f3a5

data/CHANGELOG

@@ -0,0 +1,2 @@
+1.0.1 (2024-02-02)
+Creted first version by AndrewTrumenov (chaky22222222@gmail.com).

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2023-2024 Andrew Chernuha
+
+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.rdoc

@@ -0,0 +1,60 @@
+= Int64 UUID (UInt52) autoincremented via redis-server
+
+Why UInt52? Becouse JavaScript have problems with usege of Int64 values, that less than UInt54 max value.
+So I create this library for be sure that migration to the UUID64 will not brake front side with rounding JavaScript bug.
+
+What bug? Please open in your browser console and put into it
+
+11111111111111111+2
+
+What you see? Yes! It is 11111111111111114.
+
+But it is not all. Please insert in this console 11111111111111111 and press enter. What you see? Yes, it is 11111111111111112.
+
+Why it happens: becouse JavaScript use Double for store and working with Integers. Yes, i know, it is really bad idea :(.
+
+So UInt54 is the maximum int that JavaScript can process without this bug.
+
+If you do not want search and fix all places in your project with this bug and you need UUID64 - use this lib.
+
+= What this gem provide:
+Generates universally unique identifiers (UUID52) with unsigned Int64 last 52 bits (so it will be UInt52)
+for use in distributed applications.
+Based on:
+1) possibility autoincrement value in redis-server
+2) unix timestamps with microseconds
+3) expire key possibility in redis database.
+4) this value UInt52 can be used by JavaScript without lags.
+
+
+== Generating UInt52 Ids
+
+Call #generate to generate a new UUID64. The method returns a Int64 unique value less than UINT52 max value.
+
+For example in rails:
+
+  before_create do |record|
+    record.id ||= RedisInt52Autoincrement.generate(Rails.cache.redis || Redis.new(url: "redis://localhost:6379/0"))
+  end
+
+== Why so hard?
+
+We have an issue where the servers have different times on each server and during the time the server syncs the time we have a shift of a few seconds.
+So this lib have +-50(UUID52_MAX_SECONDS_EXPIRE) seconds maximum for delta shift.
+
+== Latest and Greatest
+
+Source code and documentation hosted on Github: http://github.com/trumenov/redis_int52_autoincrement
+
+To get UUID52 from source:
+
+  git clone git://github.com/trumenov/redis_int52_autoincrement.git
+
+
+== License
+
+This package is licensed under the MIT license and/or the Creative
+Commons Attribution-ShareAlike.
+
+:include: MIT-LICENSE
+

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake/testtask'
+#require 'rake/rdoctask'
+
+
+spec = Gem::Specification.load(File.expand_path("redis_int52_autoincrement.gemspec", File.dirname(__FILE__)))
+
+desc "Default Task"
+task :default => :test
+
+
+desc "Run all test cases"
+Rake::TestTask.new do |test|
+  test.verbose = true
+  test.test_files = ['test/*.rb']
+  test.warning = true
+end
+
+# Create the documentation.
+#Rake::RDocTask.new do |rdoc|
+#  rdoc.rdoc_files.include "README.rdoc", "lib/**/*.rb"
+#  rdoc.options = spec.rdoc_options
+#end
+
+
+
+desc "Push new release to rubyforge and git tag"
+task :push do
+  sh "git push"
+  puts "Tagging version #{spec.version} .."
+  sh "git tag v#{spec.version}"
+  sh "git push --tag"
+  puts "Building and pushing gem .."
+  sh "gem build #{spec.name}.gemspec"
+  sh "gem push #{spec.name}-#{spec.version}.gem"
+end
+
+desc "Install #{spec.name} locally"
+task :install do
+  sh "gem build #{spec.name}.gemspec"
+  sh "gem install #{spec.name}-#{spec.version}.gem"
+end

data/lib/redis_int52_autoincrement.rb

@@ -0,0 +1,58 @@
+class RedisInt52Autoincrement
+
+  # Why 30 seconds? Easy to debug and more than enouth for sync time delta shift.
+  # You can use 10 or 5 seconds - and all must working normal too.
+  # 30seconds was chosen by me without any explanation. Just took this value, i do not know why.
+  REDIS_KEY_TTL_SECONDS = 30
+
+  MAX_BUFFER_BITS_CNT = 52
+  TIMESTAMP_BITS_CNT = 34.freeze # 34bits for 150+ years more than enougth
+  TIMESTAMP_MICROSECONDS_BITS_CNT = 20.freeze # 0..999_999 - require 20bits
+  TIMESTAMP_MICROSECONDS_STORE_BITS_CNT = 9.freeze # from max value 999_999 we will take only first 9 high bits.
+  TIMESTAMP_MICROSECONDS_BITS_SHL = TIMESTAMP_MICROSECONDS_BITS_CNT - TIMESTAMP_MICROSECONDS_STORE_BITS_CNT
+  INCREMENTED_ID_BITS_CNT = 7.freeze  # 7bits for 0..127 INCREMENTED_UINT8_ID
+  SERVER_ID_BITS_CNT = 2.freeze
+  # So in result: 34 + 9 + 7 + 2 = 52bits(MAX_BUFFER_BITS_CNT).
+
+  TIMESTAMP_SECONDS_SHIFT_LEFT_CNT = (TIMESTAMP_MICROSECONDS_STORE_BITS_CNT + INCREMENTED_ID_BITS_CNT + SERVER_ID_BITS_CNT).freeze # 18 bits
+  TIMESTAMP_MICROSECONDS_SHIFT_LEFT_CNT = (INCREMENTED_ID_BITS_CNT + SERVER_ID_BITS_CNT).freeze # 9 bits
+  INCREMENTED_ID_MAX_VAL    = ((1 << INCREMENTED_ID_BITS_CNT) - 1).freeze # 1111111b=127
+  UINT52_MAX_VAL = 4503599627370496 # 2^52 = 4503599627370496
+  LIB_FIRST_VAL  = 447450850315268 # First id was generated 02.02.2024 at ~18:00 (Kiev +2:00)
+
+  # Version number.
+  module Version
+    version = Gem::Specification.load(File.expand_path("../redis_int52_autoincrement.gemspec", File.dirname(__FILE__))).version.to_s.split(".").map { |i| i.to_i }
+    MAJOR = version[1]
+    MINOR = version[0]
+    PATCH = version[1]
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+
+  VERSION = Version::STRING
+
+  class << self
+    def generate(redis, namespace = 'default', options = {})
+      server_id = options[:server_id] || 0
+      time_redis = options[:time_redis] || redis
+      raise("Wrong server_id[#{server_id}]. Allow only 0..3 server_id") unless server_id.between?(0, 3)
+      time_arr = time_redis.time
+      raise("Wrong time type[#{time_arr.inspect}]") unless time_arr.count.eql?(2)
+      unix_seconds = time_arr.first.to_i
+      first_part = unix_seconds << TIMESTAMP_SECONDS_SHIFT_LEFT_CNT
+
+      microseconds = time_arr[1].to_i
+      raise("Wrong microseconds [#{microseconds}]") unless microseconds.between?(0, 999_999)
+      second_part = (microseconds >> TIMESTAMP_MICROSECONDS_BITS_SHL) << TIMESTAMP_MICROSECONDS_SHIFT_LEFT_CNT
+
+      key = "ai64:#{namespace}:#{unix_seconds}:#{microseconds}"
+      incremented_val = redis.incrby(key, 1)
+      redis.expire(key, REDIS_KEY_TTL_SECONDS)
+      raise("Wrong incremented_val [#{incremented_val}]") unless incremented_val.between?(0, INCREMENTED_ID_MAX_VAL)
+      third_part = incremented_val << SERVER_ID_BITS_CNT
+      result = ((first_part | second_part) | third_part) | server_id
+      raise("Wrong result[#{result}]") unless result.between?(LIB_FIRST_VAL, UINT52_MAX_VAL)
+      result
+    end
+  end
+end

data/redis_int52_autoincrement.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name = 'redis_int52_autoincrement'
+  s.version = '1.0.1'
+  s.summary = "Int64 (UInt52) autoincrement via redis-servers"
+  s.description = <<-EOF
+Int64 (UInt52) autoincrement via redis-servers with timestamp in microseconds, autoincerent via redis key.
+Support 1-5 redis servers in one system (1 - timestamp + 4 servers - autoincrementers).
+EOF
+
+  s.authors << 'Trumenov' << 'Chaky'
+  s.email = 'chaky22222222@gmail.com'
+  s.homepage = 'http://github.com/trumenov/redis_int52_autoincrement'
+  s.license = 'MIT'
+
+  s.files = Dir['{bin,test,lib,docs}/**/*'] + ['README.rdoc', 'MIT-LICENSE', 'Rakefile', 'CHANGELOG', 'redis_int52_autoincrement.gemspec']
+
+  s.rdoc_options << '--main' << 'README.rdoc' << '--title' <<  'Int64 UInt52 redis autoincrementer' << '--line-numbers'
+                       '--webcvs' << 'http://github.com/trumenov/redis_int52_autoincrement'
+  s.extra_rdoc_files = ['README.rdoc', 'MIT-LICENSE']
+end

data/test/test_redis_int52_autoincrement.rb

@@ -0,0 +1,20 @@
+# encoding: UTF-8
+# Author:: Andrew Chernuha chaky22222222@gmail.com
+# License:: MIT and/or Creative Commons Attribution-ShareAlike
+# run test with command: rake
+
+require 'test/unit'
+require 'rubygems'
+require 'redis_int52_autoincrement'
+require "redis"
+
+class TestRedisInt52Autoincrement < Test::Unit::TestCase
+
+  def test_check_generated_placed_in_target_region
+    redis = Redis.new(url: "redis://localhost:6379/0")
+    left_part = Time.now.to_i << (RedisInt52Autoincrement::MAX_BUFFER_BITS_CNT - RedisInt52Autoincrement::TIMESTAMP_BITS_CNT)
+    new_id = RedisInt52Autoincrement.generate(redis)
+    right_part = (Time.now.to_i + 1) << (RedisInt52Autoincrement::MAX_BUFFER_BITS_CNT - RedisInt52Autoincrement::TIMESTAMP_BITS_CNT)
+    assert new_id.between?(left_part, right_part)
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: redis_int52_autoincrement
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Trumenov
+- Chaky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-02-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Int64 (UInt52) autoincrement via redis-servers with timestamp in microseconds, autoincerent via redis key.
+  Support 1-5 redis servers in one system (1 - timestamp + 4 servers - autoincrementers).
+email: chaky22222222@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- MIT-LICENSE
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/redis_int52_autoincrement.rb
+- redis_int52_autoincrement.gemspec
+- test/test_redis_int52_autoincrement.rb
+homepage: http://github.com/trumenov/redis_int52_autoincrement
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.rdoc
+- "--title"
+- Int64 UInt52 redis autoincrementer
+- "--line-numbers"
+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: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Int64 (UInt52) autoincrement via redis-servers
+test_files: []