aegis_support 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c24d3a8cb0e54f8593a3e16b3354602fea04602286271804dbf251dca661c0f
-  data.tar.gz: d48a250d22d2cd520406069b764ed409bfb3399de0445e5582478f2d62e8ca70
+  metadata.gz: 3983471972c6f92a26bb79c686b0c040cc3f2bab58e1460a36c8ec227e4a1d98
+  data.tar.gz: c9726be24cd6ecaa35e6ce3876d42c3c2786e7711eb5141a1d0afae92295e3ac
 SHA512:
-  metadata.gz: 7b274e4cc77fef9c30603af94b5c9c26d22a6b800ac2c6f97fc059b61a476b62079acb9bbe1d4da79850a304c5c0c9b7e3a15297c9db43a55cfc1fb22b65d514
-  data.tar.gz: 35687085418c783aa5109adce4853d31bb8fe8d31206c571c932ae87621e3b5f8a76b7e0c32777c05ab90324f99ba14dae10ba802e1f391a479d68237bef63fb
+  metadata.gz: 9bfa5278a266c1926c381638068bd5e603ba9e92fcd14c613b6966747adfe6f90d32940627f71e648212ec7fa4ac62dff9afdcc84feae37d59911f29199c4221
+  data.tar.gz: 96f1c99ffaf2f0e5ac3abb0fbee5f2ad2eeb922e3b0ee3843dffb077a7a1de9aa4b01ab5dac08d4b25563da649b6c128a0892ab29cd846a5ac1238ca32bd8ca1

data/README.md

@@ -4,33 +4,43 @@ Aegis Support is a collection of utility classes and library extensions that wer
 ## Usage
 
 ### AegisSupport::SecureNumber
-A module with `has_secure_number` method for generate unique numbers，
+A module with `has_secure_number` method for generate unique numbers
 
 ```ruby
-# Schema: Order(order_no:string)
+# Database Schema:
+# 
+# Order(
+#   order_no: string,
+#   order_no_with_prefix: string,
+#   order_no_with_suffix: string,
+#   order_no_with_specific_length: string
+# )
 class Order < ActiveRecord::Base
   include AegisSupport::SecureNumber
   
-  # replace `order_no` with what column your want 
+  # replace above column with what your want 
   has_secure_number :order_no
+  has_secure_number :order_no_with_prefix, prefix: "PN_"
+  has_secure_number :order_no_with_suffix, prefix: "_SN"
+  has_secure_number :order_no_with_specific_length, length: 16
 end
 
 order = Order.new
 order.save
 
 order.order_no # 15103771760966048900
+order.order_no_with_prefix # PN_93550490115056646751
+order.order_no_with_suffix # 26931151941756843999_SN
+order.order_no_with_specific_length # 9124679044244949
 ```
 
-The generate algorithm is: 
-```ruby
-maximum_number = 99999_99999_99999_99999 # 20 characters long
-secure_number = SecureRandom.random_number(maximum_number).to_s.rjust(20, "0")
-```
+`SecureRandom.random_number` is used to generate the random numeric string. when the result's length is less than the 
+specific(default is 20), some leading zeros will be added to the number to make its width equal to the length. `prefix` 
+and `suffix` are not included in the calculation of length.
 
-Thus it will generate a random numeric string of 20 characters long, so collisions are highly unlikely.
-like the `has_secure_token` in ActiveRecord, it's still possible generate a race condition in the database 
-in the same way that `validates_uniqueness_of` can. You're encouraged to add a unique index in the database 
-to deal with this even more unlikely scenario
+when the length is long enough, The collisions are highly unlikely. like the `has_secure_token` in ActiveRecord,
+it's still possible generate a race condition in the database in the same way that `validates_uniqueness_of` can.
+You're encouraged to add a unique index in the database to deal with this even more unlikely scenario
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/aegis_support/secure_number.rb

@@ -1,21 +1,22 @@
-
 module AegisSupport
   module SecureNumber
     extend ActiveSupport::Concern
 
     module ClassMethods
-      def has_secure_number(attribute)
+      DEFAULT_MAXIMUM_NUMBER_LENGTH = 20
+
+      def has_secure_number(attribute, **options)
         require "securerandom"
 
-        define_method("regenerate_#{attribute}"){ update! attribute => self.class.generate_secure_number(attribute) }
-        before_create{ self.send("#{attribute}=", self.class.generate_secure_number(attribute)) }
+        define_method("regenerate_#{attribute}") { update! attribute => self.class.generate_secure_number(attribute, **options) }
+        before_create { self.send("#{attribute}=", self.class.generate_secure_number(attribute, **options)) }
       end
 
-      def generate_secure_number(attribute)
+      def generate_secure_number(attribute, **options)
+        options.symbolize_keys!
+
         10.times do |i|
-          # generate random number of 20 characters long
-          maximum_number = 99999_99999_99999_99999
-          secure_number = SecureRandom.random_number(maximum_number).to_s.rjust(20, "0")
+          secure_number = options[:prefix].to_s + random_string(options[:length]) + options[:suffix].to_s
 
           if exists?(attribute => secure_number)
             raise "Couldn't generate a unique number in 10 attempts!" if i == 9
@@ -24,6 +25,17 @@ module AegisSupport
           end
         end
       end
+
+      private
+
+      def random_string(length)
+        length = length.present? ? Integer(length) : DEFAULT_MAXIMUM_NUMBER_LENGTH
+        maximum_number = ("9" * length).to_i
+
+        SecureRandom.random_number(maximum_number)
+                    .to_s
+                    .rjust(length, "0")
+      end
     end
   end
 end

data/lib/aegis_support/version.rb

@@ -1,3 +1,3 @@
 module AegisSupport
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aegis_support
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - ian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails