contactable 0.1.0 → 1.0.1

data/CHANGELOG

@@ -0,0 +1,2 @@
+v1.0.1. Added contactable_views generator
+v1.0. Initial public release

data/Manifest

@@ -1,23 +1,103 @@
+CHANGELOG
 LICENSE
 Manifest
 README.rdoc
 Rakefile
+app/controllers/addresses_controller.rb
+app/controllers/cities_controller.rb
+app/controllers/contact_field_actions.rb
+app/controllers/divisions_controller.rb
+app/controllers/emails_controller.rb
+app/controllers/identifications_controller.rb
+app/controllers/instant_messengers_controller.rb
+app/controllers/phones_controller.rb
+app/controllers/websites_controller.rb
+app/helpers/contactable_helper.rb
+app/models/address.rb
+app/models/address_type.rb
+app/models/city.rb
+app/models/country.rb
+app/models/division.rb
+app/models/email.rb
+app/models/email_type.rb
+app/models/identification.rb
+app/models/identification_type.rb
+app/models/instant_messenger.rb
+app/models/instant_messenger_protocol.rb
+app/models/instant_messenger_type.rb
+app/models/phone.rb
+app/models/phone_type.rb
+app/models/province.rb
+app/models/website.rb
+app/models/website_type.rb
+app/views/addresses/_address.html.erb
+app/views/cities/index.html.erb
+app/views/contactable/_contactable.html.erb
+app/views/contactable/_contactable_field.html.erb
+app/views/contactable/_fields.html.erb
+app/views/divisions/index.html.erb
+app/views/emails/_email.html.erb
+app/views/identifications/_identification.html.erb
+app/views/instant_messengers/_instant_messenger.html.erb
+app/views/phones/_phone.html.erb
+app/views/websites/_website.html.erb
+config/contactable_routes.rb
 generators/contactable/USAGE
 generators/contactable/contactable_generator.rb
+generators/contactable/lib/insert_commands.rb
+generators/contactable/templates/README
 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
+generators/contactable_views/USAGE
+generators/contactable_views/contactable_views_generator.rb
+generators/contactable_views/templates/views/formtastic/addresses/_address.html.erb
+generators/contactable_views/templates/views/formtastic/cities/index.html.erb
+generators/contactable_views/templates/views/formtastic/contactable/_contactable.html.erb
+generators/contactable_views/templates/views/formtastic/contactable/_contactable_field.html.erb
+generators/contactable_views/templates/views/formtastic/contactable/_fields.html.erb
+generators/contactable_views/templates/views/formtastic/divisions/index.html.erb
+generators/contactable_views/templates/views/formtastic/emails/_email.html.erb
+generators/contactable_views/templates/views/formtastic/identifications/_identification.html.erb
+generators/contactable_views/templates/views/formtastic/instant_messengers/_instant_messenger.html.erb
+generators/contactable_views/templates/views/formtastic/phones/_phone.html.erb
+generators/contactable_views/templates/views/formtastic/websites/_website.html.erb
+generators/contactable_views/templates/views/jintastic/addresses/_address.html.erb
+generators/contactable_views/templates/views/jintastic/addresses/_form.html.erb
+generators/contactable_views/templates/views/jintastic/addresses/create.js.rjs
+generators/contactable_views/templates/views/jintastic/addresses/destroy.js.rjs
+generators/contactable_views/templates/views/jintastic/addresses/update.js.rjs
+generators/contactable_views/templates/views/jintastic/cities/index.html.erb
+generators/contactable_views/templates/views/jintastic/contactable/_birthday.html.erb
+generators/contactable_views/templates/views/jintastic/contactable/_contactable.html.erb
+generators/contactable_views/templates/views/jintastic/contactable/_contactable_field.html.erb
+generators/contactable_views/templates/views/jintastic/contactable/_fields.html.erb
+generators/contactable_views/templates/views/jintastic/contactable/_name.html.erb
+generators/contactable_views/templates/views/jintastic/divisions/index.html.erb
+generators/contactable_views/templates/views/jintastic/emails/_email.html.erb
+generators/contactable_views/templates/views/jintastic/emails/_form.html.erb
+generators/contactable_views/templates/views/jintastic/emails/create.js.rjs
+generators/contactable_views/templates/views/jintastic/emails/destroy.js.rjs
+generators/contactable_views/templates/views/jintastic/emails/update.js.rjs
+generators/contactable_views/templates/views/jintastic/identifications/_form.html.erb
+generators/contactable_views/templates/views/jintastic/identifications/_identification.html.erb
+generators/contactable_views/templates/views/jintastic/identifications/create.js.rjs
+generators/contactable_views/templates/views/jintastic/identifications/destroy.js.rjs
+generators/contactable_views/templates/views/jintastic/identifications/update.js.rjs
+generators/contactable_views/templates/views/jintastic/instant_messengers/_form.html.erb
+generators/contactable_views/templates/views/jintastic/instant_messengers/_instant_messenger.html.erb
+generators/contactable_views/templates/views/jintastic/instant_messengers/create.js.rjs
+generators/contactable_views/templates/views/jintastic/instant_messengers/destroy.js.rjs
+generators/contactable_views/templates/views/jintastic/instant_messengers/update.js.rjs
+generators/contactable_views/templates/views/jintastic/phones/_form.html.erb
+generators/contactable_views/templates/views/jintastic/phones/_phone.html.erb
+generators/contactable_views/templates/views/jintastic/phones/create.js.rjs
+generators/contactable_views/templates/views/jintastic/phones/destroy.js.rjs
+generators/contactable_views/templates/views/jintastic/phones/update.js.rjs
+generators/contactable_views/templates/views/jintastic/websites/_form.html.erb
+generators/contactable_views/templates/views/jintastic/websites/_website.html.erb
+generators/contactable_views/templates/views/jintastic/websites/create.js.rjs
+generators/contactable_views/templates/views/jintastic/websites/destroy.js.rjs
+generators/contactable_views/templates/views/jintastic/websites/update.js.rjs
 lib/contactable.rb
