Class: Redmine::FieldFormat::Base

Inherits:
Object
  • Object
show all
Includes:
ERB::Util, Helpers::URL, I18n, Singleton
Defined in:
lib/redmine/field_format.rb

Direct Known Subclasses

AttachmentFormat, List, Unbounded

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helpers::URL

#uri_with_link_safe_scheme?, #uri_with_safe_scheme?

Methods included from I18n

#abbr_day_name, #current_language, #day_letter, #day_name, #find_language, #format_date, #format_hours, #format_time, included, #l, #l_hours, #l_hours_short, #l_or_humanize, #languages_options, #ll, #lu, #month_name, #normalize_float, #set_language_if_valid, #valid_languages

Class Method Details

.field_attributes(*args) ⇒ Object 



113
114
115
 
# File 'lib/redmine/field_format.rb', line 113

def self.field_attributes(*args)
  CustomField.store_accessor :format_store, *args
end

Instance Method Details

#after_save_custom_value(custom_field, custom_value) ⇒ Object

CustomValue after_save callback



242
243
 
# File 'lib/redmine/field_format.rb', line 242

def after_save_custom_value(custom_field, custom_value)
end

#before_custom_field_save(custom_field) ⇒ Object 



339
340
 
# File 'lib/redmine/field_format.rb', line 339

def before_custom_field_save(custom_field)
end

#bulk_edit_tag(view, tag_id, tag_name, custom_field, objects, value, options = {}) ⇒ Object 



314
315
316
317
 
# File 'lib/redmine/field_format.rb', line 314

def bulk_edit_tag(view, tag_id, tag_name, custom_field, objects, value, options={})
  view.text_field_tag(tag_name, value, options.merge(:id => tag_id)) +
    bulk_clear_tag(view, tag_id, tag_name, custom_field, value)
end

#cast_custom_value(custom_value) ⇒ Object 



140
141
142
 
# File 'lib/redmine/field_format.rb', line 140

def cast_custom_value(custom_value)
  cast_value(custom_value.custom_field, custom_value.value, custom_value.customized)
end

#cast_single_value(custom_field, value, customized = nil) ⇒ Object 



157
158
159
 
# File 'lib/redmine/field_format.rb', line 157

def cast_single_value(custom_field, value, customized=nil)
  value.to_s
end

#cast_value(custom_field, value, customized = nil) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/redmine/field_format.rb', line 144

def cast_value(custom_field, value, customized=nil)
  if value.blank?
    nil
  elsif value.is_a?(Array)
    casted = value.map do |v|
      cast_single_value(custom_field, v, customized)
    end
    casted.compact.sort
  else
    cast_single_value(custom_field, value, customized)
  end
end

#edit_tag(view, tag_id, tag_name, custom_value, options = {}) ⇒ Object 



310
311
312
 
# File 'lib/redmine/field_format.rb', line 310

def edit_tag(view, tag_id, tag_name, custom_value, options={})
  view.text_field_tag(tag_name, custom_value.value, options.merge(:id => tag_id))
end

#formatted_custom_value(view, custom_value, html = false) ⇒ Object 



245
246
247
 
# File 'lib/redmine/field_format.rb', line 245

def formatted_custom_value(view, custom_value, html=false)
  formatted_value(view, custom_value.custom_field, custom_value.value, custom_value.customized, html)
end

#formatted_value(view, custom_field, value, customized = nil, html = false) ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/redmine/field_format.rb', line 249

def formatted_value(view, custom_field, value, customized=nil, html=false)
  casted = cast_value(custom_field, value, customized)
  if html && custom_field.url_pattern.present?
    texts_and_urls = Array.wrap(casted).map do |single_value|
      text = view.format_object(single_value, html: false).to_s
      url = url_from_pattern(custom_field, single_value, customized)
      [text, url]
    end
    links = texts_and_urls.sort_by(&:first).map do |text, url|
      view.link_to text, url
    end
    sanitize_html links.join(', ')
  else
    casted
  end
end

#group_statement(custom_field) ⇒ 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.



352
353
354
 
# File 'lib/redmine/field_format.rb', line 352

def group_statement(custom_field)
  nil
end

#join_for_order_statement(custom_field) ⇒ Object

Returns a JOIN clause that is added to the query when sorting by custom values



357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/redmine/field_format.rb', line 357

