fat_free_crm 0.11.0

data/app/models/fields/custom_field.rb

@@ -0,0 +1,138 @@
+# Fat Free CRM
+# Copyright (C) 2008-2011 by Michael Dvorkin
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#------------------------------------------------------------------------------
+
+# == Schema Information
+#
+# Table name: fields
+#
+#  id             :integer         not null, primary key
+#  type           :string(255)
+#  field_group_id :integer
+#  position       :integer
+#  name           :string(64)
+#  label          :string(128)
+#  hint           :string(255)
+#  placeholder    :string(255)
+#  as             :string(32)
+#  collection     :text
+#  disabled       :boolean
+#  required       :boolean
+#  maxlength      :integer
+#  created_at     :datetime
+#  updated_at     :datetime
+#
+
+# Implementation Notes
+#------------------------------------------------------------------------------
+# Adding database columns dynamically is not usually recommended,
+# and can be potentially unsafe. However, the only alternative would be static migrations,
+# and we want to let users add custom fields without having to restart their server.
+# We could not use the EAV model for performance reasons, since we need to retain the
+# ability to filter and search across thousands of records with potentially hundreds
+# of custom fields.
+#
+# We have solved all of the major issues:
+#
+# * Custom fields for view templates are dynamically generated based on normalized
+#   database records in the 'fields' table, instead of ActiveRecord's cached attributes.
+# * Concurrency issues are resolved by using 'method_missing' to refresh a model's column information
+#   when fields are added by a separate server process.
+# * The custom field can be renamed or deleted, but database columns are never renamed or destroyed.
+#   A rake task can be run to purge any orphaned columns.
+# * Custom field types can only be changed if the database can support the transition.
+#   For example, you can change an 'email' field to a 'string', but not to a 'datetime',
+#   since changing the type of the database column would cause data to be lost.
+#
+
+class CustomField < Field
+  after_validation :update_column, :on => :update
+  before_create    :add_column
+
+  SAFE_DB_TRANSITIONS = {
+    :any => [[:date, :time, :timestamp], [:integer, :float]],
+    :one => {:string => :text}
+  }
+
+  def available_as
+    Field.field_types.reject do |new_type, params|
+      db_transition_safety(as, new_type) == :unsafe
+    end
+  end
+
+protected
+
+  # When changing a custom field's type, it may be necessary to
+  # change the column type in the database. This method returns
+  # the safety of a given transition.
+  # Returns:
+  #   :null   => no transition needed
+  #   :safe   => transition is safe
+  #   :unsafe => transition is unsafe
+  def db_transition_safety(old_type, new_type = self.as)
+    old_col, new_col = [old_type, new_type].map{|t| column_type(t) }
+    return :null if old_col == new_col  # no transition needed
+    return :safe if SAFE_DB_TRANSITIONS[:one].any? do |start, final|
+      old_col == start && new_col == final  # one-to-one
+    end
+    return :safe if SAFE_DB_TRANSITIONS[:any].any? do |col_set|
+      [old_col, new_col].all?{|c| col_set.include?(c)}  # any-to-any
+    end
+    :unsafe # Else, unsafe.
+  end
+
+  def table_name
+    klass.table_name
+  end
+
+  def klass_column_names
+    klass.columns.map(&:name)
+  end
+
+  def generate_column_name
+    # Generate column name for custom field.
+    # If column name is already taken, a numeric suffix is appended.
+    # Example column sequence: cf_custom, cf_custom_2, cf_custom_3, ...
+    suffix = nil
+    field_name = 'cf_' + label.downcase.gsub(/[^a-z0-9]+/, '_')
+    while (final_name = [field_name, suffix].compact.join('_')) &&
+          klass_column_names.include?(final_name) do
+      suffix = (suffix || 1) + 1
+    end
+    final_name
+  end
+
+  # Returns options for ActiveRecord operations
+  def column_options
+    Field.field_types[self.as][:options] || {}
+  end
+
+  def add_column
+    self.name = generate_column_name if name.blank?
+    connection.add_column(table_name, name, column_type, column_options)
+    klass.reset_column_information
+  end
+
+  def update_column
+    # Change database column type if appropriate
+    # (NOTE: Columns will never be renamed or destroyed)
+    if self.errors.empty? && db_transition_safety(as_was) == :safe
+      connection.change_column(table_name, name, column_type, column_options)
+      klass.reset_column_information
+    end
+  end
+end
+

data/app/models/fields/field.rb

