public_uid 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cd4cccc86e11b76e1a46d7cc471dace3bc5a8c3
-  data.tar.gz: 815f34a839ea4b11419fd11c44b24a6325a396f9
+  metadata.gz: 76143c57285dda08be346c203901c384bc273bf0
+  data.tar.gz: 1bf42db639233d908a3bd447c57d9be3582fa572
 SHA512:
-  metadata.gz: 6c4c3b9ba948a19a316c4dc24a57b04a65718415de4e7353f964980ec80f3b99e34a4642fb1547d467fcbde377f4e3b62873b67e62914eb7f6e9e37a4595135f
-  data.tar.gz: ec5c68da6ce0135e8ef1266b847f2d40d3570a34369235050f4be92614aae1729d42e979f109af01cfb7fd0491d1fb9762025ffb753a6928e9e83b337a8c3f67
+  metadata.gz: fd980096e936fa5816f1838aeb614d2d51dda724f66f046e45bceab9d072a0103e09a07325e92e800d45217352dc10cfe464c0897888b9711090c98d3a820428
+  data.tar.gz: 31f622b8165abae325f8c81921820fc18b91bf8dd0fe6c51a152c989834ef6a31b3841ef9d0a1e9ce40fec2ca57941e99e8f3c73b0591e0c8cad7d7a0cb7b8c3

data/README.md

@@ -19,17 +19,18 @@ against you.
 
 This is bad: 
 
-    http://eq8.eu/orders/12/edit
-    http://eq8.eu/orders/12-order-for-mouse-and-keyboard/edit
+    http://www.eq8.eu/orders/12/edit
+    http://www.eq8.eu/orders/12-order-for-mouse-and-keyboard/edit
 
 However if you generate random unique identifier and use that as a public
 identifier, you won't have to worry about that.
 
 This is how it should be: 
 
-    http://eq8.eu/orders/8395820/edit
-    http://eq8.eu/orders/abaoeule/edit
-    http://eq8.eu/orders/aZc3/edit
+    http://www.eq8.eu/orders/8395820/edit
+    http://www.eq8.eu/orders/8395820-order-for-mouse-and-keyboard/edit
+    http://www.eq8.eu/orders/abaoeule/edit
+    http://www.eq8.eu/orders/aZc3/edit
 
 So keep `record.id` for your internal relationships and show `public_id`
 to the world :smile:
@@ -47,7 +48,7 @@ And then execute:
 
 ## Usage
 
-Create database column for public unique id. It have to be string.
+Create database column for public unique ID.
 
 ```ruby
 class AddPublicUidToUsers < ActiveRecord::Migration
@@ -65,7 +66,7 @@ class User < ActiveRecord::Base
 end
 ```
 
-This will automatically generate 7 digit random unique number for 
+This will automatically generate unique 8 char downcase string for 
 column `public_uid`. 
 
 
@@ -73,7 +74,7 @@ column `public_uid`.
 u = User.new
 u.public_uid  #=> nil
 u.save!       #=> true
-u.public_uid  #=> 9392049
+u.public_uid  #=> "aeuhsthi"
 ```
 
 If you want to use different column just specify column option:
@@ -88,15 +89,15 @@ end
 u = User.new
 u.guid  #=> nil
 u.save! #=> true
-u.guid  #=> 8392049
+u.guid  #=> "troxuroh"
 ```
 
-If you want to generate random string you can use built-in string
+If you want to generate random Integer you can use built-in number 
 generator:
 
 ```ruby
 class User < ActiveRecord::Base
-  generate_public_uid generator: PublicUid::Generators::RangeString.new
+  generate_public_uid generator: PublicUid::Generators::NumberRandom.new
 end
 ```
 
@@ -104,9 +105,14 @@ end
 u = User.new
 u.public_uid  #=> nil
 u.save!       #=> true
-u.public_uid  #=> "azuberdc"
+u.public_uid  #=> 4567123
 ```
 
+**Note** Warning **PostgreSQL** have built in type safety meaning that this
+generator wont work if your public uniq ID column is a String (as the
+gem would try to set Integer on a String). If you really want a number
+like string you can specify number range for Range String Generator
+
 ### Customizing generated string
 
 ```ruby
@@ -123,6 +129,17 @@ u.save!       #=> true
 u.public_uid  #=> "aZ3e"
 ```
 
+To generate number format String you can specify number range 
+
+```
+class User < ActiveRecord::Base
+  UID_RANGE = ('1'..'9').to_a
+  generate_public_uid generator: PublicUid::Generators::RangeString.new(4, UID_RANGE)
+end
+
+# User.create.public_uid  == "1234"
+```
+
 ### Customizing randomized number 
 
 ```ruby

data/lib/public_uid/model.rb

@@ -16,7 +16,7 @@ module PublicUid
 
       def generate_public_uid(options={})
         @public_uid_column    = options[:column]    || :public_uid
-        @public_uid_generator = options[:generator] || Generators::NumberRandom.new
+        @public_uid_generator = options[:generator] || Generators::RangeString.new
         before_create :generate_uid, unless: @public_uid_column
       end
     end

