Class: CustomField

Inherits:
ApplicationRecord show all
Includes:
Redmine::SafeAttributes, Redmine::SubclassFactory
Defined in:
app/models/custom_field.rb

Overview

Redmine - project management software Copyright © 2006- Jean-Philippe Lang

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Redmine::SubclassFactory

included

Methods included from Redmine::SafeAttributes

#delete_unsafe_attributes, included, #safe_attribute?, #safe_attribute_names, #safe_attributes=

Class Method Details

.customized_class ⇒ Object 



283
284
285
286
 
# File 'app/models/custom_field.rb', line 283

def self.customized_class
  self.name =~ /^(.+)CustomField$/
  $1.constantize rescue nil
end

.for_all ⇒ Object

to move in project_custom_field



289
290
291
 
# File 'app/models/custom_field.rb', line 289

def self.for_all
  where(:is_for_all => true).order(:position).to_a
end

.human_attribute_name(attribute_key_name) ⇒ Object 



339
340
341
342
343
344
345
 
# File 'app/models/custom_field.rb', line 339

def self.human_attribute_name(attribute_key_name, *)
  attr_name = attribute_key_name.to_s
  if attr_name == 'url_pattern'
    attr_name = "url"
  end
  super(attr_name, *)
end

Instance Method Details

#<=>(field) ⇒ Object 



272
273
274
275
276
 
# File 'app/models/custom_field.rb', line 272

def <=>(field)
  return nil unless field.is_a?(CustomField)

  position <=> field.position
end

#after_save_custom_value(custom_value) ⇒ Object 



331
332
333
 
# File 'app/models/custom_field.rb', line 331

def after_save_custom_value(custom_value)
  format.after_save_custom_value(self, custom_value)
end

#cast_value(value) ⇒ Object 



206
207
208
 
# File 'app/models/custom_field.rb', line 206

def cast_value(value)
  format.cast_value(self, value)
end

#copy_from(arg, options = {}) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'app/models/custom_field.rb', line 108

def copy_from(arg, options={})
  return if arg.blank?

  custom_field = arg.is_a?(CustomField) ? arg : CustomField.find_by(id: arg.to_s)
  self.attributes = custom_field.attributes.dup.except('id', 'name', 'position')
  custom_field.enumerations.each do |e|
    new_enumeration = self.enumerations.build
    new_enumeration.attributes = e.attributes.except('id')
  end
  self.default_value = nil if custom_field.enumerations.any?
  if %w(IssueCustomField TimeEntryCustomField ProjectCustomField VersionCustomField).include?(self.class.name)
    self.role_ids = custom_field.role_ids.dup
  end
  if self.is_a?(IssueCustomField)
    self.tracker_ids = custom_field.tracker_ids.dup
    self.project_ids = custom_field.project_ids.dup
  end
  self
end

#css_classes ⇒ Object 



347
348
349
 
# File 'app/models/custom_field.rb', line 347

def css_classes
  "#{field_format}_cf cf_#{id}"
end

#field_format=(arg) ⇒ Object 



132
133
134
135
136
137
138
 
# File 'app/models/custom_field.rb', line 132

def field_format=(arg)
  # cannot change format of a saved custom field
  if new_record?
    @format = nil
    super
  end
end

#format ⇒ Object 



128
129
130
 
# File 'app/models/custom_field.rb', line 128

def format
  @format ||= Redmine::FieldFormat.find(field_format)
end

#format_in?(*args) ⇒ Boolean

Returns:

  • (Boolean) 


335
336
337
 
# File 'app/models/custom_field.rb', line 335

def format_in?(*args)
  args.include?(field_format)
end

#full_text_formatting? ⇒ Boolean

Returns:

  • (Boolean) 


227
228
229
 
# File 'app/models/custom_field.rb', line 227

def full_text_formatting?
  text_formatting == 'full'
end

#full_width_layout? ⇒ Boolean

Returns:

  • (Boolean) 


223
224
225
 
# File 'app/models/custom_field.rb', line 223

def full_width_layout?
  full_width_layout == '1'
end

#group_statement ⇒ Object

Returns a GROUP BY clause that can used to group by custom value Returns nil if the custom field can not be used for grouping.



246
247
248
249
250
 
# File 'app/models/custom_field.rb', line 246

def group_statement
  return nil if multiple?

  format.group_statement(self)
end

#join_for_order_statement ⇒ Object 



252
253
254
 
# File 'app/models/custom_field.rb', line 252

def join_for_order_statement
  format.join_for_order_statement(self)
end

#order_statement ⇒ Object

Returns a ORDER BY clause that can used to sort customized objects by their value of the custom field. Returns nil if the custom field can not be used for sorting.



238
239
240
241
242
 
# File 'app/models/custom_field.rb', line 238

def order_statement
  return nil if multiple?

  format.order_statement(self)
end

#possible_custom_value_options(custom_value) ⇒ Object 



168
169
170
 
# File 'app/models/custom_field.rb', line 168

def possible_custom_value_options(custom_value)
  format.possible_custom_value_options(custom_value)
end

#possible_values ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
 
# File 'app/models/custom_field.rb', line 180

def possible_values
  values = read_attribute(:possible_values)
  if values.is_a?(Array)
    values.each do |value|
      value.to_s.force_encoding('UTF-8')
    end
    values
  else
    []
  end
