jro_apps/redmine Commit - r8602:8d5f932660f9

Do not validate blank default custom field value....

Jean-Philippe Lang -

r8602:8d5f932660f9

parent child

Context file:

r8602:8d5f932660f9

Collapse all files

app/models/custom_field.rb +1 -1

             # 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.
             class CustomField < ActiveRecord::Base
               include Redmine::SubclassFactory
               has_many :custom_values, :dependent => :delete_all
               acts_as_list :scope => 'type = \'#{self.class}\''
               serialize :possible_values
               validates_presence_of :name, :field_format
               validates_uniqueness_of :name, :scope => :type
               validates_length_of :name, :maximum => 30
               validates_inclusion_of :field_format, :in => Redmine::CustomFieldFormat.available_formats
               validate :validate_custom_field
               before_validation :set_searchable
               def initialize(attributes=nil, *args)
                 super
                 self.possible_values ||= []
               end
               def set_searchable
                 # make sure these fields are not searchable
                 self.searchable = false if %w(int float date bool).include?(field_format)
                 # make sure only these fields can have multiple values
                 self.multiple = false unless %w(list user version).include?(field_format)
                 true
               end
               def validate_custom_field
                 if self.field_format == "list"
                   errors.add(:possible_values, :blank) if self.possible_values.nil? || self.possible_values.empty?
                   errors.add(:possible_values, :invalid) unless self.possible_values.is_a? Array
                 end
                 if regexp.present?
                   begin
                     Regexp.new(regexp)
                   rescue
                     errors.add(:regexp, :invalid)
                   end
                 end
-                unless valid_field_value?(default_value)
+                if default_value.present? && !valid_field_value?(default_value)
                   errors.add(:default_value, :invalid)
                 end
               end
               def possible_values_options(obj=nil)
                 case field_format
                 when 'user', 'version'
                   if obj.respond_to?(:project) && obj.project
                     case field_format
                     when 'user'
                       obj.project.users.sort.collect {|u| [u.to_s, u.id.to_s]}
                     when 'version'
                       obj.project.shared_versions.sort.collect {|u| [u.to_s, u.id.to_s]}
                     end
                   elsif obj.is_a?(Array)
                     obj.collect {|o| possible_values_options(o)}.inject {|memo, v| memo & v}
                   else
                     []
                   end
                 else
                   read_attribute :possible_values
                 end
               end
               def possible_values(obj=nil)
                 case field_format
                 when 'user', 'version'
                   possible_values_options(obj).collect(&:last)
                 else
                   read_attribute :possible_values
                 end
               end
               # Makes possible_values accept a multiline string
               def possible_values=(arg)
                 if arg.is_a?(Array)
                   write_attribute(:possible_values, arg.compact.collect(&:strip).select {|v| !v.blank?})
                 else
                   self.possible_values = arg.to_s.split(/[\n\r]+/)
                 end
               end
               def cast_value(value)
                 casted = nil
                 unless value.blank?
                   case field_format
                   when 'string', 'text', 'list'
                     casted = value
                   when 'date'
                     casted = begin; value.to_date; rescue; nil end
                   when 'bool'
                     casted = (value == '1' ? true : false)
                   when 'int'
                     casted = value.to_i
                   when 'float'
                     casted = value.to_f
                   when 'user', 'version'
                     casted = (value.blank? ? nil : field_format.classify.constantize.find_by_id(value.to_i))
                   end
                 end
                 casted
               end
               # Returns a ORDER BY clause that can used to sort customized
               # objects by their value of the custom field.
               # Returns false, if the custom field can not be used for sorting.
               def order_statement
                 return nil if multiple?
                 case field_format
                   when 'string', 'text', 'list', 'date', 'bool'
                     # COALESCE is here to make sure that blank and NULL values are sorted equally
                     "COALESCE((SELECT cv_sort.value FROM #{CustomValue.table_name} cv_sort" +
                       " WHERE cv_sort.customized_type='#{self.class.customized_class.name}'" +
                       " AND cv_sort.customized_id=#{self.class.customized_class.table_name}.id" +
                       " AND cv_sort.custom_field_id=#{id} LIMIT 1), '')"
                   when 'int', 'float'
                     # Make the database cast values into numeric
                     # Postgresql will raise an error if a value can not be casted!
                     # CustomValue validations should ensure that it doesn't occur
                     "(SELECT CAST(cv_sort.value AS decimal(60,3)) FROM #{CustomValue.table_name} cv_sort" +
                       " WHERE cv_sort.customized_type='#{self.class.customized_class.name}'" +
                       " AND cv_sort.customized_id=#{self.class.customized_class.table_name}.id" +
                       " AND cv_sort.custom_field_id=#{id} AND cv_sort.value <> '' AND cv_sort.value IS NOT NULL LIMIT 1)"
                   else
                     nil
                 end
               end
               def <=>(field)
                 position <=> field.position
               end
               def self.customized_class
                 self.name =~ /^(.+)CustomField$/
                 begin; $1.constantize; rescue nil; end
               end
               # to move in project_custom_field
               def self.for_all
                 find(:all, :conditions => ["is_for_all=?", true], :order => 'position')
               end
               def type_name
                 nil
               end
               # Returns the error messages for the given value
               # or an empty array if value is a valid value for the custom field
               def validate_field_value(value)
                 errs = []
                 if value.is_a?(Array)
                   if !multiple?
                     errs << ::I18n.t('activerecord.errors.messages.invalid')
                   end
                   if is_required? && value.detect(&:present?).nil?
                     errs << ::I18n.t('activerecord.errors.messages.blank')
                   end
                   value.each {|v| errs += validate_field_value_format(v)}
                 else
                   if is_required? && value.blank?
                     errs << ::I18n.t('activerecord.errors.messages.blank')
                   end
                   errs += validate_field_value_format(value)
                 end
                 errs
               end
               # Returns true if value is a valid value for the custom field
               def valid_field_value?(value)
                 validate_field_value(value).empty?
               end
               protected
               # Returns the error message for the given value regarding its format
               def validate_field_value_format(value)
                 errs = []
                 if value.present?
                   errs << ::I18n.t('activerecord.errors.messages.invalid') unless regexp.blank? or value =~ Regexp.new(regexp)
                   errs << ::I18n.t('activerecord.errors.messages.too_short', :count => min_length) if min_length > 0 and value.length < min_length
                   errs << ::I18n.t('activerecord.errors.messages.too_long', :count => max_length) if max_length > 0 and value.length > max_length
                   # Format specific validations
                   case field_format
                   when 'int'
                     errs << ::I18n.t('activerecord.errors.messages.not_a_number') unless value =~ /^[+-]?\d+$/
                   when 'float'
                     begin; Kernel.Float(value); rescue; errs << ::I18n.t('activerecord.errors.messages.invalid') end
                   when 'date'
                     errs << ::I18n.t('activerecord.errors.messages.not_a_date') unless value =~ /^\d{4}-\d{2}-\d{2}$/ && begin; value.to_date; rescue; false end
                   when 'list'
                     errs << ::I18n.t('activerecord.errors.messages.inclusion') unless possible_values.include?(value)
                   end
                 end
                 errs
               end
             end

