public_uid 1.2.1 → 1.2.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YmE5ZTQ4YjY0ZjYyYzBhZjQ3ODE1YWFkMGI3NTEwZGFmYTM2NmNiMg==
-  data.tar.gz: !binary |-
-    YTM1ZGMyMmNlMjJjMGIwOWJkNGIyMTc0NjRlNWU0OGI2ODJhZjA5OQ==
+SHA1:
+  metadata.gz: 7323c6067a97bf3479759130f27f3ab6a2629084
+  data.tar.gz: 2a5aa34772776cc391d103d9f1ecb776899f0b0e
 SHA512:
-  metadata.gz: !binary |-
-    ZWQ5NjBlZDA3YWU5ODc4NzYzY2EzNTI3Y2Y2Y2I5Y2RhMDAxYWJiMTZkMzMz
-    ZjI4OTgwNDhmZmY3ZDNhNGY3Y2EyNmZjZDMzMWQ2NDE5NDg1NGFlODhjMGQy
-    N2ZiNmQwYTVlOGFmNGY1MjdkYmU4ZGY0NGE5Yjg5YTNjYjdmODU=
-  data.tar.gz: !binary |-
-    NGJjOGNlZDg2M2NlMDY1YTczN2JmZTA3MDQ4NjdmODE1OTM2MTZlNjY2Y2Fj
-    OWNhODQwZjk3YTIzOGY0NGNkM2U0YjA5YTYzZWRkZTE0NTgwNGU1YTg2NTlh
-    YjUyZmRjOTY5OTU3YzNhZmRlMzIyM2ZkMDgxZGI2NjE5Mzk5NWY=
+  metadata.gz: 51f04e7f8a1331cacee37033b013237a49cbd9946d9f564998705c4ba5be1a1a2e16960a09d9de298579178cc97bcb612d361301795aa80c21178974eb4ff4c9
+  data.tar.gz: 935f54f79fcd7b681e8ad76f28a5b98d45810236ed2fc86862a6a38dad9e1d1b0a30c13a6815a460d27ffc45c3411ac55b839236c043dc67c5ead9e1eee9d49e

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.idea
 .yardoc
 Gemfile.lock
 InstalledFiles
@@ -15,5 +16,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.ruby-version
-.ruby-gemset
+.ruby-version*
+.ruby-gemset*

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
   - 2.1.1
   - 2.2.2
+  - 2.3.0
   - ruby-head

data/README.md

@@ -77,6 +77,34 @@ u.save!       #=> true
 u.public_uid  #=> "aeuhsthi"
 ```
 
+Then you can do more clever things like having urls based on `public_uid` and `title` (http://blog.teamtreehouse.com/creating-vanity-urls-in-rails)
+
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  generate_public_uid
+
+  def self.find_param(param)
+    find_by! public_uid: param.split('-').first
+  end
+  
+  def to_param
+    "#{public_uid}-#{tile.gsub(/\s/,'-')}"
+  end
+end
+ 
+# app/controllers/users_controller.rb
+class UsersController < ActionController::Base
+  # ...
+  def show
+    @user = User.find_param(param[:id])
+    # ...
+  end
+  # ...
+end
+```
+
+
 If you want to use different column just specify column option:
 
 ```ruby
@@ -177,6 +205,58 @@ Model ValidationType: generating public_uids for missing records
   * generating 0 public_uid(s)
 ```
 
