orthodox 0.3.4 → 0.3.5
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.
- checksums.yaml +4 -4
- data/.gitignore +0 -1
- data/.yardopts +7 -0
- data/README.md +4 -0
- data/docs/Authenticateable/ClassMethods.html +105 -0
- data/docs/Authenticateable.html +246 -0
- data/docs/AuthenticationGenerator.html +1335 -0
- data/docs/AuthenticationHelpers.html +194 -0
- data/docs/BaseControllerGenerator.html +247 -0
- data/docs/CoffeescriptGenerator.html +495 -0
- data/docs/ControllerGenerator.html +855 -0
- data/docs/LayoutHelperGenerator.html +397 -0
- data/docs/Orthodox/Railtie.html +124 -0
- data/docs/Orthodox.html +133 -0
- data/docs/OtpCredentialsHelper.html +298 -0
- data/docs/Otpable.html +267 -0
- data/docs/PasswordResetToken.html +324 -0
- data/docs/PasswordResetable.html +193 -0
- data/docs/SassGenerator.html +549 -0
- data/docs/TfaSession.html +476 -0
- data/docs/TwoFactorAuthentication/ClassMethods.html +222 -0
- data/docs/TwoFactorAuthentication.html +121 -0
- data/docs/_config.yml +1 -0
- data/docs/_index.html +265 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +496 -0
- data/docs/file.README.html +311 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +311 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +555 -0
- data/docs/top-level-namespace.html +112 -0
- data/lib/orthodox/version.rb +1 -1
- data/orthodox.gemspec +4 -5
- metadata +44 -24
data/docs/index.html
ADDED
|
@@ -0,0 +1,311 @@
|
|
|
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
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Orthodox
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "README";
|
|
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</a> »
|
|
40
|
+
<span class="title">File: README</span>
|
|
41
|
+
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<div id="search">
|
|
45
|
+
|
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
|
47
|
+
href="class_list.html">
|
|
48
|
+
|
|
49
|
+
<svg width="24" height="24">
|
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
</svg>
|
|
54
|
+
</a>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
<div class="clear"></div>
|
|
58
|
+
</div>
|
|
59
|
+
|
|
60
|
+
<div id="content"><div id='filecontents'><h1>Orthodox</h1>
|
|
61
|
+
|
|
62
|
+
<p>Replacement Rails generators for Katana apps.</p>
|
|
63
|
+
|
|
64
|
+
<h2>Installation</h2>
|
|
65
|
+
|
|
66
|
+
<p>Add this line to your application's Gemfile:</p>
|
|
67
|
+
|
|
68
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>orthodox</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>github:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>katanacode/orthodox</span><span class='tstring_end'>"</span></span>
|
|
69
|
+
</code></pre>
|
|
70
|
+
|
|
71
|
+
<p>And then execute:</p>
|
|
72
|
+
|
|
73
|
+
<pre class="code ruby"><code class="ruby">$ bundle
|
|
74
|
+
</code></pre>
|
|
75
|
+
|
|
76
|
+
<p>Or install it yourself as:</p>
|
|
77
|
+
|
|
78
|
+
<pre class="code ruby"><code class="ruby">$ gem install orthodox
|
|
79
|
+
</code></pre>
|
|
80
|
+
|
|
81
|
+
<h2>Usage</h2>
|
|
82
|
+
|
|
83
|
+
<h3>A Coffeescript file:</h3>
|
|
84
|
+
|
|
85
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_rails'>rails</span> <span class='id identifier rubyid_g'>g</span> <span class='id identifier rubyid_coffeescript'>coffeescript</span> <span class='id identifier rubyid_users'>users</span>
|
|
86
|
+
</code></pre>
|
|
87
|
+
|
|
88
|
+
<p>Creates</p>
|
|
89
|
+
|
|
90
|
+
<pre class="code ruby"><code class="ruby">window.users = do ->
|
|
91
|
+
|
|
92
|
+
init = ->
|
|
93
|
+
|
|
94
|
+
return { init }
|
|
95
|
+
</code></pre>
|
|
96
|
+
|
|
97
|
+
<h3>A Coffeescript file with functions:</h3>
|
|
98
|
+
|
|
99
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_rails'>rails</span> <span class='id identifier rubyid_g'>g</span> <span class='id identifier rubyid_coffeescript'>coffeescript</span> <span class='id identifier rubyid_users'>users</span> <span class='id identifier rubyid_show_all'>show_all</span>
|
|
100
|
+
</code></pre>
|
|
101
|
+
|
|
102
|
+
<p>Creates</p>
|
|
103
|
+
|
|
104
|
+
<pre class="code ruby"><code class="ruby">window.users = do ->
|
|
105
|
+
|
|
106
|
+
init = ->
|
|
107
|
+
|
|
108
|
+
showAll = ->
|
|
109
|
+
|
|
110
|
+
return { init }
|
|
111
|
+
</code></pre>
|
|
112
|
+
|
|
113
|
+
<h3>A Sass file:</h3>
|
|
114
|
+
|
|
115
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_rails'>rails</span> <span class='id identifier rubyid_g'>g</span> <span class='id identifier rubyid_sass'>sass</span> <span class='id identifier rubyid_users'>users</span>
|
|
116
|
+
</code></pre>
|
|
117
|
+
|
|
118
|
+
<p>Creates</p>
|
|
119
|
+
|
|
120
|
+
<pre class="code ruby"><code class="ruby">.user
|
|
121
|
+
// Define sass here
|
|
122
|
+
</code></pre>
|
|
123
|
+
|
|
124
|
+
<h3>A Sass file with BEM elements:</h3>
|
|
125
|
+
|
|
126
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_rails'>rails</span> <span class='id identifier rubyid_g'>g</span> <span class='id identifier rubyid_sass'>sass</span> <span class='id identifier rubyid_users'>users</span> <span class='id identifier rubyid_name'>name</span> <span class='id identifier rubyid_avatar'>avatar</span>
|
|
127
|
+
</code></pre>
|
|
128
|
+
|
|
129
|
+
<p>Creates</p>
|
|
130
|
+
|
|
131
|
+
<pre class="code ruby"><code class="ruby">.user
|
|
132
|
+
// Define sass here
|
|
133
|
+
|
|
134
|
+
.user-name
|
|
135
|
+
// Define sass here
|
|
136
|
+
|
|
137
|
+
.user-avatar
|
|
138
|
+
// Define sass here
|
|
139
|
+
</code></pre>
|
|
140
|
+
|
|
141
|
+
<h3>An empty controller:</h3>
|
|
142
|
+
|
|
143
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_rails'>rails</span> <span class='id identifier rubyid_g'>g</span> <span class='id identifier rubyid_controller'>controller</span> <span class='id identifier rubyid_users'>users</span>
|
|
144
|
+
</code></pre>
|
|
145
|
+
|
|
146
|
+
<p>Creates:</p>
|
|
147
|
+
|
|
148
|
+
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Users</span> <span class='op'><</span> <span class='const'>ApplicationController</span>
|
|
149
|
+
|
|
150
|
+
<span class='kw'>end</span>
|
|
151
|
+
</code></pre>
|
|
152
|
+
|
|
153
|
+
<h3>A controller with prepopulated actions:</h3>
|
|
154
|
+
|
|
155
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_rails'>rails</span> <span class='id identifier rubyid_g'>g</span> <span class='id identifier rubyid_controller'>controller</span> <span class='id identifier rubyid_users'>users</span> <span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_create'>create</span> <span class='id identifier rubyid_show'>show</span>
|
|
156
|
+
</code></pre>
|
|
157
|
+
|
|
158
|
+
<p>Creates:</p>
|
|
159
|
+
|
|
160
|
+
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Users</span> <span class='op'><</span> <span class='const'>ApplicationController</span>
|
|
161
|
+
|
|
162
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_new'>new</span>
|
|
163
|
+
<span class='ivar'>@user</span> <span class='op'>=</span> <span class='id identifier rubyid_users_scope'>users_scope</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
164
|
+
<span class='kw'>end</span>
|
|
165
|
+
|
|
166
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span>
|
|
167
|
+
<span class='ivar'>@user</span> <span class='op'>=</span> <span class='id identifier rubyid_users_scope'>users_scope</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_user_params'>user_params</span><span class='rparen'>)</span>
|
|
168
|
+
<span class='kw'>if</span> <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
|
|
169
|
+
<span class='id identifier rubyid_redirect_to'>redirect_to</span><span class='lparen'>(</span><span class='id identifier rubyid_user_url'>user_url</span><span class='lparen'>(</span><span class='ivar'>@user</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>notice:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Successfully created user</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
170
|
+
<span class='kw'>else</span>
|
|
171
|
+
<span class='id identifier rubyid_render'>render</span> <span class='symbol'>:new</span>
|
|
172
|
+
<span class='kw'>end</span>
|
|
173
|
+
<span class='kw'>end</span>
|
|
174
|
+
|
|
175
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_show'>show</span>
|
|
176
|
+
<span class='ivar'>@user</span> <span class='op'>=</span> <span class='id identifier rubyid_users_scope'>users_scope</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
177
|
+
<span class='kw'>end</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
<span class='id identifier rubyid_private'>private</span>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_users_scope'>users_scope</span>
|
|
184
|
+
<span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
|
|
185
|
+
<span class='kw'>end</span>
|
|
186
|
+
|
|
187
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_user_params'>user_params</span>
|
|
188
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_require'>require</span><span class='lparen'>(</span><span class='symbol'>:user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_permit'>permit</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
189
|
+
<span class='kw'>end</span>
|
|
190
|
+
|
|
191
|
+
<span class='kw'>end</span>
|
|
192
|
+
</code></pre>
|
|
193
|
+
|
|
194
|
+
<h3>A controller with actions and authentication:</h3>
|
|
195
|
+
|
|
196
|
+
<pre class="code ruby"><code class="ruby">rails g controller users new create show --authenticate admin
|
|
197
|
+
</code></pre>
|
|
198
|
+
|
|
199
|
+
<p>Creates:</p>
|
|
200
|
+
|
|
201
|
+
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Users</span> <span class='op'><</span> <span class='const'>ApplicationController</span>
|
|
202
|
+
|
|
203
|
+
<span class='id identifier rubyid_before_action'>before_action</span> <span class='symbol'>:authenticate_admin!</span>
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_new'>new</span>
|
|
207
|
+
<span class='ivar'>@user</span> <span class='op'>=</span> <span class='id identifier rubyid_users_scope'>users_scope</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
208
|
+
<span class='kw'>end</span>
|
|
209
|
+
|
|
210
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span>
|
|
211
|
+
<span class='ivar'>@user</span> <span class='op'>=</span> <span class='id identifier rubyid_users_scope'>users_scope</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_user_params'>user_params</span><span class='rparen'>)</span>
|
|
212
|
+
<span class='kw'>if</span> <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
|
|
213
|
+
<span class='id identifier rubyid_redirect_to'>redirect_to</span><span class='lparen'>(</span><span class='id identifier rubyid_user_url'>user_url</span><span class='lparen'>(</span><span class='ivar'>@user</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>notice:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Successfully created user</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
214
|
+
<span class='kw'>else</span>
|
|
215
|
+
<span class='id identifier rubyid_render'>render</span> <span class='symbol'>:new</span>
|
|
216
|
+
<span class='kw'>end</span>
|
|
217
|
+
<span class='kw'>end</span>
|
|
218
|
+
|
|
219
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_show'>show</span>
|
|
220
|
+
<span class='ivar'>@user</span> <span class='op'>=</span> <span class='id identifier rubyid_users_scope'>users_scope</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
221
|
+
<span class='kw'>end</span>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<span class='id identifier rubyid_private'>private</span>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_users_scope'>users_scope</span>
|
|
230
|
+
<span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
|
|
231
|
+
<span class='kw'>end</span>
|
|
232
|
+
|
|
233
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_user_params'>user_params</span>
|
|
234
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_require'>require</span><span class='lparen'>(</span><span class='symbol'>:user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_permit'>permit</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
235
|
+
<span class='kw'>end</span>
|
|
236
|
+
|
|
237
|
+
<span class='kw'>end</span>
|
|
238
|
+
</code></pre>
|
|
239
|
+
|
|
240
|
+
<h3>A controller with a namespace:</h3>
|
|
241
|
+
|
|
242
|
+
<pre class="code ruby"><code class="ruby">rails g controller admins/users new create show --authenticate admin
|
|
243
|
+
</code></pre>
|
|
244
|
+
|
|
245
|
+
<p>Creates:</p>
|
|
246
|
+
|
|
247
|
+
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Admins</span><span class='op'>::</span><span class='const'>Users</span> <span class='op'><</span> <span class='const'>Admins</span><span class='op'>::</span><span class='const'>BaseControler</span>
|
|
248
|
+
|
|
249
|
+
<span class='id identifier rubyid_before_action'>before_action</span> <span class='symbol'>:authenticate_admin!</span>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_new'>new</span>
|
|
253
|
+
<span class='ivar'>@user</span> <span class='op'>=</span> <span class='id identifier rubyid_users_scope'>users_scope</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
254
|
+
<span class='kw'>end</span>
|
|
255
|
+
|
|
256
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span>
|
|
257
|
+
<span class='ivar'>@user</span> <span class='op'>=</span> <span class='id identifier rubyid_users_scope'>users_scope</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_user_params'>user_params</span><span class='rparen'>)</span>
|
|
258
|
+
<span class='kw'>if</span> <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
|
|
259
|
+
<span class='id identifier rubyid_redirect_to'>redirect_to</span><span class='lparen'>(</span><span class='id identifier rubyid_user_url'>user_url</span><span class='lparen'>(</span><span class='ivar'>@user</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>notice:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Successfully created user</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
260
|
+
<span class='kw'>else</span>
|
|
261
|
+
<span class='id identifier rubyid_render'>render</span> <span class='symbol'>:new</span>
|
|
262
|
+
<span class='kw'>end</span>
|
|
263
|
+
<span class='kw'>end</span>
|
|
264
|
+
|
|
265
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_show'>show</span>
|
|
266
|
+
<span class='ivar'>@user</span> <span class='op'>=</span> <span class='id identifier rubyid_users_scope'>users_scope</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
267
|
+
<span class='kw'>end</span>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
<span class='id identifier rubyid_private'>private</span>
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_users_scope'>users_scope</span>
|
|
274
|
+
<span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
|
|
275
|
+
<span class='kw'>end</span>
|
|
276
|
+
|
|
277
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_user_params'>user_params</span>
|
|
278
|
+
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_require'>require</span><span class='lparen'>(</span><span class='symbol'>:user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_permit'>permit</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
279
|
+
<span class='kw'>end</span>
|
|
280
|
+
|
|
281
|
+
<span class='kw'>end</span>
|
|
282
|
+
</code></pre>
|
|
283
|
+
|
|
284
|
+
<h2>Development</h2>
|
|
285
|
+
|
|
286
|
+
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
|
|
287
|
+
|
|
288
|
+
<p>To install this gem onto your local machine, run <code>bundle exec rake install</code>. To release a new version, update the version number in <code>version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
|
|
289
|
+
|
|
290
|
+
<h2>Contributing</h2>
|
|
291
|
+
|
|
292
|
+
<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/KatanaCode/orthodox">https://github.com/KatanaCode/orthodox</a>.</p>
|
|
293
|
+
|
|
294
|
+
<h2>License</h2>
|
|
295
|
+
|
|
296
|
+
<p>The gem is available as open source under the terms of the <a href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
297
|
+
|
|
298
|
+
<h2>About Katana</h2>
|
|
299
|
+
|
|
300
|
+
<p>Katana are <a href="http://katanacode.com/" title="Katana Code">web and mobile app developers in Edinburgh, Scotland</a>.</p>
|
|
301
|
+
</div></div>
|
|
302
|
+
|
|
303
|
+
<div id="footer">
|
|
304
|
+
Generated on Thu Aug 13 16:36:42 2020 by
|
|
305
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
306
|
+
0.9.24 (ruby-2.6.6).
|
|
307
|
+
</div>
|
|
308
|
+
|
|
309
|
+
</div>
|
|
310
|
+
</body>
|
|
311
|
+
</html>
|
data/docs/js/app.js
ADDED
|
@@ -0,0 +1,314 @@
|
|
|
1
|
+
(function() {
|
|
2
|
+
|
|
3
|
+
var localStorage = {}, sessionStorage = {};
|
|
4
|
+
try { localStorage = window.localStorage; } catch (e) { }
|
|
5
|
+
try { sessionStorage = window.sessionStorage; } catch (e) { }
|
|
6
|
+
|
|
7
|
+
function createSourceLinks() {
|
|
8
|
+
$('.method_details_list .source_code').
|
|
9
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
|
10
|
+
$('.toggleSource').toggle(function() {
|
|
11
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
|
12
|
+
$(this).text("Hide source");
|
|
13
|
+
},
|
|
14
|
+
function() {
|
|
15
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
|
16
|
+
$(this).text("View source");
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
function createDefineLinks() {
|
|
21
|
+
var tHeight = 0;
|
|
22
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
|
23
|
+
$('.toggleDefines').toggle(function() {
|
|
24
|
+
tHeight = $(this).parent().prev().height();
|
|
25
|
+
$(this).prev().css('display', 'inline');
|
|
26
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
27
|
+
$(this).text("(less)");
|
|
28
|
+
},
|
|
29
|
+
function() {
|
|
30
|
+
$(this).prev().hide();
|
|
31
|
+
$(this).parent().prev().height(tHeight);
|
|
32
|
+
$(this).text("more...");
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function createFullTreeLinks() {
|
|
37
|
+
var tHeight = 0;
|
|
38
|
+
$('.inheritanceTree').toggle(function() {
|
|
39
|
+
tHeight = $(this).parent().prev().height();
|
|
40
|
+
$(this).parent().toggleClass('showAll');
|
|
41
|
+
$(this).text("(hide)");
|
|
42
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
43
|
+
},
|
|
44
|
+
function() {
|
|
45
|
+
$(this).parent().toggleClass('showAll');
|
|
46
|
+
$(this).parent().prev().height(tHeight);
|
|
47
|
+
$(this).text("show all");
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
function searchFrameButtons() {
|
|
52
|
+
$('.full_list_link').click(function() {
|
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
|
54
|
+
return false;
|
|
55
|
+
});
|
|
56
|
+
window.addEventListener('message', function(e) {
|
|
57
|
+
if (e.data === 'navEscape') {
|
|
58
|
+
$('#nav').slideUp(100);
|
|
59
|
+
$('#search a').removeClass('active inactive');
|
|
60
|
+
$(window).focus();
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
$(window).resize(function() {
|
|
65
|
+
if ($('#search:visible').length === 0) {
|
|
66
|
+
$('#nav').removeAttr('style');
|
|
67
|
+
$('#search a').removeClass('active inactive');
|
|
68
|
+
$(window).focus();
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
function toggleSearchFrame(id, link) {
|
|
74
|
+
var frame = $('#nav');
|
|
75
|
+
$('#search a').removeClass('active').addClass('inactive');
|
|
76
|
+
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
|
77
|
+
frame.slideUp(100);
|
|
78
|
+
$('#search a').removeClass('active inactive');
|
|
79
|
+
}
|
|
80
|
+
else {
|
|
81
|
+
$(id).addClass('active').removeClass('inactive');
|
|
82
|
+
if (frame.attr('src') !== link) frame.attr('src', link);
|
|
83
|
+
frame.slideDown(100);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
function linkSummaries() {
|
|
88
|
+
$('.summary_signature').click(function() {
|
|
89
|
+
document.location = $(this).find('a').attr('href');
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
function summaryToggle() {
|
|
94
|
+
$('.summary_toggle').click(function(e) {
|
|
95
|
+
e.preventDefault();
|
|
96
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
97
|
+
$('.summary_toggle').each(function() {
|
|
98
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
99
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
100
|
+
if (next.hasClass('compact')) {
|
|
101
|
+
next.toggle();
|
|
102
|
+
next.nextAll('ul.summary').first().toggle();
|
|
103
|
+
}
|
|
104
|
+
else if (next.hasClass('summary')) {
|
|
105
|
+
var list = $('<ul class="summary compact" />');
|
|
106
|
+
list.html(next.html());
|
|
107
|
+
list.find('.summary_desc, .note').remove();
|
|
108
|
+
list.find('a').each(function() {
|
|
109
|
+
$(this).html($(this).find('strong').html());
|
|
110
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
111
|
+
});
|
|
112
|
+
next.before(list);
|
|
113
|
+
next.toggle();
|
|
114
|
+
}
|
|
115
|
+
});
|
|
116
|
+
return false;
|
|
117
|
+
});
|
|
118
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
119
|
+
$('.summary_toggle').first().click();
|
|
120
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
function constantSummaryToggle() {
|
|
124
|
+
$('.constants_summary_toggle').click(function(e) {
|
|
125
|
+
e.preventDefault();
|
|
126
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
127
|
+
$('.constants_summary_toggle').each(function() {
|
|
128
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
129
|
+
var next = $(this).parent().parent().nextAll('dl.constants').first();
|
|
130
|
+
if (next.hasClass('compact')) {
|
|
131
|
+
next.toggle();
|
|
132
|
+
next.nextAll('dl.constants').first().toggle();
|
|
133
|
+
}
|
|
134
|
+
else if (next.hasClass('constants')) {
|
|
135
|
+
var list = $('<dl class="constants compact" />');
|
|
136
|
+
list.html(next.html());
|
|
137
|
+
list.find('dt').each(function() {
|
|
138
|
+
$(this).addClass('summary_signature');
|
|
139
|
+
$(this).text( $(this).text().split('=')[0]);
|
|
140
|
+
if ($(this).has(".deprecated").length) {
|
|
141
|
+
$(this).addClass('deprecated');
|
|
142
|
+
};
|
|
143
|
+
});
|
|
144
|
+
// Add the value of the constant as "Tooltip" to the summary object
|
|
145
|
+
list.find('pre.code').each(function() {
|
|
146
|
+
console.log($(this).parent());
|
|
147
|
+
var dt_element = $(this).parent().prev();
|
|
148
|
+
var tooltip = $(this).text();
|
|
149
|
+
if (dt_element.hasClass("deprecated")) {
|
|
150
|
+
tooltip = 'Deprecated. ' + tooltip;
|
|
151
|
+
};
|
|
152
|
+
dt_element.attr('title', tooltip);
|
|
153
|
+
});
|
|
154
|
+
list.find('.docstring, .tags, dd').remove();
|
|
155
|
+
next.before(list);
|
|
156
|
+
next.toggle();
|
|
157
|
+
}
|
|
158
|
+
});
|
|
159
|
+
return false;
|
|
160
|
+
});
|
|
161
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
162
|
+
$('.constants_summary_toggle').first().click();
|
|
163
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
function generateTOC() {
|
|
167
|
+
if ($('#filecontents').length === 0) return;
|
|
168
|
+
var _toc = $('<ol class="top"></ol>');
|
|
169
|
+
var show = false;
|
|
170
|
+
var toc = _toc;
|
|
171
|
+
var counter = 0;
|
|
172
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
173
|
+
var i;
|
|
174
|
+
var curli;
|
|
175
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
176
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
177
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
178
|
+
$(tags.join(', ')).each(function() {
|
|
179
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
|
180
|
+
if (this.id == "filecontents") return;
|
|
181
|
+
show = true;
|
|
182
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
183
|
+
if (this.id.length === 0) {
|
|
184
|
+
var proposedId = $(this).attr('toc-id');
|
|
185
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
|
186
|
+
else {
|
|
187
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
188
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
189
|
+
this.id = proposedId;
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
if (thisTag > lastTag) {
|
|
193
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
194
|
+
if ( typeof(curli) == "undefined" ) {
|
|
195
|
+
curli = $('<li/>');
|
|
196
|
+
toc.append(curli);
|
|
197
|
+
}
|
|
198
|
+
toc = $('<ol/>');
|
|
199
|
+
curli.append(toc);
|
|
200
|
+
curli = undefined;
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
if (thisTag < lastTag) {
|
|
204
|
+
for (i = 0; i < lastTag - thisTag; i++) {
|
|
205
|
+
toc = toc.parent();
|
|
206
|
+
toc = toc.parent();
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
var title = $(this).attr('toc-title');
|
|
210
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
|
211
|
+
curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
|
212
|
+
toc.append(curli);
|
|
213
|
+
lastTag = thisTag;
|
|
214
|
+
});
|
|
215
|
+
if (!show) return;
|
|
216
|
+
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
|
217
|
+
$('#content').prepend(html);
|
|
218
|
+
$('#toc').append(_toc);
|
|
219
|
+
$('#toc .hide_toc').toggle(function() {
|
|
220
|
+
$('#toc .top').slideUp('fast');
|
|
221
|
+
$('#toc').toggleClass('hidden');
|
|
222
|
+
$('#toc .title small').toggle();
|
|
223
|
+
}, function() {
|
|
224
|
+
$('#toc .top').slideDown('fast');
|
|
225
|
+
$('#toc').toggleClass('hidden');
|
|
226
|
+
$('#toc .title small').toggle();
|
|
227
|
+
});
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
function navResizeFn(e) {
|
|
231
|
+
if (e.which !== 1) {
|
|
232
|
+
navResizeFnStop();
|
|
233
|
+
return;
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
sessionStorage.navWidth = e.pageX.toString();
|
|
237
|
+
$('.nav_wrap').css('width', e.pageX);
|
|
238
|
+
$('.nav_wrap').css('-ms-flex', 'inherit');
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
function navResizeFnStop() {
|
|
242
|
+
$(window).unbind('mousemove', navResizeFn);
|
|
243
|
+
window.removeEventListener('message', navMessageFn, false);
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
function navMessageFn(e) {
|
|
247
|
+
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
|
248
|
+
if (e.data.action === 'mouseup') navResizeFnStop();
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
function navResizer() {
|
|
252
|
+
$('#resizer').mousedown(function(e) {
|
|
253
|
+
e.preventDefault();
|
|
254
|
+
$(window).mousemove(navResizeFn);
|
|
255
|
+
window.addEventListener('message', navMessageFn, false);
|
|
256
|
+
});
|
|
257
|
+
$(window).mouseup(navResizeFnStop);
|
|
258
|
+
|
|
259
|
+
if (sessionStorage.navWidth) {
|
|
260
|
+
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
function navExpander() {
|
|
265
|
+
var done = false, timer = setTimeout(postMessage, 500);
|
|
266
|
+
function postMessage() {
|
|
267
|
+
if (done) return;
|
|
268
|
+
clearTimeout(timer);
|
|
269
|
+
var opts = { action: 'expand', path: pathId };
|
|
270
|
+
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
|
271
|
+
done = true;
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
window.addEventListener('message', function(event) {
|
|
275
|
+
if (event.data === 'navReady') postMessage();
|
|
276
|
+
return false;
|
|
277
|
+
}, false);
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
function mainFocus() {
|
|
281
|
+
var hash = window.location.hash;
|
|
282
|
+
if (hash !== '' && $(hash)[0]) {
|
|
283
|
+
$(hash)[0].scrollIntoView();
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
setTimeout(function() { $('#main').focus(); }, 10);
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
function navigationChange() {
|
|
290
|
+
// This works around the broken anchor navigation with the YARD template.
|
|
291
|
+
window.onpopstate = function() {
|
|
292
|
+
var hash = window.location.hash;
|
|
293
|
+
if (hash !== '' && $(hash)[0]) {
|
|
294
|
+
$(hash)[0].scrollIntoView();
|
|
295
|
+
}
|
|
296
|
+
};
|
|
297
|
+
}
|
|
298
|
+
|
|
299
|
+
$(document).ready(function() {
|
|
300
|
+
navResizer();
|
|
301
|
+
navExpander();
|
|
302
|
+
createSourceLinks();
|
|
303
|
+
createDefineLinks();
|
|
304
|
+
createFullTreeLinks();
|
|
305
|
+
searchFrameButtons();
|
|
306
|
+
linkSummaries();
|
|
307
|
+
summaryToggle();
|
|
308
|
+
constantSummaryToggle();
|
|
309
|
+
generateTOC();
|
|
310
|
+
mainFocus();
|
|
311
|
+
navigationChange();
|
|
312
|
+
});
|
|
313
|
+
|
|
314
|
+
})();
|