SoundSoftware Code Site

# Redmine - project management software

# Copyright (C) 2006-2012  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 Redmine

  class CustomFieldFormat

    include Redmine::I18n

    cattr_accessor :available

    @@available = {}

    attr_accessor :name, :order, :label, :edit_as, :class_names

    def initialize(name, options={})

      self.name = name

      self.label = options[:label] || "label_#{name}".to_sym

      self.order = options[:order] || self.class.available_formats.size

      self.edit_as = options[:edit_as] || name

      self.class_names = options[:only]

    end

    def format(value)

      send "format_as_#{name}", value

    end

    def format_as_date(value)

      begin; format_date(value.to_date); rescue; value end

    end

    def format_as_bool(value)

      l(value == "1" ? :general_text_Yes : :general_text_No)

    end

    ['string','text','int','float','list'].each do |name|

      define_method("format_as_#{name}") {|value|

        return value

      }

    end

    ['user', 'version'].each do |name|

      define_method("format_as_#{name}") {|value|

        return value.blank? ? "" : name.classify.constantize.find_by_id(value.to_i).to_s

      }

    end

    class << self

      def map(&block)

        yield self

      end

      # Registers a custom field format

      def register(*args)

        custom_field_format = args.first

        unless custom_field_format.is_a?(Redmine::CustomFieldFormat)

          custom_field_format = Redmine::CustomFieldFormat.new(*args)

        end

        @@available[custom_field_format.name] = custom_field_format unless @@available.keys.include?(custom_field_format.name)

      end

      def available_formats

        @@available.keys

      end

      def find_by_name(name)

        @@available[name.to_s]

      end

      def label_for(name)

        format = @@available[name.to_s]

        format.label if format

      end

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

      def as_select(class_name=nil)

        fields = @@available.values

        fields = fields.select {|field| field.class_names.nil? || field.class_names.include?(class_name)}

        fields.sort {|a,b|

          a.order <=> b.order

        }.collect {|custom_field_format|

          [ l(custom_field_format.label), custom_field_format.name ]

        }

      end

      def format_value(value, field_format)

        return "" unless value && !value.empty?

        if format_type = find_by_name(field_format)

          format_type.format(value)

        else

          value

        end

      end

    end

  end

end