rudder 0.2.2 → 0.3.0

data/docs/Rudder/DSL/Pipeline.html

@@ -157,6 +157,15 @@ then loaded into a <span class='object_link'><a href="" title="Rudder::DSL::Pipe
 <span class='object_link'><a href="#include_component-instance_method" title="Rudder::DSL::Pipeline#include_component (method)">#include_component</a></span>. This is useful for factoring out
 common resources for multiple pipeline&#39;s to use.</p>
 
+<h3 id="label-Loading+Concourse+Variables">Loading Concourse Variables</h3>
+
+<p>Occasionally it is helpful to have access to concourse variable when
+generating a pipeline, for example, when a Rudder pipeline should be
+parameterized on some value already stored in a Concourse parameter file.
+Rudder supports loading a concourse vars file from the <span class='object_link'><a href="../../Rudder.html" title="Rudder (module)">Rudder</a></span> command
+line. These are exposed to the pipeline dsl through the <code>vars</code>
+accessor.</p>
+
 
   </div>
 </div>
@@ -257,6 +266,27 @@ end</code></pre>
   <span class='rbrace'>}</span>
 <span class='kw'>end</span></code></pre>
     
+      
+        <p class="example_title"><div class='inline'>
+<p>Loading Concourse Variables</p>
+</div></p>
+      
+      <pre class="example code"><code>#
+# vars_pipeline.rb
+#
+# Assuming a variables file of the form:
+#
+# my_branch: awesome-feature
+#
+
+my_branch = vars[:my_branch] # &lt;--- Pulls in the variable here
+
+resource :my_git_repo, :git do
+  source[:uri]    = &#39;https://github.com/my/repo.git&#39;
+  source[:branch] = my_branch
+end
+...</code></pre>
+    
   </div>
 
 
@@ -379,6 +409,33 @@ end</code></pre>
 <p>Hash of names to <span class='object_link'><a href="Resource.html" title="Rudder::DSL::Resource (class)">Resource</a></span>.</p>
 </div></span>
   
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#vars-instance_method" title="#vars (instance method)">#<strong>vars</strong>  &#x21d2; Hash&lt;Symbol, (String,Float,Hash,Array)&gt; </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Hash of concourse variables.</p>
+</div></span>
+  
 </li>
 
     
@@ -472,7 +529,7 @@ it, creates a new component.</p>
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(file_path = nil, resources: {}, jobs: {}, groups: {}, resource_types: {})  &#x21d2; Pipeline </a>
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(file_path = nil, resources: {}, jobs: {}, groups: {}, resource_types: {}, vars: {})  &#x21d2; Pipeline </a>
     
 
     
@@ -685,7 +742,7 @@ representations.</p>
     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">
   
-    #<strong>initialize</strong>(file_path = nil, resources: {}, jobs: {}, groups: {}, resource_types: {})  &#x21d2; <tt><span class='object_link'><a href="" title="Rudder::DSL::Pipeline (class)">Pipeline</a></span></tt> 
+    #<strong>initialize</strong>(file_path = nil, resources: {}, jobs: {}, groups: {}, resource_types: {}, vars: {})  &#x21d2; <tt><span class='object_link'><a href="" title="Rudder::DSL::Pipeline (class)">Pipeline</a></span></tt> 
   
 
   
@@ -808,6 +865,25 @@ map of <span class='object_link'><a href="Resource.html" title="Rudder::DSL::Res
         <div class='inline'>
 <p>esources_types [Hash&lt;(String, Symbol), Rudder::DSL::ResourceType] map of
 Resource Type names to their definitions.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>vars</span>
+      
+      
+        <span class='type'>(<tt>Hash&lt;(String, Symbol), (String,Float,Hash,Array)]
+map of var names to corresponding concourse variable
+value</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>ars      [Hash&lt;(String, Symbol), (String,Float,Hash,Array)] map of var
+names to corresponding concourse variable value</p>
 </div>
       
     </li>
@@ -821,29 +897,32 @@ Resource Type names to their definitions.</p>
       <pre class="lines">
 
 
-183
-184
-185
-186
-187
-188
-189
-190
-191
-192
-193
-194
-195
-196
-197
-198
-199</pre>
+214
+215
+216
+217
+218
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
+233</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 183</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 214</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>resources:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>jobs:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span>
-               <span class='label'>groups:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>resource_types:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+               <span class='label'>groups:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>resource_types:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>vars:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='ivar'>@resources</span>      <span class='op'>=</span> <span class='id identifier rubyid_resources'>resources</span>
   <span class='ivar'>@jobs</span>           <span class='op'>=</span> <span class='id identifier rubyid_jobs'>jobs</span>
   <span class='ivar'>@groups</span>         <span class='op'>=</span> <span class='id identifier rubyid_groups'>groups</span>
@@ -858,6 +937,9 @@ Resource Type names to their definitions.</p>
   <span class='comment'># rubocop:enable Layout/AlignHash, Layout/SpaceBeforeComma
 </span>  <span class='ivar'>@pipelines</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
   <span class='ivar'>@file_path</span> <span class='op'>=</span> <span class='id identifier rubyid_file_path'>file_path</span>
+  <span class='ivar'>@vars</span>      <span class='op'>=</span> <span class='id identifier rubyid_vars'>vars</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='op'>|</span>
+    <span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='rbracket'>]</span>
+  <span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_to_h'>to_h</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -962,27 +1044,27 @@ Otherwise returns <code>nil</code>.</p>
       <pre class="lines">
 
 
-261
-262
-263
-264
-265
-266
-267
-268
-269
-270
-271
-272
-273
-274
-275
-276
-277
-278</pre>
+295
+296
+297
+298
+299
+300
+301
+302
+303
+304
+305
+306
+307
+308
+309
+310
+311
+312</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 261</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 295</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_component_block'>component_block</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_local_component'>local_component</span> <span class='op'>=</span> <span class='id identifier rubyid__get_local_component'>_get_local_component</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='rparen'>)</span>
@@ -1053,12 +1135,12 @@ Otherwise returns <code>nil</code>.</p>
       <pre class="lines">
 
 
-155
-156
-157</pre>
+180
+181
+182</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 155</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 180</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_groups'>groups</span>
   <span class='ivar'>@groups</span>
@@ -1109,12 +1191,12 @@ Otherwise returns <code>nil</code>.</p>
       <pre class="lines">
 
 
-149
-150
-151</pre>
+174
+175
+176</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 149</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 174</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_jobs'>jobs</span>
   <span class='ivar'>@jobs</span>
@@ -1165,12 +1247,12 @@ Otherwise returns <code>nil</code>.</p>
       <pre class="lines">
 
 
-152
-153
-154</pre>
+177
+178
+179</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 152</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 177</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_resource_types'>resource_types</span>
   <span class='ivar'>@resource_types</span>
@@ -1221,12 +1303,12 @@ Otherwise returns <code>nil</code>.</p>
       <pre class="lines">
 
 
-146
-147
-148</pre>
+171
+172
+173</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 146</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 171</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_resources'>resources</span>
   <span class='ivar'>@resources</span>
@@ -1236,6 +1318,62 @@ Otherwise returns <code>nil</code>.</p>
 </table>
 </div>
     
+      
+      <span id="vars=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="vars-instance_method">
+  
+    #<strong>vars</strong>  &#x21d2; <tt>Hash&lt;Symbol, (String,Float,Hash,Array)&gt;</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Hash of concourse variables</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Hash&lt;Symbol, (String,Float,Hash,Array)&gt;</tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+183
+184
+185</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 183</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_vars'>vars</span>
+  <span class='ivar'>@vars</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
   </div>
 
 
@@ -1330,20 +1468,20 @@ provided at construction time If both are nil, raises an exception</p>
       <pre class="lines">
 
 
-303
-304
-305
-306
-307
-308
-309
-310
-311
-312
-313</pre>
+337
+338
+339
+340
+341
+342
+343
+344
+345
+346
+347</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 303</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 337</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_eval'>eval</span><span class='lparen'>(</span><span class='id identifier rubyid_file_path'>file_path</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
   <span class='ivar'>@file_path</span> <span class='op'>=</span> <span class='id identifier rubyid_file_path'>file_path</span> <span class='op'>||</span> <span class='ivar'>@file_path</span>
@@ -1487,19 +1625,19 @@ constructor.</p>
       <pre class="lines">
 
 
-371
-372
-373
-374
-375
-376
-377
-378
-379
-380</pre>
+405
+406
+407
+408
+409
+410
+411
+412
+413
+414</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 371</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 405</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_include_component'>include_component</span><span class='lparen'>(</span><span class='id identifier rubyid_component_path'>component_path</span><span class='comma'>,</span> <span class='id identifier rubyid_class_sym'>class_sym</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unable to load </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_class_sym'>class_sym</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='ivar'>@known_classes</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_class_sym'>class_sym</span>
@@ -1585,13 +1723,13 @@ defined component in this pipeline will override the previous definition</p>
       <pre class="lines">
 
 
