Skip to content

Commit

Permalink
Merge pull request rails#52706 from p8/railties/stats-register_directory
Browse files Browse the repository at this point in the history
Rename `CodeStatistics.add_directory` to `CodeStatistics.register_directory`
  • Loading branch information
rafaelfranca authored Aug 26, 2024
2 parents d369c19 + cb8fd48 commit 10924d3
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions railties/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
* Deprecate `::STATS_DIRECTORIES`.

The global constant `STATS_DIRECTORIES` has been deprecated in favor of
`Rails::CodeStatistics.add_directory`.
`Rails::CodeStatistics.register_directory`.

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

```ruby
require "rails/code_statistics"
Rails::CodeStatistics.add_directory('My Directory', 'path/to/dir')
Rails::CodeStatistics.register_directory('My Directory', 'path/to/dir')
```

*Petrik de Heus*
Expand Down
4 changes: 2 additions & 2 deletions railties/lib/rails/code_statistics.rb
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ class CodeStatistics

# Add directories to the output of the `bin/rails stats` command.
#
# Rails::CodeStatistics.add_directory("My Directory", "path/to/dir")
def self.add_directory(label, path)
# Rails::CodeStatistics.register_directory("My Directory", "path/to/dir")
def self.register_directory(label, path)
self.directories << [label, path]
end

Expand Down
2 changes: 1 addition & 1 deletion railties/lib/rails/tasks/statistics.rake
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require "rails/code_statistics"
STATS_DIRECTORIES = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(
Rails::CodeStatistics::DIRECTORIES,
"`STATS_DIRECTORIES` is deprecated and will be removed in Rails 8.1! Use `Rails::CodeStatistics.add_directory('My Directory', 'path/to/dir)` instead.",
"`STATS_DIRECTORIES` is deprecated and will be removed in Rails 8.1! Use `Rails::CodeStatistics.register_directory('My Directory', 'path/to/dir)` instead.",
Rails.deprecator
)

Expand Down
4 changes: 2 additions & 2 deletions railties/test/commands/stats_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class Rails::Command::StatsTest < ActiveSupport::TestCase

app_file "config/initializers/custom.rb", <<~CODE
require "rails/code_statistics"
Rails::CodeStatistics.add_directory("Custom dir", "custom/dir")
Rails::CodeStatistics.register_directory("Custom dir", "custom/dir")
CODE

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

output = rails "stats"
Expand Down

0 comments on commit 10924d3

Please sign in to comment.