has_public_id 1.1.0 → 1.1.5

data/README.md

@@ -2,20 +2,17 @@
 
 ## Description
 
-Simplifies the generation and use of random, secure ID's in your activerecord models.
+Simplifies the generation and use of unique, random identifiers for ActiveRecord models.
 
-Uses SecureRandom.urlsafe_base64(10) by default, which generates a 14 character
-base 64 encoded string with the following characters: a-z, A-Z, 0-10, "-" and "_".
+We generate a string of random (using SecureRandom) alphanumeric characters (a-z, A-Z, 0-9) along with an optional prefix that defaults to the first 3 characters of the model name. The random string has a default length of 12, providing 62 ^ 12 possible strings.
 
-Assuming an even distribution, this allows for 64 ^ 14 different possible encodings
-with the default settings.
-
-Even so, the plugin is smart enough to discard ID's that are already in use for
-a given model and try again.
+On assignment to the model, if duplicate ID is detected in
+the database, a new random identifier is generated.
 
 ## Installation
 Add to Gemfile / etc
-  gem 'public_id'
+
+    gem 'public_id'
 
 ## Usage
 
@@ -28,11 +25,11 @@ rails generate migration add_ident_to_users ident:string
 Tell your activerecord object that ident is your new public identifier.
 ```ruby
 class User < ActiveRecord::Base
-  has_public_id :ident
+  has_public_id :ident, prefix: 'user'
   # Automatically defines to_param as :ident
 end
 User.new.ident
-# => "use-ECNrdIzvCBh8jg"
+# => "user-ECNrdIzvCBh8"
 
 ```
 

data/lib/has_public_id/activerecord/mixin.rb

@@ -36,6 +36,9 @@ module HasPublicId
             def find_by_public_id(public_id)
               where(self.public_id_attr => public_id).first
             end
+            def find_by_public_id!(public_id)
+              where(self.public_id_attr => public_id).first!
+            end
             def new_public_id
               while(true)
                 new_id = ::HasPublicId::Util.new_public_id(self, self.public_id_options)

data/lib/has_public_id/util.rb

@@ -1,16 +1,24 @@
 module HasPublicId
   module Util
+    DEFAULT_CHAR_SET = (0..9).collect { |i| i.to_s } + ('A'..'Z').to_a + ('a'..'z').to_a
+    def self.char_set
+      @car_set ||= DEFAULT_CHAR_SET
+    end
     def self.generate_random_suffix(length)
-      SecureRandom.urlsafe_base64(length)
+      (0...length.to_i).map do |i|
+        char_set[SecureRandom.random_number(char_set.length)]
+      end.join
     end
-    def self.generate_prefix(klass, joiner)
-      klass.to_s.demodulize.underscore.first(3) + joiner
+    def self.generate_prefix(klass)
+      klass.to_s.demodulize.underscore.first(3)
     end
     def self.new_public_id(klass, options = {})
-      length = options[:length] || 10
-      prefix = options.fetch(:prefix, generate_prefix(klass, options.fetch(:joiner, '-') ))
+      length = options[:length] || 12
+      prefix = options.fetch(:prefix, generate_prefix(klass))
+      prefix = nil if !prefix || prefix.empty?
+      join_with = options.fetch(:join_with, '-')
       suffix = generate_random_suffix(length)
-      "#{prefix ? prefix : ''}#{suffix}"
+      [prefix, suffix].compact.join(join_with)
     end
 
   end

data/lib/has_public_id/version.rb

@@ -1,3 +1,3 @@
 module HasPublicId
-  VERSION = "1.1.0"
+  VERSION = "1.1.5"
 end

data/test/dummy/app/models/user.rb

@@ -1,3 +1,3 @@
 class User < ActiveRecord::Base
-  has_public_id :ident
+  has_public_id :ident, prefix: 'user'
 end