-393
-394
-395
-396</pre>
+427
+428
+429
+430</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 393</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 427</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_include_pipeline'>include_pipeline</span><span class='lparen'>(</span><span class='id identifier rubyid_other_pipeline_path'>other_pipeline_path</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_pipeline'>pipeline</span> <span class='op'>=</span> <span class='id identifier rubyid_load'>load</span> <span class='id identifier rubyid_other_pipeline_path'>other_pipeline_path</span>
@@ -1735,24 +1873,24 @@ the other <span class='object_link'><a href="" title="Rudder::DSL::Pipeline (cla
       <pre class="lines">
 
 
-338
-339
-340
-341
-342
-343
-344
-345
-346
-347
-348
-349
-350
-351
-352</pre>
+372
+373
+374
+375
+376
+377
+378
+379
+380
+381
+382
+383
+384
+385
+386</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 338</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 372</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_load'>load</span><span class='lparen'>(</span><span class='id identifier rubyid_other_pipeline_path'>other_pipeline_path</span><span class='comma'>,</span> <span class='label'>resources:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>resource_types:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span>
          <span class='label'>jobs:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>groups:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
@@ -1880,17 +2018,17 @@ components into their respective Pipeline group by class.</p>
       <pre class="lines">
 
 
-425
-426
-427
-428
-429
-430
-431
-432</pre>
+459
+460
+461
+462
+463
+464
+465
+466</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 425</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 459</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_merge_components'>merge_components</span><span class='lparen'>(</span><span class='id identifier rubyid_components'>components</span><span class='rparen'>)</span>
   <span class='kw'>case</span> <span class='id identifier rubyid_components'>components</span>
@@ -1931,12 +2069,12 @@ components into their respective Pipeline group by class.</p>
       <pre class="lines">
 
 
-222
-223
-224</pre>
+256
+257
+258</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 222</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 256</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_p_convert_h_val'>p_convert_h_val</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
   <span class='id identifier rubyid__convert_h_val'>_convert_h_val</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
@@ -1983,12 +2121,12 @@ components into their respective Pipeline group by class.</p>
       <pre class="lines">
 
 
-289
-290
-291</pre>
+323
+324
+325</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 289</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 323</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid__include_all'>_include_all</span> <span class='op'>=</span> <span class='kw'>true</span><span class='rparen'>)</span>
   <span class='ivar'>@known_classes</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span> <span class='id identifier rubyid_name'>name</span>
@@ -2042,12 +2180,12 @@ components into their respective Pipeline group by class.</p>
       <pre class="lines">
 
 
-285
-286
-287</pre>
+319
+320
+321</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 285</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 319</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_respond_to_missing?'>respond_to_missing?</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid__'>_</span><span class='rparen'>)</span>
   <span class='kw'>true</span>
@@ -2105,18 +2243,18 @@ rendering at all.</p>
       <pre class="lines">
 
 
-209
-210
-211
-212
-213
-214
-215
-216
-217</pre>
+243
+244
+245
+246
+247
+248
+249
+250
+251</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 209</span>
+      <pre class="code"><span class="info file"># File 'lib/rudder/dsl/pipeline.rb', line 243</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span>
   <span class='id identifier rubyid_h'>h</span> <span class='op'>=</span> <span class='lbrace'>{</span>
@@ -2137,7 +2275,7 @@ rendering at all.</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Aug 16 17:25:43 2019 by
+  Generated on Wed Nov  6 21:05:09 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.20 (ruby-2.5.1).
 </div>

data/docs/Rudder/DSL/Resource.html

@@ -574,7 +574,7 @@ without knowing it&#39;s underlying concourse name.</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Aug 16 17:25:43 2019 by
+  Generated on Wed Nov  6 21:05:09 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.20 (ruby-2.5.1).
 </div>

data/docs/Rudder/DSL/ResourceType.html

@@ -213,7 +213,7 @@ community defined.</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Aug 16 17:25:43 2019 by
+  Generated on Wed Nov  6 21:05:09 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.20 (ruby-2.5.1).
 </div>

data/docs/Rudder/DSL/Util.html

@@ -360,7 +360,7 @@ Hash (if able), or returns the object itself.</p>
 </div>
 
       <div id="footer">
-  Generated on Fri Aug 16 17:25:43 2019 by
+  Generated on Wed Nov  6 21:05:08 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.20 (ruby-2.5.1).
 </div>