contactable 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009
+
+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/Manifest

@@ -0,0 +1,23 @@
+LICENSE
+Manifest
+README.rdoc
+Rakefile
+generators/contactable/USAGE
+generators/contactable/contactable_generator.rb
+generators/contactable/templates/migrations/create_contactable_related_tables.rb
+generators/contactable/templates/models/address.rb
+generators/contactable/templates/models/address_type.rb
+generators/contactable/templates/models/city.rb
+generators/contactable/templates/models/country.rb
+generators/contactable/templates/models/email.rb
+generators/contactable/templates/models/email_type.rb
+generators/contactable/templates/models/instant_messenger.rb
+generators/contactable/templates/models/instant_messenger_protocol.rb
+generators/contactable/templates/models/instant_messenger_type.rb
+generators/contactable/templates/models/phone.rb
+generators/contactable/templates/models/phone_type.rb
+generators/contactable/templates/models/province.rb
+generators/contactable/templates/models/website.rb
+generators/contactable/templates/models/website_type.rb
+lib/contactable.rb
+test/contactable_test.rb

data/README.rdoc

@@ -0,0 +1,2 @@
+= Contactable
+    A rails gem that adds contact information to an active record model

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('contactable', '0.1.0') do |p|
+  p.description     = "Adds contact information to an active record model"
+  p.url             = "http://github.com/lperichon/contactable"
+  p.author          = "Luis Perichon"
+  p.email           = "info@luisperichon.com.ar"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/contactable.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{contactable}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Luis Perichon"]
+  s.date = %q{2009-11-18}
+  s.description = %q{Adds contact information to an active record model}
+  s.email = %q{info@luisperichon.com.ar}
+  s.extra_rdoc_files = ["LICENSE", "README.rdoc", "lib/contactable.rb"]
+  s.files = ["LICENSE", "Manifest", "README.rdoc", "Rakefile", "generators/contactable/USAGE", "generators/contactable/contactable_generator.rb", "generators/contactable/templates/migrations/create_contactable_related_tables.rb", "generators/contactable/templates/models/address.rb", "generators/contactable/templates/models/address_type.rb", "generators/contactable/templates/models/city.rb", "generators/contactable/templates/models/country.rb", "generators/contactable/templates/models/email.rb", "generators/contactable/templates/models/email_type.rb", "generators/contactable/templates/models/instant_messenger.rb", "generators/contactable/templates/models/instant_messenger_protocol.rb", "generators/contactable/templates/models/instant_messenger_type.rb", "generators/contactable/templates/models/phone.rb", "generators/contactable/templates/models/phone_type.rb", "generators/contactable/templates/models/province.rb", "generators/contactable/templates/models/website.rb", "generators/contactable/templates/models/website_type.rb", "lib/contactable.rb", "test/contactable_test.rb", "contactable.gemspec"]
+  s.homepage = %q{http://github.com/lperichon/contactable}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Contactable", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{contactable}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Adds contact information to an active record model}
+  s.test_files = ["test/contactable_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/generators/contactable/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Creates a migration that adds contactable fields to the given model
+
+Example:
+    ./script/generate contactable contact [--skip_related]
+
+    This will create:
+        db/migrate/TIMESTAMP_create_contactable_related_tables.rb
+        app/models/...
+        db/migrate/TIMESTAMP_add_contactable_fields_to_contact.rb

data/generators/contactable/contactable_generator.rb

@@ -0,0 +1,45 @@
+class ContactableGenerator < Rails::Generator::NamedBase
+  default_options :skip_related => false
+
+  def add_options!(opt)
+    opt.on('-sr', '--skip_related') { |value| options[:skip_related] = value }
+  end
+
+  def manifest
+    record do |m|
+      unless options[:skip_related]
+        # migration
+        m.file 'migrations/create_contactable_related_tables.rb', "db/migrate/#{Time.now.strftime('%Y%m%d%H%M%S')}_create_contactable_related_tables.rb"
+
+        # models
+        %w( address address_type phone phone_type instant_messenger
+          instant_messenger_type instant_messenger_protocol website website_type
+          email email_type country province city ).each do |model|
+          m.file "models/#{model}.rb", "app/models/#{model}.rb"
+        end
+      end
+      m.migration_template 'migration:migration.rb', "db/migrate", {:assigns => contactable_local_assigns,
+        :migration_file_name => "add_contactable_fields_to_#{custom_file_name}"
+       }
+    end
+  end
+
+  private
+    def custom_file_name
+      custom_name = class_name.underscore.downcase
+      custom_name = custom_name.pluralize if ActiveRecord::Base.pluralize_table_names
+    end
+
+    def contactable_local_assigns
+      returning(assigns = {}) do
+        assigns[:migration_action] = "add"
+        assigns[:class_name] = "add_contactable_fields_to_#{custom_file_name}"
+        assigns[:table_name] = custom_file_name
+        assigns[:attributes] = []
+        assigns[:attributes] << Rails::Generator::GeneratedAttribute.new("first_name", "string")
+        assigns[:attributes] << Rails::Generator::GeneratedAttribute.new("middle_name", "string")
+        assigns[:attributes] << Rails::Generator::GeneratedAttribute.new("last_name", "string")
+        assigns[:attributes] << Rails::Generator::GeneratedAttribute.new("birthday", "date")
+      end
+    end
+end

data/generators/contactable/templates/migrations/create_contactable_related_tables.rb

@@ -0,0 +1,108 @@
+class CreateContactableRelatedTables < ActiveRecord::Migration
+  def self.up
+    create_table  :addresses do |t|
+      t.integer   :owner_id
+      t.string    :owner_type
+      t.integer   :type_id, :default => 1
+      t.string    :address
+      t.integer   :city_id
+      t.integer   :province_id
+      t.integer   :country_id
+      t.string    :zip
+
+      t.timestamps
+    end
+
+    create_table  :emails do |t|
+      t.integer   :owner_id
+      t.string    :owner_type
+      t.integer   :type_id, :default => 1
+      t.string    :address
+
+      t.timestamps
+    end
+
+    create_table  :instant_messengers do |t|
+      t.integer   :owner_id
+      t.string    :owner_type
+      t.integer   :protocol_id, :default => 1
+      t.integer   :type_id, :default => 1
+      t.string    :nick
+
+      t.timestamps
+    end
+
+    create_table  :phones do |t|
+      t.integer   :owner_id
+      t.string    :owner_type
+      t.integer   :type_id, :default => 1
+      t.string    :number
+
+      t.timestamps
+    end
+
+    create_table  :websites do |t|
+      t.integer   :owner_id
+      t.string    :owner_type
+      t.integer   :type_id, :default => 1
+      t.string    :address
+
+      t.timestamps
+    end
+
+    create_table  :address_types do |t|
+      t.string    :description
+    end
+
+    create_table  :cities do |t|
+      t.references :province
+      t.string    :name
+    end
+
+    create_table  :countries do |t|
+      t.string    :name
+    end
+
+    create_table  :email_types do |t|
+      t.string    :description
+    end
+
+    create_table  :instant_messenger_protocols do |t|
+      t.string    :name
+    end
+
+    create_table  :instant_messenger_types do |t|
+      t.string    :description
+    end
+
+    create_table  :phone_types do |t|
+      t.string    :description
+    end
+
+    create_table  :provinces do |t|
+      t.references :country
+      t.string    :name
+    end
+
+    create_table  :website_types do |t|
+      t.string    :description
+    end
+  end
+
+  def self.down
+    drop_table :addresses
+    drop_table :emails
+    drop_table :instant_messengers
+    drop_table :phones
+    drop_table :websites
+    drop_table :address_types
+    drop_table :cities
+    drop_table :countries
+    drop_table :email_types
+    drop_table :instant_messenger_protocols
+    drop_table :instant_messenger_types
+    drop_table :phone_types
+    drop_table :provinces
+    drop_table :website_types
+  end
+end

data/generators/contactable/templates/models/address.rb

@@ -0,0 +1,33 @@
+class Address < ActiveRecord::Base
+
+  belongs_to :owner, :polymorphic => true
+  belongs_to :type, :class_name => 'AddressType'
+  belongs_to :city
+  belongs_to :country
+  belongs_to :province
+
+  def city_name
+    city.name if city
+  end
+
+  def city_name=(name)
+    self.city = City.find_or_create_by_name(name.to_s.titleize) unless name.blank?
+  end
+
+  def province_name
+    province.name if province
+  end
+
+  def province_name=(name)
+    self.province = Province.find_or_create_by_name(name.to_s.titleize) unless name.blank?
+  end
+
+  def country_name
+    country.name if country
+  end
+
+  def country_name=(name)
+    self.country = Country.find_or_create_by_name(name.to_s.titleize) unless name.blank?
+  end
+
+end

data/generators/contactable/templates/models/address_type.rb

@@ -0,0 +1,5 @@
+class AddressType < ActiveRecord::Base
+  
+  validates_presence_of :description
+  
+end

data/generators/contactable/templates/models/city.rb

@@ -0,0 +1,4 @@
+class City < ActiveRecord::Base
+  belongs_to :province
+  validates_presence_of :name, :province
+end

data/generators/contactable/templates/models/country.rb

@@ -0,0 +1,4 @@
+class Country < ActiveRecord::Base
+  has_many :provinces
+  validates_presence_of :name
+end

data/generators/contactable/templates/models/email.rb

@@ -0,0 +1,14 @@
+class Email < ActiveRecord::Base
+
+  validates_presence_of :address
+  validates_format_of   :address,
+    :with => /^([a-zA-Z0-9_\.\-\+])+\@(([a-zA-Z0-9\-])+\.)+([a-zA-Z0-9]{2,4})+$/
+
+  belongs_to            :owner, :polymorphic => true
+  belongs_to            :type,  :class_name => 'EmailType'
+
+  def before_save
+    self.address.downcase!
+  end
+
+end

data/generators/contactable/templates/models/email_type.rb

@@ -0,0 +1,5 @@
+class EmailType < ActiveRecord::Base
+  
+    validates_presence_of :description
+    
+end

data/generators/contactable/templates/models/instant_messenger.rb

@@ -0,0 +1,9 @@
+class InstantMessenger < ActiveRecord::Base
+
+  validates_presence_of :nick
+
+  belongs_to :owner,    :polymorphic => true
+  belongs_to :protocol, :class_name => 'InstantMessengerProtocol'
+  belongs_to :type,     :class_name => 'InstantMessengerType'
+
+end

data/generators/contactable/templates/models/instant_messenger_protocol.rb

@@ -0,0 +1,5 @@
+class InstantMessengerProtocol < ActiveRecord::Base
+  
+    validates_presence_of :name
+    
+end

data/generators/contactable/templates/models/instant_messenger_type.rb

@@ -0,0 +1,5 @@
+class InstantMessengerType < ActiveRecord::Base
+  
+    validates_presence_of :description
+    
+end

data/generators/contactable/templates/models/phone.rb

@@ -0,0 +1,8 @@
+class Phone < ActiveRecord::Base
+
+  validates_presence_of :number
+
+  belongs_to :owner,  :polymorphic => true
+  belongs_to :type,   :class_name => 'PhoneType'
+
+end

data/generators/contactable/templates/models/phone_type.rb

@@ -0,0 +1,5 @@
+class PhoneType < ActiveRecord::Base
+  
+  validates_presence_of :description
+  
+end

data/generators/contactable/templates/models/province.rb

@@ -0,0 +1,5 @@
+class Province < ActiveRecord::Base
+  belongs_to :country
+  has_many :cities
+  validates_presence_of :name, :country
+end

data/generators/contactable/templates/models/website.rb

@@ -0,0 +1,8 @@
+class Website < ActiveRecord::Base
+
+  validates_presence_of :address
+
+  belongs_to            :owner, :polymorphic => true
+  belongs_to            :type,  :class_name => 'WebsiteType'
+
+end

data/generators/contactable/templates/models/website_type.rb

@@ -0,0 +1,5 @@
+class WebsiteType < ActiveRecord::Base
+  
+  validates_presence_of :description
+  
+end

data/lib/contactable.rb

@@ -0,0 +1,84 @@
+module Contactable
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  # This  extension provides contact information to an active record model.
+  #
+  # Examples:
+  #
+  #   class Person < ActiveRecord::Base
+  #     contactable
+  #   end
+  module ClassMethods
+    # Configuration options are:
+    #
+    def contactable(*args, &block)
+      # default options
+      options = {}
+      options.merge!(args.pop) if args.last.kind_of? Hash
+
+      class_eval <<-EOV
+        def name_part_columns
+          [:first_name, :middle_name, :last_name]
+        end
+
+        def name_parts
+          name_parts = []
+            name_part_columns.each do |name_part|
+              name_parts << self.send(name_part) if self.respond_to?(name_part)
+            end
+          name_parts
+        end
+
+        # contactable#name() supports 2 options:
+        # If a name column exists that one is used
+        # If not use first, middle and last_name columns (only if available)
+        def name
+          if self[:name]
+            self[:name]
+          else
+            name_parts.join(' ')
+          end
+        end
+
+        def initials
+          if self[:name]
+            self[:name].tr('-', ' ').split(' ').map { |word| word.chars.first.upcase.to_s + '.'}.join
+          else
+            name_parts.map {|name_part| name_part.chars.first.upcase.to_s + '.'}.join
+          end
+        end
+
+        def age
+          if self.respond_to?(:birthday) && !self.birthday.nil?
+            now = Time.now.utc.to_date
+            now.year - birthday.year - (birthday.to_date.change(:year => now.year) > now ? 1 : 0)
+          end
+        end
+
+        has_many                      :addresses,           :as => :owner
+        has_many                      :emails,              :as => :owner
+        has_many                      :instant_messengers,  :as => :owner
+        has_many                      :phones,              :as => :owner
+        has_many                      :websites,            :as => :owner
+
+        accepts_nested_attributes_for :addresses,
+          :reject_if => proc { |attributes| attributes['address'].blank? }, :allow_destroy => true
+        accepts_nested_attributes_for :emails,
+          :reject_if => proc { |attributes| attributes['address'].blank? }, :allow_destroy => true
+        accepts_nested_attributes_for :instant_messengers,
+          :reject_if => proc { |attributes| attributes['nick'].blank? }, :allow_destroy => true
+        accepts_nested_attributes_for :phones,
+          :reject_if => proc { |attributes| attributes['number'].blank? }, :allow_destroy => true
+        accepts_nested_attributes_for :websites,
+          :reject_if => proc { |attributes| attributes['address'].blank? }, :allow_destroy => true
+      EOV
+    end
+
+  end
+end
+
+class ActiveRecord::Base
+  include Contactable
+end

data/test/contactable_test.rb

@@ -0,0 +1,84 @@
+require 'test/unit'
+require 'rubygems'
+gem 'activerecord'
+gem 'timecop'
+require 'timecop'
+require 'active_record'
+
+require "#{File.dirname(__FILE__)}/../lib/contactable"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :contacts do |t|
+      t.column :first_name, :string
+      t.column :last_name, :string
+      t.column :birthday, :date
+    end
+    create_table :companies do |t|
+      t.column :name, :string
+    end
+    create_table :email_addresses do |t|
+      t.column :contactable_id, :integer
+      t.column :contactable_type, :string
+      t.column :address, :string
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Contact < ActiveRecord::Base
+  contactable
+end
+
+class Company < ActiveRecord::Base
+  contactable
+end
+
+class EmailAddress < ActiveRecord::Base
+  belongs_to :contactable, :polymorphic => true
+  validates_presence_of :contactable, :address
+end
+
+class ContactableTest < Test::Unit::TestCase
+
+  def setup
+    setup_db
+
+    # Set Time.now to September 1, 2008 10:05:00 AM (at this instant), but allow it to move forward
+    t = Time.local(2009, 11, 6, 10, 5, 0)
+    Timecop.travel(t)    
+    @contact = Contact.create! :first_name => "Bart", :last_name => "Simpson", :birthday => Date.parse('3-3-1983')
+    @company = Company.create! :name => "The Leftorium"
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_name
+    assert_equal 'Bart Simpson', @contact.name
+    assert_equal 'The Leftorium', @company.name
+  end
+
+  def test_initials
+    assert_equal 'B.S.', @contact.initials
+  end
+
+  def test_age
+    assert_equal 26, @contact.age
+  end
+
+  def test_email_addresses
+    assert @contact.email_addresses.empty?
+
+    contact_with_email = Contact.create!(:first_name => 'Homer', :last_name => "Simpson", :email_addresses_attributes => [{:address => 'homer@simpsons.com'}] )
+  end
+
+end 

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: contactable
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Luis Perichon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-18 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: Adds contact information to an active record model
+email: info@luisperichon.com.ar
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- lib/contactable.rb
+files: 
+- LICENSE
+- Manifest
+- README.rdoc
+- Rakefile
+- generators/contactable/USAGE
+- generators/contactable/contactable_generator.rb
+- generators/contactable/templates/migrations/create_contactable_related_tables.rb
+- generators/contactable/templates/models/address.rb
+- generators/contactable/templates/models/address_type.rb
+- generators/contactable/templates/models/city.rb
+- generators/contactable/templates/models/country.rb
+- generators/contactable/templates/models/email.rb
+- generators/contactable/templates/models/email_type.rb
+- generators/contactable/templates/models/instant_messenger.rb
+- generators/contactable/templates/models/instant_messenger_protocol.rb
+- generators/contactable/templates/models/instant_messenger_type.rb
+- generators/contactable/templates/models/phone.rb
+- generators/contactable/templates/models/phone_type.rb
+- generators/contactable/templates/models/province.rb
+- generators/contactable/templates/models/website.rb
+- generators/contactable/templates/models/website_type.rb
+- lib/contactable.rb
+- test/contactable_test.rb
+- contactable.gemspec
+has_rdoc: true
+homepage: http://github.com/lperichon/contactable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Contactable
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: contactable
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Adds contact information to an active record model
+test_files: 
+- test/contactable_test.rb