govuk_schemas 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f0717cb5ebb1dc03c12f035a91dcf2f45558e27
-  data.tar.gz: 6ed611cdea54b588141d7c031aaed8e568c46a2a
+  metadata.gz: 5b6cda522703d0896cf14a762388caa66fbca5c0
+  data.tar.gz: ca5ca470c2662ba182b283584c58ede459465720
 SHA512:
-  metadata.gz: 0280cc2e9eaaa76c79442c1ad3fa8bf33cac8c13f4028c8cada49b53f4d2b81a12330be014c5720994e343a45c9658a646cf13e67884b1b0b1b1d6b6f8a12a15
-  data.tar.gz: feb12a918c28c94a0c1f7ac88a12371be71d8ce4784a0eabd382498cbecc7d1f5ba8709c721cd6280d788f177e83b96e440c88c1114429a1cd954d2166c6e246
+  metadata.gz: 761d1a395fcd5c9051f162d68398d9ff88861493cf0947eb50292d333561ca591d37261b7668c52403c7bce3cc8b4b346f659285350291753a41f1a5d01560a0
+  data.tar.gz: 8a11fcaed55550bec45183185789c09a0394db87d2ab9b6656b2b84c29b20c3044002487043ec20aca08af479d7012694a1a3aa89a5f3ad049fc924a2e9f4916

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.0.0
+
+* Change GovukSchemas::Schema.find to take { links_schema: 'detailded_guide' }
+* Add regex for lowercase-underscore strings
+
 # 1.0.0
 
 * Add regex for GOV.UK campaign URLs

data/README.md

@@ -10,6 +10,11 @@ In your Gemfile:
 gem "govuk_schemas", "~> VERSION"
 ```
 
+## Limitations
+
+- The gem doesn't support `patternProperties` yet. On GOV.UK we [use this in the expanded frontend links](https://github.com/alphagov/govuk-content-schemas/blob/bdd97d18c7a9318e66f332f0748a410fddab1141/formats/frontend_links_definition.json#L67-L71).
+- It's complicated to generate random data for `oneOf` properties. According to the JSON Schema spec a `oneOf` schema is only valid if the data is valid against *only one* of the clauses. To do this properly, we'd have to make sure that the data generated below doesn't validate against the other schemas properties.
+
 ## Usage
 
 [Read the documentation!](https://alphagov.github.io/govuk_schemas_gem/frames.html)

data/docs/GovukSchemas/RandomExample.html

@@ -117,7 +117,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#for_schema-class_method" title="for_schema (class method)">+ (GovukSchemas::RandomExample) <strong>for_schema</strong>(schema_name, schema_type:) </a>
+      <a href="#for_schema-class_method" title="for_schema (class method)">+ (GovukSchemas::RandomExample) <strong>for_schema</strong>(schema_key_value) </a>
     
 
     
@@ -306,7 +306,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="for_schema-class_method">
   
-    + (<tt><span class='object_link'><a href="" title="GovukSchemas::RandomExample (class)">GovukSchemas::RandomExample</a></span></tt>) <strong>for_schema</strong>(schema_name, schema_type:) 
+    + (<tt><span class='object_link'><a href="" title="GovukSchemas::RandomExample (class)">GovukSchemas::RandomExample</a></span></tt>) <strong>for_schema</strong>(schema_key_value) 
   
 
   
@@ -319,7 +319,7 @@
 
 <p>For example:</p>
 
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_generator'>generator</span> <span class='op'>=</span> <span class='const'>GovukSchemas</span><span class='op'>::</span><span class='const'>RandomExample</span><span class='period'>.</span><span class='id identifier rubyid_for_schema'>for_schema</span><span class='lparen'>(</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='comma'>,</span> <span class='label'>schema_type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>frontend</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_generator'>generator</span> <span class='op'>=</span> <span class='const'>GovukSchemas</span><span class='op'>::</span><span class='const'>RandomExample</span><span class='period'>.</span><span class='id identifier rubyid_for_schema'>for_schema</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>
 <span class='id identifier rubyid_generator'>generator</span><span class='period'>.</span><span class='id identifier rubyid_payload'>payload</span>
 <span class='comment'># =&gt; {&quot;base_path&quot;=&gt;&quot;/e42dd28e&quot;, &quot;title&quot;=&gt;&quot;dolor est...&quot;, &quot;publishing_app&quot;=&gt;&quot;elit&quot;...}
 </span></code></pre>
@@ -328,7 +328,22 @@
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>schema_key_value</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+    </li>
   
+</ul>
+
 <p class="tag_title">Returns:</p>
 <ul class="return">
   
@@ -349,16 +364,16 @@
       <pre class="lines">
 
 
-31
 32
 33
-34</pre>
+34
+35</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/govuk_schemas/random_example.rb', line 31</span>
+      <pre class="code"><span class="info file"># File 'lib/govuk_schemas/random_example.rb', line 32</span>
 
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_for_schema'>for_schema</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>
-  <span class='id identifier rubyid_schema'>schema</span> <span class='op'>=</span> <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='id identifier rubyid_schema_name'>schema_name</span><span class='comma'>,</span> <span class='label'>schema_type:</span> <span class='id identifier rubyid_schema_type'>schema_type</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_for_schema'>for_schema</span><span class='lparen'>(</span><span class='id identifier rubyid_schema_key_value'>schema_key_value</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_schema'>schema</span> <span class='op'>=</span> <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='id identifier rubyid_schema_key_value'>schema_key_value</span><span class='rparen'>)</span>
   <span class='const'>GovukSchemas</span><span class='op'>::</span><span class='const'>RandomExample</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>schema:</span> <span class='id identifier rubyid_schema'>schema</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -457,7 +472,6 @@ isn&#39;t valid against the schema an error will be raised.</p>
       <pre class="lines">
 
 
-67
 68
 69
 70
@@ -466,17 +480,18 @@ isn&#39;t valid against the schema an error will be raised.</p>
 73
 74
 75
-76</pre>
+76
+77</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/govuk_schemas/random_example.rb', line 67</span>
+      <pre class="code"><span class="info file"># File 'lib/govuk_schemas/random_example.rb', line 68</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_merge_and_validate'>merge_and_validate</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='id identifier rubyid_payload'>payload</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_stringify_keys'>stringify_keys</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_errors'>errors</span> <span class='op'>=</span> <span class='id identifier rubyid_validation_errors_for'>validation_errors_for</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span>
 
   <span class='kw'>if</span> <span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span>
-    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>InvalidContentGenerated</span><span class='comma'>,</span> <span class='id identifier rubyid_error_message_custom'>error_message_custom</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid_errors'>errors</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_raise'>raise</span> <span class='const'>InvalidContentGenerated</span><span class='comma'>,</span> <span class='id identifier rubyid_error_message_custom'>error_message_custom</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='comma'>,</span> <span class='id identifier rubyid_hash'>hash</span><span class='comma'>,</span> <span class='id identifier rubyid_errors'>errors</span><span class='rparen'>)</span>
   <span class='kw'>end</span>
 
   <span class='id identifier rubyid_item'>item</span>
@@ -536,7 +551,6 @@ isn&#39;t valid against the schema an error will be raised.</p>
       <pre class="lines">
 
 
-44
 45
 46
 47
@@ -545,10 +559,11 @@ isn&#39;t valid against the schema an error will be raised.</p>
 50
 51
 52
-53</pre>
+53
+54</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/govuk_schemas/random_example.rb', line 44</span>
+      <pre class="code"><span class="info file"># File 'lib/govuk_schemas/random_example.rb', line 45</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_payload'>payload</span>
   <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='ivar'>@random_generator</span><span class='period'>.</span><span class='id identifier rubyid_payload'>payload</span>
@@ -570,7 +585,7 @@ isn&#39;t valid against the schema an error will be raised.</p>
 </div>
 
     <div id="footer">
-  Generated on Fri Sep 23 14:26:38 2016 by
+  Generated on Thu Nov  3 17:31:15 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/docs/GovukSchemas/Schema.html

@@ -117,7 +117,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#all-class_method" title="all (class method)">+ (Object) <strong>all</strong>(schema_type: &#39;*&#39;) </a>
+      <a href="#all-class_method" title="all (class method)">+ (Array&lt;Hash&gt;) <strong>all</strong>(schema_type: &#39;*&#39;) </a>
     
 
     
@@ -141,7 +141,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#find-class_method" title="find (class method)">+ (Object) <strong>find</strong>(schema_name, schema_type:) </a>
+      <a href="#find-class_method" title="find (class method)">+ (Hash) <strong>find</strong>(schema) </a>
     
 
     
@@ -165,7 +165,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#random_schema-class_method" title="random_schema (class method)">+ (Object) <strong>random_schema</strong>(schema_type:) </a>
+      <a href="#random_schema-class_method" title="random_schema (class method)">+ (Hash) <strong>random_schema</strong>(schema_type:) </a>
     
 
     
@@ -198,7 +198,7 @@
       <div class="method_details first">
   <h3 class="signature first" id="all-class_method">
   
-    + (<tt>Object</tt>) <strong>all</strong>(schema_type: &#39;*&#39;) 
+    + (<tt>Array&lt;Hash&gt;</tt>) <strong>all</strong>(schema_type: &#39;*&#39;) 
   
 
   
@@ -234,6 +234,24 @@
   
 </ul>
 
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array&lt;Hash&gt;</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>List of JSON schemas as hashes</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -241,16 +259,16 @@
       <pre class="lines">
 
 
-16
-17
-18
-19
-20
-21
-22</pre>
+22
+23
+24
+25
+26
+27
+28</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/govuk_schemas/schema.rb', line 16</span>
+      <pre class="code"><span class="info file"># File 'lib/govuk_schemas/schema.rb', line 22</span>
 
 <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>
   <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>
@@ -267,7 +285,7 @@
       <div class="method_details ">
   <h3 class="signature " id="find-class_method">
   
-    + (<tt>Object</tt>) <strong>find</strong>(schema_name, schema_type:) 
+    + (<tt>Hash</tt>) <strong>find</strong>(schema) 
   
 
   
@@ -282,62 +300,74 @@
   </div>
 </div>
 <div class="tags">
-  <p class="tag_title">Parameters:</p>
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+      <pre class="example code"><code>
+<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>
+<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>
+<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>
+<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>
+    
+  </div>
+<p class="tag_title">Parameters:</p>
 <ul class="param">
   
     <li>
       
-        <span class='name'>schema_name</span>
+        <span class='name'>schema</span>
       
       
-        <span class='type'>(<tt>String</tt>)</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
       
       
       
         &mdash;
         <div class='inline'>
-<p>Name of the schema/format</p>
+<p>Type =&gt; Name of the schema/format:</p>
 </div>
       
     </li>
   
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
     <li>
       
-        <span class='name'>schema_type</span>
-      
       
-        <span class='type'>(<tt>String</tt>)</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
       
       
       
         &mdash;
         <div class='inline'>
-<p>The type: frontend, publisher, notification or links</p>
+<p>the JSON schema as a hash</p>
 </div>
       
     </li>
   
 </ul>
 
-
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-7
-8
-9
-10
-11</pre>
+13
+14
+15
+16</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/govuk_schemas/schema.rb', line 7</span>
+      <pre class="code"><span class="info file"># File 'lib/govuk_schemas/schema.rb', line 13</span>
 
-<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>
-  <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>
-  <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>
+<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>
+  <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>
   <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>
 <span class='kw'>end</span></pre>
     </td>
@@ -348,7 +378,7 @@
       <div class="method_details ">
   <h3 class="signature " id="random_schema-class_method">
   
-    + (<tt>Object</tt>) <strong>random_schema</strong>(schema_type:) 
+    + (<tt>Hash</tt>) <strong>random_schema</strong>(schema_type:) 
   
 
   
@@ -384,6 +414,24 @@
   
 </ul>
 
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>a JSON schema as a hash</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -391,12 +439,12 @@
       <pre class="lines">
 
 
-27
-28
-29</pre>
+34
+35
+36</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/govuk_schemas/schema.rb', line 27</span>
+      <pre class="code"><span class="info file"># File 'lib/govuk_schemas/schema.rb', line 34</span>
 
 <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>
   <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>
@@ -411,7 +459,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Sep 23 14:26:37 2016 by
+  Generated on Thu Nov  3 17:31:15 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/docs/GovukSchemas.html

@@ -111,7 +111,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Sep 23 14:26:37 2016 by
+  Generated on Thu Nov  3 17:31:15 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/docs/_index.html

@@ -131,7 +131,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Sep 23 14:26:37 2016 by
+  Generated on Thu Nov  3 17:31:15 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/docs/file.README.html

@@ -74,6 +74,20 @@ href="https://github.com/alphagov/govuk-content-schemas">govuk-content-schemas</
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>govuk_schemas</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>~&gt; VERSION</span><span class='tstring_end'>&quot;</span></span>
 </code></pre>
 
+<h2 id="label-Limitations">Limitations</h2>
+<ul><li>
+<p>The gem doesn&#39;t support <code>patternProperties</code> yet. On GOV.UK
+we <a
+href="https://github.com/alphagov/govuk-content-schemas/blob/bdd97d18c7a9318e66f332f0748a410fddab1141/formats/frontend_links_definition.json#L67-L71">use
+this in the expanded frontend links</a>.</p>
+</li><li>
+<p>It&#39;s complicated to generate random data for <code>oneOf</code>
+properties. According to the JSON Schema spec a <code>oneOf</code> schema
+is only valid if the data is valid against <em>only one</em> of the
+clauses. To do this properly, we&#39;d have to make sure that the data
+generated below doesn&#39;t validate against the other schemas properties.</p>
+</li></ul>
+
 <h2 id="label-Usage">Usage</h2>
 
 <p><a href="https://alphagov.github.io/govuk_schemas_gem/frames.html">Read the
@@ -111,7 +125,7 @@ href="LICENSE.md">MIT License</a>.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Fri Sep 23 14:26:37 2016 by
+  Generated on Thu Nov  3 17:31:15 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/docs/index.html

@@ -74,6 +74,20 @@ href="https://github.com/alphagov/govuk-content-schemas">govuk-content-schemas</
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>govuk_schemas</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>~&gt; VERSION</span><span class='tstring_end'>&quot;</span></span>
 </code></pre>
 
+<h2 id="label-Limitations">Limitations</h2>
+<ul><li>
+<p>The gem doesn&#39;t support <code>patternProperties</code> yet. On GOV.UK
+we <a
+href="https://github.com/alphagov/govuk-content-schemas/blob/bdd97d18c7a9318e66f332f0748a410fddab1141/formats/frontend_links_definition.json#L67-L71">use
+this in the expanded frontend links</a>.</p>
+</li><li>
+<p>It&#39;s complicated to generate random data for <code>oneOf</code>
+properties. According to the JSON Schema spec a <code>oneOf</code> schema
+is only valid if the data is valid against <em>only one</em> of the
+clauses. To do this properly, we&#39;d have to make sure that the data
+generated below doesn&#39;t validate against the other schemas properties.</p>
+</li></ul>
+
 <h2 id="label-Usage">Usage</h2>
 
 <p><a href="https://alphagov.github.io/govuk_schemas_gem/frames.html">Read the
@@ -111,7 +125,7 @@ href="LICENSE.md">MIT License</a>.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Fri Sep 23 14:26:37 2016 by
+  Generated on Thu Nov  3 17:31:15 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/docs/top-level-namespace.html

@@ -103,7 +103,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Sep 23 14:26:37 2016 by
+  Generated on Thu Nov  3 17:31:15 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.3.1).
 </div>

data/lib/govuk_schemas/random.rb

@@ -47,6 +47,10 @@ module GovukSchemas
         "##{SecureRandom.hex}"
       end
 
+      def random_identifier(separator:)
+        Utils.parameterize(WORDS.sample(rand(1..10)).join('-')).gsub('-', separator)
+      end
+
       def string_for_regex(pattern)
         case pattern.to_s
         when '^(placeholder|placeholder_.+)$'
@@ -62,7 +66,9 @@ module GovukSchemas
         when "^#.+$"
           anchor
         when "[a-z-]"
-          Utils.parameterize(WORDS.sample(rand(1..10)).join('-'))
+          random_identifier(separator: '-')
+        when "^[a-z_]+$"
+          random_identifier(separator: '_')
         when "^/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?(\\?([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?(#([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?$"
           base_path
         when "^https://([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[A-Za-z0-9])?\\.)+campaign\\.gov\\.uk(/(([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})+(/([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)*)?(\\?([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?(#([a-zA-Z0-9._~!$&'()*+,;=:@-]|%[0-9a-fA-F]{2})*)?)?$"

data/lib/govuk_schemas/random_example.rb

@@ -23,13 +23,14 @@ module GovukSchemas
     #
     # For example:
     #
-    #     generator = GovukSchemas::RandomExample.for_schema("detailed_guide", schema_type: "frontend")
+    #     generator = GovukSchemas::RandomExample.for_schema(frontend_schema: "detailed_guide")
     #     generator.payload
     #     # => {"base_path"=>"/e42dd28e", "title"=>"dolor est...", "publishing_app"=>"elit"...}
     #
+    # @param schema_key_value [Hash]
     # @return [GovukSchemas::RandomExample]
-    def self.for_schema(schema_name, schema_type:)
-      schema = GovukSchemas::Schema.find(schema_name, schema_type: schema_type)
+    def self.for_schema(schema_key_value)
+      schema = GovukSchemas::Schema.find(schema_key_value)
       GovukSchemas::RandomExample.new(schema: schema)
     end
 

data/lib/govuk_schemas/schema.rb

@@ -2,17 +2,23 @@ module GovukSchemas
   class Schema
     # Find a schema by name
     #
-    # @param schema_name [String] Name of the schema/format
-    # @param schema_type [String] The type: frontend, publisher, notification or links
-    def self.find(schema_name, schema_type:)
-      schema_type = "publisher_v2" if schema_type == "publisher"
-      file_path = "#{GovukSchemas::CONTENT_SCHEMA_DIR}/dist/formats/#{schema_name}/#{schema_type}/schema.json"
+    # @param schema [Hash] Type => Name of the schema/format:
+    # @example
+    #
+    #   GovukSchemas::Schema.find(links_schema: "detailed_guide")
+    #   GovukSchemas::Schema.find(frontend_schema: "detailed_guide")
+    #   GovukSchemas::Schema.find(publisher_schema: "detailed_guide")
+    #   GovukSchemas::Schema.find(notification_schema: "detailed_guide")
+    # @return [Hash] the JSON schema as a hash
+    def self.find(schema)
+      file_path = "#{GovukSchemas::CONTENT_SCHEMA_DIR}/dist/formats/#{location_for_schema_name(schema)}"
       JSON.parse(File.read(file_path))
     end
 
     # Return all schemas in a hash, keyed by schema name
     #
     # @param schema_type [String] The type: frontend, publisher, notification or links
+    # @return [Array<Hash>] List of JSON schemas as hashes
     def self.all(schema_type: '*')
       schema_type = "publisher_v2" if schema_type == "publisher"
       Dir.glob("#{GovukSchemas::CONTENT_SCHEMA_DIR}/dist/formats/*/#{schema_type}/*.json").reduce({}) do |hash, file_path|
@@ -24,8 +30,22 @@ module GovukSchemas
     # Return a random schema of a certain type
     #
     # @param schema_type [String] The type: frontend, publisher, notification or links
+    # @return [Hash] a JSON schema as a hash
     def self.random_schema(schema_type:)
       all(schema_type: schema_type).values.sample
     end
+
+    # @private
+    def self.location_for_schema_name(schema)
+      type, schema_name = schema.to_a.flatten
+      {
+        links_schema: "#{schema_name}/publisher_v2/links.json",
+        frontend_schema: "#{schema_name}/frontend/schema.json",
+        publisher_schema: "#{schema_name}/publisher_v2/schema.json",
+        notification_schema: "#{schema_name}/notification/schema.json",
+      }[type]
+    end
+
+    private_class_method :location_for_schema_name
   end
 end

data/lib/govuk_schemas/version.rb

@@ -1,4 +1,4 @@
 module GovukSchemas
   # @private
-  VERSION = "1.0.0".freeze
+  VERSION = "2.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_schemas
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-06 00:00:00.000000000 Z
+date: 2016-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema