Adds support for multiselect custom fields (#1189).

git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@8721 e93f8b46-1217-0410-a6f0-8f06a7374b81

test/functional/issues_controller_test.rb

@@ -625,6 +625,36 @@ class IssuesControllerTest < ActionController::TestCase
       :ancestor => {:tag => 'table', :attributes => {:class => /issues/}}
   end
 
+  def test_index_with_multi_custom_field_column
+    field = CustomField.find(1)
+    field.update_attribute :multiple, true
+    issue = Issue.find(1)
+    issue.custom_field_values = {1 => ['MySQL', 'Oracle']}
+    issue.save!
+
+    get :index, :set_filter => 1, :c => %w(tracker subject cf_1)
+    assert_response :success
+
+    assert_tag :td,
+      :attributes => {:class => /cf_1/},
+      :content => 'MySQL, Oracle'
+  end
+
+  def test_index_with_multi_user_custom_field_column
+    field = IssueCustomField.create!(:name => 'Multi user', :field_format => 'user', :multiple => true,
+      :tracker_ids => [1], :is_for_all => true)
+    issue = Issue.find(1)
+    issue.custom_field_values = {field.id => ['2', '3']}
+    issue.save!
+
+    get :index, :set_filter => 1, :c => ['tracker', 'subject', "cf_#{field.id}"]
+    assert_response :success
+
+    assert_tag :td,
+      :attributes => {:class => /cf_#{field.id}/},
+      :child => {:tag => 'a', :content => 'John Smith'}
+  end
+
   def test_index_with_date_column
     Issue.find(1).update_attribute :start_date, '1987-08-24'
 
@@ -1032,6 +1062,33 @@ class IssuesControllerTest < ActionController::TestCase
     assert_no_tag 'a', :content => /Next/
   end
 
+  def test_show_with_multi_custom_field
+    field = CustomField.find(1)
+    field.update_attribute :multiple, true
+    issue = Issue.find(1)
+    issue.custom_field_values = {1 => ['MySQL', 'Oracle']}
+    issue.save!
+
+    get :show, :id => 1
+    assert_response :success
+
+    assert_tag :td, :content => 'MySQL, Oracle'
+  end
+
+  def test_show_with_multi_user_custom_field
+    field = IssueCustomField.create!(:name => 'Multi user', :field_format => 'user', :multiple => true,
+      :tracker_ids => [1], :is_for_all => true)
+    issue = Issue.find(1)
+    issue.custom_field_values = {field.id => ['2', '3']}
+    issue.save!
+
+    get :show, :id => 1
+    assert_response :success
+
+    # TODO: should display links
+    assert_tag :td, :content => 'John Smith, Dave Lopper'
+  end
+
   def test_show_atom
     get :show, :id => 2, :format => 'atom'
     assert_response :success
@@ -1104,6 +1161,40 @@ class IssuesControllerTest < ActionController::TestCase
     assert_no_tag 'input', :attributes => {:name => 'issue[watcher_user_ids][]'}
   end
 
+  def test_get_new_with_multi_custom_field
+    field = IssueCustomField.find(1)
+    field.update_attribute :multiple, true
+
+    @request.session[:user_id] = 2
+    get :new, :project_id => 1, :tracker_id => 1
+    assert_response :success
+    assert_template 'new'
+
+    assert_tag 'select',
+      :attributes => {:name => 'issue[custom_field_values][1][]', :multiple => 'multiple'},
+      :children => {:count => 3},
+      :child => {:tag => 'option', :attributes => {:value => 'MySQL'}, :content => 'MySQL'}
+    assert_tag 'input',
+      :attributes => {:name => 'issue[custom_field_values][1][]', :value => ''}
+  end
+
+  def test_get_new_with_multi_user_custom_field
+    field = IssueCustomField.create!(:name => 'Multi user', :field_format => 'user', :multiple => true,
+      :tracker_ids => [1], :is_for_all => true)
+
+    @request.session[:user_id] = 2
+    get :new, :project_id => 1, :tracker_id => 1
+    assert_response :success
+    assert_template 'new'
+
+    assert_tag 'select',
+      :attributes => {:name => "issue[custom_field_values][#{field.id}][]", :multiple => 'multiple'},
+      :children => {:count => Project.find(1).users.count},
+      :child => {:tag => 'option', :attributes => {:value => '2'}, :content => 'John Smith'}
+    assert_tag 'input',
+      :attributes => {:name => "issue[custom_field_values][#{field.id}][]", :value => ''}
+  end
+
   def test_get_new_without_default_start_date_is_creation_date
     Setting.default_issue_start_date_to_creation_date = 0
 
@@ -1303,6 +1394,60 @@ class IssuesControllerTest < ActionController::TestCase
     assert_redirected_to :controller => 'issues', :action => 'show', :id => Issue.last.id
   end
 
+  def test_post_create_with_multi_custom_field
+    field = IssueCustomField.find_by_name('Database')
+    field.update_attribute(:multiple, true)
+
+    @request.session[:user_id] = 2
+    assert_difference 'Issue.count' do
+      post :create, :project_id => 1,
+                 :issue => {:tracker_id => 1,
+                            :subject => 'This is the test_new issue',
+                            :description => 'This is the description',
+                            :priority_id => 5,
+                            :custom_field_values => {'1' => ['', 'MySQL', 'Oracle']}}
+    end
+    assert_response 302
+    issue = Issue.first(:order => 'id DESC')
+    assert_equal ['MySQL', 'Oracle'], issue.custom_field_value(1).sort
+  end
+
+  def test_post_create_with_empty_multi_custom_field
+    field = IssueCustomField.find_by_name('Database')
+    field.update_attribute(:multiple, true)
+
+    @request.session[:user_id] = 2
+    assert_difference 'Issue.count' do
+      post :create, :project_id => 1,
+                 :issue => {:tracker_id => 1,
+                            :subject => 'This is the test_new issue',
+                            :description => 'This is the description',
+                            :priority_id => 5,
+                            :custom_field_values => {'1' => ['']}}
+    end
+    assert_response 302
+    issue = Issue.first(:order => 'id DESC')
+    assert_equal [''], issue.custom_field_value(1).sort
+  end
+
+  def test_post_create_with_multi_user_custom_field
+    field = IssueCustomField.create!(:name => 'Multi user', :field_format => 'user', :multiple => true,
+      :tracker_ids => [1], :is_for_all => true)
+
+    @request.session[:user_id] = 2
+    assert_difference 'Issue.count' do
+      post :create, :project_id => 1,
+                 :issue => {:tracker_id => 1,
+                            :subject => 'This is the test_new issue',
+                            :description => 'This is the description',
+                            :priority_id => 5,
+                            :custom_field_values => {field.id.to_s => ['', '2', '3']}}
+    end
+    assert_response 302
+    issue = Issue.first(:order => 'id DESC')
+    assert_equal ['2', '3'], issue.custom_field_value(field).sort
+  end
+
   def test_post_create_with_required_custom_field_and_without_custom_fields_param
     field = IssueCustomField.find_by_name('Database')
     field.update_attribute(:is_required, true)
@@ -1822,6 +1967,27 @@ class IssuesControllerTest < ActionController::TestCase
     assert_tag :input, :attributes => { :name => 'time_entry[comments]', :value => 'test_get_edit_with_params' }
   end
 
+  def test_get_edit_with_multi_custom_field
+    field = CustomField.find(1)
+    field.update_attribute :multiple, true
+    issue = Issue.find(1)
+    issue.custom_field_values = {1 => ['MySQL', 'Oracle']}
+    issue.save!
+
+    @request.session[:user_id] = 2
+    get :edit, :id => 1
+    assert_response :success
+    assert_template 'edit'
+
+    assert_tag 'select', :attributes => {:name => 'issue[custom_field_values][1][]', :multiple => 'multiple'}
+    assert_tag 'select', :attributes => {:name => 'issue[custom_field_values][1][]'},
+      :child => {:tag => 'option', :attributes => {:value => 'MySQL', :selected => 'selected'}}
+    assert_tag 'select', :attributes => {:name => 'issue[custom_field_values][1][]'},
+      :child => {:tag => 'option', :attributes => {:value => 'PostgreSQL', :selected => nil}}
+    assert_tag 'select', :attributes => {:name => 'issue[custom_field_values][1][]'},
+      :child => {:tag => 'option', :attributes => {:value => 'Oracle', :selected => 'selected'}}
+  end
+
   def test_update_edit_form
     @request.session[:user_id] = 2
     xhr :put, :new, :project_id => 1,
@@ -1979,6 +2145,27 @@ class IssuesControllerTest < ActionController::TestCase
     assert mail.body.include?("Searchable field changed from 125 to New custom value")
   end
 
+  def test_put_update_with_multi_custom_field_change
+    field = CustomField.find(1)
+    field.update_attribute :multiple, true
+    issue = Issue.find(1)
+    issue.custom_field_values = {1 => ['MySQL', 'Oracle']}
+    issue.save!
+
+    @request.session[:user_id] = 2
+    assert_difference('Journal.count') do
+      assert_difference('JournalDetail.count', 3) do
+        put :update, :id => 1,
+          :issue => {
+            :subject => 'Custom field change',
+            :custom_field_values => { '1' => ['', 'Oracle', 'PostgreSQL'] }
+          }
+      end
+    end
+    assert_redirected_to :action => 'show', :id => '1'
+    assert_equal ['Oracle', 'PostgreSQL'], Issue.find(1).custom_field_value(1).sort
+  end
+
   def test_put_update_with_status_and_assignee_change
     issue = Issue.find(1)
     assert_equal 1, issue.status_id
@@ -2283,6 +2470,23 @@ class IssuesControllerTest < ActionController::TestCase
       }
   end
 
+  def test_get_bulk_edit_with_multi_custom_field
+    field = CustomField.find(1)
+    field.update_attribute :multiple, true
+
+    @request.session[:user_id] = 2
+    get :bulk_edit, :ids => [1, 2]
+    assert_response :success
+    assert_template 'bulk_edit'
+
+    assert_tag :select,
+      :attributes => {:name => "issue[custom_field_values][1][]"},
+      :children => {
+        :only => {:tag => 'option'},
+        :count => 3
+      }
+  end
+
   def test_bulk_update
     @request.session[:user_id] = 2
     # update issues priority
@@ -2463,6 +2667,24 @@ class IssuesControllerTest < ActionController::TestCase
     assert_equal '777', journal.details.first.value
   end
 
+  def test_bulk_update_multi_custom_field
+    field = CustomField.find(1)
+    field.update_attribute :multiple, true
+
+    @request.session[:user_id] = 2
+    post :bulk_update, :ids => [1, 2, 3], :notes => 'Bulk editing multi custom field',
+                                     :issue => {:priority_id => '',
+                                                :assigned_to_id => '',
+                                                :custom_field_values => {'1' => ['MySQL', 'Oracle']}}
+
+    assert_response 302
+
+    assert_equal ['MySQL', 'Oracle'], Issue.find(1).custom_field_value(1).sort
+    assert_equal ['MySQL', 'Oracle'], Issue.find(3).custom_field_value(1).sort
+    # the custom field is not associated with the issue tracker
+    assert_nil Issue.find(2).custom_field_value(1)
+  end
+
   def test_bulk_update_unassign
     assert_not_nil Issue.find(2).assigned_to
     @request.session[:user_id] = 2

test/integration/api_test/issues_test.rb

@@ -258,6 +258,108 @@ class ApiTest::IssuesTest < ActionController::IntegrationTest
       end
     end
 
+    context "with multi custom fields" do
+      setup do
+        field = CustomField.find(1)
+        field.update_attribute :multiple, true
+        issue = Issue.find(3)
+        issue.custom_field_values = {1 => ['MySQL', 'Oracle']}
+        issue.save!
+      end
+
+      context ".xml" do
+        should "display custom fields" do
+          get '/issues/3.xml'
+          assert_response :success
+          assert_tag :tag => 'issue',
+            :child => {
+              :tag => 'custom_fields',
+              :attributes => { :type => 'array' },
+              :child => {
+                :tag => 'custom_field',
+                :attributes => { :id => '1'},
+                :child => {
+                  :tag => 'value',
+                  :attributes => { :type => 'array' },
+                  :children => { :count => 2 }
+                }
+              }
+            }
+
+          xml = Hash.from_xml(response.body)
+          custom_fields = xml['issue']['custom_fields']
+          assert_kind_of Array, custom_fields
+          field = custom_fields.detect {|f| f['id'] == '1'}
+          assert_kind_of Hash, field
+          assert_equal ['MySQL', 'Oracle'], field['value'].sort
+        end
+      end
+
+      context ".json" do
+        should "display custom fields" do
+          get '/issues/3.json'
+          assert_response :success
+          json = ActiveSupport::JSON.decode(response.body)
+          custom_fields = json['issue']['custom_fields']
+          assert_kind_of Array, custom_fields
+          field = custom_fields.detect {|f| f['id'] == 1}
+          assert_kind_of Hash, field
+          assert_equal ['MySQL', 'Oracle'], field['value'].sort
+        end
+      end
+    end
+
+    context "with empty value for multi custom field" do
+      setup do
+        field = CustomField.find(1)
+        field.update_attribute :multiple, true
+        issue = Issue.find(3)
+        issue.custom_field_values = {1 => ['']}
+        issue.save!
+      end
+
+      context ".xml" do
+        should "display custom fields" do
+          get '/issues/3.xml'
+          assert_response :success
+          assert_tag :tag => 'issue',
+            :child => {
+              :tag => 'custom_fields',
+              :attributes => { :type => 'array' },
+              :child => {
+                :tag => 'custom_field',
+                :attributes => { :id => '1'},
+                :child => {
+                  :tag => 'value',
+                  :attributes => { :type => 'array' },
+                  :children => { :count => 0 }
+                }
+              }
+            }
+
+          xml = Hash.from_xml(response.body)
+          custom_fields = xml['issue']['custom_fields']
+          assert_kind_of Array, custom_fields
+          field = custom_fields.detect {|f| f['id'] == '1'}
+          assert_kind_of Hash, field
+          assert_equal [], field['value']
+        end
+      end
+
+      context ".json" do
+        should "display custom fields" do
+          get '/issues/3.json'
+          assert_response :success
+          json = ActiveSupport::JSON.decode(response.body)
+          custom_fields = json['issue']['custom_fields']
+          assert_kind_of Array, custom_fields
+          field = custom_fields.detect {|f| f['id'] == 1}
+          assert_kind_of Hash, field
+          assert_equal [], field['value'].sort
+        end
+      end
+    end
+
     context "with attachments" do
       context ".xml" do
         should "display attachments" do
@@ -455,6 +557,24 @@ class ApiTest::IssuesTest < ActionController::IntegrationTest
     end
   end
 
+  context "PUT /issues/3.xml with multi custom fields" do
+    setup do
+      field = CustomField.find(1)
+      field.update_attribute :multiple, true
+      @parameters = {:issue => {:custom_fields => [{'id' => '1', 'value' => ['MySQL', 'PostgreSQL'] }, {'id' => '2', 'value' => '150'}]}}
+    end
+
+    should "update custom fields" do
+      assert_no_difference('Issue.count') do
+        put '/issues/3.xml', @parameters, credentials('jsmith')
+      end
+
+      issue = Issue.find(3)
+      assert_equal '150', issue.custom_value_for(2).value
+      assert_equal ['MySQL', 'PostgreSQL'], issue.custom_field_value(1)
+    end
+  end
+
   context "PUT /issues/3.xml with project change" do
     setup do
       @parameters = {:issue => {:project_id => 2, :subject => 'Project changed'}}

test/unit/custom_field_test.rb

@@ -164,4 +164,26 @@ class CustomFieldTest < ActiveSupport::TestCase
     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

test/unit/issue_test.rb

@@ -921,6 +921,36 @@ class IssueTest < ActiveSupport::TestCase
     end
   end
 
+  def test_journalized_multi_custom_field
+    field = IssueCustomField.create!(:name => 'filter', :field_format => 'list', :is_filter => true, :is_for_all => true,
+      :tracker_ids => [1], :possible_values => ['value1', 'value2', 'value3'], :multiple => true)
+
+    issue = Issue.create!(:project_id => 1, :tracker_id => 1, :subject => 'Test', :author_id => 1)
+
+    assert_difference 'Journal.count' do
+      assert_difference 'JournalDetail.count' do
+        issue.init_journal(User.first)
+        issue.custom_field_values = {field.id => ['value1']}
+        issue.save!
+      end
+      assert_difference 'JournalDetail.count' do
+        issue.init_journal(User.first)
+        issue.custom_field_values = {field.id => ['value1', 'value2']}
+        issue.save!
+      end
+      assert_difference 'JournalDetail.count', 2 do
+        issue.init_journal(User.first)
+        issue.custom_field_values = {field.id => ['value3', 'value2']}
+        issue.save!
+      end
+      assert_difference 'JournalDetail.count', 2 do
+        issue.init_journal(User.first)
+        issue.custom_field_values = {field.id => nil}
+        issue.save!
+      end
+    end
+  end
+
   def test_description_eol_should_be_normalized
     i = Issue.new(:description => "CR \r LF \n CRLF \r\n")
     assert_equal "CR \r\n LF \r\n CRLF \r\n", i.description

test/unit/query_test.rb

@@ -173,6 +173,44 @@ class QueryTest < ActiveSupport::TestCase
     assert_equal 2, issues.first.id
   end
 
+  def test_operator_is_on_multi_list_custom_field
+    f = IssueCustomField.create!(:name => 'filter', :field_format => 'list', :is_filter => true, :is_for_all => true,
+      :possible_values => ['value1', 'value2', 'value3'], :multiple => true)
+    CustomValue.create!(:custom_field => f, :customized => Issue.find(1), :value => 'value1')
+    CustomValue.create!(:custom_field => f, :customized => Issue.find(1), :value => 'value2')
+    CustomValue.create!(:custom_field => f, :customized => Issue.find(3), :value => 'value1')
+
+    query = Query.new(:name => '_')
+    query.add_filter("cf_#{f.id}", '=', ['value1'])
+    issues = find_issues_with_query(query)
+    assert_equal [1, 3], issues.map(&:id).sort
+
+    query = Query.new(:name => '_')
+    query.add_filter("cf_#{f.id}", '=', ['value2'])
+    issues = find_issues_with_query(query)
+    assert_equal [1], issues.map(&:id).sort
+  end
+
+  def test_operator_is_not_on_multi_list_custom_field
+    f = IssueCustomField.create!(:name => 'filter', :field_format => 'list', :is_filter => true, :is_for_all => true,
+      :possible_values => ['value1', 'value2', 'value3'], :multiple => true)
+    CustomValue.create!(:custom_field => f, :customized => Issue.find(1), :value => 'value1')
+    CustomValue.create!(:custom_field => f, :customized => Issue.find(1), :value => 'value2')
+    CustomValue.create!(:custom_field => f, :customized => Issue.find(3), :value => 'value1')
+
+    query = Query.new(:name => '_')
+    query.add_filter("cf_#{f.id}", '!', ['value1'])
+    issues = find_issues_with_query(query)
+    assert !issues.map(&:id).include?(1)
+    assert !issues.map(&:id).include?(3)
+
+    query = Query.new(:name => '_')
+    query.add_filter("cf_#{f.id}", '!', ['value2'])
+    issues = find_issues_with_query(query)
+    assert !issues.map(&:id).include?(1)
+    assert issues.map(&:id).include?(3)
+  end
+
   def test_operator_greater_than
     query = Query.new(:project => Project.find(1), :name => '_')
     query.add_filter('done_ratio', '>=', ['40'])
@@ -492,7 +530,18 @@ class QueryTest < ActiveSupport::TestCase
 
   def test_groupable_columns_should_include_custom_fields
     q = Query.new
-    assert q.groupable_columns.detect {|c| c.is_a? QueryCustomFieldColumn}
+    column = q.groupable_columns.detect {|c| c.name == :cf_1}
+    assert_not_nil column
+    assert_kind_of QueryCustomFieldColumn, column
+  end
+
+  def test_groupable_columns_should_not_include_multi_custom_fields
+    field = CustomField.find(1)
+    field.update_attribute :multiple, true
+
+    q = Query.new
+    column = q.groupable_columns.detect {|c| c.name == :cf_1}
+    assert_nil column
   end
 
   def test_grouped_with_valid_column
@@ -527,6 +576,19 @@ class QueryTest < ActiveSupport::TestCase
     end
   end
 
+  def test_sortable_columns_should_include_custom_field
+    q = Query.new
+    assert q.sortable_columns['cf_1']
+  end
+
+  def test_sortable_columns_should_not_include_multi_custom_field
+    field = CustomField.find(1)
+    field.update_attribute :multiple, true
+
+    q = Query.new
+    assert !q.sortable_columns['cf_1']
+  end
+
   def test_default_sort
     q = Query.new
     assert_equal [], q.sort_criteria