renee 0.3.11 → 0.4.0.pre1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (231) hide show
  1. data/Gemfile +17 -0
  2. data/Gemfile-renee +8 -0
  3. data/Gemfile-renee-core +8 -0
  4. data/Gemfile-renee-render +9 -0
  5. data/Gemfile-renee-session +9 -0
  6. data/Gemfile-renee-url-generation +8 -0
  7. data/MIT-LICENSE.txt +7 -0
  8. data/README-renee-core.md +242 -0
  9. data/README-renee-render.md +38 -0
  10. data/README-renee-session.md +3 -0
  11. data/README-renee-url-generation.md +3 -0
  12. data/README.md +131 -6
  13. data/Rakefile +109 -9
  14. data/TODO.txt +45 -0
  15. data/config.ru +26 -0
  16. data/examples/blog/blog.rb +3 -1
  17. data/examples/blog/config.ru +24 -19
  18. data/examples/blog/views/edit.erb +10 -1
  19. data/examples/blog/views/show.erb +5 -0
  20. data/lib/renee.rb +11 -4
  21. data/lib/renee/core.rb +98 -0
  22. data/lib/renee/core/chaining.rb +66 -0
  23. data/lib/renee/core/env_accessors.rb +72 -0
  24. data/lib/renee/core/exceptions.rb +15 -0
  25. data/lib/renee/core/matcher.rb +61 -0
  26. data/lib/renee/core/plugins.rb +31 -0
  27. data/lib/renee/core/rack_interaction.rb +50 -0
  28. data/lib/renee/core/request_context.rb +56 -0
  29. data/lib/renee/core/responding.rb +112 -0
  30. data/lib/renee/core/response.rb +78 -0
  31. data/lib/renee/core/routing.rb +319 -0
  32. data/lib/renee/core/transform.rb +18 -0
  33. data/lib/renee/render.rb +221 -0
  34. data/lib/renee/session.rb +50 -0
  35. data/lib/renee/url_generation.rb +117 -0
  36. data/lib/renee/util.rb +7 -0
  37. data/lib/renee/version.rb +2 -4
  38. data/plan.txt +19 -0
  39. data/renee-core.gemspec +26 -0
  40. data/renee-render.gemspec +30 -0
  41. data/renee-session.gemspec +28 -0
  42. data/renee-url-generation.gemspec +24 -0
  43. data/renee.gemspec +5 -6
  44. data/site/MIT-LICENSE.txt +7 -0
  45. data/site/public/css/app.css +75 -0
  46. data/site/public/docs/renee-core/Renee.html +208 -0
  47. data/site/public/docs/renee-core/Renee/Core.html +366 -0
  48. data/site/public/docs/renee-core/Renee/Core/Chaining.html +192 -0
  49. data/site/public/docs/renee-core/Renee/Core/ClassMethods.html +725 -0
  50. data/site/public/docs/renee-core/Renee/Core/ClientError.html +317 -0
  51. data/site/public/docs/renee-core/Renee/Core/EnvAccessors.html +152 -0
  52. data/site/public/docs/renee-core/Renee/Core/EnvAccessors/ClassMethods.html +354 -0
  53. data/site/public/docs/renee-core/Renee/Core/Matcher.html +675 -0
  54. data/site/public/docs/renee-core/Renee/Core/Plugins.html +475 -0
  55. data/site/public/docs/renee-core/Renee/Core/RackInteraction.html +488 -0
  56. data/site/public/docs/renee-core/Renee/Core/RequestContext.html +511 -0
  57. data/site/public/docs/renee-core/Renee/Core/Responding.html +877 -0
  58. data/site/public/docs/renee-core/Renee/Core/Response.html +691 -0
  59. data/site/public/docs/renee-core/Renee/Core/Routing.html +1589 -0
  60. data/site/public/docs/renee-core/Renee/Core/Transform.html +249 -0
  61. data/site/public/docs/renee-core/Renee/Core/URLGeneration.html +597 -0
  62. data/site/public/docs/renee-core/_index.html +244 -0
  63. data/site/public/docs/renee-core/class_list.html +47 -0
  64. data/site/public/docs/renee-core/css/common.css +1 -0
  65. data/site/public/docs/renee-core/css/full_list.css +55 -0
  66. data/site/public/docs/renee-core/css/style.css +322 -0
  67. data/site/public/docs/renee-core/file.README-renee-core.html +341 -0
  68. data/site/public/docs/renee-core/file.README.html +212 -0
  69. data/site/public/docs/renee-core/file_list.html +49 -0
  70. data/site/public/docs/renee-core/frames.html +13 -0
  71. data/site/public/docs/renee-core/index.html +341 -0
  72. data/site/public/docs/renee-core/js/app.js +205 -0
  73. data/site/public/docs/renee-core/js/full_list.js +167 -0
  74. data/site/public/docs/renee-core/js/jquery.js +16 -0
  75. data/site/public/docs/renee-core/method_list.html +590 -0
  76. data/site/public/docs/renee-core/top-level-namespace.html +103 -0
  77. data/site/public/docs/renee-render/Renee.html +116 -0
  78. data/site/public/docs/renee-render/Renee/Core.html +346 -0
  79. data/site/public/docs/renee-render/Renee/Core/Chaining.html +125 -0
  80. data/site/public/docs/renee-render/Renee/Core/ClassMethods.html +620 -0
  81. data/site/public/docs/renee-render/Renee/Core/ClientError.html +317 -0
  82. data/site/public/docs/renee-render/Renee/Core/EnvAccessors.html +152 -0
  83. data/site/public/docs/renee-render/Renee/Core/EnvAccessors/ClassMethods.html +354 -0
  84. data/site/public/docs/renee-render/Renee/Core/Matcher.html +675 -0
  85. data/site/public/docs/renee-render/Renee/Core/RackInteraction.html +488 -0
  86. data/site/public/docs/renee-render/Renee/Core/RequestContext.html +421 -0
  87. data/site/public/docs/renee-render/Renee/Core/Responding.html +873 -0
  88. data/site/public/docs/renee-render/Renee/Core/Response.html +691 -0
  89. data/site/public/docs/renee-render/Renee/Core/Routing.html +1682 -0
  90. data/site/public/docs/renee-render/Renee/Core/Transform.html +249 -0
  91. data/site/public/docs/renee-render/Renee/Core/URLGeneration.html +597 -0
  92. data/site/public/docs/renee-render/Renee/Render.html +873 -0
  93. data/site/public/docs/renee-render/Renee/Render/ClassMethods.html +382 -0
  94. data/site/public/docs/renee-render/Renee/Render/TemplateNotFound.html +126 -0
  95. data/site/public/docs/renee-render/_index.html +143 -0
  96. data/site/public/docs/renee-render/class_list.html +47 -0
  97. data/site/public/docs/renee-render/css/common.css +1 -0
  98. data/site/public/docs/renee-render/css/full_list.css +55 -0
  99. data/site/public/docs/renee-render/css/style.css +322 -0
  100. data/site/public/docs/renee-render/file.README-renee-render.html +104 -0
  101. data/site/public/docs/renee-render/file.README.html +212 -0
  102. data/site/public/docs/renee-render/file_list.html +49 -0
  103. data/site/public/docs/renee-render/frames.html +13 -0
  104. data/site/public/docs/renee-render/index.html +104 -0
  105. data/site/public/docs/renee-render/js/app.js +205 -0
  106. data/site/public/docs/renee-render/js/full_list.js +167 -0
  107. data/site/public/docs/renee-render/js/jquery.js +16 -0
  108. data/site/public/docs/renee-render/method_list.html +110 -0
  109. data/site/public/docs/renee-render/top-level-namespace.html +103 -0
  110. data/site/public/docs/renee-session/Renee.html +106 -0
  111. data/site/public/docs/renee-session/Renee/Session.html +173 -0
  112. data/site/public/docs/renee-session/Renee/Session/ClassMethods.html +470 -0
  113. data/site/public/docs/renee-session/_index.html +136 -0
  114. data/site/public/docs/renee-session/class_list.html +47 -0
  115. data/site/public/docs/renee-session/css/common.css +1 -0
  116. data/site/public/docs/renee-session/css/full_list.css +55 -0
  117. data/site/public/docs/renee-session/css/style.css +322 -0
  118. data/site/public/docs/renee-session/file.README-renee-core.html +341 -0
  119. data/site/public/docs/renee-session/file.README-renee-session.html +69 -0
  120. data/site/public/docs/renee-session/file_list.html +49 -0
  121. data/site/public/docs/renee-session/frames.html +13 -0
  122. data/site/public/docs/renee-session/index.html +69 -0
  123. data/site/public/docs/renee-session/js/app.js +205 -0
  124. data/site/public/docs/renee-session/js/full_list.js +167 -0
  125. data/site/public/docs/renee-session/js/jquery.js +16 -0
  126. data/site/public/docs/renee-session/method_list.html +102 -0
  127. data/site/public/docs/renee-session/top-level-namespace.html +103 -0
  128. data/site/public/docs/renee-url-generation/Renee.html +208 -0
  129. data/site/public/docs/renee-url-generation/Renee/Core.html +366 -0
  130. data/site/public/docs/renee-url-generation/Renee/Core/Chaining.html +192 -0
  131. data/site/public/docs/renee-url-generation/Renee/Core/ClassMethods.html +725 -0
  132. data/site/public/docs/renee-url-generation/Renee/Core/ClientError.html +317 -0
  133. data/site/public/docs/renee-url-generation/Renee/Core/EnvAccessors.html +152 -0
  134. data/site/public/docs/renee-url-generation/Renee/Core/EnvAccessors/ClassMethods.html +354 -0
  135. data/site/public/docs/renee-url-generation/Renee/Core/Matcher.html +675 -0
  136. data/site/public/docs/renee-url-generation/Renee/Core/Plugins.html +475 -0
  137. data/site/public/docs/renee-url-generation/Renee/Core/RackInteraction.html +488 -0
  138. data/site/public/docs/renee-url-generation/Renee/Core/RequestContext.html +511 -0
  139. data/site/public/docs/renee-url-generation/Renee/Core/Responding.html +877 -0
  140. data/site/public/docs/renee-url-generation/Renee/Core/Response.html +691 -0
  141. data/site/public/docs/renee-url-generation/Renee/Core/Routing.html +1589 -0
  142. data/site/public/docs/renee-url-generation/Renee/Core/Transform.html +249 -0
  143. data/site/public/docs/renee-url-generation/_index.html +244 -0
  144. data/site/public/docs/renee-url-generation/class_list.html +47 -0
  145. data/site/public/docs/renee-url-generation/css/common.css +1 -0
  146. data/site/public/docs/renee-url-generation/css/full_list.css +55 -0
  147. data/site/public/docs/renee-url-generation/css/style.css +322 -0
  148. data/site/public/docs/renee-url-generation/file.README-renee-url-generation.html +69 -0
  149. data/site/public/docs/renee-url-generation/file_list.html +49 -0
  150. data/site/public/docs/renee-url-generation/frames.html +13 -0
  151. data/site/public/docs/renee-url-generation/index.html +69 -0
  152. data/site/public/docs/renee-url-generation/js/app.js +205 -0
  153. data/site/public/docs/renee-url-generation/js/full_list.js +167 -0
  154. data/site/public/docs/renee-url-generation/js/jquery.js +16 -0
  155. data/site/public/docs/renee-url-generation/method_list.html +590 -0
  156. data/site/public/docs/renee-url-generation/top-level-namespace.html +103 -0
  157. data/site/public/docs/renee/Renee.html +232 -0
  158. data/site/public/docs/renee/Renee/Application.html +367 -0
  159. data/site/public/docs/renee/Renee/Core.html +370 -0
  160. data/site/public/docs/renee/Renee/Core/Chaining.html +192 -0
  161. data/site/public/docs/renee/Renee/Core/ClassMethods.html +725 -0
  162. data/site/public/docs/renee/Renee/Core/ClientError.html +317 -0
  163. data/site/public/docs/renee/Renee/Core/EnvAccessors.html +152 -0
  164. data/site/public/docs/renee/Renee/Core/EnvAccessors/ClassMethods.html +354 -0
  165. data/site/public/docs/renee/Renee/Core/Matcher.html +675 -0
  166. data/site/public/docs/renee/Renee/Core/Plugins.html +475 -0
  167. data/site/public/docs/renee/Renee/Core/RackInteraction.html +488 -0
  168. data/site/public/docs/renee/Renee/Core/RequestContext.html +511 -0
  169. data/site/public/docs/renee/Renee/Core/Responding.html +877 -0
  170. data/site/public/docs/renee/Renee/Core/Response.html +691 -0
  171. data/site/public/docs/renee/Renee/Core/Routing.html +1589 -0
  172. data/site/public/docs/renee/Renee/Core/Transform.html +249 -0
  173. data/site/public/docs/renee/Renee/Core/URLGeneration.html +597 -0
  174. data/site/public/docs/renee/Renee/Render.html +877 -0
  175. data/site/public/docs/renee/Renee/Render/ClassMethods.html +382 -0
  176. data/site/public/docs/renee/Renee/Render/TemplateNotFound.html +126 -0
  177. data/site/public/docs/renee/Renee/Session.html +177 -0
  178. data/site/public/docs/renee/Renee/Session/ClassMethods.html +470 -0
  179. data/site/public/docs/renee/Renee/URLGeneration.html +142 -0
  180. data/site/public/docs/renee/Renee/URLGeneration/ClassMethods.html +593 -0
  181. data/site/public/docs/renee/Renee/Util.html +163 -0
  182. data/site/public/docs/renee/_index.html +336 -0
  183. data/site/public/docs/renee/class_list.html +47 -0
  184. data/site/public/docs/renee/css/common.css +1 -0
  185. data/site/public/docs/renee/css/full_list.css +55 -0
  186. data/site/public/docs/renee/css/style.css +322 -0
  187. data/site/public/docs/renee/file.README.html +212 -0
  188. data/site/public/docs/renee/file_list.html +49 -0
  189. data/site/public/docs/renee/frames.html +13 -0
  190. data/site/public/docs/renee/index.html +212 -0
  191. data/site/public/docs/renee/js/app.js +205 -0
  192. data/site/public/docs/renee/js/full_list.js +167 -0
  193. data/site/public/docs/renee/js/jquery.js +16 -0
  194. data/site/public/docs/renee/method_list.html +758 -0
  195. data/site/public/docs/renee/top-level-namespace.html +202 -0
  196. data/site/public/img/favicon.ico +0 -0
  197. data/site/public/img/reneeclean.png +0 -0
  198. data/site/public/img/russiangithub.png +0 -0
  199. data/site/public/img/stoneposter.png +0 -0
  200. data/site/public/img/vospit.jpeg +0 -0
  201. data/site/views/chaining.md +32 -0
  202. data/site/views/index.md +219 -0
  203. data/site/views/layouts/app.haml +16 -0
  204. data/site/views/rack-integration.md +51 -0
  205. data/site/views/responding.md +103 -0
  206. data/site/views/route-generation.md +82 -0
  207. data/site/views/routing.md +261 -0
  208. data/site/views/settings.md +19 -0
  209. data/site/views/team-renee.md +13 -0
  210. data/site/views/tutorial.md +57 -0
  211. data/site/views/variable-types.md +57 -0
  212. data/test.watchr +61 -0
  213. data/test/renee-core/chaining_test.rb +33 -0
  214. data/test/renee-core/env_accessors_test.rb +43 -0
  215. data/test/renee-core/include_test.rb +14 -0
  216. data/test/renee-core/request_context_test.rb +70 -0
  217. data/test/renee-core/responding_test.rb +128 -0
  218. data/test/renee-core/routing_test.rb +443 -0
  219. data/test/renee-core/test_helper.rb +4 -0
  220. data/test/renee-core/variable_type_test.rb +57 -0
  221. data/test/renee-render/render_test.rb +162 -0
  222. data/test/renee-render/test_helper.rb +9 -0
  223. data/test/renee-session/session_test.rb +31 -0
  224. data/test/renee-session/test_helper.rb +9 -0
  225. data/test/renee-url-generation/test_helper.rb +10 -0
  226. data/test/renee-url-generation/url_generation_test.rb +63 -0
  227. data/test/{blog_test.rb → renee/blog_test.rb} +10 -5
  228. data/test/renee/test_helper.rb +56 -0
  229. data/test/test_helper.rb +23 -10
  230. metadata +333 -156
  231. data/.yardopts +0 -6
