[ci skip] change all instances of blacklist and whitelist to denylist… #33681

minaslater · 2018-08-22T02:40:58Z

… and allowlist

Summary

Per DHH, changed occurrence of "blacklist" to "denylist" and "whitelist" to "allowlist" in Rails documentation files. This pull request closes this issue.

Other Information

Adhering to information from the contribution guidelines re: documentation changes, only files in rails/guides/source were changed.

Finally, if your pull request affects documentation or any non-code
changes, guidelines for those changes are available
here

Thanks for contributing to Rails!

… and allowlist

justizin

There's no reason to believe they wouldn't, but a reading of this change shows that the grammar and code examples don't functionally change.

rafaelfranca

Thank you so much for working on this. I totally agree with the reasons for changing those terms.

I think we can improve most of those texts with different words than allowedlist. I made some comments with suggestions but I didn't got to review the whole patch with suggestion to avoid put a lot of comments.

Can you review the changes to make the text to look more fluid?

rafaelfranca · 2018-08-22T03:52:52Z

guides/source/4_0_release_notes.md

@@ -70,7 +70,7 @@ Major Features

 ### ActionPack

-* **Strong parameters** ([commit](https://github.com/rails/rails/commit/a8f6d5c6450a7fe058348a7f10a908352bb6c7fc)) - Only allow whitelisted parameters to update model objects (`params.permit(:title, :text)`).
+* **Strong parameters** ([commit](https://github.com/rails/rails/commit/a8f6d5c6450a7fe058348a7f10a908352bb6c7fc)) - Only allow allowlisted parameters to update model objects (`params.permit(:title, :text)`).


Maybe: Only allow trusted parameters to updated model objects?

rafaelfranca · 2018-08-22T03:54:15Z

guides/source/4_1_release_notes.md

@@ -719,7 +719,7 @@ for detailed changes.
 responsibilities within a
 class. ([Commit](https://github.com/rails/rails/commit/1eee0ca6de975b42524105a59e0521d18b38ab81))

-* Added `Object#presence_in` to simplify value whitelisting.
+* Added `Object#presence_in` to simplify value allowlisting.


"allowing values" maybe?

rafaelfranca · 2018-08-22T03:54:46Z

guides/source/action_controller_overview.md

@@ -193,7 +193,7 @@ In a given request, the method is not actually called for every single generated

 With strong parameters, Action Controller parameters are forbidden to
 be used in Active Model mass assignments until they have been
-whitelisted. This means that you'll have to make a conscious decision about
+allowlisted. This means that you'll have to make a conscious decision about


"allowed" seems better here.

rafaelfranca · 2018-08-22T03:55:37Z

guides/source/action_controller_overview.md

@@ -269,7 +269,7 @@ but be careful because this opens the door to arbitrary input. In this
 case, `permit` ensures values in the returned structure are permitted
 scalars and filters out anything else.

-To whitelist an entire hash of parameters, the `permit!` method can be
+To allowlist an entire hash of parameters, the `permit!` method can be


rafaelfranca · 2018-08-22T03:55:50Z

guides/source/action_controller_overview.md

@@ -291,7 +291,7 @@ params.permit(:name, { emails: [] },
 { family: [ :name ], hobbies: [] }])
 ```

-This declaration whitelists the `name`, `emails`, and `friends`
+This declaration allowlists the `name`, `emails`, and `friends`


rafaelfranca · 2018-08-22T03:57:35Z

guides/source/configuring.md

@@ -275,7 +275,7 @@ config.middleware.delete Rack::MethodOverride

 All these configuration options are delegated to the `I18n` library.

-* `config.i18n.available_locales` whitelists the available locales for the app. Defaults to all locale keys found in locale files, usually only `:en` on a new application.
+* `config.i18n.available_locales` allowlists the available locales for the app. Defaults to all locale keys found in locale files, usually only `:en` on a new application.


rafaelfranca · 2018-08-22T03:57:47Z

guides/source/configuring.md

@@ -444,7 +444,7 @@ The schema dumper adds two additional configuration options:

 * `config.action_controller.action_on_unpermitted_parameters` enables logging or raising an exception if parameters that are not explicitly permitted are found. Set to `:log` or `:raise` to enable. The default value is `:log` in development and test environments, and `false` in all other environments.

-* `config.action_controller.always_permitted_parameters` sets a list of whitelisted parameters that are permitted by default. The default values are `['controller', 'action']`.
+* `config.action_controller.always_permitted_parameters` sets a list of allowlisted parameters that are permitted by default. The default values are `['controller', 'action']`.


rafaelfranca · 2018-08-22T03:59:04Z

guides/source/debugging_rails_applications.md

@@ -888,7 +888,7 @@ do that with `local_variables`.

 ### Settings

-* `config.web_console.whitelisted_ips`: Authorized list of IPv4 or IPv6
+* `config.web_console.allowlisted_ips`: Authorized list of IPv4 or IPv6


This one we can't change without changing the web_console too and allowed_ips sounds better.

rafaelfranca · 2018-08-22T03:59:54Z

guides/source/form_helpers.md

@@ -999,7 +999,7 @@ remove addresses:
 <% end %>
 ```

-Don't forget to update the whitelisted params in your controller to also include
+Don't forget to update the allowlisted params in your controller to also include


rafaelfranca · 2018-08-22T04:00:07Z

guides/source/form_helpers.md

@@ -953,7 +953,7 @@ If the associated object is already saved, `fields_for` autogenerates a hidden i
 ### The Controller

 As usual you need to
-[whitelist the parameters](action_controller_overview.html#strong-parameters) in
+[allowlist the parameters](action_controller_overview.html#strong-parameters) in


allow maybe?

minaslater · 2018-08-22T12:40:38Z

@rafaelfranca Thanks for combing through for those awkward grammar. I've fixed all of them, mostly with your suggestion in the new commit.

…e word allowlist

yskkin · 2018-08-22T12:52:51Z

guides/source/upgrading_ruby_on_rails.md

@@ -1200,7 +1200,7 @@ to the database as `NULL` instead of passing the `nil` value through YAML (`"---
 * Rails 4.0 has removed `attr_accessible` and `attr_protected` feature in favor of Strong Parameters. You can use the [Protected Attributes gem](https://github.com/rails/protected_attributes) for a smooth upgrade path.

 * If you are not using Protected Attributes, you can remove any options related to
-this gem such as `whitelist_attributes` or `mass_assignment_sanitizer` options.
+this gem such as `allowlist_attributes` or `mass_assignment_sanitizer` options.


I guess we cannot change this unless we change Protected Attributes gem.

huysentruitw · 2018-08-22T15:58:41Z

guides/source/form_helpers.md

@@ -999,7 +999,7 @@ remove addresses:
 <% end %>
 ```

-Don't forget to update the whitelisted params in your controller to also include
+Don't forget to update the permitted params in your controller to also include


By renaming whitelist to a mixture of:

permitted

allowed

trusted

we're only creating more confusion.

I think we could reword this to consistently use "permit" or "permitted".

@tenderlove Roger that.

tenderlove

I added some comments. I really like this change, but I think we should try to consistently use "permitted" (consistency should help people reading the docs, plus it shares the name of the method). "Denylist" seems kind of awkward, but I'm having a hard time thinking of an antonym for "permit" besides "deny". 😊

tenderlove · 2018-08-22T18:48:40Z

guides/source/action_controller_overview.md

@@ -193,7 +193,7 @@ In a given request, the method is not actually called for every single generated

 With strong parameters, Action Controller parameters are forbidden to
 be used in Active Model mass assignments until they have been
-whitelisted. This means that you'll have to make a conscious decision about
+allowed. This means that you'll have to make a conscious decision about


This should probably be "what is allowed" (or "what is permitted")

"...until they have been what is permitted." doesn't seem to make sense. 🤔

tenderlove · 2018-08-22T18:51:47Z

guides/source/action_controller_overview.md

@@ -241,7 +241,7 @@ Given
 params.permit(:id)
 ```

-the key `:id` will pass the whitelisting if it appears in `params` and
+the key `:id` will pass the allowlisting if it appears in `params` and


the key :id will be permitted if it appears in params and

or possibly

the key :id will be permitted for inclusion if it appears in params and

tenderlove · 2018-08-22T18:52:59Z

guides/source/action_controller_overview.md

@@ -349,7 +349,7 @@ end

 The strong parameter API was designed with the most common use cases
 in mind. It is not meant as a silver bullet to handle all of your
-whitelisting problems. However, you can easily mix the API with your
+allowlisting problems. However, you can easily mix the API with your


parameter filtering problems.

tenderlove · 2018-08-22T18:54:37Z

guides/source/getting_started.md

-assignment. In this case, we want to both allow and require the `title` and
-`text` parameters for valid use of `create`. The syntax for this introduces
-`require` and `permit`. The change will involve one line in the `create` action:
+We have to define our permitted controller parameters to prevent wrongful mass assignment. In this case, we want to both allow and require the `title` and `text` parameters for valid use of `create`. The syntax for this introduces `require` and `permit`. The change will involve one line in the `create` action:


I think this paragraph needs to be wrapped

tenderlove · 2018-08-22T18:54:58Z

guides/source/i18n.md

@@ -77,8 +77,8 @@ There are also attribute readers and writers for the following attributes:
 load_path # Announce your custom translation files
 locale # Get and set the current locale
 default_locale # Get and set the default locale
-available_locales # Whitelist locales available for the application
-enforce_available_locales # Enforce locale whitelisting (true or false)
+available_locales # Allowlist locales available for the application


s/Allowlist/Permitted/

tenderlove · 2018-08-22T18:55:14Z

guides/source/i18n.md

@@ -128,7 +128,7 @@ The load path must be specified before any translations are looked up. To change
 # Where the I18n library should search for translation files
 I18n.load_path += Dir[Rails.root.join('lib', 'locale', '*.{rb,yml}')]

-# Whitelist locales available for the application
+# Allowlist locales available for the application


s/Allowlist/Permitted/

minaslater · 2018-08-22T19:06:29Z

@tenderlove How do you feel about "restricted list" or "restrict" as an alternative?

tenderlove · 2018-08-23T00:46:13Z

@tenderlove How do you feel about "restricted list" or "restrict" as an alternative?

Sounds good to me! 😄

…restricted list and consistently use permitted

### Summary Follow up rubocop#6464, rubocop#6466, and rubocop#6467. This PR changes a terminology from `Whitelist` and `Blacklist` to `Allowlist` and `Denylist`. This change is an obvious breaking change to some cop options. So I'd like to introduce it before RuboCop 1.0 if this change is acceptable. ### Other Information This change has also been made in Rails repository and other repos. rails/rails#33681

### Summary Follow up #6464, #6466, and #6467. This PR changes a terminology from `Whitelist` and `Blacklist` to `Allowlist` and `Denylist`. This change is an obvious breaking change to some cop options. So I'd like to introduce it before RuboCop 1.0 if this change is acceptable. ### Other Information This change has also been made in Rails repository and other repos. rails/rails#33681

Use terminology which is more descriptive and is consistent with the direction of some upstream libraries: rubocop/rubocop#6467 rails/rails#33681

[ci skip] change all instances of blacklist and whitelist to denylist…

44da9eb

… and allowlist

justizin approved these changes Aug 22, 2018

View reviewed changes

rafaelfranca reviewed Aug 22, 2018

View reviewed changes

[ci skip] fixes awkward grammar

7bdf43d

[ci skip] fixes a few more grammar issues, changing a to an before th…

58b7837

…e word allowlist

yskkin reviewed Aug 22, 2018

View reviewed changes

[ci skip] revert terminology related to syntax

0292a37

huysentruitw reviewed Aug 22, 2018

View reviewed changes

tenderlove approved these changes Aug 22, 2018

View reviewed changes

[ci skip] corrects more grammar awkwardness, replacing denylist with …

f1d647a

…restricted list and consistently use permitted

guilleiguaran approved these changes Aug 23, 2018

View reviewed changes

tiegz mentioned this pull request Aug 23, 2018

Issue #33677: Replace use of whitelist with allowlist and blacklist with denylist #33678

Closed

rafaelfranca approved these changes Aug 23, 2018

View reviewed changes

tenderlove merged commit de6a200 into rails:master Aug 23, 2018

wadetandy mentioned this pull request Aug 24, 2018

Accomodate JSON, Array, escaped string params graphiti-api/graphiti_old_archived#10

Merged

kddnewton mentioned this pull request Aug 24, 2018

Finish converting whitelist and blacklist references #33718

Merged

koic mentioned this pull request Oct 29, 2019

Change terminology to Allowlist and Denylist rubocop/rubocop#7469

Merged

8 tasks

johnsyweb mentioned this pull request Jun 7, 2020

Is it time to change the name? rubocop/rubocop#8091

Closed

jcoyne mentioned this pull request Jun 23, 2020

Change terminology to ForbiddenMethods and AllowedMethods rubocop/rubocop-rails#265

Merged

JuanitoFatas mentioned this pull request Jul 1, 2020

HTML::Pipeline 3.0 gjtorikian/html-pipeline#334

Closed

caiangums mentioned this pull request Jun 18, 2021

[Suggestion] Change from white/black to a more inclusive language (allow/block?) goatandsheep/react-native-dotenv#182

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ci skip] change all instances of blacklist and whitelist to denylist… #33681

[ci skip] change all instances of blacklist and whitelist to denylist… #33681

minaslater commented Aug 22, 2018 •

edited

Loading

justizin left a comment •

edited

Loading

rafaelfranca left a comment

rafaelfranca Aug 22, 2018

rafaelfranca Aug 22, 2018

rafaelfranca Aug 22, 2018

rafaelfranca Aug 22, 2018

rafaelfranca Aug 22, 2018

rafaelfranca Aug 22, 2018

rafaelfranca Aug 22, 2018

rafaelfranca Aug 22, 2018

rafaelfranca Aug 22, 2018

rafaelfranca Aug 22, 2018

minaslater commented Aug 22, 2018

yskkin Aug 22, 2018

huysentruitw Aug 22, 2018 •

edited

Loading

tenderlove Aug 22, 2018

minaslater Aug 22, 2018

tenderlove left a comment

tenderlove Aug 22, 2018

minaslater Aug 23, 2018

tenderlove Aug 22, 2018

tenderlove Aug 22, 2018

tenderlove Aug 22, 2018

tenderlove Aug 22, 2018

tenderlove Aug 22, 2018

minaslater commented Aug 22, 2018

tenderlove commented Aug 23, 2018

[ci skip] change all instances of blacklist and whitelist to denylist… #33681

[ci skip] change all instances of blacklist and whitelist to denylist… #33681

Conversation

minaslater commented Aug 22, 2018 • edited Loading

Summary

Other Information

justizin left a comment • edited Loading

Choose a reason for hiding this comment

rafaelfranca left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

minaslater commented Aug 22, 2018

Choose a reason for hiding this comment

huysentruitw Aug 22, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tenderlove left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

minaslater commented Aug 22, 2018

tenderlove commented Aug 23, 2018

minaslater commented Aug 22, 2018 •

edited

Loading

justizin left a comment •

edited

Loading

huysentruitw Aug 22, 2018 •

edited

Loading