test/unit/custom_field_test.rb +5 0

             # 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.
             require File.expand_path('../../test_helper', __FILE__)
             class CustomFieldTest < ActiveSupport::TestCase
               fixtures :custom_fields
               def test_create
                 field = UserCustomField.new(:name => 'Money money money', :field_format => 'float')
                 assert field.save
               end
               def test_before_validation
                 field = CustomField.new(:name => 'test_before_validation', :field_format => 'int')
                 field.searchable = true
                 assert field.save
                 assert_equal false, field.searchable
                 field.searchable = true
                 assert field.save
                 assert_equal false, field.searchable
               end
               def test_regexp_validation
                 field = IssueCustomField.new(:name => 'regexp', :field_format => 'text', :regexp => '[a-z0-9')
                 assert !field.save
                 assert_equal I18n.t('activerecord.errors.messages.invalid'),
                              field.errors[:regexp].to_s
                 field.regexp = '[a-z0-9]'
                 assert field.save
               end
               def test_default_value_should_be_validated
                 field = CustomField.new(:name => 'Test', :field_format => 'int')
                 field.default_value = 'abc'
                 assert !field.valid?
                 field.default_value = '6'
                 assert field.valid?
               end
+              def test_default_value_should_not_be_validated_when_blank
+                field = CustomField.new(:name => 'Test', :field_format => 'list', :possible_values => ['a', 'b'], :is_required => true, :default_value => '')
+                assert field.valid?
+              end
               def test_possible_values_should_accept_an_array
                 field = CustomField.new
                 field.possible_values = ["One value", ""]
                 assert_equal ["One value"], field.possible_values
               end
               def test_possible_values_should_accept_a_string
                 field = CustomField.new
                 field.possible_values = "One value"
                 assert_equal ["One value"], field.possible_values
               end
               def test_possible_values_should_accept_a_multiline_string
                 field = CustomField.new
                 field.possible_values = "One value\nAnd another one  \r\n \n"
                 assert_equal ["One value", "And another one"], field.possible_values
               end
               def test_destroy
                 field = CustomField.find(1)
                 assert field.destroy
               end
               def test_new_subclass_instance_should_return_an_instance
                 f = CustomField.new_subclass_instance('IssueCustomField')
                 assert_kind_of IssueCustomField, f
               end
               def test_new_subclass_instance_should_set_attributes
                 f = CustomField.new_subclass_instance('IssueCustomField', :name => 'Test')
                 assert_kind_of IssueCustomField, f
                 assert_equal 'Test', f.name
               end
               def test_new_subclass_instance_with_invalid_class_name_should_return_nil
                 assert_nil CustomField.new_subclass_instance('WrongClassName')
               end
               def test_new_subclass_instance_with_non_subclass_name_should_return_nil
                 assert_nil CustomField.new_subclass_instance('Project')
               end
               def test_string_field_validation_with_blank_value
                 f = CustomField.new(:field_format => 'string')
                 assert f.valid_field_value?(nil)
                 assert f.valid_field_value?('')
                 f.is_required = true
                 assert !f.valid_field_value?(nil)
                 assert !f.valid_field_value?('')
               end
               def test_string_field_validation_with_min_and_max_lengths
                 f = CustomField.new(:field_format => 'string', :min_length => 2, :max_length => 5)
                 assert f.valid_field_value?(nil)
                 assert f.valid_field_value?('')
                 assert f.valid_field_value?('a' * 2)
                 assert !f.valid_field_value?('a')
                 assert !f.valid_field_value?('a' * 6)
               end
               def test_string_field_validation_with_regexp
                 f = CustomField.new(:field_format => 'string', :regexp => '^[A-Z0-9]*$')
                 assert f.valid_field_value?(nil)
                 assert f.valid_field_value?('')
                 assert f.valid_field_value?('ABC')
                 assert !f.valid_field_value?('abc')
               end
               def test_date_field_validation
                 f = CustomField.new(:field_format => 'date')
                 assert f.valid_field_value?(nil)
                 assert f.valid_field_value?('')
                 assert f.valid_field_value?('1975-07-14')
                 assert !f.valid_field_value?('1975-07-33')
                 assert !f.valid_field_value?('abc')
               end
               def test_list_field_validation
                 f = CustomField.new(:field_format => 'list', :possible_values => ['value1', 'value2'])
                 assert f.valid_field_value?(nil)
                 assert f.valid_field_value?('')
                 assert f.valid_field_value?('value2')
                 assert !f.valid_field_value?('abc')
               end
               def test_int_field_validation
                 f = CustomField.new(:field_format => 'int')
                 assert f.valid_field_value?(nil)
                 assert f.valid_field_value?('')
                 assert f.valid_field_value?('123')
                 assert f.valid_field_value?('+123')
                 assert f.valid_field_value?('-123')
                 assert !f.valid_field_value?('6abc')
               end
               def test_float_field_validation
                 f = CustomField.new(:field_format => 'float')
                 assert f.valid_field_value?(nil)
                 assert f.valid_field_value?('')
                 assert f.valid_field_value?('11.2')
                 assert f.valid_field_value?('-6.250')
                 assert f.valid_field_value?('5')
                 assert !f.valid_field_value?('6abc')
               end
               def test_multi_field_validation
                 f = CustomField.new(:field_format => 'list', :multiple => 'true', :possible_values => ['value1', 'value2'])
                 assert f.valid_field_value?(nil)
                 assert f.valid_field_value?('')
                 assert f.valid_field_value?([])
                 assert f.valid_field_value?([nil])
                 assert f.valid_field_value?([''])
                 assert f.valid_field_value?('value2')
                 assert !f.valid_field_value?('abc')
                 assert f.valid_field_value?(['value2'])
                 assert !f.valid_field_value?(['abc'])
                 assert f.valid_field_value?(['', 'value2'])
                 assert !f.valid_field_value?(['', 'abc'])
                 assert f.valid_field_value?(['value1', 'value2'])
                 assert !f.valid_field_value?(['value1', 'abc'])
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages