acts_as_identifier 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50941b62619d0fa3829df18f02e97e46d02e7b35f052db3c64d9c7b821699826
-  data.tar.gz: 728fbeb1a33e0dd5f5f734f5a1e18821320df7118e79717b5bc543c9fceacec4
+  metadata.gz: 5eb6246b99ed8a6b043f1b86f7280676f22107154a2b885b9414058e44d8e11d
+  data.tar.gz: e7ebde2dc53be641c11f26fffefc450568fd2775fe5382e352b16945c7965741
 SHA512:
-  metadata.gz: d323726b48026b4bb396a8837d47f1c45b6f3fded3972c3c7a51e7ca3bccbfdcfa11f33ba895dd081b21a2c3b79327f9348ad6987a0bff2695c32b868c6c1fd2
-  data.tar.gz: 6fba6c6ade83590f4c91909298da3133d01665014c187d12324d129f8d03a992cfaab01cab7693d869c124ec233e8e485de17ca7a3175e15b2c7aed6be9abbfe
+  metadata.gz: 4e88efefec94d938295a34dadb93b29ec350ac7680b997d36499a2f6b2e81c3244dec7142800576752b8b25056e3df1c83c5c237e80546822c1f044136f408e7
+  data.tar.gz: 5a61dcbb7a9f9d114768a82e28cfe68c3a57834cfc93f154f007774b84554bcf68d4df9cbc3cafafa2a068ef0412d69ced5ab0178eb09c0739508a00056a44f6

data/README.md

@@ -6,29 +6,30 @@ Automatically generate unique secure random string for one or more columns of Ac
 
 ## Usage
 
-> `ActsAsIdentifier` only generate identifier `before create`
+> `ActsAsIdentifier` only generate identifier `after_create_commit`
 
 ```ruby
 class Account < ActiveRecord::Base
   #
   # Note: without Rails, should include ActsAsIdentifier
   #
-
-  # with default options:
-  #           column: :identifier
-  #           length: 6
-  #   case sensitive: true
-  #         max_loop: 100
-  #            scope: []
+  # def acts_as_identifier(attr = :identifier,
+  #                            length: 6,
+  #                            prefix: '',
+  #                            id_column: :id,
+  #                            chars: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.chars,
+  #                            mappings: '3NjncZg82M5fe1PuSABJG9kiRQOqlVa0ybKXYDmtTxCp6Lh7rsIFUWd4vowzHE'.chars)
+  #
   acts_as_identifier
-
-  # extra column
-  acts_as_identifier :slug, length: 8, case_sensitive: false, max_loop: 1000, scope: [:tenant_id]
+  # or customize options:
+  acts_as_identifier :slug, length: 6, prefix: 's-'
 end
-# => [Account(id: integer, name: string, tenant_id: string, identifier: string, slug: string)]
+# => [Account(id: integer, name: string, tenant_id: string, slug: string)]
 
 Account.create
-# => #<Account:0x00007fcdb90830c0 id: 1, name: nil, tenant_id: nil, identifier: "PWbYHd", slug: "5fabb1e7">
+# => #<Account:0x00007fcdb90830c0 id: 1, name: nil, tenant_id: nil, slug: "s-HuF2Od">
+Account.create
+# => #<Account:0x00007fcdb90830c0 id: 2, name: nil, tenant_id: nil, slug: "s-g3SIB8">
 
 ```
 
@@ -41,5 +42,10 @@ bundle add acts_as_identifier
 ## Contributing
 Contribution directions go here.
 
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+## Testing
+
+```shell
+bundle exec rspec
+# or test specific range
+EXTRA_TEST=100000,1000000 bundle exec rspec
+```

data/lib/acts_as_identifier.rb

@@ -2,6 +2,8 @@
 
 require 'securerandom'
 require 'acts_as_identifier/version'
+require 'acts_as_identifier/xbase_integer'
+require 'acts_as_identifier/encoder'
 
 module ActsAsIdentifier
   LoopTooManyTimesError = Class.new(StandardError)
@@ -12,28 +14,39 @@ module ActsAsIdentifier
 
   module ClassMethods
     #
-    # == Automatically generate unique secure random string
+    # == Automatically generate unique string based on id
     #
     # @param attr [String, Symbol] column name, default: :identifier
     # @param length [Integer] length of identifier, default: 6
-    # @param case_sensitive [Boolean] Case-sensitive? default: true
-    # @param max_loop [Integer] max loop count to generate unique identifier, in case of running endless loop, default: 100
-    # @param scope [Array<Symbol,String>] scope of identifier, default: []
     # @params prefix [String, Symbol] add prefix to value, default: ''
