validates_formatting_of 0.2.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.3-p0@validates_formatting_of"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    exit 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if command -v bundle && [[ -s Gemfile ]]
+# then
+#   bundle install
+# fi
+
+

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - rbx
+  - jruby
+  - ruby-head

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.2.0
+
+* initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in validates_format_of.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Matt Bridges
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,36 @@
+# validates_formatting_of
+
+The *validates_formatting_of" gem addess several convenient methods to validating things such as emails, urls, and phones in a Rails application.
+
+# Installation
+
+To install *validates_formatting_of*, add the following to your `Gemfile`:
+
+    gem 'validates_formatting_of'
+
+Then bundle install:
+
+    bundle install
+
+# Usage
+
+Using validates_formatting_of is as simple as using Rails' built-in validation methods in models.
+
+    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`
+
+# Available Formatting Validations
+
+`validates_formatting_of` has support for the following validations:
+
+* Email
+* URL
+* Alpha-only
+* Alphanumeric
+* Credit Card (Visa, Mastercard, Discver, and American Express)
+* US Zipcodes
+* US Phone numbers
+* IP Address

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/validates_formatting_of/model_additions.rb

@@ -0,0 +1,29 @@
+module ValidatesFormattingOf
+  module ModelAdditions
+    def validates_formatting_of(attribute, opts = {})
+
+      # Here is where the input is formatted before it is validated.
+      # Not yet implemented.
+      # 
+      # unless opts[:preformat].nil?
+      #   before_validation do
+      #     # add formatting changes here
+      #   end
+      # end
+
+      regex_for_validation = opts[:regex] || validate_with(opts[:using])
+
+      validates_format_of attribute, :with => regex_for_validation, :message => opts[:message]
+    end
+
+    # Actually retrieve the regex to check against
+    def validate_with(method)
+      formatting.send(method)
+    end
+
+    # Grab the validating methods
+    def formatting
+      @formatting ||= ValidatingMethods.new
+    end
+  end
+end

data/lib/validates_formatting_of/railtie.rb

@@ -0,0 +1,10 @@
+# Extend ActiveRecord's methods
+module ValidatesFormattingOf
+  class Railtie < Rails::Railtie
+    initializer 'validates_formatting_of.model_additions' do
+      ActiveSupport.on_load :active_record do
+        extend ModelAdditions
+      end
+    end
+  end
+end

data/lib/validates_formatting_of/validating_methods.rb

@@ -0,0 +1,44 @@
+module ValidatesFormattingOf
+  class ValidatingMethods
+
+    # This method is very close to allowing what is specified in RFC 5322 and RFC 5321
+    def email
+      /^[0-9A-Z!#$\%&'*+-\/=?^_`{|}~]+@[0-9A-Z\-.]+\.[A-Z]{2,4}$/i
+    end
+
+    # Taken from Ryan Bates' screencast on extracting gems. Works extremely well. Thanks Ryan!
+    def url
+      /^https?:\/\/([^\s:@]+:[^\s:@]*@)?[-[[:alnum:]]]+(\.[-[[:alnum:]]]+)+\.?(:\d{1,5})?([\/?]\S*)?$/iux
+    end
+
+    # No numbers of symbols. allows "-"
+    def alpha
+      /^([^\d\W]|[-])*$/
+    end
+
+    # Letters, numbers, and spaces
+    def alphanum
+      /^[A-Z0-9\s]+$/i
+    end
+
+    # Visa, Mastercard, Discver, and American Express
+    def credit_card
+      /^((4\d{3})|(5[1-5]\d{2})|(6011))-?\d{4}-?\d{4}-?\d{4}|3[4,7]\d{13}$/
+    end
+
+    # US Zip code. ##### or #####-####
+    def us_zip
+      /^\d{5}(-\d{4})?$/
+    end
+
+    # US Phone numbers. (###) ###-#### | (###)###-#### | ###-###-####
+    def us_phone
+      /^([\(]{1}[0-9]{3}[\)]{1}[ |\-]{0,1}|^[0-9]{3}[\-| ])?[0-9]{3}(\-| ){1}[0-9]{4}$/
+    end
+
+    def ip_address
+      /^(\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])$/
+    end
+
+  end
+end

data/lib/validates_formatting_of/version.rb

@@ -0,0 +1,3 @@
+module ValidatesFormattingOf
+  VERSION = "0.2.0"
+end

data/lib/validates_formatting_of.rb

@@ -0,0 +1,6 @@
+# This file does all of the preloading. Little to no actual code should go in this file.
+
+require "validates_formatting_of/version"
+require "validates_formatting_of/validating_methods"
+require "validates_formatting_of/model_additions"
+require "validates_formatting_of/railtie" if defined? Rails

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'validates_formatting_of'
+require 'supermodel'
+
+class SuperModel::Base
+  include ActiveModel::Validations::Callbacks
+  extend ValidatesFormattingOf::ModelAdditions
+end

