pretty_id 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2adaf9801acbc841856a03333afaaddf61d1eba3
-  data.tar.gz: 478f9e9224476be744f41cf237d8e774ed2af44a
+  metadata.gz: a7f1120896f3956cc8a5706975b38fcec7f4fdeb
+  data.tar.gz: 8d816ca3e1a09fff5db1550088b87ce5e3343f8b
 SHA512:
-  metadata.gz: dcf2bbba6f40717818e2eecee56d154557b620313c9666d7643e3ed03e443c81e1dbd369e9d369b898e537fa03e8dc57df9dbe87b14d8cfd7751c19a971926e8
-  data.tar.gz: da70deca1e75cb700629ae154d02358ad50185443644b2369ba39a9691bd9e7b1528ff45c73a7fe2fa9f1d88474ccbd330a0879c03b638ced897f4e9dbb872cd
+  metadata.gz: d80a89411bee051f8fc265ea1dbe676a98f455f1c78d5b960a6d18449b5c6c724787f8784738b3385ca65909f547961a5359473c3769dba0f1db26b73e8dafad
+  data.tar.gz: ab3657e910acdb234d8c1ba15c81ab6745c1d0d5823576ed6eafd745058143d53b2020d25addd7401638cb37fc66d3068b3beb7af1bcd253d874a70a4a0fea54

data/README.md

