ohio_state_person 0.1.0 → 0.2.0

data/.gitignore

@@ -2,3 +2,6 @@
 .bundle
 Gemfile.lock
 pkg/*
+.project
+*.swp
+spec/debug.log

data/.rvmrc

@@ -0,0 +1,81 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ree@ohio_state_person"
+
+#
+# Uncomment the following lines if you want to verify rvm version per project
+#
+# rvmrc_rvm_version="1.10.2" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+#
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+#
+# The variable PROJECT_JRUBY_OPTS requires the following to be run in shell:
+#
+#    chmod +x ${rvm_path}/hooks/after_use_jruby_opts
+#
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create use  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && ! command -v bundle >/dev/null
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && command -v bundle
+# then
+#   bundle install
+# fi
+
+if [[ $- == *i* ]] # check for interactive shells
+then
+    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+else 
+	echo "Using: $GEM_HOME" # don't use colors in interactive shells
+fi
+

data/Rakefile

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

data/lib/ohio_state_person/version.rb

@@ -1,3 +1,3 @@
 module OhioStatePerson
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/ohio_state_person.rb

@@ -21,15 +21,20 @@ module OhioStatePerson
   end
 
   module ClassMethods
-    def search(q)
-      q = q.to_s.strip
+    def search(q, options={})
+      q = q.to_s
       h = ActiveSupport::OrderedHash.new
-      h[/\A\d+\z/]        = lambda { where(:emplid => q) }
-      h[/\A\D+\.\d+\z/]   = lambda { where(:name_n => q) } if column_names.include? 'name_n'
-      h[/(\S+),\s*(\S+)/] = lambda { where('last_name LIKE ? AND first_name LIKE ?', $1, "#{$2}%") }
-      h[/(\S+)\s+(\S+)/]  = lambda { where('first_name LIKE ? AND last_name LIKE ?', $1, "#{$2}%") }
-      h[/\S/]             = lambda { where('last_name LIKE ?', "#{q}%") }
-      h[//]               = lambda { where('1=2') }
+      if options[:fuzzy]
+        h[/\A\s*\d+\s*\z/]      = lambda { where('emplid LIKE ?', "#{q.strip}%") }
+        h[/\A\s*\D+\.\d*\s*\z/] = lambda { where('name_n LIKE ?', "#{q.strip}%") } if column_names.include? 'name_n'
+      else
+        h[/\A\s*\d+\s*\z/]      = lambda { where(:emplid => q.strip) }
+        h[/\A\s*\D+\.\d*\s*\z/] = lambda { where(:name_n => q.strip) } if column_names.include? 'name_n'
+      end
+      h[/(\S+),\s*(\S*)/]     = lambda { where('last_name LIKE ? AND first_name LIKE ?', $1, "#{$2}%") }
+      h[/(\S+)\s+(\S*)/]      = lambda { where('first_name LIKE ? AND last_name LIKE ?', $1, "#{$2}%") }
+      h[/\S/]                 = lambda { where('last_name LIKE ?', "#{q}%") }
+      h[//]                   = lambda { where('1=2') }
 
       h.each do |regex, where_clause|
         return where_clause.call if q =~ regex

data/ohio_state_person.gemspec

@@ -18,8 +18,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
   s.add_runtime_dependency "activerecord", '~> 3.0'
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "activesupport", '~> 3.0'
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "shoulda-matchers"
+  s.add_development_dependency "factory_girl"
 end

data/spec/callbacks_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe 'callbacks' do
+  let(:student) { create :student, :emplid => 87654321 }
+
+  it 'should set id to emplid.to_i' do
+    student.id.should == 87654321
+  end
+end

data/spec/database.yml

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

data/spec/email_helper_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'email helper method' do
+
+  context 'a model with neither email nor name_n fileds' do
+    subject { build :luddite }
+    its(:email) { should be_nil }
+  end
+
+  context 'a model with an email field' do
+    subject { build :applicant, :email => 'email@address' }
+    its(:email) { should == 'email@address' }
+  end
+
+  context 'a model with a name_n field' do
+    subject { build :student, :name_n => 'student.1' }
+    its(:email) { should == 'student.1@osu.edu' }
+  end
+end

data/spec/search_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe 'the search method' do
+
+  before(:all) do
+    Student.delete_all
+    @student = create :student,
+                      :first_name => 'Brutus',
+                      :last_name  => 'Buckeye',
+                      :name_n     => 'buckeye.11',
+                      :emplid     => '18181818'
+  end
+
+  it "should return no results given a blank search" do
+    Student.search(nil).should == []
+    Student.search('').should == []
+  end
+
+  it "should return exact matches on emplid" do
+    Student.search(18181818).should == [@student]
+    Student.search(1818).should == []
+  end
+
+  it "should return exact matches on name_n" do
+    Student.search('buckeye.11').should == [@student]
+    Student.search('buckeye.1').should == []
+  end
+
+  it "should return fuzzy matches on emplid" do
+    Student.search(18181818, :fuzzy => true).should == [@student]
+    Student.search(1818,     :fuzzy => true).should == [@student]
+  end
+
+  it "should return fuzzy matches on name_n" do
+    Student.search('buckeye.11', :fuzzy => true).should == [@student]
+    Student.search('buckeye.1',  :fuzzy => true).should == [@student]
+  end
+
+  it "should not give results on first name only" do
+    Student.search('Brutus').should == []
+    Student.search('Brut').should == []
+  end
+
+  it "should give results on last name only" do
+    Student.search('Buckeye').should == [@student]
+    Student.search('Buck').should == [@student]
+  end
+
+  it "should give results for full name" do
+    Student.search('Brutus Buckeye').should == [@student]
+    Student.search('Brutus Bu').should == [@student]
+  end
+
+  it "should ignore case" do
+    Student.search('BUCKEYE').should == [@student]
+    Student.search('buckeye').should == [@student]
+  end
+
+  it "should return multiple results sorted by name_n" do
+    other_buckeye = create :student,
+                           :first_name => 'Derpina',
+                           :last_name  => 'Buckeye',
+                           :name_n     => 'buckeye.99'
+    Student.search('buckeye').order('name_n').should == [@student, other_buckeye]
+    other_buckeye.destroy
+  end
+
+  it "should match on last name, first name" do
+    Student.search('Buckeye, Brutus').should == [@student]
+  end
+
+  it "should ignore case on last name, first name" do
+    Student.search('BUCKEYE, BRUTUS').should == [@student]
+  end
+
+  it "should partially match on last name, first name" do
+    Student.search('Buckeye, Brut').should == [@student]
+  end
+
+  it "should ignore beginning and trailing whitespace" do
+    Student.search('18181818 ').should == [@student]
+    Student.search(' 18181818').should == [@student]
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'active_record'
+require 'active_support'
+require 'ohio_state_person'
+require 'shoulda-matchers'
+require 'factory_girl'
+
+ActiveRecord::Base.logger = ActiveSupport::BufferedLogger.new(File.dirname(__FILE__) + "/debug.log")
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.establish_connection(config['test'])
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+  config.color_enabled = true
+end

data/spec/support/factories.rb

@@ -0,0 +1,27 @@
+FactoryGirl.define do
+  sequence :emplid do |n|
+    '%08d' % n
+  end
+  sequence :name_n do |n|
+    "buckeye.#{n}"
+  end
+
+  factory :student do
+    first_name 'Brutus'
+    last_name  'Buckeye'
+    name_n
+    emplid
+  end
+
+  factory :applicant do
+    first_name 'Brutus'
+    last_name  'Buckeye'
+    email      'brutus_buckeye@gmail.com'
+    emplid
+  end
+
+  factory :luddite do
+    first_name 'Some'
+    last_name  'Guy'
+  end
+end

data/spec/support/models/applicant.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Base.connection.create_table :applicants, :force => true do |table|
+  table.column :emplid, :string
+  table.column :email, :string
+  table.column :first_name, :string
+  table.column :last_name, :string
+end
+
+class Applicant < ActiveRecord::Base
+  is_a_buckeye
+end

data/spec/support/models/luddite.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Base.connection.create_table :luddites, :force => true do |table|
+  table.column :first_name, :string
+  table.column :last_name, :string
+end
+
+class Luddite < ActiveRecord::Base
+  is_a_buckeye
+end

data/spec/support/models/student.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Base.connection.create_table :students, :force => true do |table|
+  table.column :emplid, :string
+  table.column :name_n, :string
+  table.column :first_name, :string
+  table.column :last_name, :string
+end
+
+class Student < ActiveRecord::Base
+  is_a_buckeye
+end

data/spec/validations_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'validations' do
+
+  specify { build(:student).should be_valid }
+  specify { build(:applicant).should be_valid }
+
+  let(:student)   { create :student }
+  let(:applicant) { create :applicant }
+
+  describe 'the name_n field' do
+    subject { student }
+
+    it { should validate_uniqueness_of :name_n }
+    it { should validate_format_of(:name_n).not_with('gee2').
+           with_message(/must be in format: name.#/) }
+    it { should validate_format_of(:name_n).with('gee.2').
+           with_message(/must be in format: name.#/) }
+  end
+
+  describe 'the emplid field' do
+    subject { applicant }
+
+    it { should validate_uniqueness_of :emplid }
+    it { should validate_format_of(:emplid).not_with('54321').
+           with_message(/must be 8 or 9 digits/) }
+    it { should validate_format_of(:emplid).with('987654321').
+           with_message(/must be 8 or 9 digits/) }
+  end
+
+  describe 'the id field' do
+    subject { student }
+
+    specify { subject.id.should == subject.emplid.to_i }
+
+    context 'with a different emplid' do
+      before { subject.emplid = subject.id + 1 }
+      specify do
+        subject.should_not be_valid
+        subject.errors[:id].should == ['must be the same as the emplid']
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ohio_state_person
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - mikegee
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-06 00:00:00 Z
+date: 2012-02-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -32,6 +32,91 @@ dependencies:
         version: "3.0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: shoulda-matchers
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: factory_girl
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: "requires fields: name_n, emplid; sets id to emplid.to_i; provides a search method; etc."
 email: 
 - gee.24@osu.edu
@@ -43,12 +128,23 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rvmrc
 - Gemfile
 - README.md
 - Rakefile
 - lib/ohio_state_person.rb
 - lib/ohio_state_person/version.rb
 - ohio_state_person.gemspec
+- spec/callbacks_spec.rb
+- spec/database.yml
+- spec/email_helper_spec.rb
+- spec/search_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/models/applicant.rb
+- spec/support/models/luddite.rb
+- spec/support/models/student.rb
+- spec/validations_spec.rb
 homepage: https://github.com/ASCTech/ohio_state_person
 licenses: []
 
@@ -82,5 +178,14 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: ActiveRecord mixin for people at Ohio State University
-test_files: []
-
+test_files: 
+- spec/callbacks_spec.rb
+- spec/database.yml
+- spec/email_helper_spec.rb
+- spec/search_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/models/applicant.rb
+- spec/support/models/luddite.rb
+- spec/support/models/student.rb
+- spec/validations_spec.rb