Merge pull request rails#53281 from jduff/schema_dumper_sort_columns

Sort table columns by name when dumping schema

Author: byroot

activerecord/CHANGELOG.md

@@ -1,3 +1,10 @@
+*   The table columns inside `schema.rb` are now sorted alphabetically.
+
+    Previously they'd be sorted by creation order, which can cause merge conflicts when two
+    branches modify the same table concurrently.
+
+    *John Duff*
+
 *   Introduce versions formatter for the schema dumper.
 
     It is now possible to override how schema dumper formats versions information inside the

activerecord/lib/active_record/schema_dumper.rb

@@ -192,7 +192,7 @@ def table(table, stream)
           tbl.puts ", force: :cascade do |t|"
 
           # then dump all non-primary key columns
-          columns.each do |column|
+          columns.sort_by(&:name).each do |column|
             raise StandardError, "Unknown type '#{column.sql_type}' for column '#{column.name}'" unless @connection.valid_type?(column.type)
             next if column.name == pk
 

activerecord/test/cases/schema_dumper_test.rb

@@ -167,6 +167,14 @@ def test_schema_dump_with_regexp_ignored_table
     assert_no_match %r{create_table "ar_internal_metadata"}, output
   end
 
+  def test_table_columns_sorted
+    column_names = column_definition_lines(dump_table_schema("companies")).flatten.filter_map do |line|
+      $1 if line !~ /t\.index/ && line.match(/t\..*"(\w+)"/)
+    end
+
+    assert_equal %w[account_id client_of description firm_id firm_name name rating status type], column_names
+  end
+
   def test_schema_dumps_index_columns_in_right_order
     index_definition = dump_table_schema("companies").split(/\n/).grep(/t\.index.*company_index/).first.strip
     if current_adapter?(:Mysql2Adapter, :TrilogyAdapter)