validates_formatting_of 0.6.9 → 0.7.0

data/.travis.yml

@@ -1,3 +1,4 @@
+script: SKIP_SIMPLECOV=true bundle exec rspec spec
 rvm:
   - 1.9.2
   - 1.9.3

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## v0.7.0
+
+* Removed :ip_address validation method
+* Bug fix for :simple_email validation. Identical to :email validation.
+
+There were a few changes between v0.5.0 and v0.7.0, however I neglected to updated them here. They are as follows:
+
+* Refactored entire gem for better testing
+* Deprecating and then removing :ip_address validation in favor of :ip_address_v4 validation.
+
 ## v0.5.0
 * Dropped support for Ruby 1.8.7
 * Dropped support for REE

data/README.markdown

@@ -1,7 +1,10 @@
-# validates_formatting_of
+# Validates Formatting Of
+
 [![Build Status](https://secure.travis-ci.org/mattdbridges/validates_formatting_of.png)](http://travis-ci.org/mattdbridges/validates_formatting_of)
 [![Dependency Status](https://gemnasium.com/mattdbridges/validates_formatting_of.png?travis)](https://gemnasium.com/mattdbridges/validates_formatting_of)
 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/mattdbridges/validates_formatting_of)
+
 The `validates_formatting_of` gem adds several convenient methods to validate things such as emails, urls, and phone numbers in a Rails application.
 
 # Unsupported versions
@@ -23,13 +26,23 @@ Then bundle install:
 
 # Usage
 
-Using validates_formatting_of is as simple as using Rails' built-in validation methods in models.
+Using `validates_formatting_of` is as simple as using Rails' built-in validation methods in models.
+
+```ruby
+class User < ActiveRecord::Base
+  validates_formatting_of :email
+end
+```
 
-    class User < ActiveRecord::Base
-      validates_formatting_of :email, :using => :email
-    end
+If the name of the column is identical to the validation method you would use, it auto-selects that validation method. Thus, this is a shortcut for the following:
 
-This call will ensure that the user-provided email is a valid email. This way, you will not need to find or write your own regex to validate. All of that logic is contained within `validates_formatting_of`
+```ruby
+class User < ActiveRecord::Base
+  validates_formatting_of :email, :using => :email
+end
+```
+
+This call will ensure that the user-provided email is a valid email. This way, you will not need to find or write your own regex to validate. All of that logic is contained within `validates_formatting_of`.
 
 # Rails validation options still available
 
@@ -48,83 +61,128 @@ You can still add the following options when using `validates_formatting_of`:
 
 ### Email
 
-    class User < ActiveRecord::Base
-      validates_formatting_of :email, :using => :email
-    end
+```ruby
+class User < ActiveRecord::Base
+  validates_formatting_of :email, :using => :email
+end
+```
+
+**Note**: If you use `client_side_validations` then you need to use the following validation method:
+
+```ruby
+class User < ActiveRecord::Base
+  validates_formatting_of :email, :using => :simple_email
+end
+```
 
 ### URL
 
-    class Sites < ActiveRecord::Base
-      validates_formatting_of :website, :using => :url
-    end
+```ruby
+class Sites < ActiveRecord::Base
+  validates_formatting_of :website, :using => :url
+end
+```
 
 ### Alpha
 
-    class Name < ActiveRecord::Base
-      validates_formatting_of :first_name, :using => :alpha
-    end
+```ruby
+class Name < ActiveRecord::Base
+  validates_formatting_of :first_name, :using => :alpha
+end
+```
 
 ### Alphanumeric
 
-    class Sites < ActiveRecord::Base
-      validates_formatting_of :text, :using => :alphanum
-    end
+```ruby
+class Sites < ActiveRecord::Base
+  validates_formatting_of :text, :using => :alphanum
+end
+```
 
 ### Credit Card (Visa, Mastercard, Discover, and American Express)
 
-    class Purchases < ActiveRecord::Base
-      validates_formatting_of :cc, :using => :credit_card
-    end
+```ruby
+class Purchases < ActiveRecord::Base
+  validates_formatting_of :cc, :using => :credit_card
+end
+```
 
 ### US Zipcodes
 
-    class Location < ActiveRecord::Base
-      validates_formatting_of :zipcode, :using => :us_zip
-    end
+```ruby
+class Location < ActiveRecord::Base
+  validates_formatting_of :zipcode, :using => :us_zip
+end
+```
 
 ### US Phone numbers
 
-    class Phones < ActiveRecord::Base
-      validates_formatting_of :phone, :using => :us_phone
-    end
+```ruby
+class Phones < ActiveRecord::Base
+  validates_formatting_of :phone, :using => :us_phone
+end
+```
 
-### IP Address
+### IPv4
+
+```ruby
+class Location < ActiveRecord::Base
+  validates_formatting_of :ip, :using => :ip_address_v4
+end
+```
 
-    class Location < ActiveRecord::Base
-      validates_formatting_of :website, :using => :ip_address
-    end
 ### Social Security Number
 
-    class User < ActiveRecord::Base
-      validates_formatting_of :ssn, :using => :ssn
-    end
+```ruby
+class User < ActiveRecord::Base
+  validates_formatting_of :ssn, :using => :ssn
+end
+```
 
 ### Hex Colors
 
-    class Color < ActiveRecord::Base
-      validates_formatting_of :color, :using => :hex_color
-    end
+```ruby
+class Color < ActiveRecord::Base
+  validates_formatting_of :color, :using => :hex_color
+end
+```
 
 ### Dollar Amount
 
-    class Invoice < ActiveRecord::Base
-      validates_formatting_of :amount, :using => :dollars
-    end
-
-# Customizable
+```ruby
+class Invoice < ActiveRecord::Base
+  validates_formatting_of :amount, :using => :dollars
+end
+```
 
-If, for any reason, you want to use your own regex instead of Rail's built-in methods, you can specify what you want to use with the `:regex` option. For example,
+# Over-writable
 
+If, for any reason, you want to overwrite the regex specified in the gem, you can using the `:with` option just like in ActiveModel's built-in `validates_format_of`.
 
-    class Person < ActiveRecord::Base
-      validates_formatting_of :first_name, :regex => /[A-Z]/i
-    end
+```ruby
+class Person < ActiveRecord::Base
+  validates_formatting_of :first_name, :with => /[A-Z]/i
+end
+```
 
 # Development and Contribution
 
-It is very easy to contribute to this gem. Full documentation to do so will be added in the near future.
+To add a simple regex validation, all that is necessary is to add a single line to the `Method` module in the `lib/method.rb` file (with a line or two of documentation explaining it's use).
+
+For example:
+
+```ruby
+module Method
+  # This :validation_name method is for example purposes only.
+  # You can use this in production, but it would require a value of 'example regex' to pass.
+  add :validation_name, %r{example regex}iux, "is a message for validation method :validation_name"
+end
+```
+
+1. Fork it
+2. Make it awesome (with passing tests)
+3. Create a new Pull Request.
 
 # Have Ideas?
 
 Do you use a particular pattern on a regular basis that isn't here or you would like to contribute? For now, [create a new issue](https://github.com/mattdbridges/validates_formatting_of/issues/new) in the issue tracker. I would be more than happy to consider adding it to the project.
-

data/lib/validates_formatting_of/method.rb

@@ -2,9 +2,6 @@ require 'validates_formatting_of/validation'
 require 'validates_formatting_of/validation_addition'
 
 module ValidatesFormattingOf
-
-  class MissingValidation < StandardError; end
-
   module Method
 
     extend ValidationAddition
@@ -15,7 +12,7 @@ module ValidatesFormattingOf
     # Thie version of the email exists to support common validation libraries (such
     # as client_side_validations) that require access to Rails' validation. Look-behinds
     # are not supported in javascript.
-    add :simple_email, %r{\A([^@\s]+)@((?:(?!-)[-a-z0-9]+(?<!-)\.)+[a-z]{2,})\Z}i, "is not a valid email"
+    add :simple_email, %r{\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z}i, "is not a valid email"
 
     # Taken from Ryan Bates' screencast on extracting gems. Works extremely well. Thanks Ryan!
     # (slightly revised to work on MRI 1.8.7 and ree)
@@ -44,7 +41,6 @@ module ValidatesFormattingOf
     add :us_phone, %r{\A(\((\d{3})\)|\d{3})[ |\.|\-]?(\d{3})[ |\.|\-]?(\d{4})\Z}, "is not a valid phone number"
 
     # IP Address validation
-    add :ip_address, %r{\A(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\Z}, "is not a valid IPv4 address"
     add :ip_address_v4, %r{\A(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\.(\d{1,2}|1\d\d|2[0-4]\d|25[0-5])\Z}, "is not a valid IPv4 address"
 
     # Social Security Number pattern

data/lib/validates_formatting_of/validation.rb

@@ -1,6 +1,10 @@
 module ValidatesFormattingOf
 
-  class InvalidRegularExpression < StandardError; end
+  class InvalidRegularExpression < StandardError
+    def initialize(name)
+      super("You must specify a Regexp, a proc, or a lambda for the #{name.inspect} validation.")
+    end
+  end
 
   class Validation
     attr_reader :name, :regex, :message
@@ -8,7 +12,7 @@ module ValidatesFormattingOf
     def initialize(name, regexp, message = "is not correctly formatted")
       callable = regexp.respond_to? :call
       if !callable && regexp.class.to_s != "Regexp"
-        raise InvalidRegularExpression, "You must specify a Regexp, a proc, or a lambda for the #{name.inspect} validation."
+        raise InvalidRegularExpression.new(name)
       end
       @name, @regex, @message = name, regexp, message
     end

data/lib/validates_formatting_of/validation_addition.rb

@@ -1,4 +1,13 @@
+require 'active_support/core_ext/object/blank'
+
 module ValidatesFormattingOf
+
+  class MissingValidation < StandardError
+    def initialize(method)
+      super("The validation method #{method.to_sym.inspect} has not been defined.")
+    end
+  end
+
   module ValidationAddition
     attr_reader :validations
 
@@ -8,18 +17,20 @@ module ValidatesFormattingOf
     end
 
     def find(attribute, opts = {})
-      method = opts[:using].nil? ? attribute : opts[:using]
-      if !exists? method
-        raise MissingValidation, "The validation method #{method.to_sym.inspect} has not been defined."
-      end
+      method = opts.fetch(:using, attribute)
+      raise MissingValidation.new(method) if missing? method
       if method.to_sym == :ip_address
-        warn "[DEPRECATION] The :ip_address validation for `validates_formatting_of` is DEPRECATED. Please update your model validations to use :ip_address_v4. This method will be removed by version 0.7.0."
+        raise ArgumentError, "[REMOVED] The :ip_address validation for `validates_formatting_of` has been removed since version 0.7.0. Please update your model validations to use :ip_address_v4."
       end
       @validations[method.to_sym]
     end
 
+    def missing?(name)
+      !exists?(name)
+    end
+
     def exists?(name)
-      !@validations[name.to_sym].nil?
+      @validations[name.to_sym].present?
     end
   end
 end

data/lib/validates_formatting_of/version.rb

@@ -1,3 +1,3 @@
 module ValidatesFormattingOf
-  VERSION = "0.6.9"
+  VERSION = "0.7.0"
 end

data/spec/spec_helper.rb

@@ -1,5 +1,10 @@
 require 'simplecov'
-SimpleCov.start
+
+unless ENV["SKIP_SIMPLECOV"] == 'true'
+  SimpleCov.start do
+    load_adapter 'test_frameworks'
+  end
+end
 
 require 'validates_formatting_of'
 require 'active_model'

data/spec/validates_formatting_of/model_additions_spec.rb

@@ -109,33 +109,18 @@ describe ValidatesFormattingOf::ModelAdditions do
     end
   end
 
-  describe "ip_address" do
-    class IPAddress < TestActiveRecord
-      attr_accessor :ip
-      validates_formatting_of :ip, :using => :ip_address
-    end
-    it "validates that the IP address provided is valid" do
-      IPAddress.new(:ip => '10.10.10').should_not be_valid
-      IPAddress.new(:ip => '999.10.10.20').should_not be_valid
-      IPAddress.new(:ip => '2222.22.22.22').should_not be_valid
-      IPAddress.new(:ip => '22.2222.22.2').should_not be_valid
-      IPAddress.new(:ip => '127.0.0.1').should be_valid
-      IPAddress.new(:ip => '132.254.111.10').should be_valid
-    end
-  end
-
   describe "ip_address_v4" do
-    class IPAddress2 < TestActiveRecord
+    class IPAddress < TestActiveRecord
       attr_accessor :ipv4
       validates_formatting_of :ipv4, :using => :ip_address_v4
     end
     it "validates that the IP address provided is valid" do
-      IPAddress2.new(:ipv4 => '10.10.10').should_not be_valid
-      IPAddress2.new(:ipv4 => '999.10.10.20').should_not be_valid
-      IPAddress2.new(:ipv4 => '2222.22.22.22').should_not be_valid
-      IPAddress2.new(:ipv4 => '22.2222.22.2').should_not be_valid
-      IPAddress2.new(:ipv4 => '127.0.0.1').should be_valid
-      IPAddress2.new(:ipv4 => '132.254.111.10').should be_valid
+      IPAddress.new(:ipv4 => '10.10.10').should_not be_valid
+      IPAddress.new(:ipv4 => '999.10.10.20').should_not be_valid
+      IPAddress.new(:ipv4 => '2222.22.22.22').should_not be_valid
+      IPAddress.new(:ipv4 => '22.2222.22.2').should_not be_valid
+      IPAddress.new(:ipv4 => '127.0.0.1').should be_valid
+      IPAddress.new(:ipv4 => '132.254.111.10').should be_valid
     end
   end
 

data/spec/validates_formatting_of/validation_addition_spec.rb

@@ -10,6 +10,9 @@ module ValidatesFormattingOf
     before do
       TestAdding.add :email, /email/i
     end
+    after do
+      TestAdding.instance_variable_set("@validations", nil)
+    end
     it "should be able to add new validations" do
       TestAdding.add :another, /another/i
       TestAdding.validations.count.should == 2
@@ -27,9 +30,17 @@ module ValidatesFormattingOf
     it "should raise an error if the method does not exist" do
       expect { TestAdding.find(:fake) }.to raise_error MissingValidation
     end
-    it "should be able to determine if the method exists" do
+    it "should be able to determine if the method does not exist" do
       TestAdding.exists?(:email).should be_true
       TestAdding.exists?(:non_existent).should be_false
     end
+    it "should be able to accept strings for validation names (for namespacing)" do
+      TestAdding.add "namespace:phone", /namespace/i
+      TestAdding.exists?("namespace:phone").should be_true
+    end
+    it "should be able to determine if the method is missing" do
+      TestAdding.missing?(:non_existent).should be_true
+      TestAdding.missing?(:email).should be_false
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validates_formatting_of
 version: !ruby/object:Gem::Version
-  version: 0.6.9
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-16 00:00:00.000000000 Z
+date: 2012-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel