make_id 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2448e655a9a006abb23272b2b54c6b4fc537f702407c931afcf106b82c468b04
-  data.tar.gz: 9852758f34e12c2be8aa90149cdded09e011f2ab879320089fc1bfb3f577d849
+  metadata.gz: 7f93b4ee4fa18932ab4bc7769214bee5a4297555d776ab4b38a31a56e3c98fe6
+  data.tar.gz: ea62bc4fa6bab34e649d9c3983146b55c81dbe469d16142c9847c00c8c291f49
 SHA512:
-  metadata.gz: 108e40b61bfdcc00ac5e550b4afb14fb8f7298df617d10b7179975b2be8f6f04c6b4693fc6909de26f42e6a9977333d12f7ecc5c5846b1317b3ab728b6e6d04d
-  data.tar.gz: 25c7229af03bc353707c2ee832f00c2ad63243318156ffa51bcd197f328a2cae865eaf37fa0949d7c8d98bcf9e583b4ec8f2fb2563317d7584b906b9f3c8cf08
+  metadata.gz: 183ea9a2f7e14c6a70d5f0addec62718ce467face83be99128163df22eae71cb5a6cdb813fe413cac2bb0daa80e1bda17267400995455fa11b916ba37bb20662
+  data.tar.gz: c2001d8acbc1427e88007146a05a32bbf47e725cce418ac42fd6242d94a23757819afefbaca268558943881012ba3ddcf5b133bc580b2fea44b6f4af092041bd

data/lib/make_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MakeId
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/make_id.rb

@@ -3,6 +3,7 @@
 require_relative "make_id/version"
 require "securerandom"
 require "zlib"
+require "digest"
 
 # MakeID generates record Identifiers other than sequential integers.
 # MakeId  - From the "make_id" gem found at https://github.com/afair/make_id
@@ -100,6 +101,21 @@ module MakeId
     check_digit ? append_check_digit(id, base) : id
   end
 
+  # Takes a string and returns an 8-byte integer for the string.
+  # This implementation uses the SHA256 hash of the string to generate the ID.
+  # You can also have random bits added to the ID to make it unique.
+  # This is not a unique ID, but a repeatable ID for the same string
+  # (unless random_bits is used), and can be used like a hashing value.
+  def self.string_id(string, random_bits: 0, base: 10, bytes: 8)
+    id = Digest::SHA256.hexdigest(string)[0, bytes * 2].to_i(16)
+    if random_bits > 0
+      id >> random_bits
+      id << random_bits
+      id |= SecureRandom.random_number(2**random_bits - 1)
+    end
+    (base == 10) ? id : int_to_base(id, base)
+  end
+
   ##############################################################################
   # UUID - Universally Unique Identifier
   ##############################################################################
@@ -197,6 +213,36 @@ module MakeId
     ].join
   end
 
+  # Returns an id using the current epoch time with floating precision and random bits.
+  # Be default, this returns an 8-byte integer in ascending order within precision.
+  # Format is approximately "SSSSSSSSSMMMRRR" (seconds, milliseconds, random).
+  # * precision (1..5) The number of milliseconds decimeal places to use. Default is 4.
+  # * random_bits (1..) The number of bits to use for the random number. Default is 18.
+  # * time - Time object to use for the token. Default is Time.now
+  # * base - The base to use for the id. Default is 10
+  # * chars - The character set to use for the base conversion. Default is BASE62
+  def self.time_id(base: 10, precision: 4, random_bits: 18, time: nil, chars: nil)
+    seconds = ((time || Time.now).to_f * (10**precision)).to_i
+    id = (seconds * (2**random_bits)) | SecureRandom.random_number(2**random_bits - 1)
+    (base == 10) ? id : int_to_base(id, base, chars: chars)
+  end
+
+  # Returns a string from the time with floating precision, and a random number appended.
+  # This calls time_id() and returns a token of the given size.
+  # If size is zero, the full token is returned. If size is greater than the token,
+  # the token is right-justified with zeros. If the token is larger than size, the
+  # right-most characters are returned.
+  def self.time_token(size: 0, base: 62, chars: nil, time: nil, precision: 3, random_bits: 8)
+    token = time_id(base: base, precision: precision, random_bits: random_bits, time: time, chars: chars)
+    if size == 0
+      token
+    elsif token.size < size
+      token.rjust(size, "0")
+    else
+      token[-size, size]
+    end
+  end
+
   ##############################################################################
   # Snowflake Id - Epoch + millisecond + worker_id id + sequence number
   # Snowflakes are a form of unique identifier used in distributed computing.
@@ -370,6 +416,12 @@ module MakeId
     id.to_s + compute_check_digit(id, base)
   end
 
+  # Removes and validates the check digit. Retuns nil if the check digit is invalid.
+  def self.remove_check_digit(id, base = 10)
+    id, cd = id.to_s[0..-2], id.to_s[-1]
+    valid_check_digit?(id + cd, base) ? id : nil
+  end
+
   # Returns a character computed using the CRC32 algorithm
   # Uses a pre-defined check_proc if configured. See check_proc=().
   def self.compute_check_digit(id, base = 10)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: make_id
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Allen Fair
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-18 00:00:00.000000000 Z
+date: 2025-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -24,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  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: MakeId is a collection of record Identifier generators
 email:
 - allen.fair@gmail.com
@@ -49,7 +62,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/afair/make_id
   source_code_uri: https://github.com/afair/make_id
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,8 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: MakeId provides a collection of record Identifier generators
 test_files: []