data/spec/validates_formatting_of/model_additions_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe ValidatesFormattingOf::ModelAdditions do
+
+  describe "email" do
+
+    class Email < SuperModel::Base
+      validates_formatting_of :email, :using => :email
+    end
+    it "validates that the email provided is valid" do
+      Email.new(:email => "example@example.com").should be_valid
+      Email.new(:email => "badexample.com").should_not be_valid
+      Email.new(:email => "mbridges.91@gmail.com").should be_valid
+      Email.new(:email => "some-random%%%strangely-formatted-email@lots.of.subdomains.com").should be_valid
+      Email.new(:email => "this__???{}|__should@be-valid.com").should be_valid
+    end
+
+  end
+  describe "url" do
+
+    class Webpage < SuperModel::Base
+      validates_formatting_of :url, :using => :url
+    end
+    it "validates that the email provided is valid" do
+      Webpage.new(:url => 'http://something.com').should be_valid
+      Webpage.new(:url => "something else").should_not be_valid
+    end
+
+  end
+  describe "us_zip" do
+    
+    class USZip < SuperModel::Base
+      validates_formatting_of :zipcode, :using => :us_zip
+    end
+    it "validates that the email provided is valid" do
+      USZip.new(:zipcode => '92348').should be_valid
+      USZip.new(:zipcode => '23434-2348').should be_valid
+      USZip.new(:zipcode => '234').should_not be_valid
+      USZip.new(:zipcode => '23408234').should_not be_valid
+      USZip.new(:zipcode => 'invalid').should_not be_valid
+    end
+
+  end
+  describe "alpha" do
+    
+    class Alpha < SuperModel::Base
+      validates_formatting_of :letters, :using => :alpha
+    end
+    it "validates that the email provided is valid" do
+      Alpha.new(:letters => 'abscdsofjsdpfahdsofkajlsdfaspdhjfads').should be_valid
+      Alpha.new(:letters => 'asdfalskdfjhas-dlfhasdksdfaldhfadsfasdfa').should be_valid
+      Alpha.new(:letters => 'adsufasodfksadjfskjdfha98').should_not be_valid
+      Alpha.new(:letters => 'asdf ausdpf98hasdfo alsdf ja8 sd').should_not be_valid
+    end
+
+  end
+  describe "alphanum" do
+    
+    class Alphanum < SuperModel::Base
+      validates_formatting_of :letters_and_numbers, :using => :alphanum
+    end
+    it "validates that the email provided is valid" do
+      Alphanum.new(:letters_and_numbers => 'numbersandlettersarevalid1234567890').should be_valid
+      Alphanum.new(:letters_and_numbers => 'justletters').should be_valid
+      Alphanum.new(:letters_and_numbers => 'letters and numbers 123 with spaces').should be_valid
+      Alphanum.new(:letters_and_numbers => 'adding ; some special ** chars').should_not be_valid
+    end
+
+  end
+  describe "us_phone" do
+    
+    class USPhone < SuperModel::Base
+      validates_formatting_of :phone_number, :using => :us_phone
+    end
+    it "validates that the email provided is valid" do
+      USPhone.new(:phone_number => '(234) 234-3456').should be_valid
+      USPhone.new(:phone_number => '123 123 3456').should be_valid
+      USPhone.new(:phone_number => '(223)123-2347').should be_valid
+      USPhone.new(:phone_number => '2349870238').should_not be_valid
+      USPhone.new(:phone_number => '12349870238').should_not be_valid
+    end
+
+  end
+end

data/validates_formatting_of.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/validates_formatting_of/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Matt Bridges"]
+  gem.email         = ["mbridges.91@gmail.com"]
+  gem.description   = %q{Common Rails validations for different types of data}
+  gem.summary       = %q{Adds common data validations to save development time. (i.e. phone and url)}
+  gem.homepage      = "https://github.com/mattdbridges/validates_formatting_of"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "validates_formatting_of"
+  gem.require_paths = ["lib"]
+  gem.version       = ValidatesFormattingOf::VERSION
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "supermodel"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: validates_formatting_of
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Matt Bridges
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70227849493380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70227849493380
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70227849492920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70227849492920
+- !ruby/object:Gem::Dependency
+  name: supermodel
+  requirement: &70227849492420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70227849492420
+description: Common Rails validations for different types of data
+email:
+- mbridges.91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- lib/validates_formatting_of.rb
+- lib/validates_formatting_of/model_additions.rb
+- lib/validates_formatting_of/railtie.rb
+- lib/validates_formatting_of/validating_methods.rb
+- lib/validates_formatting_of/version.rb
+- spec/spec_helper.rb
+- spec/validates_formatting_of/model_additions_spec.rb
+- validates_formatting_of.gemspec
+homepage: https://github.com/mattdbridges/validates_formatting_of
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Adds common data validations to save development time. (i.e. phone and url)
+test_files:
+- spec/spec_helper.rb
+- spec/validates_formatting_of/model_additions_spec.rb