utopia 2.5.5 → 2.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. checksums.yaml +4 -4
  2. data/.travis.yml +1 -2
  3. data/Gemfile +1 -0
  4. data/Rakefile +2 -0
  5. data/docs/code/Utopia.html +439 -433
  6. data/docs/code/Utopia/Command.html +201 -195
  7. data/docs/code/Utopia/Command/Environment.html +244 -244
  8. data/docs/code/Utopia/Command/Server.html +202 -202
  9. data/docs/code/Utopia/Command/Server/Create.html +192 -192
  10. data/docs/code/Utopia/Command/Server/Update.html +235 -235
  11. data/docs/code/Utopia/Command/Site.html +269 -263
  12. data/docs/code/Utopia/Command/Site/Create.html +192 -192
  13. data/docs/code/Utopia/Command/Site/Update.html +246 -246
  14. data/docs/code/Utopia/Command/Top.html +244 -244
  15. data/docs/code/Utopia/Content.html +636 -630
  16. data/docs/code/Utopia/Content/Document.html +1411 -1407
  17. data/docs/code/Utopia/Content/Document/State.html +1048 -1048
  18. data/docs/code/Utopia/Content/Link.html +1023 -1023
  19. data/docs/code/Utopia/Content/Links.html +629 -623
  20. data/docs/code/Utopia/Content/MarkupParser.html +702 -702
  21. data/docs/code/Utopia/Content/MarkupParser/ParsedTag.html +375 -375
  22. data/docs/code/Utopia/Content/MarkupParser/UnbalancedTagError.html +523 -523
  23. data/docs/code/Utopia/Content/Namespace.html +416 -416
  24. data/docs/code/Utopia/Content/Node.html +952 -952
  25. data/docs/code/Utopia/Content/Node/Context.html +790 -790
  26. data/docs/code/Utopia/Content/Response.html +686 -686
  27. data/docs/code/Utopia/Content/SymbolicHash.html +365 -365
  28. data/docs/code/Utopia/Content/Tags.html +134 -134
  29. data/docs/code/Utopia/Content/UnbalancedTagError.html +270 -270
  30. data/docs/code/Utopia/ContentLength.html +298 -294
  31. data/docs/code/Utopia/Controller.html +657 -651
  32. data/docs/code/Utopia/Controller/Actions.html +260 -260
  33. data/docs/code/Utopia/Controller/Actions/Action.html +785 -779
  34. data/docs/code/Utopia/Controller/Actions/ClassMethods.html +360 -360
  35. data/docs/code/Utopia/Controller/Base.html +989 -989
  36. data/docs/code/Utopia/Controller/Respond.html +264 -254
  37. data/docs/code/Utopia/Controller/Respond/ClassMethods.html +207 -207
  38. data/docs/code/Utopia/Controller/Respond/Converter.html +219 -219
  39. data/docs/code/Utopia/Controller/Respond/Converter/Callback.html +425 -425
  40. data/docs/code/Utopia/Controller/Respond/Converter/ToJSON.html +323 -317
  41. data/docs/code/Utopia/Controller/Respond/Passthrough.html +266 -260
  42. data/docs/code/Utopia/Controller/Respond/Responder.html +449 -443
  43. data/docs/code/Utopia/Controller/Rewrite.html +260 -260
  44. data/docs/code/Utopia/Controller/Rewrite/ClassMethods.html +216 -216
  45. data/docs/code/Utopia/Controller/Rewrite/ExtractPrefixRule.html +303 -303
  46. data/docs/code/Utopia/Controller/Rewrite/Rewriter.html +402 -402
  47. data/docs/code/Utopia/Controller/Rewrite/Rule.html +193 -193
  48. data/docs/code/Utopia/Controller/Variables.html +428 -428
  49. data/docs/code/Utopia/Controllers.html +216 -216
  50. data/docs/code/Utopia/Exceptions.html +125 -125
  51. data/docs/code/Utopia/Exceptions/Handler.html +405 -405
  52. data/docs/code/Utopia/Exceptions/Mailer.html +400 -394
  53. data/docs/code/Utopia/Extensions.html +116 -116
  54. data/docs/code/Utopia/Extensions/ArraySplit.html +164 -164
  55. data/docs/code/Utopia/Extensions/DateTimeComparison.html +173 -173
  56. data/docs/code/Utopia/Extensions/TimeDateComparison.html +173 -173
  57. data/docs/code/Utopia/HTTP.html +193 -187
  58. data/docs/code/Utopia/HTTP/Status.html +355 -355
  59. data/docs/code/Utopia/Locale.html +522 -522
  60. data/docs/code/Utopia/Localization.html +886 -880
  61. data/docs/code/Utopia/Localization/Wrapper.html +403 -403
  62. data/docs/code/Utopia/Logger.html +185 -185
  63. data/docs/code/Utopia/Logger/CompactFormatter.html +290 -290
  64. data/docs/code/Utopia/Path.html +2562 -2556
  65. data/docs/code/Utopia/Path/Matcher.html +395 -395
  66. data/docs/code/Utopia/Path/Matcher/MatchData.html +418 -418
  67. data/docs/code/Utopia/Redirection.html +148 -142
  68. data/docs/code/Utopia/Redirection/ClientRedirect.html +594 -594
  69. data/docs/code/Utopia/Redirection/DirectoryIndex.html +265 -265
  70. data/docs/code/Utopia/Redirection/Errors.html +391 -385
  71. data/docs/code/Utopia/Redirection/Moved.html +265 -265
  72. data/docs/code/Utopia/Redirection/RequestFailure.html +201 -201
  73. data/docs/code/Utopia/Redirection/Rewrite.html +265 -265
  74. data/docs/code/Utopia/Session.html +723 -717
  75. data/docs/code/Utopia/Session/LazyHash.html +709 -709
  76. data/docs/code/Utopia/Setup.html +783 -777
  77. data/docs/code/Utopia/Static.html +516 -510
  78. data/docs/code/Utopia/Static/LocalFile.html +875 -869
  79. data/docs/code/Utopia/Static/MimeTypeLoader.html +427 -427
  80. data/docs/code/Utopia/Static/MimeTypeLoader/ExpansionError.html +123 -123
  81. data/docs/code/_index.html +757 -757
  82. data/docs/code/class_list.html +51 -51
  83. data/docs/code/css/full_list.css +58 -58
  84. data/docs/code/css/style.css +496 -499
  85. data/docs/code/file.README.html +72 -70
  86. data/docs/code/file_list.html +56 -56
  87. data/docs/code/frames.html +17 -17
  88. data/docs/code/index.html +72 -70
  89. data/docs/code/js/app.js +292 -248
  90. data/docs/code/js/full_list.js +216 -216
  91. data/docs/code/js/jquery.js +3 -3
  92. data/docs/code/method_list.html +3443 -3443
  93. data/docs/code/top-level-namespace.html +109 -109
  94. data/docs/index.html +2 -2
  95. data/docs/wiki.html +2 -2
  96. data/docs/wiki/edit.html +1 -1
  97. data/docs/wiki/javascript.html +153 -0
  98. data/docs/wiki/javascript/index.html +153 -0
  99. data/documentation/.yarnrc +1 -0
  100. data/documentation/Gemfile +1 -0
  101. data/documentation/config/environment.rb +1 -0
  102. data/documentation/pages/wiki/content.md +1 -1
  103. data/documentation/pages/wiki/javascript/content.md +75 -0
  104. data/documentation/pages/wiki/links.yaml +3 -1
  105. data/lib/utopia/command/site.rb +4 -4
  106. data/lib/utopia/version.rb +1 -1
  107. data/setup/site/.yarnrc +1 -0
  108. data/setup/site/tasks/yarn.rake +32 -0
  109. data/spec/utopia/command_spec.rb +2 -2
  110. metadata +8 -9
  111. data/docs/wiki/bower-integration.html +0 -74
  112. data/docs/wiki/bower-integration/index.html +0 -74
  113. data/documentation/.bowerrc +0 -4
  114. data/documentation/pages/wiki/bower-integration/content.md +0 -25
  115. data/setup/.bowerrc +0 -3
  116. data/setup/site/.bowerrc +0 -4
  117. data/setup/site/tasks/bower.rake +0 -45
