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
@@ -0,0 +1,249 @@
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::Transform
8
+
9
+ &mdash; Documentation by YARD 0.7.4
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 (T)</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">Transform</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::Transform
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/transform.rb</dd>
80
+
81
+ </dl>
82
+ <div class="clear"></div>
83
+
84
+ <h2>Overview</h2><div class="docstring">
85
+ <div class="discussion">
86
+ <p>Module used for transforming arbitrary values using the registerd variable types.</p>
87
+
88
+
89
+ </div>
90
+ </div>
91
+ <div class="tags">
92
+
93
+
94
+ <h3>See Also:</h3>
95
+ <ul class="see">
96
+
97
+ <li>#register_variable_name.</li>
98
+
99
+ </ul>
100
+
101
+ </div>
102
+
103
+
104
+
105
+
106
+
107
+ <h2>
108
+ Instance Method Summary
109
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
110
+ </h2>
111
+
112
+ <ul class="summary">
113
+
114
+ <li class="public ">
115
+ <span class="summary_signature">
116
+
117
+ <a href="#transform-instance_method" title="#transform (instance method)">- (Object) <strong>transform</strong>(type, value) </a>
118
+
119
+
120
+
121
+ </span>
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+ <span class="summary_desc"><div class='inline'><p>Transforms a value according to the rules specified by #register_variable_name.</p>
131
+ </div></span>
132
+
133
+ </li>
134
+
135
+
136
+ </ul>
137
+
138
+
139
+
140
+
141
+ <div id="instance_method_details" class="method_details_list">
142
+ <h2>Instance Method Details</h2>
143
+
144
+
145
+ <div class="method_details first">
146
+ <p class="signature first" id="transform-instance_method">
147
+
148
+ - (<tt>Object</tt>) <strong>transform</strong>(type, value)
149
+
150
+
151
+
152
+ </p><div class="docstring">
153
+ <div class="discussion">
154
+ <p>Transforms a value according to the rules specified by #register_variable_name.</p>
155
+
156
+
157
+ </div>
158
+ </div>
159
+ <div class="tags">
160
+ <h3>Parameters:</h3>
161
+ <ul class="param">
162
+
163
+ <li>
164
+
165
+ <span class='name'>name</span>
166
+
167
+
168
+ <span class='type'>(<tt>Symbol</tt>)</span>
169
+
170
+
171
+
172
+ &mdash;
173
+ <div class='inline'><p>The name of the variable type.</p>
174
+ </div>
175
+
176
+ </li>
177
+
178
+ <li>
179
+
180
+ <span class='name'>value</span>
181
+
182
+
183
+ <span class='type'>(<tt>String</tt>)</span>
184
+
185
+
186
+
187
+ &mdash;
188
+ <div class='inline'><p>The value to transform.</p>
189
+ </div>
190
+
191
+ </li>
192
+
193
+ </ul>
194
+
195
+ <h3>Returns:</h3>
196
+ <ul class="return">
197
+
198
+ <li>
199
+
200
+
201
+ <span class='type'></span>
202
+
203
+
204
+
205
+
206
+ <div class='inline'><p>The transformed value or nil.</p>
207
+ </div>
208
+
209
+ </li>
210
+
211
+ </ul>
212
+
213
+ </div><table class="source_code">
214
+ <tr>
215
+ <td>
216
+ <pre class="lines">
217
+
218
+
219
+ 11
220
+ 12
221
+ 13
222
+ 14
223
+ 15</pre>
224
+ </td>
225
+ <td>
226
+ <pre class="code"><span class="info file"># File 'lib/renee/core/transform.rb', line 11</span>
227
+
228
+ <span class='kw'>def</span> <span class='id identifier rubyid_transform'>transform</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
229
+ <span class='kw'>if</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_variable_types'>variable_types</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='id identifier rubyid_m'>m</span> <span class='op'>=</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_variable_types'>variable_types</span><span class='lbracket'>[</span><span class='id identifier rubyid_type'>type</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_value'>value</span><span class='rbracket'>]</span>
230
+ <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='op'>==</span> <span class='id identifier rubyid_value'>value</span> <span class='op'>?</span> <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span> <span class='op'>:</span> <span class='kw'>nil</span>
231
+ <span class='kw'>end</span>
232
+ <span class='kw'>end</span></pre>
233
+ </td>
234
+ </tr>
235
+ </table>
236
+ </div>
237
+
238
+ </div>
239
+
240
+ </div>
241
+
242
+ <div id="footer">
243
+ Generated on Mon Jan 23 11:10:30 2012 by
244
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
245
+ 0.7.4 (ruby-1.9.2).
246
+ </div>
247
+
248
+ </body>
249
+ </html>
@@ -0,0 +1,597 @@
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::URLGeneration
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 (U)</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">URLGeneration</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::URLGeneration
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="ClassMethods.html" title="Renee::Core::ClassMethods (module)">ClassMethods</a></span></dd>
75
+
76
+
77
+
78
+ <dt class="r2 last">Defined in:</dt>
79
+ <dd class="r2 last">lib/renee/core/url_generation.rb</dd>
80
+
81
+ </dl>
82
+ <div class="clear"></div>
83
+
84
+ <h2>Overview</h2><div class="docstring">
85
+ <div class="discussion">
86
+ <p>URL generator for creating paths and URLs within your application.</p>
87
+
88
+
89
+ </div>
90
+ </div>
91
+ <div class="tags">
92
+
93
+
94
+ </div>
95
+
96
+
97
+
98
+
99
+
100
+ <h2>
101
+ Instance Method Summary
102
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
103
+ </h2>
104
+
105
+ <ul class="summary">
106
+
107
+ <li class="public ">
108
+ <span class="summary_signature">
109
+
110
+ <a href="#path-instance_method" title="#path (instance method)">- (Object) <strong>path</strong>(name, *args) </a>
111
+
112
+
113
+
114
+ </span>
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+ <span class="summary_desc"><div class='inline'><p>Generates a path for a given name.</p>
124
+ </div></span>
125
+
126
+ </li>
127
+
128
+
129
+ <li class="public ">
130
+ <span class="summary_signature">
131
+
132
+ <a href="#prefix-instance_method" title="#prefix (instance method)">- (Object) <strong>prefix</strong>(prefix, defaults = nil, &amp;blk) </a>
133
+
134
+
135
+
136
+ </span>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+ <span class="summary_desc"><div class='inline'><p>Allows the creation of generation contexts.</p>
146
+ </div></span>
147
+
148
+ </li>
149
+
150
+
151
+ <li class="public ">
152
+ <span class="summary_signature">
153
+
154
+ <a href="#register-instance_method" title="#register (instance method)">- (Object) <strong>register</strong>(name, pattern, defaults = nil) </a>
155
+
156
+
157
+
158
+ </span>
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <span class="summary_desc"><div class='inline'><p>Registers new paths for generation.</p>
168
+ </div></span>
169
+
170
+ </li>
171
+
172
+
173
+ <li class="public ">
174
+ <span class="summary_signature">
175
+
176
+ <a href="#url-instance_method" title="#url (instance method)">- (Object) <strong>url</strong>(name, *args) </a>
177
+
178
+
179
+
180
+ </span>
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+ <span class="summary_desc"><div class='inline'><p>Generates a url for a given name.</p>
190
+ </div></span>
191
+
192
+ </li>
193
+
194
+
195
+ </ul>
196
+
197
+
198
+
199
+
200
+ <div id="instance_method_details" class="method_details_list">
201
+ <h2>Instance Method Details</h2>
202
+
203
+
204
+ <div class="method_details first">
205
+ <p class="signature first" id="path-instance_method">
206
+
207
+ - (<tt>Object</tt>) <strong>path</strong>(name, *args)
208
+
209
+
210
+
211
+ </p><div class="docstring">
212
+ <div class="discussion">
213
+ <p>Generates a path for a given name.</p>
214
+
215
+
216
+ </div>
217
+ </div>
218
+ <div class="tags">
219
+ <h3>Parameters:</h3>
220
+ <ul class="param">
221
+
222
+ <li>
223
+
224
+ <span class='name'>name</span>
225
+
226
+
227
+ <span class='type'>(<tt>Symbol</tt>)</span>
228
+
229
+
230
+
231
+ &mdash;
232
+ <div class='inline'><p>The name of the path</p>
233
+ </div>
234
+
235
+ </li>
236
+
237
+ <li>
238
+
239
+ <span class='name'>args</span>
240
+
241
+
242
+ <span class='type'>(<tt>Object</tt>)</span>
243
+
244
+
245
+
246
+ &mdash;
247
+ <div class='inline'><p>The values used to generate the path. Can be named with using :name => "value" or supplied
248
+ in the order for which the variables were decalared in #register.</p>
249
+ </div>
250
+
251
+ </li>
252
+
253
+ </ul>
254
+
255
+
256
+ <h3>See Also:</h3>
257
+ <ul class="see">
258
+
259
+ <li><span class='object_link'><a href="#register-instance_method" title="Renee::Core::URLGeneration#register (method)">#register</a></span></li>
260
+
261
+ </ul>
262
+
263
+ </div><table class="source_code">
264
+ <tr>
265
+ <td>
266
+ <pre class="lines">
267
+
268
+
269
+ 53
270
+ 54
271
+ 55
272
+ 56</pre>
273
+ </td>
274
+ <td>
275
+ <pre class="code"><span class="info file"># File 'lib/renee/core/url_generation.rb', line 53</span>
276
+
277
+ <span class='kw'>def</span> <span class='id path'>path</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id args'>args</span><span class='rparen'>)</span>
278
+ <span class='id generator'>generator</span> <span class='op'>=</span> <span class='id url_generators'>url_generators</span><span class='lbracket'>[</span><span class='id name'>name</span><span class='rbracket'>]</span>
279
+ <span class='id generator'>generator</span> <span class='op'>?</span> <span class='id generator'>generator</span><span class='period'>.</span><span class='id path'>path</span><span class='lparen'>(</span><span class='op'>*</span><span class='id args'>args</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id raise'>raise</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Generator for </span><span class='embexpr_beg'>#{</span><span class='id name'>name</span><span class='rbrace'>}</span><span class='tstring_content'> doesn't exist</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
280
+ <span class='kw'>end</span></pre>
281
+ </td>
282
+ </tr>
283
+ </table>
284
+ </div>
285
+
286
+ <div class="method_details ">
287
+ <p class="signature " id="prefix-instance_method">
288
+
289
+ - (<tt>Object</tt>) <strong>prefix</strong>(prefix, defaults = nil, &amp;blk)
290
+
291
+
292
+
293
+ </p><div class="docstring">
294
+ <div class="discussion">
295
+ <p>Allows the creation of generation contexts.</p>
296
+
297
+
298
+ </div>
299
+ </div>
300
+ <div class="tags">
301
+
302
+ <div class="examples">
303
+ <h3>Examples:</h3>
304
+
305
+ <h4><div class='inline'>
306
+ </div></h4>
307
+ <pre class="example code"><span class='id renee'>renee</span><span class='period'>.</span><span class='id prefix'>prefix</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/prefix</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span>
308
+ <span class='id renee'>renee</span><span class='period'>.</span><span class='id register'>register</span><span class='lparen'>(</span><span class='symbol'>:prefix_path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/path</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'># would register /prefix/path
309
+ </span><span class='rbrace'>}</span></pre>
310
+
311
+ </div>
312
+ <h3>Parameters:</h3>
313
+ <ul class="param">
314
+
315
+ <li>
316
+
317
+ <span class='name'>prefix</span>
318
+
319
+
320
+ <span class='type'>(<tt>String</tt>)</span>
321
+
322
+
323
+
324
+ &mdash;
325
+ <div class='inline'><p>The prefix to add to subsequent calls to #register.</p>
326
+ </div>
327
+
328
+ </li>
329
+
330
+ <li>
331
+
332
+ <span class='name'>defaults</span>
333
+
334
+
335
+ <span class='type'>(<tt>Hash</tt>, <tt>nil</tt>)</span>
336
+
337
+
338
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
339
+
340
+
341
+ &mdash;
342
+ <div class='inline'><p>The defaults to add to subsequent calls to #register.</p>
343
+ </div>
344
+
345
+ </li>
346
+
347
+ </ul>
348
+
349
+
350
+ <h3>See Also:</h3>
351
+ <ul class="see">
352
+
353
+ <li><span class='object_link'><a href="#register-instance_method" title="Renee::Core::URLGeneration#register (method)">#register</a></span></li>
354
+
355
+ </ul>
356
+
357
+ </div><table class="source_code">
358
+ <tr>
359
+ <td>
360
+ <pre class="lines">
361
+
362
+
363
+ 30
364
+ 31
365
+ 32
366
+ 33
367
+ 34
368
+ 35
369
+ 36
370
+ 37
371
+ 38
372
+ 39
373
+ 40
374
+ 41
375
+ 42
376
+ 43
377
+ 44
378
+ 45</pre>
379
+ </td>
380
+ <td>
381
+ <pre class="code"><span class="info file"># File 'lib/renee/core/url_generation.rb', line 30</span>
382
+
383
+ <span class='kw'>def</span> <span class='id prefix'>prefix</span><span class='lparen'>(</span><span class='id prefix'>prefix</span><span class='comma'>,</span> <span class='id defaults'>defaults</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id blk'>blk</span><span class='rparen'>)</span>
384
+ <span class='id generator'>generator</span> <span class='op'>=</span> <span class='kw'>self</span>
385
+ <span class='id subgenerator'>subgenerator</span> <span class='op'>=</span> <span class='const'>Class</span><span class='period'>.</span><span class='id new'>new</span> <span class='lbrace'>{</span>
386
+ <span class='id include'>include</span> <span class='const'>URLGeneration</span>
387
+ <span class='id define_method'>define_method</span><span class='lparen'>(</span><span class='symbol'>:url_generators</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id generator'>generator</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='symbol'>:url_generators</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
388
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id new'>new</span>
389
+ <span class='id subgenerator'>subgenerator</span><span class='period'>.</span><span class='id instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='symbol'>:@generation_prefix</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@generation_prefix</span><span class='rbrace'>}</span><span class='embexpr_beg'>#{</span><span class='id prefix'>prefix</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
390
+ <span class='id subgenerator'>subgenerator</span><span class='period'>.</span><span class='id instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='symbol'>:@generation_defaults</span><span class='comma'>,</span> <span class='id defaults_for_generation'>defaults_for_generation</span><span class='lparen'>(</span><span class='id defaults'>defaults</span><span class='rparen'>)</span><span class='rparen'>)</span>
391
+ <span class='kw'>if</span> <span class='id block_given?'>block_given?</span>
392
+ <span class='id old_prefix'>old_prefix</span><span class='comma'>,</span> <span class='id old_defaults'>old_defaults</span> <span class='op'>=</span> <span class='ivar'>@generation_prefix</span><span class='comma'>,</span> <span class='ivar'>@generation_defaults</span>
393
+ <span class='ivar'>@generation_prefix</span><span class='comma'>,</span> <span class='ivar'>@generation_defaults</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@generation_prefix</span><span class='rbrace'>}</span><span class='embexpr_beg'>#{</span><span class='id prefix'>prefix</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id defaults_for_generation'>defaults_for_generation</span><span class='lparen'>(</span><span class='id defaults'>defaults</span><span class='rparen'>)</span>
394
+ <span class='id subgenerator'>subgenerator</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>
395
+ <span class='ivar'>@generation_prefix</span><span class='comma'>,</span> <span class='ivar'>@generation_defaults</span> <span class='op'>=</span> <span class='id old_prefix'>old_prefix</span><span class='comma'>,</span> <span class='id old_defaults'>old_defaults</span>
396
+ <span class='kw'>end</span>
397
+ <span class='id subgenerator'>subgenerator</span>
398
+ <span class='kw'>end</span></pre>
399
+ </td>
400
+ </tr>
401
+ </table>
402
+ </div>
403
+
404
+ <div class="method_details ">
405
+ <p class="signature " id="register-instance_method">
406
+
407
+ - (<tt>Object</tt>) <strong>register</strong>(name, pattern, defaults = nil)
408
+
409
+
410
+
411
+ </p><div class="docstring">
412
+ <div class="discussion">
413
+ <p>Registers new paths for generation.</p>
414
+
415
+
416
+ </div>
417
+ </div>
418
+ <div class="tags">
419
+
420
+ <div class="examples">
421
+ <h3>Examples:</h3>
422
+
423
+ <h4><div class='inline'>
424
+ </div></h4>
425
+ <pre class="example code"><span class='id renee'>renee</span><span class='period'>.</span><span class='id register'>register</span><span class='lparen'>(</span><span class='symbol'>:path</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/my/:var/path</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
426
+ <span class='id renee'>renee</span><span class='period'>.</span><span class='id path'>path</span><span class='lparen'>(</span><span class='symbol'>:path</span><span class='comma'>,</span> <span class='int'>123</span><span class='rparen'>)</span> <span class='comment'># =&gt; &quot;/my/123/path&quot;
427
+ </span><span class='id renee'>renee</span><span class='period'>.</span><span class='id path'>path</span><span class='lparen'>(</span><span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:var</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>hey you</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># =&gt; &quot;/my/hey%20you/path&quot;</span></pre>
428
+
429
+ </div>
430
+ <h3>Parameters:</h3>
431
+ <ul class="param">
432
+
433
+ <li>
434
+
435
+ <span class='name'>name</span>
436
+
437
+
438
+ <span class='type'>(<tt>Symbol</tt>)</span>
439
+
440
+
441
+
442
+ &mdash;
443
+ <div class='inline'><p>The name of the path</p>
444
+ </div>
445
+
446
+ </li>
447
+
448
+ <li>
449
+
450
+ <span class='name'>pattern</span>
451
+
452
+
453
+ <span class='type'>(<tt>String</tt>)</span>
454
+
455
+
456
+
457
+ &mdash;
458
+ <div class='inline'><p>The pattern used for generation.</p>
459
+ </div>
460
+
461
+ </li>
462
+
463
+ <li>
464
+
465
+ <span class='name'>defaults</span>
466
+
467
+
468
+ <span class='type'>(<tt>Hash</tt>, <tt>nil</tt>)</span>
469
+
470
+
471
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
472
+
473
+
474
+ &mdash;
475
+ <div class='inline'><p>Any default values used for generation.</p>
476
+ </div>
477
+
478
+ </li>
479
+
480
+ </ul>
481
+
482
+
483
+ </div><table class="source_code">
484
+ <tr>
485
+ <td>
486
+ <pre class="lines">
487
+
488
+
489
+ 17
490
+ 18
491
+ 19</pre>
492
+ </td>
493
+ <td>
494
+ <pre class="code"><span class="info file"># File 'lib/renee/core/url_generation.rb', line 17</span>
495
+
496
+ <span class='kw'>def</span> <span class='id register'>register</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id pattern'>pattern</span><span class='comma'>,</span> <span class='id defaults'>defaults</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
497
+ <span class='id url_generators'>url_generators</span><span class='lbracket'>[</span><span class='id name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Generator</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='embexpr_beg'>#{</span><span class='ivar'>@generation_prefix</span><span class='rbrace'>}</span><span class='embexpr_beg'>#{</span><span class='id pattern'>pattern</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id defaults_for_generation'>defaults_for_generation</span><span class='lparen'>(</span><span class='id defaults'>defaults</span><span class='rparen'>)</span><span class='rparen'>)</span>
498
+ <span class='kw'>end</span></pre>
499
+ </td>
500
+ </tr>
501
+ </table>
502
+ </div>
503
+
504
+ <div class="method_details ">
505
+ <p class="signature " id="url-instance_method">
506
+
507
+ - (<tt>Object</tt>) <strong>url</strong>(name, *args)
508
+
509
+
510
+
511
+ </p><div class="docstring">
512
+ <div class="discussion">
513
+ <p>Generates a url for a given name.</p>
514
+
515
+
516
+ </div>
517
+ </div>
518
+ <div class="tags">
519
+ <h3>Parameters:</h3>
520
+ <ul class="param">
521
+
522
+ <li>
523
+
524
+ <span class='name'>name</span>
525
+
526
+
527
+ <span class='type'>(<tt>Symbol</tt>)</span>
528
+
529
+
530
+
531
+ &mdash;
532
+ <div class='inline'><p>The name of the path</p>
533
+ </div>
534
+
535
+ </li>
536
+
537
+ <li>
538
+
539
+ <span class='name'>args</span>
540
+
541
+
542
+ <span class='type'>(<tt>Object</tt>)</span>
543
+
544
+
545
+
546
+ &mdash;
547
+ <div class='inline'><p>The values used to generate the path. Can be named with using :name => "value" or supplied
548
+ in the order for which the variables were decalared in #register.</p>
549
+ </div>
550
+
551
+ </li>
552
+
553
+ </ul>
554
+
555
+
556
+ <h3>See Also:</h3>
557
+ <ul class="see">
558
+
559
+ <li><span class='object_link'><a href="#path-instance_method" title="Renee::Core::URLGeneration#path (method)">#path</a></span></li>
560
+
561
+ </ul>
562
+
563
+ </div><table class="source_code">
564
+ <tr>
565
+ <td>
566
+ <pre class="lines">
567
+
568
+
569
+ 61
570
+ 62
571
+ 63
572
+ 64</pre>
573
+ </td>
574
+ <td>
575
+ <pre class="code"><span class="info file"># File 'lib/renee/core/url_generation.rb', line 61</span>
576
+
577
+ <span class='kw'>def</span> <span class='id url'>url</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id args'>args</span><span class='rparen'>)</span>
578
+ <span class='id generator'>generator</span> <span class='op'>=</span> <span class='id url_generators'>url_generators</span><span class='lbracket'>[</span><span class='id name'>name</span><span class='rbracket'>]</span>
579
+ <span class='id generator'>generator</span> <span class='op'>?</span> <span class='id generator'>generator</span><span class='period'>.</span><span class='id url'>url</span><span class='lparen'>(</span><span class='op'>*</span><span class='id args'>args</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id raise'>raise</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Generator for </span><span class='embexpr_beg'>#{</span><span class='id name'>name</span><span class='rbrace'>}</span><span class='tstring_content'> doesn't exist</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
580
+ <span class='kw'>end</span></pre>
581
+ </td>
582
+ </tr>
583
+ </table>
584
+ </div>
585
+
586
+ </div>
587
+
588
+ </div>
589
+
590
+ <div id="footer">
591
+ Generated on Thu Dec 22 09:56:47 2011 by
592
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
593
+ 0.7.3 (ruby-1.9.2).
594
+ </div>
595
+
596
+ </body>
597
+ </html>