govuk_schemas 2.3.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -0
  3. data/CHANGELOG.md +4 -0
  4. data/README.md +1 -10
  5. data/Rakefile +0 -5
  6. data/lib/govuk_schemas/random_example.rb +75 -74
  7. data/lib/govuk_schemas/rspec_matchers.rb +1 -0
  8. data/lib/govuk_schemas/version.rb +1 -1
  9. metadata +3 -19
  10. data/docs/GovukSchemas.html +0 -120
  11. data/docs/GovukSchemas/RandomExample.html +0 -594
  12. data/docs/GovukSchemas/Schema.html +0 -468
  13. data/docs/_index.html +0 -140
  14. data/docs/class_list.html +0 -58
  15. data/docs/css/common.css +0 -1
  16. data/docs/css/full_list.css +0 -57
  17. data/docs/css/style.css +0 -339
  18. data/docs/file.README.html +0 -134
  19. data/docs/file_list.html +0 -60
  20. data/docs/frames.html +0 -26
  21. data/docs/index.html +0 -134
  22. data/docs/js/app.js +0 -219
  23. data/docs/js/full_list.js +0 -181
  24. data/docs/js/jquery.js +0 -4
  25. data/docs/method_list.html +0 -99
  26. data/docs/top-level-namespace.html +0 -112
data/docs/GovukSchemas/Schema.html DELETED
@@ -1,468 +0,0 @@
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)">+ (Array&lt;Hash&gt;) <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)">+ (Hash) <strong>find</strong>(schema) </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)">+ (Hash) <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>Array&lt;Hash&gt;</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
- <p class="tag_title">Returns:</p>
238
- <ul class="return">
239
-
240
- <li>
241
-
242
-
243
- <span class='type'>(<tt>Array&lt;Hash&gt;</tt>)</span>
244
-
245
-
246
-
247
- &mdash;
248
- <div class='inline'>
249
- <p>List of JSON schemas as hashes</p>
250
- </div>
251
-
252
- </li>
253
-
254
- </ul>
255
-
256
- </div><table class="source_code">
257
- <tr>
258
- <td>
259
- <pre class="lines">
260
-
261
-
262
- 22
263
- 23
264
- 24
265
- 25
266
- 26
267
- 27
268
- 28</pre>
269
- </td>
270
- <td>
271
- <pre class="code"><span class="info file"># File 'lib/govuk_schemas/schema.rb', line 22</span>
272
-
273
- <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>
274
- <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>
275
- <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>
276
- <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>
277
- <span class='id identifier rubyid_hash'>hash</span>
278
- <span class='kw'>end</span>
279
- <span class='kw'>end</span></pre>
280
- </td>
281
- </tr>
282
- </table>
283
- </div>
284
-
285
- <div class="method_details ">
286
- <h3 class="signature " id="find-class_method">
287
-
288
- + (<tt>Hash</tt>) <strong>find</strong>(schema)
289
-
290
-
291
-
292
-
293
-
294
- </h3><div class="docstring">
295
- <div class="discussion">
296
-
297
- <p>Find a schema by name</p>
298
-
299
-
300
- </div>
301
- </div>
302
- <div class="tags">
303
-
304
- <div class="examples">
305
- <p class="tag_title">Examples:</p>
306
-
307
-
308
- <pre class="example code"><code>
309
- <span class='const'>GovukSchemas</span><span class='op'>::</span><span class='const'>Schema</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='label'>links_schema:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>detailed_guide</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
310
- <span class='const'>GovukSchemas</span><span class='op'>::</span><span class='const'>Schema</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='label'>frontend_schema:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>detailed_guide</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
311
- <span class='const'>GovukSchemas</span><span class='op'>::</span><span class='const'>Schema</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='label'>publisher_schema:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>detailed_guide</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
312
- <span class='const'>GovukSchemas</span><span class='op'>::</span><span class='const'>Schema</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='label'>notification_schema:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>detailed_guide</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></code></pre>
313
-
314
- </div>
315
- <p class="tag_title">Parameters:</p>
316
- <ul class="param">
317
-
318
- <li>
319
-
320
- <span class='name'>schema</span>
321
-
322
-
323
- <span class='type'>(<tt>Hash</tt>)</span>
324
-
325
-
326
-
327
- &mdash;
328
- <div class='inline'>
329
- <p>Type =&gt; Name of the schema/format:</p>
330
- </div>
331
-
332
- </li>
333
-
334
- </ul>
335
-
336
- <p class="tag_title">Returns:</p>
337
- <ul class="return">
338
-
339
- <li>
340
-
341
-
342
- <span class='type'>(<tt>Hash</tt>)</span>
343
-
344
-
345
-
346
- &mdash;
347
- <div class='inline'>
348
- <p>the JSON schema as a hash</p>
349
- </div>
350
-
351
- </li>
352
-
353
- </ul>
354
-
355
- </div><table class="source_code">
356
- <tr>
357
- <td>
358
- <pre class="lines">
359
-
360
-
361
- 13
362
- 14
363
- 15
364
- 16</pre>
365
- </td>
366
- <td>
367
- <pre class="code"><span class="info file"># File 'lib/govuk_schemas/schema.rb', line 13</span>
368
-
369
- <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'>schema</span><span class='rparen'>)</span>
370
- <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_location_for_schema_name'>location_for_schema_name</span><span class='lparen'>(</span><span class='id identifier rubyid_schema'>schema</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
371
- <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>
372
- <span class='kw'>end</span></pre>
373
- </td>
374
- </tr>
375
- </table>
376
- </div>
377
-
378
- <div class="method_details ">
379
- <h3 class="signature " id="random_schema-class_method">
380
-
381
- + (<tt>Hash</tt>) <strong>random_schema</strong>(schema_type:)
382
-
383
-
384
-
385
-
386
-
387
- </h3><div class="docstring">
388
- <div class="discussion">
389
-
390
- <p>Return a random schema of a certain type</p>
391
-
392
-
393
- </div>
394
- </div>
395
- <div class="tags">
396
- <p class="tag_title">Parameters:</p>
397
- <ul class="param">
398
-
399
- <li>
400
-
401
- <span class='name'>schema_type</span>
402
-
403
-
404
- <span class='type'>(<tt>String</tt>)</span>
405
-
406
-
407
-
408
- &mdash;
409
- <div class='inline'>
410
- <p>The type: frontend, publisher, notification or links</p>
411
- </div>
412
-
413
- </li>
414
-
415
- </ul>
416
-
417
- <p class="tag_title">Returns:</p>
418
- <ul class="return">
419
-
420
- <li>
421
-
422
-
423
- <span class='type'>(<tt>Hash</tt>)</span>
424
-
425
-
426
-
427
- &mdash;
428
- <div class='inline'>
429
- <p>a JSON schema as a hash</p>
430
- </div>
431
-
432
- </li>
433
-
434
- </ul>
435
-
436
- </div><table class="source_code">
437
- <tr>
438
- <td>
439
- <pre class="lines">
440
-
441
-
442
- 34
443
- 35
444
- 36</pre>
445
- </td>
446
- <td>
447
- <pre class="code"><span class="info file"># File 'lib/govuk_schemas/schema.rb', line 34</span>
448
-
449
- <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>
450
- <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>
451
- <span class='kw'>end</span></pre>
452
- </td>
453
- </tr>
454
- </table>
455
- </div>
456
-
457
- </div>
458
-
459
- </div>
460
-
461
- <div id="footer">
462
- Generated on Thu Nov 3 17:31:15 2016 by
463
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
464
- 0.8.7.6 (ruby-2.3.1).
465
- </div>
466
-
467
- </body>
468
- </html>