uniqable 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4109b6f0535addf58a992e5f527581d0feef1d9
-  data.tar.gz: d6d2058195767a915243ce1a8490837d7c2bece4
+  metadata.gz: 9c62d651fd862f7f16f28da78984646b6f058a3a
+  data.tar.gz: 22ed697e5d197cc2ec2cd51ace98d8cd222b6d59
 SHA512:
-  metadata.gz: ae292f512985c3f15fa308988fd07478fd2e88823070fc532c3fdbf2a1b626c71522875ee89d82cdb5a6a49ed413128eb8f4a69d9167a85e249b87858f43f519
-  data.tar.gz: 248c0d37f1a22e60f8a6aad203b8e88cb673de40b78d345cbd4019da81ff4a2047025e4a5da226bd521deecd20a08e9588eddc3e42888a2f32398f645846cda8
+  metadata.gz: 02aea5d916ad5f4a834847f1daf4ce3dcbd678f7e117695465df991c2f33c05df5881c75e4969156d9dadfbb88a4e172bc478c68da6186fc05d4c6ca66af9fb1
+  data.tar.gz: aac1283ae40d4095ce7408edcf7de102e8bad63dda1ea096ee8819ee17a24b782da18a91ea38a386c0f3dda928eb4afc68b2f3d5520e90bd1221a4defcc9be8f

data/README.md

@@ -2,9 +2,7 @@
 
 [![CircleCI](https://circleci.com/gh/mpakus/uniqable.svg?style=svg)](https://circleci.com/gh/mpakus/uniqable)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/uniqable`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby on Rails gem for generating a unique, random token in an ActiveRecord model.
 
 ## Installation
 
@@ -35,6 +33,16 @@ First include Uniqable concern to your model and then describe columns which you
 
 It generates unique and random token before each Model instance is created.
 
+if you want you can use `:to_param` option to generate automatically `#to_param` method
+```ruby
+    uniqable :uid, :slug, to_param: :uid
+```
+
+anyway you have one more method `.find_uniqable` which one you can use to find your model record
+```ruby
+  MyModel.find_uniqable params[:uid]
+```
+
 You can also create your own token callback method and set the field:
 
 ```ruby

data/lib/uniqable.rb

@@ -9,14 +9,37 @@ module Uniqable
   end
 
   module ClassMethods
-    def uniqable(*fields)
+    # Uniqable fields and options declaration
+    # @example:
+    #   uniqable :uid, :slug, to_param: :uid
+    def uniqable(*fields, to_param: nil)
       fields = [:uid] if fields.blank?
+      @_uniqable_fields = fields
       fields.each do |name|
         before_create { |record| record.uniqable_uid(name) }
       end
+      # :to_param option
+      if to_param
+        define_method :to_param do
+          public_send(to_param)
+        end
+      end
+    end
+
+    # Find record by one of the uniq field
+    # usage @example:
+    #   uniqable :uid, :slug
+    #   ...
+    #   MyModel.find_uniqable params[:uid] # can be uid or slug column
+    # @return [self]
+    def find_uniqable(uid)
+      where_sql = @_uniqable_fields.map{ |r| "#{table_name}.#{r} = :uid"}.join(' OR ')
+      self.where(where_sql, uid: uid).take(1)
     end
   end
 
+  # Generate and set random and uniq field
+  # @TODO: split into 2 actions generate and set
   def uniqable_uid(field)
     loop do
       send("#{field}=", SecureRandom.hex(8))

data/lib/uniqable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uniqable
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uniqable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Renat "MpaK" Ibragimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord