uniqueness 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7826153c6e988edbd91c51573a98dab137b7d9d6
-  data.tar.gz: 1bee0f48405859310b879fbb1d915fa21aa73d94
+  metadata.gz: b9103e34b3744f24b43bc7d6b5c8bbeff052e7bd
+  data.tar.gz: fbbb46f768b37161ee05abc657d9ff35cbb8a09c
 SHA512:
-  metadata.gz: 839a11df5197d0536084b015a033b279512b3c31a017654b66f8ae09fa95c2dd6b6f5134d0525fc9e262d345c3d58ed82bfe51103a45a364ad4dc100f554ccf7
-  data.tar.gz: 996b20e7644bf4cd2cff8f166312c24bb7c88a89781ea27c56646db53cc26efd216059044f9002864dfc97d539cd64266b7f396b4903cac3542d74bfcfd9e746
+  metadata.gz: 10fe4f821e8aaa584e7bb6a79c771e72c4949e1f10373f86ce016d473198d281e963e9248cb11d6e1b74e1a9fd98fcc17c7dc26ab2f55bf2c845a656de00ddba
+  data.tar.gz: 538b5d94051fc97a83ec06415a8ae11528c8b6d06f3d3e72ed7cb8d70d43cc135cbaae0c5bce67754bc35fea772f9d021a8626ef7161929c00db339a0b041134

data/.travis.yml

@@ -4,8 +4,6 @@ rvm:
 - 2.2.4
 - 2.1.8
 - 2.0.0
-- 1.9.3
-- jruby-19mode
 - rbx-2
 before_install:
   - gem install bundler -v '~> 1.11'
@@ -14,5 +12,13 @@ gemfile:
   - gemfiles/41.gemfile
   - gemfiles/42.gemfile
   - gemfiles/50.gemfile
+matrix:
+  exclude:
+    - rvm: 2.0.0
+      gemfile: gemfiles/50.gemfile
+    - rvm: 2.1.8
+      gemfile: gemfiles/50.gemfile
+    - rvm: rbx-2
+      gemfile: gemfiles/50.gemfile
 cache:
   - bundler

data/README.md

