ssn 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.rvmrc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jason Harrelson
+
+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,89 @@
+= addressable_record
+
+http://github.com/midas/ssn
+
+
+== DESCRIPTION
+
+Encapsulates functionality for storing an unformatted SSN but formatting the SSN on print.
+
+
+== FEATURES
+
+* Store a SSN unformatted in a database field with auto formatting when using.
+
+
+== REQUIREMENTS
+
+* active_record >= 2.3
+
+
+== INSTALL
+
+  gem sources -a http://gemcutter.org
+  sudo gem install ssn
+
+
+== INSTALL FOR RAILS 3
+
+Add to environment file:
+
+  gem 'ssn', '~>0.1.0'
+
+Run:
+
+  bundle:install
+
+== INSTALL FOR RAILS 2
+
+Add to environment file:
+
+  config.gem 'ssn', :version => '~>0.1.0', :source => 'http://gemcutter.org'
+
+Run:
+
+  sudo rake:gems:install
+
+
+== USAGE
+
+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:
+
+  class Person
+    has_ssn :ssn
+    ...
+  end
+
+Use the field:
+
+  person = Peson.new :ssn => '123456789'
+  person.ssn                                # => 123-45-6789
+  person.ssn = '123-45-6789'
+  person.ssn                                # => 123-45-6789
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+== Copyright
+
+Copyright (c) 2009 C. Jason Harrelson (midas)
+
+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/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ssn"
+    gem.summary = %Q{Encapsulates functionality for storing an unformatted SSN but formatting the SSN on print.}
+    gem.description = %Q{Encapsulates functionality for storing an unformatted SSN but formatting the SSN on print.}
+    gem.email = "jason@lookforwardenterprises.com"
+    gem.homepage = "http://github.com/midas/ssn"
+    gem.authors = ["Jason Harrelson"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ssn #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/ssn.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'ssn/active_record_extensions'
+require 'ssn/social_security_number'
+
+module Ssn
+  VERSION = '0.1.0'
+end
+
+ActiveRecord::Base.send( :include, Ssn::ActiveRecordExtensions ) if defined?( ActiveRecord::Base )

data/lib/ssn/active_record_extensions.rb

@@ -0,0 +1,56 @@
+module Ssn
+  module ActiveRecordExtensions
+    def self.included( base )
+      base.extend ActsMethods
+    end
+
+    module ActsMethods
+      def has_ssn( *args )
+        unless included_modules.include? InstanceMethods
+          self.class_eval { extend ClassMethods }
+          include InstanceMethods
+          validates_length_of :raw_ssn, :maximum => 9, :allow_blank => true
+          validates_format_of :raw_ssn, :with => /^[0-9]{9}$/, :allow_blank => true
+        end
+
+        initialize_has_ssn_from_args args
+      end
+
+      alias_method :has_ssns, :has_ssn
+    end
+
+    module ClassMethods
+      def initialize_has_ssn_from_args( args )
+        if args.first.is_a? Symbol
+          initialize_has_ssn_from_string args.first.to_s
+        elsif args.first.is_a? String
+          initialize_has_ssn_from_string args.first
+        elsif args.first.is_a? Hash
+          initialize_has_ssn_from_hash args.first
+        else
+          raise 'has_ssn can only accept a string, symbol or hash of strings or symbols'
+        end
+      end
+
+      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" )
+        end
+
+        define_method "#{str}=" do |value|
+          unless /^[0-9]{3}-?[0-9]{2}-?[0-9]{4}$/.match( value )
+            raise 'Invalid SSN format provided for ssn'
+          end
+          self.raw_ssn = value.gsub( /-/, "" )
+        end
+      end
+
+      def initialize_has_ssn_from_hash( args )
+      end
+    end
+
+    module InstanceMethods
+
+    end
+  end
+end

data/lib/ssn/social_security_number.rb

@@ -0,0 +1,5 @@
+module Ssn
+  class SocialSecurityNumber
+
+  end
+end

data/script/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r 'rubygems' -r 'active_record' -r '#{File.dirname(__FILE__) + '/../lib/ssn.rb'}' -r '#{File.dirname(__FILE__) + '/environment'}' -r '#{File.dirname(__FILE__) + '/seed'}'"
+
+puts "Loading ssn gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/environment.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Base.configurations = YAML::load( IO.read( File.dirname(__FILE__) + '/../spec/database.yml' ) )
+ActiveRecord::Base.establish_connection( 'test' )
+
+ActiveRecord::Schema.define :version => 1 do
+  create_table "users", :force => true do |t|
+    t.string   "name",       :limit => 50
+    t.string   "raw_ssn",    :limit => 9
+  end
+
+  create_table "people", :force => true do |t|
+    t.string   "name",       :limit => 50
+  end
+end
+
+class User < ActiveRecord::Base
+  has_ssn :ssn
+end

data/script/seed.rb

@@ -0,0 +1 @@
+User.create! :name => 'John Smith', :raw_ssn => '123456789'

data/spec/database.yml

@@ -0,0 +1,3 @@
+test:
+  :adapter: sqlite3
+  :database: ":memory:"

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'active_record'
+require 'ssn'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+
+end
+
+require File.dirname(__FILE__) + '/../script/environment'

data/spec/ssn_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Ssn" do
+  describe "having ActiveRecord extensions" do
+    it "should respond to has_ssn" do
+      ActiveRecord::Base.respond_to?( :has_ssn ).should be_true
+    end
+
+    it "should respond to has_ssns" do
+      ActiveRecord::Base.respond_to?( :has_ssns ).should be_true
+    end
+  end
+
+  describe "when a user provides a symbol to the has_ssn method" do
+    before :each do
+      @user = User.new :name => 'John Smith', :raw_ssn => '123456789'
+    end
+
+    it "should respond to a getter method with the correct name" do
+      @user.respond_to?( :ssn ).should be_true
+    end
+
+    it "should respond to a setter method with the correct name" do
+      @user.respond_to?( :ssn= ).should be_true
+    end
+
+    it "should add a length validation on the raw ssn field" do
+      @user.raw_ssn = '1234567890'
+      @user.save.should be_false
+    end
+
+    it "should not allow any formatting in the raw ssn field" do
+      @user.raw_ssn = '1-3456789'
+      @user.save.should be_false
+    end
+
+    it "should not allow a mal-formed social security number" do
+      lambda { @user.ssn = "1-1345-6789" }.should raise_error
+    end
+
+    it "should allow correctly formed social security numbers" do
+      lambda { @user.ssn = "123-45-6789" }.should_not raise_error
+    end
+
+    it "should allow correctly formed social security numbers" do
+      lambda { @user.ssn = "123456789" }.should_not raise_error
+    end
+  end
+
+  describe "in general" do
+    before :each do
+      @user = User.new :name => 'John Smith', :raw_ssn => '123456789'
+    end
+
+    it "should return nil if the raw ssn is nil" do
+      @user.raw_ssn = nil
+      @user.save!
+      @user.ssn.should be_nil
+    end
+
+    it "should return nil if the raw ssn is ''" do
+      @user.raw_ssn = ''
+      @user.save!
+      @user.ssn.should be_nil
+    end
+
+    it "should return a formatted social security number" do
+      @user.ssn.should == '123-45-6789'
+    end
+
+    it "should set ssn" do
+      @user.ssn = '234-56-7890'
+      @user.ssn.should == '234-56-7890'
+    end
+
+    it "should strip formatting from a social security number" do
+      @user.ssn = '234-56-7890'
+      @user.raw_ssn.should == '234567890'
+    end
+  end
+end

data/ssn.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ssn}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason Harrelson"]
+  s.date = %q{2010-10-05}
+  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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/ssn.rb",
+     "lib/ssn/active_record_extensions.rb",
+     "lib/ssn/social_security_number.rb",
+     "script/console",
+     "script/environment.rb",
+     "script/seed.rb",
+     "spec/database.yml",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/ssn_spec.rb",
+     "ssn.gemspec"
+  ]
+  s.homepage = %q{http://github.com/midas/ssn}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  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_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: ssn
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jason Harrelson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Encapsulates functionality for storing an unformatted SSN but formatting the SSN on print.
+email: jason@lookforwardenterprises.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/ssn.rb
+- lib/ssn/active_record_extensions.rb
+- lib/ssn/social_security_number.rb
+- script/console
+- script/environment.rb
+- script/seed.rb
+- spec/database.yml
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/ssn_spec.rb
+- ssn.gemspec
+has_rdoc: true
+homepage: http://github.com/midas/ssn
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+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_spec.rb