Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions src/7.1/classes/AbstractController/Base.html
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ <h3 id="method-c-controller_path">

<h4 id="method-c-controller_path-label-Returns">Returns</h4>
<ul><li>
<p><code>String</code></p>
<p><a href="../String.html"><code>String</code></a></p>
</li></ul>
</div>

Expand Down Expand Up @@ -415,7 +415,7 @@ <h3 id="method-c-supports_path-3F">


<div class="description">
<p>Returns true if the given controller is capable of rendering a path. A subclass of <code>AbstractController::Base</code> may return false. An Email controller for example does not support paths, only full URLs.</p>
<p>Returns true if the given controller is capable of rendering a path. A subclass of <a href="Base.html"><code>AbstractController::Base</code></a> may return false. An Email controller for example does not support paths, only full URLs.</p>
</div>


Expand Down Expand Up @@ -529,7 +529,7 @@ <h3 id="method-i-available_action-3F">

<h4 id="method-i-available_action-3F-label-Parameters">Parameters</h4>
<ul><li>
<p><code>action_name</code> - The name of an action to be tested</p>
<p><a href="Base.html#method-i-action_name"><code>action_name</code></a> - The name of an action to be tested</p>
</li></ul>
</div>

Expand Down
8 changes: 4 additions & 4 deletions src/7.1/classes/AbstractController/Caching/Fragments.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ <h3 id="method-i-combined_fragment_cache_key">


<div class="description">
<p>Given a key (as described in <code>expire_fragment</code>), returns a key array suitable for use in reading, writing, or expiring a cached fragment. All keys begin with <code>:views</code>, followed by <code>ENV[&quot;RAILS_CACHE_ID&quot;]</code> or <code>ENV[&quot;RAILS_APP_VERSION&quot;]</code> if set, followed by any controller-wide key prefix values, ending with the specified <code>key</code> value.</p>
<p>Given a key (as described in <a href="Fragments.html#method-i-expire_fragment"><code>expire_fragment</code></a>), returns a key array suitable for use in reading, writing, or expiring a cached fragment. All keys begin with <code>:views</code>, followed by <code>ENV[&quot;RAILS_CACHE_ID&quot;]</code> or <code>ENV[&quot;RAILS_APP_VERSION&quot;]</code> if set, followed by any controller-wide key prefix values, ending with the specified <code>key</code> value.</p>
</div>


Expand Down Expand Up @@ -204,7 +204,7 @@ <h3 id="method-i-fragment_exist-3F">


<div class="description">
<p>Check if a cached fragment from the location signified by <code>key</code> exists (see <code>expire_fragment</code> for acceptable formats).</p>
<p>Check if a cached fragment from the location signified by <code>key</code> exists (see <a href="Fragments.html#method-i-expire_fragment"><code>expire_fragment</code></a> for acceptable formats).</p>
</div>


Expand Down Expand Up @@ -244,7 +244,7 @@ <h3 id="method-i-read_fragment">


<div class="description">
<p>Reads a cached fragment from the location signified by <code>key</code> (see <code>expire_fragment</code> for acceptable formats).</p>
<p>Reads a cached fragment from the location signified by <code>key</code> (see <a href="Fragments.html#method-i-expire_fragment"><code>expire_fragment</code></a> for acceptable formats).</p>
</div>


Expand Down Expand Up @@ -285,7 +285,7 @@ <h3 id="method-i-write_fragment">


<div class="description">
<p>Writes <code>content</code> to the location signified by <code>key</code> (see <code>expire_fragment</code> for acceptable formats).</p>
<p>Writes <code>content</code> to the location signified by <code>key</code> (see <a href="Fragments.html#method-i-expire_fragment"><code>expire_fragment</code></a> for acceptable formats).</p>
</div>


Expand Down
2 changes: 1 addition & 1 deletion src/7.1/classes/AbstractController/Rendering.html
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ <h3 id="method-i-render">
<div class="description">
<p>Normalizes arguments and options, and then delegates to <a href="Rendering.html#method-i-render_to_body"><code>render_to_body</code></a> and sticks the result in <code>self.response_body</code>.</p>

<p>Supported options depend on the underlying <code>render_to_body</code> implementation.</p>
<p>Supported options depend on the underlying <a href="Rendering.html#method-i-render_to_body"><code>render_to_body</code></a> implementation.</p>
</div>


Expand Down
2 changes: 1 addition & 1 deletion src/7.1/classes/ActionCable/Channel/Base.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ <h2 id="class-ActionCable::Channel::Base-label-Action+processing">Action process
end
</code></pre>