def join_for_order_statement(custom_field)
  alias_name = join_alias(custom_field)

  "LEFT OUTER JOIN #{CustomValue.table_name} #{alias_name}" +
    " ON #{alias_name}.customized_type = '#{custom_field.class.customized_class.base_class.name}'" +
    " AND #{alias_name}.customized_id = #{custom_field.class.customized_class.table_name}.id" +
    " AND #{alias_name}.custom_field_id = #{custom_field.id}" +
    " AND (#{custom_field.visibility_by_project_condition})" +
    " AND #{alias_name}.value <> ''" +
    " AND #{alias_name}.id = (SELECT max(#{alias_name}_2.id) FROM #{CustomValue.table_name} #{alias_name}_2" +
      " WHERE #{alias_name}_2.customized_type = #{alias_name}.customized_type" +
      " AND #{alias_name}_2.customized_id = #{alias_name}.customized_id" +
      " AND #{alias_name}_2.custom_field_id = #{alias_name}.custom_field_id)"
end

#label ⇒ Object 



123
124
125
 
# File 'lib/redmine/field_format.rb', line 123

def label
  "label_#{name}"
end

#name ⇒ Object 



119
120
121
 
# File 'lib/redmine/field_format.rb', line 119

def name
  self.class.format_name
end

#order_statement(custom_field) ⇒ 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.



345
346
347
348
 
# File 'lib/redmine/field_format.rb', line 345

def order_statement(custom_field)
  # COALESCE is here to make sure that blank and NULL values are sorted equally
  Arel.sql "COALESCE(#{join_alias custom_field}.value, '')"
end

#possible_custom_value_options(custom_value) ⇒ Object 



165
166
167
 
# File 'lib/redmine/field_format.rb', line 165

def possible_custom_value_options(custom_value)
  possible_values_options(custom_value.custom_field, custom_value.customized)
end

#possible_values_options(custom_field, object = nil) ⇒ Object 



169
170
171
 
# File 'lib/redmine/field_format.rb', line 169

def possible_values_options(custom_field, object=nil)
  []
end

#query_filter_options(custom_field, query) ⇒ Object 



335
336
337
 
# File 'lib/redmine/field_format.rb', line 335

def query_filter_options(custom_field, query)
  {:type => :string}
end

#sanitize_html(html) ⇒ Object 



266
267
268
 
# File 'lib/redmine/field_format.rb', line 266

def sanitize_html(html)
  Redmine::WikiFormatting::HtmlSanitizer.call(html).html_safe
end

#set_custom_field_value(custom_field, custom_field_value, value) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/redmine/field_format.rb', line 127

def set_custom_field_value(custom_field, custom_field_value, value)
  if value.is_a?(Array)
    value = value.map(&:to_s).reject{|v| v==''}.uniq
    if value.empty?
      value << ''
    end
  else
    value = value.to_s
  end

  value
end

#target_class ⇒ Object 



161
162
163
 
# File 'lib/redmine/field_format.rb', line 161

def target_class
  nil
end

#validate_custom_field(custom_field) ⇒ Object

Returns the validation errors for custom_field Should return an empty array if custom_field is valid



217
218
219
220
221
222
223
224
 
# File 'lib/redmine/field_format.rb', line 217

def validate_custom_field(custom_field)
  errors = []
  pattern = custom_field.url_pattern
  if pattern.present? && !uri_with_safe_scheme?(url_pattern_without_tokens(pattern))
    errors << [:url_pattern, :invalid]
  end
  errors
end

#validate_custom_value(custom_value) ⇒ Object

Returns the validation error messages for custom_value Should return an empty array if custom_value is valid custom_value is a CustomFieldValue.



229
230
231
232
233
234
235
 
# File 'lib/redmine/field_format.rb', line 229

def validate_custom_value(custom_value)
  values = Array.wrap(custom_value.value).reject {|value| value.to_s == ''}
  errors = values.map do |value|
    validate_single_value(custom_value.custom_field, value, custom_value.customized)
  end
  errors.flatten.uniq
end

#validate_single_value(custom_field, value, customized = nil) ⇒ Object 



237
238
239
 
# File 'lib/redmine/field_format.rb', line 237

def validate_single_value(custom_field, value, customized=nil)
  []
end

#value_from_keyword(custom_field, keyword, object) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/redmine/field_format.rb', line 173

def value_from_keyword(custom_field, keyword, object)
  possible_values_options = possible_values_options(custom_field, object)
  if possible_values_options.present?
    parse_keyword(custom_field, keyword) do |k|
      if v = possible_values_options.detect {|text, id| k.casecmp(text) == 0}
        if v.is_a?(Array)
          v.last
        else
          v
        end
      end
    end
  else
    keyword
  end
end