data/site/public/docs/renee-render/Renee/Core/RequestContext.html ADDED
@@ -0,0 +1,421 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: Renee::Core::RequestContext
8
+
9
+ &mdash; Documentation by YARD 0.7.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '../..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../../_index.html">Index (R)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../../Renee.html" title="Renee (module)">Renee</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Core.html" title="Renee::Core (class)">Core</a></span></span>
38
+ &raquo;
39
+ <span class="title">RequestContext</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Module: Renee::Core::RequestContext
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+ <dt class="r1">Included in:</dt>
74
+ <dd class="r1"><span class='object_link'><a href="../Core.html" title="Renee::Core (class)">Renee::Core</a></span></dd>
75
+
76
+
77
+
78
+ <dt class="r2 last">Defined in:</dt>
79
+ <dd class="r2 last">lib/renee/core/request_context.rb</dd>
80
+
81
+ </dl>
82
+ <div class="clear"></div>
83
+
84
+ <h2>Overview</h2><div class="docstring">
85
+ <div class="discussion">
86
+ <p>This module deals with the Rack#call compilance. It defines #call and also defines several critical methods
87
+ used by interaction by other application modules.</p>
88
+
89
+
90
+ </div>
91
+ </div>
92
+ <div class="tags">
93
+
94
+
95
+ </div>
96
+
97
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
98
+ <ul class="summary">
99
+
100
+ <li class="public ">
101
+ <span class="summary_signature">
102
+
103
+ <a href="#detected_extension-instance_method" title="#detected_extension (instance method)">- (Object) <strong>detected_extension</strong> </a>
104
+
105
+
106
+
107
+ </span>
108
+
109
+
110
+ <span class="note title readonly">readonly</span>
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute detected_extension.</p>
120
+ </div></span>
121
+
122
+ </li>
123
+
124
+
125
+ <li class="public ">
126
+ <span class="summary_signature">
127
+
128
+ <a href="#env-instance_method" title="#env (instance method)">- (Object) <strong>env</strong> </a>
129
+
130
+
131
+
132
+ </span>
133
+
134
+
135
+ <span class="note title readonly">readonly</span>
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute env.</p>
145
+ </div></span>
146
+
147
+ </li>
148
+
149
+
150
+ <li class="public ">
151
+ <span class="summary_signature">
152
+
153
+ <a href="#request-instance_method" title="#request (instance method)">- (Object) <strong>request</strong> </a>
154
+
155
+
156
+
157
+ </span>
158
+
159
+
160
+ <span class="note title readonly">readonly</span>
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+ <span class="summary_desc"><div class='inline'><p>Returns the value of attribute request.</p>
170
+ </div></span>
171
+
172
+ </li>
173
+
174
+
175
+ </ul>
176
+
177
+
178
+
179
+
180
+
181
+ <h2>
182
+ Instance Method Summary
183
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
184
+ </h2>
185
+
186
+ <ul class="summary">
187
+
188
+ <li class="public ">
189
+ <span class="summary_signature">
190
+
191
+ <a href="#call-instance_method" title="#call (instance method)">- (Object) <strong>call</strong>(env) </a>
192
+
193
+
194
+
195
+ </span>
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+ <span class="summary_desc"><div class='inline'><p>Provides a rack interface compliant call method.</p>
205
+ </div></span>
206
+
207
+ </li>
208
+
209
+
210
+ </ul>
211
+
212
+
213
+
214
+ <div id="instance_attr_details" class="attr_details">
215
+ <h2>Instance Attribute Details</h2>
216
+
217
+
218
+ <span id=""></span>
219
+ <span id="detected_extension-instance_method"></span>
220
+ <div class="method_details first">
221
+ <p class="signature first" id="detected_extension-instance_method">
222
+
223
+ - (<tt>Object</tt>) <strong>detected_extension</strong> <span class="extras">(readonly)</span>
224
+
225
+
226
+
227
+ </p><div class="docstring">
228
+ <div class="discussion">
229
+ <p>Returns the value of attribute detected_extension</p>
230
+
231
+
232
+ </div>
233
+ </div>
234
+ <div class="tags">
235
+
236
+
237
+ </div><table class="source_code">
238
+ <tr>
239
+ <td>
240
+ <pre class="lines">
241
+
242
+
243
+ 6
244
+ 7
245
+ 8</pre>
246
+ </td>
247
+ <td>
248
+ <pre class="code"><span class="info file"># File 'lib/renee/core/request_context.rb', line 6</span>
249
+
250
+ <span class='kw'>def</span> <span class='id detected_extension'>detected_extension</span>
251
+ <span class='ivar'>@detected_extension</span>
252
+ <span class='kw'>end</span></pre>
253
+ </td>
254
+ </tr>
255
+ </table>
256
+ </div>
257
+
258
+
259
+ <span id=""></span>
260
+ <span id="env-instance_method"></span>
261
+ <div class="method_details ">
262
+ <p class="signature " id="env-instance_method">
263
+
264
+ - (<tt>Object</tt>) <strong>env</strong> <span class="extras">(readonly)</span>
265
+
266
+
267
+
268
+ </p><div class="docstring">
269
+ <div class="discussion">
270
+ <p>Returns the value of attribute env</p>
271
+
272
+
273
+ </div>
274
+ </div>
275
+ <div class="tags">
276
+
277
+
278
+ </div><table class="source_code">
279
+ <tr>
280
+ <td>
281
+ <pre class="lines">
282
+
283
+
284
+ 6
285
+ 7
286
+ 8</pre>
287
+ </td>
288
+ <td>
289
+ <pre class="code"><span class="info file"># File 'lib/renee/core/request_context.rb', line 6</span>
290
+
291
+ <span class='kw'>def</span> <span class='id env'>env</span>
292
+ <span class='ivar'>@env</span>
293
+ <span class='kw'>end</span></pre>
294
+ </td>
295
+ </tr>
296
+ </table>
297
+ </div>
298
+
299
+
300
+ <span id=""></span>
301
+ <span id="request-instance_method"></span>
302
+ <div class="method_details ">
303
+ <p class="signature " id="request-instance_method">
304
+
305
+ - (<tt>Object</tt>) <strong>request</strong> <span class="extras">(readonly)</span>
306
+
307
+
308
+
309
+ </p><div class="docstring">
310
+ <div class="discussion">
311
+ <p>Returns the value of attribute request</p>
312
+
313
+
314
+ </div>
315
+ </div>
316
+ <div class="tags">
317
+
318
+
319
+ </div><table class="source_code">
320
+ <tr>
321
+ <td>
322
+ <pre class="lines">
323
+
324
+
325
+ 6
326
+ 7
327
+ 8</pre>
328
+ </td>
329
+ <td>
330
+ <pre class="code"><span class="info file"># File 'lib/renee/core/request_context.rb', line 6</span>
331
+
332
+ <span class='kw'>def</span> <span class='id request'>request</span>
333
+ <span class='ivar'>@request</span>
334
+ <span class='kw'>end</span></pre>
335
+ </td>
336
+ </tr>
337
+ </table>
338
+ </div>
339
+
340
+ </div>
341
+
342
+
343
+ <div id="instance_method_details" class="method_details_list">
344
+ <h2>Instance Method Details</h2>
345
+
346
+
347
+ <div class="method_details first">
348
+ <p class="signature first" id="call-instance_method">
349
+
350
+ - (<tt>Object</tt>) <strong>call</strong>(env)
351
+
352
+
353
+
354
+ </p><div class="docstring">
355
+ <div class="discussion">
356
+ <p>Provides a rack interface compliant call method.
357
+ @param[Hash] env The rack environment.</p>
358
+
359
+
360
+ </div>
361
+ </div>
362
+ <div class="tags">
363
+
364
+
365
+ </div><table class="source_code">
366
+ <tr>
367
+ <td>
368
+ <pre class="lines">
369
+
370
+
371
+ 10
372
+ 11
373
+ 12
374
+ 13
375
+ 14
376
+ 15
377
+ 16
378
+ 17
379
+ 18
380
+ 19
381
+ 20
382
+ 21
383
+ 22
384
+ 23
385
+ 24</pre>
386
+ </td>
387
+ <td>
388
+ <pre class="code"><span class="info file"># File 'lib/renee/core/request_context.rb', line 10</span>
389
+
390
+ <span class='kw'>def</span> <span class='id call'>call</span><span class='lparen'>(</span><span class='id env'>env</span><span class='rparen'>)</span>
391
+ <span class='ivar'>@env</span><span class='comma'>,</span> <span class='ivar'>@request</span> <span class='op'>=</span> <span class='id env'>env</span><span class='comma'>,</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id env'>env</span><span class='rparen'>)</span>
392
+ <span class='ivar'>@detected_extension</span> <span class='op'>=</span> <span class='id env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>PATH_INFO</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\.([^\.\/]+)$</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='int'>1</span><span class='rbracket'>]</span>
393
+ <span class='comment'># TODO clear template cache in development? `template_cache.clear`
394
+ </span> <span class='id catch'>catch</span><span class='lparen'>(</span><span class='symbol'>:halt</span><span class='rparen'>)</span> <span class='kw'>do</span>
395
+ <span class='kw'>begin</span>
396
+ <span class='id instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='kw'>self</span><span class='period'>.</span><span class='id class'>class</span><span class='period'>.</span><span class='id application_block'>application_block</span><span class='rparen'>)</span>
397
+ <span class='kw'>rescue</span> <span class='const'>ClientError</span> <span class='op'>=&gt;</span> <span class='id e'>e</span>
398
+ <span class='id e'>e</span><span class='period'>.</span><span class='id response'>response</span> <span class='op'>?</span> <span class='id instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id e'>e</span><span class='period'>.</span><span class='id response'>response</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id halt'>halt</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>There was an error with your request</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='int'>400</span><span class='rparen'>)</span>
399
+ <span class='kw'>rescue</span> <span class='const'>NotMatchedError</span> <span class='op'>=&gt;</span> <span class='id e'>e</span>
400
+ <span class='comment'># unmatched, continue on
401
+ </span> <span class='kw'>end</span>
402
+ <span class='const'>Renee</span><span class='op'>::</span><span class='const'>Core</span><span class='op'>::</span><span class='const'>Response</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Not found</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='int'>404</span><span class='rparen'>)</span><span class='period'>.</span><span class='id finish'>finish</span>
403
+ <span class='kw'>end</span>
404
+ <span class='kw'>end</span></pre>
405
+ </td>
406
+ </tr>
407
+ </table>
408
+ </div>
409
+
410
+ </div>
411
+
412
+ </div>
413
+
414
+ <div id="footer">
415
+ Generated on Thu Dec 22 09:52:35 2011 by
416
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
417
+ 0.7.3 (ruby-1.9.2).
418
+ </div>
419
+
420
+ </body>
421
+ </html>
data/site/public/docs/renee-render/Renee/Core/Responding.html ADDED
@@ -0,0 +1,873 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: Renee::Core::Responding
8
+
9
+ &mdash; Documentation by YARD 0.7.3
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '../..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../../_index.html">Index (R)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../../Renee.html" title="Renee (module)">Renee</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Core.html" title="Renee::Core (class)">Core</a></span></span>
38
+ &raquo;
39
+ <span class="title">Responding</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Module: Renee::Core::Responding
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+ <dt class="r1">Included in:</dt>
74
+ <dd class="r1"><span class='object_link'><a href="../Core.html" title="Renee::Core (class)">Renee::Core</a></span></dd>
75
+
76
+
77
+
78
+ <dt class="r2 last">Defined in:</dt>
79
+ <dd class="r2 last">lib/renee/core/responding.rb</dd>
80
+
81
+ </dl>
82
+ <div class="clear"></div>
83
+
84
+ <h2>Overview</h2><div class="docstring">
85
+ <div class="discussion">
86
+ <p>Collection of useful methods for responding within a <span class='object_link'><a href="../Core.html" title="Renee::Core (class)">Renee::Core</a></span> app.</p>
87
+
88
+
89
+ </div>
90
+ </div>
91
+ <div class="tags">
92
+
93
+
94
+ </div>
95
+ <h2>Constant Summary</h2>
96
+
97
+ <dl class="constants">
98
+
99
+ <dt id="HTTP_CODES-constant" class="">HTTP_CODES =
100
+ <div class="docstring">
101
+ <div class="discussion">
102
+ <p>Codes used by Symbol lookup in interpret_response.</p>
103
+
104
+
105
+ </div>
106
+ </div>
107
+ <div class="tags">
108
+
109
+ <div class="examples">
110
+ <h3>Examples:</h3>
111
+
112
+ <h4><div class='inline'>
113
+ </div></h4>
114
+ <pre class="example code"><span class='id halt'>halt</span> <span class='symbol'>:unauthorized</span> <span class='comment'># would return a 401.</span></pre>
115
+
116
+ </div>
117
+
118
+
119
+ </div>
120
+ </dt>
121
+ <dd><pre class="code"><span class='lbrace'>{</span>
122
+ <span class='symbol'>:ok</span> <span class='op'>=&gt;</span> <span class='int'>200</span><span class='comma'>,</span>
123
+ <span class='symbol'>:created</span> <span class='op'>=&gt;</span> <span class='int'>201</span><span class='comma'>,</span>
124
+ <span class='symbol'>:accepted</span> <span class='op'>=&gt;</span> <span class='int'>202</span><span class='comma'>,</span>
125
+ <span class='symbol'>:no_content</span> <span class='op'>=&gt;</span> <span class='int'>204</span><span class='comma'>,</span>
126
+ <span class='symbol'>:no_content</span> <span class='op'>=&gt;</span> <span class='int'>204</span><span class='comma'>,</span>
127
+ <span class='symbol'>:bad_request</span> <span class='op'>=&gt;</span> <span class='int'>400</span><span class='comma'>,</span>
128
+ <span class='symbol'>:unauthorized</span> <span class='op'>=&gt;</span> <span class='int'>401</span><span class='comma'>,</span>
129
+ <span class='symbol'>:payment_required</span> <span class='op'>=&gt;</span> <span class='int'>403</span><span class='comma'>,</span>
130
+ <span class='symbol'>:not_found</span> <span class='op'>=&gt;</span> <span class='int'>404</span><span class='comma'>,</span>
131
+ <span class='symbol'>:method_not_found</span> <span class='op'>=&gt;</span> <span class='int'>405</span><span class='comma'>,</span>
132
+ <span class='symbol'>:not_acceptable</span> <span class='op'>=&gt;</span> <span class='int'>406</span><span class='comma'>,</span>
133
+ <span class='symbol'>:gone</span> <span class='op'>=&gt;</span> <span class='int'>410</span><span class='comma'>,</span>
134
+ <span class='symbol'>:error</span> <span class='op'>=&gt;</span> <span class='int'>500</span><span class='comma'>,</span>
135
+ <span class='symbol'>:not_implemented</span> <span class='op'>=&gt;</span> <span class='int'>501</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id freeze'>freeze</span></pre></dd>
136
+
137
+ </dl>
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+ <h2>
146
+ Instance Method Summary
147
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
148
+ </h2>
149
+
150
+ <ul class="summary">
151
+
152
+ <li class="public ">
153
+ <span class="summary_signature">
154
+
155
+ <a href="#halt-instance_method" title="#halt (instance method)">- (Object) <strong>halt</strong>(*response) </a>
156
+
157
+
158
+
159
+ </span>
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+ <span class="summary_desc"><div class='inline'><p>Halts current processing to the top-level calling Renee application and uses that as a response.</p>
169
+ </div></span>
170
+
171
+ </li>
172
+
173
+
174
+ <li class="public ">
175
+ <span class="summary_signature">
176
+
177
+ <a href="#interpret_response-instance_method" title="#interpret_response (instance method)">- (Object) <strong>interpret_response</strong>(response) </a>
178
+
179
+
180
+
181
+ </span>
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+ <span class="summary_desc"><div class='inline'><p>Interprets responses returns by #halt.</p>
191
+ </div></span>
192
+
193
+ </li>
194
+
195
+
196
+ <li class="public ">
197
+ <span class="summary_signature">
198
+
199
+ <a href="#redirect-instance_method" title="#redirect (instance method)">- (Object) <strong>redirect</strong>(path, code = 302) </a>
200
+
201
+
202
+
203
+ </span>
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <span class="summary_desc"><div class='inline'><p>Returns a rack-based response for redirection.</p>
213
+ </div></span>
214
+
215
+ </li>
216
+
217
+
218
+ <li class="public ">
219
+ <span class="summary_signature">
220
+
221
+ <a href="#redirect%21-instance_method" title="#redirect! (instance method)">- (Object) <strong>redirect!</strong>(path, code = 302) </a>
222
+
223
+
224
+
225
+ </span>
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+ <span class="summary_desc"><div class='inline'><p>Halts with a rack-based response for redirection.</p>
235
+ </div></span>
236
+
237
+ </li>
238
+
239
+
240
+ <li class="public ">
241
+ <span class="summary_signature">
242
+
243
+ <a href="#respond-instance_method" title="#respond (instance method)">- (Object) <strong>respond</strong>(body = [], status = 200, header = {}, &amp;blk) </a>
244
+
245
+
246
+
247
+ </span>
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+ <span class="summary_desc"><div class='inline'><p>Creates a response by allowing the response header, body and status to be passed into the block.</p>
257
+ </div></span>
258
+
259
+ </li>
260
+
261
+
262
+ <li class="public ">
263
+ <span class="summary_signature">
264
+
265
+ <a href="#respond%21-instance_method" title="#respond! (instance method)">- (Object) <strong>respond!</strong>(*args, &amp;blk) </a>
266
+
267
+
268
+
269
+ </span>
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+ <span class="summary_desc"><div class='inline'><p>Creates a response by allowing the response header, body and status to be passed into the block.</p>
279
+ </div></span>
280
+
281
+ </li>
282
+
283
+
284
+ </ul>
285
+
286
+
287
+
288
+
289
+ <div id="instance_method_details" class="method_details_list">
290
+ <h2>Instance Method Details</h2>
291
+
292
+
293
+ <div class="method_details first">
294
+ <p class="signature first" id="halt-instance_method">
295
+
296
+ - (<tt>Object</tt>) <strong>halt</strong>(*response)
297
+
298
+
299
+
300
+ </p><div class="docstring">
301
+ <div class="discussion">
302
+ <p>Halts current processing to the top-level calling Renee application and uses that as a response.</p>
303
+
304
+
305
+ </div>
306
+ </div>
307
+ <div class="tags">
308
+ <h3>Parameters:</h3>
309
+ <ul class="param">
310
+
311
+ <li>
312
+
313
+ <span class='name'>response</span>
314
+
315
+
316
+ <span class='type'>(<tt>Object...</tt>)</span>
317
+
318
+
319
+
320
+ &mdash;
321
+ <div class='inline'><p>The response to use.</p>
322
+ </div>
323
+
324
+ </li>
325
+
326
+ </ul>
327
+
328
+
329
+ <h3>See Also:</h3>
330
+ <ul class="see">
331
+
332
+ <li><span class='object_link'><a href="#interpret_response-instance_method" title="Renee::Core::Responding#interpret_response (method)">#interpret_response</a></span></li>
333
+
334
+ </ul>
335
+
336
+ </div><table class="source_code">
337
+ <tr>
338
+ <td>
339
+ <pre class="lines">
340
+
341
+
342
+ 28
343
+ 29
344
+ 30</pre>
345
+ </td>
346
+ <td>
347
+ <pre class="code"><span class="info file"># File 'lib/renee/core/responding.rb', line 28</span>
348
+
349
+ <span class='kw'>def</span> <span class='id halt'>halt</span><span class='lparen'>(</span><span class='op'>*</span><span class='id response'>response</span><span class='rparen'>)</span>
350
+ <span class='id throw'>throw</span> <span class='symbol'>:halt</span><span class='comma'>,</span> <span class='id interpret_response'>interpret_response</span><span class='lparen'>(</span><span class='id response'>response</span><span class='period'>.</span><span class='id size'>size</span> <span class='op'>==</span> <span class='int'>1</span> <span class='op'>?</span> <span class='id response'>response</span><span class='period'>.</span><span class='id first'>first</span> <span class='op'>:</span> <span class='id response'>response</span><span class='rparen'>)</span>
351
+ <span class='kw'>end</span></pre>
352
+ </td>
353
+ </tr>
354
+ </table>
355
+ </div>
356
+
357
+ <div class="method_details ">
358
+ <p class="signature " id="interpret_response-instance_method">
359
+
360
+ - (<tt>Object</tt>) <strong>interpret_response</strong>(response)
361
+
362
+
363
+
364
+ </p><div class="docstring">
365
+ <div class="discussion">
366
+ <p>Interprets responses returns by #halt.</p>
367
+
368
+ <ul>
369
+ <li>If it is a Symbol, it will be looked up in <span class='object_link'><a href="#HTTP_CODES-constant" title="Renee::Core::Responding::HTTP_CODES (constant)">HTTP_CODES</a></span>.</li>
370
+ <li>If it is a Symbol, it will use Rack::Response to return the value.</li>
371
+ <li>If it is a Symbol, it will either be used as a Rack response or as a body and status code.</li>
372
+ <li>If it is an Integer, it will use Rack::Response to return the status code.</li>
373
+ <li>Otherwise, #to_s will be called on it and it will be treated as a Symbol.</li>
374
+ </ul>
375
+
376
+
377
+
378
+ </div>
379
+ </div>
380
+ <div class="tags">
381
+ <h3>Parameters:</h3>
382
+ <ul class="param">
383
+
384
+ <li>
385
+
386
+ <span class='name'>response</span>
387
+
388
+
389
+ <span class='type'>(<tt>Object</tt>)</span>
390
+
391
+
392
+
393
+ &mdash;
394
+ <div class='inline'><p>This can be either a Symbol, String, Array or any Object.</p>
395
+ </div>
396
+
397
+ </li>
398
+
399
+ </ul>
400
+
401
+
402
+ </div><table class="source_code">
403
+ <tr>
404
+ <td>
405
+ <pre class="lines">
406
+
407
+
408
+ 70
409
+ 71
410
+ 72
411
+ 73
412
+ 74
413
+ 75
414
+ 76
415
+ 77
416
+ 78
417
+ 79
418
+ 80
419
+ 81
420
+ 82
421
+ 83
422
+ 84</pre>
423
+ </td>
424
+ <td>
425
+ <pre class="code"><span class="info file"># File 'lib/renee/core/responding.rb', line 70</span>
426
+
427
+ <span class='kw'>def</span> <span class='id interpret_response'>interpret_response</span><span class='lparen'>(</span><span class='id response'>response</span><span class='rparen'>)</span>
428
+ <span class='kw'>case</span> <span class='id response'>response</span>
429
+ <span class='kw'>when</span> <span class='const'>Array</span> <span class='kw'>then</span>
430
+ <span class='kw'>case</span> <span class='id response'>response</span><span class='period'>.</span><span class='id size'>size</span>
431
+ <span class='kw'>when</span> <span class='int'>3</span> <span class='kw'>then</span> <span class='id response'>response</span>
432
+ <span class='kw'>when</span> <span class='int'>2</span> <span class='kw'>then</span> <span class='const'>Renee</span><span class='op'>::</span><span class='const'>Core</span><span class='op'>::</span><span class='const'>Response</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id response'>response</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='const'>HTTP_CODES</span><span class='lbracket'>[</span><span class='id response'>response</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id response'>response</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id finish'>finish</span>
433
+ <span class='kw'>else</span> <span class='id raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>I don't know how to render </span><span class='embexpr_beg'>#{</span><span class='id response'>response</span><span class='period'>.</span><span class='id inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
434
+ <span class='kw'>end</span>
435
+ <span class='kw'>when</span> <span class='const'>String</span> <span class='kw'>then</span> <span class='const'>Renee</span><span class='op'>::</span><span class='const'>Core</span><span class='op'>::</span><span class='const'>Response</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id response'>response</span><span class='rparen'>)</span><span class='period'>.</span><span class='id finish'>finish</span>
436
+ <span class='kw'>when</span> <span class='const'>Integer</span> <span class='kw'>then</span> <span class='const'>Renee</span><span class='op'>::</span><span class='const'>Core</span><span class='op'>::</span><span class='const'>Response</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Status code </span><span class='embexpr_beg'>#{</span><span class='id response'>response</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id response'>response</span><span class='rparen'>)</span><span class='period'>.</span><span class='id finish'>finish</span>
437
+ <span class='kw'>when</span> <span class='const'>Symbol</span> <span class='kw'>then</span> <span class='id interpret_response'>interpret_response</span><span class='lparen'>(</span><span class='const'>HTTP_CODES</span><span class='lbracket'>[</span><span class='id response'>response</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id response'>response</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rparen'>)</span>
438
+ <span class='kw'>when</span> <span class='const'>Proc</span> <span class='kw'>then</span> <span class='id instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id response'>response</span><span class='rparen'>)</span>
439
+ <span class='kw'>else</span> <span class='id response'>response</span> <span class='comment'># pass through response
440
+ </span> <span class='kw'>end</span>
441
+ <span class='kw'>end</span></pre>
442
+ </td>
443
+ </tr>
444
+ </table>
445
+ </div>
446
+
447
+ <div class="method_details ">
448
+ <p class="signature " id="redirect-instance_method">
449
+
450
+ - (<tt>Object</tt>) <strong>redirect</strong>(path, code = 302)
451
+
452
+
453
+
454
+ </p><div class="docstring">
455
+ <div class="discussion">
456
+ <p>Returns a rack-based response for redirection.</p>
457
+
458
+
459
+ </div>
460
+ </div>
461
+ <div class="tags">
462
+
463
+ <div class="examples">
464
+ <h3>Examples:</h3>
465
+
466
+ <h4><div class='inline'>
467
+ </div></h4>
468
+ <pre class="example code"><span class='id r'>r</span> <span class='op'>=</span> <span class='const'>Renee</span><span class='period'>.</span><span class='id core'>core</span> <span class='lbrace'>{</span> <span class='id get'>get</span> <span class='lbrace'>{</span> <span class='id halt'>halt</span> <span class='id redirect'>redirect</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/index</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
469
+ <span class='id r'>r</span><span class='period'>.</span><span class='id call'>call</span><span class='lparen'>(</span><span class='const'>Rack</span><span class='op'>::</span><span class='const'>MockResponse</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='comment'># =&gt; [302, {&quot;Location&quot; =&gt; &quot;/index&quot;}, []]</span></pre>
470
+
471
+ </div>
472
+ <h3>Parameters:</h3>
473
+ <ul class="param">
474
+
475
+ <li>
476
+
477
+ <span class='name'>path</span>
478
+
479
+
480
+ <span class='type'>(<tt>String</tt>)</span>
481
+
482
+
483
+
484
+ &mdash;
485
+ <div class='inline'><p>The URL to redirect to.</p>
486
+ </div>
487
+
488
+ </li>
489
+
490
+ <li>
491
+
492
+ <span class='name'>code</span>
493
+
494
+
495
+ <span class='type'>(<tt>Integer</tt>)</span>
496
+
497
+
498
+ <em class="default">(defaults to: <tt>302</tt>)</em>
499
+
500
+
501
+ &mdash;
502
+ <div class='inline'><p>The HTTP code to use.</p>
503
+ </div>
504
+
505
+ </li>
506
+
507
+ </ul>
508
+
509
+
510
+ </div><table class="source_code">
511
+ <tr>
512
+ <td>
513
+ <pre class="lines">
514
+
515
+
516
+ 92
517
+ 93
518
+ 94
519
+ 95
520
+ 96</pre>
521
+ </td>
522
+ <td>
523
+ <pre class="code"><span class="info file"># File 'lib/renee/core/responding.rb', line 92</span>
524
+
525
+ <span class='kw'>def</span> <span class='id redirect'>redirect</span><span class='lparen'>(</span><span class='id path'>path</span><span class='comma'>,</span> <span class='id code'>code</span> <span class='op'>=</span> <span class='int'>302</span><span class='rparen'>)</span>
526
+ <span class='id response'>response</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'>Rack</span><span class='op'>::</span><span class='const'>Response</span><span class='period'>.</span><span class='id new'>new</span>
527
+ <span class='id response'>response</span><span class='period'>.</span><span class='id redirect'>redirect</span><span class='lparen'>(</span><span class='id path'>path</span><span class='comma'>,</span> <span class='id code'>code</span><span class='rparen'>)</span>
528
+ <span class='id response'>response</span><span class='period'>.</span><span class='id finish'>finish</span>
529
+ <span class='kw'>end</span></pre>
530
+ </td>
531
+ </tr>
532
+ </table>
533
+ </div>
534
+
535
+ <div class="method_details ">
536
+ <p class="signature " id="redirect!-instance_method">
537
+
538
+ - (<tt>Object</tt>) <strong>redirect!</strong>(path, code = 302)
539
+
540
+
541
+
542
+ </p><div class="docstring">
543
+ <div class="discussion">
544
+ <p>Halts with a rack-based response for redirection.</p>
545
+
546
+
547
+ </div>
548
+ </div>
549
+ <div class="tags">
550
+
551
+ <div class="examples">
552
+ <h3>Examples:</h3>
553
+
554
+ <h4><div class='inline'>
555
+ </div></h4>
556
+ <pre class="example code"><span class='id r'>r</span> <span class='op'>=</span> <span class='const'>Renee</span><span class='period'>.</span><span class='id core'>core</span> <span class='lbrace'>{</span> <span class='id get'>get</span> <span class='lbrace'>{</span> <span class='id redirect!'>redirect!</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/index</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
557
+ <span class='id r'>r</span><span class='period'>.</span><span class='id call'>call</span><span class='lparen'>(</span><span class='const'>Rack</span><span class='op'>::</span><span class='const'>MockResponse</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='comment'># =&gt; [302, {&quot;Location&quot; =&gt; &quot;/index&quot;}, []]</span></pre>
558
+
559
+ </div>
560
+ <h3>Parameters:</h3>
561
+ <ul class="param">
562
+
563
+ <li>
564
+
565
+ <span class='name'>path</span>
566
+
567
+
568
+ <span class='type'>(<tt>String</tt>)</span>
569
+
570
+
571
+
572
+ &mdash;
573
+ <div class='inline'><p>The URL to redirect to.</p>
574
+ </div>
575
+
576
+ </li>
577
+
578
+ <li>
579
+
580
+ <span class='name'>code</span>
581
+
582
+
583
+ <span class='type'>(<tt>Integer</tt>)</span>
584
+
585
+
586
+ <em class="default">(defaults to: <tt>302</tt>)</em>
587
+
588
+
589
+ &mdash;
590
+ <div class='inline'><p>The HTTP code to use.</p>
591
+ </div>
592
+
593
+ </li>
594
+
595
+ </ul>
596
+
597
+
598
+ <h3>See Also:</h3>
599
+ <ul class="see">
600
+
601
+ <li><span class='object_link'><a href="#redirect-instance_method" title="Renee::Core::Responding#redirect (method)">#redirect</a></span></li>
602
+
603
+ </ul>
604
+
605
+ </div><table class="source_code">
606
+ <tr>
607
+ <td>
608
+ <pre class="lines">
609
+
610
+
611
+ 105
612
+ 106
613
+ 107</pre>
614
+ </td>
615
+ <td>
616
+ <pre class="code"><span class="info file"># File 'lib/renee/core/responding.rb', line 105</span>
617
+
618
+ <span class='kw'>def</span> <span class='id redirect!'>redirect!</span><span class='lparen'>(</span><span class='id path'>path</span><span class='comma'>,</span> <span class='id code'>code</span> <span class='op'>=</span> <span class='int'>302</span><span class='rparen'>)</span>
619
+ <span class='id halt'>halt</span> <span class='id redirect'>redirect</span><span class='lparen'>(</span><span class='id path'>path</span><span class='comma'>,</span> <span class='id code'>code</span><span class='rparen'>)</span>
620
+ <span class='kw'>end</span></pre>
621
+ </td>
622
+ </tr>
623
+ </table>
624
+ </div>
625
+
626
+ <div class="method_details ">
627
+ <p class="signature " id="respond-instance_method">
628
+
629
+ - (<tt>Object</tt>) <strong>respond</strong>(body = [], status = 200, header = {}, &amp;blk)
630
+
631
+
632
+
633
+ </p><div class="docstring">
634
+ <div class="discussion">
635
+ <p>Creates a response by allowing the response header, body and status to be passed into the block.</p>
636
+
637
+
638
+ </div>
639
+ </div>
640
+ <div class="tags">
641
+
642
+ <div class="examples">
643
+ <h3>Examples:</h3>
644
+
645
+ <h4><div class='inline'>
646
+ </div></h4>
647
+ <pre class="example code"><span class='id respond'>respond</span> <span class='lbrace'>{</span> <span class='id status'>status</span> <span class='int'>200</span><span class='semicolon'>;</span> <span class='id body'>body</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Yay!</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
648
+ <span class='id respond'>respond</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Hello</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='int'>200</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>foo</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>bar</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
649
+
650
+ </div>
651
+ <h3>Parameters:</h3>
652
+ <ul class="param">
653
+
654
+ <li>
655
+
656
+ <span class='name'>body</span>
657
+
658
+
659
+ <span class='type'>(<tt>Array</tt>)</span>
660
+
661
+
662
+ <em class="default">(defaults to: <tt>[]</tt>)</em>
663
+
664
+
665
+ &mdash;
666
+ <div class='inline'><p>The contents to return.</p>
667
+ </div>
668
+
669
+ </li>
670
+
671
+ <li>
672
+
673
+ <span class='name'>status</span>
674
+
675
+
676
+ <span class='type'>(<tt>Integer</tt>)</span>
677
+
678
+
679
+ <em class="default">(defaults to: <tt>200</tt>)</em>
680
+
681
+
682
+ &mdash;
683
+ <div class='inline'><p>The status code to return.</p>
684
+ </div>
685
+
686
+ </li>
687
+
688
+ <li>
689
+
690
+ <span class='name'>header</span>
691
+
692
+
693
+ <span class='type'>(<tt>Hash</tt>)</span>
694
+
695
+
696
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
697
+
698
+
699
+ &mdash;
700
+ <div class='inline'><p>The headers to return.</p>
701
+ </div>
702
+
703
+ </li>
704
+
705
+ <li>
706
+
707
+ <span class='name'>&amp;blk</span>
708
+
709
+
710
+ <span class='type'>(<tt>Proc</tt>)</span>
711
+
712
+
713
+
714
+ &mdash;
715
+ <div class='inline'><p>The response options to specify</p>
716
+ </div>
717
+
718
+ </li>
719
+
720
+ </ul>
721
+
722
+
723
+ </div><table class="source_code">
724
+ <tr>
725
+ <td>
726
+ <pre class="lines">
727
+
728
+
729
+ 44
730
+ 45
731
+ 46</pre>
732
+ </td>
733
+ <td>
734
+ <pre class="code"><span class="info file"># File 'lib/renee/core/responding.rb', line 44</span>
735
+
736
+ <span class='kw'>def</span> <span class='id respond'>respond</span><span class='lparen'>(</span><span class='id body'>body</span><span class='op'>=</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id status'>status</span><span class='op'>=</span><span class='int'>200</span><span class='comma'>,</span> <span class='id header'>header</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id blk'>blk</span><span class='rparen'>)</span>
737
+ <span class='const'>Renee</span><span class='op'>::</span><span class='const'>Core</span><span class='op'>::</span><span class='const'>Response</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id body'>body</span><span class='comma'>,</span> <span class='id status'>status</span><span class='comma'>,</span> <span class='id header'>header</span><span class='rparen'>)</span><span class='period'>.</span><span class='id tap'>tap</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id r'>r</span><span class='op'>|</span> <span class='id r'>r</span><span class='period'>.</span><span class='id instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='id blk'>blk</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id finish'>finish</span>
738
+ <span class='kw'>end</span></pre>
739
+ </td>
740
+ </tr>
741
+ </table>
742
+ </div>
743
+
744
+ <div class="method_details ">
745
+ <p class="signature " id="respond!-instance_method">
746
+
747
+ - (<tt>Object</tt>) <strong>respond!</strong>(*args, &amp;blk)
748
+
749
+
750
+
751
+ </p><div class="docstring">
752
+ <div class="discussion">
753
+ <p>Creates a response by allowing the response header, body and status to be passed into the block.</p>
754
+
755
+
756
+ </div>
757
+ </div>
758
+ <div class="tags">
759
+
760
+ <div class="examples">
761
+ <h3>Examples:</h3>
762
+
763
+ <h4><div class='inline'>
764
+ </div></h4>
765
+ <pre class="example code"><span class='id respond!'>respond!</span> <span class='lbrace'>{</span> <span class='id status'>status</span> <span class='int'>200</span><span class='semicolon'>;</span> <span class='id body'>body</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Yay!</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span></pre>
766
+
767
+ </div>
768
+ <h3>Parameters:</h3>
769
+ <ul class="param">
770
+
771
+ <li>
772
+
773
+ <span class='name'>body</span>
774
+
775
+
776
+ <span class='type'>(<tt>Array</tt>)</span>
777
+
778
+
779
+
780
+ &mdash;
781
+ <div class='inline'><p>The contents to return.</p>
782
+ </div>
783
+
784
+ </li>
785
+
786
+ <li>
787
+
788
+ <span class='name'>status</span>
789
+
790
+
791
+ <span class='type'>(<tt>Integer</tt>)</span>
792
+
793
+
794
+
795
+ &mdash;
796
+ <div class='inline'><p>The status code to return.</p>
797
+ </div>
798
+
799
+ </li>
800
+
801
+ <li>
802
+
803
+ <span class='name'>header</span>
804
+
805
+
806
+ <span class='type'>(<tt>Hash</tt>)</span>
807
+
808
+
809
+
810
+ &mdash;
811
+ <div class='inline'><p>The headers to return.</p>
812
+ </div>
813
+
814
+ </li>
815
+
816
+ <li>
817
+
818
+ <span class='name'>&amp;blk</span>
819
+
820
+
821
+ <span class='type'>(<tt>Proc</tt>)</span>
822
+
823
+
824
+
825
+ &mdash;
826
+ <div class='inline'><p>The response options to specify</p>
827
+ </div>
828
+
829
+ </li>
830
+
831
+ </ul>
832
+
833
+
834
+ <h3>See Also:</h3>
835
+ <ul class="see">
836
+
837
+ <li><span class='object_link'><a href="#respond-instance_method" title="Renee::Core::Responding#respond (method)">#respond</a></span></li>
838
+
839
+ </ul>
840
+
841
+ </div><table class="source_code">
842
+ <tr>
843
+ <td>
844
+ <pre class="lines">
845
+
846
+
847
+ 56
848
+ 57
849
+ 58</pre>
850
+ </td>
851
+ <td>
852
+ <pre class="code"><span class="info file"># File 'lib/renee/core/responding.rb', line 56</span>
853
+
854
+ <span class='kw'>def</span> <span class='id respond!'>respond!</span><span class='lparen'>(</span><span class='op'>*</span><span class='id args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id blk'>blk</span><span class='rparen'>)</span>
855
+ <span class='id halt'>halt</span> <span class='id respond'>respond</span><span class='lparen'>(</span><span class='op'>*</span><span class='id args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id blk'>blk</span><span class='rparen'>)</span>
856
+ <span class='kw'>end</span></pre>
857
+ </td>
858
+ </tr>
859
+ </table>
860
+ </div>
861
+
862
+ </div>
863
+
864
+ </div>
865
+
866
+ <div id="footer">
867
+ Generated on Thu Dec 22 09:52:35 2011 by
868
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
869
+ 0.7.3 (ruby-1.9.2).
870
+ </div>
871
+
872
+ </body>
873
+ </html>