diff --git a/actioncable/README.md b/actioncable/README.md index ce65fa88a7..418c55bdc3 100644 --- a/actioncable/README.md +++ b/actioncable/README.md @@ -1,8 +1,8 @@ -# Action Cable – Integrated WebSockets for Rails +# Action Cable – Integrated WebSockets for \Rails -Action Cable seamlessly integrates WebSockets with the rest of your Rails application. +Action Cable seamlessly integrates WebSockets with the rest of your \Rails application. It allows for real-time features to be written in Ruby in the same style -and form as the rest of your Rails application, while still being performant +and form as the rest of your \Rails application, while still being performant and scalable. It's a full-stack offering that provides both a client-side JavaScript framework and a server-side Ruby framework. You have access to your full domain model written with Active Record or your ORM of choice. diff --git a/actioncable/lib/action_cable/server/configuration.rb b/actioncable/lib/action_cable/server/configuration.rb index bc1dbdcee7..3642c41b03 100644 --- a/actioncable/lib/action_cable/server/configuration.rb +++ b/actioncable/lib/action_cable/server/configuration.rb @@ -5,7 +5,7 @@ module Server # = Action Cable \Server \Configuration # # An instance of this configuration object is available via ActionCable.server.config, which allows you to tweak Action Cable configuration - # in a Rails config initializer. + # in a \Rails config initializer. class Configuration attr_accessor :logger, :log_tags attr_accessor :connection_class, :worker_pool_size diff --git a/actioncable/lib/action_cable/subscription_adapter/test.rb b/actioncable/lib/action_cable/subscription_adapter/test.rb index be638c7209..d4b9eaa088 100644 --- a/actioncable/lib/action_cable/subscription_adapter/test.rb +++ b/actioncable/lib/action_cable/subscription_adapter/test.rb @@ -5,11 +5,11 @@ module SubscriptionAdapter # == \Test adapter for Action Cable # # The test adapter should be used only in testing. Along with - # ActionCable::TestHelper it makes a great tool to test your Rails application. + # ActionCable::TestHelper it makes a great tool to test your \Rails application. # # To use the test adapter set +adapter+ value to +test+ in your +config/cable.yml+ file. # - # NOTE: Test adapter extends the +ActionCable::SubscriptionAdapter::Async+ adapter, + # NOTE: +Test+ adapter extends the +ActionCable::SubscriptionAdapter::Async+ adapter, # so it could be used in system tests too. class Test < Async def broadcast(channel, payload) diff --git a/actionmailbox/README.md b/actionmailbox/README.md index 0b4876c2be..47fcbc0113 100644 --- a/actionmailbox/README.md +++ b/actionmailbox/README.md @@ -1,6 +1,6 @@ # Action Mailbox -Action Mailbox routes incoming emails to controller-like mailboxes for processing in Rails. It ships with ingresses for Mailgun, Mandrill, Postmark, and SendGrid. You can also handle inbound mails directly via the built-in Exim, Postfix, and Qmail ingresses. +Action Mailbox routes incoming emails to controller-like mailboxes for processing in \Rails. It ships with ingresses for Mailgun, Mandrill, Postmark, and SendGrid. You can also handle inbound mails directly via the built-in Exim, Postfix, and Qmail ingresses. The inbound emails are turned into `InboundEmail` records using Active Record and feature lifecycle tracking, storage of the original email on cloud storage via Active Storage, and responsible data handling with on-by-default incineration. diff --git a/actionmailer/lib/action_mailer/base.rb b/actionmailer/lib/action_mailer/base.rb index ff9e32a2ee..efbf79e71c 100644 --- a/actionmailer/lib/action_mailer/base.rb +++ b/actionmailer/lib/action_mailer/base.rb @@ -267,7 +267,7 @@ module ActionMailer # the delivery agents. Your class should make any needed modifications directly to the passed # in +Mail::Message+ instance. # - # = Default Hash + # = Default \Hash # # Action Mailer provides some intelligent defaults for your emails, these are usually specified in a # default method inside the class definition: @@ -316,7 +316,7 @@ module ActionMailer # # config.action_mailer.default_options = { from: "no-reply@example.org" } # - # = Callbacks + # = \Callbacks # # You can specify callbacks using before_action and after_action for configuring your messages, # and using before_deliver and after_deliver for wrapping the delivery process. @@ -783,7 +783,7 @@ def _raise_error # the most used headers in an email message, these are: # # * +:subject+ - The subject of the message, if this is omitted, Action Mailer will - # ask the Rails I18n class for a translated +:subject+ in the scope of + # ask the \Rails I18n class for a translated +:subject+ in the scope of # [mailer_scope, action_name] or if this is missing, will translate the # humanized version of the +action_name+ # * +:to+ - Who the message is destined for, can be a string of addresses, or an array @@ -929,7 +929,7 @@ def set_content_type(m, user_content_type, class_default) # :doc: end end - # Translates the +subject+ using Rails I18n class under [mailer_scope, action_name] scope. + # Translates the +subject+ using \Rails I18n class under [mailer_scope, action_name] scope. # If it does not find a translation for the +subject+ under the specified scope it will default to a # humanized version of the action_name. # If the subject has interpolations, you can pass them through the +interpolations+ parameter. diff --git a/actionpack/README.rdoc b/actionpack/README.rdoc index dcda82def4..028f5910d3 100644 --- a/actionpack/README.rdoc +++ b/actionpack/README.rdoc @@ -16,11 +16,11 @@ It consists of several modules: subclassed to implement filters and actions to handle requests. The result of an action is typically content generated from views. -With the Ruby on Rails framework, users only directly interface with the +With the Ruby on \Rails framework, users only directly interface with the Action Controller module. Necessary Action Dispatch functionality is activated by default and Action View rendering is implicitly triggered by Action Controller. However, these modules are designed to function on their own and -can be used outside of Rails. +can be used outside of \Rails. You can read more about Action Pack in the {Action Controller Overview}[https://guides.rubyonrails.org/action_controller_overview.html] guide. diff --git a/actionpack/lib/action_controller/metal/http_authentication.rb b/actionpack/lib/action_controller/metal/http_authentication.rb index 1977be730f..b904917891 100644 --- a/actionpack/lib/action_controller/metal/http_authentication.rb +++ b/actionpack/lib/action_controller/metal/http_authentication.rb @@ -316,7 +316,7 @@ def secret_token(request) # of this document. # # The nonce is opaque to the client. Composed of Time, and hash of Time with secret - # key from the Rails session secret generated upon creation of project. Ensures + # key from the \Rails session secret generated upon creation of project. Ensures # the time cannot be modified by client. def nonce(secret_key, time = Time.now) t = time.to_i diff --git a/actionpack/lib/action_controller/metal/mime_responds.rb b/actionpack/lib/action_controller/metal/mime_responds.rb index fb32257ebe..e0e94d7614 100644 --- a/actionpack/lib/action_controller/metal/mime_responds.rb +++ b/actionpack/lib/action_controller/metal/mime_responds.rb @@ -32,7 +32,7 @@ module MimeResponds # # What that says is, "if the client wants HTML or JS in response to this action, just respond as we # would have before, but if the client wants XML, return them the list of people in XML format." - # (Rails determines the desired response format from the HTTP Accept header submitted by the client.) + # (\Rails determines the desired response format from the HTTP Accept header submitted by the client.) # # Supposing you have an action that adds a new person, optionally creating their company # (by name) if it does not already exist, without web-services, it might look like this: @@ -98,7 +98,7 @@ module MimeResponds # # Note that you can define your own XML parameter parser which would allow you to describe multiple entities # in a single request (i.e., by wrapping them all in a single root node), but if you just go with the flow - # and accept Rails' defaults, life will be much easier. + # and accept \Rails' defaults, life will be much easier. # # If you need to use a MIME type which isn't supported by default, you can register your own handlers in # +config/initializers/mime_types.rb+ as follows. diff --git a/actionpack/lib/action_controller/metal/redirecting.rb b/actionpack/lib/action_controller/metal/redirecting.rb index 64cf6277a5..4c02d1a94d 100644 --- a/actionpack/lib/action_controller/metal/redirecting.rb +++ b/actionpack/lib/action_controller/metal/redirecting.rb @@ -65,8 +65,8 @@ class UnsafeRedirectError < StandardError; end # # === Open Redirect protection # - # By default, Rails protects against redirecting to external hosts for your app's safety, so called open redirects. - # Note: this was a new default in Rails 7.0, after upgrading opt-in by uncommenting the line with +raise_on_open_redirects+ in config/initializers/new_framework_defaults_7_0.rb + # By default, \Rails protects against redirecting to external hosts for your app's safety, so called open redirects. + # Note: this was a new default in \Rails 7.0, after upgrading opt-in by uncommenting the line with +raise_on_open_redirects+ in config/initializers/new_framework_defaults_7_0.rb # # Here #redirect_to automatically validates the potentially-unsafe URL: # diff --git a/actionpack/lib/action_controller/metal/renderers.rb b/actionpack/lib/action_controller/metal/renderers.rb index f6fb115811..3ea0216e2b 100644 --- a/actionpack/lib/action_controller/metal/renderers.rb +++ b/actionpack/lib/action_controller/metal/renderers.rb @@ -58,7 +58,7 @@ module All # disposition: "attachment; filename=#{filename}.csv" # end # - # Note that we used Mime[:csv] for the csv mime type as it comes with Rails. + # Note that we used Mime[:csv] for the csv mime type as it comes with \Rails. # For a custom renderer, you'll need to register a mime type with # Mime::Type.register. # diff --git a/actionpack/lib/action_controller/metal/request_forgery_protection.rb b/actionpack/lib/action_controller/metal/request_forgery_protection.rb index b611c146ef..142dd0bb07 100644 --- a/actionpack/lib/action_controller/metal/request_forgery_protection.rb +++ b/actionpack/lib/action_controller/metal/request_forgery_protection.rb @@ -39,7 +39,7 @@ class InvalidCrossOriginRequest < ActionControllerError # :nodoc: # ActionController::InvalidAuthenticityToken error on unverified requests. # # APIs may want to disable this behavior since they are typically designed to be - # state-less: that is, the request API client handles the session instead of Rails. + # state-less: that is, the request API client handles the session instead of \Rails. # One way to achieve this is to use the :null_session strategy instead, # which allows unverified requests to be handled, but with an empty session: # diff --git a/actionpack/lib/action_controller/test_case.rb b/actionpack/lib/action_controller/test_case.rb index af2b9abe65..fa5c33bdc4 100644 --- a/actionpack/lib/action_controller/test_case.rb +++ b/actionpack/lib/action_controller/test_case.rb @@ -239,10 +239,10 @@ def load! # # == Use integration style controller tests over functional style controller tests. # - # Rails discourages the use of functional tests in favor of integration tests + # \Rails discourages the use of functional tests in favor of integration tests # (use ActionDispatch::IntegrationTest). # - # New Rails applications no longer generate functional style controller tests and they should + # New \Rails applications no longer generate functional style controller tests and they should # only be used for backward compatibility. Integration style controller tests perform actual # requests, whereas functional style controller tests merely simulate a request. Besides, # integration tests are as fast as functional tests and provide lot of helpers such as +as+, @@ -477,7 +477,7 @@ def head(action, **args) # # It's not recommended to make more than one request in the same test. Instance # variables that are set in one request will not persist to the next request, - # but it's not guaranteed that all Rails internal state will be reset. Prefer + # but it's not guaranteed that all \Rails internal state will be reset. Prefer # ActionDispatch::IntegrationTest for making multiple requests in the same test. # # Note that the request method is not verified. diff --git a/actionpack/lib/action_dispatch/middleware/session/cookie_store.rb b/actionpack/lib/action_dispatch/middleware/session/cookie_store.rb index bd6dd5dbe3..3c7aaaea54 100644 --- a/actionpack/lib/action_dispatch/middleware/session/cookie_store.rb +++ b/actionpack/lib/action_dispatch/middleware/session/cookie_store.rb @@ -8,7 +8,7 @@ module ActionDispatch module Session # = Action Dispatch Session \CookieStore # - # This cookie-based session store is the Rails default. It is + # This cookie-based session store is the \Rails default. It is # dramatically faster than the alternatives. # # Sessions typically contain at most a user ID and flash message; both fit @@ -20,18 +20,18 @@ module Session # # Your cookies will be encrypted using your application's +secret_key_base+. This # goes a step further than signed cookies in that encrypted cookies cannot - # be altered or read by users. This is the default starting in Rails 4. + # be altered or read by users. This is the default starting in \Rails 4. # # Configure your session store in an initializer: # # Rails.application.config.session_store :cookie_store, key: '_your_app_session' # # In the development and test environments your application's +secret_key_base+ is - # generated by Rails and stored in a temporary file in tmp/local_secret.txt. + # generated by \Rails and stored in a temporary file in tmp/local_secret.txt. # In all other environments, it is stored encrypted in the # config/credentials.yml.enc file. # - # If your application was not updated to Rails 5.2 defaults, the +secret_key_base+ + # If your application was not updated to \Rails 5.2 defaults, the +secret_key_base+ # will be found in the old config/secrets.yml file. # # Note that changing your +secret_key_base+ will invalidate all existing session. diff --git a/actionpack/lib/action_dispatch/middleware/static.rb b/actionpack/lib/action_dispatch/middleware/static.rb index 81a00e3b6e..dbeb9f9f92 100644 --- a/actionpack/lib/action_dispatch/middleware/static.rb +++ b/actionpack/lib/action_dispatch/middleware/static.rb @@ -8,7 +8,7 @@ module ActionDispatch # This middleware serves static files from disk, if available. # If no file is found, it hands off to the main app. # - # In Rails apps, this middleware is configured to serve assets from + # In \Rails apps, this middleware is configured to serve assets from # the +public/+ directory. # # Only GET and HEAD requests are served. POST and other HTTP methods diff --git a/actionpack/lib/action_dispatch/routing/mapper.rb b/actionpack/lib/action_dispatch/routing/mapper.rb index 8aa2820632..0173e3c17f 100644 --- a/actionpack/lib/action_dispatch/routing/mapper.rb +++ b/actionpack/lib/action_dispatch/routing/mapper.rb @@ -760,7 +760,7 @@ def map_method(method, args, &block) # end # # This will create a number of routes for each of the posts and comments - # controller. For +Admin::PostsController+, Rails will create: + # controller. For +Admin::PostsController+, \Rails will create: # # GET /admin/posts # GET /admin/posts/new @@ -1330,7 +1330,7 @@ def resource(*resources, &block) self end - # In Rails, a resourceful route provides a mapping between HTTP verbs + # In \Rails, a resourceful route provides a mapping between HTTP verbs # and URLs and controller actions. By convention, each action also maps # to particular CRUD operations in a database. A single entry in the # routing file, such as @@ -1505,7 +1505,7 @@ def resources(*resources, &block) # end # end # - # This will enable Rails to recognize paths such as /photos/search + # This will enable \Rails to recognize paths such as /photos/search # with GET, and route to the search action of +PhotosController+. It will also # create the search_photos_url and search_photos_path # route helpers. @@ -1675,7 +1675,7 @@ def match(path, *rest, &block) end end - # You can specify what Rails should route "/" to with the root method: + # You can specify what \Rails should route "/" to with the root method: # # root to: 'pages#main' # @@ -1687,7 +1687,7 @@ def match(path, *rest, &block) # # You should put the root route at the top of config/routes.rb, # because this means it will be matched first. As this is the most popular route - # of most Rails applications, this is beneficial. + # of most \Rails applications, this is beneficial. def root(path, options = {}) if path.is_a?(String) options[:to] = path diff --git a/actionpack/lib/action_dispatch/routing/url_for.rb b/actionpack/lib/action_dispatch/routing/url_for.rb index 5b345e4d9e..55d92c29ef 100644 --- a/actionpack/lib/action_dispatch/routing/url_for.rb +++ b/actionpack/lib/action_dispatch/routing/url_for.rb @@ -39,7 +39,7 @@ module Routing # # => "/users/new?message=Welcome%21" # # Notice the only_path: true part. This is because UrlFor has no - # information about the website hostname that your Rails app is serving. So if you + # information about the website hostname that your \Rails app is serving. So if you # want to include the hostname as well, then you must also pass the :host # argument: # diff --git a/actionpack/lib/action_dispatch/system_test_case.rb b/actionpack/lib/action_dispatch/system_test_case.rb index c7d4b395d3..f78e60341a 100644 --- a/actionpack/lib/action_dispatch/system_test_case.rb +++ b/actionpack/lib/action_dispatch/system_test_case.rb @@ -107,7 +107,7 @@ module ActionDispatch # end # # Because +ActionDispatch::SystemTestCase+ is a shim between Capybara - # and Rails, any driver that is supported by Capybara is supported by system + # and \Rails, any driver that is supported by Capybara is supported by system # tests as long as you include the required gems and files. class SystemTestCase < ActiveSupport::TestCase include Capybara::DSL diff --git a/actionpack/lib/action_dispatch/testing/integration.rb b/actionpack/lib/action_dispatch/testing/integration.rb index 43b606cda8..30be79c725 100644 --- a/actionpack/lib/action_dispatch/testing/integration.rb +++ b/actionpack/lib/action_dispatch/testing/integration.rb @@ -635,7 +635,7 @@ def method_missing(method, *args, &block) # +response_parser+ defines how the response body should be parsed through # +parsed_body+. # - # Consult the Rails Testing Guide for more. + # Consult the {Rails Testing Guide}[https://guides.rubyonrails.org/testing.html] for more. class IntegrationTest < ActiveSupport::TestCase include TestProcess::FixtureFile diff --git a/actiontext/README.md b/actiontext/README.md index 7919279db7..20d2d3e825 100644 --- a/actiontext/README.md +++ b/actiontext/README.md @@ -1,6 +1,6 @@ # Action Text -Action Text brings rich text content and editing to Rails. It includes the [Trix editor](https://trix-editor.org) that handles everything from formatting to links to quotes to lists to embedded images and galleries. The rich text content generated by the Trix editor is saved in its own RichText model that's associated with any existing Active Record model in the application. Any embedded images (or other attachments) are automatically stored using Active Storage and associated with the included RichText model. +Action Text brings rich text content and editing to \Rails. It includes the [Trix editor](https://trix-editor.org) that handles everything from formatting to links to quotes to lists to embedded images and galleries. The rich text content generated by the Trix editor is saved in its own RichText model that's associated with any existing Active Record model in the application. Any embedded images (or other attachments) are automatically stored using Active Storage and associated with the included RichText model. You can read more about Action Text in the [Action Text Overview](https://guides.rubyonrails.org/action_text_overview.html) guide. diff --git a/actionview/lib/action_view/base.rb b/actionview/lib/action_view/base.rb index 6521c9fe9b..211d4f1bef 100644 --- a/actionview/lib/action_view/base.rb +++ b/actionview/lib/action_view/base.rb @@ -82,8 +82,8 @@ module ActionView # :nodoc: # # === Template caching # - # By default, Rails will compile each template to a method in order to render it. When you alter a template, - # Rails will check the file's modification time and recompile it in development mode. + # By default, \Rails will compile each template to a method in order to render it. When you alter a template, + # \Rails will check the file's modification time and recompile it in development mode. # # == Builder # diff --git a/actionview/lib/action_view/helpers/asset_tag_helper.rb b/actionview/lib/action_view/helpers/asset_tag_helper.rb index 1ef6f15832..e75640f23e 100644 --- a/actionview/lib/action_view/helpers/asset_tag_helper.rb +++ b/actionview/lib/action_view/helpers/asset_tag_helper.rb @@ -43,7 +43,7 @@ module AssetTagHelper # source, and include other JavaScript or CoffeeScript files inside the manifest. # # If the server supports HTTP Early Hints, and the +defer+ option is not - # enabled, Rails will push a 103 Early Hints response that links + # enabled, \Rails will push a 103 Early Hints response that links # to the assets. # # ==== Options @@ -152,7 +152,7 @@ def javascript_include_tag(*sources) # set extname: false in the options. # You can modify the link attributes by passing a hash as the last argument. # - # If the server supports HTTP Early Hints, Rails will push a 103 Early + # If the server supports HTTP Early Hints, \Rails will push a 103 Early # Hints response that links to the assets. # # ==== Options diff --git a/actionview/lib/action_view/helpers/asset_url_helper.rb b/actionview/lib/action_view/helpers/asset_url_helper.rb index cd2b480858..d1b4347e00 100644 --- a/actionview/lib/action_view/helpers/asset_url_helper.rb +++ b/actionview/lib/action_view/helpers/asset_url_helper.rb @@ -17,8 +17,8 @@ module Helpers # :nodoc: # # === Using asset hosts # - # By default, Rails links to these assets on the current host in the public - # folder, but you can direct Rails to link to assets from a dedicated asset + # By default, \Rails links to these assets on the current host in the public + # folder, but you can direct \Rails to link to assets from a dedicated asset # server by setting ActionController::Base.asset_host in the application # configuration, typically in config/environments/production.rb. # For example, you'd define assets.example.com to be your asset @@ -373,7 +373,7 @@ def stylesheet_url(source, options = {}) # image_path("http://www.example.com/img/edit.png") # => "http://www.example.com/img/edit.png" # # If you have images as application resources this method may conflict with their named routes. - # The alias +path_to_image+ is provided to avoid that. Rails uses the alias internally, and + # The alias +path_to_image+ is provided to avoid that. \Rails uses the alias internally, and # plugin authors are encouraged to do so. def image_path(source, options = {}) path_to_asset(source, { type: :image }.merge!(options)) diff --git a/actionview/lib/action_view/helpers/csp_helper.rb b/actionview/lib/action_view/helpers/csp_helper.rb index 9b732ad276..1434ca6288 100644 --- a/actionview/lib/action_view/helpers/csp_helper.rb +++ b/actionview/lib/action_view/helpers/csp_helper.rb @@ -11,7 +11,7 @@ module CspHelper # <%= csp_meta_tag %> # # - # This is used by the Rails UJS helper to create dynamically + # This is used by the \Rails UJS helper to create dynamically # loaded inline