acts_as_identifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56a684b60d5b16c517e29049493feee1bed693c74b5de33fd18100454fa53547
+  data.tar.gz: 81c9a2c9b6a3c7cc7fd87ef3123f595cab818783018e22b9423ed6aee085fd2c
+SHA512:
+  metadata.gz: 178d1de2dd01dce8afdeb933cc9bec7a18b38132e8ead74dc1271d5d33eb6e7ee37f72c4bf0c8142fc9d7e7b4c1f2bd5136cd2f9fbbd74ada4be9d7e854573af
+  data.tar.gz: c8c1d26f4ec778832a14dd1bae837f6c90786098302dccf0ed3938e82930d54aab4f26d59cf17b1815a03242ebeba3f4c8174dc01913ddc2cd8f4d3c8263a8d8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# ActsAsIdentifier
+
+Automatically generate unique secure random string for one or more columns of ActiveRecord.
+
+## Usage
+
+> `ActsAsIdentifier` only generate identifier `before create`
+
+```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: []
+  acts_as_identifier
+
+  # extra column
+  acts_as_identifier :slug, length: 8, case_sensitive: false, max_loop: 1000, scope: [:tenant_id]
+end
+# => [Account(id: integer, name: string, tenant_id: string, identifier: string, slug: string)]
+
+Account.create
+# => #<Account:0x00007fcdb90830c0 id: 1, name: nil, tenant_id: nil, identifier: "PWbYHd", slug: "5fabb1e7">
+
+```
+
+## Installation
+
+```ruby
+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).

data/lib/acts_as_identifier.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'acts_as_identifier/version'
+
+module ActsAsIdentifier
+  LoopTooManyTimesError = Class.new(StandardError)
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    #
+    # == Automatically generate unique secure random string
+    #
+    # @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: []
+    def acts_as_identifier(attr = nil, length: 6, case_sensitive: true, max_loop: 100, scope: [])
+      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}=", SecureRandom.send(method, length))
+          break unless query.where(attr => value).exists?
+          raise LoopTooManyTimesError if n > max_loop
+        end
+      end
+    end
+  end
+end
+
+require 'acts_as_identifier/railtie' if defined?(Rails)

data/lib/acts_as_identifier/railtie.rb

@@ -0,0 +1,11 @@
+# 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/version.rb

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

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_identifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- xiaohui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- xiaohui@tanmer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Auto-generate unique identifier value for Active Record
+test_files: []