Merge pull request rails#53459 from zzak/guides-rubocop-stringliterals

Inherit Style/StrigLiterals cop for Guides [ci skip]

Author: rafaelfranca

guides/.rubocop.yml

@@ -1,9 +1,6 @@
 inherit_from:
   - '../.rubocop.yml'
 
-Style/StringLiterals:
-  Enabled: false
-
 Layout/IndentationConsistency:
   Enabled: false
 

guides/source/7_1_release_notes.md

@@ -213,7 +213,7 @@ development:
 Alternatively, integration can be achieved using the `DATABASE_URL` environment variable:
 
 ```ruby
-ENV['DATABASE_URL'] # => "trilogy://localhost/blog_development?pool=5"
+ENV["DATABASE_URL"] # => "trilogy://localhost/blog_development?pool=5"
 ```
 
 ### Add `ActiveSupport::MessagePack`

guides/source/action_cable_overview.md

@@ -136,7 +136,7 @@ session, your session cookie is named `_session` and the user ID key is `user_id
 can use this approach:
 
 ```ruby
-verified_user = User.find_by(id: cookies.encrypted['_session']['user_id'])
+verified_user = User.find_by(id: cookies.encrypted["_session"]["user_id"])
 ```
 
 [`ActionCable::Connection::Base`]: https://api.rubyonrails.org/classes/ActionCable/Connection/Base.html
@@ -238,7 +238,7 @@ specific channel to handle raised exceptions:
 ```ruby
 # app/channels/chat_channel.rb
 class ChatChannel < ApplicationCable::Channel
-  rescue_from 'MyError', with: :deliver_error_message
+  rescue_from "MyError", with: :deliver_error_message
 
   private
     def deliver_error_message(e)
