Skip to content

Commit cb8fd48

Browse files
committed
Rename CodeStatistics.add_directory to CodeStatistics.register_directory
`register_*` seems a more common pattern in Rails, especially for third party hooks. For example: Rails::SourceAnnotationExtractor::Annotation.register_directories("spec", "another") Other examples: ActionMailer::Base.register_preview_interceptor MimeType.register MimeType.register_alias ActiveModel::Type.register
1 parent c6e3336 commit cb8fd48

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

railties/CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
* Deprecate `::STATS_DIRECTORIES`.
22

33
The global constant `STATS_DIRECTORIES` has been deprecated in favor of
4-
`Rails::CodeStatistics.add_directory`.
4+
`Rails::CodeStatistics.register_directory`.
55

6-
Add extra directories with `Rails::CodeStatistics.add_directory(label, path)`:
6+
Add extra directories with `Rails::CodeStatistics.register_directory(label, path)`:
77

88
```ruby
99
require "rails/code_statistics"
10-
Rails::CodeStatistics.add_directory('My Directory', 'path/to/dir')
10+
Rails::CodeStatistics.register_directory('My Directory', 'path/to/dir')
1111
```
1212

1313
*Petrik de Heus*

railties/lib/rails/code_statistics.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ class CodeStatistics
4646

4747
# Add directories to the output of the `bin/rails stats` command.
4848
#
49-
# Rails::CodeStatistics.add_directory("My Directory", "path/to/dir")
50-
def self.add_directory(label, path)
49+
# Rails::CodeStatistics.register_directory("My Directory", "path/to/dir")
50+
def self.register_directory(label, path)
5151
self.directories << [label, path]
5252
end
5353

railties/lib/rails/tasks/statistics.rake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
require "rails/code_statistics"
44
STATS_DIRECTORIES = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(
55
Rails::CodeStatistics::DIRECTORIES,
6-
"`STATS_DIRECTORIES` is deprecated and will be removed in Rails 8.1! Use `Rails::CodeStatistics.add_directory('My Directory', 'path/to/dir)` instead.",
6+
"`STATS_DIRECTORIES` is deprecated and will be removed in Rails 8.1! Use `Rails::CodeStatistics.register_directory('My Directory', 'path/to/dir)` instead.",
77
Rails.deprecator
88
)
99

railties/test/commands/stats_test.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class Rails::Command::StatsTest < ActiveSupport::TestCase
1313

1414
app_file "config/initializers/custom.rb", <<~CODE
1515
require "rails/code_statistics"
16-
Rails::CodeStatistics.add_directory("Custom dir", "custom/dir")
16+
Rails::CodeStatistics.register_directory("Custom dir", "custom/dir")
1717
CODE
1818

1919
output = rails "stats"
@@ -23,7 +23,7 @@ class Rails::Command::StatsTest < ActiveSupport::TestCase
2323
test "`bin/rails stats` handles non-existing directories added by third parties" do
2424
app_file "config/initializers/custom.rb", <<~CODE
2525
require "rails/code_statistics"
26-
Rails::CodeStatistics.add_directory("Non Existing", "app/non_existing")
26+
Rails::CodeStatistics.register_directory("Non Existing", "app/non_existing")
2727
CODE
2828

2929
output = rails "stats"

0 commit comments

Comments
 (0)