+## Alternatives
+
+There is a lot of reasons behind the existance of this gem, we are fully aware there are "built" in alternatives it's just they don't quite fit the purpouse of Developer to chose char range himself. 
+
+Anyway if you hate our guts for writing this gem try something like:
+
+#### UUID
+
+```ruby
+class Post < ActiveRecord::Base
+ before_create :generate_random_id
+
+ private 
+ def generate_random_id
+   self.id = SecureRandom.uuid
+ end 
+end
+```
+
+Or if you are using Rails >= 4 and PostgreSQL, you can have it generating them for you :
+
+```ruby
+create_table :posts, id: :uuid do |t|
+  ...
+end
+```
+
+* [Source](http://stackoverflow.com/a/34679841)
+
+#### SecureRandom.random_number
+
+```ruby
+class MyModel < ActiveRecord::Base
+  before_create :randomize_id
+  
+  private
+  def randomize_id
+    begin
+      self.id = SecureRandom.random_number(1_000_000)
+    end while Model.where(id: self.id).exists?
+  end
+end
+
+```
+
+Or you can use `SecureRandom.hex`
+
+In future gem version we will actually introduce this two generators.
+
+* [Source](http://stackoverflow.com/a/13680914)
+
+
 ## Contributing
 
 1. Fork it

data/lib/public_uid/set_public_uid.rb

@@ -27,7 +27,7 @@ module PublicUid
     private
 
     def similar_uid_exist?
-      @klass.where(public_uid: new_uid).count > 0
+      @klass.where(@column => new_uid).count > 0
     end
 
     def check_column_existance

data/lib/public_uid/tasks/generate.rake

@@ -1,20 +1,21 @@
+require 'rake'
+
 namespace :public_uid do
-  desc "Generate public_uid on Models that have public_uid column on records that have nil public_uid"
+  desc "Generate public_uid on Models that have public_uid column on records that have nil value"
   task :generate => :environment do
-    Rails.application.eager_load!
     ActiveRecord::Base.descendants.each do |model|
-      model.connection # establis conection
+      model.connection # establish conection
 
       if model.instance_methods.collect(&:to_s).include?('generate_uid')
-        puts "Model #{model.name}: generating public_uids for missing records"
-
+        puts "Model #{model.name}:"
+        uid_column_name = model.public_uid_column
         model
-          .where(public_uid: nil)
-          .tap { |scope| puts "  * generating #{scope.count} public_uid(s)" }
-          .each do |record_without_public_uid|
-            record_without_public_uid.generate_uid
-            record_without_public_uid.save!
-          end
+          .where(uid_column_name => nil)
+          .tap { |scope| puts "  * generating #{scope.count} #{uid_column_name}(s) for #{model.table_name}" }
+          .find_each do |record_without_public_uid|
+          record_without_public_uid.generate_uid
+          record_without_public_uid.save!
+        end
         puts ''
       end
     end

data/lib/public_uid/version.rb

@@ -1,3 +1,3 @@
 module PublicUid
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/public_uid.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "~> 5"
   spec.add_development_dependency "rr", "~> 1.1.2"
   spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "activerecord", '~> 3.2'
+  spec.add_development_dependency "activerecord", '~> 4.2' # ensures compatibility for ruby 2.0.0+ to head
 end

data/test/lib/set_public_uid_test.rb

@@ -21,7 +21,7 @@ TestConf.orm_modules.each do |orm_module|
       let(:options)  { {record: record, column: :public_uid} }
       let(:instance) { PublicUid::SetPublicUid.new options }
       let(:record)   { record_class.new }
-      let(:record_class) { "#{orm_module}::User".constantize }
+      let(:record_class) { "#{orm_module}::ModelWithGeneratorDefaults".constantize }
 
       describe 'initialization' do
         context 'when column not specified' do

data/test/lib/tasks/generate_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+require 'rake'
+
+describe 'Generate' do
+  before :all do
+    # load File.expand_path('../../../../lib/public_uid/tasks/generate.rake', __FILE__)
+    Rake.application.rake_require 'public_uid/tasks/generate'
+    Rake::Task.define_task(:environment)
+  end
+
+  TestConf.orm_modules.each do |orm_module|
+    describe orm_module.description do
+      {
+        "#{orm_module}::ModelWithGeneratorDefaults".constantize => :public_uid,
+        "#{orm_module}::ModelWithCustomGererator".constantize   => :public_uid,
+        "#{orm_module}::CustomPublicUidColumnModel".constantize => :custom_uid,
+      }.each_pair do |model, uid_column|
+
+        context "For #{model.name} with #{uid_column}" do
+          let(:run_generate_task) do
+            Rake::Task['public_uid:generate'].reenable
+            Rake.application.invoke_task 'public_uid:generate'
+          end
+
+          describe '#invoke' do
+            it 'generates uid' do
+              user = model.new
+              user.save!
+              initial_uid = user.send(uid_column)
+
+              # simulate an existing record with no uid value
+              user.update_attribute(uid_column, nil).must_equal true
+              user.send(uid_column).must_be_nil
+
+              # run the rake task
+              run_generate_task
+
+              user.reload
+              user.send(uid_column).must_be_kind_of String
+              user.send(uid_column).wont_be_empty
+              user.send(uid_column).wont_be_same_as initial_uid
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+
+end

data/test/models/custom_public_uid_column_test.rb

@@ -10,6 +10,14 @@ TestConf.orm_modules.each do |orm_module|
 
         context 'in new record' do
           it{ subject.must_be_nil }
+
+          describe '#generate_uid' do
+            before do
+              user.generate_uid
+            end
+
+            it { subject.wont_be_nil }
+          end
         end
 
         context 'after save' do

data/test/models/model_with_custom_generator_test.rb

@@ -10,6 +10,14 @@ TestConf.orm_modules.each do |orm_module|
 
         context 'in new record' do
           it{ subject.must_be_nil }
+
+          describe '#generate_uid' do
+            before do
+              user.generate_uid
+            end
+
+            it { subject.wont_be_nil }
+          end
         end
 
         context 'after save' do

data/test/models/model_with_generator_defaults_test.rb

@@ -10,6 +10,14 @@ TestConf.orm_modules.each do |orm_module|
 
         context 'in new record' do
           it{ subject.must_be_nil }
+
+          describe '#generate_uid' do
+            before do
+              user.generate_uid
+            end
+
+            it { subject.wont_be_nil }
+          end
         end
 
         context 'after save' do

data/test/support/orm/active_record.rb

@@ -1,5 +1,9 @@
 ActiveRecord::Base::establish_connection(adapter: 'sqlite3', database: ':memory:')
-ActiveRecord::Base.connection.execute(%{CREATE TABLE users  (id INTEGER PRIMARY KEY, public_uid VARCHAR, custom_uid VARCHAR);})
+# creates 3 `users` tables, with either `public_uid` or `custom_uid` (but not both), or no uid column,
+# to expose potential `SQLite3::SQLException: no such column` error.
+ActiveRecord::Base.connection.execute(%{CREATE TABLE users (id INTEGER PRIMARY KEY);})
+ActiveRecord::Base.connection.execute(%{CREATE TABLE user_puids (id INTEGER PRIMARY KEY, public_uid VARCHAR);})
+ActiveRecord::Base.connection.execute(%{CREATE TABLE user_cuids (id INTEGER PRIMARY KEY, custom_uid VARCHAR);})
 
 module ActRec
   def self.description
@@ -7,12 +11,12 @@ module ActRec
   end
 
   class CustomPublicUidColumnModel < ActiveRecord::Base
-    self.table_name = "users"
+    self.table_name = 'user_cuids'
     generate_public_uid column: :custom_uid
   end
 
   class ModelWithCustomGererator < ActiveRecord::Base
-    self.table_name = "users"
+    self.table_name = 'user_puids'
 
     gener_range = ('a'..'z').to_a+('A'..'Z').to_a
 
@@ -21,16 +25,12 @@ module ActRec
   end
 
   class ModelWithGeneratorDefaults < ActiveRecord::Base
-    self.table_name =  "users"
+    self.table_name =  'user_puids'
     generate_public_uid
   end
 
   class ModelWithoutGenaratePublicUid < ActiveRecord::Base
-    self.table_name =  "users"
-  end
-
-  class User < ActiveRecord::Base
-    self.table_name = 'users'
+    self.table_name =  'users'
   end
 end
 

metadata

@@ -1,113 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: public_uid
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Tomas Valent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2017-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orm_adapter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.2
 - !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'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
 description: Automatic generates public unique identifier for model
 email:
 - equivalent@eq8.eu
@@ -115,8 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -134,6 +134,7 @@ files:
 - test/lib/generators/number_random_test.rb
 - test/lib/generators/range_string_test.rb
 - test/lib/set_public_uid_test.rb
+- test/lib/tasks/generate_test.rb
 - test/models/custom_public_uid_column_test.rb
 - test/models/instance_methods_initialization_test.rb
 - test/models/model_with_custom_generator_test.rb
@@ -151,17 +152,17 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Automatic generates public UID column
@@ -169,6 +170,7 @@ test_files:
 - test/lib/generators/number_random_test.rb
 - test/lib/generators/range_string_test.rb
 - test/lib/set_public_uid_test.rb
+- test/lib/tasks/generate_test.rb
 - test/models/custom_public_uid_column_test.rb
 - test/models/instance_methods_initialization_test.rb
 - test/models/model_with_custom_generator_test.rb