+lib/contactable/extensions/routes.rb
+rails/init.rb
 test/contactable_test.rb

data/README.rdoc

@@ -1,2 +1,28 @@
 = Contactable
-    A rails gem that adds contact information to an active record model
+  A rails gem that adds contact information to an active record model
+
+== Installation
+
+To install the Formtastic gem run:
+  sudo gem install contactable
+
+And add it to your environment.rb configuration as a gem dependency:
+  config.gem 'contactable'
+
+Now you can use it in your existing models by running:
+  ./script/generate contactable contact
+
+Remember you need to add the new contactable routes:
+  map.resources :contacts do |contact|
+    contact.contactable_resources
+  end
+
+You can now use the default contactable partial in your show view
+  <%= render :partial => 'contactable/contactable', :locals => {:contactable => @contact} %>
+
+And in your formtastic form
+  <%= render :partial => 'contactable/fields', :locals => {:f => f}
+
+Optionally, run
+  ./script/generate contactable_views formtastic
+

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('contactable', '0.1.0') do |p|
+Echoe.new('contactable', '1.0.1') do |p|
   p.description     = "Adds contact information to an active record model"
   p.url             = "http://github.com/lperichon/contactable"
   p.author          = "Luis Perichon"

data/app/controllers/addresses_controller.rb

@@ -0,0 +1,3 @@
+class AddressesController < ApplicationController
+  include ContactFieldActions
+end

data/app/controllers/cities_controller.rb

@@ -0,0 +1,16 @@
+class CitiesController < ApplicationController
+  layout nil
+
+  def index
+    search_options = {
+    }.merge(params[:search])
+    search_options[:country_id] = 0 if search_options[:country_id].blank?
+    @field_dom_id = params['field_dom_id']
+    @search = City.search(search_options)
+    if @search
+      @cities = @search.all
+    else
+      @cities = []
+    end
+  end
+end

data/app/controllers/contact_field_actions.rb

@@ -0,0 +1,60 @@
+module ContactFieldActions
+  def self.included(base)
+    base.class_eval do
+      before_filter :load_contactable
+      helper ContactableHelper
+    end
+  end
+
+  def load_contactable
+    path_component = request.path.split('/').reject(&:blank?).first.singularize
+    class_name = path_component.capitalize
+    @contactable = Kernel.const_get(class_name).find(params["#{path_component}_id"])
+  end
+
+  def association_name
+    self.field_name.pluralize
+  end
+
+  def field_name
+    self.controller_class_name.chomp("Controller").singularize.underscore
+  end
+
+  def create
+    @field = @contactable.send("#{self.association_name}").new(params[self.field_name.to_sym])
+
+    if @field.save
+      flash[:notice] = t(self.association_name + '.create.notice')
+      respond_to do |format|
+        format.js {}
+      end
+    else
+      # TODO: handle errors via js
+    end
+  end
+
+  def update
+    @field = @contactable.send("#{self.association_name}").find(params[:id])
+
+    @field.attributes = params[self.field_name.to_sym]
+    if @field.save
+      flash[:notice] = t(self.association_name + '.update.notice')
+
+      respond_to do |format|
+        format.js {}
+      end
+    end
+  end
+
+  def destroy
+    @field = @contactable.send("#{self.association_name}").find(params[:id])
+    @field_dom_id = dom_id @field
+    if @field.destroy
+      flash[:notice] = t(self.association_name + '.destroy.notice')
+
+      respond_to do |format|
+        format.js {}
+      end
+    end
+  end
+end

data/app/controllers/divisions_controller.rb

@@ -0,0 +1,17 @@
+class DivisionsController < ApplicationController
+  layout nil
+  def index
+    search_options = {
+      'level' => 1,
+    }.merge(params[:search])
+    search_options[:country_id] = 0 if search_options[:country_id].blank?
+    @field_dom_id = params['field_dom_id']
+    @level = Integer(search_options['level'])
+    @search = Division.search(search_options)
+    if params[:search]
+      @divisions = @search.all
+    else
+      @divisions = []
+    end
+  end
+end

data/app/controllers/emails_controller.rb

@@ -0,0 +1,3 @@
+class EmailsController < ApplicationController
+  include ContactFieldActions
+end

data/app/controllers/identifications_controller.rb

@@ -0,0 +1,3 @@
+class IdentificationsController < ApplicationController
+  include ContactFieldActions
+end

data/app/controllers/instant_messengers_controller.rb

@@ -0,0 +1,3 @@
+class InstantMessengersController < ApplicationController
+  include ContactFieldActions
+end

data/app/controllers/phones_controller.rb

@@ -0,0 +1,3 @@
+class PhonesController < ApplicationController
+  include ContactFieldActions
+end

data/app/controllers/websites_controller.rb

@@ -0,0 +1,3 @@
+class WebsitesController < ApplicationController
+  include ContactFieldActions
+end

data/app/helpers/contactable_helper.rb

@@ -0,0 +1,46 @@
+module ContactableHelper
+  def identification_label(identification)
+    "#{identification.type ? identification.type.name : nil} - #{identification.code}"
+  end
+
+  def phone_label(phone)
+    "#{phone.type ? phone.type.name : nil} - #{phone.number}"
+  end
+
+  def address_label(address)
+    "#{address.type ? address.type.name : nil} - #{address.full_address}"
+  end
+
+  def email_label(email)
+    "#{email.type ? email.type.name : nil} - #{email.address}"
+  end
+
+  def website_label(website)
+    "#{website.type ? website.type.name : nil} - #{website.address}"
+  end
+
+  def instant_messenger_label(instant_messenger)
+    "#{instant_messenger.type ? instant_messenger.type.name : nil} - #{instant_messenger.protocol ? instant_messenger.protocol.name : nil} - #{instant_messenger.nick}"
+  end
+
+    # Helpers for contact nested forms
+  def add_new_record_link(record, name, form_builder)
+    name = name.to_s
+    plural_name = name.pluralize
+    link_to_function "add a new #{name}", :class => 'add' do |page|
+      new_record = record.send(plural_name).build
+      form_builder.semantic_fields_for plural_name, new_record, :child_index => 'NEW_RECORD' do |p|
+        html = "<fieldset class='inputs'><ol>#{render(:partial => plural_name + '/' + name, :locals => { :f => p, name.to_sym => new_record })}</ol></fieldset>"
+        page << "$('##{plural_name}').append('#{escape_javascript(html)}'.replace(/NEW_RECORD/g, new Date().getTime()));"
+      end
+    end
+  end
+
+  # remove link
+  def remove_link_unless_new_record(fields)
+    out = ''
+    out << fields.hidden_field(:_delete) unless fields.object.new_record?
+    out << link_to_function("remove", "$(this).parent().parent().hide(); $(this).siblings('input[type=hidden]')[0].value = 1;", :class => 'remove')
+    out
+  end
+end

data/app/models/address.rb

@@ -0,0 +1,96 @@
+class Address < ActiveRecord::Base
+
+  belongs_to :owner, :polymorphic => true
+  belongs_to :type, :class_name => 'AddressType'
+  belongs_to :city
+  belongs_to :country
+  belongs_to :division1, :class_name => 'Division'
+  belongs_to :division2, :class_name => 'Division'
+  belongs_to :division3, :class_name => 'Division'
+  belongs_to :division4, :class_name => 'Division'
+
+  #acts_as_mappable :default_units => :kms
+  before_save :cleanup_address
+  #before_validation :geocode_address
+
+  def full_address
+    returning address_str = "" do
+      if self.address.present?
+        address_str << self.address
+      end
+      if self.city.present?
+        address_str << ", #{self.city.name}"
+      end
+      if self.zip.present?
+        address_str << " (#{self.zip})"
+      end
+      %w(division4 division3 division2 division1).each do |division|
+        if self.send(division).present?
+          address_str << ", #{self.send(division).name}"
+        end
+      end
+      if self.country.present?
+        address_str << ", #{self.country.name}"
+      end
+    end
+  end
+
+  def mapped?
+    lat && lng
+  end
+
+  def coordinates
+    [lat, lng]
+  end
+
+  def cities
+    if self.division4
+      self.division4.cities
+    elsif self.division3 && self.division3.children.empty?
+      self.division3.cities
+    elsif self.division2 && self.division2.children.empty?
+      self.division2.cities
+    elsif self.division1 && self.division1.children.empty?
+      self.division1.cities
+    elsif self.country && self.country.first_level_divisions.empty?
+      self.country.cities
+    else
+      []
+    end
+  end
+
+  private
+
+#
+#  def geocode_address
+#    geo=Geokit::Geocoders::MultiGeocoder.geocode(self.full_address)
+#    errors.add(:address, I18n.t('address.geocode_error')) if !geo.success
+#    self.lat, self.lng = geo.lat,geo.lng if geo.success
+#  end
+
+  def cleanup_address
+    (2..4).to_a.reverse.each do |idx|
+      # if division[idx-1] is not parent of division[idx]
+      # or division[idx] is not present
+      # or division[idx-1] is not present
+      if(self.send("division#{idx}").present? && self.send("division#{idx - 1}").present? && self.send("division#{idx - 1}") != self.send("division#{idx}").parent ||
+          self.send("division#{idx}").blank? ||
+          self.send("division#{idx - 1}").blank?)
+        (idx..4).each do |invalid_idx|
+          # cleanup all divisions below
+          self.send("division#{invalid_idx}=", nil)
+        end
+      end
+
+      if(self.division1.present? && self.country.present? && self.country != self.division1.country ||
+          self.country.blank?)
+        (1..4).each do |invalid_idx|
+          # cleanup all divisions below
+          self.send("division#{invalid_idx}=", nil)
+        end
+      end
+
+      self.city = nil unless self.cities.include?(self.city)
+    end
+  end
+end

data/app/models/address_type.rb

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

data/app/models/city.rb

@@ -0,0 +1,21 @@
+class City < ActiveRecord::Base
+  belongs_to :country
+  belongs_to :division
+
+  # Returns an array with all the parents of this city
+  #
+  # The first position in the array is the +country+ and up to 4 more positions
+  # can contain the ADM1, ADM2, ADM3 and ADM4 divisions containing the city
+  def containers
+    return @containers unless @containers.nil?
+    container_codes = []
+    codes = code.split('|')
+    container_codes << (codes = codes[0..-2]).join('|') while codes.size > 1
+    # first is country code
+    @containers = [country]
+    # second, third can be parent administrative division if not nil
+    # NOTE container codes is like: ["ES|58|PO", "ES|58", "ES"] (country is last)
+    @containers += Division.find_all_by_code container_codes[0..-2], :order => :level if container_codes.size > 1
+    return @containers
+  end
+end