data/lib/public_uid/set_public_uid.rb

@@ -1,5 +1,10 @@
 module PublicUid
   class SetPublicUid
+    NewUidNotSetYet             = Class.new(StandardError)
+    PublicUidColumnDoesNotExist = Class.new(StandardError)
+    NoPublicUidColumnSpecified  = Class.new(StandardError)
+    NoRecordSpecified           = Class.new(StandardError)
+
     attr_reader :new_uid
 
     def initialize(options)
@@ -22,16 +27,11 @@ module PublicUid
     private
 
     def similar_uid_exist?
-      @klass.where(public_uid: new_uid.to_s).count > 0
+      @klass.where(public_uid: new_uid).count > 0
     end
 
     def check_column_existance
       raise PublicUidColumnDoesNotExist if @klass.column_names.include?(@column)
     end
-
-    class NewUidNotSetYet < StandardError; end
-    class PublicUidColumnDoesNotExist < StandardError; end
-    class NoPublicUidColumnSpecified  < StandardError; end
-    class NoRecordSpecified           < StandardError; end
   end
 end

data/lib/public_uid/version.rb

@@ -1,3 +1,3 @@
 module PublicUid
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/test/lib/set_public_uid_test.rb

@@ -76,10 +76,13 @@ TestConf.orm_modules.each do |orm_module|
 
         before { mock(instance).new_uid { 567 } }
 
-        # Due to PostgreSQL type check feature
-        it 'must look for integer generated numbers as a string' do 
-          count_mock = stub(record_class).count { 123 }
-          stub(record_class).where( { public_uid: "567" } ) { count_mock }
+        # There is an issue with passing integer to PostgreSQL type check
+        # in previous version application deal with this issue by converting
+        # everything given by generator to string which is wrong. If the output
+        # of generator is not supported by DB don't use it.
+        it 'must pass exact type of generator to model' do 
+          count_mock = stub(record_class).count { 10 }
+          stub(record_class).where( { public_uid: 567 } ) { count_mock }
 
           trigger.must_equal true
         end

data/test/models/custom_public_uid_column_test.rb

@@ -2,23 +2,25 @@ require 'test_helper'
 
 TestConf.orm_modules.each do |orm_module|
   describe orm_module.description do
-    let(:user) { "#{orm_module}::CustomPublicUidColumnModel".constantize.new }
+    context 'Model with custom public uid column' do
+      let(:user) { "#{orm_module}::CustomPublicUidColumnModel".constantize.new }
 
-    describe '#custom_uid' do
-      subject{ user.custom_uid }
+      describe '#custom_uid' do
+        subject{ user.custom_uid }
 
-      context 'in new record' do
-        it{ subject.must_be_nil }
-      end
-
-      context 'after save' do
-        before do
-          user.save
-          user.reload
+        context 'in new record' do
+          it{ subject.must_be_nil }
         end
-        it{ subject.wont_be_nil }
-        it 'by default should generate 7 digit number string' do
-          subject.to_i.to_s.length.must_equal(7)
+
+        context 'after save' do
+
+          before do
+            user.save
+            user.reload
+          end
+
+          it{ subject.must_be_kind_of(String) }
+          it{ subject.length.must_equal(8) }
         end
       end
     end

data/test/models/model_with_custom_generator_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 TestConf.orm_modules.each do |orm_module|
   describe orm_module.description do
-    describe 'ModelWithCustomGererator' do
+    context 'Model with custom uid generator' do
       let(:user) { "#{orm_module}::ModelWithCustomGererator".constantize.new }
 
       describe '#public_uid' do

data/test/models/model_with_generator_defaults_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 TestConf.orm_modules.each do |orm_module|
   describe orm_module.description do
-    describe 'ModelWithGeneratorDefaults' do
+    context 'Model with default generator' do
       let(:user) { "#{orm_module}::ModelWithGeneratorDefaults".constantize.new }
 
       describe '#public_uid' do
@@ -13,14 +13,14 @@ TestConf.orm_modules.each do |orm_module|
         end
 
         context 'after save' do
+
           before do
             user.save
             user.reload
           end
-          it{ subject.wont_be_nil }
-          it 'by default should generate 7 digit number string' do
-            subject.to_i.to_s.length.must_equal(7)
-          end
+
+          it{ subject.must_be_kind_of(String) }
+          it{ subject.length.must_equal(8) }
         end
       end
     end

data/test/support/orm/active_record.rb

@@ -1,5 +1,5 @@
 ActiveRecord::Base::establish_connection(adapter: 'sqlite3', database: ':memory:')
-ActiveRecord::Base.connection.execute(%{CREATE TABLE users  (id INTEGER PRIMARY KEY, public_uid VARCHAR, custom_uid INTEGER);})
+ActiveRecord::Base.connection.execute(%{CREATE TABLE users  (id INTEGER PRIMARY KEY, public_uid VARCHAR, custom_uid VARCHAR);})
 
 module ActRec
   def self.description

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: public_uid
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Tomas Valent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orm_adapter