SoundSoftware Code Site

# Redmine - project management software

# Copyright (C) 2006-2011  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.

module CustomFieldsHelper

  def custom_fields_tabs

    tabs = [{:name => 'IssueCustomField', :partial => 'custom_fields/index', :label => :label_issue_plural},

            {:name => 'TimeEntryCustomField', :partial => 'custom_fields/index', :label => :label_spent_time},

            {:name => 'ProjectCustomField', :partial => 'custom_fields/index', :label => :label_project_plural},

            {:name => 'VersionCustomField', :partial => 'custom_fields/index', :label => :label_version_plural},

            {:name => 'UserCustomField', :partial => 'custom_fields/index', :label => :label_user_plural},

            {:name => 'GroupCustomField', :partial => 'custom_fields/index', :label => :label_group_plural},

            {:name => 'TimeEntryActivityCustomField', :partial => 'custom_fields/index', :label => TimeEntryActivity::OptionName},

            {:name => 'IssuePriorityCustomField', :partial => 'custom_fields/index', :label => IssuePriority::OptionName},

            {:name => 'DocumentCategoryCustomField', :partial => 'custom_fields/index', :label => DocumentCategory::OptionName}

            ]

  end

  # Return custom field html tag corresponding to its format

  def custom_field_tag(name, custom_value)

    custom_field = custom_value.custom_field

    field_name = "#{name}[custom_field_values][#{custom_field.id}]"

    field_id = "#{name}_custom_field_values_#{custom_field.id}"

    field_format = Redmine::CustomFieldFormat.find_by_name(custom_field.field_format)

    case field_format.try(:edit_as)

    when "date"

      text_field_tag(field_name, custom_value.value, :id => field_id, :size => 10) +

      calendar_for(field_id)

    when "text"

      text_area_tag(field_name, custom_value.value, :id => field_id, :rows => 3, :style => 'width:90%')

    when "bool"

      hidden_field_tag(field_name, '0') + check_box_tag(field_name, '1', custom_value.true?, :id => field_id)

    when "list"

      blank_option = custom_field.is_required? ?

                       (custom_field.default_value.blank? ? "<option value=\"\">--- #{l(:actionview_instancetag_blank_option)} ---</option>" : '') :

                       '<option></option>'

      select_tag(field_name, blank_option + options_for_select(custom_field.possible_values_options(custom_value.customized), custom_value.value), :id => field_id)

    else

      text_field_tag(field_name, custom_value.value, :id => field_id)

    end

  end

  # Return custom field label tag

  def custom_field_label_tag(name, custom_value)

    content_tag "label", custom_value.custom_field.name +

        (custom_value.custom_field.is_required? ? " <span class=\"required\">*</span>" : ""),

        :for => "#{name}_custom_field_values_#{custom_value.custom_field.id}",

        :class => (custom_value.errors.empty? ? nil : "error" )

  end

  # Return custom field tag with its label tag

  def custom_field_tag_with_label(name, custom_value)

    custom_field_label_tag(name, custom_value) + custom_field_tag(name, custom_value)

  end

  def custom_field_tag_for_bulk_edit(name, custom_field, projects=nil)

    field_name = "#{name}[custom_field_values][#{custom_field.id}]"

    field_id = "#{name}_custom_field_values_#{custom_field.id}"

    field_format = Redmine::CustomFieldFormat.find_by_name(custom_field.field_format)

    case field_format.try(:edit_as)

      when "date"

        text_field_tag(field_name, '', :id => field_id, :size => 10) +

        calendar_for(field_id)

      when "text"

        text_area_tag(field_name, '', :id => field_id, :rows => 3, :style => 'width:90%')

      when "bool"

        select_tag(field_name, options_for_select([[l(:label_no_change_option), ''],

                                                   [l(:general_text_yes), '1'],

                                                   [l(:general_text_no), '0']]), :id => field_id)

      when "list"

        select_tag(field_name, options_for_select([[l(:label_no_change_option), '']] + custom_field.possible_values_options(projects)), :id => field_id)

      else

        text_field_tag(field_name, '', :id => field_id)

    end

  end

  # Return a string used to display a custom value

  def show_value(custom_value)

    return "" unless custom_value

    format_value(custom_value.value, custom_value.custom_field.field_format)

  end

  # Return a string used to display a custom value

  def format_value(value, field_format)

    Redmine::CustomFieldFormat.format_value(value, field_format) # Proxy

  end

  # Return an array of custom field formats which can be used in select_tag

  def custom_field_formats_for_select(custom_field)

    Redmine::CustomFieldFormat.as_select(custom_field.class.customized_class.name)

  end

  # Renders the custom_values in api views

  def render_api_custom_values(custom_values, api)

    api.array :custom_fields do

      custom_values.each do |custom_value|

        api.custom_field :id => custom_value.custom_field_id, :name => custom_value.custom_field.name do

          api.value custom_value.value

        end

      end

    end unless custom_values.empty?

  end

end