end

#possible_values=(arg) ⇒ Object

Makes possible_values accept a multiline string



193
194
195
196
197
198
199
200
 
# File 'app/models/custom_field.rb', line 193

def possible_values=(arg)
  if arg.is_a?(Array)
    values = arg.compact.map {|a| a.to_s.strip}.reject(&:blank?)
    write_attribute(:possible_values, values)
  else
    self.possible_values = arg.to_s.split(/[\n\r]+/)
  end
end

#possible_values_options(object = nil) ⇒ Object 



172
173
174
175
176
177
178
 
# File 'app/models/custom_field.rb', line 172

def possible_values_options(object=nil)
  if object.is_a?(Array)
    object.map {|o| format.possible_values_options(self, o)}.reduce(:&) || []
  else
    format.possible_values_options(self, object) || []
  end
end

#query_filter_options(query) ⇒ Object

Returns the options hash used to build a query filter for the field



215
216
217
 
# File 'app/models/custom_field.rb', line 215

def query_filter_options(query)
  format.query_filter_options(self, query)
end

#set_custom_field_value(custom_field_value, value) ⇒ Object 



202
203
204
 
# File 'app/models/custom_field.rb', line 202

def set_custom_field_value(custom_field_value, value)
  format.set_custom_field_value(self, custom_field_value, value)
end

#set_searchable ⇒ Object 



140
141
142
143
144
145
146
 
# File 'app/models/custom_field.rb', line 140

def set_searchable
  # make sure these fields are not searchable
  self.searchable = false unless format.class.searchable_supported
  # make sure only these fields can have multiple values
  self.multiple = false unless format.class.multiple_supported
  true
end

#thousands_delimiter? ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
 
# File 'app/models/custom_field.rb', line 231

def thousands_delimiter?
  thousands_delimiter == '1'
end

#totalable? ⇒ Boolean

Returns:

  • (Boolean) 


219
220
221
 
# File 'app/models/custom_field.rb', line 219

def totalable?
  format.totalable_supported
end

#type_name ⇒ Object 



293
294
295
 
# File 'app/models/custom_field.rb', line 293

def type_name
  nil
end

#valid_field_value?(value) ⇒ Boolean

Returns true if value is a valid value for the custom field

Returns:

  • (Boolean) 


327
328
329
 
# File 'app/models/custom_field.rb', line 327

def valid_field_value?(value)
  validate_field_value(value).empty?
end

#validate_custom_field ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'app/models/custom_field.rb', line 148

def validate_custom_field
  format.validate_custom_field(self).each do |attribute, message|
    errors.add attribute, message
  end

  if regexp.present?
    begin
      Regexp.new(regexp)
    rescue
      errors.add(:regexp, :invalid)
    end
  end

  if default_value.present?
    validate_field_value(default_value).each do |message|
      errors.add :default_value, message
    end
  end
end

#validate_custom_value(custom_value) ⇒ Object

Returns the error messages for the given value or an empty array if value is a valid value for the custom field



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'app/models/custom_field.rb', line 299

def validate_custom_value(custom_value)
  value = custom_value.value
  errs = format.validate_custom_value(custom_value)

  unless errs.any?
    if value.is_a?(Array)
      unless multiple?
        errs << ::I18n.t('activerecord.errors.messages.invalid')
      end
      if is_required? && value.detect(&:present?).nil?
        errs << ::I18n.t('activerecord.errors.messages.blank')
      end
    else
      if is_required? && value.blank?
        errs << ::I18n.t('activerecord.errors.messages.blank')
      end
    end
  end

  errs
end

#validate_field_value(value) ⇒ Object

Returns the error messages for the default custom field value



322
323
324
 
# File 'app/models/custom_field.rb', line 322

def validate_field_value(value)
  validate_custom_value(CustomFieldValue.new(:custom_field => self, :value => value))
end

#value_class ⇒ Object

Returns the class that values represent



279
280
281
 
# File 'app/models/custom_field.rb', line 279

def value_class
  format.target_class if format.respond_to?(:target_class)
end

#value_from_keyword(keyword, customized) ⇒ Object 



210
211
212
 
# File 'app/models/custom_field.rb', line 210

def value_from_keyword(keyword, customized)
  format.value_from_keyword(self, keyword, customized)
end

#visibility_by_project_condition(project_key = nil, user = User.current, id_column = nil) ⇒ Object 



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'app/models/custom_field.rb', line 256

def visibility_by_project_condition(project_key=nil, user=User.current, id_column=nil)
  if visible? || user.admin?
    "1=1"
  elsif user.anonymous?
    "1=0"
  else
    project_key ||= "#{self.class.customized_class.table_name}.project_id"
    id_column ||= id
    "#{project_key} IN (SELECT DISTINCT m.project_id FROM #{Member.table_name} m" \
      " INNER JOIN #{MemberRole.table_name} mr ON mr.member_id = m.id" \
      " INNER JOIN #{table_name_prefix}custom_fields_roles#{table_name_suffix} cfr" \
      " ON cfr.role_id = mr.role_id" \
      " WHERE m.user_id = #{user.id} AND cfr.custom_field_id = #{id_column})"
  end
end

#visible_by?(project, user = User.current) ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
 
# File 'app/models/custom_field.rb', line 75

def visible_by?(project, user=User.current)
  visible? || user.admin?
end