data/docs/code/Utopia/Controller/Base.html CHANGED
@@ -1,660 +1,660 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- Class: Utopia::Controller::Base
8
-
9
- &mdash; Documentation by YARD 0.9.12
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- pathId = "Utopia::Controller::Base";
19
- relpath = '../../';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="../../class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="../../_index.html">Index (B)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../../Utopia.html" title="Utopia (module)">Utopia</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Controller.html" title="Utopia::Controller (class)">Controller</a></span></span>
41
- &raquo;
42
- <span class="title">Base</span>
43
-
44
- </div>
45
-
46
- <div id="search">
47
-
48
- <a class="full_list_link" id="class_list_link"
49
- href="../../class_list.html">
50
-
51
- <svg width="24" height="24">
52
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
- </svg>
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <div id="content"><h1>Class: Utopia::Controller::Base
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName">Object</span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">Utopia::Controller::Base</li>
78
-
79
- </ul>
80
- <a href="#" class="inheritanceTree">show all</a>
81
-
82
- </dd>
83
- </dl>
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
- <dl>
96
- <dt>Defined in:</dt>
97
- <dd>lib/utopia/controller/base.rb</dd>
98
- </dl>
99
-
100
- </div>
101
-
102
- <h2>Overview</h2><div class="docstring">
103
- <div class="discussion">
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Utopia::Controller::Base
8
+
9
+ &mdash; Documentation by YARD 0.9.18
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Utopia::Controller::Base";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (B)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Utopia.html" title="Utopia (module)">Utopia</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Controller.html" title="Utopia::Controller (class)">Controller</a></span></span>
41
+ &raquo;
42
+ <span class="title">Base</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Utopia::Controller::Base
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Utopia::Controller::Base</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/utopia/controller/base.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
104
  <p>The base implementation of a controller class.</p>
105
-
106
-
107
- </div>
108
- </div>
109
- <div class="tags">
110
-
111
-
112
- </div>
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
- <h2>
121
- Class Method Summary
122
- <small><a href="#" class="summary_toggle">collapse</a></small>
123
- </h2>
124
-
125
- <ul class="summary">
126
-
127
- <li class="public ">
128
- <span class="summary_signature">
129
-
130
- <a href="#base_path-class_method" title="base_path (class method)">.<strong>base_path</strong> &#x21d2; Object </a>
131
-
132
-
133
-
134
- </span>
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
105
+
106
+
107
+ </div>
108
+ </div>
109
+ <div class="tags">
110
+
111
+
112
+ </div>
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+ <h2>
121
+ Class Method Summary
122
+ <small><a href="#" class="summary_toggle">collapse</a></small>
123
+ </h2>
124
+
125
+ <ul class="summary">
126
+
127
+ <li class="public ">
128
+ <span class="summary_signature">
129
+
130
+ <a href="#base_path-class_method" title="base_path (class method)">.<strong>base_path</strong> &#x21d2; Object </a>
131
+
132
+
133
+
134
+ </span>
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
144
  <span class="summary_desc"><div class='inline'><p>A string which is the full path to the directory which contains the controller.</p>
145
- </div></span>
146
-
147
- </li>
148
-
149
-
150
- <li class="public ">
151
- <span class="summary_signature">
152
-
153
- <a href="#controller-class_method" title="controller (class method)">.<strong>controller</strong> &#x21d2; Object </a>
154
-
155
-
156
-
157
- </span>
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
145
+ </div></span>
146
+
147
+ </li>
148
+
149
+
150
+ <li class="public ">
151
+ <span class="summary_signature">
152
+
153
+ <a href="#controller-class_method" title="controller (class method)">.<strong>controller</strong> &#x21d2; Object </a>
154
+
155
+
156
+
157
+ </span>
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
167
  <span class="summary_desc"><div class='inline'><p>The controller middleware itself.</p>
168
- </div></span>
169
-
170
- </li>
171
-
172
-
173
- <li class="public ">
174
- <span class="summary_signature">
175
-
176
- <a href="#direct%3F-class_method" title="direct? (class method)">.<strong>direct?</strong>(path) &#x21d2; Boolean </a>
177
-
178
-
179
-
180
- </span>
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
168
+ </div></span>
169
+
170
+ </li>
171
+
172
+
173
+ <li class="public ">
174
+ <span class="summary_signature">
175
+
176
+ <a href="#direct%3F-class_method" title="direct? (class method)">.<strong>direct?</strong>(path) &#x21d2; Boolean </a>
177
+
178
+
179
+
180
+ </span>
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
190
  <span class="summary_desc"><div class='inline'>
191
- </div></span>
192
-
193
- </li>
194
-
195
-
196
- <li class="public ">
197
- <span class="summary_signature">
198
-
199
- <a href="#freeze-class_method" title="freeze (class method)">.<strong>freeze</strong> &#x21d2; Object </a>
200
-
201
-
202
-
203
- </span>
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
191
+ </div></span>
192
+
193
+ </li>
194
+
195
+
196
+ <li class="public ">
197
+ <span class="summary_signature">
198
+
199
+ <a href="#freeze-class_method" title="freeze (class method)">.<strong>freeze</strong> &#x21d2; Object </a>
200
+
201
+
202
+
203
+ </span>
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
213
  <span class="summary_desc"><div class='inline'>
214
- </div></span>
215
-
216
- </li>
217
-
218
-
219
- <li class="public ">
220
- <span class="summary_signature">
221
-
222
- <a href="#uri_path-class_method" title="uri_path (class method)">.<strong>uri_path</strong> &#x21d2; Object </a>
223
-
224
-
225
-
226
- </span>
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
214
+ </div></span>
215
+
216
+ </li>
217
+
218
+
219
+ <li class="public ">
220
+ <span class="summary_signature">
221
+
222
+ <a href="#uri_path-class_method" title="uri_path (class method)">.<strong>uri_path</strong> &#x21d2; Object </a>
223
+
224
+
225
+
226
+ </span>
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
236
  <span class="summary_desc"><div class='inline'><p>A relative path to the controller directory relative to the controller root directory.</p>
237
- </div></span>
238
-
239
- </li>
240
-
241
-
242
- </ul>
243
-
244
- <h2>
245
- Instance Method Summary
246
- <small><a href="#" class="summary_toggle">collapse</a></small>
247
- </h2>
248
-
249
- <ul class="summary">
250
-
251
- <li class="public ">
252
- <span class="summary_signature">
253
-
254
- <a href="#body_for-instance_method" title="#body_for (instance method)">#<strong>body_for</strong>(status, headers, options) &#x21d2; Object </a>
255
-
256
-
257
-
258
- </span>
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
237
+ </div></span>
238
+
239
+ </li>
240
+
241
+
242
+ </ul>
243
+
244
+ <h2>
245
+ Instance Method Summary
246
+ <small><a href="#" class="summary_toggle">collapse</a></small>
247
+ </h2>
248
+
249
+ <ul class="summary">
250
+
251
+ <li class="public ">
252
+ <span class="summary_signature">
253
+
254
+ <a href="#body_for-instance_method" title="#body_for (instance method)">#<strong>body_for</strong>(status, headers, options) &#x21d2; Object </a>
255
+
256
+
257
+
258
+ </span>
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
268
  <span class="summary_desc"><div class='inline'><p>Generate the body for the given status, headers and options.</p>
269
- </div></span>
270
-
271
- </li>
272
-
273
-
274
- <li class="public ">
275
- <span class="summary_signature">
276
-
277
- <a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(env) &#x21d2; Object </a>
278
-
279
-
280
-
281
- </span>
282
-
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
-
269
+ </div></span>
270
+
271
+ </li>
272
+
273
+
274
+ <li class="public ">
275
+ <span class="summary_signature">
276
+
277
+ <a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong>(env) &#x21d2; Object </a>
278
+
279
+
280
+
281
+ </span>
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
291
  <span class="summary_desc"><div class='inline'><p>Call into the next app as defined by rack.</p>
292
- </div></span>
293
-
294
- </li>
295
-
296
-
297
- <li class="public ">
298
- <span class="summary_signature">
299
-
300
- <a href="#catch_response-instance_method" title="#catch_response (instance method)">#<strong>catch_response</strong> &#x21d2; Object </a>
301
-
302
-
303
-
304
- </span>
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
-
313
-
292
+ </div></span>
293
+
294
+ </li>
295
+
296
+
297
+ <li class="public ">
298
+ <span class="summary_signature">
299
+
300
+ <a href="#catch_response-instance_method" title="#catch_response (instance method)">#<strong>catch_response</strong> &#x21d2; Object </a>
301
+
302
+
303
+
304
+ </span>
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
314
  <span class="summary_desc"><div class='inline'>
315
- </div></span>
316
-
317
- </li>
318
-
319
-
320
- <li class="public ">
321
- <span class="summary_signature">
322
-
323
- <a href="#copy_instance_variables-instance_method" title="#copy_instance_variables (instance method)">#<strong>copy_instance_variables</strong>(from) &#x21d2; Object </a>
324
-
325
-
326
-
327
- </span>
328
-
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
-
315
+ </div></span>
316
+
317
+ </li>
318
+
319
+
320
+ <li class="public ">
321
+ <span class="summary_signature">
322
+
323
+ <a href="#copy_instance_variables-instance_method" title="#copy_instance_variables (instance method)">#<strong>copy_instance_variables</strong>(from) &#x21d2; Object </a>
324
+
325
+
326
+
327
+ </span>
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+
337
337
  <span class="summary_desc"><div class='inline'><p>Copy the instance variables from the previous controller to the next controller (usually only a few).</p>
338
- </div></span>
339
-
340
- </li>
341
-
342
-
343
- <li class="public ">
344
- <span class="summary_signature">
345
-
346
- <a href="#fail!-instance_method" title="#fail! (instance method)">#<strong>fail!</strong>(error = 400, message = nil) &#x21d2; Object </a>
347
-
348
-
349
-
350
- </span>
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
338
+ </div></span>
339
+
340
+ </li>
341
+
342
+
343
+ <li class="public ">
344
+ <span class="summary_signature">
345
+
346
+ <a href="#fail!-instance_method" title="#fail! (instance method)">#<strong>fail!</strong>(error = 400, message = nil) &#x21d2; Object </a>
347
+
348
+
349
+
350
+ </span>
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
360
  <span class="summary_desc"><div class='inline'><p>Respond with an error which indiciates some kind of failure.</p>
361
- </div></span>
362
-
363
- </li>
364
-
365
-
366
- <li class="public ">
367
- <span class="summary_signature">
368
-
369
- <a href="#goto!-instance_method" title="#goto! (instance method)">#<strong>goto!</strong>(target, status = 302) &#x21d2; Object </a>
370
-
371
-
372
-
373
- </span>
374
-
375
-
376
-
377
-
378
-
379
-
380
-
381
-
382
-
361
+ </div></span>
362
+
363
+ </li>
364
+
365
+
366
+ <li class="public ">
367
+ <span class="summary_signature">
368
+
369
+ <a href="#goto!-instance_method" title="#goto! (instance method)">#<strong>goto!</strong>(target, status = 302) &#x21d2; Object </a>
370
+
371
+
372
+
373
+ </span>
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
383
  <span class="summary_desc"><div class='inline'><p>Controller relative redirect.</p>
384
- </div></span>
385
-
386
- </li>
387
-
388
-
389
- <li class="public ">
390
- <span class="summary_signature">
391
-
392
- <a href="#ignore!-instance_method" title="#ignore! (instance method)">#<strong>ignore!</strong> &#x21d2; Object </a>
393
-
394
-
395
-
396
- </span>
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
384
+ </div></span>
385
+
386
+ </li>
387
+
388
+
389
+ <li class="public ">
390
+ <span class="summary_signature">
391
+
392
+ <a href="#ignore!-instance_method" title="#ignore! (instance method)">#<strong>ignore!</strong> &#x21d2; Object </a>
393
+
394
+
395
+
396
+ </span>
397
+
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+
406
406
  <span class="summary_desc"><div class='inline'><p>This will cause the controller middleware to pass on the request.</p>
407
- </div></span>
408
-
409
- </li>
410
-
411
-
412
- <li class="public ">
413
- <span class="summary_signature">
414
-
415
- <a href="#process!-instance_method" title="#process! (instance method)">#<strong>process!</strong>(request, relative_path) &#x21d2; Object </a>
416
-
417
-
418
-
419
- </span>
420
-
421
-
422
-
423
-
424
-
425
-
426
-
427
-
428
-
407
+ </div></span>
408
+
409
+ </li>
410
+
411
+
412
+ <li class="public ">
413
+ <span class="summary_signature">
414
+
415
+ <a href="#process!-instance_method" title="#process! (instance method)">#<strong>process!</strong>(request, relative_path) &#x21d2; Object </a>
416
+
417
+
418
+
419
+ </span>
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
429
  <span class="summary_desc"><div class='inline'><p>Return nil if this controller didn’t do anything.</p>
