Merge pull request #17574 from kamipo/charset_collation_options

Add charset and collation options support for MySQL string and text columns.

4 files changed, 118 insertions, 18 deletions

diff --git a/activerecord/test/cases/adapters/mysql/charset_collation_test.rb b/activerecord/test/cases/adapters/mysql/charset_collation_test.rb
new file mode 100644
index 0000000000..71a3756a90
--- /dev/null
+++ b/activerecord/test/cases/adapters/mysql/charset_collation_test.rb
@@ -0,0 +1,54 @@
+require "cases/helper"
+require 'support/schema_dumping_helper'
+
+class CharsetCollationTest < ActiveRecord::TestCase
+  include SchemaDumpingHelper
+  self.use_transactional_fixtures = false
+
+  setup do
+    @connection = ActiveRecord::Base.connection
+    @connection.create_table :charset_collations, force: true do |t|
+      t.string :string_ascii_bin, charset: 'ascii', collation: 'ascii_bin'
+      t.text :text_ucs2_unicode_ci, charset: 'ucs2', collation: 'ucs2_unicode_ci'
+    end
+  end
+
+  teardown do
+    @connection.drop_table :charset_collations, if_exists: true
+  end
+
+  test "string column with charset and collation" do
+    column = @connection.columns(:charset_collations).find { |c| c.name == 'string_ascii_bin' }
+    assert_equal :string, column.type
+    assert_equal 'ascii_bin', column.collation
+  end
+
+  test "text column with charset and collation" do
+    column = @connection.columns(:charset_collations).find { |c| c.name == 'text_ucs2_unicode_ci' }
+    assert_equal :text, column.type
+    assert_equal 'ucs2_unicode_ci', column.collation
+  end
+
+  test "add column with charset and collation" do
+    @connection.add_column :charset_collations, :title, :string, charset: 'utf8', collation: 'utf8_bin'
+
+    column = @connection.columns(:charset_collations).find { |c| c.name == 'title' }
+    assert_equal :string, column.type
+    assert_equal 'utf8_bin', column.collation
+  end
+
+  test "change column with charset and collation" do
+    @connection.add_column :charset_collations, :description, :string, charset: 'utf8', collation: 'utf8_unicode_ci'
+    @connection.change_column :charset_collations, :description, :text, charset: 'utf8', collation: 'utf8_general_ci'
+
+    column = @connection.columns(:charset_collations).find { |c| c.name == 'description' }
+    assert_equal :text, column.type
+    assert_equal 'utf8_general_ci', column.collation
+  end
+
+  test "schema dump includes collation" do
+    output = dump_table_schema("charset_collations")
+    assert_match %r{t.string\s+"string_ascii_bin",\s+limit: 255,\s+collation: "ascii_bin"$}, output
+    assert_match %r{t.text\s+"text_ucs2_unicode_ci",\s+limit: 65535,\s+collation: "ucs2_unicode_ci"$}, output
+  end
+end
diff --git a/activerecord/test/cases/adapters/mysql2/charset_collation_test.rb b/activerecord/test/cases/adapters/mysql2/charset_collation_test.rb
new file mode 100644
index 0000000000..71a3756a90
--- /dev/null
+++ b/activerecord/test/cases/adapters/mysql2/charset_collation_test.rb
@@ -0,0 +1,54 @@
+require "cases/helper"
+require 'support/schema_dumping_helper'
+
+class CharsetCollationTest < ActiveRecord::TestCase
+  include SchemaDumpingHelper
+  self.use_transactional_fixtures = false
+
+  setup do
+    @connection = ActiveRecord::Base.connection
+    @connection.create_table :charset_collations, force: true do |t|
+      t.string :string_ascii_bin, charset: 'ascii', collation: 'ascii_bin'
+      t.text :text_ucs2_unicode_ci, charset: 'ucs2', collation: 'ucs2_unicode_ci'
+    end
+  end
+
+  teardown do
+    @connection.drop_table :charset_collations, if_exists: true
+  end
+
+  test "string column with charset and collation" do
+    column = @connection.columns(:charset_collations).find { |c| c.name == 'string_ascii_bin' }
+    assert_equal :string, column.type
+    assert_equal 'ascii_bin', column.collation
+  end
+
+  test "text column with charset and collation" do
+    column = @connection.columns(:charset_collations).find { |c| c.name == 'text_ucs2_unicode_ci' }
+    assert_equal :text, column.type
+    assert_equal 'ucs2_unicode_ci', column.collation
+  end
+
+  test "add column with charset and collation" do
+    @connection.add_column :charset_collations, :title, :string, charset: 'utf8', collation: 'utf8_bin'
+
+    column = @connection.columns(:charset_collations).find { |c| c.name == 'title' }
+    assert_equal :string, column.type
+    assert_equal 'utf8_bin', column.collation
+  end
+
+  test "change column with charset and collation" do
+    @connection.add_column :charset_collations, :description, :string, charset: 'utf8', collation: 'utf8_unicode_ci'
+    @connection.change_column :charset_collations, :description, :text, charset: 'utf8', collation: 'utf8_general_ci'
+
+    column = @connection.columns(:charset_collations).find { |c| c.name == 'description' }
+    assert_equal :text, column.type
+    assert_equal 'utf8_general_ci', column.collation
+  end
+
+  test "schema dump includes collation" do
+    output = dump_table_schema("charset_collations")
+    assert_match %r{t.string\s+"string_ascii_bin",\s+limit: 255,\s+collation: "ascii_bin"$}, output
+    assert_match %r{t.text\s+"text_ucs2_unicode_ci",\s+limit: 65535,\s+collation: "ucs2_unicode_ci"$}, output
+  end
+end
diff --git a/activerecord/test/schema/mysql2_specific_schema.rb b/activerecord/test/schema/mysql2_specific_schema.rb
index d6fd0c4ab0..52d3290c84 100644
--- a/activerecord/test/schema/mysql2_specific_schema.rb
+++ b/activerecord/test/schema/mysql2_specific_schema.rb
@@ -24,6 +24,11 @@ ActiveRecord::Schema.define do
   add_index :key_tests, :pizza, :using => :btree, :name => 'index_key_tests_on_pizza'
   add_index :key_tests, :snacks, :name => 'index_key_tests_on_snack'
 
