acts_as_human 2.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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,36 @@
+= ActsAsHuman
+
+* Adds:
+      full_name
+* and
+      full_name=
+instance methods to a model
+
+Adds validations to ensure that the names are reasonable.
+
+* Requires:
+      first_name, last_name and middle_names columns on the model
+
+@todo Need to add rake task to add fields to model.
+
+== Example
+      
+      class User < ActiveRecord::Base
+        acts_as_human
+      end
+
+* user = User.new(:first_name => 'Brent', :last_name => 'Greeff')
+      user.full_name
+        => "Brent Greeff"
+
+* user = User.new(:full_name => "Brent Wicked Middle Names Greeff")
+      user.first_name
+        => "Brent"
+      
+      user.last_name
+        => "Greeff"
+      
+      user.middle_names
+        => "Wicked Middle Names"
+
+Copyright (c) 2009 [Brent Greeff], released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_human plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_human plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsHuman'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/lib/acts_as_human/validations.rb

@@ -0,0 +1,22 @@
+module ActiveRecord
+  module Validations
+    module ClassMethods
+	    
+	    def validates_as_person_name(*attr_names)
+	      config = {
+	        :with => ActsAs::Human.acceptable_name,
+          :message => ActsAs::Human.bad_name_message
+	      }
+	      check_format(attr_names, config)
+	    end
+			
+			private
+			
+			def check_format(attr_names, config)
+			  config.update(attr_names.pop) if attr_names.last.is_a?(Hash)
+		    validates_format_of attr_names, config
+			end
+			
+    end
+  end
+end

data/lib/acts_as_human.rb

@@ -0,0 +1,83 @@
+module ActsAs
+  module Human
+    mattr_accessor :acceptable_name, :bad_name_message
+    
+    self.acceptable_name    = /\A[^[:cntrl:]\\<>\/&]*\z/
+    self.bad_name_message   = "some characters in your name are not allowed".freeze
+    
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+    
+    module ClassMethods
+      
+      def acts_as_human(options={})
+        cattr_accessor :require_last_name
+        
+        if options.has_key? :require_last_name
+          @require_last_name = options[:require_last_name]
+        else
+          @require_last_name = true
+        end
+        send :include, InstanceMethods
+
+        class_eval do
+          validates_presence_of       :first_name, :message => 'first name is required'
+          validates_length_of         :first_name, :maximum => 40,
+                                      :message => 'first name is too long (max 40 characters)'
+          validates_as_person_name    :first_name
+          
+          validates_length_of         :middle_names, :maximum => 40,
+                                      :allow_blank => true,
+                                      :message => 'middle names are too long (max 40 characters)'
+          validates_as_person_name    :middle_names, :allow_nil => true
+          
+          validates_presence_of       :last_name, :if => Proc.new { @require_last_name },
+                                      :message => 'last name is required'
+          validates_length_of         :last_name, :maximum => 40,
+                                      :allow_blank => true,
+                                      :message => 'last name is too long (max 40 characters)'
+          validates_as_person_name    :last_name
+        end
+      end
+      
+    end
+    
+    module InstanceMethods
+      def full_name
+        return '' if first_name.blank? and last_name.blank?
+    
+        return "#{first_name} #{last_name}" if middle_names.blank?
+        return "#{first_name} #{middle_names} #{last_name}"
+      end
+      
+      def full_name=(names)
+        names_array = names.titlecase.split
+    
+        self.first_name = names_array.first
+        return if names_array.size < 2
+    
+        self.last_name = names_array.last
+    
+        assign_middle_names(names_array)
+      end
+      
+      private
+      
+      def assign_middle_names(names_array)
+        if names_array.size > 2
+          self.middle_names = get_middle_names(names_array)
+        else
+          self.middle_names = nil
+        end
+      end
+      
+      def get_middle_names(names_array)
+        names_array[1..(names_array.size-2)].join(' ')
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActsAs::Human)
+

data/test/acts_as_human_test.rb