<p>In this example, the subscribed and unsubscribed methods are not callable methods, as they were already declared in <a href="Base.html"><code>ActionCable::Channel::Base</code></a>, but <code>#appear</code> and <code>#away</code> are. <code>#generate_connection_token</code> is also not callable, since it’s a private method. You’ll see that appear accepts a data parameter, which it then uses as part of its model call. <code>#away</code> does not, since it’s simply a trigger action.</p>
<p>In this example, the subscribed and unsubscribed methods are not callable methods, as they were already declared in <a href="Base.html"><code>ActionCable::Channel::Base</code></a>, but appear and away are. generate_connection_token is also not callable, since it’s a private method. You’ll see that appear accepts a data parameter, which it then uses as part of its model call. away does not, since it’s simply a trigger action.</p>

<p>Also note that in this example, <code>current_user</code> is available because it was marked as an identifying attribute on the connection. All such identifiers will automatically create a delegation method of the same name on the channel instance.</p>

Expand Down
2 changes: 1 addition & 1 deletion src/7.1/classes/ActionCable/Channel/ChannelStub.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h1>

<h1 id="module-ActionCable::Channel::ChannelStub-label-Action+Cable+Channel+Stub">Action Cable Channel Stub</h1>

<p>Stub <code>stream_from</code> to track streams for the channel. Add public aliases for <code>subscription_confirmation_sent?</code> and <code>subscription_rejected?</code>.</p>
<p>Stub <a href="ChannelStub.html#method-i-stream_from"><code>stream_from</code></a> to track streams for the channel. Add public aliases for <code>subscription_confirmation_sent?</code> and <code>subscription_rejected?</code>.</p>

</div>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ <h3 id="method-i-channel_name">


<div class="description">
<p>Returns the name of the channel, underscored, without the <code>Channel</code> ending. If the channel is in a namespace, then the namespaces are represented by single colon separators in the channel name.</p>
<p>Returns the name of the channel, underscored, without the <a href="../../Channel.html"><code>Channel</code></a> ending. If the channel is in a namespace, then the namespaces are represented by single colon separators in the channel name.</p>

<pre><code>ChatChannel.channel_name # =&gt; &#39;chat&#39;
Chats::AppearancesChannel.channel_name # =&gt; &#39;chats:appearances&#39;
Expand Down
6 changes: 3 additions & 3 deletions src/7.1/classes/ActionCable/Channel/TestCase.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,13 @@ <h2 id="class-ActionCable::Channel::TestCase-label-Basic+example">Basic example<
<h2 id="class-ActionCable::Channel::TestCase-label-Special+methods">Special methods</h2>

<p><a href="TestCase.html"><code>ActionCable::Channel::TestCase</code></a> will also automatically provide the following instance methods for use in the tests:</p>
<dl class="rdoc-list note-list"><dt>connection
<dl class="rdoc-list note-list"><dt>connection</dt>
<dd>
<p>An <a href="ConnectionStub.html"><code>ActionCable::Channel::ConnectionStub</code></a>, representing the current HTTP connection.</p>
</dd><dt>subscription
</dd><dt>subscription</dt>
<dd>
<p>An instance of the current channel, created when you call <code>subscribe</code>.</p>
</dd><dt>transmissions
</dd><dt>transmissions</dt>
<dd>
<p>A list of all messages that have been transmitted into the channel.</p>
</dd></dl>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h1>

<h1 id="class-ActionCable::RemoteConnections::RemoteConnection-label-Action+Cable+Remote+Connection">Action Cable Remote Connection</h1>

<p>Represents a single remote connection found via <code>ActionCable.server.remote_connections.where(*)</code>. Exists solely for the purpose of calling <a href="RemoteConnection.html#method-i-disconnect"><code>disconnect</code></a> on that connection.</p>
<p>Represents a single remote connection found via <a href="../../ActionCable.html#method-i-server"><code>ActionCable.server.remote_connections.where(*)</code></a>. Exists solely for the purpose of calling <a href="RemoteConnection.html#method-i-disconnect"><code>disconnect</code></a> on that connection.</p>

</div>

Expand Down
2 changes: 1 addition & 1 deletion src/7.1/classes/ActionCable/SubscriptionAdapter/Test.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ <h2 id="class-ActionCable::SubscriptionAdapter::Test-label-Test+adapter+for+Acti

<p>To use the test adapter set <code>adapter</code> value to <code>test</code> in your <code>config/cable.yml</code> file.</p>