-    def acts_as_identifier(attr = nil, length: 6, case_sensitive: true, max_loop: 100, scope: [], prefix: '')
-      attr ||= :identifier
-      scope = Array(scope)
-      method = case_sensitive ? :alphanumeric : :hex
-      length /= 2 if method == :hex
-
-      before_create do
-        query = self.class.unscoped.where(scope.inject({}) { |memo, i| memo.merge(i => send(i)) })
-        n = 0
-        loop do
-          n += 1
-          value = send("#{attr}=", "#{prefix}#{SecureRandom.send(method, length)}")
-          break unless query.where(attr => value).exists?
-          raise LoopTooManyTimesError if n > max_loop
+    # @params id_column [String, Symbol] column name of id, default: :id
+    # @params chars [Array<String>] chars
+    # @params mappings [Array<String>] mappings must have the same characters as chars
+    def acts_as_identifier(attr = :identifier,
+                           length: 6,
+                           prefix: '',
+                           id_column: :id,
+                           chars: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.chars,
+                           mappings: '3NjncZg82M5fe1PuSABJG9kiRQOqlVa0ybKXYDmtTxCp6Lh7rsIFUWd4vowzHE'.chars)
+      raise 'chars must be an array' unless chars.is_a?(Array)
+      raise 'mappings must be an array' unless mappings.is_a?(Array)
+      unless (chars - mappings).empty? && (mappings - chars).empty?
+        raise 'chars and mappings must have the same characters'
+      end
+
+      encoder = Encoder.new(chars: chars, mappings: mappings, length: length)
+
+      define_singleton_method "decode_#{attr}" do |str|
+        encoder.decode(str[prefix.length..-1])
+      end
+
+      define_singleton_method "encode_#{attr}" do |num|
+        "#{prefix}#{encoder.encode(num)}"
+      end
+
+      before_commit do |record|
+        if record.previous_changes.key?(id_column.to_s) && !record.destroyed?
+          record.update_column attr, self.class.send("encode_#{attr}", record.send(id_column))
         end
       end
     end

data/lib/acts_as_identifier/encoder.rb

@@ -0,0 +1,36 @@
+module ActsAsIdentifier
+  class Encoder
+    attr_reader :max, :base, :chars, :mappings, :length
+
+    def initialize(chars:, mappings:, length:)
+      @chars = chars.dup
+      @mappings = mappings.dup
+      @length = length
+      @xbase_integer = XbaseInteger.new(chars)
+      @base = @xbase_integer.to_i("#{chars[1]}#{chars[0] * (length - 1)}")
+      @max = @xbase_integer.to_i(chars[-1] * length) - @base
+    end
+
+    def encode(num)
+      str = @xbase_integer.to_x(num + base)
+      (str.length - 1).downto(1).each do |i|
+        idx = @mappings.index(str[i])
+        idx2 = (@mappings.index(str[i - 1]) + idx) % @mappings.size
+        str[i] = @chars.at(idx)
+        str[i - 1] = @chars.at(idx2)
+      end
+      str
+    end
+
+    def decode(str)
+      str = str.dup
+      0.upto(str.length - 2).each do |i|
+        idx = @chars.index(str[i + 1])
+        idx2 = (@chars.index(str[i]) - idx + @chars.size) % @chars.size
+        str[i] = @mappings.at(idx2)
+        str[i + 1] = @mappings.at(idx)
+      end
+      @xbase_integer.to_i(str) - base
+    end
+  end
+end

data/lib/acts_as_identifier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActsAsIdentifier
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

data/lib/acts_as_identifier/xbase_integer.rb

@@ -0,0 +1,23 @@
+module ActsAsIdentifier
+  class XbaseInteger
+    attr_reader :chars
+    def initialize(chars)
+      @chars = chars.dup
+    end
+
+    def to_i(str)
+      sum = 0
+      str.chars.reverse.each_with_index do |char, i|
+        sum += chars.index(char) * chars.size**i
+      end
+      sum
+    end
+
+    def to_x(num)
+      str = chars.at(num % chars.size)
+      num /= chars.size
+      str = "#{to_x(num)}#{str}" if num > 0
+      str
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_identifier
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - xiaohui
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -48,8 +48,10 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/acts_as_identifier.rb
+- lib/acts_as_identifier/encoder.rb
 - lib/acts_as_identifier/railtie.rb
 - lib/acts_as_identifier/version.rb
+- lib/acts_as_identifier/xbase_integer.rb
 homepage: https://github.com/xiaohui-zhangxh/acts_as_identifier
 licenses:
 - MIT