@@ -0,0 +1,126 @@
+require File.dirname(__FILE__) + '/test_helper.rb' 
+
+class ActsAsHumanTest < ActiveSupport::TestCase
+  
+  class User < ActiveRecord::Base
+    acts_as_human
+  end
+  
+  class Customer < ActiveRecord::Base
+    acts_as_human :require_last_name => false
+  end
+  
+  def test_should_require_a_first_name
+    user = create_user
+    user.first_name = ''
+    
+    deny user.valid?, 'Should not be valid without a first name'
+    assert_equal 'first name is required', user.errors[:first_name]
+  end
+  
+  def test_should_have_first_name_that_is_less_than_40_characters
+    user = User.new(:first_name => 'aaaaabbbbbcccccdddddeeeeefffffggggghhhhhi')
+    
+    deny user.valid?
+    assert_equal 'first name is too long (max 40 characters)', user.errors[:first_name]
+  end
+  
+  def test_should_require_a_last_name
+    user = User.new(:first_name => 'Brent')
+    
+    deny user.valid?
+    assert_equal 'last name is required', user.errors[:last_name]
+  end
+  
+  def test_should_not_require_a_last_name_if_not_required
+    someone_else = Customer.new(:first_name => 'Brent')
+    assert someone_else.valid?
+  end
+  
+  def test_should_have_last_name_that_is_less_than_40_characters
+    user = create_user
+    user.last_name = 'aaaaabbbbbcccccdddddeeeeefffffggggghhhhhi'
+    
+    deny user.valid?
+    assert_equal 'last name is too long (max 40 characters)', user.errors[:last_name]
+  end
+  
+  def test_should_have_a_last_name_when_assigned_through_full_name
+    user = User.new(:full_name => 'Brent')
+    
+    deny user.valid?
+    assert_equal 'last name is required', user.errors[:last_name]
+  end
+  
+  def test_should_have_full_name_composed_of_first_and_last_name
+    user = User.new(:first_name => 'Brent', :last_name => 'Greeff')
+    assert_equal 'Brent Greeff', user.full_name
+  end
+  
+  def test_should_have_full_name_composed_of_first_middle_and_last_name
+    user = User.new(:first_name => 'Brent', :middle_names => 'Middle Names', :last_name => 'Greeff')
+    assert_equal 'Brent Middle Names Greeff', user.full_name
+  end
+  
+  def test_should_assign_first_and_last_name_when_assigning_to_full_name
+    user = User.new(:full_name => 'Brent Greeff')
+    
+    assert_equal 'Brent', user.first_name
+    assert_equal 'Greeff', user.last_name
+  end
+  
+  def test_should_assign_first_last_and_middle_names_when_assigning_to_full_name
+    user = User.new(:full_name => 'Brent Middle Names Greeff')
+    
+    assert_equal 'Brent', user.first_name
+    assert_equal 'Middle Names', user.middle_names
+    assert_equal 'Greeff', user.last_name
+  end
+  
+  def test_should_have_middle_names_that_are_less_than_40_characters
+    user = create_user
+    user.middle_names = 'aaaaabbbbbcccccdddddeeeeefffffggggghhhhhi'
+    
+    deny user.valid?
+    assert_equal 'middle names are too long (max 40 characters)', user.errors[:middle_names]
+  end
+  
+  def test_should_have_a_empty_full_name_when_user_is_new
+    user = User.new
+    assert_equal '', user.full_name
+  end
+  
+  def test_should_not_allow_non_name_like_characters
+    user = User.new(:full_name => "<Brent> Middle >< Names Gre&eff")
+    
+    deny user.valid?
+    assert_equal 'some characters in your name are not allowed', user.errors[:first_name]
+    assert_equal 'some characters in your name are not allowed', user.errors[:last_name]
+    assert_equal 'some characters in your name are not allowed', user.errors[:middle_names]
+  end
+  
+  private
+  
+  def create_user(options={})
+    default_options = {
+      :first_name => "Brent",
+      :last_name => "Greeff"
+    }
+    
+    return User.create!(default_options.merge(options))
+  end
+  
+  def create_customer(options={})
+    default_options = {
+      :first_name => "Brent",
+      :last_name => "Greeff"
+    }
+    
+    return Customer.create!(default_options.merge(options))
+  end
+  
+  def deny(expected_to_be_false, message = '')
+    assert ! expected_to_be_false, message
+  end
+  
+end

data/test/database.yml

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

data/test/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define(:version => 20090628014113) do
+  
+  create_table "users", :force => true do |t|
+    t.string   "first_name"
+    t.string   "middle_names"
+    t.string   "last_name"
+  end
+  
+  create_table "customers", :force => true do |t|
+    t.string   "first_name"
+    t.string   "middle_names"
+    t.string   "last_name"
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'test/unit'
+
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.establish_connection(config['test'])
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+require File.dirname(__FILE__) + '/../rails/init.rb'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_human
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
+platform: ruby
+authors: 
+- Brent Greeff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-27 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Rails plugin to handle first_name, middle_names and last_name combinations.
+email: email@brentgreeff.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/acts_as_human.rb
+- lib/acts_as_human/validations.rb
+- test/acts_as_human_test.rb
+- test/database.yml
+- test/schema.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/brentgreeff/acts_as_human
+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: Rails plugin to handle first_name, middle_names and last_name combinations.
+test_files: []
+