PageRenderTime 28ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/api/classes/ActionController/Caching/Actions.html

https://gitlab.com/ability-list-inc/abilitylist
HTML | 361 lines | 223 code | 135 blank | 3 comment | 0 complexity | 18074a307818cf8cbbcd31504ba97160 MD5 | raw file
    

  1. <?xml version="1.0" encoding="utf-8"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.     <title>ActionController::Caching::Actions</title>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    8. 

  8.     <link rel="stylesheet" href="../../../css/reset.css" type="text/css" media="screen" />
    9. 

  9. <link rel="stylesheet" href="../../../css/main.css" type="text/css" media="screen" />
    10. 

  10. <link rel="stylesheet" href="../../../css/github.css" type="text/css" media="screen" />
    11. 

  11. <script src="../../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
    12. 

  12. <script src="../../../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
    13. 

  13. <script src="../../../js/main.js" type="text/javascript" charset="utf-8"></script>
    14. 

  14. <script src="../../../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
    15. 

  15. 

  16. </head>
    17. 

  17. 

  18. <body>     
    19. 

  19.     <div class="banner">
    20. 

  20.         
    21. 

  21.             <span>Ruby on Rails 4.2.0</span><br />
    22. 

  22.         
    23. 

  23.         <h1>
    24. 

  24.             <span class="type">Module</span> 
    25. 

  25.             ActionController::Caching::Actions 
    26. 

  26.             
    27. 

  27.         </h1>
    28. 

  28.         <ul class="files">
    29. 

  29.             
    30. 

  30.             <li><a href="../../../files/__/__/_rvm/gems/ruby-2_2_0/bundler/gems/actionpack-action_caching-30ae10cba0f0/lib/action_controller/caching/actions_rb.html">/Users/az/.rvm/gems/ruby-2.2.0/bundler/gems/actionpack-action_caching-30ae10cba0f0/lib/action_controller/caching/actions.rb</a></li>
    31. 

  31.             
    32. 

  32.         </ul>
    33. 

  33.     </div>
    34. 

  34.     <div id="bodyContent">
    35. 

  35.         <div id="content">
    36. 

  36.   
    37. 

  37.     <div class="description">
    38. 

  38.       
    39. 

  39. <p>Action caching is similar to page caching by the fact that the entire
    40. 

  40. output of the response is cached, but unlike page caching, every request
    41. 

  41. still goes through Action Pack. The key benefit of this is that filters run
    42. 

  42. before the cache is served, which allows for authentication and other
    43. 

  43. restrictions on whether someone is allowed to execute such action.</p>
    44. 

  44. 

  45. <pre><code>class ListsController &lt; ApplicationController
    46. 

  46.   before_filter :authenticate, except: :public
    47. 

  47. 

  48.   caches_page   :public
    49. 

  49.   caches_action :index, :show
    50. 

  50. end
    51. 

  51. </code></pre>
    52. 

  52. 

  53. <p>In this example, the <code>public</code> action doesn&#39;t require
    54. 

  54. authentication so it&#39;s possible to use the faster page caching. On the
    55. 

  55. other hand <code>index</code> and <code>show</code> require authentication.
    56. 

  56. They can still be cached, but we need action caching for them.</p>
    57. 

  57. 

  58. <p>Action caching uses fragment caching internally and an around filter to do
    59. 

  59. the job. The fragment cache is named according to the host and path of the
    60. 

  60. request. A page that is accessed at
    61. 

  61. <code>http://david.example.com/lists/show/1</code> will result in a
    62. 

  62. fragment named <code>david.example.com/lists/show/1</code>. This allows the
    63. 

  63. cacher to differentiate between <code>david.example.com/lists/</code> and
    64. 

  64. <code>jamis.example.com/lists/</code> – which is a helpful way of assisting
    65. 

  65. the subdomain-as-account-key pattern.</p>
    66. 

  66. 

  67. <p>Different representations of the same resource, e.g.
    68. 

  68. <code>http://david.example.com/lists</code> and
    69. 

  69. <code>http://david.example.com/lists.xml</code> are treated like separate
    70. 

  70. requests and so are cached separately. Keep in mind when expiring an action
    71. 

  71. cache that <code>action: &#39;lists&#39;</code> is not the same as
    72. 

  72. <code>action: &#39;lists&#39;, format: :xml</code>.</p>
    73. 

  73. 

  74. <p>You can modify the default action cache path by passing a
    75. 

  75. <code>:cache_path</code> option. This will be passed directly to
    76. 

  76. <code>ActionCachePath.new</code>. This is handy for actions with multiple
    77. 

  77. possible routes that should be cached differently. If a block is given, it
    78. 

  78. is called with the current controller instance. If an object that responds
    79. 

  79. to <code>call</code> is given, it&#39;ll be called with the current
    80. 

  80. controller instance.</p>
    81. 

  81. 

  82. <p>And you can also use <code>:if</code> (or <code>:unless</code>) to pass a
    83. 

  83. proc that specifies when the action should be cached.</p>
    84. 

  84. 

  85. <p>As of Rails 3.0, you can also pass <code>:expires_in</code> with a time
    86. 

  86. interval (in seconds) to schedule expiration of the cached item.</p>
    87. 

  87. 

  88. <p>The following example depicts some of the points made above:</p>
    89. 

  89. 

  90. <pre><code>class CachePathCreator
    91. 

  91.   def initialize(name)
    92. 

  92.     @name = name
    93. 

  93.   end
    94. 

  94. 

  95.   def call(controller)
    96. 

  96.     &quot;cache-path-#{@name}&quot;
    97. 

  97.   end
    98. 

  98. end
    99. 

  99. 

  100. class ListsController &lt; ApplicationController
    101. 

  101.   before_filter :authenticate, except: :public
    102. 

  102. 

  103.   caches_page :public
    104. 

  104. 

  105.   caches_action :index, if: Proc.new do
    106. 

  106.     !request.format.json?  # cache if is not a JSON request
    107. 

  107.   end
    108. 

  108. 

  109.   caches_action :show, cache_path: { project: 1 },
    110. 

  110.     expires_in: 1.hour
    111. 

  111. 

  112.   caches_action :feed, cache_path: Proc.new do
    113. 

  113.     if params[:user_id]
    114. 

  114.       user_list_url(params[:user_id, params[:id])
    115. 

  115.     else
    116. 

  116.       list_url(params[:id])
    117. 

  117.     end
    118. 

  118.   end
    119. 

  119. 

  120.   caches_action :posts, cache_path: CachePathCreator.new(&#39;posts&#39;)
    121. 

  121. end</code></pre>
    122. 

  122. 

  123. <p>If you pass <code>layout: false</code>, it will only cache your action
    124. 

  124. content. That&#39;s useful when your layout has dynamic information.</p>
    125. 

  125. 

  126. <p>Warning: If the format of the request is determined by the Accept HTTP
    127. 

  127. header the Content-Type of the cached response could be wrong because no
    128. 

  128. information about the MIME type is stored in the cache key. So, if you
    129. 

  129. first ask for MIME type M in the Accept header, a cache entry is created,
    130. 

  130. and then perform a second request to the same resource asking for a
    131. 

  131. different MIME type, you&#39;d get the content cached for M.</p>
    132. 

  132. 

  133. <p>The <code>:format</code> parameter is taken into account though. The safest
    134. 

  134. way to cache by MIME type is to pass the format in the route.</p>
    135. 

  135. 

  136.     </div>
    137. 

  137.   
    138. 

  138. 

  139. 

  140.   
    141. 

  141. 

  142. 

  143.   
    144. 

  144.   
    145. 

  145. 

  146. 

  147.   
    148. 

  148.     <!-- Namespace -->
    149. 

  149.     <div class="sectiontitle">Namespace</div>
    150. 

  150.     <ul>
    151. 

  151.       
    152. 

  152.         <li>
    153. 

  153.           <span class="type">MODULE</span>
    154. 

  154.           <a href="Actions/ClassMethods.html">ActionController::Caching::Actions::ClassMethods</a>
    155. 

  155.         </li>
    156. 

  156.       
    157. 

  157.         <li>
    158. 

  158.           <span class="type">CLASS</span>
    159. 

  159.           <a href="Actions/ActionCachePath.html">ActionController::Caching::Actions::ActionCachePath</a>
    160. 

  160.         </li>
    161. 

  161.       
    162. 

  162.     </ul>
    163. 

  163.   
    164. 

  164. 

  165. 

  166.   
    167. 

  167.     <!-- Method ref -->
    168. 

  168.     <div class="sectiontitle">Methods</div>
    169. 

  169.     <dl class="methods">
    170. 

  170.       
    171. 

  171.         <dt>#</dt>
    172. 

  172.         <dd>
    173. 

  173.           <ul>
    174. 

  174.             
    175. 

  175.               
    176. 

  176.               <li>
    177. 

  177.                 <a href="#method-i-_save_fragment">_save_fragment</a>
    178. 

  178.               </li>
    179. 

  179.             
    180. 

  180.           </ul>
    181. 

  181.         </dd>
    182. 

  182.       
    183. 

  183.         <dt>C</dt>
    184. 

  184.         <dd>
    185. 

  185.           <ul>
    186. 

  186.             
    187. 

  187.               
    188. 

  188.               <li>
    189. 

  189.                 <a href="#method-i-caching_allowed-3F">caching_allowed?</a>
    190. 

  190.               </li>
    191. 

  191.             
    192. 

  192.           </ul>
    193. 

  193.         </dd>
    194. 

  194.       
    195. 

  195.         <dt>E</dt>
    196. 

  196.         <dd>
    197. 

  197.           <ul>
    198. 

  198.             
    199. 

  199.               
    200. 

  200.               <li>
    201. 

  201.                 <a href="#method-i-expire_action">expire_action</a>
    202. 

  202.               </li>
    203. 

  203.             
    204. 

  204.           </ul>
    205. 

  205.         </dd>
    206. 

  206.       
    207. 

  207.     </dl>
    208. 

  208.   
    209. 

  209. 

  210.   
    211. 

  211. 

  212. 

  213. 

  214.   
    215. 

  215. 

  216.     
    217. 

  217. 

  218.     
    219. 

  219. 

  220.     
    221. 

  221. 

  222. 

  223.     
    224. 

  224. 

  225. 

  226.     <!-- Methods -->
    227. 

  227.         
    228. 

  228.       <div class="sectiontitle">Instance Public methods</div>
    229. 

  229.       
    230. 

  230.         <div class="method">
    231. 

  231.           <div class="title method-title" id="method-i-_save_fragment">
    232. 

  232.             
    233. 

  233.               <b>_save_fragment</b>(name, options)
    234. 

  234.             
    235. 

  235.             <a href="../../../classes/ActionController/Caching/Actions.html#method-i-_save_fragment" name="method-i-_save_fragment" class="permalink">Link</a>
    236. 

  236.           </div>
    237. 

  237.           
    238. 

  238.           
    239. 

  239.             <div class="description">
    240. 

  240.               
    241. 

  241.             </div>
    242. 

  242.           
    243. 

  243.           
    244. 

  244.           
    245. 

  245. 

  246.           
    247. 

  247.           
    248. 

  248.           
    249. 

  249.             
    250. 

  250.             <div class="sourcecode">
    251. 

  251.               
    252. 

  252.               <p class="source-link">
    253. 

  253.                 Source: 
    254. 

  254.                 <a href="javascript:toggleSource('method-i-_save_fragment_source')" id="l_method-i-_save_fragment_source">show</a>
    255. 

  255.                 
    256. 

  256.               </p>
    257. 

  257.               <div id="method-i-_save_fragment_source" class="dyn-source">
    258. 

  258.                 <pre><span class="ruby-comment"># File ../../.rvm/gems/ruby-2.2.0/bundler/gems/actionpack-action_caching-30ae10cba0f0/lib/action_controller/caching/actions.rb, line 120</span>
    259. 

  259. <span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">_save_fragment</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span>)
    260. 

  260.   <span class="ruby-identifier">content</span> = <span class="ruby-string">&#39;&#39;</span>
    261. 

  261.   <span class="ruby-identifier">response_body</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">parts</span><span class="ruby-operator">|</span>
    262. 

  262.     <span class="ruby-identifier">content</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">parts</span>
    263. 

  263.   <span class="ruby-keyword">end</span>
    264. 

  264. 

  265.   <span class="ruby-keyword">if</span> <span class="ruby-identifier">caching_allowed?</span>
    266. 

  266.     <span class="ruby-identifier">write_fragment</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">content</span>, <span class="ruby-identifier">options</span>)
    267. 

  267.   <span class="ruby-keyword">else</span>
    268. 

  268.     <span class="ruby-identifier">content</span>
    269. 

  269.   <span class="ruby-keyword">end</span>
    270. 

  270. <span class="ruby-keyword">end</span></pre>
    271. 

  271.               </div>
    272. 

  272.             </div>
    273. 

  273.             
    274. 

  274.           </div>
    275. 

  275.         
    276. 

  276.         <div class="method">
    277. 

  277.           <div class="title method-title" id="method-i-caching_allowed-3F">
    278. 

  278.             
    279. 

  279.               <b>caching_allowed?</b>()
    280. 

  280.             
    281. 

  281.             <a href="../../../classes/ActionController/Caching/Actions.html#method-i-caching_allowed-3F" name="method-i-caching_allowed-3F" class="permalink">Link</a>
    282. 

  282.           </div>
    283. 

  283.           
    284. 

  284.           
    285. 

  285.             <div class="description">
    286. 

  286.               
    287. 

  287.             </div>
    288. 

  288.           
    289. 

  289.           
    290. 

  290.           
    291. 

  291. 

  292.           
    293. 

  293.           
    294. 

  294.           
    295. 

  295.             
    296. 

  296.             <div class="sourcecode">
    297. 

  297.               
    298. 

  298.               <p class="source-link">
    299. 

  299.                 Source: 
    300. 

  300.                 <a href="javascript:toggleSource('method-i-caching_allowed-3F_source')" id="l_method-i-caching_allowed-3F_source">show</a>
    301. 

  301.                 
    302. 

  302.               </p>
    303. 

  303.               <div id="method-i-caching_allowed-3F_source" class="dyn-source">
    304. 

  304.                 <pre><span class="ruby-comment"># File ../../.rvm/gems/ruby-2.2.0/bundler/gems/actionpack-action_caching-30ae10cba0f0/lib/action_controller/caching/actions.rb, line 133</span>
    305. 

  305. <span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">caching_allowed?</span>
    306. 

  306.   (<span class="ruby-identifier">request</span>.<span class="ruby-identifier">get?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">request</span>.<span class="ruby-identifier">head?</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">status</span> <span class="ruby-operator">==</span> <span class="ruby-number">200</span>
    307. 

  307. <span class="ruby-keyword">end</span></pre>
    308. 

  308.               </div>
    309. 

  309.             </div>
    310. 

  310.             
    311. 

  311.           </div>
    312. 

  312.               
    313. 

  313.       <div class="sectiontitle">Instance Protected methods</div>
    314. 

  314.       
    315. 

  315.         <div class="method">
    316. 

  316.           <div class="title method-title" id="method-i-expire_action">
    317. 

  317.             
    318. 

  318.               <b>expire_action</b>(options = {})
    319. 

  319.             
    320. 

  320.             <a href="../../../classes/ActionController/Caching/Actions.html#method-i-expire_action" name="method-i-expire_action" class="permalink">Link</a>
    321. 

  321.           </div>
    322. 

  322.           
    323. 

  323.           
    324. 

  324.             <div class="description">
    325. 

  325.               
    326. 

  326.             </div>
    327. 

  327.           
    328. 

  328.           
    329. 

  329.           
    330. 

  330. 

  331.           
    332. 

  332.           
    333. 

  333.           
    334. 

  334.             
    335. 

  335.             <div class="sourcecode">
    336. 

  336.               
    337. 

  337.               <p class="source-link">
    338. 

  338.                 Source: 
    339. 

  339.                 <a href="javascript:toggleSource('method-i-expire_action_source')" id="l_method-i-expire_action_source">show</a>
    340. 

  340.                 
    341. 

  341.               </p>
    342. 

  342.               <div id="method-i-expire_action_source" class="dyn-source">
    343. 

  343.                 <pre><span class="ruby-comment"># File ../../.rvm/gems/ruby-2.2.0/bundler/gems/actionpack-action_caching-30ae10cba0f0/lib/action_controller/caching/actions.rb, line 138</span>
    344. 

  344. <span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">expire_action</span>(<span class="ruby-identifier">options</span> = {})
    345. 

  345.   <span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">cache_configured?</span>
    346. 

  346. 

  347.   <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:action</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
    348. 

  348.     <span class="ruby-identifier">options</span>[<span class="ruby-value">:action</span>].<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">action</span><span class="ruby-operator">|</span> <span class="ruby-identifier">expire_action</span>(<span class="ruby-identifier">options</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-identifier">action</span>)) }
    349. 

  349.   <span class="ruby-keyword">else</span>
    350. 

  350.     <span class="ruby-identifier">expire_fragment</span>(<span class="ruby-constant">ActionCachePath</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">options</span>, <span class="ruby-keyword">false</span>).<span class="ruby-identifier">path</span>)
    351. 

  351.   <span class="ruby-keyword">end</span>
    352. 

  352. <span class="ruby-keyword">end</span></pre>
    353. 

  353.               </div>
    354. 

  354.             </div>
    355. 

  355.             
    356. 

  356.           </div>
    357. 

  357.                     </div>
    358. 

  358. 

  359.     </div>
    360. 

  360.   </body>
    361. 

  361. </html>    
    362.