@@ -0,0 +1,124 @@
+# Fat Free CRM
+# Copyright (C) 2008-2011 by Michael Dvorkin
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#------------------------------------------------------------------------------
+
+# == Schema Information
+#
+# Table name: fields
+#
+#  id             :integer         not null, primary key
+#  type           :string(255)
+#  field_group_id :integer
+#  position       :integer
+#  name           :string(64)
+#  label          :string(128)
+#  hint           :string(255)
+#  placeholder    :string(255)
+#  as             :string(32)
+#  collection     :text
+#  disabled       :boolean
+#  required       :boolean
+#  maxlength      :integer
+#  created_at     :datetime
+#  updated_at     :datetime
+#
+
+class Field < ActiveRecord::Base
+  acts_as_list
+
+  serialize :collection, Array
+
+  belongs_to :field_group
+
+  delegate :klass, :klass_name, :klass_name=, :to => :field_group
+
+  KLASSES = [Campaign, Lead, Contact, Account, Opportunity]
+
+  FIELD_TYPES = {
+    'string'      => :string,
+    'text'        => :text,
+    'email'       => :string,
+    'url'         => :string,
+    'tel'         => :string,
+    'select'      => :string,
+    'radio'       => :string,
+    'check_boxes' => :text,
+    'boolean'     => :boolean,
+    'date'        => :date,
+    'datetime'    => :timestamp,
+    'decimal'     => [:decimal, {:precision => 15, :scale => 2}],
+    'integer'     => :integer,
+    'float'       => :float
+  }
+
+  validates_presence_of :label, :message => "^Please enter a Field label."
+  validates_length_of :label, :maximum => 64, :message => "^The Field name must be less than 64 characters in length."
+
+  validates_numericality_of :maxlength, :only_integer => true, :allow_blank => true, :message => "^Max size can only be whole number."
+
+  validates_presence_of :as, :message => "^Please specify a Field type."
+  validates_inclusion_of :as, :in => FIELD_TYPES.keys, :message => "Invalid Field Type."
+
+
+  def self.field_types
+    # Expands concise FIELD_TYPES into a more usable hash
+    @field_types ||= FIELD_TYPES.inject({}) do |hash, n|
+      arr = [n[1]].flatten
+      hash[n[0]] = {:type => arr[0], :options => arr[1]}
+      hash
+    end
+  end
+
+  def column_type(field_type = self.as)
+    (opts = Field.field_types[field_type]) ? opts[:type] : raise("Unknown field_type: #{field_type}")
+  end
+
+  def input_options
+    input_html = {:maxlength => attributes[:maxlength]}
+
+    attributes.reject { |k,v|
+      !%w(as collection disabled label placeholder required).include?(k) or v.blank?
+    }.symbolize_keys.merge(:input_html => input_html)
+  end
+
+  def collection_string=(value)
+    self.collection = value.split("|").map(&:strip).reject(&:blank?)
+  end
+  def collection_string
+    collection.try(:join, "|")
+  end
+
+  def render_value(object)
+    render object.send(name)
+  end
+
+  def render(value)
+    case as
+    when 'checkbox'
+      value.to_s == '0' ? "no" : "yes"
+    when 'date'
+      value && value.strftime(I18n.t("date.formats.default"))
+    when 'datetime'
+      value && value.strftime(I18n.t("time.formats.short"))
+    when 'check_boxes'
+      value = YAML.load(value) if value.is_a?(String)
+      value.select(&:present?).in_groups_of(2, false).map {|g| g.join(', ')}.join("<br />".html_safe) if Array === value
+    else
+      value.to_s
+    end
+  end
+end
+

data/app/models/fields/field_group.rb

@@ -0,0 +1,81 @@
+# Fat Free CRM
+# Copyright (C) 2008-2011 by Michael Dvorkin
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#------------------------------------------------------------------------------
+
+# == Schema Information
+#
+# Table name: field_groups
+#
+#  id         :integer         not null, primary key
+#  name       :string(64)
+#  label      :string(128)
+#  position   :integer
+#  hint       :string(255)
+#  created_at :datetime
+#  updated_at :datetime
+#  tag_id     :integer
+#  klass_name :string(32)
+#
+
+class FieldGroup < ActiveRecord::Base
+  has_many :fields, :order => :position
+  belongs_to :tag
+  before_destroy :not_default_field_group, :move_fields_to_default_field_group
+
+  validates_presence_of :label
+
+  before_save do
+    self.name = label.downcase.gsub(/[^a-z0-9]+/, '_') if name.blank? and label.present?
+  end
+
+  def key
+    "field_group_#{id}"
+  end
+
+  def klass
+    klass_name.constantize
+  end
+
+  def core_fields
+    fields.where(:type => 'CoreField')
+  end
+
+  def custom_fields
+    fields.where(:type => 'CustomField')
+  end
+
+  def self.with_tags(tag_ids)
+    where 'tag_id IS NULL OR tag_id IN (?)', tag_ids
+  end
+
+  def label_i18n
+    I18n.t(name, :default => label)
+  end
+  
+  private
+  # Can't delete default field group
+  def not_default_field_group
+    name != "custom_fields"
+  end
+  
+  # When deleted, transfer fields to default field group
+  def move_fields_to_default_field_group
+    default_group = FieldGroup.find_by_name_and_klass_name("custom_fields", klass_name)
+    default_group.fields << fields
+    self.reload
+  end
+end
+

data/app/models/list.rb

@@ -0,0 +1,8 @@
+class List < ActiveRecord::Base
+  validates_presence_of :name
+
+  # Parses the controller from the url
+  def controller
+    (url || "").sub(/^\//,'').split(/\/|\?/).first
+  end
+end

data/app/models/mailers/notifier.rb

@@ -0,0 +1,44 @@
+# Fat Free CRM
+# Copyright (C) 2008-2011 by Michael Dvorkin
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#------------------------------------------------------------------------------
+
+class Notifier < ActionMailer::Base
+
+  #----------------------------------------------------------------------------
+  def password_reset_instructions(user)
+    @edit_password_url = edit_password_url(user.perishable_token)
+
+    mail(:subject => "Fat Free CRM: " + I18n.t(:password_reset_instruction),
+         :to => user.email,
+         :from => "Fat Free CRM <noreply@fatfreecrm.com>",
+         :date => Time.now)
+  end
+
+  #----------------------------------------------------------------------------
+  def dropbox_ack_notification(user, from, email, mediator_links)
+    I18n.locale = Setting.locale
+    @mediator_links = mediator_links.join("\n")
+    @subject        = email.subject
+    @body           = email.body_plain
+
+    mail(:subject => I18n.t(:dropbox_ack_subject, :subject => email.subject),
+         :to => user.email,
+         :from => from,
+         :date => Time.now)
+  end
+
+end
+

data/app/models/observers/activity_observer.rb

@@ -0,0 +1,84 @@
+# Fat Free CRM
+# Copyright (C) 2008-2011 by Michael Dvorkin
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#------------------------------------------------------------------------------
+
+class ActivityObserver < ActiveRecord::Observer
+  observe :account, :campaign, :contact, :lead, :opportunity, :task
+  
+  @@tasks = {}
+  @@leads = {}
+  @@opportunities = {}
+
+  def after_create(subject)
+    log_activity(subject, :created)
+    if subject.is_a?(Opportunity) && subject.campaign && subject.stage == "won"
+      update_campaign_revenue(subject.campaign, (subject.amount || 0) - (subject.discount || 0))
+    end
+  end
+
+  def before_update(subject)
+    if subject.is_a?(Task)
+      @@tasks[subject.id] = Task.find(subject.id).freeze
+    elsif subject.is_a?(Lead)
+      @@leads[subject.id] = Lead.find(subject.id).freeze
+    elsif subject.is_a?(Opportunity)
+      @@opportunities[subject.id] = Opportunity.find(subject.id).freeze
+    end
+  end
+
+  def after_update(subject)
+    if subject.is_a?(Task)
+      original = @@tasks.delete(subject.id)
+      if original
+        return log_activity(subject, :completed)   if subject.completed_at && original.completed_at.nil?
+        return log_activity(subject, :reassigned)  if subject.assigned_to != original.assigned_to
+        return log_activity(subject, :rescheduled) if subject.bucket != original.bucket
+      end
+    elsif subject.is_a?(Lead)
+      original = @@leads.delete(subject.id)
+      if original && original.status != "rejected" && subject.status == "rejected"
+        return log_activity(subject, :rejected)
+      end
+    elsif subject.is_a?(Opportunity)
+      original = @@opportunities.delete(subject.id)
+      if original
+        if original.stage != "won" && subject.stage == "won"    # :other to :won -- add to total campaign revenue.
+          update_campaign_revenue(subject.campaign, (subject.amount || 0) - (subject.discount || 0))
+          return log_activity(subject, :won)
+        elsif original.stage == "won" && subject.stage != "won" # :won to :other -- substract from total campaign revenue.
+          update_campaign_revenue(original.campaign, -((original.amount || 0) - (original.discount || 0)))
+        end
+      end
+    end
+    log_activity(subject, :updated)
+  end
+
+  def before_destroy(subject)
+    log_activity(subject, :deleted)
+  end
+
+  private
+  def log_activity(subject, action)
+    current_user = User.current_user
+    Activity.log(current_user, subject, action) if current_user
+  end
+
+  def update_campaign_revenue(campaign, revenue)
+    campaign.update_attribute(:revenue, (campaign.revenue || 0) + revenue) if campaign
+  end
+
+end
+