Skip to content

Add guideline for constant definitions in blocks #841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bbatsov merged 1 commit into from
Sep 13, 2020
Merged

Add guideline for constant definitions in blocks #841

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3425,6 +3425,27 @@ class TestClass
end
----

=== Defining Constants within a Block [[no-constant-definition-in-block]]

Do not define constants within a block, since the block's scope does not isolate or namespace the constant in any way.

Define the constant outside of the block instead, or use a variable or method if defining the constant in the outer scope would be problematic.

[source,ruby]
----
# bad - FILES_TO_LINT is now defined globally
task :lint do
FILES_TO_LINT = Dir['lib/*.rb']
# ...
end

# good - files_to_lint is only defined inside the block
task :lint do
files_to_lint = Dir['lib/*.rb']
# ...
end
----

== Classes: Constructors

=== Factory Methods [[factory-methods]]
Expand Down