Skip to content

Commit 71f61b1

Browse files
committed
Remove deprecated methods in `Tasks::DatabaseTasks
1 parent 9828cc7 commit 71f61b1

File tree

4 files changed

+32
-117
lines changed

4 files changed

+32
-117
lines changed

activerecord/CHANGELOG.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
* Remove deprecated `Tasks::DatabaseTasks.spec`.
2+
3+
*Rafael Mendonça França*
4+
5+
* Remove deprecated `Tasks::DatabaseTasks.current_config`.
6+
7+
*Rafael Mendonça França*
8+
9+
* Deprecate `Tasks::DatabaseTasks.schema_file_type`.
10+
11+
*Rafael Mendonça França*
12+
13+
* Remove deprecated `Tasks::DatabaseTasks.dump_filename`.
14+
15+
*Rafael Mendonça França*
16+
17+
* Remove deprecated `Tasks::DatabaseTasks.schema_file`.
18+
19+
*Rafael Mendonça França*
20+
121
* Remove deprecated `environment` and `name` arguments from `Tasks::DatabaseTasks.schema_up_to_date?`.
222

323
*Rafael Mendonça França*

activerecord/lib/active_record/tasks/database_tasks.rb

Lines changed: 2 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,7 @@ module DatabaseTasks
5555

5656
extend self
5757

58-
attr_writer :current_config, :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader
59-
deprecate :current_config=
58+
attr_writer :db_dir, :migrations_paths, :fixtures_path, :root, :env, :seed_loader
6059
attr_accessor :database_configuration
6160

6261
LOCAL_HOSTS = ["127.0.0.1", "localhost"]
@@ -110,11 +109,6 @@ def env
110109
@env ||= Rails.env
111110
end
112111

113-
def spec
114-
@spec ||= "primary"
115-
end
116-
deprecate spec: "please use name instead"
117-
118112
def name
119113
@name ||= "primary"
120114
end
@@ -123,18 +117,6 @@ def seed_loader
123117
@seed_loader ||= Rails.application
124118
end
125119

126-
def current_config(options = {})
127-
if options.has_key?(:config)
128-
@current_config = options[:config]
129-
else
130-
env_name = options[:env] || env
131-
name = options[:spec] || "primary"
132-
133-
@current_config ||= configs_for(env_name: env_name, name: name)&.configuration_hash
134-
end
135-
end
136-
deprecate :current_config
137-
138120
def create(configuration, *arguments)
139121
db_config = resolve_configuration(configuration)
140122
database_adapter_for(db_config, *arguments).create
@@ -453,11 +435,6 @@ def dump_schema(db_config, format = ActiveRecord.schema_format) # :nodoc:
453435
end
454436
end
455437

456-
def schema_file(format = ActiveRecord.schema_format)
457-
File.join(db_dir, schema_file_type(format))
458-
end
459-
deprecate :schema_file
460-
461438
def schema_file_type(format = ActiveRecord.schema_format)
462439
case format
463440
when :ruby
@@ -466,18 +443,7 @@ def schema_file_type(format = ActiveRecord.schema_format)
466443
"structure.sql"
467444
end
468445
end
469-
470-
def dump_filename(db_config_name, format = ActiveRecord.schema_format)
471-
ActiveSupport::Deprecation.warn("#dump_filename is deprecated. Please call `schema_dump_path` or call `schema_dump` on the `db_config` directly.")
472-
473-
filename = if ActiveRecord::Base.configurations.primary?(db_config_name)
474-
schema_file_type(format)
475-
else
476-
"#{db_config_name}_#{schema_file_type(format)}"
477-
end
478-
479-
ENV["SCHEMA"] || File.join(ActiveRecord::Tasks::DatabaseTasks.db_dir, filename)
480-
end
446+
deprecate :schema_file_type
481447

482448
def schema_dump_path(db_config, format = ActiveRecord.schema_format)
483449
return ENV["SCHEMA"] if ENV["SCHEMA"]

activerecord/test/cases/tasks/database_tasks_test.rb

Lines changed: 0 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -112,59 +112,6 @@ def test_raises_an_error_if_no_migrations_have_been_made
112112
end
113113
end
114114

115-
class DatabaseTasksCurrentConfigTask < ActiveRecord::TestCase
116-
def test_current_config_set
117-
hash = {}
118-
119-
with_stubbed_configurations do
120-
ActiveRecord::Tasks::DatabaseTasks.current_config(config: hash, env: "production")
121-
122-
assert_equal hash, ActiveRecord::Tasks::DatabaseTasks.current_config(env: "production")
123-
end
124-
end
125-
126-
def test_current_config_read_none_found
127-
with_stubbed_configurations do
128-
config = ActiveRecord::Tasks::DatabaseTasks.current_config(env: "production", spec: "empty")
129-
130-
assert_nil config
131-
end
132-
end
133-
134-
def test_current_config_read_found
135-
with_stubbed_configurations do
136-
config = ActiveRecord::Tasks::DatabaseTasks.current_config(env: "production", spec: "exists")
137-
138-
assert_equal({ database: "my-db" }, config)
139-
end
140-
end
141-
142-
def test_current_config_read_after_set
143-
hash = {}
144-
145-
with_stubbed_configurations do
146-
ActiveRecord::Tasks::DatabaseTasks.current_config(config: hash, env: "production")
147-
148-
config = ActiveRecord::Tasks::DatabaseTasks.current_config(env: "production", spec: "exists")
149-
150-
assert_equal hash, config
151-
end
152-
end
153-
154-
private
155-
def with_stubbed_configurations(&block)
156-
old_configurations = ActiveRecord::Base.configurations
157-
ActiveRecord::Base.configurations = { "production" => { "exists" => { "database" => "my-db" } } }
158-
159-
assert_deprecated(&block)
160-
ensure
161-
ActiveRecord::Base.configurations = old_configurations
162-
assert_deprecated do
163-
ActiveRecord::Tasks::DatabaseTasks.current_config = nil
164-
end
165-
end
166-
end
167-
168115
class DatabaseTasksRegisterTask < ActiveRecord::TestCase
169116
def test_register_task
170117
klazz = Class.new do
@@ -1597,24 +1544,6 @@ class DatabaseTasksCheckSchemaFileMethods < ActiveRecord::TestCase
15971544
@configurations = { "development" => { "database" => "my-db" } }
15981545
end
15991546

1600-
def test_check_schema_file_defaults
1601-
ActiveRecord::Tasks::DatabaseTasks.stub(:db_dir, "/tmp") do
1602-
assert_deprecated do
1603-
assert_equal "/tmp/schema.rb", ActiveRecord::Tasks::DatabaseTasks.schema_file
1604-
end
1605-
end
1606-
end
1607-
1608-
{ ruby: "schema.rb", sql: "structure.sql" }.each_pair do |fmt, filename|
1609-
define_method("test_check_schema_file_for_#{fmt}_format") do
1610-
ActiveRecord::Tasks::DatabaseTasks.stub(:db_dir, "/tmp") do
1611-
assert_deprecated do
1612-
assert_equal "/tmp/#{filename}", ActiveRecord::Tasks::DatabaseTasks.schema_file(fmt)
1613-
end
1614-
end
1615-
end
1616-
end
1617-
16181547
def test_check_dump_filename_defaults
16191548
ActiveRecord::Tasks::DatabaseTasks.stub(:db_dir, "/tmp") do
16201549
with_stubbed_configurations do
@@ -1623,16 +1552,6 @@ def test_check_dump_filename_defaults
16231552
end
16241553
end
16251554

1626-
def test_dump_filename_is_deprecated
1627-
ActiveRecord::Tasks::DatabaseTasks.stub(:db_dir, "/tmp") do
1628-
with_stubbed_configurations do
1629-
assert_deprecated do
1630-
assert_equal "/tmp/schema.rb", ActiveRecord::Tasks::DatabaseTasks.dump_filename(config_for("development", "primary").name)
1631-
end
1632-
end
1633-
end
1634-
end
1635-
16361555
def test_check_dump_filename_with_schema_env
16371556
schema = ENV["SCHEMA"]
16381557
ENV["SCHEMA"] = "schema_path"

guides/source/7_0_release_notes.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,18 @@ Please refer to the [Changelog][active-record] for detailed changes.
141141

142142
* Remove deprecated `environment` and `name` arguments from `Tasks::DatabaseTasks.schema_up_to_date?`.
143143

144+
* Remove deprecated `Tasks::DatabaseTasks.dump_filename`.
145+
146+
* Remove deprecated `Tasks::DatabaseTasks.schema_file`.
147+
148+
* Remove deprecated `Tasks::DatabaseTasks.spec`.
149+
150+
* Remove deprecated `Tasks::DatabaseTasks.current_config`.
151+
144152
### Deprecations
145153

154+
* Deprecated `Tasks::DatabaseTasks.:schema_file_type`.
155+
146156
### Notable changes
147157

148158
* Rollback transactions when the block returns earlier than expected.

0 commit comments

Comments
 (0)