Chris@1517
|
1 # Redmine - project management software
|
Chris@1517
|
2 # Copyright (C) 2006-2014 Jean-Philippe Lang
|
Chris@1517
|
3 #
|
Chris@1517
|
4 # This program is free software; you can redistribute it and/or
|
Chris@1517
|
5 # modify it under the terms of the GNU General Public License
|
Chris@1517
|
6 # as published by the Free Software Foundation; either version 2
|
Chris@1517
|
7 # of the License, or (at your option) any later version.
|
Chris@1517
|
8 #
|
Chris@1517
|
9 # This program is distributed in the hope that it will be useful,
|
Chris@1517
|
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
|
Chris@1517
|
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
Chris@1517
|
12 # GNU General Public License for more details.
|
Chris@1517
|
13 #
|
Chris@1517
|
14 # You should have received a copy of the GNU General Public License
|
Chris@1517
|
15 # along with this program; if not, write to the Free Software
|
Chris@1517
|
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
Chris@1517
|
17
|
Chris@1517
|
18 module Redmine
|
Chris@1517
|
19 module Acts
|
Chris@1517
|
20 module Customizable
|
Chris@1517
|
21 def self.included(base)
|
Chris@1517
|
22 base.extend ClassMethods
|
Chris@1517
|
23 end
|
Chris@1517
|
24
|
Chris@1517
|
25 module ClassMethods
|
Chris@1517
|
26 def acts_as_customizable(options = {})
|
Chris@1517
|
27 return if self.included_modules.include?(Redmine::Acts::Customizable::InstanceMethods)
|
Chris@1517
|
28 cattr_accessor :customizable_options
|
Chris@1517
|
29 self.customizable_options = options
|
Chris@1517
|
30 has_many :custom_values, :as => :customized,
|
Chris@1517
|
31 :include => :custom_field,
|
Chris@1517
|
32 :order => "#{CustomField.table_name}.position",
|
Chris@1517
|
33 :dependent => :delete_all,
|
Chris@1517
|
34 :validate => false
|
Chris@1517
|
35
|
Chris@1517
|
36 send :include, Redmine::Acts::Customizable::InstanceMethods
|
Chris@1517
|
37 validate :validate_custom_field_values
|
Chris@1517
|
38 after_save :save_custom_field_values
|
Chris@1517
|
39 end
|
Chris@1517
|
40 end
|
Chris@1517
|
41
|
Chris@1517
|
42 module InstanceMethods
|
Chris@1517
|
43 def self.included(base)
|
Chris@1517
|
44 base.extend ClassMethods
|
Chris@1517
|
45 base.send :alias_method_chain, :reload, :custom_fields
|
Chris@1517
|
46 end
|
Chris@1517
|
47
|
Chris@1517
|
48 def available_custom_fields
|
Chris@1517
|
49 CustomField.where("type = '#{self.class.name}CustomField'").sorted.all
|
Chris@1517
|
50 end
|
Chris@1517
|
51
|
Chris@1517
|
52 # Sets the values of the object's custom fields
|
Chris@1517
|
53 # values is an array like [{'id' => 1, 'value' => 'foo'}, {'id' => 2, 'value' => 'bar'}]
|
Chris@1517
|
54 def custom_fields=(values)
|
Chris@1517
|
55 values_to_hash = values.inject({}) do |hash, v|
|
Chris@1517
|
56 v = v.stringify_keys
|
Chris@1517
|
57 if v['id'] && v.has_key?('value')
|
Chris@1517
|
58 hash[v['id']] = v['value']
|
Chris@1517
|
59 end
|
Chris@1517
|
60 hash
|
Chris@1517
|
61 end
|
Chris@1517
|
62 self.custom_field_values = values_to_hash
|
Chris@1517
|
63 end
|
Chris@1517
|
64
|
Chris@1517
|
65 # Sets the values of the object's custom fields
|
Chris@1517
|
66 # values is a hash like {'1' => 'foo', 2 => 'bar'}
|
Chris@1517
|
67 def custom_field_values=(values)
|
Chris@1517
|
68 values = values.stringify_keys
|
Chris@1517
|
69
|
Chris@1517
|
70 custom_field_values.each do |custom_field_value|
|
Chris@1517
|
71 key = custom_field_value.custom_field_id.to_s
|
Chris@1517
|
72 if values.has_key?(key)
|
Chris@1517
|
73 value = values[key]
|
Chris@1517
|
74 if value.is_a?(Array)
|
Chris@1517
|
75 value = value.reject(&:blank?).map(&:to_s).uniq
|
Chris@1517
|
76 if value.empty?
|
Chris@1517
|
77 value << ''
|
Chris@1517
|
78 end
|
Chris@1517
|
79 else
|
Chris@1517
|
80 value = value.to_s
|
Chris@1517
|
81 end
|
Chris@1517
|
82 custom_field_value.value = value
|
Chris@1517
|
83 end
|
Chris@1517
|
84 end
|
Chris@1517
|
85 @custom_field_values_changed = true
|
Chris@1517
|
86 end
|
Chris@1517
|
87
|
Chris@1517
|
88 def custom_field_values
|
Chris@1517
|
89 @custom_field_values ||= available_custom_fields.collect do |field|
|
Chris@1517
|
90 x = CustomFieldValue.new
|
Chris@1517
|
91 x.custom_field = field
|
Chris@1517
|
92 x.customized = self
|
Chris@1517
|
93 if field.multiple?
|
Chris@1517
|
94 values = custom_values.select { |v| v.custom_field == field }
|
Chris@1517
|
95 if values.empty?
|
Chris@1517
|
96 values << custom_values.build(:customized => self, :custom_field => field, :value => nil)
|
Chris@1517
|
97 end
|
Chris@1517
|
98 x.value = values.map(&:value)
|
Chris@1517
|
99 else
|
Chris@1517
|
100 cv = custom_values.detect { |v| v.custom_field == field }
|
Chris@1517
|
101 cv ||= custom_values.build(:customized => self, :custom_field => field, :value => nil)
|
Chris@1517
|
102 x.value = cv.value
|
Chris@1517
|
103 end
|
Chris@1517
|
104 x.value_was = x.value.dup if x.value
|
Chris@1517
|
105 x
|
Chris@1517
|
106 end
|
Chris@1517
|
107 end
|
Chris@1517
|
108
|
Chris@1517
|
109 def visible_custom_field_values
|
Chris@1517
|
110 custom_field_values.select(&:visible?)
|
Chris@1517
|
111 end
|
Chris@1517
|
112
|
Chris@1517
|
113 def custom_field_values_changed?
|
Chris@1517
|
114 @custom_field_values_changed == true
|
Chris@1517
|
115 end
|
Chris@1517
|
116
|
Chris@1517
|
117 def custom_value_for(c)
|
Chris@1517
|
118 field_id = (c.is_a?(CustomField) ? c.id : c.to_i)
|
Chris@1517
|
119 custom_values.detect {|v| v.custom_field_id == field_id }
|
Chris@1517
|
120 end
|
Chris@1517
|
121
|
Chris@1517
|
122 def custom_field_value(c)
|
Chris@1517
|
123 field_id = (c.is_a?(CustomField) ? c.id : c.to_i)
|
Chris@1517
|
124 custom_field_values.detect {|v| v.custom_field_id == field_id }.try(:value)
|
Chris@1517
|
125 end
|
Chris@1517
|
126
|
Chris@1517
|
127 def validate_custom_field_values
|
Chris@1517
|
128 if new_record? || custom_field_values_changed?
|
Chris@1517
|
129 custom_field_values.each(&:validate_value)
|
Chris@1517
|
130 end
|
Chris@1517
|
131 end
|
Chris@1517
|
132
|
Chris@1517
|
133 def save_custom_field_values
|
Chris@1517
|
134 target_custom_values = []
|
Chris@1517
|
135 custom_field_values.each do |custom_field_value|
|
Chris@1517
|
136 if custom_field_value.value.is_a?(Array)
|
Chris@1517
|
137 custom_field_value.value.each do |v|
|
Chris@1517
|
138 target = custom_values.detect {|cv| cv.custom_field == custom_field_value.custom_field && cv.value == v}
|
Chris@1517
|
139 target ||= custom_values.build(:customized => self, :custom_field => custom_field_value.custom_field, :value => v)
|
Chris@1517
|
140 target_custom_values << target
|
Chris@1517
|
141 end
|
Chris@1517
|
142 else
|
Chris@1517
|
143 target = custom_values.detect {|cv| cv.custom_field == custom_field_value.custom_field}
|
Chris@1517
|
144 target ||= custom_values.build(:customized => self, :custom_field => custom_field_value.custom_field)
|
Chris@1517
|
145 target.value = custom_field_value.value
|
Chris@1517
|
146 target_custom_values << target
|
Chris@1517
|
147 end
|
Chris@1517
|
148 end
|
Chris@1517
|
149 self.custom_values = target_custom_values
|
Chris@1517
|
150 custom_values.each(&:save)
|
Chris@1517
|
151 @custom_field_values_changed = false
|
Chris@1517
|
152 true
|
Chris@1517
|
153 end
|
Chris@1517
|
154
|
Chris@1517
|
155 def reset_custom_values!
|
Chris@1517
|
156 @custom_field_values = nil
|
Chris@1517
|
157 @custom_field_values_changed = true
|
Chris@1517
|
158 end
|
Chris@1517
|
159
|
Chris@1517
|
160 def reload_with_custom_fields(*args)
|
Chris@1517
|
161 @custom_field_values = nil
|
Chris@1517
|
162 @custom_field_values_changed = false
|
Chris@1517
|
163 reload_without_custom_fields(*args)
|
Chris@1517
|
164 end
|
Chris@1517
|
165
|
Chris@1517
|
166 module ClassMethods
|
Chris@1517
|
167 end
|
Chris@1517
|
168 end
|
Chris@1517
|
169 end
|
Chris@1517
|
170 end
|
Chris@1517
|
171 end
|