ohio_state_person 0.0.2 → 0.1.0

data/README.md

@@ -0,0 +1,33 @@
+# ohio_state_person
+
+[Gem page](https://rubygems.org/gems/ohio_state_person)
+
+
+## Description
+
+This is an extraction of the common user model code in our Rails apps.
+
+
+## Synopsis
+
+```ruby
+class Student < ActiveRecord::Base
+  is_a_buckeye
+end
+```
+
+
+## Features
+
+It validates the format and uniqueness of ```name_n``` and ```emplid```.
+
+It sets the ```id``` of new records to ```emplid.to_i```, and validates that the ```id``` is always ```emplid.to_i```.
+
+It adds a class method: ```search```, which searches by ```emplid```, ```name_n```, ```last_name, first_name```, ```first_name last_name```, or just ```last_name```, depending on whether the search term looks like an emplid, name_n, etc.
+
+It adds an instance method: ```email```, which is just ```"#{name_n}@osu.edu"```.
+
+
+## Usage
+
+Just call ```is_a_buckeye``` from the class level in your model.  This mixin expects ```emplid```, ```name_n```, ```first_name```, and ```last_name``` to be attributes of the model in question.

data/lib/ohio_state_person.rb

@@ -2,58 +2,60 @@ require "ohio_state_person/version"
 
 module OhioStatePerson
 
-	module ModelAdditions
-		def is_a_buckeye
-			extend ClassMethods
-			include InstanceMethods
-
-			validates_uniqueness_of :name_n
-			validates_format_of :name_n, :with => /\A[a-z]([a-z-]*[a-z])?\.[1-9]\d*\z/, :message => 'must be in format: name.#'
-
-			validates_uniqueness_of :emplid
-			validates_format_of :emplid, :with => /\A\d{8,9}\z/, :message => 'must be 8 or 9 digits'
-
-			before_validation :set_id, :on => :create
-			validate :id_is_emplid
-		end
-	end
-
-	module ClassMethods
-		def search(q)
-			q.strip! if q
-			case q
-			when /\A\d+\z/
-				where(:emplid => q)
-			when /\A\D+\.\d+\z/
-				where(:name_n => q)
-			when /(\S+),\s*(\S+)/
-				where('last_name LIKE ? AND first_name LIKE ?', $1, "#{$2}%")
-			when /(\S+)\s+(\S+)/
-				where('first_name LIKE ? AND last_name LIKE ?', $1, "#{$2}%")
-			when /\S/
-				where('last_name LIKE ?', "#{q}%")
-			else
-				where('1=2')
-			end
-		end
-	end
-
-	module InstanceMethods
-		def email
-			name_n.present? ? "#{name_n}@osu.edu" : ''
-		end
-
-		protected
-		def set_id
-			self.id = self.emplid.to_i
-		end
-
-		def id_is_emplid
-			unless self.id == self.emplid.to_i
-				errors.add(:id, 'must be the same as the emplid')
-			end
-		end
-	end
+  module ModelAdditions
+    def is_a_buckeye
+      extend ClassMethods
+      include InstanceMethods
+
+      if column_names.include? 'name_n'
+        validates_uniqueness_of :name_n
+        validates_format_of :name_n, :with => /\A[a-z]([a-z-]*[a-z])?\.[1-9]\d*\z/, :message => 'must be in format: name.#'
+      end
+
+      validates_uniqueness_of :emplid
+      validates_format_of :emplid, :with => /\A\d{8,9}\z/, :message => 'must be 8 or 9 digits'
+
+      before_validation :set_id, :on => :create
+      validate :id_is_emplid
+    end
+  end
+
+  module ClassMethods
+    def search(q)
+      q = q.to_s.strip
+      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') }
+
+      h.each do |regex, where_clause|
+        return where_clause.call if q =~ regex
+      end
+
+    end
+  end
+
+  module InstanceMethods
+    def email
+      return self[:email] if self.class.column_names.include? 'email'
+      return nil      unless self.class.column_names.include? 'name_n'
+      name_n.present? ? "#{name_n}@osu.edu" : ''
+    end
+
+    protected
+    def set_id
+      self.id = self.emplid.to_i
+    end
+
+    def id_is_emplid
+      unless self.id == self.emplid.to_i
+        errors.add(:id, 'must be the same as the emplid')
+      end
+    end
+  end
 
 end
 

data/lib/ohio_state_person/version.rb

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

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - mikegee
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-21 00:00:00 Z
+date: 2012-02-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -44,6 +44,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - lib/ohio_state_person.rb
 - lib/ohio_state_person/version.rb
@@ -77,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ohio_state_person
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: ActiveRecord mixin for people at Ohio State University