govuk_schemas 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,420 @@
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
+ Class: GovukSchemas::Schema
8
+
9
+ &mdash; Documentation by YARD 0.8.7.6
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
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!GovukSchemas/Schema.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (S)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../GovukSchemas.html" title="GovukSchemas (module)">GovukSchemas</a></span></span>
36
+ &raquo;
37
+ <span class="title">Schema</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: GovukSchemas::Schema
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">GovukSchemas::Schema</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+ <dt class="r2 last">Defined in:</dt>
97
+ <dd class="r2 last">lib/govuk_schemas/schema.rb</dd>
98
+
99
+ </dl>
100
+ <div class="clear"></div>
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>
111
+ Class Method Summary
112
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
113
+ </h2>
114
+
115
+ <ul class="summary">
116
+
117
+ <li class="public ">
118
+ <span class="summary_signature">
119
+
120
+ <a href="#all-class_method" title="all (class method)">+ (Object) <strong>all</strong>(schema_type: &#39;*&#39;) </a>
121
+
122
+
123
+
124
+ </span>
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ <span class="summary_desc"><div class='inline'>
135
+ <p>Return all schemas in a hash, keyed by schema name.</p>
136
+ </div></span>
137
+
138
+ </li>
139
+
140
+
141
+ <li class="public ">
142
+ <span class="summary_signature">
143
+
144
+ <a href="#find-class_method" title="find (class method)">+ (Object) <strong>find</strong>(schema_name, schema_type:) </a>
145
+
146
+
147
+
148
+ </span>
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>Find a schema by name.</p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#random_schema-class_method" title="random_schema (class method)">+ (Object) <strong>random_schema</strong>(schema_type:) </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+ <span class="summary_desc"><div class='inline'>
183
+ <p>Return a random schema of a certain type.</p>
184
+ </div></span>
185
+
186
+ </li>
187
+
188
+
189
+ </ul>
190
+
191
+
192
+
193
+
194
+ <div id="class_method_details" class="method_details_list">
195
+ <h2>Class Method Details</h2>
196
+
197
+
198
+ <div class="method_details first">
199
+ <h3 class="signature first" id="all-class_method">
200
+
201
+ + (<tt>Object</tt>) <strong>all</strong>(schema_type: &#39;*&#39;)
202
+
203
+
204
+
205
+
206
+
207
+ </h3><div class="docstring">
208
+ <div class="discussion">
209
+
210
+ <p>Return all schemas in a hash, keyed by schema name</p>
211
+
212
+
213
+ </div>
214
+ </div>
215
+ <div class="tags">
216
+ <p class="tag_title">Parameters:</p>
217
+ <ul class="param">
218
+
219
+ <li>
220
+
221
+ <span class='name'>schema_type</span>
222
+
223
+
224
+ <span class='type'>(<tt>String</tt>)</span>
225
+
226
+
227
+
228
+ &mdash;
229
+ <div class='inline'>
230
+ <p>The type: frontend, publisher, notification or links</p>
231
+ </div>
232
+
233
+ </li>
234
+
235
+ </ul>
236
+
237
+
238
+ </div><table class="source_code">
239
+ <tr>
240
+ <td>
241
+ <pre class="lines">
242
+
243
+
244
+ 16
245
+ 17
246
+ 18
247
+ 19
248
+ 20
249
+ 21
250
+ 22</pre>
251
+ </td>
252
+ <td>
253
+ <pre class="code"><span class="info file"># File 'lib/govuk_schemas/schema.rb', line 16</span>
254
+
255
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span><span class='label'>schema_type:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>*</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
256
+ <span class='id identifier rubyid_schema_type'>schema_type</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>publisher_v2</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_schema_type'>schema_type</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>publisher</span><span class='tstring_end'>&quot;</span></span>
257
+ <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_glob'>glob</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>GovukSchemas</span><span class='op'>::</span><span class='const'>CONTENT_SCHEMA_DIR</span><span class='embexpr_end'>}</span><span class='tstring_content'>/dist/formats/*/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_schema_type'>schema_type</span><span class='embexpr_end'>}</span><span class='tstring_content'>/*.json</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_reduce'>reduce</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_hash'>hash</span><span class='comma'>,</span> <span class='id identifier rubyid_file_path'>file_path</span><span class='op'>|</span>
258
+ <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_file_path'>file_path</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='rparen'>)</span><span class='rparen'>)</span>
259
+ <span class='id identifier rubyid_hash'>hash</span>
260
+ <span class='kw'>end</span>
261
+ <span class='kw'>end</span></pre>
262
+ </td>
263
+ </tr>
264
+ </table>
265
+ </div>
266
+
267
+ <div class="method_details ">
268
+ <h3 class="signature " id="find-class_method">
269
+
270
+ + (<tt>Object</tt>) <strong>find</strong>(schema_name, schema_type:)
271
+
272
+
273
+
274
+
275
+
276
+ </h3><div class="docstring">
277
+ <div class="discussion">
278
+
279
+ <p>Find a schema by name</p>
280
+
281
+
282
+ </div>
283
+ </div>
284
+ <div class="tags">
285
+ <p class="tag_title">Parameters:</p>
286
+ <ul class="param">
287
+
288
+ <li>
289
+
290
+ <span class='name'>schema_name</span>
291
+
292
+
293
+ <span class='type'>(<tt>String</tt>)</span>
294
+
295
+
296
+
297
+ &mdash;
298
+ <div class='inline'>
299
+ <p>Name of the schema/format</p>
300
+ </div>
301
+
302
+ </li>
303
+
304
+ <li>
305
+
306
+ <span class='name'>schema_type</span>
307
+
308
+
309
+ <span class='type'>(<tt>String</tt>)</span>
310
+
311
+
312
+
313
+ &mdash;
314
+ <div class='inline'>
315
+ <p>The type: frontend, publisher, notification or links</p>
316
+ </div>
317
+
318
+ </li>
319
+
320
+ </ul>
321
+
322
+
323
+ </div><table class="source_code">
324
+ <tr>
325
+ <td>
326
+ <pre class="lines">
327
+
328
+
329
+ 7
330
+ 8
331
+ 9
332
+ 10
333
+ 11</pre>
334
+ </td>
335
+ <td>
336
+ <pre class="code"><span class="info file"># File 'lib/govuk_schemas/schema.rb', line 7</span>
337
+
338
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_name'>schema_name</span><span class='comma'>,</span> <span class='label'>schema_type:</span><span class='rparen'>)</span>
339
+ <span class='id identifier rubyid_schema_type'>schema_type</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>publisher_v2</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_schema_type'>schema_type</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>publisher</span><span class='tstring_end'>&quot;</span></span>
340
+ <span class='id identifier rubyid_file_path'>file_path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'>GovukSchemas</span><span class='op'>::</span><span class='const'>CONTENT_SCHEMA_DIR</span><span class='embexpr_end'>}</span><span class='tstring_content'>/dist/formats/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_schema_name'>schema_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_schema_type'>schema_type</span><span class='embexpr_end'>}</span><span class='tstring_content'>/schema.json</span><span class='tstring_end'>&quot;</span></span>
341
+ <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span><span class='rparen'>)</span><span class='rparen'>)</span>
342
+ <span class='kw'>end</span></pre>
343
+ </td>
344
+ </tr>
345
+ </table>
346
+ </div>
347
+
348
+ <div class="method_details ">
349
+ <h3 class="signature " id="random_schema-class_method">
350
+
351
+ + (<tt>Object</tt>) <strong>random_schema</strong>(schema_type:)
352
+
353
+
354
+
355
+
356
+
357
+ </h3><div class="docstring">
358
+ <div class="discussion">
359
+
360
+ <p>Return a random schema of a certain type</p>
361
+
362
+
363
+ </div>
364
+ </div>
365
+ <div class="tags">
366
+ <p class="tag_title">Parameters:</p>
367
+ <ul class="param">
368
+
369
+ <li>
370
+
371
+ <span class='name'>schema_type</span>
372
+
373
+
374
+ <span class='type'>(<tt>String</tt>)</span>
375
+
376
+
377
+
378
+ &mdash;
379
+ <div class='inline'>
380
+ <p>The type: frontend, publisher, notification or links</p>
381
+ </div>
382
+
383
+ </li>
384
+
385
+ </ul>
386
+
387
+
388
+ </div><table class="source_code">
389
+ <tr>
390
+ <td>
391
+ <pre class="lines">
392
+
393
+
394
+ 27
395
+ 28
396
+ 29</pre>
397
+ </td>
398
+ <td>
399
+ <pre class="code"><span class="info file"># File 'lib/govuk_schemas/schema.rb', line 27</span>
400
+
401
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_random_schema'>random_schema</span><span class='lparen'>(</span><span class='label'>schema_type:</span><span class='rparen'>)</span>
402
+ <span class='id identifier rubyid_all'>all</span><span class='lparen'>(</span><span class='label'>schema_type:</span> <span class='id identifier rubyid_schema_type'>schema_type</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_sample'>sample</span>
403
+ <span class='kw'>end</span></pre>
404
+ </td>
405
+ </tr>
406
+ </table>
407
+ </div>
408
+
409
+ </div>
410
+
411
+ </div>
412
+
413
+ <div id="footer">
414
+ Generated on Fri Sep 23 14:26:37 2016 by
415
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
416
+ 0.8.7.6 (ruby-2.3.1).
417
+ </div>
418
+
419
+ </body>
420
+ </html>
data/docs/_index.html ADDED
@@ -0,0 +1,140 @@
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
+ Documentation by YARD 0.8.7.6
8
+
9
+ </title>
10
+
11
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
12
+
13
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
14
+
15
+ <script type="text/javascript" charset="utf-8">
16
+ hasFrames = window.top.frames.main ? true : false;
17
+ relpath = '';
18
+ framesUrl = "frames.html#!_index.html";
19
+ </script>
20
+
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
+ <div id="header">
30
+ <div id="menu">
31
+
32
+
33
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
34
+ </div>
35
+
36
+ <div id="search">
37
+
38
+ <a class="full_list_link" id="class_list_link"
39
+ href="class_list.html">
40
+ Class List
41
+ </a>
42
+
43
+ <a class="full_list_link" id="method_list_link"
44
+ href="method_list.html">
45
+ Method List
46
+ </a>
47
+
48
+ <a class="full_list_link" id="file_list_link"
49
+ href="file_list.html">
50
+ File List
51
+ </a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1 class="noborder title">Documentation by YARD 0.8.7.6</h1>
60
+ <div id="listing">
61
+ <h1 class="alphaindex">Alphabetic Index</h1>
62
+
63
+ <h2>File Listing</h2>
64
+ <ul id="files" class="index_inline_list">
65
+
66
+
67
+ <li class="r1"><a href="index.html" title="README">README</a></li>
68
+
69
+
70
+ </ul>
71
+
72
+ <div class="clear"></div>
73
+ <h2>Namespace Listing A-Z</h2>
74
+
75
+
76
+
77
+
78
+ <table>
79
+ <tr>
80
+ <td valign='top' width="33%">
81
+
82
+
83
+ <ul id="alpha_G" class="alpha">
84
+ <li class="letter">G</li>
85
+ <ul>
86
+
87
+ <li>
88
+ <span class='object_link'><a href="GovukSchemas.html" title="GovukSchemas (module)">GovukSchemas</a></span>
89
+
90
+ </li>
91
+
92
+ </ul>
93
+ </ul>
94
+
95
+
96
+ <ul id="alpha_R" class="alpha">
97
+ <li class="letter">R</li>
98
+ <ul>
99
+
100
+ <li>
101
+ <span class='object_link'><a href="GovukSchemas/RandomExample.html" title="GovukSchemas::RandomExample (class)">RandomExample</a></span>
102
+
103
+ <small>(GovukSchemas)</small>
104
+
105
+ </li>
106
+
107
+ </ul>
108
+ </ul>
109
+
110
+
111
+ <ul id="alpha_S" class="alpha">
112
+ <li class="letter">S</li>
113
+ <ul>
114
+
115
+ <li>
116
+ <span class='object_link'><a href="GovukSchemas/Schema.html" title="GovukSchemas::Schema (class)">Schema</a></span>
117
+
118
+ <small>(GovukSchemas)</small>
119
+
120
+ </li>
121
+
122
+ </ul>
123
+ </ul>
124
+
125
+ </td>
126
+ </tr>
127
+ </table>
128
+
129
+ </div>
130
+
131
+ </div>
132
+
133
+ <div id="footer">
134
+ Generated on Fri Sep 23 14:26:37 2016 by
135
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
136
+ 0.8.7.6 (ruby-2.3.1).
137
+ </div>
138
+
139
+ </body>
140
+ </html>