format_for_extensions 0.1.0

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "rails", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "mocha", "0.9.5"
+  gem "rcov", ">= 0"
+  gem "shoulda", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,42 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (2.3.11)
+      actionpack (= 2.3.11)
+    actionpack (2.3.11)
+      activesupport (= 2.3.11)
+      rack (~> 1.1.0)
+    activerecord (2.3.11)
+      activesupport (= 2.3.11)
+    activeresource (2.3.11)
+      activesupport (= 2.3.11)
+    activesupport (2.3.11)
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    mocha (0.9.5)
+      rake
+    rack (1.1.1)
+    rails (2.3.11)
+      actionmailer (= 2.3.11)
+      actionpack (= 2.3.11)
+      activerecord (= 2.3.11)
+      activeresource (= 2.3.11)
+      activesupport (= 2.3.11)
+      rake (>= 0.8.3)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  mocha (= 0.9.5)
+  rails (>= 2.3.5)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Karle Durante
+
+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.rdoc

@@ -0,0 +1,86 @@
+= format_for
+
+Tired of repeating 'validates_format_of' with the same regex expression across your models only to validate the same email address and postal code fields?  So am I.  Use format_for to dynamically define reusable formats for any field you want.
+
+By default, format_for comes with smart formats for email addresses and postal codes.  Even better, no code repetition!  Use constructs that make sense such as "validates_email_for :account_owner" and "validates_postal_code_for :address_postal_code".
+
+
+== System Requirements
+format_for should work with Rails 2.3.5 and above.  However, I have not yet tested this with Rails 3.1. 
+
+
+== Installation
+Modify your Gemfile to include format_for:
+  
+  gem 'format_for'
+
+Run `bundle install`.  You thought it would be harder?
+
+
+== Usage 
+By default, ArValidationExtensions supports email and postal code formats.  These can be leveraged by including code such as:
+
+  class Person < ActiveRecord::Base
+    # Notice how the normal ActiveRecord Validation options can still be used...
+    validates_email_for :email_address
+    validates_email_for :home_email_address, :if => :full_validation_required
+    validates_postal_code_for :postal_code, :allow_blank => true
+  end
+
+
+=== Configuration
+
+Default configurations are specified in the gem's config/ar_validation_extensions.yml file.  If you wish to modify the default regular expressions or messages reported when validation fails, simply copy this file to the config directory in your Rails root folder.  You can also manually create [rails_root]/config/ar_validation_extensions.yml if you'd like to.
+
+The format of this file is as follows:
+
+  # ar_validation_extensions.yml
+  en:
+    email:
+      regex: /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/
+      message: "is invalid.  The address should be in a format similar to 'user@example.com'."
+
+PLEASE NOTE that localization is not really supported at this time.  By default we only support english mappings, the 'en' locale exists to allow us to more easily support localization in the future.
+
+If you modify this file, you will need to bounce your application server (or restart your rails console) as this gem caches configurations at load time.
+
+
+=== The Hotness
+You can dynamically create your own format validators!  For instance, add this to your [rails_root]/config/ar_validation_extensions.yml file:
+
+  # ar_validation_extensions.yml
+  en:
+    hotness:
+      regex: /^hot/
+      message: "is not hot!"
+
+And you now have a completely useless method to validate that fields begin with 'hot':
+
+  class Person < ActiveRecord::Base
+    # Validation will fail if your first_name does not begin with 'hot'
+    validates_hotness_for :first_name
+  end
+
+As you might have guessed, the gem is driven off of the configuration file.  The same way you can add validators, you can remove them by simply deleting lines from the configuration file.
+
+
+== TODO
+- We intend to support more locales other then english.  The idea being that we'd check the current local, and load the regex/message accordingly.
+- Support some other highly repetitious fields, such as phone number.
+
+
+== Contributing to format_for
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Karle Durante. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "format_for_extensions"
+  gem.homepage = "http://github.com/customink/format_for_extensions"
+  gem.license = "MIT"
+  gem.summary = %Q{Extends ActiveRecord validates_format_of validations with reusable and customizable validation methods.}
+  gem.description = %Q{Tired of repeating 'validates_format_of' with the same regex expression across your models only to validate the same email address and postal code fields?  So am I.  Use format_for_extensions to dynamically define reusable formats for any ActiveRecord model attribute you want.}
+  gem.email = "kdurante@customink.com"
+  gem.authors = ["Karle Durante"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ar_validation_extensions #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/config/format_for_extensions.yml

@@ -0,0 +1,9 @@
+# Default validation configurations...
+en:
+  postal_code:
+    regex: /^[0-9]{5}(-[0-9]{4})?|[ABCEGHJKLMNPRSTVXY]\d[A-Z] *\d[A-Z]\d?$/
+    message: "is invalid.  Valid formats: 94105-0011 or 94105 or T2X 1V4 or T2X1V4"
+
+  email:
+    regex: /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/
+    message: "is invalid.  The address should be in a format similar to 'user@example.com'."

data/format_for_extensions.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{format_for_extensions}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Karle Durante"]
+  s.date = %q{2011-06-02}
+  s.description = %q{Tired of repeating 'validates_format_of' with the same regex expression across your models only to validate the same email address and postal code fields?  So am I.  Use format_for_extensions to dynamically define reusable formats for any ActiveRecord model attribute you want.}
+  s.email = %q{kdurante@customink.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "config/format_for_extensions.yml",
+    "format_for_extensions.gemspec",
+    "lib/format_for_extensions.rb",
+    "lib/format_for_extensions/config.rb",
+    "test/helper.rb",
+    "test/lib/format_for_extensions/test_config.rb",
+    "test/models/abstract_model.rb",
+    "test/models/person.rb",
+    "test/test_format_for_extensions.rb"
+  ]
+  s.homepage = %q{http://github.com/customink/format_for_extensions}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{Extends ActiveRecord validates_format_of validations with reusable and customizable validation methods.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 2.3.5"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<mocha>, ["= 0.9.5"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 2.3.5"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<mocha>, ["= 0.9.5"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 2.3.5"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<mocha>, ["= 0.9.5"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/lib/format_for_extensions/config.rb

@@ -0,0 +1,24 @@
+module FormatForExtensions
+  class Config
+    require 'yaml'
+    
+    # TODO: Bake in support for multiple locales...
+    DEFAULT_LOCALE = 'en'
+    
+    def self.values(locale = DEFAULT_LOCALE)
+      @@config ||= nil
+      
+      # First, we want to see if the consumer of this gem has defined a config file
+      return @@config[locale] unless @@config.nil?
+      
+      begin
+        @@config = YAML.load_file(File.join(Rails.root, 'config', 'format_for_extensions.yml'))
+      rescue
+        # fall back to our smart defaults
+        @@config = YAML.load_file(File.join(File.dirname(__FILE__), '../../config', 'format_for_extensions.yml'))
+      end
+      
+      @@config[locale]
+    end      
+  end
+end

data/lib/format_for_extensions.rb

@@ -0,0 +1,59 @@
+require 'active_record'
+
+module FormatForExtensions
+  module ActiveRecord
+    module Validations
+      def self.included(base)
+        base.extend ClassMethods
+      end
+      
+      module ClassMethods
+        require 'format_for_extensions/config'
+        
+        begin
+          FIELDS = FormatForExtensions::Config.values.keys
+        rescue Exception => e
+          puts "Exception loading config: #{e.inspect}"
+          raise(RuntimeError, "Your format_for_extensions.yml file seems to be invalid, perhaps you've mis-keyed something?")
+        end
+        
+        FIELDS.each do |field|
+          define_method("validates_#{field}_for") do |*attr_names|
+            configuration = {:with => self.send("#{field}_regex"),
+                             :message => self.send("#{field}_message")
+                            }
+                            
+            # Add in user supplied options (yes, users can still override the regex and 
+            # message with custom options)
+            configuration.update(attr_names.extract_options!)
+
+            # Leverage existing ActiveRecord::Validations...
+            validates_format_of(attr_names, configuration)
+          end
+        end
+
+        # Compose accessor methods for each of the specified field types
+        # e.g. postal_code_regex, postal_code_message, etc...
+        ['postal_code', 'email'].each do |field|
+          define_method("#{field}_regex".to_sym) do
+            regex = FormatForExtensions::Config.values[field]['regex']
+            raise(ArgumentError, "Your format_for_extensions.yml is missing the mapping '#{field}: regex:'") if regex.blank?
+            
+            return eval(regex)
+          end
+
+          define_method("#{field}_message".to_sym) do
+            message = FormatForExtensions::Config.values[field]['message']
+            raise(ArgumentError, "Your format_for_extensions.yml is missing the mapping '#{field}: message:'") if message.blank?
+            
+            return message
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include FormatForExtensions::ActiveRecord::Validations
+end

data/test/helper.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'active_record'
+require 'active_record/test_case'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'format_for_extensions'
+
+
+
+# These have to load AFTER our gem...
+require 'models/abstract_model'
+require 'models/person'
+
+class Test::Unit::TestCase
+end

data/test/lib/format_for_extensions/test_config.rb

@@ -0,0 +1,12 @@
+require 'helper'
+require 'format_for_extensions/config'
+
+class TestConfig < Test::Unit::TestCase
+  should "load the default yml file if an override has not been specified" do
+    config = FormatForExtensions::Config.values
+    
+    assert_equal "is invalid.  Valid formats: 94105-0011 or 94105 or T2X 1V4 or T2X1V4", config['postal_code']['message']
+    assert_equal "is invalid.  The address should be in a format similar to 'user@example.com'.", config['email']['message']
+  end
+  
+end

data/test/models/abstract_model.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+# require 'active_record/base'
+
+class AbstractModel < ActiveRecord::Base
+  self.abstract_class = true
+  
+  def self.columns() @columns ||= []; end      
+  
+  def self.column(name, sql_type = nil, default = nil, null = true)
+    columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)
+  end
+end

data/test/models/person.rb

@@ -0,0 +1,9 @@
+class Person < AbstractModel
+
+  #insert the names of the form fields here
+  column :email, :string
+  column :postal_code, :string
+  
+  validates_postal_code_for :postal_code, :allow_blank => true
+  validates_email_for       :email, :allow_blank => true
+end

data/test/test_format_for_extensions.rb

@@ -0,0 +1,59 @@
+require 'helper'
+
+class TestFormatForExtensions < Test::Unit::TestCase
+  
+  context "When loading FormatFor" do
+    context "with valid configurations" do
+      setup { @fields = FormatForExtensions::Config.values.keys }
+    
+      should "define extended validation methods for each configured field" do    
+        @fields.each do |field|
+          assert ActiveRecord::Base.respond_to?("validates_#{field}_for")
+        end
+      end
+  
+      should "define data accessor methods for each configured field" do
+        @fields.each do |field|
+          assert ActiveRecord::Base.respond_to?("#{field}_regex")
+          assert ActiveRecord::Base.respond_to?("#{field}_message")
+        end
+      end
+  
+      should "consider the postal code to be valid" do
+        person = Person.new
+        ['94105-0011', '94105', 'T2X 1V4', 'T2X1V4'].each do |postal_code|
+          person.postal_code = postal_code
+          assert person.valid?
+        end
+      end
+  
+      should "consider the postal code to be invalid" do
+        person = Person.new
+        ['9410', 'abc', '123-123'].each do |postal_code|
+          person.postal_code = postal_code
+          assert !person.valid?
+        end
+      end
+    
+      should "consider the email to be valid" do
+        person = Person.new
+        ['user@example.org', 'some.other.guy@yahoo.us.ca', 'a@b.com'].each do |email|
+          person.email = email
+          assert person.valid?
+        end
+      end
+    
+      should "consider the email to be valid" do
+        person = Person.new
+        ['user@example', 'yahoo.us.ca', 'a.com'].each do |email|
+          person.email = email
+          assert !person.valid?
+        end
+      end
+    end
+
+    context "with invalid configurations " do
+      # TODO:  How to test this?? Once active record and the gem are loaded, how do we unload/reload them with bad params?
+    end
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification 
+name: format_for_extensions
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Karle Durante
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-02 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  requirement: *id001
+  prerelease: false
+  name: rails
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+  prerelease: false
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  requirement: *id003
+  prerelease: false
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 9
+        - 5
+        version: 0.9.5
+  requirement: *id004
+  prerelease: false
+  name: mocha
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+  prerelease: false
+  name: rcov
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+  prerelease: false
+  name: shoulda
+description: Tired of repeating 'validates_format_of' with the same regex expression across your models only to validate the same email address and postal code fields?  So am I.  Use format_for_extensions to dynamically define reusable formats for any ActiveRecord model attribute you want.
+email: kdurante@customink.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- config/format_for_extensions.yml
+- format_for_extensions.gemspec
+- lib/format_for_extensions.rb
+- lib/format_for_extensions/config.rb
+- test/helper.rb
+- test/lib/format_for_extensions/test_config.rb
+- test/models/abstract_model.rb
+- test/models/person.rb
+- test/test_format_for_extensions.rb
+has_rdoc: true
+homepage: http://github.com/customink/format_for_extensions
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Extends ActiveRecord validates_format_of validations with reusable and customizable validation methods.
+test_files: []
+