<p>NOTE: <code>Test</code> adapter extends the <code>ActionCable::SubscriptionAdapter::Async</code> adapter, so it could be used in system tests too.</p>
<p>NOTE: <a href="Test.html"><code>Test</code></a> adapter extends the <a href="Async.html"><code>ActionCable::SubscriptionAdapter::Async</code></a> adapter, so it could be used in system tests too.</p>

</div>

Expand Down
6 changes: 3 additions & 3 deletions src/7.1/classes/ActionController/API.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ <h1 id="class-ActionController::API-label-Action+Controller+API">Action Controll

<p>An <a href="API.html"><code>API</code></a> Controller is different from a normal controller in the sense that by default it doesn’t include a number of features that are usually required by browser access only: layouts and templates rendering, flash, assets, and so on. This makes the entire controller stack thinner, suitable for <a href="API.html"><code>API</code></a> applications. It doesn’t mean you won’t have such features if you need them: they’re all available for you to include in your application, they’re just not part of the default <a href="API.html"><code>API</code></a> controller stack.</p>

<p>Normally, <code>ApplicationController</code> is the only controller that inherits from <code>ActionController::API</code>. All other controllers in turn inherit from <code>ApplicationController</code>.</p>
<p>Normally, <code>ApplicationController</code> is the only controller that inherits from <a href="API.html"><code>ActionController::API</code></a>. All other controllers in turn inherit from <code>ApplicationController</code>.</p>

<p>A sample controller could look like this:</p>

Expand Down Expand Up @@ -71,7 +71,7 @@ <h2 id="class-ActionController::API-label-Redirects">Redirects</h2>

<h2 id="class-ActionController::API-label-Adding+New+Behavior">Adding New Behavior</h2>

<p>In some scenarios you may want to add back some functionality provided by <a href="Base.html"><code>ActionController::Base</code></a> that is not present by default in <code>ActionController::API</code>, for instance <code>MimeResponds</code>. This module gives you the <code>respond_to</code> method. Adding it is quite simple, you just need to include the module in a specific controller or in <code>ApplicationController</code> in case you want it available in your entire application:</p>
<p>In some scenarios you may want to add back some functionality provided by <a href="Base.html"><code>ActionController::Base</code></a> that is not present by default in <a href="API.html"><code>ActionController::API</code></a>, for instance <a href="MimeResponds.html"><code>MimeResponds</code></a>. This module gives you the <code>respond_to</code> method. Adding it is quite simple, you just need to include the module in a specific controller or in <code>ApplicationController</code> in case you want it available in your entire application:</p>

<pre><code>class ApplicationController &lt; ActionController::API
include ActionController::MimeResponds
Expand All @@ -89,7 +89,7 @@ <h2 id="class-ActionController::API-label-Adding+New+Behavior">Adding New Behavi
end
</code></pre>

<p>Make sure to check the modules included in <a href="Base.html"><code>ActionController::Base</code></a> if you want to use any other functionality that is not provided by <code>ActionController::API</code> out of the box.</p>
<p>Make sure to check the modules included in <a href="Base.html"><code>ActionController::Base</code></a> if you want to use any other functionality that is not provided by <a href="API.html"><code>ActionController::API</code></a> out of the box.</p>

</div>

Expand Down
2 changes: 1 addition & 1 deletion src/7.1/classes/ActionController/Base.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h1 id="class-ActionController::Base-label-Action+Controller+Base">Action Contro

<p>Action Controllers are the core of a web request in Rails. They are made up of one or more actions that are executed on request and then either it renders a template or redirects to another action. An action is defined as a public method on the controller, which will automatically be made accessible to the web-server through Rails Routes.</p>

<p>By default, only the ApplicationController in a Rails application inherits from <code>ActionController::Base</code>. All other controllers inherit from ApplicationController. This gives you one class to configure things such as request forgery protection and filtering of sensitive request parameters.</p>
<p>By default, only the ApplicationController in a Rails application inherits from <a href="Base.html"><code>ActionController::Base</code></a>. All other controllers inherit from ApplicationController. This gives you one class to configure things such as request forgery protection and filtering of sensitive request parameters.</p>

<p>A sample controller could look like this:</p>

Expand Down
28 changes: 14 additions & 14 deletions src/7.1/classes/ActionController/ConditionalGet.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,21 +113,21 @@ <h3 id="method-i-expires_in">


<div class="description">
<p>Sets the <code>Cache-Control</code> header, overwriting existing directives. This method will also ensure an HTTP <code>Date</code> header for client compatibility.</p>
<p>Sets the <code>Cache-Control</code> header, overwriting existing directives. This method will also ensure an HTTP <a href="../Date.html"><code>Date</code></a> header for client compatibility.</p>