@@ -28,19 +28,43 @@ class Book < ActiveRecord::Base
 end
 ```
 
+## Generation methods
+
+#### :pretty (default)
+```ruby
+chars = ('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a
+Array.new(options[:length]) { chars[rand(chars.length)] }.join
+```
+
+#### :urlsafe_base64
+```ruby
+SecureRandom.urlsafe_base64(options[:length] / 1.333)
+```
+
 ## Options
 ```ruby
 class Book < ActiveRecord::Base
-  has_pretty_id column: :another_string_column,   # default: :pretty_id
+  has_pretty_id method: :urlsafe_base64,          # default: :pretty
+                column: :another_string_column,   # default: :pretty_id
                 length: 12                        # default: 8
 end
 ```
 
-## Warnings
+## Instance methods
+
+#### `#regenerate_#{column_name}`
+```ruby
+user = User.create
+user.pretty_id # => 'a0923sdf'
+user.regenerate_pretty_id
+user.pretty_id # => 'lf91fs9s'
+```
+
+#### `#regenerate_#{column_name}!`
+Same as above, but also calls `save` on the record
 
-Pretty IDs are generated using the [Bignum#to_s](http://www.ruby-doc.org/core-2.1.1/Bignum.html#method-i-to_s) method, and since we're seeding with a random value, there's no guarantee that they'll always be 8 characters long. However, the IDs are always checked against existing values in the database to ensure uniqueness.
 
-[0]: http://img.shields.io/travis/dobtco/pretty_id.svg
-[1]: http://img.shields.io/codeclimate/github/dobtco/pretty_id.svg
-[2]: http://img.shields.io/coveralls/dobtco/pretty_id.svg
-[3]: http://img.shields.io/gem/v/pretty_id.svg
+[0]: https://img.shields.io/travis/dobtco/pretty_id.svg
+[1]: https://img.shields.io/codeclimate/github/dobtco/pretty_id.svg
+[2]: https://img.shields.io/coveralls/dobtco/pretty_id.svg
+[3]: https://img.shields.io/gem/v/pretty_id.svg

data/lib/pretty_id/core.rb

@@ -8,14 +8,30 @@ module PrettyId
       def has_pretty_id(options = {})
         default_options = {
           column: :pretty_id,
-          length: 8
+          method: :pretty
         }
 
         options = default_options.merge(options)
 
+        case options[:method]
+        when :pretty
+          options[:length] ||= 8
+          options[:generate_proc] = -> {
+            chars = ('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a
+            Array.new(options[:length]) { chars[rand(chars.length)] }.join
+          }
+        when :urlsafe_base64
+          options[:length] ||= 21
+          options[:generate_proc] = -> {
+            SecureRandom.urlsafe_base64(options[:length] / 1.333)
+          }
+        else
+          fail 'Unknown :method passed to has_pretty_id'
+        end
+
         define_method(:"generate_#{options[:column]}") do
           new_pretty_id = loop do
-            random_pretty_id = rand(36**options[:length]).to_s(36)
+            random_pretty_id = options[:generate_proc].call
             exists_hash = {}
             exists_hash[options[:column]] = random_pretty_id
             break random_pretty_id unless self.class.exists?(exists_hash)
@@ -24,6 +40,15 @@ module PrettyId
           self.send "#{options[:column]}=", new_pretty_id
         end
 
+        define_method(:"regenerate_#{options[:column]}") do
+          self.send("generate_#{options[:column]}")
+        end
+
+        define_method(:"regenerate_#{options[:column]}!") do
+          self.send("generate_#{options[:column]}")
+          self.save
+        end
+
         before_create :"generate_#{options[:column]}"
       end
     end

data/lib/pretty_id/version.rb

@@ -1,3 +1,3 @@
 module PrettyId
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/pretty_id_spec.rb

@@ -5,6 +5,21 @@ class UserWithPrettyId < ActiveRecord::Base
   has_pretty_id
 end
 
+class UserWithLongerPrettyId < ActiveRecord::Base
+  self.table_name = 'users'
+  has_pretty_id length: 16
+end
+
+class UserWithUrlsafeBase64PrettyId < ActiveRecord::Base
+  self.table_name = 'users'
+  has_pretty_id method: :urlsafe_base64
+end
+
+class UserWithLongerUrlsafeBase64PrettyId < ActiveRecord::Base
+  self.table_name = 'users'
+  has_pretty_id method: :urlsafe_base64, length: 32
+end
+
 class UserWithPrettyIdAlt < ActiveRecord::Base
   self.table_name = 'users'
   has_pretty_id column: :pretty_id_alt
@@ -34,12 +49,60 @@ describe PrettyId do
   describe 'preventing duplicates' do
     before do
       UserWithPrettyId.stub(:exists?).and_return(true, false)
-      UserWithPrettyId.any_instance.stub(:rand).and_return(1, 2)
+      UserWithPrettyId.stub(:rand).and_return(1, 2)
     end
 
     it 'prevents duplicates' do
       u = UserWithPrettyId.create
-      expect(u.pretty_id).to eq '2'
+      expect(u.pretty_id).to eq 'cccccccc'
+    end
+  end
+
+  describe 'method = pretty' do
+    it 'assigns 8 characters' do
+      u = UserWithPrettyId.new
+      u.generate_pretty_id
+      expect(u.pretty_id.length).to eq 8
+    end
+
+    it 'assigns longer ids' do
+      u = UserWithLongerPrettyId.new
+      u.generate_pretty_id
+      expect(u.pretty_id.length).to eq 16
+    end
+  end
+
+  describe 'method = urlsafe_base64' do
+    it 'assigns ~21 characters' do
+      u = UserWithUrlsafeBase64PrettyId.new
+      u.generate_pretty_id
+      expect(u.pretty_id.length).to eq be_within(1).of(21)
+    end
+
+    it 'assigns more characters' do
+      u = UserWithLongerUrlsafeBase64PrettyId.new
+      u.generate_pretty_id
+      expect(u.pretty_id.length).to eq be_within(1).of(32)
+    end
+  end
+
+  describe '#regenerate_pretty_id' do
+    let(:user) { UserWithPrettyId.create }
+
+    it 'regenerates' do
+      expect {
+        user.regenerate_pretty_id
+      }.to change { user.pretty_id }
+    end
+
+    it 'does not call save' do
+      expect(user).to_not receive(:save)
+      user.regenerate_pretty_id
+    end
+
+    it 'has a dangerous counterpart' do
+      expect(user).to receive(:save)
+      user.regenerate_pretty_id!
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pretty_id
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Adam Becker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails