Chris@1494: # Redmine - project management software
Chris@1494: # Copyright (C) 2006-2014  Jean-Philippe Lang
Chris@1494: #
Chris@1494: # This program is free software; you can redistribute it and/or
Chris@1494: # modify it under the terms of the GNU General Public License
Chris@1494: # as published by the Free Software Foundation; either version 2
Chris@1494: # of the License, or (at your option) any later version.
Chris@1494: #
Chris@1494: # This program is distributed in the hope that it will be useful,
Chris@1494: # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1494: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@1494: # GNU General Public License for more details.
Chris@1494: #
Chris@1494: # You should have received a copy of the GNU General Public License
Chris@1494: # along with this program; if not, write to the Free Software
Chris@1494: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
Chris@1494: 
Chris@1494: module Redmine
Chris@1494:   module Acts
Chris@1494:     module Customizable
Chris@1494:       def self.included(base)
Chris@1494:         base.extend ClassMethods
Chris@1494:       end
Chris@1494: 
Chris@1494:       module ClassMethods
Chris@1494:         def acts_as_customizable(options = {})
Chris@1494:           return if self.included_modules.include?(Redmine::Acts::Customizable::InstanceMethods)
Chris@1494:           cattr_accessor :customizable_options
Chris@1494:           self.customizable_options = options
Chris@1494:           has_many :custom_values, :as => :customized,
Chris@1494:                                    :include => :custom_field,
Chris@1494:                                    :order => "#{CustomField.table_name}.position",
Chris@1494:                                    :dependent => :delete_all,
Chris@1494:                                    :validate => false
Chris@1494: 
Chris@1494:           send :include, Redmine::Acts::Customizable::InstanceMethods
Chris@1494:           validate :validate_custom_field_values
Chris@1494:           after_save :save_custom_field_values
Chris@1494:         end
Chris@1494:       end
Chris@1494: 
Chris@1494:       module InstanceMethods
Chris@1494:         def self.included(base)
Chris@1494:           base.extend ClassMethods
Chris@1494:           base.send :alias_method_chain, :reload, :custom_fields
Chris@1494:         end
Chris@1494: 
Chris@1494:         def available_custom_fields
Chris@1494:           CustomField.where("type = '#{self.class.name}CustomField'").sorted.all
Chris@1494:         end
Chris@1494: 
Chris@1494:         # Sets the values of the object's custom fields
Chris@1494:         # values is an array like [{'id' => 1, 'value' => 'foo'}, {'id' => 2, 'value' => 'bar'}]
Chris@1494:         def custom_fields=(values)
Chris@1494:           values_to_hash = values.inject({}) do |hash, v|
Chris@1494:             v = v.stringify_keys
Chris@1494:             if v['id'] && v.has_key?('value')
Chris@1494:               hash[v['id']] = v['value']
Chris@1494:             end
Chris@1494:             hash
Chris@1494:           end
Chris@1494:           self.custom_field_values = values_to_hash
Chris@1494:         end
Chris@1494: 
Chris@1494:         # Sets the values of the object's custom fields
Chris@1494:         # values is a hash like {'1' => 'foo', 2 => 'bar'}
Chris@1494:         def custom_field_values=(values)
Chris@1494:           values = values.stringify_keys
Chris@1494: 
Chris@1494:           custom_field_values.each do |custom_field_value|
Chris@1494:             key = custom_field_value.custom_field_id.to_s
Chris@1494:             if values.has_key?(key)
Chris@1494:               value = values[key]
Chris@1494:               if value.is_a?(Array)
Chris@1494:                 value = value.reject(&:blank?).uniq
Chris@1494:                 if value.empty?
Chris@1494:                   value << ''
Chris@1494:                 end
Chris@1494:               end
Chris@1494:               custom_field_value.value = value
Chris@1494:             end
Chris@1494:           end
Chris@1494:           @custom_field_values_changed = true
Chris@1494:         end
Chris@1494: 
Chris@1494:         def custom_field_values
Chris@1494:           @custom_field_values ||= available_custom_fields.collect do |field|
Chris@1494:             x = CustomFieldValue.new
Chris@1494:             x.custom_field = field
Chris@1494:             x.customized = self
Chris@1494:             if field.multiple?
Chris@1494:               values = custom_values.select { |v| v.custom_field == field }
Chris@1494:               if values.empty?
Chris@1494:                 values << custom_values.build(:customized => self, :custom_field => field, :value => nil)
Chris@1494:               end
Chris@1494:               x.value = values.map(&:value)
Chris@1494:             else
Chris@1494:               cv = custom_values.detect { |v| v.custom_field == field }
Chris@1494:               cv ||= custom_values.build(:customized => self, :custom_field => field, :value => nil)
Chris@1494:               x.value = cv.value
Chris@1494:             end
Chris@1494:             x
Chris@1494:           end
Chris@1494:         end
Chris@1494: 
Chris@1494:         def visible_custom_field_values
Chris@1494:           custom_field_values.select(&:visible?)
Chris@1494:         end
Chris@1494: 
Chris@1494:         def custom_field_values_changed?
Chris@1494:           @custom_field_values_changed == true
Chris@1494:         end
Chris@1494: 
Chris@1494:         def custom_value_for(c)
Chris@1494:           field_id = (c.is_a?(CustomField) ? c.id : c.to_i)
Chris@1494:           custom_values.detect {|v| v.custom_field_id == field_id }
Chris@1494:         end
Chris@1494: 
Chris@1494:         def custom_field_value(c)
Chris@1494:           field_id = (c.is_a?(CustomField) ? c.id : c.to_i)
Chris@1494:           custom_field_values.detect {|v| v.custom_field_id == field_id }.try(:value)
Chris@1494:         end
Chris@1494: 
Chris@1494:         def validate_custom_field_values
Chris@1494:           if new_record? || custom_field_values_changed?
Chris@1494:             custom_field_values.each(&:validate_value)
Chris@1494:           end
Chris@1494:         end
Chris@1494: 
Chris@1494:         def save_custom_field_values
Chris@1494:           target_custom_values = []
Chris@1494:           custom_field_values.each do |custom_field_value|
Chris@1494:             if custom_field_value.value.is_a?(Array)
Chris@1494:               custom_field_value.value.each do |v|
Chris@1494:                 target = custom_values.detect {|cv| cv.custom_field == custom_field_value.custom_field && cv.value == v}
Chris@1494:                 target ||= custom_values.build(:customized => self, :custom_field => custom_field_value.custom_field, :value => v)
Chris@1494:                 target_custom_values << target
Chris@1494:               end
Chris@1494:             else
Chris@1494:               target = custom_values.detect {|cv| cv.custom_field == custom_field_value.custom_field}
Chris@1494:               target ||= custom_values.build(:customized => self, :custom_field => custom_field_value.custom_field)
Chris@1494:               target.value = custom_field_value.value
Chris@1494:               target_custom_values << target
Chris@1494:             end
Chris@1494:           end
Chris@1494:           self.custom_values = target_custom_values
Chris@1494:           custom_values.each(&:save)
Chris@1494:           @custom_field_values_changed = false
Chris@1494:           true
Chris@1494:         end
Chris@1494: 
Chris@1494:         def reset_custom_values!
Chris@1494:           @custom_field_values = nil
Chris@1494:           @custom_field_values_changed = true
Chris@1494:         end
Chris@1494: 
Chris@1494:         def reload_with_custom_fields(*args)
Chris@1494:           @custom_field_values = nil
Chris@1494:           @custom_field_values_changed = false
Chris@1494:           reload_without_custom_fields(*args)
Chris@1494:         end
Chris@1494: 
Chris@1494:         module ClassMethods
Chris@1494:         end
Chris@1494:       end
Chris@1494:     end
Chris@1494:   end
Chris@1494: end