430
- </div></span>
431
-
432
- </li>
433
-
434
-
435
- <li class="public ">
436
- <span class="summary_signature">
437
-
438
- <a href="#redirect!-instance_method" title="#redirect! (instance method)">#<strong>redirect!</strong>(target, status = 302) &#x21d2; Object </a>
439
-
440
-
441
-
442
- </span>
443
-
444
-
445
-
446
-
447
-
448
-
449
-
450
-
451
-
430
+ </div></span>
431
+
432
+ </li>
433
+
434
+
435
+ <li class="public ">
436
+ <span class="summary_signature">
437
+
438
+ <a href="#redirect!-instance_method" title="#redirect! (instance method)">#<strong>redirect!</strong>(target, status = 302) &#x21d2; Object </a>
439
+
440
+
441
+
442
+ </span>
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
452
  <span class="summary_desc"><div class='inline'><p>Request relative redirect.</p>
453
- </div></span>
454
-
455
- </li>
456
-
457
-
458
- <li class="public ">
459
- <span class="summary_signature">
460
-
461
- <a href="#respond!-instance_method" title="#respond! (instance method)">#<strong>respond!</strong>(response) &#x21d2; Object </a>
462
-
463
-
464
-
465
- </span>
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
453
+ </div></span>
454
+
455
+ </li>
456
+
457
+
458
+ <li class="public ">
459
+ <span class="summary_signature">
460
+
461
+ <a href="#respond!-instance_method" title="#respond! (instance method)">#<strong>respond!</strong>(response) &#x21d2; Object </a>
462
+
463
+
464
+
465
+ </span>
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
475
  <span class="summary_desc"><div class='inline'><p>This will cause the middleware to generate a response.</p>
476
- </div></span>
477
-
478
- </li>
479
-
480
-
481
- <li class="public ">
482
- <span class="summary_signature">
483
-
484
- <a href="#succeed!-instance_method" title="#succeed! (instance method)">#<strong>succeed!</strong>(status: 200, headers: {}, **options) &#x21d2; Object </a>
485
-
486
-
487
-
488
- </span>
489
-
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
-
476
+ </div></span>
477
+
478
+ </li>
479
+
480
+
481
+ <li class="public ">
482
+ <span class="summary_signature">
483
+
484
+ <a href="#succeed!-instance_method" title="#succeed! (instance method)">#<strong>succeed!</strong>(status: 200, headers: {}, **options) &#x21d2; Object </a>
485
+
486
+
487
+
488
+ </span>
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
498
  <span class="summary_desc"><div class='inline'><p>Succeed the request and immediately respond.</p>
499
- </div></span>
500
-
501
- </li>
502
-
503
-
504
- </ul>
505
-
506
-
507
-
508
-
509
- <div id="class_method_details" class="method_details_list">
510
- <h2>Class Method Details</h2>
511
-
512
-
513
- <div class="method_details first">
514
- <h3 class="signature first" id="base_path-class_method">
515
-
516
- .<strong>base_path</strong> &#x21d2; <tt>Object</tt>
517
-
518
-
519
-
520
-
521
-
522
- </h3><div class="docstring">
523
- <div class="discussion">
499
+ </div></span>
500
+
501
+ </li>
502
+
503
+
504
+ </ul>
505
+
506
+
507
+
508
+
509
+ <div id="class_method_details" class="method_details_list">
510
+ <h2>Class Method Details</h2>
511
+
512
+
513
+ <div class="method_details first">
514
+ <h3 class="signature first" id="base_path-class_method">
515
+
516
+ .<strong>base_path</strong> &#x21d2; <tt>Object</tt>
517
+
518
+
519
+
520
+
521
+
522
+ </h3><div class="docstring">
523
+ <div class="discussion">
524
524
  <p>A string which is the full path to the directory which contains the controller.</p>
525
-
526
-
527
- </div>
528
- </div>
529
- <div class="tags">
530
-
531
-
532
- </div><table class="source_code">
533
- <tr>
534
- <td>
525
+
526
+
527
+ </div>
528
+ </div>
529
+ <div class="tags">
530
+
531
+
532
+ </div><table class="source_code">
533
+ <tr>
534
+ <td>
535
535
  <pre class="lines">
536
536
 
537
537
 
538
538
  28
539
539
  29
540
- 30</pre>
541
- </td>
542
- <td>
540
+ 30</pre>
541
+ </td>
542
+ <td>
543
543
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 28</span>
544
544
 
545
545
  <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_base_path'>base_path</span>
546
546
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='symbol'>:BASE_PATH</span><span class='rparen'>)</span>
547
- <span class='kw'>end</span></pre>
548
- </td>
549
- </tr>
550
- </table>
551
- </div>
552
-
553
- <div class="method_details ">
554
- <h3 class="signature " id="controller-class_method">
555
-
556
- .<strong>controller</strong> &#x21d2; <tt>Object</tt>
557
-
558
-
559
-
560
-
561
-
562
- </h3><div class="docstring">
563
- <div class="discussion">
547
+ <span class='kw'>end</span></pre>
548
+ </td>
549
+ </tr>
550
+ </table>
551
+ </div>
552
+
553
+ <div class="method_details ">
554
+ <h3 class="signature " id="controller-class_method">
555
+
556
+ .<strong>controller</strong> &#x21d2; <tt>Object</tt>
557
+
558
+
559
+
560
+
561
+
562
+ </h3><div class="docstring">
563
+ <div class="discussion">
564
564
  <p>The controller middleware itself.</p>
565
-
566
-
567
- </div>
568
- </div>
569
- <div class="tags">
570
-
571
-
572
- </div><table class="source_code">
573
- <tr>
574
- <td>
565
+
566
+
567
+ </div>
568
+ </div>
569
+ <div class="tags">
570
+
571
+
572
+ </div><table class="source_code">
573
+ <tr>
574
+ <td>
575
575
  <pre class="lines">
576
576
 
577
577
 
578
578
  38
579
579
  39
580
- 40</pre>
581
- </td>
582
- <td>
580
+ 40</pre>
581
+ </td>
582
+ <td>
583
583
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 38</span>
584
584
 
585
585
  <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_controller'>controller</span>
586
586
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='symbol'>:CONTROLLER</span><span class='rparen'>)</span>
587
- <span class='kw'>end</span></pre>
588
- </td>
589
- </tr>
590
- </table>
591
- </div>
592
-
593
- <div class="method_details ">
594
- <h3 class="signature " id="direct?-class_method">
595
-
596
- .<strong>direct?</strong>(path) &#x21d2; <tt>Boolean</tt>
597
-
598
-
599
-
600
-
601
-
602
- </h3><div class="docstring">
603
- <div class="discussion">
604
-
605
-
606
-
607
- </div>
608
- </div>
609
- <div class="tags">
610
-
611
- <p class="tag_title">Returns:</p>
612
- <ul class="return">
613
-
614
- <li>
615
-
616
-
617
- <span class='type'>(<tt>Boolean</tt>)</span>
618
-
619
-
620
-
621
- </li>
622
-
623
- </ul>
624
-
625
- </div><table class="source_code">
626
- <tr>
627
- <td>
587
+ <span class='kw'>end</span></pre>
588
+ </td>
589
+ </tr>
590
+ </table>
591
+ </div>
592
+
593
+ <div class="method_details ">
594
+ <h3 class="signature " id="direct?-class_method">
595
+
596
+ .<strong>direct?</strong>(path) &#x21d2; <tt>Boolean</tt>
597
+
598
+
599
+
600
+
601
+
602
+ </h3><div class="docstring">
603
+ <div class="discussion">
604
+
605
+
606
+
607
+ </div>
608
+ </div>
609
+ <div class="tags">
610
+
611
+ <p class="tag_title">Returns:</p>
612
+ <ul class="return">
613
+
614
+ <li>
615
+
616
+
617
+ <span class='type'>(<tt>Boolean</tt>)</span>
618
+
619
+
620
+
621
+ </li>
622
+
623
+ </ul>
624
+
625
+ </div><table class="source_code">
626
+ <tr>
627
+ <td>
628
628
  <pre class="lines">