@@ -479,8 +479,8 @@ consumer.subscriptions.create({ channel: "ChatChannel", room: "Best Room" }, {
 ActionCable.server.broadcast(
   "chat_#{room}",
   {
-    sent_by: 'Paul',
-    body: 'This is a cool chat app.'
+    sent_by: "Paul",
+    body: "This is a cool chat app."
   }
 )
 ```
@@ -548,7 +548,7 @@ class AppearanceChannel < ApplicationCable::Channel
   end
 
   def appear(data)
-    current_user.appear(on: data['appearing_on'])
+    current_user.appear(on: data["appearing_on"])
   end
 
   def away
@@ -697,8 +697,8 @@ application:
 # Somewhere in your app this is called, perhaps from a NewCommentJob
 WebNotificationsChannel.broadcast_to(
   current_user,
-  title: 'New things!',
-  body: 'All the news fit to print'
+  title: "New things!",
+  body: "All the news fit to print"
 )
 ```
 
@@ -788,7 +788,7 @@ passed to the server config as an array. The origins can be instances of
 strings or regular expressions, against which a check for the match will be performed.
 
 ```ruby
-config.action_cable.allowed_request_origins = ['https://rubyonrails.com', %r{http://ruby.*}]
+config.action_cable.allowed_request_origins = ["https://rubyonrails.com", %r{http://ruby.*}]
 ```
 
 To disable and allow requests from any origin:
@@ -842,7 +842,7 @@ the user account id if available, else "no-account" while tagging:
 
 ```ruby
 config.action_cable.log_tags = [
-  -> request { request.env['user_account_id'] || "no-account" },
+  -> request { request.env["user_account_id"] || "no-account" },
   :action_cable,
   -> request { request.uuid }
 ]
@@ -866,7 +866,7 @@ listen for WebSocket requests on `/websocket`, specify that path to
 ```ruby
 # config/application.rb
 class Application < Rails::Application
-  config.action_cable.mount_path = '/websocket'
+  config.action_cable.mount_path = "/websocket"
 end
 ```
 

guides/source/action_controller_overview.md

@@ -181,7 +181,7 @@ NOTE: Support for parsing XML parameters has been extracted into a gem named `ac
 The `params` hash will always contain the `:controller` and `:action` keys, but you should use the methods [`controller_name`][] and [`action_name`][] instead to access these values. Any other parameters defined by the routing, such as `:id`, will also be available. As an example, consider a listing of clients where the list can show either active or inactive clients. We can add a route that captures the `:status` parameter in a "pretty" URL:
 
 ```ruby
-get '/clients/:status', to: 'clients#index', foo: 'bar'
+get "/clients/:status", to: "clients#index", foo: "bar"
 ```
 
 In this case, when a user opens the URL `/clients/active`, `params[:status]` will be set to "active". When this route is used, `params[:foo]` will also be set to "bar", as if it were passed in the query string. Your controller will also receive `params[:action]` as "index" and `params[:controller]` as "clients".
@@ -210,7 +210,7 @@ end
 And the following route:
 
 ```ruby
-get '/books/:id', to: 'books#show'
+get "/books/:id", to: "books#show"
 ```
 
 When a user opens the URL `/books/4_2`, the controller will extract the composite
@@ -469,14 +469,14 @@ Rails sets up a session key (the name of the cookie) when signing the session da
 
 ```ruby
 # Be sure to restart your server when you modify this file.
-Rails.application.config.session_store :cookie_store, key: '_your_app_session'
+Rails.application.config.session_store :cookie_store, key: "_your_app_session"
 ```
 
 You can also pass a `:domain` key and specify the domain name for the cookie:
 
 ```ruby
 # Be sure to restart your server when you modify this file.
-Rails.application.config.session_store :cookie_store, key: '_your_app_session', domain: ".example.com"
+Rails.application.config.session_store :cookie_store, key: "_your_app_session", domain: ".example.com"
 ```
 
 Rails sets up (for the CookieStore) a secret key used for signing the session data in `config/credentials.yml.enc`. This can be changed with `bin/rails credentials:edit`.
@@ -702,7 +702,7 @@ into `String`s:
 class CookiesController < ApplicationController
   def set_cookie
     cookies.encrypted[:expiration_date] = Date.tomorrow # => Thu, 20 Mar 2014
-    redirect_to action: 'read_cookie'
+    redirect_to action: "read_cookie"
   end
 
   def read_cookie
@@ -1145,7 +1145,7 @@ class MyController < ActionController::Base
   include ActionController::Live
 
   def stream
-    response.headers['Content-Type'] = 'text/event-stream'
+    response.headers["Content-Type"] = "text/event-stream"
     100.times {
       response.stream.write "hello world\n"
       sleep 1
@@ -1181,7 +1181,7 @@ class LyricsController < ActionController::Base
   include ActionController::Live
 
   def show
-    response.headers['Content-Type'] = 'text/event-stream'
+    response.headers["Content-Type"] = "text/event-stream"
     song = Song.find(params[:id])
 
     song.each do |line|
@@ -1242,13 +1242,13 @@ Sometimes it's desirable to filter out from log files some sensitive locations y
 You can do that by using the `config.filter_redirect` configuration option:
 
 ```ruby
-config.filter_redirect << 's3.amazonaws.com'
+config.filter_redirect << "s3.amazonaws.com"
 ```
 
 You can set it to a String, a Regexp, or an array of both.
 
 ```ruby
-config.filter_redirect.concat ['s3.amazonaws.com', /private_path/]
+config.filter_redirect.concat ["s3.amazonaws.com", /private_path/]
 ```
 
 Matching URLs will be replaced with '[FILTERED]'. However, if you only wish to filter the parameters, not the whole URLs,

guides/source/action_mailbox_basics.md

@@ -478,7 +478,7 @@ class ForwardsMailboxTest < ActionMailbox::TestCase
   test "directly recording a client forward for a forwarder and forwardee corresponding to one project" do
     assert_difference -> { people(:david).buckets.first.recordings.count } do
       receive_inbound_email_from_mail \
-        to: '[email protected]',
+        to: "[email protected]",
         from: people(:david).email_address,
         subject: "Fwd: Status update?",
         body: <<~BODY

guides/source/action_mailer_basics.md

@@ -71,7 +71,7 @@ used to define attributes common to all Mailers:
 # app/mailers/application_mailer.rb
 class ApplicationMailer < ActionMailer::Base
   default from: "[email protected]"
-  layout 'mailer'
+  layout "mailer"
 end
 ```
 
@@ -360,7 +360,7 @@ Action Mailer will automatically guess the `mime_type`, set the `encoding`, and
 create the attachment.
 
 ```ruby
-attachments['filename.jpg'] = File.read('/path/to/filename.jpg')
+attachments["filename.jpg"] = File.read("/path/to/filename.jpg")
 ```
 
 When the `mail` method is triggered, it will send a multipart email with an
@@ -372,10 +372,10 @@ The other way to send attachments is to specify the file name, MIME-type and
 encoding headers, and content. Action Mailer will use the settings you pass in.
 
 ```ruby
-encoded_content = SpecialEncode(File.read('/path/to/filename.jpg'))
-attachments['filename.jpg'] = {
-  mime_type: 'application/gzip',
-  encoding: 'SpecialEncoding',
+encoded_content = SpecialEncode(File.read("/path/to/filename.jpg"))
+attachments["filename.jpg"] = {
+  mime_type: "application/gzip",
+  encoding: "SpecialEncoding",
   content: encoded_content
 }
 ```
@@ -395,7 +395,7 @@ calling `#inline`:
 
 ```ruby
 def welcome
-  attachments.inline['image.jpg'] = File.read('/path/to/image.jpg')
+  attachments.inline["image.jpg"] = File.read("/path/to/image.jpg")
 end
 ```
 
@@ -461,15 +461,15 @@ There is a `template_path` and `template_name` option to the `mail` method:
 
 ```ruby
 class UserMailer < ApplicationMailer
-  default from: '[email protected]'
+  default from: "[email protected]"
 
   def welcome_email
     @user = params[:user]
-    @url  = 'http://example.com/login'
+    @url  = "http://example.com/login"
     mail(to: @user.email,
-         subject: 'Welcome to My Awesome Site',
-         template_path: 'notifications',
-         template_name: 'hello')
+         subject: "Welcome to My Awesome Site",
+         template_path: "notifications",
+         template_name: "hello")
   end
 end
 ```
@@ -483,15 +483,15 @@ template. You can also render plain text inline without using a template file:
 
 ```ruby
 class UserMailer < ApplicationMailer
-  default from: '[email protected]'
+  default from: "[email protected]"
 
   def welcome_email
     @user = params[:user]
-    @url  = 'http://example.com/login'
+    @url  = "http://example.com/login"
     mail(to: @user.email,
-         subject: 'Welcome to My Awesome Site') do |format|
-      format.html { render 'another_template' }
-      format.text { render plain: 'hello' }
+         subject: "Welcome to My Awesome Site") do |format|
+      format.html { render "another_template" }
+      format.text { render plain: "hello" }
     end
   end
 end
@@ -535,7 +535,7 @@ You can configure the default `host` across the application in
 `config/application.rb`:
 
 ```ruby
-config.action_mailer.default_url_options = { host: 'example.com' }
+config.action_mailer.default_url_options = { host: "example.com" }
 ```
 
 Once the `host` is configured, it is recommended that email views use the
@@ -595,7 +595,7 @@ Usually the `:asset_host` is consistent across the application, so you can
 configure it globally in `config/application.rb`:
 
 ```ruby
-config.action_mailer.asset_host = 'http://example.com'
+config.action_mailer.asset_host = "http://example.com"
 ```
 
 NOTE: Because we can't infer the protocol from the request, you'll need to
@@ -662,7 +662,7 @@ To use a different layout for a given mailer, call [`layout`][]:
 
 ```ruby
 class UserMailer < ApplicationMailer
-  layout 'awesome' # Use awesome.(html|text).erb as the layout
+  layout "awesome" # Use awesome.(html|text).erb as the layout
 end
 ```
 
@@ -673,7 +673,7 @@ To use a specific layout for a given email, you can pass in a `layout:
 class UserMailer < ApplicationMailer
   def welcome_email
     mail(to: params[:user].email) do |format|
-      format.html { render layout: 'my_layout' }
+      format.html { render layout: "my_layout" }
       format.text
     end
   end
@@ -700,7 +700,7 @@ For example, to inform all admins of a new registration:
 ```ruby
 class AdminMailer < ApplicationMailer
   default to: -> { Admin.pluck(:email) },
-          from: '[email protected]'
+          from: "[email protected]"
 
   def new_registration(user)
     @user = user
@@ -726,7 +726,7 @@ def welcome_email
   @user = params[:user]
   mail(
     to: email_address_with_name(@user.email, @user.name),
-    subject: 'Welcome to My Awesome Site'
+    subject: "Welcome to My Awesome Site"
   )
 end
 ```
@@ -735,7 +735,7 @@ The same method in `from:` works to display the name of the sender:
 
 ```ruby
 class UserMailer < ApplicationMailer
-  default from: email_address_with_name('[email protected]', 'Example Company Notifications')
+  default from: email_address_with_name("[email protected]", "Example Company Notifications")
 end
 ```
 
@@ -904,7 +904,7 @@ class UserMailer < ApplicationMailer
 
     # An Interceptor alternative.
     def sandbox_staging
-      message.to = ['[email protected]'] if Rails.env.staging?
+      message.to = ["[email protected]"] if Rails.env.staging?
     end
 
     # A callback has more context than the comparable Observer example.
@@ -976,7 +976,7 @@ config.action_mailer.delivery_method = :sendmail
 # }
 config.action_mailer.perform_deliveries = true
 config.action_mailer.raise_delivery_errors = true
-config.action_mailer.default_options = { from: '[email protected]' }
+config.action_mailer.default_options = { from: "[email protected]" }
 ```
 
 ### Action Mailer Configuration for Gmail
@@ -986,12 +986,12 @@ Add this to your `config/environments/$RAILS_ENV.rb` file to send via Gmail:
 ```ruby
 config.action_mailer.delivery_method = :smtp
 config.action_mailer.smtp_settings = {
-  address:         'smtp.gmail.com',
+  address:         "smtp.gmail.com",
   port:            587,
-  domain:          'example.com',
+  domain:          "example.com",
   user_name:       Rails.application.credentials.dig(:smtp, :user_name),
   password:        Rails.application.credentials.dig(:smtp, :password),
-  authentication:  'plain',
+  authentication:  "plain",
   enable_starttls: true,
   open_timeout:    5,
   read_timeout:    5 }
@@ -1084,7 +1084,7 @@ sent.
 ```ruby
 class SandboxEmailInterceptor
   def self.delivering_email(message)
-    message.to = ['[email protected]']
+    message.to = ["[email protected]"]
   end
 end
 ```

guides/source/action_view_overview.md

@@ -790,7 +790,7 @@ Let's say you're displaying an article on a page which should be wrapped in a
 `div` for display purposes. First, you'll create a new `Article`:
 
 ```ruby
-Article.create(body: 'Partial Layouts are cool!')
+Article.create(body: "Partial Layouts are cool!")
 ```
 
 In the `show` template, you'll render the `_article` partial wrapped in the

guides/source/active_job_basics.md

@@ -119,7 +119,7 @@ GuestsCleanupJob.set(wait: 1.week).perform_later(guest)
 ```ruby
 # `perform_now` and `perform_later` will call `perform` under the hood so
 # you can pass as many arguments as defined in the latter.
-GuestsCleanupJob.perform_later(guest1, guest2, filter: 'some_filter')
+GuestsCleanupJob.perform_later(guest1, guest2, filter: "some_filter")
 ```
 
 That's it!
@@ -255,7 +255,7 @@ The default queue name prefix delimiter is '\_'.  This can be changed by setting
 module YourApp
   class Application < Rails::Application
     config.active_job.queue_name_prefix = Rails.env
-    config.active_job.queue_name_delimiter = '.'
+    config.active_job.queue_name_delimiter = "."
   end
 end
 ```