Chris@1494: # encoding: utf-8
Chris@1494: #
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 CustomFieldsHelper
Chris@1494: 
Chris@1494:   CUSTOM_FIELDS_TABS = [
Chris@1494:     {:name => 'IssueCustomField', :partial => 'custom_fields/index',
Chris@1494:      :label => :label_issue_plural},
Chris@1494:     {:name => 'TimeEntryCustomField', :partial => 'custom_fields/index',
Chris@1494:      :label => :label_spent_time},
Chris@1494:     {:name => 'ProjectCustomField', :partial => 'custom_fields/index',
Chris@1494:      :label => :label_project_plural},
Chris@1494:     {:name => 'VersionCustomField', :partial => 'custom_fields/index',
Chris@1494:      :label => :label_version_plural},
Chris@1494:     {:name => 'UserCustomField', :partial => 'custom_fields/index',
Chris@1494:      :label => :label_user_plural},
Chris@1494:     {:name => 'GroupCustomField', :partial => 'custom_fields/index',
Chris@1494:      :label => :label_group_plural},
Chris@1494:     {:name => 'TimeEntryActivityCustomField', :partial => 'custom_fields/index',
Chris@1494:      :label => TimeEntryActivity::OptionName},
Chris@1494:     {:name => 'IssuePriorityCustomField', :partial => 'custom_fields/index',
Chris@1494:      :label => IssuePriority::OptionName},
Chris@1494:     {:name => 'DocumentCategoryCustomField', :partial => 'custom_fields/index',
Chris@1494:      :label => DocumentCategory::OptionName}
Chris@1494:   ]
Chris@1494: 
Chris@1494:   def custom_fields_tabs
Chris@1494:     CUSTOM_FIELDS_TABS
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Return custom field html tag corresponding to its format
Chris@1494:   def custom_field_tag(name, custom_value)
Chris@1494:     custom_field = custom_value.custom_field
Chris@1494:     field_name = "#{name}[custom_field_values][#{custom_field.id}]"
Chris@1494:     field_name << "[]" if custom_field.multiple?
Chris@1494:     field_id = "#{name}_custom_field_values_#{custom_field.id}"
Chris@1494: 
Chris@1494:     tag_options = {:id => field_id, :class => "#{custom_field.field_format}_cf"}
Chris@1494: 
Chris@1494:     field_format = Redmine::CustomFieldFormat.find_by_name(custom_field.field_format)
Chris@1494:     case field_format.try(:edit_as)
Chris@1494:     when "date"
Chris@1494:       text_field_tag(field_name, custom_value.value, tag_options.merge(:size => 10)) +
Chris@1494:       calendar_for(field_id)
Chris@1494:     when "text"
Chris@1494:       text_area_tag(field_name, custom_value.value, tag_options.merge(:rows => 3))
Chris@1494:     when "bool"
Chris@1494:       hidden_field_tag(field_name, '0') + check_box_tag(field_name, '1', custom_value.true?, tag_options)
Chris@1494:     when "list"
Chris@1494:       blank_option = ''.html_safe
Chris@1494:       unless custom_field.multiple?
Chris@1494:         if custom_field.is_required?
Chris@1494:           unless custom_field.default_value.present?
Chris@1494:             blank_option = content_tag('option', "--- #{l(:actionview_instancetag_blank_option)} ---", :value => '')
Chris@1494:           end
Chris@1494:         else
Chris@1494:           blank_option = content_tag('option')
Chris@1494:         end
Chris@1494:       end
Chris@1494:       s = select_tag(field_name, blank_option + options_for_select(custom_field.possible_values_options(custom_value.customized), custom_value.value),
Chris@1494:         tag_options.merge(:multiple => custom_field.multiple?))
Chris@1494:       if custom_field.multiple?
Chris@1494:         s << hidden_field_tag(field_name, '')
Chris@1494:       end
Chris@1494:       s
Chris@1494:     else
Chris@1494:       text_field_tag(field_name, custom_value.value, tag_options)
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Return custom field label tag
Chris@1494:   def custom_field_label_tag(name, custom_value, options={})
Chris@1494:     required = options[:required] || custom_value.custom_field.is_required?
Chris@1494: 
Chris@1494:     content_tag "label", h(custom_value.custom_field.name) +
Chris@1494:       (required ? " <span class=\"required\">*</span>".html_safe : ""),
Chris@1494:       :for => "#{name}_custom_field_values_#{custom_value.custom_field.id}"
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Return custom field tag with its label tag
Chris@1494:   def custom_field_tag_with_label(name, custom_value, options={})
Chris@1494:     custom_field_label_tag(name, custom_value, options) + custom_field_tag(name, custom_value)
Chris@1494:   end
Chris@1494: 
Chris@1494:   def custom_field_tag_for_bulk_edit(name, custom_field, projects=nil, value='')
Chris@1494:     field_name = "#{name}[custom_field_values][#{custom_field.id}]"
Chris@1494:     field_name << "[]" if custom_field.multiple?
Chris@1494:     field_id = "#{name}_custom_field_values_#{custom_field.id}"
Chris@1494: 
Chris@1494:     tag_options = {:id => field_id, :class => "#{custom_field.field_format}_cf"}
Chris@1494: 
Chris@1494:     unset_tag = ''
Chris@1494:     unless custom_field.is_required?
Chris@1494:       unset_tag = content_tag('label',
Chris@1494:         check_box_tag(field_name, '__none__', (value == '__none__'), :id => nil, :data => {:disables => "##{field_id}"}) + l(:button_clear),
Chris@1494:         :class => 'inline'
Chris@1494:       )
Chris@1494:     end
Chris@1494: 
Chris@1494:     field_format = Redmine::CustomFieldFormat.find_by_name(custom_field.field_format)
Chris@1494:     case field_format.try(:edit_as)
Chris@1494:       when "date"
Chris@1494:         text_field_tag(field_name, value, tag_options.merge(:size => 10)) +
Chris@1494:         calendar_for(field_id) +
Chris@1494:         unset_tag
Chris@1494:       when "text"
Chris@1494:         text_area_tag(field_name, value, tag_options.merge(:rows => 3)) +
Chris@1494:         '<br />'.html_safe +
Chris@1494:         unset_tag
Chris@1494:       when "bool"
Chris@1494:         select_tag(field_name, options_for_select([[l(:label_no_change_option), ''],
Chris@1494:                                                    [l(:general_text_yes), '1'],
Chris@1494:                                                    [l(:general_text_no), '0']], value), tag_options)
Chris@1494:       when "list"
Chris@1494:         options = []
Chris@1494:         options << [l(:label_no_change_option), ''] unless custom_field.multiple?
Chris@1494:         options << [l(:label_none), '__none__'] unless custom_field.is_required?
Chris@1494:         options += custom_field.possible_values_options(projects)
Chris@1494:         select_tag(field_name, options_for_select(options, value), tag_options.merge(:multiple => custom_field.multiple?))
Chris@1494:       else
Chris@1494:         text_field_tag(field_name, value, tag_options) +
Chris@1494:         unset_tag
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Return a string used to display a custom value
Chris@1494:   def show_value(custom_value)
Chris@1494:     return "" unless custom_value
Chris@1494:     format_value(custom_value.value, custom_value.custom_field.field_format)
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Return a string used to display a custom value
Chris@1494:   def format_value(value, field_format)
Chris@1494:     if value.is_a?(Array)
Chris@1494:       value.collect {|v| format_value(v, field_format)}.compact.sort.join(', ')
Chris@1494:     else
Chris@1494:       Redmine::CustomFieldFormat.format_value(value, field_format)
Chris@1494:     end
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Return an array of custom field formats which can be used in select_tag
Chris@1494:   def custom_field_formats_for_select(custom_field)
Chris@1494:     Redmine::CustomFieldFormat.as_select(custom_field.class.customized_class.name)
Chris@1494:   end
Chris@1494: 
Chris@1494:   # Renders the custom_values in api views
Chris@1494:   def render_api_custom_values(custom_values, api)
Chris@1494:     api.array :custom_fields do
Chris@1494:       custom_values.each do |custom_value|
Chris@1494:         attrs = {:id => custom_value.custom_field_id, :name => custom_value.custom_field.name}
Chris@1494:         attrs.merge!(:multiple => true) if custom_value.custom_field.multiple?
Chris@1494:         api.custom_field attrs do
Chris@1494:           if custom_value.value.is_a?(Array)
Chris@1494:             api.array :value do
Chris@1494:               custom_value.value.each do |value|
Chris@1494:                 api.value value unless value.blank?
Chris@1494:               end
Chris@1494:             end
Chris@1494:           else
Chris@1494:             api.value custom_value.value
Chris@1494:           end
Chris@1494:         end
Chris@1494:       end
Chris@1494:     end unless custom_values.empty?
Chris@1494:   end
Chris@1494: end