aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTim Petricola <tim.petricola@gmail.com>2016-07-01 11:24:12 +0200
committerTim Petricola <tim.petricola@gmail.com>2016-08-17 10:09:34 +0200
commitdde3bdf214e7376cb2fccf0068da340efa06ec28 (patch)
treed7854016d24daf32ce36074a21854ecc89127388
parent6eee67318483c64bd864dc845550f27d45fa984c (diff)
downloadrails-dde3bdf214e7376cb2fccf0068da340efa06ec28.tar.gz
rails-dde3bdf214e7376cb2fccf0068da340efa06ec28.tar.bz2
rails-dde3bdf214e7376cb2fccf0068da340efa06ec28.zip
Option not to line up column types and attributes in schema.rb
-rw-r--r--activerecord/CHANGELOG.md12
-rw-r--r--activerecord/lib/active_record/schema_dumper.rb48
-rw-r--r--activerecord/test/cases/schema_dumper_test.rb78
-rw-r--r--guides/source/configuring.md4
4 files changed, 128 insertions, 14 deletions
diff --git a/activerecord/CHANGELOG.md b/activerecord/CHANGELOG.md
index 6b996fd6bd..87e31813aa 100644
--- a/activerecord/CHANGELOG.md
+++ b/activerecord/CHANGELOG.md
@@ -1,3 +1,9 @@
+* Option to remove standardized column types/arguments spaces in schema dump
+ with `ActiveRecord::SchemaDumper.standardized_argument_widths` and
+ `ActiveRecord::SchemaDumper.standardized_type_widths` methods.
+
+ *Tim Petricola*
+
* Doing count on relations that contain LEFT OUTER JOIN Arel node no longer
force a DISTINCT. This solves issues when using count after a left_joins.
@@ -57,8 +63,8 @@
*Xavier Noria*
* Using `group` with an attribute that has a custom type will properly cast
- the hash keys after calling a calculation method like `count`.
-
+ the hash keys after calling a calculation method like `count`.
+
Fixes #25595.
*Sean Griffin*
@@ -93,7 +99,7 @@
*Sean Griffin*
* Ensure hashes can be assigned to attributes created using `composed_of`.
-
+
Fixes #25210.
*Sean Griffin*
diff --git a/activerecord/lib/active_record/schema_dumper.rb b/activerecord/lib/active_record/schema_dumper.rb
index 01f788a424..be74922453 100644
--- a/activerecord/lib/active_record/schema_dumper.rb
+++ b/activerecord/lib/active_record/schema_dumper.rb
@@ -16,6 +16,22 @@ module ActiveRecord
cattr_accessor :ignore_tables
@@ignore_tables = []
+ ##
+ # :singleton-method:
+ # Define whether column arguments are lined up in dump.
+ # Acceptable values are true or false.
+ # This setting is only used if ActiveRecord::Base.schema_format == :ruby
+ cattr_accessor :standardized_argument_widths
+ @@standardized_argument_widths = true
+
+ ##
+ # :singleton-method:
+ # Define whether columns types are lined up in dump.
+ # Acceptable values are true or false.
+ # This setting is only used if ActiveRecord::Base.schema_format == :ruby
+ cattr_accessor :standardized_type_widths
+ @@standardized_type_widths = true
+
class << self
def dump(connection=ActiveRecord::Base.connection, stream=STDOUT, config = ActiveRecord::Base)
new(connection, generate_options(config)).dump(stream)
@@ -146,20 +162,32 @@ HEADER
keys = @connection.migration_keys
# figure out the lengths for each column based on above keys
- lengths = keys.map { |key|
- column_specs.map { |spec|
- spec[key] ? spec[key].length + 2 : 0
- }.max
- }
+ lengths = if standardized_argument_widths
+ keys.map { |key|
+ column_specs.map { |spec|
+ spec[key] ? spec[key].length + 2 : 0
+ }.max
+ }
+ else
+ [0] * keys.length
+ end
# the string we're going to sprintf our values against, with standardized column widths
- format_string = lengths.map { |len| "%-#{len}s" }
-
- # find the max length for the 'type' column, which is special
- type_length = column_specs.map { |column| column[:type].length }.max
+ format_string = if standardized_argument_widths
+ lengths.map { |len| "%-#{len}s" }
+ else
+ ["%s"] * keys.length
+ end
# add column type definition to our format string
- format_string.unshift " t.%-#{type_length}s "
+ if standardized_type_widths
+ # find the max length for the 'type' column, which is special
+ type_length = column_specs.map { |column| column[:type].length }.max
+
+ format_string.unshift " t.%-#{type_length}s "
+ else
+ format_string.unshift " t.%s "
+ end
format_string *= ""
diff --git a/activerecord/test/cases/schema_dumper_test.rb b/activerecord/test/cases/schema_dumper_test.rb
index 33baf84ef2..23cfe46d7f 100644
--- a/activerecord/test/cases/schema_dumper_test.rb
+++ b/activerecord/test/cases/schema_dumper_test.rb
@@ -442,3 +442,81 @@ class SchemaDumperDefaultsTest < ActiveRecord::TestCase
assert_match %r{t\.time\s+"time_with_default",\s+default: '2000-01-01 07:17:04'}, output
end
end
+
+class SchemaDumperNoStandardizedArgumentWidthsTest < ActiveRecord::TestCase
+ include SchemaDumpingHelper
+
+ setup do
+ ActiveRecord::SchemaDumper.standardized_argument_widths = false
+ ActiveRecord::SchemaMigration.create_table
+ end
+
+ teardown do
+ ActiveRecord::SchemaDumper.standardized_argument_widths = true
+ end
+
+ def standard_dump
+ @@standard_dump ||= perform_schema_dump
+ end
+
+ def perform_schema_dump
+ dump_all_table_schema []
+ end
+
+ def assert_no_line_up(lines, pattern)
+ return assert(true) if lines.empty?
+ matches = lines.map { |line| line.match(pattern) }
+ matches.compact!
+ return assert(true) if matches.empty?
+ line_matches = lines.map { |line| [line, line.match(pattern)] }.select { |line, match| match }
+ assert line_matches.all? { |line, match|
+ start = match.offset(0).first
+ line[start - 2..start - 1] == ", "
+ }
+ end
+
+ def column_definition_lines(output = standard_dump)
+ output.scan(/^( *)create_table.*?\n(.*?)^\1end/m).map { |m| m.last.split(/\n/) }
+ end
+
+ def test_arguments_no_line_up
+ column_definition_lines.each do |column_set|
+ assert_no_line_up(column_set, /default: /)
+ assert_no_line_up(column_set, /limit: /)
+ assert_no_line_up(column_set, /null: /)
+ end
+ end
+end
+
+class SchemaDumperNoStandardizedTypeWidthsTest < ActiveRecord::TestCase
+ include SchemaDumpingHelper
+
+ setup do
+ ActiveRecord::SchemaDumper.standardized_type_widths = false
+ ActiveRecord::SchemaMigration.create_table
+ end
+
+ teardown do
+ ActiveRecord::SchemaDumper.standardized_type_widths = true
+ end
+
+ def standard_dump
+ @@standard_dump ||= perform_schema_dump
+ end
+
+ def perform_schema_dump
+ dump_all_table_schema []
+ end
+
+ def column_definition_lines(output = standard_dump)
+ output.scan(/^( *)create_table.*?\n(.*?)^\1end/m).map { |m| m.last.split(/\n/) }
+ end
+
+ def test_types_no_line_up
+ column_definition_lines.each do |column_set|
+ next if column_set.empty?
+
+ assert column_set.all? { |column| !column.match(/\bt\.\w+\s{2,}/) }
+ end
+ end
+end
diff --git a/guides/source/configuring.md b/guides/source/configuring.md
index 7239105b29..3e27dfafa0 100644
--- a/guides/source/configuring.md
+++ b/guides/source/configuring.md
@@ -368,9 +368,11 @@ The MySQL adapter adds one additional configuration option:
* `ActiveRecord::ConnectionAdapters::Mysql2Adapter.emulate_booleans` controls whether Active Record will consider all `tinyint(1)` columns as booleans. Defaults to `true`.
-The schema dumper adds one additional configuration option:
+The schema dumper adds additional configuration options:
* `ActiveRecord::SchemaDumper.ignore_tables` accepts an array of tables that should _not_ be included in any generated schema file. This setting is ignored unless `config.active_record.schema_format == :ruby`.
+* `ActiveRecord::SchemaDumper.standardized_argument_widths` configures whether colum arguments should be lined up or not in dump. By default this is `true`. This setting is ignored unless `config.active_record.schema_format == :ruby`.
+* `ActiveRecord::SchemaDumper.standardized_type_widths` configures whether colum types should be lined up or not in dump. By default this is `true`. This setting is ignored unless `config.active_record.schema_format == :ruby`.
### Configuring Action Controller