629
629
 
630
630
 
631
631
  52
632
632
  53
633
- 54</pre>
634
- </td>
635
- <td>
633
+ 54</pre>
634
+ </td>
635
+ <td>
636
636
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 52</span>
637
637
 
638
638
  <span class='kw'>def</span> <span class='id identifier rubyid_direct?'>direct?</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
639
639
  <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span> <span class='op'>==</span> <span class='id identifier rubyid_uri_path'>uri_path</span>
640
- <span class='kw'>end</span></pre>
641
- </td>
642
- </tr>
643
- </table>
644
- </div>
645
-
646
- <div class="method_details ">
647
- <h3 class="signature " id="freeze-class_method">
648
-
649
- .<strong>freeze</strong> &#x21d2; <tt>Object</tt>
650
-
651
-
652
-
653
-
654
-
655
- </h3><table class="source_code">
656
- <tr>
657
- <td>
640
+ <span class='kw'>end</span></pre>
641
+ </td>
642
+ </tr>
643
+ </table>
644
+ </div>
645
+
646
+ <div class="method_details ">
647
+ <h3 class="signature " id="freeze-class_method">
648
+
649
+ .<strong>freeze</strong> &#x21d2; <tt>Object</tt>
650
+
651
+
652
+
653
+
654
+
655
+ </h3><table class="source_code">
656
+ <tr>
657
+ <td>
658
658
  <pre class="lines">
659
659
 
660
660
 
@@ -665,9 +665,9 @@
665
665
  47
666
666
  48
667
667
  49
668
- 50</pre>
669
- </td>
670
- <td>
668
+ 50</pre>
669
+ </td>
670
+ <td>
671
671
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 43</span>
672
672
 
673
673
  <span class='kw'>def</span> <span class='id identifier rubyid_freeze'>freeze</span>
@@ -677,80 +677,80 @@
677
677
  <span class='kw'>end</span>
678
678
 
679
679
  <span class='kw'>super</span>
680
- <span class='kw'>end</span></pre>
681
- </td>
682
- </tr>
683
- </table>
684
- </div>
685
-
686
- <div class="method_details ">
687
- <h3 class="signature " id="uri_path-class_method">
688
-
689
- .<strong>uri_path</strong> &#x21d2; <tt>Object</tt>
690
-
691
-
692
-
693
-
694
-
695
- </h3><div class="docstring">
696
- <div class="discussion">
680
+ <span class='kw'>end</span></pre>
681
+ </td>
682
+ </tr>
683
+ </table>
684
+ </div>
685
+
686
+ <div class="method_details ">
687
+ <h3 class="signature " id="uri_path-class_method">
688
+
689
+ .<strong>uri_path</strong> &#x21d2; <tt>Object</tt>
690
+
691
+
692
+
693
+
694
+
695
+ </h3><div class="docstring">
696
+ <div class="discussion">
697
697
  <p>A relative path to the controller directory relative to the controller root directory.</p>
698
-
699
-
700
- </div>
701
- </div>
702
- <div class="tags">
703
-
704
-
705
- </div><table class="source_code">
706
- <tr>
707
- <td>
698
+
699
+
700
+ </div>
701
+ </div>
702
+ <div class="tags">
703
+
704
+
705
+ </div><table class="source_code">
706
+ <tr>
707
+ <td>
708
708
  <pre class="lines">
709
709
 
710
710
 
711
711
  33
712
712
  34
713
- 35</pre>
714
- </td>
715
- <td>
713
+ 35</pre>
714
+ </td>
715
+ <td>
716
716
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 33</span>
717
717
 
718
718
  <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_uri_path'>uri_path</span>
719
719
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_const_get'>const_get</span><span class='lparen'>(</span><span class='symbol'>:URI_PATH</span><span class='rparen'>)</span>
720
- <span class='kw'>end</span></pre>
721
- </td>
722
- </tr>
723
- </table>
724
- </div>
725
-
726
- </div>
727
-
728
- <div id="instance_method_details" class="method_details_list">
729
- <h2>Instance Method Details</h2>
730
-
731
-
732
- <div class="method_details first">
733
- <h3 class="signature first" id="body_for-instance_method">
734
-
735
- #<strong>body_for</strong>(status, headers, options) &#x21d2; <tt>Object</tt>
736
-
737
-
738
-
739
-
740
-
741
- </h3><div class="docstring">
742
- <div class="discussion">
720
+ <span class='kw'>end</span></pre>
721
+ </td>
722
+ </tr>
723
+ </table>
724
+ </div>
725
+
726
+ </div>
727
+
728
+ <div id="instance_method_details" class="method_details_list">
729
+ <h2>Instance Method Details</h2>
730
+
731
+
732
+ <div class="method_details first">
733
+ <h3 class="signature first" id="body_for-instance_method">
734
+
735
+ #<strong>body_for</strong>(status, headers, options) &#x21d2; <tt>Object</tt>
736
+
737
+
738
+
739
+
740
+
741
+ </h3><div class="docstring">
742
+ <div class="discussion">
743
743
  <p>Generate the body for the given status, headers and options.</p>
744
-
745
-
746
- </div>
747
- </div>
748
- <div class="tags">
749
-
750
-
751
- </div><table class="source_code">
752
- <tr>
753
- <td>
744
+
745
+
746
+ </div>
747
+ </div>
748
+ <div class="tags">
749
+
750
+
751
+ </div><table class="source_code">
752
+ <tr>
753
+ <td>
754
754
  <pre class="lines">
755
755
 
756
756
 
@@ -760,9 +760,9 @@
760
760
  127
761
761
  128
762
762
  129
763
- 130</pre>
764
- </td>
765
- <td>
763
+ 130</pre>
764
+ </td>
765
+ <td>
766
766
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 124</span>
767
767
 
768
768
  <span class='kw'>def</span> <span class='id identifier rubyid_body_for'>body_for</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
@@ -771,64 +771,64 @@
771
771
  <span class='kw'>elsif</span> <span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:content</span><span class='rbracket'>]</span>
772
772
  <span class='kw'>return</span> <span class='lbracket'>[</span><span class='id identifier rubyid_content'>content</span><span class='rbracket'>]</span>
773
773
  <span class='kw'>end</span>
