aegis_support 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c77e86a53ff5e0811169153c2d9d7657c1cc5725ffc5c50fbc887efd30fe97be
-  data.tar.gz: bf6c63c92af362cbdb4ff8b8da154e4501665150669f316cb644b03ca9315fa0
+  metadata.gz: 3983471972c6f92a26bb79c686b0c040cc3f2bab58e1460a36c8ec227e4a1d98
+  data.tar.gz: c9726be24cd6ecaa35e6ce3876d42c3c2786e7711eb5141a1d0afae92295e3ac
 SHA512:
-  metadata.gz: 3d565663fbe59685bec2616bbed2616a285cc225ffc2a82242364b41b5407f5f280d0a3f4dde5299c8c86463c064e4c807d7d2a277af2e52af2bb1f7bc4fa7e2
-  data.tar.gz: bc4244243aff667b9de0841fb1b7bca66c676214622edb1f6c58d8066ead7abc62875d77a3c628751b28c1248fcc7e15f1e93402756654ee19c743de68cdac4e
+  metadata.gz: 9bfa5278a266c1926c381638068bd5e603ba9e92fcd14c613b6966747adfe6f90d32940627f71e648212ec7fa4ac62dff9afdcc84feae37d59911f29199c4221
+  data.tar.gz: 96f1c99ffaf2f0e5ac3abb0fbee5f2ad2eeb922e3b0ee3843dffb077a7a1de9aa4b01ab5dac08d4b25563da649b6c128a0892ab29cd846a5ac1238ca32bd8ca1

data/README.md

@@ -1,8 +1,46 @@
-# Aeg*i*sSupport
-Short description and motivation.
+# AegisSupport
+Aegis Support is a collection of utility classes and library extensions that were found useful for the Rails framework
 
 ## Usage
-How to use my plugin.
+
+### AegisSupport::SecureNumber
+A module with `has_secure_number` method for generate unique numbers
+
+```ruby
+# 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 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
+```
+
+`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.
+
+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

@@ -0,0 +1,41 @@
+module AegisSupport
+  module SecureNumber
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      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, **options) }
+        before_create { self.send("#{attribute}=", self.class.generate_secure_number(attribute, **options)) }
+      end
+
+      def generate_secure_number(attribute, **options)
+        options.symbolize_keys!
+
+        10.times do |i|
+          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
+          else
+            break secure_number
+          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.1"
+  VERSION = "0.0.4"
 end

data/lib/aegis_support.rb

@@ -1,5 +1,6 @@
 require "aegis_support/version"
 require "aegis_support/railtie"
+require "aegis_support/secure_number"
 
 module AegisSupport
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aegis_support
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  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
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.2.3
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
 description: A helpful collection of utitility for rails application
 email:
 - ianlynxk@gmail.com
@@ -36,6 +50,7 @@ files:
 - Rakefile
 - lib/aegis_support.rb
 - lib/aegis_support/railtie.rb
+- lib/aegis_support/secure_number.rb
 - lib/aegis_support/version.rb
 - lib/tasks/aegis_support_tasks.rake
 homepage: https://github.com/otorain/aegis_support