acts_as_identifier 1.0.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eb6246b99ed8a6b043f1b86f7280676f22107154a2b885b9414058e44d8e11d
-  data.tar.gz: e7ebde2dc53be641c11f26fffefc450568fd2775fe5382e352b16945c7965741
+  metadata.gz: 5949d5438578e6ba0dc781e97099ff60de4929de294a46dcb64a1b8f558fd805
+  data.tar.gz: e3975e906f51cc8ff890ea819658d70cf6b97b35c0748639c61acd440fbd3d97
 SHA512:
-  metadata.gz: 4e88efefec94d938295a34dadb93b29ec350ac7680b997d36499a2f6b2e81c3244dec7142800576752b8b25056e3df1c83c5c237e80546822c1f044136f408e7
-  data.tar.gz: 5a61dcbb7a9f9d114768a82e28cfe68c3a57834cfc93f154f007774b84554bcf68d4df9cbc3cafafa2a068ef0412d69ced5ab0178eb09c0739508a00056a44f6
+  metadata.gz: 1652f9572cf96245f35ad3f36bda3f71ad8e1f271d316b213734c466e7898b772a09a5dd673c24f2a570a2d6342ca48a26766f337235ad19b39922fdb054d1bd
+  data.tar.gz: 7d12df48ab6b85d74b1fa345491fcd1b319bb8f7623701bfcdf5f0fa17abf300880d37c5a4576d9ef8605e793993f6cfb4b79824f3817a2223209d822e8015f0

data/README.md

@@ -2,23 +2,24 @@
 
 [![Gem Version](https://badge.fury.io/rb/acts_as_identifier.svg)](https://badge.fury.io/rb/acts_as_identifier)
 
-Automatically generate unique secure random string for one or more columns of ActiveRecord.
+Automatically generate unique fixed-length string for one or more columns of ActiveRecord based on sequence column
 
 ## Usage
 
-> `ActsAsIdentifier` only generate identifier `after_create_commit`
+> `ActsAsIdentifier` only generate identifier `before_commit`
 
 ```ruby
 class Account < ActiveRecord::Base
+  include ActsAsIdentifier
   #
-  # Note: without Rails, should include ActsAsIdentifier
+  # == default options
   #
-  # def acts_as_identifier(attr = :identifier,
-  #                            length: 6,
-  #                            prefix: '',
-  #                            id_column: :id,
-  #                            chars: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'.chars,
-  #                            mappings: '3NjncZg82M5fe1PuSABJG9kiRQOqlVa0ybKXYDmtTxCp6Lh7rsIFUWd4vowzHE'.chars)
+  #      attr: :identifier,
+  #      seed: 1,
+  #    length: 6,
+  #    prefix: nil,
+  # id_column: :id,
+  #     chars: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
   #
   acts_as_identifier
   # or customize options:
@@ -27,9 +28,9 @@ end
 # => [Account(id: integer, name: string, tenant_id: string, slug: string)]
 
 Account.create
-# => #<Account:0x00007fcdb90830c0 id: 1, name: nil, tenant_id: nil, slug: "s-HuF2Od">
+# => #<Account:0x00007fcdb90830c0 id: 1, name: nil, tenant_id: nil, slug: "s-EPaPaP">
 Account.create
-# => #<Account:0x00007fcdb90830c0 id: 2, name: nil, tenant_id: nil, slug: "s-g3SIB8">
+# => #<Account:0x00007fcdb90830c0 id: 2, name: nil, tenant_id: nil, slug: "s-HSo0u4">
 
 ```
 
@@ -39,6 +40,10 @@ Account.create
 bundle add acts_as_identifier
 ```
 
+## Requirements
+
+Use gem [`Xencoder`](https://github.com/xiaohui-zhangxh/xencoder/) to encode sequence number to fixed-length string.
+
 ## Contributing
 Contribution directions go here.
 
@@ -46,6 +51,4 @@ Contribution directions go here.
 
 ```shell
 bundle exec rspec
-# or test specific range
-EXTRA_TEST=100000,1000000 bundle exec rspec
 ```

data/lib/acts_as_identifier.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-require 'securerandom'
 require 'acts_as_identifier/version'
-require 'acts_as_identifier/xbase_integer'
-require 'acts_as_identifier/encoder'
+require 'xencoder'
 
 module ActsAsIdentifier
-  LoopTooManyTimesError = Class.new(StandardError)
 
   def self.included(base)
     base.extend ClassMethods
@@ -17,40 +14,41 @@ module ActsAsIdentifier
     # == Automatically generate unique string based on id
     #
     # @param attr [String, Symbol] column name, default: :identifier
+    # @param seed [Integer] Random seed, default: 1
     # @param length [Integer] length of identifier, default: 6
-    # @params prefix [String, Symbol] add prefix to value, default: ''
+    # @params prefix [String, Symbol] add prefix to value, default: nil
     # @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
+    # @params chars [String] chars for generating identifier
     def acts_as_identifier(attr = :identifier,
+                           seed: 1,
                            length: 6,
-                           prefix: '',
+                           prefix: nil,
                            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
+                           chars: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
+      define_singleton_method "#{attr}_encoder" do
+        vname = "@#{attr}_encoder"
+        return instance_variable_get(vname) if instance_variable_defined?(vname)
 
-      encoder = Encoder.new(chars: chars, mappings: mappings, length: length)
+        instance_variable_set(vname, Xencoder.new(chars, length: length, seed: seed))
+      end
 
       define_singleton_method "decode_#{attr}" do |str|
-        encoder.decode(str[prefix.length..-1])
+        if prefix
+          return nil unless str.to_s.start_with?(prefix)
+          str = str[prefix.length..-1]
+        end
+        str && send("#{attr}_encoder").decode(str)
       end
 
       define_singleton_method "encode_#{attr}" do |num|
-        "#{prefix}#{encoder.encode(num)}"
+        "#{prefix}#{send("#{attr}_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
+      define_method "acts_as_identifier__update_#{attr}" do
+        update_column attr, self.class.send("encode_#{attr}", send(id_column))
       end
+
+      before_commit :"acts_as_identifier__update_#{attr}", if: -> { previous_changes.key?(id_column.to_s) && !destroyed? }
     end
   end
 end
-
-require 'acts_as_identifier/railtie' if defined?(Rails)

data/lib/acts_as_identifier/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_identifier
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.3
 platform: ruby
 authors:
 - xiaohui
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: xencoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - xiaohui@tanmer.com
 executables: []
@@ -48,15 +62,12 @@ 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
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -71,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Auto-generate unique identifier value for Active Record
 test_files: []

data/lib/acts_as_identifier/encoder.rb

@@ -1,36 +0,0 @@
-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/railtie.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module ActsAsIdentifier
-  class Railtie < ::Rails::Railtie
-    initializer 'acts_as_identifier' do
-      ActiveSupport.on_load(:active_record) do
-        include ActsAsIdentifier
-      end
-    end
-  end
-end

data/lib/acts_as_identifier/xbase_integer.rb

@@ -1,23 +0,0 @@
-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