774
- <span class='kw'>end</span></pre>
775
- </td>
776
- </tr>
777
- </table>
778
- </div>
779
-
780
- <div class="method_details ">
781
- <h3 class="signature " id="call-instance_method">
782
-
783
- #<strong>call</strong>(env) &#x21d2; <tt>Object</tt>
784
-
785
-
786
-
787
-
788
-
789
- </h3><div class="docstring">
790
- <div class="discussion">
774
+ <span class='kw'>end</span></pre>
775
+ </td>
776
+ </tr>
777
+ </table>
778
+ </div>
779
+
780
+ <div class="method_details ">
781
+ <h3 class="signature " id="call-instance_method">
782
+
783
+ #<strong>call</strong>(env) &#x21d2; <tt>Object</tt>
784
+
785
+
786
+
787
+
788
+
789
+ </h3><div class="docstring">
790
+ <div class="discussion">
791
791
  <p>Call into the next app as defined by rack.</p>
792
-
793
-
794
- </div>
795
- </div>
796
- <div class="tags">
797
-
798
-
799
- </div><table class="source_code">
800
- <tr>
801
- <td>
792
+
793
+
794
+ </div>
795
+ </div>
796
+ <div class="tags">
797
+
798
+
799
+ </div><table class="source_code">
800
+ <tr>
801
+ <td>
802
802
  <pre class="lines">
803
803
 
804
804
 
805
805
  76
806
806
  77
807
- 78</pre>
808
- </td>
809
- <td>
807
+ 78</pre>
808
+ </td>
809
+ <td>
810
810
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 76</span>
811
811
 
812
812
  <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
813
813
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_controller'>controller</span><span class='period'>.</span><span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
814
- <span class='kw'>end</span></pre>
815
- </td>
816
- </tr>
817
- </table>
818
- </div>
819
-
820
- <div class="method_details ">
821
- <h3 class="signature " id="catch_response-instance_method">
822
-
823
- #<strong>catch_response</strong> &#x21d2; <tt>Object</tt>
824
-
825
-
826
-
827
-
828
-
829
- </h3><table class="source_code">
830
- <tr>
831
- <td>
814
+ <span class='kw'>end</span></pre>
815
+ </td>
816
+ </tr>
817
+ </table>
818
+ </div>
819
+
820
+ <div class="method_details ">
821
+ <h3 class="signature " id="catch_response-instance_method">
822
+
823
+ #<strong>catch_response</strong> &#x21d2; <tt>Object</tt>
824
+
825
+
826
+
827
+
828
+
829
+ </h3><table class="source_code">
830
+ <tr>
831
+ <td>
832
832
  <pre class="lines">
833
833
 
834
834
 
@@ -836,43 +836,43 @@
836
836
  58
837
837
  59
838
838
  60
839
- 61</pre>
840
- </td>
841
- <td>
839
+ 61</pre>
840
+ </td>
841
+ <td>
842
842
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 57</span>
843
843
 
844
844
  <span class='kw'>def</span> <span class='id identifier rubyid_catch_response'>catch_response</span>
845
845
  <span class='id identifier rubyid_catch'>catch</span><span class='lparen'>(</span><span class='symbol'>:response</span><span class='rparen'>)</span> <span class='kw'>do</span>
846
846
  <span class='kw'>yield</span> <span class='kw'>and</span> <span class='kw'>nil</span>
847
847
  <span class='kw'>end</span>
848
- <span class='kw'>end</span></pre>
849
- </td>
850
- </tr>
851
- </table>
852
- </div>
853
-
854
- <div class="method_details ">
855
- <h3 class="signature " id="copy_instance_variables-instance_method">
856
-
857
- #<strong>copy_instance_variables</strong>(from) &#x21d2; <tt>Object</tt>
858
-
859
-
860
-
861
-
862
-
863
- </h3><div class="docstring">
864
- <div class="discussion">
848
+ <span class='kw'>end</span></pre>
849
+ </td>
850
+ </tr>
851
+ </table>
852
+ </div>
853
+
854
+ <div class="method_details ">
855
+ <h3 class="signature " id="copy_instance_variables-instance_method">
856
+
857
+ #<strong>copy_instance_variables</strong>(from) &#x21d2; <tt>Object</tt>
858
+
859
+
860
+
861
+
862
+
863
+ </h3><div class="docstring">
864
+ <div class="discussion">
865
865
  <p>Copy the instance variables from the previous controller to the next controller (usually only a few). This allows controllers to share effectively the same instance variables while still being separate classes/instances.</p>
866
-
867
-
868
- </div>
869
- </div>
870
- <div class="tags">
871
-
872
-
873
- </div><table class="source_code">
874
- <tr>
875
- <td>
866
+
867
+
868
+ </div>
869
+ </div>
870
+ <div class="tags">
871
+
872
+
873
+ </div><table class="source_code">
874
+ <tr>
875
+ <td>
876
876
  <pre class="lines">
877
877
 
878
878
 
@@ -880,43 +880,43 @@
880
880
  70
881
881
  71
882
882
  72
883
- 73</pre>
884
- </td>
885
- <td>
883
+ 73</pre>
884
+ </td>
885
+ <td>
886
886
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 69</span>
887
887
 
888
888
  <span class='kw'>def</span> <span class='id identifier rubyid_copy_instance_variables'>copy_instance_variables</span><span class='lparen'>(</span><span class='id identifier rubyid_from'>from</span><span class='rparen'>)</span>
889
889
  <span class='id identifier rubyid_from'>from</span><span class='period'>.</span><span class='id identifier rubyid_instance_variables'>instance_variables</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_name'>name</span><span class='op'>|</span>
890
890
  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_from'>from</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='rparen'>)</span>
891
891
  <span class='kw'>end</span>
892
- <span class='kw'>end</span></pre>
893
- </td>
894
- </tr>
895
- </table>
896
- </div>
897
-
898
- <div class="method_details ">
899
- <h3 class="signature " id="fail!-instance_method">
900
-
901
- #<strong>fail!</strong>(error = 400, message = nil) &#x21d2; <tt>Object</tt>
902
-
903
-
904
-
905
-
906
-
907
- </h3><div class="docstring">
908
- <div class="discussion">
892
+ <span class='kw'>end</span></pre>
893
+ </td>
894
+ </tr>
895
+ </table>
896
+ </div>
897
+
898
+ <div class="method_details ">
899
+ <h3 class="signature " id="fail!-instance_method">
900
+
901
+ #<strong>fail!</strong>(error = 400, message = nil) &#x21d2; <tt>Object</tt>
902
+
903
+
904
+
905
+
906
+
907
+ </h3><div class="docstring">
908
+ <div class="discussion">
909
909
  <p>Respond with an error which indiciates some kind of failure.</p>
910
-
911
-
912
- </div>
913
- </div>
914
- <div class="tags">
915
-
916
-
917
- </div><table class="source_code">
918
- <tr>
919
- <td>
910
+
911
+
912
+ </div>
913
+ </div>
914
+ <div class="tags">
915
+
916
+
917
+ </div><table class="source_code">
918
+ <tr>
919
+ <td>
920
920
  <pre class="lines">
921
921
 
922
922
 
@@ -925,9 +925,9 @@
925
925
  106
926
926
  107
927
927
  108
928
- 109</pre>
929
- </td>
930
- <td>
928
+ 109</pre>
929
+ </td>
930
+ <td>
931
931
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 104</span>
932
932
 
