jro_apps/redmine Commit - r13712:97fc28da3a56

Merged r14079 (#19316)....

Jean-Philippe Lang -

r13712:97fc28da3a56

parent child

Context file:

r13712:97fc28da3a56

Collapse all files

app/models/custom_field.rb +2 -2

             # Redmine - project management software
             # Copyright (C) 2006-2015  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
               has_and_belongs_to_many :roles, :join_table => "#{table_name_prefix}custom_fields_roles#{table_name_suffix}", :foreign_key => "custom_field_id"
               acts_as_list :scope => 'type = \'#{self.class}\''
               serialize :possible_values
               store :format_store
               validates_presence_of :name, :field_format
               validates_uniqueness_of :name, :scope => :type
               validates_length_of :name, :maximum => 30
               validates_inclusion_of :field_format, :in => Proc.new { Redmine::FieldFormat.available_formats }
               validate :validate_custom_field
               attr_protected :id
               before_validation :set_searchable
               before_save do |field|
                 field.format.before_custom_field_save(field)
               end
               after_save :handle_multiplicity_change
               after_save do |field|
                 if field.visible_changed? && field.visible
                   field.roles.clear
                 end
               end
               scope :sorted, lambda { order(:position) }
               scope :visible, lambda {|*args|
                 user = args.shift || User.current
                 if user.admin?
                   # nop
                 elsif user.memberships.any?
                   where("#{table_name}.visible = ? OR #{table_name}.id IN (SELECT DISTINCT cfr.custom_field_id FROM #{Member.table_name} m" +
                     " INNER JOIN #{MemberRole.table_name} mr ON mr.member_id = m.id" +
                     " INNER JOIN #{table_name_prefix}custom_fields_roles#{table_name_suffix} cfr ON cfr.role_id = mr.role_id" +
                     " WHERE m.user_id = ?)",
                     true, user.id)
                 else
                   where(:visible => true)
                 end
               }
               def visible_by?(project, user=User.current)
                 visible? || user.admin?
               end
               def format
                 @format ||= Redmine::FieldFormat.find(field_format)
               end
               def field_format=(arg)
                 # cannot change format of a saved custom field
                 if new_record?
                   @format = nil
                   super
                 end
               end
               def set_searchable
                 # make sure these fields are not searchable
                 self.searchable = false unless format.class.searchable_supported
                 # make sure only these fields can have multiple values
                 self.multiple = false unless format.class.multiple_supported
                 true
               end
               def validate_custom_field
                 format.validate_custom_field(self).each do |attribute, message|
                   errors.add attribute, message
                 end
                 if regexp.present?
                   begin
                     Regexp.new(regexp)
                   rescue
                     errors.add(:regexp, :invalid)
                   end
                 end
                 if default_value.present?
                   validate_field_value(default_value).each do |message|
                     errors.add :default_value, message
                   end
                 end
               end
               def possible_custom_value_options(custom_value)
                 format.possible_custom_value_options(custom_value)
               end
               def possible_values_options(object=nil)
                 if object.is_a?(Array)
                   object.map {|o| format.possible_values_options(self, o)}.reduce(:&) || []
                 else
                   format.possible_values_options(self, object) || []
                 end
               end
               def possible_values
                 values = read_attribute(:possible_values)
                 if values.is_a?(Array)
                   values.each do |value|
-                    value.force_encoding('UTF-8')
+                    value.to_s.force_encoding('UTF-8')
                   end
                   values
                 else
                   []
                 end
               end
               # Makes possible_values accept a multiline string
               def possible_values=(arg)
                 if arg.is_a?(Array)
-                  values = arg.compact.collect(&:strip).select {|v| !v.blank?}
+                  values = arg.compact.map {|a| a.to_s.strip}.reject(&:blank?)
                   write_attribute(:possible_values, values)
                 else
                   self.possible_values = arg.to_s.split(/[\n\r]+/)
                 end
               end
               def cast_value(value)
                 format.cast_value(self, value)
               end
               def value_from_keyword(keyword, customized)
                 possible_values_options = possible_values_options(customized)
                 if possible_values_options.present?
                   keyword = keyword.to_s.downcase
                   if v = possible_values_options.detect {|text, id| text.downcase == keyword}
                     if v.is_a?(Array)
                       v.last
                     else
                       v
                     end
                   end
                 else
                   keyword
                 end
               end
               # 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.
               def order_statement
                 return nil if multiple?
                 format.order_statement(self)
               end
               # 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.
               def group_statement
                 return nil if multiple?
                 format.group_statement(self)
               end
               def join_for_order_statement
                 format.join_for_order_statement(self)
               end
               def visibility_by_project_condition(project_key=nil, user=User.current, id_column=nil)
                 if visible? || user.admin?
                   "1=1"
                 elsif user.anonymous?
                   "1=0"
                 else
                   project_key ||= "#{self.class.customized_class.table_name}.project_id"
                   id_column ||= id
                   "#{project_key} IN (SELECT DISTINCT m.project_id FROM #{Member.table_name} m" +
                     " INNER JOIN #{MemberRole.table_name} mr ON mr.member_id = m.id" +
                     " INNER JOIN #{table_name_prefix}custom_fields_roles#{table_name_suffix} cfr ON cfr.role_id = mr.role_id" +
                     " WHERE m.user_id = #{user.id} AND cfr.custom_field_id = #{id_column})"
                 end
               end
               def self.visibility_condition
                 if user.admin?
                   "1=1"
                 elsif user.anonymous?
                   "#{table_name}.visible"
                 else
                   "#{project_key} IN (SELECT DISTINCT m.project_id FROM #{Member.table_name} m" +
                     " INNER JOIN #{MemberRole.table_name} mr ON mr.member_id = m.id" +
                     " INNER JOIN #{table_name_prefix}custom_fields_roles#{table_name_suffix} cfr ON cfr.role_id = mr.role_id" +
                     " WHERE m.user_id = #{user.id} AND cfr.custom_field_id = #{id})"
                 end
               end
               def <=>(field)
                 position <=> field.position
               end
               # Returns the class that values represent
               def value_class
                 format.target_class if format.respond_to?(:target_class)
               end
               def self.customized_class
                 self.name =~ /^(.+)CustomField$/
                 $1.constantize rescue nil
               end
               # to move in project_custom_field
               def self.for_all
                 where(:is_for_all => true).order('position').to_a
               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_custom_value(custom_value)
                 value = custom_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
                 else
                   if is_required? && value.blank?
                     errs << ::I18n.t('activerecord.errors.messages.blank')
                   end
                 end
                 errs += format.validate_custom_value(custom_value)
                 errs
               end
               # Returns the error messages for the default custom field value
               def validate_field_value(value)
                 validate_custom_value(CustomFieldValue.new(:custom_field => self, :value => value))
               end
               # Returns true if value is a valid value for the custom field
               def valid_field_value?(value)
                 validate_field_value(value).empty?
               end
               def format_in?(*args)
                 args.include?(field_format)
               end
               protected
               # Removes multiple values for the custom field after setting the multiple attribute to false
               # We kepp the value with the highest id for each customized object
               def handle_multiplicity_change
                 if !new_record? && multiple_was && !multiple
                   ids = custom_values.
                     where("EXISTS(SELECT 1 FROM #{CustomValue.table_name} cve WHERE cve.custom_field_id = #{CustomValue.table_name}.custom_field_id" +
                       " AND cve.customized_type = #{CustomValue.table_name}.customized_type AND cve.customized_id = #{CustomValue.table_name}.customized_id" +
                       " AND cve.id > #{CustomValue.table_name}.id)").
                     pluck(:id)
                   if ids.any?
                     custom_values.where(:id => ids).delete_all
                   end
                 end
               end
             end
             require_dependency 'redmine/field_format'

test/unit/custom_field_test.rb +14 0

             # Redmine - project management software
             # Copyright (C) 2006-2015  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, :roles, :projects,
                        :trackers, :issue_statuses,
                        :issues
               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_include I18n.t('activerecord.errors.messages.invalid'),
                                field.errors[:regexp]
                 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_field_format_should_be_validated
                 field = CustomField.new(:name => 'Test', :field_format => 'foo')
                 assert !field.valid?
               end
               def test_field_format_validation_should_accept_formats_added_at_runtime
                 Redmine::FieldFormat.add 'foobar', Class.new(Redmine::FieldFormat::Base)
                 field = CustomField.new(:name => 'Some Custom Field', :field_format => 'foobar')
                 assert field.valid?, 'field should be valid'
               ensure
                 Redmine::FieldFormat.delete 'foobar'
               end
               def test_should_not_change_field_format_of_existing_custom_field
                 field = CustomField.find(1)
                 field.field_format = 'int'
                 assert_equal 'list', field.field_format
               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_stringify_values
+                field = CustomField.new
+                field.possible_values = [1, 2]
+                assert_equal ["1", "2"], 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_return_utf8_encoded_strings
+                field = CustomField.new
+                s = "Value".force_encoding('BINARY')
+                field.possible_values = s
+                assert_equal [s], field.possible_values
+                assert_equal 'UTF-8', field.possible_values.first.encoding.name
+              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_possible_values_stored_as_binary_should_be_utf8_encoded
                 field = CustomField.find(11)
                 assert_kind_of Array, field.possible_values
                 assert field.possible_values.size > 0
                 field.possible_values.each do |value|
                   assert_equal "UTF-8", value.encoding.name
                 end
               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?(' ')
                 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?(' ')
                 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?(' ')
                 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?(' ')
                 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?(' ')
                 assert f.valid_field_value?('123')
                 assert f.valid_field_value?('+123')
                 assert f.valid_field_value?('-123')
                 assert !f.valid_field_value?('6abc')
                 assert f.valid_field_value?(123)
               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?(' ')
                 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')
                 assert f.valid_field_value?(11.2)
               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?([])
                 assert f.valid_field_value?([nil])
                 assert f.valid_field_value?([''])
                 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
               def test_changing_multiple_to_false_should_delete_multiple_values
                 field = ProjectCustomField.create!(:name => 'field', :field_format => 'list', :multiple => 'true', :possible_values => ['field1', 'field2'])
                 other = ProjectCustomField.create!(:name => 'other', :field_format => 'list', :multiple => 'true', :possible_values => ['other1', 'other2'])
                 item_with_multiple_values = Project.generate!(:custom_field_values => {field.id => ['field1', 'field2'], other.id => ['other1', 'other2']})
                 item_with_single_values = Project.generate!(:custom_field_values => {field.id => ['field1'], other.id => ['other2']})
                 assert_difference 'CustomValue.count', -1 do
                   field.multiple = false
                   field.save!
                 end
                 item_with_multiple_values = Project.find(item_with_multiple_values.id)
                 assert_kind_of String, item_with_multiple_values.custom_field_value(field)
                 assert_kind_of Array, item_with_multiple_values.custom_field_value(other)
                 assert_equal 2, item_with_multiple_values.custom_field_value(other).size
               end
               def test_value_class_should_return_the_class_used_for_fields_values
                 assert_equal User, CustomField.new(:field_format => 'user').value_class
                 assert_equal Version, CustomField.new(:field_format => 'version').value_class
               end
               def test_value_class_should_return_nil_for_other_fields
                 assert_nil CustomField.new(:field_format => 'text').value_class
                 assert_nil CustomField.new.value_class
               end
               def test_value_from_keyword_for_list_custom_field
                 field = CustomField.find(1)
                 assert_equal 'PostgreSQL', field.value_from_keyword('postgresql', Issue.find(1))
               end
               def test_visibile_scope_with_admin_should_return_all_custom_fields
                 admin = User.generate! {|user| user.admin = true}
                 CustomField.delete_all
                 fields = [
                   CustomField.generate!(:visible => true),
                   CustomField.generate!(:visible => false),
                   CustomField.generate!(:visible => false, :role_ids => [1, 3]),
                   CustomField.generate!(:visible => false, :role_ids => [1, 2]),
                 ]
                 assert_equal 4, CustomField.visible(admin).count
               end
               def test_visibile_scope_with_non_admin_user_should_return_visible_custom_fields
                 CustomField.delete_all
                 fields = [
                   CustomField.generate!(:visible => true),
                   CustomField.generate!(:visible => false),
                   CustomField.generate!(:visible => false, :role_ids => [1, 3]),
                   CustomField.generate!(:visible => false, :role_ids => [1, 2]),
                 ]
                 user = User.generate!
                 User.add_to_project(user, Project.first, Role.find(3))
                 assert_equal [fields[0], fields[2]], CustomField.visible(user).order("id").to_a
               end
               def test_visibile_scope_with_anonymous_user_should_return_visible_custom_fields
                 CustomField.delete_all
                 fields = [
                   CustomField.generate!(:visible => true),
                   CustomField.generate!(:visible => false),
                   CustomField.generate!(:visible => false, :role_ids => [1, 3]),
                   CustomField.generate!(:visible => false, :role_ids => [1, 2]),
                 ]
                 assert_equal [fields[0]], CustomField.visible(User.anonymous).order("id").to_a
               end
               def test_float_cast_blank_value_should_return_nil
                 field = CustomField.new(:field_format => 'float')
                 assert_equal nil, field.cast_value(nil)
                 assert_equal nil, field.cast_value('')
               end
               def test_float_cast_valid_value_should_return_float
                 field = CustomField.new(:field_format => 'float')
                 assert_equal 12.0, field.cast_value('12')
                 assert_equal 12.5, field.cast_value('12.5')
                 assert_equal 12.5, field.cast_value('+12.5')
                 assert_equal -12.5, field.cast_value('-12.5')
               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