acts_as_identifier 0.2.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50941b62619d0fa3829df18f02e97e46d02e7b35f052db3c64d9c7b821699826
-  data.tar.gz: 728fbeb1a33e0dd5f5f734f5a1e18821320df7118e79717b5bc543c9fceacec4
+  metadata.gz: 1d0ef5e8642b9ffa1aaf5dfa6e73a6d3b76885d08c90c8d6b74799c650b9ad86
+  data.tar.gz: 6637b7954d14b63f122ba48ba168fcdd6c8963e85188336d113b3d9c94c34a54
 SHA512:
-  metadata.gz: d323726b48026b4bb396a8837d47f1c45b6f3fded3972c3c7a51e7ca3bccbfdcfa11f33ba895dd081b21a2c3b79327f9348ad6987a0bff2695c32b868c6c1fd2
-  data.tar.gz: 6fba6c6ade83590f4c91909298da3133d01665014c187d12324d129f8d03a992cfaab01cab7693d869c124ec233e8e485de17ca7a3175e15b2c7aed6be9abbfe
+  metadata.gz: 53908ce8a218741b7a2466f77e99b6fb80ef22460d4d920f43585038d92913a573dc9142c42d3e227e93c8771d869d0467b4a80cdb33ed207e9c0dee18e32a2b
+  data.tar.gz: 21eb32be02eb86a40a84a00691800f48cb80831904afa6606ede41c1c985cb03cee67b134d083611b7b557ada0ea7697dcc3f5b0e1ab6674e15d08792b860197

data/README.md

@@ -2,33 +2,35 @@
 
 [![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 `before create`
+> `ActsAsIdentifier` only generate identifier `before_commit`
 
 ```ruby
 class Account < ActiveRecord::Base
+  include ActsAsIdentifier
   #
-  # Note: without Rails, should include ActsAsIdentifier
+  # == default options
+  #
+  #      attr: :identifier,
+  #      seed: 1,
+  #    length: 6,
+  #    prefix: nil,
+  # id_column: :id,
+  #     chars: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
   #
-
-  # with default options:
-  #           column: :identifier
-  #           length: 6
-  #   case sensitive: true
-  #         max_loop: 100
-  #            scope: []
   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-EPaPaP">
+Account.create
+# => #<Account:0x00007fcdb90830c0 id: 2, name: nil, tenant_id: nil, slug: "s-HSo0u4">
 
 ```
 
@@ -38,8 +40,15 @@ 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.
 
-## 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
+```

data/lib/acts_as_identifier.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-require 'securerandom'
 require 'acts_as_identifier/version'
+require 'xencoder'
 
 module ActsAsIdentifier
-  LoopTooManyTimesError = Class.new(StandardError)
 
   def self.included(base)
     base.extend ClassMethods
@@ -12,32 +11,46 @@ 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 seed [Integer] Random seed, default: 1
     # @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 prefix [String, Symbol] add prefix to value, default: nil
+    # @params id_column [String, Symbol] column name of id, default: :id
+    # @params chars [String] chars for generating identifier
+    def acts_as_identifier(attr = :identifier,
+                           seed: 1,
+                           length: 6,
+                           prefix: nil,
+                           id_column: :id,
+                           chars: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
+      define_singleton_method "#{attr}_encoder" do
+        vname = "@#{attr}_encoder"
+        return instance_variable_get(vname) if instance_variable_defined?(vname)
+
+        instance_variable_set(vname, Xencoder.new(chars, length: length, seed: seed))
+      end
+
+      define_singleton_method "decode_#{attr}" do |str|
+        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}#{send("#{attr}_encoder").encode(num)}"
+      end
+
+      define_method "update_#{attr}_before_commit" do
+        if previous_changes.key?(id_column.to_s) && !destroyed?
+          update_column attr, self.class.send("encode_#{attr}", send(id_column))
         end
       end
+
+      before_commit :"update_#{attr}_before_commit"
     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 = '0.2.0'
+  VERSION = '1.1.2'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_identifier
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.2
 platform: ruby
 authors:
 - xiaohui
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-12 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,13 +62,12 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/acts_as_identifier.rb
-- lib/acts_as_identifier/railtie.rb
 - lib/acts_as_identifier/version.rb
 homepage: https://github.com/xiaohui-zhangxh/acts_as_identifier
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -69,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/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