has_normalized_fields 0.0.1

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+.rvmrc
+Gemfile.lock
+pkg/*
+log/*.log
+*.tmproj
+tmp
+log
+.gitconfig
+bin/*

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - 1.9.2
+  
+script: rake spec

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,52 @@
+== HasNormalizedFields {<img src="https://secure.travis-ci.org/kylejginavan/has_normalized_fields.png"/>}[http://travis-ci.org/kylejginavan/has_normalized_fields]
+
+== DESCRIPTION
+
+has_normalized_fields is a Ruby on Rails gem that lets you normalize user data for an improved user experience.
+It takes the messy user inputed data and normalizes it into a nice clean standard format.
+
+== INSTALLATION & SETUP:
+
+add in your Gemfile:
+
+  gem 'has_normalized_fields'
+
+in your model:
+
+  has_normalized_attributes :field => :normalized_type
+
+for example:
+
+  class CoolStuff < ActiveRecord::Base
+    has_normalized_attributes :phone_attr => :phone, :zipcode_attr => :zipcode, :ssn_attr => :ssn,
+                              :dollar_attr => :dollar, :taxid_attr => :taxid, :number_attr => :number,
+                              :percent_attr => :percent, :spaces_attr => :spaces
+  end  
+
+== Normalizations availables
+  :phone, :zipcode, :ssn, :dollar, :taxid, :number, :percent, :spaces
+
+
+== COPYRIGHT
+
+Copyright (c) 2011 Kyle Ginavan
+
+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.
+See LICENSE for details.

data/Rakefile

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

data/has_normalized_fields.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "version"
+
+Gem::Specification.new do |s|
+  s.name = %q{has_normalized_fields}
+  s.version = HasNormalizedFields::VERSION
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kyle Ginavan"]
+  s.date = %q{2010-05-18}
+  s.homepage = "https://github.com/kylejginavan/has_normalized_fields"
+  s.summary =  %q{Ruby on Rails gem for normalize data prior to save}
+  s.description = %q{has_normalized_fields is a Ruby on Rails gem that lets you normalize user data for an improved user experience.
+It takes the messy user inputed data and normalizes it into a nice clean standard format.}
+  s.email = %q{kylejginavan@gmail.com}
+  s.rubyforge_project = "has_normalized_fields"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_development_dependency "rspec"
+  s.add_development_dependency("activerecord", ['>= 3.1.0'])
+  s.add_development_dependency("sqlite3")
+  s.add_development_dependency('database_cleaner')
+end
+

data/lib/has_normalized_fields.rb

@@ -0,0 +1,50 @@
+module HasNormalizedFields
+  extend ActiveSupport::Concern
+
+  #CONSTANT
+  ZIPCODE                  = /[-. )(,]/
+  PHONE                    = /[-. )(,]/
+  SSN                      = /[-. )(,]/
+  TAXID                    = /[-. )(,]/
+  DOLLAR                   = /[$, ]/
+  NUMBER                   = /[, ]/
+  PERCENT                  = /[% ]/
+  SPACES                   = /\s/
+
+  #instance methods
+  def self.normalizations(*args)
+    args.each do |arg|
+      reg_exp = HasNormalizedFields.const_get(arg.upcase)
+      define_method "normalize_#{arg}" do |value|
+        value && value.is_a?(String) && value.match(reg_exp) ? value.gsub!(reg_exp,'') : value
+      end
+    end
+  end
+
+  #loading all methods dynamically
+  normalizations :phone, :zipcode, :ssn, :taxid, :dollar, :number, :percent, :spaces
+
+
+  module ClassMethods
+    def has_normalized_attributes(args = {})
+
+      if args.blank? || !args.is_a?(Hash)
+        raise ArgumentError, 'Must define the fields you want to be normalize with has_normalized_attributes :field_one => "phone", :field_two => "zipcode"'
+      end
+
+      args.each do |field, normalization_type|
+        raise ArgumentError, "attribute #{field} no belongs to current class" unless columns.map(&:name).include?(field.to_s)
+        define_method "#{field.to_s}=" do |value|
+          if value.present?
+            send "normalize_#{normalization_type.downcase}".to_sym, value.to_s
+          end
+          super value
+        end
+      end
+
+    end
+  end
+end
+
+#include activerecord
+ActiveRecord::Base.send :include, HasNormalizedFields

data/lib/version.rb

@@ -0,0 +1,3 @@
+module HasNormalizedFields
+  VERSION = "0.0.1"
+end

data/spec/db/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  adapter: sqlite3
+  database: spec/db/test.sqlite3

data/spec/db/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table "resources", :force => true do |t|
+    t.string   "phone_attr"
+    t.string   "ssn_attr"
+    t.string   "zipcode_attr"
+    t.string   "taxid_attr"
+    t.string   "dollar_attr"
+    t.string   "number_attr"
+    t.string   "percent_attr"
+    t.string   "spaces_attr"
+  end
+
+end

data/spec/has_normalized_fields_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+class Resource < ActiveRecord::Base
+  has_normalized_attributes :phone_attr => :phone, :zipcode_attr => :zipcode, :ssn_attr => :ssn,
+                            :dollar_attr => :dollar, :taxid_attr => :taxid, :number_attr => :number,
+                            :percent_attr => :percent, :spaces_attr => :spaces
+end
+
+describe "HasNormalizedFields" do
+  before(:each) do
+    @resource = Resource.new
+  end
+
+  describe "class method" do
+    it "should work" do
+      expect {
+        Resource.send(:has_normalized_attributes, {:phone_attr => :phone})
+      }.to_not raise_error
+    end
+
+    it "should raise an error if no fields are passed in" do
+      expect {
+        Resource.send(:has_normalized_attributes)
+      }.to raise_error(ArgumentError, 'Must define the fields you want to be normalize with has_normalized_attributes :field_one => "phone", :field_two => "zipcode"')
+    end
+
+    it "should raise an error if has fields that no belongs to the current class" do
+      expect {
+        Resource.send(:has_normalized_attributes, {:food => :phone})
+      }.to raise_error(ArgumentError, 'attribute food no belongs to current class')
+    end
+
+    it "should raise an error if has fields that no belongs to the current class" do
+      expect {
+        Resource.send(:has_normalized_attributes, :food)
+      }.to raise_error(ArgumentError, 'Must define the fields you want to be normalize with has_normalized_attributes :field_one => "phone", :field_two => "zipcode"')
+    end
+
+  end
+
+  describe "#phone" do
+    it{@resource.phone_attr = "11-111"; @resource.phone_attr.should == "11111"}
+    it{@resource.phone_attr = "1111111111"; @resource.phone_attr.should == "1111111111"}
+    it{@resource.phone_attr = "111 111 1111"; @resource.phone_attr.should == "1111111111"}
+    it{@resource.phone_attr = " 111 111 1111 "; @resource.phone_attr.should == "1111111111"}
+    it{@resource.phone_attr = "111.111.1111"; @resource.phone_attr.should == "1111111111"}
+    it{@resource.phone_attr = "(111)111-1111"; @resource.phone_attr.should == "1111111111"}
+    it{@resource.phone_attr = "(111)1111111"; @resource.phone_attr.should == "1111111111"}
+    it{@resource.phone_attr = " 111-111.1111 "; @resource.phone_attr.should == "1111111111"}
+    it{@resource.phone_attr = ""; @resource.phone_attr.should == ""}
+    it{@resource.phone_attr = nil; @resource.phone_attr.should == nil}
+  end
+
+  describe "#zipcode" do
+    it{@resource.zipcode_attr = "11111"; @resource.zipcode_attr.should == "11111"}
+    it{@resource.zipcode_attr = " 11 1-11 "; @resource.zipcode_attr.should == "11111"}
+    it{@resource.zipcode_attr = " 111-11 ("; @resource.zipcode_attr.should == "11111"}
+    it{@resource.zipcode_attr = "11,1-11"; @resource.zipcode_attr.should == "11111"}
+    it{@resource.zipcode_attr = "11.111"; @resource.zipcode_attr.should == "11111"}
+    it{@resource.zipcode_attr = "111111111"; @resource.zipcode_attr.should == "111111111"}
+    it{@resource.zipcode_attr = "(11111) 1111"; @resource.zipcode_attr.should == "111111111"}
+    it{@resource.zipcode_attr = "11111) -1111"; @resource.zipcode_attr.should == "111111111"}
+    it{@resource.zipcode_attr = "11111.1111"; @resource.zipcode_attr.should == "111111111"}
+    it{@resource.zipcode_attr = "11111 --1111"; @resource.zipcode_attr.should == "111111111"}
+    it{@resource.zipcode_attr = " 11111,1111 "; @resource.zipcode_attr.should == "111111111"}
+    it{@resource.zipcode_attr = ""; @resource.zipcode_attr.should == ""}
+    it{@resource.zipcode_attr = nil; @resource.zipcode_attr.should == nil}
+    it{@resource.zipcode_attr = "(111)"; @resource.zipcode_attr.should == "111"}
+    it{@resource.zipcode_attr = "11111"; @resource.zipcode_attr.should == "11111"}
+    it{@resource.zipcode_attr = 111.11; @resource.zipcode_attr.should == 111.11}
+  end
+
+  describe "#ssn" do
+    it{@resource.ssn_attr = "111 111 1111"; @resource.ssn_attr.should == "1111111111"}
+    it{@resource.ssn_attr = " 111 111 1111 "; @resource.ssn_attr.should == "1111111111"}
+    it{@resource.ssn_attr = "111.111.1111"; @resource.ssn_attr.should == "1111111111"}
+    it{@resource.ssn_attr = "(111)111-1111"; @resource.ssn_attr.should == "1111111111"}
+    it{@resource.ssn_attr = "(111)1111111"; @resource.ssn_attr.should == "1111111111"}
+    it{@resource.ssn_attr = " 111-111.1111 "; @resource.ssn_attr.should == "1111111111"}
+    it{@resource.ssn_attr = ""; @resource.ssn_attr.should == ""}
+    it{@resource.ssn_attr = nil; @resource.ssn_attr.should == nil}
+  end
+
+  describe "#taxid" do
+    it{@resource.taxid_attr = "12-345"; @resource.taxid_attr.should == "12345"}
+    it{@resource.taxid_attr = "12.345"; @resource.taxid_attr.should == "12345"}
+    it{@resource.taxid_attr = "1-2345"; @resource.taxid_attr.should == "12345"}
+    it{@resource.taxid_attr = "1,2345"; @resource.taxid_attr.should == "12345"}
+    it{@resource.taxid_attr = ""; @resource.taxid_attr.should == ""}
+    it{@resource.taxid_attr = nil; @resource.taxid_attr.should == nil}
+  end
+
+  describe "#dollar" do
+    it{@resource.dollar_attr = "$111111";@resource.dollar_attr.should == "111111"}
+    it{@resource.dollar_attr = "111,111";@resource.dollar_attr.should == "111111"}
+    it{@resource.dollar_attr = "111 111 ";@resource.dollar_attr.should == "111111"}
+    it{@resource.dollar_attr = "$111, 111 ";@resource.dollar_attr.should == "111111"}
+    it{@resource.dollar_attr = "";@resource.dollar_attr.should == ""}
+    it{@resource.dollar_attr = nil;@resource.dollar_attr.should == nil}
+  end
+
+  describe "#number" do
+    it{@resource.number_attr = "1,23";@resource.number_attr.should == "123"}
+    it{@resource.number_attr = "1 23 ";@resource.number_attr.should == "123"}
+    it{@resource.number_attr = "";@resource.number_attr.should == ""}
+    it{@resource.number_attr = nil;@resource.number_attr.should == nil}
+  end
+
+  describe "#percent" do
+    it{@resource.percent_attr = " 1 1 ";@resource.percent_attr.should == "11"}
+    it{@resource.percent_attr = "11%";@resource.percent_attr.should == "11"}
+    it{@resource.percent_attr = "%11";@resource.percent_attr.should == "11"}
+    it{@resource.percent_attr = "1 1 % ";@resource.percent_attr.should == "11"}
+    it{@resource.percent_attr = "";@resource.percent_attr.should == ""}
+    it{@resource.percent_attr = nil;@resource.percent_attr.should == nil}
+  end
+
+  describe "#spaces" do
+    it{@resource.spaces_attr = "5 0";@resource.spaces_attr.should == "50"}
+    it{@resource.spaces_attr = "";@resource.spaces_attr.should == ""}
+    it{@resource.spaces_attr = nil;@resource.spaces_attr.should == nil}
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require "active_support"
+require "active_record"
+require "database_cleaner"
+
+ENV['debug'] = 'test' unless ENV['debug']
+
+# Establish DB Connection
+config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'db', 'database.yml')))
+ActiveRecord::Base.configurations = {'test' => config[ENV['DB'] || 'sqlite3']}
+ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+
+# Load Test Schema into the Database
+load(File.dirname(__FILE__) + "/db/schema.rb")
+
+# Load in our code
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+require 'has_normalized_fields'
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: has_normalized_fields
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kyle Ginavan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2010-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70354463185680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70354463185680
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70354463184960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *70354463184960
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70354463184460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70354463184460
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &70354463183900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70354463183900
+description: ! 'has_normalized_fields is a Ruby on Rails gem that lets you normalize
+  user data for an improved user experience.
+
+  It takes the messy user inputed data and normalizes it into a nice clean standard
+  format.'
+email: kylejginavan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.rdoc
+- Rakefile
+- has_normalized_fields.gemspec
+- lib/has_normalized_fields.rb
+- lib/version.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/db/test.sqlite3
+- spec/has_normalized_fields_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kylejginavan/has_normalized_fields
+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: has_normalized_fields
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Ruby on Rails gem for normalize data prior to save
+test_files:
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/db/test.sqlite3
+- spec/has_normalized_fields_spec.rb
+- spec/spec_helper.rb