public_uid 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8df1654181a314bd55f3b19088d5da0637a81e3a84837b9a9f544cab4bfcf4e
-  data.tar.gz: c1c7658bec15be557d28fb91080973a98817931441dbb5733fa89fa4685c3b03
+  metadata.gz: 2feee63566bac287b2b37df241fe9f6d921815a25fa9d8ffda0ec2e51e79da88
+  data.tar.gz: '06879a851089f031f9729d7b9651e32ce5340ab2096db896c9001547b26be866'
 SHA512:
-  metadata.gz: 1a6dba79147370f0d36de14b9ae4d9de0fe58614f6a088cfd63dbf67674a6cafb477524514e7441060fad6bff1ed10092c1a8d08a2d9cbc83da4628dc987bff1
-  data.tar.gz: 5f4343c40e9575faa3f4bab8795b2025ac5bc44988aecfe7806059e28b02acbf9842023a509aabbd0b321c6c008ed5d55157f0b855a6b04b9c78259c0a6f2baf
+  metadata.gz: 592b580707bcb87cee3c82405b838011524d4197573f7ba3982c7b8cd3982fbd9605123e5b24a05f1c0b11be1bd54083fba0eaec27c47c157c361fb808ff1b90
+  data.tar.gz: c4b47726fd86694bd4213e72749841ba398dd408ed2d239fb749108df89ad93b4601a02eca1eac765b1eb0e17e16d79b9e69146ac552fecde9f237f89f667043

data/README.md

@@ -48,6 +48,9 @@ And then execute:
 
 ## Usage
 
+
+### Step 1 - db column
+
 Create database column for public unique ID.
 
 ```ruby
@@ -59,6 +62,29 @@ class AddPublicUidToUsers < ActiveRecord::Migration
 end
 ```
 
