kevintyll-ssn_validator 1.0.1 → 1.0.2

data/History.txt

@@ -22,3 +22,8 @@
 * 2 bug fixes:
   * Fixed dmf mysql load error when single quote is in a data file record.
   * Fixed ssn_validator:update_data rake task that broke on the last build.
+
+== 1.0.2 2009-04-24
+
+* 1 minor enhancement:
+  * Using jeweler gem to create gemspec and rdoc files

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kevin Tyll
+
+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/PostInstall.txt

@@ -7,36 +7,23 @@ For more information on ssn_validator, see http://kevintyll.github.com/ssn_valid
     config.gem 'kevintyll-ssn_validator', :lib => 'ssn_validator'
 * To load your table with the current SSN data, from the command line, run:
     rake ssn_validator:update_data
-
     * The SSN data is updated monthly, so you'll want to run this rake task monthly to keep your validations accurate.
-
 * If you've purchased the death master file data, create the death_master_files migration:
     script/generate death_master_file_migration
 * To load the dmf files you receive from ntis:
     rake ssn_validator:death_master_file:load_file PATH='path/to/file' AS_OF='2009-03-01'
-
     * You'll need to pass in the full path to where the file is on disk.  You'll also need
       to pass in the date this file's data are as of in the format yyyy-mm-dd.
-
     * This task must be used to load the initial file you receive from ntis on CD.  It can optionally be used
       to load the monthly update files you download from the website.  If you manually download the update files,
       you do not need to add your user name and password to the environment.rb file.  For a more automated approach
       to loading the update files, add your user name and password to the environment.rb file and use the 2nd rake task.
-
 * To load the monthly updates from the ntis website:
     * Add your user_name and password to the environment.rb file
-
         SsnValidator::Ntis.user_name = 'REPLACE WITH YOUR dmf.ntis.gov USER NAME'
         SsnValidator::Ntis.password = 'REPLACE WITH YOUR dmf.ntis.gov PASSWORD'
-
     * Run the rake task:
-
         rake ssn_validator:death_master_file:update_data
-
         * This rake task will determine the most recent file that has been loaded, and loads all subsequent files in order
         from the dmf.ntis.gov website.
-
         * The death master file data is updated monthly, so you'll want to run this rake task monthly to keep your validations accurate.
-
-
-

data/README.rdoc

@@ -93,27 +93,6 @@ thanks goes to the management at Clarity Services Inc. for allowing this code to
 
         * The death master file data is updated monthly, so you'll want to run this rake task monthly to keep your validations accurate.
 
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2009 Kevin Tyll
-
-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.
+== Copyright
+
+Copyright (c) 2009 Kevin Tyll. See LICENSE for details.

data/Rakefile

