Merge pull request rails#49824 from byroot/single-quote-in-doc-and-errors

byroot · web-flow · commit e74179654241 · 2023-10-28T11:50:31.000+02:00
Use double quotes more consistenly in doc and error messages
diff --git a/actionpack/lib/action_controller/template_assertions.rb b/actionpack/lib/action_controller/template_assertions.rb
@@ -4,8 +4,8 @@ module ActionController
   module TemplateAssertions # :nodoc:
     def assert_template(options = {}, message = nil)
       raise NoMethodError,
-        "assert_template has been extracted to a gem. To continue using it,
-        add `gem 'rails-controller-testing'` to your Gemfile."
+        'assert_template has been extracted to a gem. To continue using it,
+        add `gem "rails-controller-testing"` to your Gemfile.'
     end
   end
 end
diff --git a/actionpack/lib/action_dispatch/middleware/templates/rescues/_source.html.erb b/actionpack/lib/action_dispatch/middleware/templates/rescues/_source.html.erb
@@ -29,7 +29,7 @@
         </table>
       </div>
       <%- unless self.error_highlight_available? -%>
-        <p class="error_highlight_tip">Tip: You may want to add <code>gem 'error_highlight', '&gt;= 0.4.0'</code> into your Gemfile, which will display the fine-grained error location.</p>
+        <p class="error_highlight_tip">Tip: You may want to add <code>gem "error_highlight", "&gt;= 0.4.0"</code> into your Gemfile, which will display the fine-grained error location.</p>
       <%- end -%>
     </div>
   <% end %>
diff --git a/actionpack/lib/action_dispatch/testing/test_process.rb b/actionpack/lib/action_dispatch/testing/test_process.rb
@@ -30,8 +30,8 @@ def file_fixture_upload(path, mime_type = nil, binary = false)
 
     def assigns(key = nil)
       raise NoMethodError,
-        "assigns has been extracted to a gem. To continue using it,
-        add `gem 'rails-controller-testing'` to your Gemfile."
+        'assigns has been extracted to a gem. To continue using it,
+        add `gem "rails-controller-testing"` to your Gemfile.'
     end
 
     def session
diff --git a/activemodel/lib/active_model/secure_password.rb b/activemodel/lib/active_model/secure_password.rb
@@ -41,7 +41,7 @@ module ClassMethods
       #
       # To use +has_secure_password+, add bcrypt (~> 3.1.7) to your Gemfile:
       #
-      #   gem 'bcrypt', '~> 3.1.7'
+      #   gem "bcrypt", "~> 3.1.7"
       #
       # ==== Examples
       #
diff --git a/activestorage/lib/active_storage/transformers/image_processing_transformer.rb b/activestorage/lib/active_storage/transformers/image_processing_transformer.rb
@@ -5,7 +5,7 @@
 rescue LoadError
   raise LoadError, <<~ERROR.squish
     Generating image variants require the image_processing gem.
-    Please add `gem 'image_processing', '~> 1.2'` to your Gemfile.
+    Please add `gem "image_processing", "~> 1.2"` to your Gemfile.
   ERROR
 end
 
diff --git a/activesupport/lib/active_support/railtie.rb b/activesupport/lib/active_support/railtie.rb
@@ -89,7 +89,7 @@ class Railtie < Rails::Railtie # :nodoc:
       begin
         TZInfo::DataSource.get
       rescue TZInfo::DataSourceNotFound => e
-        raise e.exception "tzinfo-data is not present. Please add gem 'tzinfo-data' to your Gemfile and run bundle install"
+        raise e.exception('tzinfo-data is not present. Please add gem "tzinfo-data" to your Gemfile and run bundle install')
       end
       require "active_support/core_ext/time/zones"
       Time.zone_default = Time.find_zone!(app.config.time_zone)
diff --git a/activesupport/lib/active_support/xml_mini.rb b/activesupport/lib/active_support/xml_mini.rb
@@ -12,7 +12,7 @@ module ActiveSupport
   # = \XmlMini
   #
   # To use the much faster libxml parser:
-  #   gem 'libxml-ruby'
+  #   gem "libxml-ruby"
   #   XmlMini.backend = 'LibXML'
   module XmlMini
     extend self
diff --git a/guides/source/3_1_release_notes.md b/guides/source/3_1_release_notes.md
@@ -37,18 +37,18 @@ The following changes are meant for upgrading your application to Rails 3.1.3, t
 Make the following changes to your `Gemfile`.
 
 ```ruby
-gem 'rails', '= 3.1.3'
-gem 'mysql2'
+gem "rails", "= 3.1.3"
+gem "mysql2"
 
 # Needed for the new asset pipeline
 group :assets do
-  gem 'sass-rails',   "~> 3.1.5"
-  gem 'coffee-rails', "~> 3.1.1"
-  gem 'uglifier',     ">= 1.0.3"
+  gem "sass-rails",   "~> 3.1.5"
+  gem "coffee-rails", "~> 3.1.1"
+  gem "uglifier",     ">= 1.0.3"
 end
 
 # jQuery is the default JavaScript library in Rails 3.1
-gem 'jquery-rails'
+gem "jquery-rails"
 ```
 
 #### config/application.rb
diff --git a/guides/source/4_2_release_notes.md b/guides/source/4_2_release_notes.md
@@ -179,7 +179,7 @@ change your code to use the explicit form (`render file: "foo/bar"`) instead.
 
 `respond_with` and the corresponding class-level `respond_to` have been moved
 to the [responders](https://github.com/plataformatec/responders) gem. Add
-`gem 'responders', '~> 2.0'` to your `Gemfile` to use it:
+`gem "responders", "~> 2.0"` to your `Gemfile` to use it:
 
 ```ruby
 # app/controllers/users_controller.rb
@@ -445,7 +445,7 @@ Please refer to the [Changelog][action-pack] for detailed changes.
 ### Removals
 
 *   `respond_with` and the class-level `respond_to` have been removed from Rails and
-    moved to the `responders` gem (version 2.0). Add `gem 'responders', '~> 2.0'`
+    moved to the `responders` gem (version 2.0). Add `gem "responders", "~> 2.0"`
     to your `Gemfile` to continue using these features.
     ([Pull Request](https://github.com/rails/rails/pull/16526),
      [More Details](https://guides.rubyonrails.org/v4.2/upgrading_ruby_on_rails.html#responders))
diff --git a/guides/source/action_view_overview.md b/guides/source/action_view_overview.md
@@ -152,7 +152,7 @@ It's similar to Builder but is used to generate JSON, instead of XML.
 If you don't have it, you can add the following to your `Gemfile`:
 
 ```ruby
-gem 'jbuilder'
+gem "jbuilder"
 ```
 
 A Jbuilder object named `json` is automatically made available to templates with
diff --git a/guides/source/active_record_postgresql.md b/guides/source/active_record_postgresql.md
@@ -805,5 +805,5 @@ You can use `ActiveRecord::Tasks::DatabaseTasks.structure_dump_flags` to configu
 For example, to exclude comments from your structure dump, add this to an initializer:
 
 ```ruby
-ActiveRecord::Tasks::DatabaseTasks.structure_dump_flags = ['--no-comments']
+ActiveRecord::Tasks::DatabaseTasks.structure_dump_flags = ["--no-comments"]
 ```
diff --git a/guides/source/active_support_core_extensions.md b/guides/source/active_support_core_extensions.md
@@ -139,7 +139,7 @@ NOTE: Defined in `active_support/core_ext/object/blank.rb`.
 The [`presence`][Object#presence] method returns its receiver if `present?`, and `nil` otherwise. It is useful for idioms like this:
 
 ```ruby
-host = config[:host].presence || 'localhost'
+host = config[:host].presence || "localhost"
 ```
 
 NOTE: Defined in `active_support/core_ext/object/blank.rb`.
@@ -179,34 +179,34 @@ NOTE: Defined in `active_support/core_ext/object/duplicable.rb`.
 The [`deep_dup`][Object#deep_dup] method returns a deep copy of a given object. Normally, when you `dup` an object that contains other objects, Ruby does not `dup` them, so it creates a shallow copy of the object. If you have an array with a string, for example, it will look like this:
 
 ```ruby
-array     = ['string']
+array     = ["string"]
 duplicate = array.dup
 
-duplicate.push 'another-string'
+duplicate.push "another-string"
 
 # the object was duplicated, so the element was added only to the duplicate
-array     # => ['string']
-duplicate # => ['string', 'another-string']
+array     # => ["string"]
+duplicate # => ["string", "another-string"]
 
-duplicate.first.gsub!('string', 'foo')
+duplicate.first.gsub!("string", "foo")
 
 # first element was not duplicated, it will be changed in both arrays
-array     # => ['foo']
-duplicate # => ['foo', 'another-string']
+array     # => ["foo"]
+duplicate # => ["foo, "another-string"]
 ```
 
 As you can see, after duplicating the `Array` instance, we got another object, therefore we can modify it and the original object will stay unchanged. This is not true for array's elements, however. Since `dup` does not make a deep copy, the string inside the array is still the same object.
 
 If you need a deep copy of an object, you should use `deep_dup`. Here is an example:
 
 ```ruby
-array     = ['string']
+array     = ["string"]
 duplicate = array.deep_dup
 
-duplicate.first.gsub!('string', 'foo')
+duplicate.first.gsub!("string", "foo")
 
-array     # => ['string']
-duplicate # => ['foo']
+array     # => ["string"]
+duplicate # => ["foo"]
 ```
 
 If the object is not duplicable, `deep_dup` will just return it:
@@ -242,8 +242,8 @@ Another example is this code from `ActiveRecord::ConnectionAdapters::AbstractAda
 ```ruby
 def log_info(sql, name, ms)
   if @logger.try(:debug?)
-    name = '%s (%.1fms)' % [name || 'SQL', ms]
-    @logger.debug(format_log_entry(name, sql.squeeze(' ')))
+    name = "%s (%.1fms)" % [name || "SQL", ms]
+    @logger.debug(format_log_entry(name, sql.squeeze(" ")))
   end
 end
 ```
@@ -372,13 +372,13 @@ end
 we get:
 
 ```ruby
-current_user.to_query('user') # => "user=357-john-smith"
+current_user.to_query("user") # => "user=357-john-smith"
 ```
 
 This method escapes whatever is needed, both for the key and the value:
 
 ```ruby
-account.to_query('company[name]')
+account.to_query("company[name]")
 # => "company%5Bname%5D=Johnson+%26+Johnson"
 ```
 
@@ -387,7 +387,7 @@ so its output is ready to be used in a query string.
 Arrays return the result of applying `to_query` to each element with `key[]` as key, and join the result with "&":
 
 ```ruby
-[3.4, -45.6].to_query('sample')
+[3.4, -45.6].to_query("sample")
 # => "sample%5B%5D=3.4&sample%5B%5D=-45.6"
 ```
 
@@ -400,7 +400,7 @@ Hashes also respond to `to_query` but with a different signature. If no argument
 The method [`Hash#to_query`][Hash#to_query] accepts an optional namespace for the keys:
 
 ```ruby
-{ id: 89, name: "John Smith" }.to_query('user')
+{ id: 89, name: "John Smith" }.to_query("user")
 # => "user%5Bid%5D=89&user%5Bname%5D=John+Smith"
 ```
 
@@ -1201,7 +1201,7 @@ The method [`truncate`][String#truncate] returns a copy of its receiver truncate
 Ellipsis can be customized with the `:omission` option:
 
 ```ruby
-"Oh dear! Oh dear! I shall be late!".truncate(20, omission: '&hellip;')
+"Oh dear! Oh dear! I shall be late!".truncate(20, omission: "&hellip;")
 # => "Oh dear! Oh &hellip;"
 ```
 
@@ -1212,7 +1212,7 @@ Pass a `:separator` to truncate the string at a natural break:
 ```ruby
 "Oh dear! Oh dear! I shall be late!".truncate(18)
 # => "Oh dear! Oh dea..."
-"Oh dear! Oh dear! I shall be late!".truncate(18, separator: ' ')
+"Oh dear! Oh dear! I shall be late!".truncate(18, separator: " ")
 # => "Oh dear! Oh..."
 ```
 
@@ -1261,14 +1261,14 @@ The method [`truncate_words`][String#truncate_words] returns a copy of its recei
 Ellipsis can be customized with the `:omission` option:
 
 ```ruby
-"Oh dear! Oh dear! I shall be late!".truncate_words(4, omission: '&hellip;')
+"Oh dear! Oh dear! I shall be late!".truncate_words(4, omission: "&hellip;")
 # => "Oh dear! Oh dear!&hellip;"
 ```
 
 Pass a `:separator` to truncate the string at a natural break:
 
 ```ruby
-"Oh dear! Oh dear! I shall be late!".truncate_words(3, separator: '!')
+"Oh dear! Oh dear! I shall be late!".truncate_words(3, separator: "!")
 # => "Oh dear! Oh dear! I shall be late..."
 ```
 
@@ -1812,7 +1812,7 @@ The capitalization of the first word can be turned off by setting the
 If "SSL" was defined to be an acronym:
 
 ```ruby
-'ssl_error'.humanize # => "SSL error"
+"ssl_error".humanize # => "SSL error"
 ```
 
 The helper method `full_messages` uses `humanize` as a fallback to include
@@ -1825,7 +1825,7 @@ end
 
 def full_message
   # ...
-  attr_name = attribute.to_s.tr('.', '_').humanize
+  attr_name = attribute.to_s.tr(".", "_").humanize
   attr_name = @base.class.human_attribute_name(attribute, default: attr_name)
   # ...
 end
@@ -2048,7 +2048,7 @@ Produce a string representation of a number as a percentage:
 # => 100.000%
 100.to_fs(:percentage, precision: 0)
 # => 100%
-1000.to_fs(:percentage, delimiter: '.', separator: ',')
+1000.to_fs(:percentage, delimiter: ".", separator: ",")
 # => 1.000,000%
 302.24398923423.to_fs(:percentage, precision: 5)
 # => 302.24399%
@@ -2208,7 +2208,7 @@ It iterates through the collection and passes each element to a block. The eleme
 
 ```ruby
 invoices.index_by(&:number)
-# => {'2009-032' => <Invoice ...>, '2009-008' => <Invoice ...>, ...}
+# => {"2009-032" => <Invoice ...>, "2009-008" => <Invoice ...>, ...}
 ```
 
 WARNING. Keys should normally be unique. If the block returns the same value for different elements no collection is built for that key. The last item will win.
@@ -3024,7 +3024,7 @@ NOTE: Defined in `active_support/core_ext/hash/keys.rb`.
 The method [`deep_transform_values`][Hash#deep_transform_values] returns a new hash with all values converted by the block operation. This includes the values from the root hash and from all nested hashes and arrays.
 
 ```ruby
-hash = { person: { name: 'Rob', age: '28' } }
+hash = { person: { name: "Rob", age: "28" } }
 
 hash.deep_transform_values { |value| value.to_s.upcase }
 # => {person: {name: "ROB", age: "28"}}
@@ -3097,8 +3097,8 @@ The method [`multiline?`][Regexp#multiline?] says whether a regexp has the `/m`
 %r{.}.multiline?  # => false
 %r{.}m.multiline? # => true
 
-Regexp.new('.').multiline?                    # => false
-Regexp.new('.', Regexp::MULTILINE).multiline? # => true
+Regexp.new(".").multiline?                    # => false
+Regexp.new(".", Regexp::MULTILINE).multiline? # => true
 ```
 
 Rails uses this method in a single place, also in the routing code. Multiline regexps are disallowed for route requirements and this flag eases enforcing that constraint.
diff --git a/guides/source/caching_with_rails.md b/guides/source/caching_with_rails.md
@@ -522,13 +522,13 @@ was rescued.
 To get started, add the redis gem to your Gemfile:
 
 ```ruby
-gem 'redis'
+gem "redis"
 ```
 
 Finally, add the configuration in the relevant `config/environments/*.rb` file:
 
 ```ruby
-config.cache_store = :redis_cache_store, { url: ENV['REDIS_URL'] }
+config.cache_store = :redis_cache_store, { url: ENV["REDIS_URL"] }
 ```
 
 A more complex, production Redis cache store may look something like this:
diff --git a/guides/source/configuring.md b/guides/source/configuring.md
@@ -3681,7 +3681,7 @@ evented file system monitor to detect changes when reloading is enabled:
 
 ```ruby
 group :development do
-  gem 'listen', '~> 3.5'
+  gem "listen", "~> 3.5"
 end
 ```
 
diff --git a/guides/source/engines.md b/guides/source/engines.md
@@ -151,7 +151,7 @@ When you include the engine into an application later on, you will do so with
 this line in the Rails application's `Gemfile`:
 
 ```ruby
-gem 'blorgh', path: 'engines/blorgh'
+gem "blorgh", path: "engines/blorgh"
 ```
 
 Don't forget to run `bundle install` as usual. By specifying it as a gem within
@@ -626,14 +626,14 @@ Usually, specifying the engine inside the `Gemfile` would be done by specifying
 as a normal, everyday gem.
 
 ```ruby
-gem 'devise'
+gem "devise"
 ```
 
 However, because you are developing the `blorgh` engine on your local machine,
 you will need to specify the `:path` option in your `Gemfile`:
 
 ```ruby
-gem 'blorgh', path: 'engines/blorgh'
+gem "blorgh", path: "engines/blorgh"
 ```
 
 Then run `bundle` to install the gem.
diff --git a/guides/source/security.md b/guides/source/security.md
@@ -1351,7 +1351,7 @@ steps.
 To get started, add the rack-cors gem to your Gemfile:
 
 ```ruby
-gem 'rack-cors'
+gem "rack-cors"
 ```
 
 Next, add an initializer to configure the middleware:
diff --git a/guides/source/upgrading_ruby_on_rails.md b/guides/source/upgrading_ruby_on_rails.md
diff --git a/railties/lib/rails/generators/rails/plugin/plugin_generator.rb b/railties/lib/rails/generators/rails/plugin/plugin_generator.rb
diff --git a/railties/test/generators/db_system_change_generator_test.rb b/railties/test/generators/db_system_change_generator_test.rb
diff --git a/railties/test/generators/plugin_generator_test.rb b/railties/test/generators/plugin_generator_test.rb
diff --git a/railties/test/railties/generators_test.rb b/railties/test/railties/generators_test.rb
diff --git a/tasks/release.rb b/tasks/release.rb

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ module ClassMethods`
`41`	`41`	`#`
`42`	`42`	`# To use +has_secure_password+, add bcrypt (~> 3.1.7) to your Gemfile:`
`43`	`43`	`#`
`44`		`- # gem 'bcrypt', '~> 3.1.7'`
	`44`	`+ # gem "bcrypt", "~> 3.1.7"`
`45`	`45`	`#`
`46`	`46`	`# ==== Examples`
`47`	`47`	`#`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ module ActiveSupport`
`12`	`12`	`# = \XmlMini`
`13`	`13`	`#`
`14`	`14`	`# To use the much faster libxml parser:`
`15`		`- # gem 'libxml-ruby'`
	`15`	`+ # gem "libxml-ruby"`
`16`	`16`	`# XmlMini.backend = 'LibXML'`
`17`	`17`	`module XmlMini`
`18`	`18`	`extend self`