+### Step 2a - Using Rails concern
+
+> a.k.a - the easy way for Rails
+
+```ruby
+class User < ActiveRecord::Base
+  include PublicUid::ModelConcern
+end
+```
+
+This will automatically:
+
+* assumes your model has `public_uid` column and generate public_uid value for you
+* will automatically tell model to use `public_uid` as `to_param` method   ffectively turning `user.public_uid` the attribute passed in routes when you do routes (instead of `id`). Example `user_path(@user)` => `/users/xxxxxxx` 
+* provides `User.find_puid('xxxxxx')` and `User.find_puid!('xxxxxx')` class methods as more convenient replacement for `find_by!(public_uid: 'xxxxxxx')` to find records in controllers.
+* `User.find_puid!('xxxxxx')` will raise `PublicUid::RecordNotFound`   instead of `ActiveRecord::RecordNotFound` for more accurate error handling in Rails controller (check [Rails rescue_from](https://apidock.com/rails/ActiveSupport/Rescuable/ClassMethods/rescue_from) for inspiration)
+
+> more info check > [source](https://github.com/equivalent/public_uid/blob/master/lib/public_uid/model_concern.rb)
+
+If you need more customization please  follow **Step 2b** instead
+
+### Step 2b - Using manual generate method
+
 Tell your model to generate the public identifier
 
 ```ruby

data/lib/public_uid.rb

@@ -6,6 +6,11 @@ require "public_uid/generators/number_random"
 require "public_uid/generators/range_string"
 require "public_uid/generators/number_secure_random"
 require "public_uid/generators/hex_string_secure_random"
+require 'public_uid/model_concern'
 require 'public_uid/tasks' if defined?(Rails)
 
+module PublicUid
+  RecordNotFound = Class.new(StandardError)
+end
+
 ActiveRecord::Base.send(:include, PublicUid::Model)

data/lib/public_uid/model_concern.rb

@@ -0,0 +1,29 @@
+module PublicUid
+  module ModelConcern
+    RecordNotFound = Class.new(StandardError)
+
+    extend ActiveSupport::Concern
+
+    included do
+      generate_public_uid
+    end
+
+    class_methods do
+      def find_puid!(public_uid)
+        find_by!(public_uid: public_uid)
+      rescue ActiveRecord::RecordNotFound
+        raise PublicUid::RecordNotFound, "#{self.name} '#{public_uid}' not found"
+      end
+
+      def find_puid(public_uid)
+        find_puid!(public_uid)
+      rescue PublicUid::RecordNotFound
+        nil
+      end
+    end
+
+    def to_param
+      public_uid
+    end
+  end
+end

data/lib/public_uid/version.rb

@@ -1,3 +1,3 @@
 module PublicUid
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/public_uid.gemspec

@@ -20,8 +20,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activerecord", '> 4.2' # ensures compatibility for ruby 2.0.0+ to head
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5"
   spec.add_development_dependency "rr", "~> 1.1.2"
   spec.add_development_dependency "sqlite3", "~> 1.4.1"
+  spec.add_development_dependency "activesupport", '> 4.2'
 end

data/test/models/model_with_public_uid_concern_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+TestConf.orm_modules.each do |orm_module|
+  describe orm_module.description do
+    context 'Model with default generator' do
+      let(:model_class) { "#{orm_module}::ModelWithPublicUidConcern".constantize }
+      let(:user) { model_class.new }
+
+      describe '#public_uid' do
+        subject{ user.public_uid }
+
+        context 'in new record' do
+          it{ expect(subject).must_be_nil }
+
+          describe '#generate_uid' do
+            before do
+              user.generate_uid
+            end
+
+            it { expect(subject).wont_be_nil }
+          end
+        end
+
+        context 'after save' do
+
+          before do
+            user.save
+            user.reload
+          end
+
+          it{ expect(subject).must_be_kind_of(String) }
+          it{ expect(subject.length).must_equal(8) }
+
+          it{ expect(user.to_param).must_equal(subject) }
+          it{ expect(model_class.find_puid(subject)).must_equal(user) }
+          it{ expect(model_class.find_puid!(subject)).must_equal(user) }
+
+
+          it{ expect(model_class.find_puid('nonexisting')).must_be_nil }
+          it do
+            assert_raises PublicUid::RecordNotFound do
+              model_class.find_puid!('nonexisting')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/support/orm/active_record.rb

@@ -29,6 +29,12 @@ module ActRec
     generate_public_uid
   end
 
+  class ModelWithPublicUidConcern  < ActiveRecord::Base
+    include PublicUid::ModelConcern
+    self.table_name =  'user_puids'
+    generate_public_uid
+  end
+
   class ModelWithoutGenaratePublicUid < ActiveRecord::Base
     self.table_name =  'users'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: public_uid
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Tomas Valent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-29 00:00:00.000000000 Z
+date: 2020-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 description: Automatic generates public unique identifier for model
 email:
 - equivalent@eq8.eu
@@ -113,6 +141,7 @@ files:
 - lib/public_uid/generators/number_secure_random.rb
 - lib/public_uid/generators/range_string.rb
 - lib/public_uid/model.rb
+- lib/public_uid/model_concern.rb
 - lib/public_uid/set_public_uid.rb
 - lib/public_uid/tasks.rb
 - lib/public_uid/tasks/generate.rake
@@ -128,6 +157,7 @@ files:
 - test/models/instance_methods_initialization_test.rb
 - test/models/model_with_custom_generator_test.rb
 - test/models/model_with_generator_defaults_test.rb
+- test/models/model_with_public_uid_concern_test.rb
 - test/support/orm/active_record.rb
 - test/support/test_conf.rb
 - test/test_helper.rb
@@ -165,6 +195,7 @@ test_files:
 - test/models/instance_methods_initialization_test.rb
 - test/models/model_with_custom_generator_test.rb
 - test/models/model_with_generator_defaults_test.rb
+- test/models/model_with_public_uid_concern_test.rb
 - test/support/orm/active_record.rb
 - test/support/test_conf.rb
 - test/test_helper.rb