@@ -1,25 +1,57 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/ssn_validator'
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new('ssn_validator', SsnValidator::VERSION) do |p|
-  p.developer('Kevin Tyll', 'kevintyll@gmail.com')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.post_install_message = 'PostInstall.txt'
-   p.extra_deps         = [
-     ['activerecord','>= 2.0.0'],
-   ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"]
-  ]
-
-  p.clean_globs |= %w[**/.DS_Store tmp *.log nbproject pkg]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ssn_validator"
+    gemspec.author = "Kevin Tyll"
+    gemspec.email = "kevintyll@gmail.com"
+    gemspec.homepage = %q{http://kevintyll.git.com/ssn_validator}
+    gemspec.summary = "Validates whether an SSN has likely been issued or not."
+    gemspec.description = "Validates whether an SSN has likely been issued or not."
+    gemspec.post_install_message = File.readlines("PostInstall.txt").join("")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs  << 'test'
+  test.pattern = 'test/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
 end
 
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ssn_validator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('LICENSE*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
 

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 2
+:major: 1

data/lib/ssn_validator.rb

@@ -10,7 +10,3 @@ require 'rake'
 
 # Load rake file
 import "#{File.dirname(__FILE__)}/tasks/ssn_validator.rake"
-
-module SsnValidator
-  VERSION = '1.0.1'
-end

data/test/test_helper.rb

@@ -1,7 +1,10 @@
-require 'stringio'
+require 'rubygems'
 require 'test/unit'
 require 'mocks/test/death_master_file_loader'
-require File.dirname(__FILE__) + '/../lib/ssn_validator'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ssn_validator'
 
 ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kevintyll-ssn_validator
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Kevin Tyll
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-13 00:00:00 -07:00
+date: 2009-04-24 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -19,43 +19,74 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
 files: 
 - History.txt
-- Manifest.txt
+- LICENSE
 - PostInstall.txt
 - README.rdoc
 - Rakefile
-- generators/ssn_validator_migration/templates/migration.rb
-- generators/ssn_validator_migration/ssn_validator_migration_generator.rb
-- generators/death_master_file_migration/templates/migration.rb
+- VERSION.yml
 - generators/death_master_file_migration/death_master_file_migration_generator.rb
-- lib/ssn_validator/ntis.rb
+- generators/death_master_file_migration/templates/migration.rb
+- generators/ssn_validator_migration/ssn_validator_migration_generator.rb
+- generators/ssn_validator_migration/templates/migration.rb
+- lib/ssn_validator.rb
+- lib/ssn_validator/models/death_master_file.rb
+- lib/ssn_validator/models/death_master_file_loader.rb
 - lib/ssn_validator/models/ssn_high_group_code.rb
 - lib/ssn_validator/models/ssn_high_group_code_loader.rb
 - lib/ssn_validator/models/ssn_validator.rb
-- lib/ssn_validator/models/death_master_file.rb
-- lib/ssn_validator/models/death_master_file_loader.rb
-- lib/ssn_validator.rb
+- lib/ssn_validator/ntis.rb
 - lib/tasks/ssn_validator.rake
-- script/console
-- script/destroy
-- script/generate
-- test/test_helper.rb
-- test/test_ssn_validator.rb
-- test/test_ssn_high_group_code_loader.rb
-- test/test_death_master_file_loader.rb
-- test/mocks/test/death_master_file_loader.rb
+- test/files/test_dmf_funky_data_load.txt
 - test/files/test_dmf_initial_load.txt
 - test/files/test_dmf_update_load.txt
+- test/files/valid_csv_from_funky_data_file.txt
+- test/mocks/test/death_master_file_loader.rb
+- test/test_death_master_file_loader.rb
+- test/test_helper.rb
+- test/test_ssn_high_group_code_loader.rb
+- test/test_ssn_validator.rb
 has_rdoc: true
 homepage: http://kevintyll.git.com/ssn_validator
-post_install_message: Read the PostInstall.txt file for instructions on how to get the necessary tables created and data loaded.
-rdoc_options: []
+post_install_message: |
+  
+  For more information on ssn_validator, see http://kevintyll.github.com/ssn_validator/
+  
+  * To create the necessary db migration, from the command line, run:
+      script/generate ssn_validator_migration
+  * Require the gem in your environment.rb file in the Rails::Initializer block:
+      config.gem 'kevintyll-ssn_validator', :lib => 'ssn_validator'
+  * To load your table with the current SSN data, from the command line, run:
+      rake ssn_validator:update_data
+      * The SSN data is updated monthly, so you'll want to run this rake task monthly to keep your validations accurate.
+  * If you've purchased the death master file data, create the death_master_files migration:
+      script/generate death_master_file_migration
+  * To load the dmf files you receive from ntis:
+      rake ssn_validator:death_master_file:load_file PATH='path/to/file' AS_OF='2009-03-01'
+      * You'll need to pass in the full path to where the file is on disk.  You'll also need
+        to pass in the date this file's data are as of in the format yyyy-mm-dd.
+      * This task must be used to load the initial file you receive from ntis on CD.  It can optionally be used
+        to load the monthly update files you download from the website.  If you manually download the update files,
+        you do not need to add your user name and password to the environment.rb file.  For a more automated approach
+        to loading the update files, add your user name and password to the environment.rb file and use the 2nd rake task.
+  * To load the monthly updates from the ntis website:
+      * Add your user_name and password to the environment.rb file
+          SsnValidator::Ntis.user_name = 'REPLACE WITH YOUR dmf.ntis.gov USER NAME'
+          SsnValidator::Ntis.password = 'REPLACE WITH YOUR dmf.ntis.gov PASSWORD'
+      * Run the rake task:
+          rake ssn_validator:death_master_file:update_data
+          * This rake task will determine the most recent file that has been loaded, and loads all subsequent files in order
+          from the dmf.ntis.gov website.
+          * The death master file data is updated monthly, so you'll want to run this rake task monthly to keep your validations accurate.
 
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
-- .
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
@@ -76,12 +107,8 @@ signing_key:
 specification_version: 2
 summary: Validates whether an SSN has likely been issued or not.
 test_files: 
+- test/mocks/test/death_master_file_loader.rb
+- test/test_death_master_file_loader.rb
 - test/test_helper.rb
-- test/test_ssn_validator.rb
 - test/test_ssn_high_group_code_loader.rb
-- test/test_death_master_file_loader.rb
-- test/mocks/test/death_master_file_loader.rb
-- test/files/test_dmf_initial_load.txt
-- test/files/test_dmf_update_load.txt
-- test/files/test_dmf_funky_data_load.txt
-- test/files/valid_csv_from_funky_data_file.txt
+- test/test_ssn_validator.rb

data/Manifest.txt

@@ -1,29 +0,0 @@
-History.txt
-Manifest.txt
-PostInstall.txt
-README.rdoc
-Rakefile
-generators/ssn_validator_migration/templates/migration.rb
-generators/ssn_validator_migration/ssn_validator_migration_generator.rb
-generators/death_master_file_migration/templates/migration.rb
-generators/death_master_file_migration/death_master_file_migration_generator.rb
-lib/ssn_validator/ntis.rb
-lib/ssn_validator/models/ssn_high_group_code.rb
-lib/ssn_validator/models/ssn_high_group_code_loader.rb
-lib/ssn_validator/models/ssn_validator.rb
-lib/ssn_validator/models/death_master_file.rb
-lib/ssn_validator/models/death_master_file_loader.rb
-lib/ssn_validator.rb
-lib/tasks/ssn_validator.rake
-script/console
-script/destroy
-script/generate
-test/test_helper.rb
-test/test_ssn_validator.rb
-test/test_ssn_high_group_code_loader.rb
-test/test_death_master_file_loader.rb
-test/mocks/test/death_master_file_loader.rb
-test/files/test_dmf_initial_load.txt
-test/files/test_dmf_update_load.txt
-test/files/test_dmf_funky_data_load.txt
-test/files/valid_csv_from_funky_data_file.txt

data/script/console

@@ -1,10 +0,0 @@
-#!/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 #{File.dirname(__FILE__) + '/../lib/ssn_validator.rb'}"
-puts "Loading ssn_validator gem"
-exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/destroy'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/generate'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Generate.new.run(ARGV)