<p>Defaults to issuing the <code>private</code> directive, so that intermediate caches must not cache the response.</p>

<h4 id="method-i-expires_in-label-Options">Options</h4>
<dl class="rdoc-list label-list"><dt><code>:public</code>
<dl class="rdoc-list label-list"><dt><code>:public</code></dt>
<dd>
<p>If true, replaces the default <code>private</code> directive with the <code>public</code> directive.</p>
</dd><dt><code>:must_revalidate</code>
</dd><dt><code>:must_revalidate</code></dt>
<dd>
<p>If true, adds the <code>must-revalidate</code> directive.</p>
</dd><dt><code>:stale_while_revalidate</code>
</dd><dt><code>:stale_while_revalidate</code></dt>
<dd>
<p>Sets the value of the <code>stale-while-revalidate</code> directive.</p>
</dd><dt><code>:stale_if_error</code>
</dd><dt><code>:stale_if_error</code></dt>
<dd>
<p>Sets the value of the <code>stale-if-error</code> directive.</p>
</dd></dl>
Expand Down Expand Up @@ -237,29 +237,29 @@ <h3 id="method-i-fresh_when">
<p>Sets the <code>etag</code>, <code>last_modified</code>, or both on the response, and renders a <code>304 Not Modified</code> response if the request is already fresh.</p>

<h4 id="method-i-fresh_when-label-Options">Options</h4>
<dl class="rdoc-list label-list"><dt><code>:etag</code>
<dl class="rdoc-list label-list"><dt><code>:etag</code></dt>
<dd>
<p>Sets a “weak” ETag validator on the response. See the <code>:weak_etag</code> option.</p>
</dd><dt><code>:weak_etag</code>
</dd><dt><code>:weak_etag</code></dt>
<dd>
<p>Sets a “weak” ETag validator on the response. Requests that specify an <code>If-None-Match</code> header may receive a <code>304 Not Modified</code> response if the ETag matches exactly.</p>

<p>A weak ETag indicates semantic equivalence, not byte-for-byte equality, so they’re good for caching HTML pages in browser caches. They can’t be used for responses that must be byte-identical, like serving <code>Range</code> requests within a PDF file.</p>
</dd><dt><code>:strong_etag</code>
<p>A weak ETag indicates semantic equivalence, not byte-for-byte equality, so they’re good for caching HTML pages in browser caches. They can’t be used for responses that must be byte-identical, like serving <a href="../Range.html"><code>Range</code></a> requests within a PDF file.</p>
</dd><dt><code>:strong_etag</code></dt>
<dd>
<p>Sets a “strong” ETag validator on the response. Requests that specify an <code>If-None-Match</code> header may receive a <code>304 Not Modified</code> response if the ETag matches exactly.</p>

<p>A strong ETag implies exact equality – the response must match byte for byte. This is necessary for serving <code>Range</code> requests within a large video or PDF file, for example, or for compatibility with some CDNs that don’t support weak ETags.</p>
</dd><dt><code>:last_modified</code>
<p>A strong ETag implies exact equality – the response must match byte for byte. This is necessary for serving <a href="../Range.html"><code>Range</code></a> requests within a large video or PDF file, for example, or for compatibility with some CDNs that don’t support weak ETags.</p>
</dd><dt><code>:last_modified</code></dt>
<dd>
<p>Sets a “weak” last-update validator on the response. Subsequent requests that specify an <code>If-Modified-Since</code> header may receive a <code>304 Not Modified</code> response if <code>last_modified</code> &lt;= <code>If-Modified-Since</code>.</p>
</dd><dt><code>:public</code>
</dd><dt><code>:public</code></dt>
<dd>
<p>By default the <code>Cache-Control</code> header is private. Set this option to <code>true</code> if you want your application to be cacheable by other devices, such as proxy caches.</p>
</dd><dt><code>:cache_control</code>
</dd><dt><code>:cache_control</code></dt>
<dd>
<p>When given, will overwrite an existing <code>Cache-Control</code> header. For a list of <code>Cache-Control</code> directives, see the <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control">article on MDN</a>.</p>
</dd><dt><code>:template</code>
</dd><dt><code>:template</code></dt>
<dd>
<p>By default, the template digest for the current controller/action is included in ETags. If the action renders a different template, you can include its digest instead. If the action doesn’t render a template at all, you can pass <code>template: false</code> to skip any attempt to check for a template digest.</p>
</dd></dl>
Expand Down
Loading