+  create_table :collation_tests, id: false, force: true do |t|
+    t.string :string_cs_column, limit: 1, collation: 'utf8_bin'
+    t.string :string_ci_column, limit: 1, collation: 'utf8_general_ci'
+  end
+
   ActiveRecord::Base.connection.execute <<-SQL
 DROP PROCEDURE IF EXISTS ten;
 SQL
@@ -35,15 +40,6 @@ BEGIN
 END
 SQL
 
-  ActiveRecord::Base.connection.drop_table "collation_tests", if_exists: true
-
-  ActiveRecord::Base.connection.execute <<-SQL
-CREATE TABLE collation_tests (
-  string_cs_column VARCHAR(1) COLLATE utf8_bin,
-  string_ci_column VARCHAR(1) COLLATE utf8_general_ci
-) CHARACTER SET utf8 COLLATE utf8_general_ci
-SQL
-
   ActiveRecord::Base.connection.drop_table "enum_tests", if_exists: true
 
   ActiveRecord::Base.connection.execute <<-SQL
diff --git a/activerecord/test/schema/mysql_specific_schema.rb b/activerecord/test/schema/mysql_specific_schema.rb
index b5378341b5..90f5a60d7b 100644
--- a/activerecord/test/schema/mysql_specific_schema.rb
+++ b/activerecord/test/schema/mysql_specific_schema.rb
@@ -24,6 +24,11 @@ ActiveRecord::Schema.define do
   add_index :key_tests, :pizza, :using => :btree, :name => 'index_key_tests_on_pizza'
   add_index :key_tests, :snacks, :name => 'index_key_tests_on_snack'
 
+  create_table :collation_tests, id: false, force: true do |t|
+    t.string :string_cs_column, limit: 1, collation: 'utf8_bin'
+    t.string :string_ci_column, limit: 1, collation: 'utf8_general_ci'
+  end
+
   ActiveRecord::Base.connection.execute <<-SQL
 DROP PROCEDURE IF EXISTS ten;
 SQL
@@ -46,15 +51,6 @@ BEGIN
 END
 SQL
 
-  ActiveRecord::Base.connection.drop_table "collation_tests", if_exists: true
-
-  ActiveRecord::Base.connection.execute <<-SQL
-CREATE TABLE collation_tests (
-  string_cs_column VARCHAR(1) COLLATE utf8_bin,
-  string_ci_column VARCHAR(1) COLLATE utf8_general_ci
-) CHARACTER SET utf8 COLLATE utf8_general_ci
-SQL
-
   ActiveRecord::Base.connection.drop_table "enum_tests", if_exists: true
 
   ActiveRecord::Base.connection.execute <<-SQL