933
933
  <span class='kw'>def</span> <span class='id identifier rubyid_fail!'>fail!</span><span class='lparen'>(</span><span class='id identifier rubyid_error'>error</span> <span class='op'>=</span> <span class='int'>400</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
@@ -935,154 +935,154 @@
935
935
 
936
936
  <span class='id identifier rubyid_message'>message</span> <span class='op'>||=</span> <span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
937
937
  <span class='id identifier rubyid_respond!'>respond!</span> <span class='lbracket'>[</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_message'>message</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
938
- <span class='kw'>end</span></pre>
939
- </td>
940
- </tr>
941
- </table>
942
- </div>
943
-
944
- <div class="method_details ">
945
- <h3 class="signature " id="goto!-instance_method">
946
-
947
- #<strong>goto!</strong>(target, status = 302) &#x21d2; <tt>Object</tt>
948
-
949
-
950
-
951
-
952
-
953
- </h3><div class="docstring">
954
- <div class="discussion">
938
+ <span class='kw'>end</span></pre>
939
+ </td>
940
+ </tr>
941
+ </table>
942
+ </div>
943
+
944
+ <div class="method_details ">
945
+ <h3 class="signature " id="goto!-instance_method">
946
+
947
+ #<strong>goto!</strong>(target, status = 302) &#x21d2; <tt>Object</tt>
948
+
949
+
950
+
951
+
952
+
953
+ </h3><div class="docstring">
954
+ <div class="discussion">
955
955
  <p>Controller relative redirect.</p>
956
-
957
-
958
- </div>
959
- </div>
960
- <div class="tags">
961
-
962
-
963
- </div><table class="source_code">
964
- <tr>
965
- <td>
956
+
957
+
958
+ </div>
959
+ </div>
960
+ <div class="tags">
961
+
962
+
963
+ </div><table class="source_code">
964
+ <tr>
965
+ <td>
966
966
  <pre class="lines">
967
967
 
968
968
 
969
969
  99
970
970
  100
971
- 101</pre>
972
- </td>
973
- <td>
971
+ 101</pre>
972
+ </td>
973
+ <td>
974
974
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 99</span>
975
975
 
976
976
  <span class='kw'>def</span> <span class='id identifier rubyid_goto!'>goto!</span><span class='lparen'>(</span><span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='int'>302</span><span class='rparen'>)</span>
977
977
  <span class='id identifier rubyid_redirect!'>redirect!</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_uri_path'>uri_path</span> <span class='op'>+</span> <span class='id identifier rubyid_target'>target</span>
978
- <span class='kw'>end</span></pre>
979
- </td>
980
- </tr>
981
- </table>
982
- </div>
983
-
984
- <div class="method_details ">
985
- <h3 class="signature " id="ignore!-instance_method">
986
-
987
- #<strong>ignore!</strong> &#x21d2; <tt>Object</tt>
988
-
989
-
990
-
991
-
992
-
993
- </h3><div class="docstring">
994
- <div class="discussion">
978
+ <span class='kw'>end</span></pre>
979
+ </td>
980
+ </tr>
981
+ </table>
982
+ </div>
983
+
984
+ <div class="method_details ">
985
+ <h3 class="signature " id="ignore!-instance_method">
986
+
987
+ #<strong>ignore!</strong> &#x21d2; <tt>Object</tt>
988
+
989
+
990
+
991
+
992
+
993
+ </h3><div class="docstring">
994
+ <div class="discussion">
995
995
  <p>This will cause the controller middleware to pass on the request.</p>
996
-
997
-
998
- </div>
999
- </div>
1000
- <div class="tags">
1001
-
1002
-
1003
- </div><table class="source_code">
1004
- <tr>
1005
- <td>
996
+
997
+
998
+ </div>
999
+ </div>
1000
+ <div class="tags">
1001
+
1002
+
1003
+ </div><table class="source_code">
1004
+ <tr>
1005
+ <td>
1006
1006
  <pre class="lines">
1007
1007
 
1008
1008
 
1009
1009
  86
1010
1010
  87
1011
- 88</pre>
1012
- </td>
1013
- <td>
1011
+ 88</pre>
1012
+ </td>
1013
+ <td>
1014
1014
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 86</span>
1015
1015
 
1016
1016
  <span class='kw'>def</span> <span class='id identifier rubyid_ignore!'>ignore!</span>
1017
1017
  <span class='id identifier rubyid_throw'>throw</span> <span class='symbol'>:response</span><span class='comma'>,</span> <span class='kw'>nil</span>
1018
- <span class='kw'>end</span></pre>
1019
- </td>
1020
- </tr>
1021
- </table>
1022
- </div>
1023
-
1024
- <div class="method_details ">
1025
- <h3 class="signature " id="process!-instance_method">
1026
-
1027
- #<strong>process!</strong>(request, relative_path) &#x21d2; <tt>Object</tt>
1028
-
1029
-
1030
-
1031
-
1032
-
1033
- </h3><div class="docstring">
1034
- <div class="discussion">
1018
+ <span class='kw'>end</span></pre>
1019
+ </td>
1020
+ </tr>
1021
+ </table>
1022
+ </div>
1023
+
1024
+ <div class="method_details ">
1025
+ <h3 class="signature " id="process!-instance_method">
1026
+
1027
+ #<strong>process!</strong>(request, relative_path) &#x21d2; <tt>Object</tt>
1028
+
1029
+
1030
+
1031
+
1032
+
1033
+ </h3><div class="docstring">
1034
+ <div class="discussion">
1035
1035
  <p>Return nil if this controller didn’t do anything. Request will keep on processing. Return a valid rack response if the controller can do so.</p>
1036
-
1037
-
1038
- </div>
1039
- </div>
1040
- <div class="tags">
1041
-
1042
-
1043
- </div><table class="source_code">
1044
- <tr>
1045
- <td>
1036
+
1037
+
1038
+ </div>
1039
+ </div>
1040
+ <div class="tags">
1041
+
1042
+
1043
+ </div><table class="source_code">
1044
+ <tr>
1045
+ <td>
1046
1046
  <pre class="lines">
1047
1047
 
1048
1048
 
1049
1049
  64
1050
1050
  65
1051
- 66</pre>
1052
- </td>
1053
- <td>
1051
+ 66</pre>
1052
+ </td>
1053
+ <td>
1054
1054
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 64</span>
1055
1055
 
1056
1056
  <span class='kw'>def</span> <span class='id identifier rubyid_process!'>process!</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_relative_path'>relative_path</span><span class='rparen'>)</span>
1057
1057
  <span class='kw'>return</span> <span class='kw'>nil</span>
1058
- <span class='kw'>end</span></pre>
1059
- </td>
1060
- </tr>
1061
- </table>
1062
- </div>
1063
-
1064
- <div class="method_details ">
1065
- <h3 class="signature " id="redirect!-instance_method">
1066
-
1067
- #<strong>redirect!</strong>(target, status = 302) &#x21d2; <tt>Object</tt>
1068
-
1069
-
1070
-
1071
-
1072
-
1073
- </h3><div class="docstring">
1074
- <div class="discussion">
1058
+ <span class='kw'>end</span></pre>
1059
+ </td>
1060
+ </tr>
1061
+ </table>
1062
+ </div>
1063
+
1064
+ <div class="method_details ">
1065
+ <h3 class="signature " id="redirect!-instance_method">
1066
+
1067
+ #<strong>redirect!</strong>(target, status = 302) &#x21d2; <tt>Object</tt>
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+ </h3><div class="docstring">
1074
+ <div class="discussion">
1075
1075
  <p>Request relative redirect. Respond with a redirect to the given target.</p>
1076
-
1077
-
1078
- </div>
1079
- </div>
1080
- <div class="tags">
1081
-
1082
-
1083
- </div><table class="source_code">
1084
- <tr>
1085
- <td>
1076
+
1077
+
1078
+ </div>
1079
+ </div>
1080
+ <div class="tags">
1081
+
1082
+
1083
+ </div><table class="source_code">
1084
+ <tr>
1085
+ <td>
1086
1086
  <pre class="lines">
1087
1087
 
1088
1088
 
@@ -1091,9 +1091,9 @@
1091
1091
  93
1092
1092
  94
1093
1093
  95
1094
- 96</pre>
1095
- </td>
1096
- <td>
1094
+ 96</pre>
1095
+ </td>
1096
+ <td>
1097
1097
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 91</span>
1098
1098
 
1099
1099
  <span class='kw'>def</span> <span class='id identifier rubyid_redirect!'>redirect!</span><span class='lparen'>(</span><span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>=</span> <span class='int'>302</span><span class='rparen'>)</span>
@@ -1101,74 +1101,74 @@
1101
1101
  <span class='id identifier rubyid_location'>location</span> <span class='op'>=</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
1102
1102
 
1103
1103
  <span class='id identifier rubyid_respond!'>respond!</span> <span class='lbracket'>[</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='const'><span class='object_link'><a href="../HTTP.html" title="Utopia::HTTP (module)">HTTP</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../HTTP.html#LOCATION-constant" title="Utopia::HTTP::LOCATION (constant)">LOCATION</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_location'>location</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
1104
- <span class='kw'>end</span></pre>
1105
- </td>
1106
- </tr>
1107
- </table>
1108
- </div>
1109
-
1110
- <div class="method_details ">
1111
- <h3 class="signature " id="respond!-instance_method">
1112
-
1113
- #<strong>respond!</strong>(response) &#x21d2; <tt>Object</tt>
1114
-
1115
-
1116
-
1117
-
1118
-
1119
- </h3><div class="docstring">
1120
- <div class="discussion">
1104
+ <span class='kw'>end</span></pre>
1105
+ </td>
1106
+ </tr>
1107
+ </table>
1108
+ </div>
1109
+
1110
+ <div class="method_details ">
1111
+ <h3 class="signature " id="respond!-instance_method">
1112
+
1113
+ #<strong>respond!</strong>(response) &#x21d2; <tt>Object</tt>
1114
+
1115
+
1116
+
1117
+
1118
+
1119
+ </h3><div class="docstring">
1120
+ <div class="discussion">
1121
1121
  <p>This will cause the middleware to generate a response.</p>
1122
-
1123
-
1124
- </div>
1125
- </div>
1126
- <div class="tags">
1127
-
1128
-
1129
- </div><table class="source_code">
1130
- <tr>
1131
- <td>
1122
+
1123
+
1124
+ </div>
1125
+ </div>
1126
+ <div class="tags">
1127
+
1128
+
1129
+ </div><table class="source_code">
1130
+ <tr>
1131
+ <td>
1132
1132
  <pre class="lines">
1133
1133
 
1134
1134
 
1135
1135
  81
1136
1136
  82
1137
- 83</pre>
1138
- </td>
1139
- <td>
1137
+ 83</pre>
1138
+ </td>
1139
+ <td>
1140
1140
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 81</span>
1141
1141
 
1142
1142
  <span class='kw'>def</span> <span class='id identifier rubyid_respond!'>respond!</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
1143
1143
  <span class='id identifier rubyid_throw'>throw</span> <span class='symbol'>:response</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span>
1144
- <span class='kw'>end</span></pre>
1145
- </td>
1146
- </tr>
1147
- </table>
1148
- </div>
1149
-
1150
- <div class="method_details ">
1151
- <h3 class="signature " id="succeed!-instance_method">
1152
-
1153
- #<strong>succeed!</strong>(status: 200, headers: {}, **options) &#x21d2; <tt>Object</tt>
1154
-
1155
-
1156
-
1157
-
1158
-
1159
- </h3><div class="docstring">
1160
- <div class="discussion">
1144
+ <span class='kw'>end</span></pre>
1145
+ </td>
1146
+ </tr>
1147
+ </table>
1148
+ </div>
1149
+
1150
+ <div class="method_details ">
1151
+ <h3 class="signature " id="succeed!-instance_method">
1152
+
1153
+ #<strong>succeed!</strong>(status: 200, headers: {}, **options) &#x21d2; <tt>Object</tt>
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+ </h3><div class="docstring">
1160
+ <div class="discussion">
1161
1161
  <p>Succeed the request and immediately respond.</p>
1162
-
1163
-
1164
- </div>
1165
- </div>
1166
- <div class="tags">
1167
-
1168
-
1169
- </div><table class="source_code">
1170
- <tr>
1171
- <td>
1162
+
1163
+
1164
+ </div>
1165
+ </div>
1166
+ <div class="tags">
1167
+
1168
+
1169
+ </div><table class="source_code">
1170
+ <tr>
1171
+ <td>
1172
1172
  <pre class="lines">
1173
1173
 
1174
1174
 
@@ -1181,9 +1181,9 @@
1181
1181
  118
1182
1182
  119
1183
1183
  120
1184
- 121</pre>
1185
- </td>
1186
- <td>
1184
+ 121</pre>
1185
+ </td>
1186
+ <td>
1187
1187
  <pre class="code"><span class="info file"># File 'lib/utopia/controller/base.rb', line 112</span>
1188
1188
 
1189
1189
  <span class='kw'>def</span> <span class='id identifier rubyid_succeed!'>succeed!</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='int'>200</span><span class='comma'>,</span> <span class='label'>headers:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
@@ -1195,22 +1195,22 @@
1195
1195
 
1196
1196
  <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='id identifier rubyid_body_for'>body_for</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
1197
1197
  <span class='id identifier rubyid_respond!'>respond!</span> <span class='lbracket'>[</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span> <span class='op'>||</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rbracket'>]</span>
1198
- <span class='kw'>end</span></pre>
1199
- </td>
1200
- </tr>
1201
- </table>
1202
- </div>
1203
-
1204
- </div>
1205
-
1206
- </div>
1207
-
1208
- <div id="footer">
1209
- Generated on Sat Mar 24 21:17:21 2018 by
1210
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1211
- 0.9.12 (ruby-2.5.0).
1212
- </div>
1213
-
1214
- </div>
1215
- </body>
1198
+ <span class='kw'>end</span></pre>
1199
+ </td>
1200
+ </tr>
1201
+ </table>
1202
+ </div>
1203
+
1204
+ </div>
1205
+
1206
+ </div>
1207
+
1208
+ <div id="footer">
1209
+ Generated on Sat Mar 9 12:01:54 2019 by
1210
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1211
+ 0.9.18 (ruby-2.6.1).
1212
+ </div>
1213
+
1214
+ </div>
1215
+ </body>
1216
1216
  </html>