acts_as_identifier 1.1.0 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e24cb96573ceb1e6439218ab0791c25fca1ff4de0e5320019039a2f1e56e0ce
-  data.tar.gz: 1958d5829d519f497c3c215183f7d071d7e68ccfb66521d2a14db3da0a26e3ba
+  metadata.gz: 7efb2fc3ad0b08e22b058358c990f15bf0a516c34c95824a8b197f1a4518e74b
+  data.tar.gz: 45eba2d5385ea34bdd6fa355001644ead93d65071f1bdc2499d980985c891b69
 SHA512:
-  metadata.gz: ed7ff77501adb90ca3b030cda300d974cc92c577863589316a3e4a34f0d14dbf84c2f57e167af13f816ef0ddb9f946b754e3a6d5e3e454f4f42e3ad85180b8d7
-  data.tar.gz: fab6c448257751fd41b08af088f59753d3154ef64bd506604e23881122221bb9338a824bfc0b4f19b697fb2e0762b03d313187dbf56e1d6141db080b87eaf2d7
+  metadata.gz: f2b83dc95625f42cab1b5b3e10e125e22c70f5fcbd06c4dc94a63f99916d5a4a0da14390bcb93314d96a8b01995a351b67141fc56692e8fabe718f447a732d00
+  data.tar.gz: 5dd8b25d169fe579cc3a6e48d34fa82483e37e882a57b5a1069543beaceb91103a47605b8a8cd86db98d3b7a10fb88d10a29522a54fac8b9a689bd9123180a7e

data/README.md

@@ -14,12 +14,12 @@ class Account < ActiveRecord::Base
   #
   # == default options
   #
-  # def acts_as_identifier(attr = :identifier,
-  #                             seed: 1,
-  #                           length: 6,
-  #                           prefix: '',
-  #                        id_column: :id,
-  #                            chars: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
+  #      attr: :identifier,
+  #      seed: 1,
+  #    length: 6,
+  #    prefix: nil,
+  # id_column: :id,
+  #     chars: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
   #
   acts_as_identifier
   # or customize options:
@@ -31,9 +31,16 @@ Account.create
 # => #<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">
-
 ```
 
+## Features
+
+- *`ActiveRecord`*.find_by_decoded_*`identifier`*('s-EPaPaP') => Actually find by id, id is decoded from identifier, with this method you don't need to add extra index for *`identifier`*
+- *`ActiveRecord`*.find_by_decoded_*`identifier`*!('s-EPaPaP') => equal to find_by_xx!
+- *`ActiveRecord`*.*decode_`identifier`*('s-EPaPaP') => decode identifier to id
+- *`ActiveRecord`*.*encode_`identifier`*(1) => encode id to identifier
+- *`ActiveRecord`*.*`identifier`*_encoder => encoder instance, see [xencoder](https://github.com/xiaohui-zhangxh/xencoder)
+
 ## Installation
 
 ```ruby

data/lib/acts_as_identifier.rb

@@ -14,15 +14,15 @@ 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')
       define_singleton_method "#{attr}_encoder" do
@@ -33,18 +33,30 @@ module ActsAsIdentifier
       end
 
       define_singleton_method "decode_#{attr}" do |str|
-        send("#{attr}_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}#{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_singleton_method "find_by_decoded_#{attr}" do |str|
+        find_by(id_column => public_send("decode_#{attr}", str))
+      end
+
+      define_singleton_method "find_by_decoded_#{attr}!" do |str|
+        find_by!(id_column => public_send("decode_#{attr}", str))
       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

data/lib/acts_as_identifier/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_identifier
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.4
 platform: ruby
 authors:
 - xiaohui
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xencoder
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - xiaohui@tanmer.com
 executables: []
@@ -67,7 +67,7 @@ homepage: https://github.com/xiaohui-zhangxh/acts_as_identifier
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,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: []