@@ -3,11 +3,20 @@
 [![Code Climate](https://codeclimate.com/github/owahab/uniqueness/badges/gpa.svg)](https://codeclimate.com/github/owahab/uniqueness)
 [![Build Status](https://travis-ci.org/owahab/uniqueness.svg?branch=master)](https://travis-ci.org/owahab/uniqueness)
 [![Coverage Status](https://coveralls.io/repos/github/owahab/uniqueness/badge.svg?branch=master)](https://coveralls.io/github/owahab/uniqueness?branch=master)
+[![Inline docs](http://inch-ci.org/github/owahab/uniqueness.svg?branch=master)](http://inch-ci.org/github/owahab/uniqueness)
+[![security](https://hakiri.io/github/owahab/uniqueness/master.svg)](https://hakiri.io/github/owahab/uniqueness/master)
 
 Rails recently introduced `has_secure_token` but it's very primitive.
 Meet the competition.
 
-[Documentation](http://www.rubydoc.info/github/owahab/uniqueness)
+[Code Documentation](http://www.rubydoc.info/github/owahab/uniqueness)
+
+## Requirements
+
+Minimum requirements are:
+
+1. Rails __4.0.0+__
+2. Ruby __2.0.0+__
 
 ## Installation
 
@@ -27,7 +36,26 @@ Or install it yourself as:
 
 ## Usage
 
+Adds random field support to Rails models.
+
+To auto-generate a new random string for field `foo`:
+
+    class Example < ActiveRecord::Base
+      has_unique_field :foo
+    end
+
+You can customize the generated string by
+passing an options hash. The following keys are supported:
 
+`:length` number of characters, defaults to __32__
+
+`:type` type of string, can be one of: `:human`, `:auto`, defaults to __:auto__
+
+Human type generates strings easier to read by excluding ambiguous characters like `1, 5, 8, B, o, O, I, l, s, u`.
+
+`:blacklist` characters to exclude when generating the random string, defaults to __[]__
+
+`:scope` scopes, defines the `ActiveRecord` `scope` applied before calculating the `position` field value. Defaults to __[]__
 
 ## Development
 
@@ -40,4 +68,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 Please see CONTRIBUTING.md for details.
 
 ## Credits
-recognition was originally written by Omar Abdel-Wahab.
+
+[![Eventtus](http://eventtus.com/css/images/logo.png)](http://eventtus.com)
+
+Project is sponsored by [Eventtus](http://eventtus.com).

data/lib/uniqueness/engine.rb

@@ -1,5 +1,5 @@
 module Uniqueness
-  class Engine < Rails::Engine #:nodoc:
+  class Engine < Rails::Engine # :nodoc:
     ActiveSupport.on_load(:active_record) do
       ActiveRecord::Base.send(:include, Uniqueness::Model)
     end

data/lib/uniqueness/model.rb

@@ -2,6 +2,8 @@ module Uniqueness
   module Model # :nodoc:
     def self.included(base)
       base.extend ClassMethods
+      # Track all uniqueness arguments
+      base.class_attribute :uniqueness_options
     end
 
     module ClassMethods
@@ -18,28 +20,45 @@ module Uniqueness
       #
       #   +:case_sensitive+ defaults to <tt>true</tt>
       #
-      #   +:type+ type of string, defaults to <tt>:hash</tt>
-      #           can be one of: <tt>:human</tt>, <tt>:hash</tt>
+      #   +:type+ type of string, defaults to <tt>:auto</tt>
+      #           can be one of: <tt>:human</tt>, <tt>:auto</tt>
       #
-      #   +:blacklist+ characters to exclude when generating the random string,
-      #                 defaults to <tt>[]</tt>
+      #   +:blacklist+ characters to exclude when generating the random
+      #                string, defaults to <tt>[]</tt>
+      #
+      #   +:scope+ defines the `ActiveRecord` `scope` applied before
+      #            calculating the `position` field value.
+      #            defaults to <tt>[]</tt>
       def has_unique_field(name, options = {})
-        validates name, presence: true, uniqueness: true
-        before_validation do
-          value = self.send(name)
-          self.send("#{name}=", uniqueness_generate(options)) unless value
-        end
+        self.uniqueness_options ||= {}
+        self.uniqueness_options[name] = self.uniqueness_default_options.merge(options)
+        before_validation :uniqueness_generate
+        validate :uniqueness_validation
+      end
+
+      # Default sorting options
+      def uniqueness_default_options
+        {
+          length: 32,
+          type: :auto,
+          blacklist: [],
+          scope: []
+        }
       end
     end
 
     # Generates a new code based on given options
-    def uniqueness_generate(opts = {})
-      options = { length: 32, type: :auto, blacklist: [] }
-      options.merge!(opts)
-      dict = uniqueness_dictionary - options[:blacklist]
-      dict = dict - [*(:A..:Z)].map(&:to_s) unless options[:case_sensitive]
-      dict = dict - uniqueness_ambigious_dictionary if options[:type].to_sym == :human
-      Array.new(options[:length]).map { dict[rand(dict.length)] }.join
+    def uniqueness_generate
+      self.uniqueness_options.each do |field, options|
+        value = send(field)
+        unless value.present?
+          dict = uniqueness_dictionary - options[:blacklist]
+          dict -= [*(:A..:Z)].map(&:to_s) unless options[:case_sensitive]
+          dict -= uniqueness_ambigious_dictionary if options[:type].to_sym == :human
+          value = Array.new(options[:length]).map { dict[rand(dict.length)] }.join
+          self.send("#{field}=", value)
+        end
+      end
     end
 
     # Dictionary used for uniqueness generation
@@ -48,7 +67,24 @@ module Uniqueness
     end
 
     def uniqueness_ambigious_dictionary
-      [1, 5, 8, :B, :o, :O, :I, :l, :L, :s, :S, :u, :U].map(&:to_s)
+      [:b, :B, :o, :O, :q, :I, :l, :L, :s, :S, :u, :U, :z, :Z].map(&:to_s)
+    end
+
+    def uniqueness_validation
+      self.class.uniqueness_options.each do |field, options|
+        value = send(field)
+        if value.nil?
+          errors.add(field, 'should not be empty')
+        else
+          conditions = {}
+          options[:scope].each do |s|
+            conditions[s] = send(s)
+          end
+          conditions[field] = value
+          query = self.class.where(conditions)
+          errors.add(field, 'should be unique') if query.any?
+        end
+      end
     end
   end
 end

data/lib/uniqueness/version.rb

@@ -1,3 +1,3 @@
 module Uniqueness
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uniqueness
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Omar Abdel-Wahab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-28 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler