your_platform 0.0.1 → 0.0.2

data/app/models/profile_field_mixins/has_child_profile_fields.rb

@@ -0,0 +1,114 @@
+# -*- coding: utf-8 -*-
+module ProfileFieldMixins::HasChildProfileFields
+
+  # This creates an easier way to access a composed ProfileField's child field
+  # values. Instead of calling 
+  #
+  #    bank_account.children.where( :label => :account_number ).first.value
+  #    bank_account.children.where( :label => :account_number ).first.value = "12345"
+  #
+  # you may call
+  # 
+  #    bank_account.account_number
+  #    bank_account.account_number = "12345"
+  #
+  # after telling the profile_field to create these accessors:
+  #
+  #    class BankAccount < ProfileField
+  #      ...
+  #      has_child_profile_fields :account_holder, :account_number, ...
+  #      ...
+  #    end
+  # 
+  # Furthermore, this method modifies the intializer to build the child fields
+  # on build of the main profile_field.
+  #
+  def has_child_profile_fields( *keys )
+
+    before_save :build_child_fields_if_absent
+    after_save :save_child_profile_fields
+    
+    attr_accessible *keys
+
+    include HasChildProfileFieldsInstanceMethods
+
+    self.class_eval <<-EOL
+
+      def keys
+        #{keys}
+      end
+
+    EOL
+
+
+    keys.each do |accessor|
+
+      self.class_eval <<-EOL
+
+          def #{accessor}
+            self.get_field( :#{accessor} )
+          end
+
+          def #{accessor}=( new_value )
+            self.set_field( :#{accessor}, new_value )
+          end
+
+      EOL
+
+    end
+  end
+
+  module HasChildProfileFieldsInstanceMethods
+
+    def find_child_by_key(key)
+      # we have to use 'select' here instead of 'where', because this needs
+      # to work before the records are saved. But this should not be a problem,
+      # since there are only a couple of child fields.
+      #
+      self.children.select { |child| child.key.to_s == key.to_s }.first
+    end
+    def find_or_build_child_by_key(key)
+      find_child_by_key(key) || build_child(key)
+    end
+
+    def build_child_fields_if_absent
+      if self.children_count == 0
+        build_child_fields self.keys
+      end
+    end
+
+    def build_child_fields( keys )
+      if self.parent == nil # do it only for the parent, not the children as well
+        keys.each do |key|
+          build_child(key) unless find_child_by_key(key)
+        end
+      end
+    end
+
+    # This method saves the child profile fields. 
+    # This is necessary, since the acts_as_tree gem does not provide the
+    # autosave option for the association.
+    #
+    def save_child_profile_fields
+      children.each do |child_field|
+        child_field.save
+      end
+    end
+    private :save_child_profile_fields
+
+    def get_field( accessor )
+      find_child_by_key(accessor).value if find_child_by_key(accessor)
+    end
+
+    def set_field( accessor, value )
+      build_child_fields_if_absent
+      find_child_by_key(accessor).value = value
+    end
+
+    def build_child( key )
+      children.build( label: key )
+    end
+
+  end
+
+end

data/app/models/profile_field_types/about.rb

@@ -0,0 +1,9 @@
+module ProfileFieldTypes
+
+  # About Myself Field
+  #
+  class About < ProfileField
+    def self.model_name; ProfileField.model_name; end
+  end
+  
+end

data/app/models/profile_field_types/academic_degree.rb

@@ -0,0 +1,10 @@
+module ProfileFieldTypes
+
+  # Academic Degree 
+  #
+  class AcademicDegree < ProfileField
+    def self.model_name; ProfileField.model_name; end
+
+  end
+
+end

data/app/models/profile_field_types/address.rb

@@ -0,0 +1,88 @@
+module ProfileFieldTypes
+
+  # Address Information
+  # 
+  class Address < ProfileField
+    def self.model_name; ProfileField.model_name; end
+
+    attr_accessible :postal_address
+
+    # Google Maps integration
+    # see: http://rubydoc.info/gems/gmaps4rails/
+    acts_as_gmappable
+
+    def geo_location
+      find_or_create_geo_location
+    end
+
+    def find_geo_location
+      @geo_location ||= GeoLocation.find_by_address(value)
+    end
+
+    def find_or_create_geo_location
+      @geo_location ||= GeoLocation.find_or_create_by_address(value) if self.value && self.value != "—"
+    end
+
+    def display_html
+      ActionController::Base.helpers.simple_format self.value
+    end
+
+    # This is needed to display the map later.
+    def gmaps4rails_address
+      self.value
+    end
+
+    def gmaps
+      true
+    end
+
+    def latitude ;      geo_information :latitude      end
+    def longitude ;     geo_information :longitude     end
+    def country ;       geo_information :country       end
+    def country_code ;  geo_information :country_code  end
+    def city ;          geo_information :city          end
+    def postal_code ;   geo_information :postal_code   end
+    def plz ;           geo_information :plz           end
+
+    def geo_information( key )
+      return nil if self.value == "—"
+      geo_location.send( key ) if self.value
+    end
+
+    def geocoded?
+      (find_geo_location && @geo_location.geocoded?).to_b
+    end
+    def geocode
+      return @geo_location.geocode if @geo_location
+      return @geo_location.geocode if find_geo_location
+      return find_or_create_geo_location
+    end
+
+    # Allow to mark one address as primary postal address.
+    # 
+    def postal_address
+      self.has_flag? :postal_address
+    end 
+    def postal_address=(new_postal_address)
+      if new_postal_address != self.postal_address
+        if new_postal_address
+          self.clear_postal_address
+          self.add_flag :postal_address
+        else
+          self.remove_flag :postal_address
+        end
+        self.delete_cache
+      end
+    end
+    def postal_address?
+      self.postal_address
+    end
+    def clear_postal_address
+      self.profileable.profile_fields.where(type: "ProfileFieldTypes::Address").each do |address_field|
+        address_field.remove_flag :postal_address
+      end
+    end
+
+  end
+  
+end

data/app/models/profile_field_types/bank_account.rb

@@ -0,0 +1,12 @@
+module ProfileFieldTypes
+
+  # Bank Account Information
+  # 
+  class BankAccount < ProfileField
+    def self.model_name; ProfileField.model_name; end
+
+    has_child_profile_fields( :account_holder, :account_number, :bank_code,
+                              :credit_institution, :iban, :bic )
+  end
+  
+end

data/app/models/profile_field_types/competence.rb

@@ -0,0 +1,7 @@
+module ProfileFieldTypes
+
+  class Competence < ProfileField
+    def self.model_name; ProfileField.model_name; end
+  end
+  
+end

data/app/models/profile_field_types/custom.rb

@@ -0,0 +1,12 @@
+module ProfileFieldTypes
+
+  # Custom Contact Information
+  #
+  # Custom profile_fields are just key-value fields. They don't have a
+  # sub-structure. They are displayed in the contact section of a profile.
+  #
+  class Custom < ProfileField
+    def self.model_name; ProfileField.model_name; end
+  end
+  
+end

data/app/models/profile_field_types/date.rb

@@ -0,0 +1,14 @@
+module ProfileFieldTypes
+
+  # Date Field
+  #
+  class Date < ProfileField
+    def self.model_name; ProfileField.model_name; end
+
+    def value
+      date_string = super
+      I18n.localize(date_string.to_date) if date_string.present?
+    end
+  end
+  
+end

data/app/models/profile_field_types/description.rb

@@ -0,0 +1,15 @@
+module ProfileFieldTypes
+
+  # Description Field
+  # 
+  # This fields are used to display any kind of free-text descriptive information.
+  #
+  class Description < ProfileField
+    def self.model_name; ProfileField.model_name; end
+
+    def display_html
+      ActionController::Base.helpers.simple_format self.value
+    end
+  end
+  
+end

data/app/models/profile_field_types/email.rb

@@ -0,0 +1,20 @@
+module ProfileFieldTypes
+
+  # Email Contact Information
+  #
+  class Email < ProfileField
+    validates_format_of :value, :with => Devise::email_regexp, :if => Proc.new { |pf| pf.value.present? }
+    
+    def self.model_name; ProfileField.model_name; end
+
+    def display_html
+      mail = self.value || ""
+      if mail == "—"
+        mail
+      else
+        ActionController::Base.helpers.mail_to mail
+      end
+    end
+  end
+  
+end

data/app/models/profile_field_types/employment.rb

@@ -0,0 +1,24 @@
+module ProfileFieldTypes
+
+  class Employment < ProfileField
+    def self.model_name; ProfileField.model_name; end
+    
+    has_child_profile_fields :from, :to, :organization, :position, :task
+    
+    # If the employment instance has no label, just say 'Employment'.
+    #
+    def label
+      super || I18n.translate( :employment, default: "Employment" ) 
+    end
+
+    def from
+      get_field(:from).to_date if get_field(:from)
+    end
+
+    def to
+      get_field(:to).to_date if get_field(:to)
+    end
+
+  end
+  
+end

data/app/models/profile_field_types/general.rb

@@ -0,0 +1,9 @@
+module ProfileFieldTypes
+
+  # General Information Field
+  #
+  class General < ProfileField
+    def self.model_name; ProfileField.model_name; end
+  end
+
+end

data/app/models/profile_field_types/homepage.rb

@@ -0,0 +1,19 @@
+module ProfileFieldTypes
+
+  # Homepage Field
+  #
+  class Homepage < ProfileField
+    def self.model_name; ProfileField.model_name; end
+
+    def display_html
+      url = self.value || ''
+      url = "http://#{url}" unless url.starts_with? 'http://' or url == "—"
+      if url.starts_with?( "http://" )
+        ActionController::Base.helpers.link_to url, url
+      else
+        url
+      end
+    end
+  end
+
+end

data/app/models/profile_field_types/name_surrounding.rb

@@ -0,0 +1,11 @@
+module ProfileFieldTypes
+
+  # Name Surrounding
+  #
+  class NameSurrounding < ProfileField
+    def self.model_name; ProfileField.model_name; end
+
+    has_child_profile_fields :text_above_name, :name_prefix, :name_suffix, :text_below_name
+  end
+  
+end

data/app/models/profile_field_types/organization.rb

@@ -0,0 +1,24 @@
+module ProfileFieldTypes
+
+  # Organisation Membership Information
+  #
+  # An organization entry represents the activity of a user in an organization.
+  # Such an entry could be:
+  #
+  #    the user is "Lead Singer" of "the Band XYZ" since "May 2007"
+  #
+  # Therefore, this profile_field has got a sub-structure.
+  #
+  #    Organization  <-- label of the parent profile field
+  #         |--------- ProfileField:  :label => :from
+  #         |--------- ProfileField:  :label => :to
+  #         |--------- ProfileField:  :label => :role
+  #
+  class Organization < ProfileField
+    def self.model_name; ProfileField.model_name; end
+
+    has_child_profile_fields :from, :to, :role
+
+  end
+  
+end

data/app/models/profile_field_types/phone.rb

@@ -0,0 +1,37 @@
+module ProfileFieldTypes
+
+  # Phone Number Field
+  #
+  class Phone < ProfileField
+    def self.model_name; ProfileField.model_name; end
+
+    before_save :auto_format_value
+
+    def self.format_phone_number( phone_number_str )
+      return "" if phone_number_str.nil?
+      value = phone_number_str
+
+      # determine whether this is an international number
+      format = :national
+      format = :international if value.start_with?( "00" ) or value.start_with? ( "+" )
+
+      # do only format international numbers, since for national numbers, the country
+      # is unknown and each country formats its national area codes differently.
+      if format == :international
+        value = Phony.normalize( value ) # remove spaces etc.
+        value = value[ 2..-1 ] if value.start_with?( "00" ) # because Phony can't handle leading 00
+        value = value[ 1..-1 ] if value.start_with?( "+" ) # because Phony can't handle leading +
+        value = Phony.formatted( value, :format => format, :spaces => ' ' )
+      end
+      
+      return value
+    end
+
+    private
+    def auto_format_value
+      self.value = Phone.format_phone_number( self.value )
+    end
+
+  end
+
+end