ssn 0.2.0 → 0.3.0

data/README.rdoc

@@ -11,6 +11,7 @@ Encapsulates functionality for storing an unformatted SSN but formatting the SSN
 == FEATURES
 
 * Store a SSN unformatted in a database field with auto formatting when using.
+* SocialSecurityNumber class to use for formatting SSNs.
 
 
 == REQUIREMENTS
@@ -47,6 +48,8 @@ Run:
 
 == USAGE
 
+=== Active Record Extension
+
 Add a raw_ssn that is at least 9 in length to the database table of the model you desire to track a SSN on.
 
 Specify usage in your model:
@@ -64,6 +67,15 @@ Use the field:
   person.ssn                                # => 123-45-6789
 
 
+=== SocialSecurityNumber Class
+
+  ssn = Ssn::SocialSecurityNumber.new( '123456789' )
+
+  ssn.raw       # => 123456789
+  ssn.formatted # => 123-45-6789
+
+
+
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/ssn/active_record_extensions.rb

@@ -12,9 +12,9 @@ module Ssn
           self.class_eval { extend ClassMethods }
           include InstanceMethods
           validates_length_of :"raw_#{args.first.to_sym}", :maximum => 9, :allow_blank => true
-          validates_format_of :"raw_#{args.first.to_sym}", :with => /^[0-9]{9}$/, :allow_blank => true
+          validates_format_of :"raw_#{args.first.to_sym}", :with => Ssn::SocialSecurityNumber::UNFORMATTED_REGEX, :allow_blank => true
 
-          validates_format_of args.first.to_sym, :with => /^[0-9]{3}-?[0-9]{2}-?[0-9]{4}$/, :allow_blank => true
+          validates_format_of args.first.to_sym, :with => Ssn::SocialSecurityNumber::FORMATTED_REGEX, :allow_blank => true
         end
 
         initialize_has_ssn_from_args args
@@ -38,7 +38,7 @@ module Ssn
 
       def initialize_has_ssn_from_string( str )
         define_method str do
-          return raw_ssn.blank? ? nil : raw_ssn.gsub( /^([0-9]{3})([0-9]{2})([0-9]{4})$/,"\\1-\\2-\\3" )
+          return raw_ssn.blank? ? nil : raw_ssn.gsub( Ssn::SocialSecurityNumber::UNFORMATTED_CAPTURE_REGEX, "\\1-\\2-\\3" )
         end
 
         define_method "#{str}=" do |value|

data/lib/ssn/social_security_number.rb

@@ -1,5 +1,28 @@
 module Ssn
   class SocialSecurityNumber
+    FORMATTED_REGEX           = /^[0-9]{3}-?[0-9]{2}-?[0-9]{4}$/
+    UNFORMATTED_REGEX         = /^[0-9]{9}$/
+    UNFORMATTED_CAPTURE_REGEX = /^([0-9]{3})([0-9]{2})([0-9]{4})$/
 
+    attr_reader :raw
+
+    def initialize( value=nil )
+      return if value.nil?
+      @raw = SocialSecurityNumber.parse( value )
+    end
+
+    def formatted
+      return (raw.nil? || raw.empty?) ?
+        '' :
+        SocialSecurityNumber.format( raw )
+    end
+
+    def self.parse( value )
+      value.gsub( /-/, "" )
+    end
+
+    def self.format( value )
+      parse( value ).gsub( UNFORMATTED_CAPTURE_REGEX,"\\1-\\2-\\3" )
+    end
   end
 end

data/spec/ssn/social_security_number_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe "Ssn::SocialSecurityNumber" do
+  before :each do
+    @klass = Ssn::SocialSecurityNumber
+    @instance = @klass.new
+  end
+
+  it "should agree that the UNFORMATTED_REGEX is /^[0-9]{9}$/" do
+    @klass::UNFORMATTED_REGEX.should == /^[0-9]{9}$/
+  end
+
+  it "should agree that the FORMATTED_REGEX is /^[0-9]{3}-?[0-9]{2}-?[0-9]{4}$/" do
+    @klass::FORMATTED_REGEX.should == /^[0-9]{3}-?[0-9]{2}-?[0-9]{4}$/
+  end
+
+  it "should agree that the UNFORMATTED_CAPTURE_REGEX is /^([0-9]{3})([0-9]{2})([0-9]{4})$/" do
+    @klass::UNFORMATTED_CAPTURE_REGEX.should == /^([0-9]{3})([0-9]{2})([0-9]{4})$/
+  end
+
+  it "should initialize when given an unformatted SSN" do
+    @klass.new( '123456789' ).raw.should == '123456789'
+  end
+
+  it "should initialize when given an unformatted SSN" do
+    @klass.new( '123-45-6789' ).raw.should == '123456789'
+  end
+
+  it "should return a formatted SSN" do
+    @klass.new( '123456789' ).formatted.should == '123-45-6789'
+  end
+
+  it "should return a '' when a the SSN is blank" do
+    @klass.new( '' ).formatted.should == ''
+  end
+
+  it "should return a '' when a the SSN is nil" do
+    @klass.new.formatted.should == ''
+  end
+
+  context "well formed SSNs" do
+    it "should parse an SSN without formatting" do
+      @klass.parse( '123456789' ).should == '123456789'
+    end
+
+    it "should parse an SSN with formatting" do
+      @klass.parse( '123-45-6789' ).should == '123456789'
+    end
+
+    it "should format an SSN without formatting" do
+      @klass.format( '123456789' ).should == '123-45-6789'
+    end
+
+    it "should format an SSN with formatting" do
+      @klass.format( '123-45-6789' ).should == '123-45-6789'
+    end
+  end
+end

data/spec/ssn_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe "Ssn" do
   describe "having ActiveRecord extensions" do

data/ssn.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ssn}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason Harrelson"]
-  s.date = %q{2010-11-05}
+  s.date = %q{2010-11-10}
   s.description = %q{Encapsulates functionality for storing an unformatted SSN but formatting the SSN on print.}
   s.email = %q{jason@lookforwardenterprises.com}
   s.extra_rdoc_files = [
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
      "spec/database.yml",
      "spec/spec.opts",
      "spec/spec_helper.rb",
+     "spec/ssn/social_security_number_spec.rb",
      "spec/ssn_spec.rb",
      "ssn.gemspec"
   ]
@@ -42,6 +43,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Encapsulates functionality for storing an unformatted SSN but formatting the SSN on print.}
   s.test_files = [
     "spec/spec_helper.rb",
+     "spec/ssn/social_security_number_spec.rb",
      "spec/ssn_spec.rb"
   ]
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ssn
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jason Harrelson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-05 00:00:00 -05:00
+date: 2010-11-10 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,7 @@ files:
 - spec/database.yml
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/ssn/social_security_number_spec.rb
 - spec/ssn_spec.rb
 - ssn.gemspec
 has_rdoc: true
@@ -97,4 +98,5 @@ specification_version: 3
 summary: Encapsulates functionality for storing an unformatted SSN but formatting the SSN on print.
 test_files: 
 - spec/spec_helper.rb
+- spec/ssn/social_security_number_spec.rb
 - spec/ssn_spec.rb