brut 0.0.27 → 0.0.29

data/docs/api/Brut/CLI/Executor.html

@@ -155,7 +155,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#system!-instance_method" title="#system! (instance method)">#<strong>system!</strong>(*args)  &#x21d2; true </a>
+      <a href="#system-instance_method" title="#system (instance method)">#<strong>system</strong>(*args)  &#x21d2; int </a>
     
 
     
@@ -169,7 +169,30 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Execute a command, logging it to the standard output and outputing the commands output and error to the standard output and error, respecitively.</p>
+    <span class="summary_desc"><div class='inline'><p>Execute a command, logging it to the standard output and outputing the  commands output and error to the standard output and error, respectively.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#system!-instance_method" title="#system! (instance method)">#<strong>system!</strong>(*args)  &#x21d2; int </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Execute a command, logging it to the standard output and outputing the  commands output and error to the standard output and error, respectively.</p>
 </div></span>
   
 </li>
@@ -265,9 +288,9 @@
 
     
       <div class="method_details first">
-  <h3 class="signature first" id="system!-instance_method">
+  <h3 class="signature first" id="system-instance_method">
   
-    #<strong>system!</strong>(*args)  &#x21d2; <tt>true</tt> 
+    #<strong>system</strong>(*args)  &#x21d2; <tt>int</tt> 
   
 
   
@@ -275,8 +298,13 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Execute a command, logging it to the standard output and outputing the commands output and error to the standard output and error,
-respecitively</p>
+    <p>Execute a command, logging it to the standard output and outputing the
+commands output and error to the standard output and error, respectively. If
+the command exits nonzero, the exit status is returned.</p>
+
+<p>Generally, you want to use <span class='object_link'><a href="#system!-instance_method" title="Brut::CLI::Executor#system! (method)">#system!</a></span> for commands that must succeed
+for the caller to continue.  Only use this method if you need
+to do special error-handling when the underlying command fails.</p>
 
 
   </div>
@@ -308,9 +336,110 @@ respecitively</p>
     <li>
       
       
-        <span class='type'>(<tt>true</tt>)</span>
+        <span class='type'>(<tt>int</tt>)</span>
+      
       
       
+        &mdash;
+        <div class='inline'><p>0 if the command completed normally, otherwise the nonzero exit status. <strong>DO NOT TREAT THIS AS A BOOLEAN VALUE</strong></p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  <p class="tag_title">See Also:</p>
+  <ul class="see">
+    
+      <li><a href="https://docs.ruby-lang.org/en/3.3/Open3.html#method-c-popen3" target="_parent" title="https://docs.ruby-lang.org/en/3.3/Open3.html#method-c-popen3">https://docs.ruby-lang.org/en/3.3/Open3.html#method-c-popen3</a></li>
+    
+      <li><span class='object_link'><a href="#system!-instance_method" title="Brut::CLI::Executor#system! (method)">#system!</a></span></li>
+    
+  </ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+32
+33
+34
+35
+36
+37</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/brut/cli/executor.rb', line 32</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_system!'>system!</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
+  <span class='int'>0</span>
+<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="../../Brut.html" title="Brut (module)">Brut</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../CLI.html" title="Brut::CLI (module)">CLI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SystemExecError.html" title="Brut::CLI::SystemExecError (class)">SystemExecError</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
+  <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_exit_status'>exit_status</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="system!-instance_method">
+  
+    #<strong>system!</strong>(*args)  &#x21d2; <tt>int</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Execute a command, logging it to the standard output and outputing the
+commands output and error to the standard output and error, respectively. If
+the command exits nonzero, an exception is raised and your CLI app will
+also exit nonzero.</p>
+
+<p>If you need to handle  the command exiting nonzero, use <span class='object_link'><a href="#system-instance_method" title="Brut::CLI::Executor#system (method)">#system</a></span>
+instead, as it will not raise an exception.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>args</span>
+      
+      
+        <span class='type'>(<tt>String|Array</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Whatever you would give to <code>Kernel#system</code> or <code>Open3.popen3</code>.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>int</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Always returns 0</p>
+</div>
       
     </li>
   
@@ -326,7 +455,7 @@ respecitively</p>
       
       
         
-        <div class='inline'><p>Brut::CLI::Error::SystemExecError if the spawed command exits nonzer</p>
+        <div class='inline'><p>Brut::CLI::Error::SystemExecError if the spawed command exits nonzero</p>
 </div>
       
     </li>
@@ -338,6 +467,8 @@ respecitively</p>
     
       <li><a href="https://docs.ruby-lang.org/en/3.3/Open3.html#method-c-popen3" target="_parent" title="https://docs.ruby-lang.org/en/3.3/Open3.html#method-c-popen3">https://docs.ruby-lang.org/en/3.3/Open3.html#method-c-popen3</a></li>
     
+      <li><span class='object_link'><a href="#system-instance_method" title="Brut::CLI::Executor#system (method)">#system</a></span></li>
+    
   </ul>
 
 </div><table class="source_code">
@@ -346,39 +477,39 @@ respecitively</p>
       <pre class="lines">
 
 
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
 53
 54
 55
-56</pre>
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70
+71
+72
+73
+74
+75
+76
+77
+78
+79
+80
+81
+82</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/brut/cli/executor.rb', line 27</span>
+      <pre class="code"><span class="info file"># File 'lib/brut/cli/executor.rb', line 53</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_system!'>system!</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
   <span class='ivar'>@out</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Executing </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_args'>args</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
@@ -408,7 +539,7 @@ respecitively</p>
   <span class='kw'>else</span>
     <span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../../Brut.html" title="Brut (module)">Brut</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../CLI.html" title="Brut::CLI (module)">CLI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SystemExecError.html" title="Brut::CLI::SystemExecError (class)">SystemExecError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="SystemExecError.html#initialize-instance_method" title="Brut::CLI::SystemExecError#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span><span class='id identifier rubyid_wait_thread'>wait_thread</span><span class='period'>.</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_exitstatus'>exitstatus</span><span class='rparen'>)</span>
   <span class='kw'>end</span>
-  <span class='kw'>true</span>
+  <span class='int'>0</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -420,7 +551,7 @@ respecitively</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Jun 25 22:57:20 2025 by
+  Generated on Fri Jul  4 21:27:27 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

data/docs/api/Brut/CLI/InvalidOption.html

@@ -235,7 +235,7 @@ error message given the global/command optiona dichotomy.</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Jun 25 22:57:20 2025 by
+  Generated on Fri Jul  4 21:27:27 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

data/docs/api/Brut/CLI/Options.html

@@ -144,6 +144,29 @@
     <span class="summary_desc"><div class='inline'><p>Access an options value directly.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#[]=-instance_method" title="#[]= (instance method)">#<strong>[]=</strong>(key, value)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+</div></span>
+  
 </li>
 
       
@@ -413,10 +436,6 @@ will respond to any method that either takes no arguments or where the only argu
       <pre class="lines">
 
 
-44
-45
-46
-47
 48
 49
 50
@@ -441,10 +460,14 @@ will respond to any method that either takes no arguments or where the only argu
 69
 70
 71
-72</pre>
+72
+73
+74
+75
+76</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/brut/cli/options.rb', line 44</span>
+      <pre class="code"><span class="info file"># File 'lib/brut/cli/options.rb', line 48</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_sym'>sym</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_block'>block</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_boolean'>boolean</span> <span class='op'>=</span> <span class='kw'>false</span>
@@ -531,16 +554,42 @@ will respond to any method that either takes no arguments or where the only argu
       <pre class="lines">
 
 
-14
-15
-16</pre>
+14</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/brut/cli/options.rb', line 14</span>
 
-<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='ivar'>@parsed_options</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span>
-<span class='comment'># Check if `key` was provided on the command line.
-</span><span class='comment'># @param [String] key the key to use. This must be the exact name you used when calling `opts.on` or when creating the `OptionParser` for your app or command.</span></pre>
+<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='ivar'>@parsed_options</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="[]=-instance_method">
+  
+    #<strong>[]=</strong>(key, value)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+16
+17
+18</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/brut/cli/options.rb', line 16</span>
+
+<span class='kw'>def</span> <span class='op'>[]=</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
+  <span class='ivar'>@parsed_options</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
+<span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
@@ -603,10 +652,10 @@ will respond to any method that either takes no arguments or where the only argu
       <pre class="lines">
 
 
-17</pre>
+21</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/brut/cli/options.rb', line 17</span>
+      <pre class="code"><span class="info file"># File 'lib/brut/cli/options.rb', line 21</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span> <span class='op'>=</span> <span class='ivar'>@parsed_options</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span></pre>
     </td>
@@ -674,12 +723,12 @@ line.</p>
       <pre class="lines">
 
 
-23
-24
-25</pre>
+27
+28
+29</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/brut/cli/options.rb', line 23</span>
+      <pre class="code"><span class="info file"># File 'lib/brut/cli/options.rb', line 27</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_set_default'>set_default</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='comma'>,</span><span class='id identifier rubyid_default_value'>default_value</span><span class='rparen'>)</span>
   <span class='ivar'>@defaults</span><span class='lbracket'>[</span><span class='id identifier rubyid_sym'>sym</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_default_value'>default_value</span>
@@ -743,7 +792,7 @@ line.</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Jun 25 22:57:20 2025 by
+  Generated on Fri Jul  4 21:27:27 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

data/docs/api/Brut/CLI/Output.html

@@ -689,7 +689,7 @@ it's intended to be piped into another app.</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Jun 25 22:57:20 2025 by
+  Generated on Fri Jul  4 21:27:27 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

data/docs/api/Brut/CLI/SystemExecError.html

@@ -441,7 +441,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Jun 25 22:57:20 2025 by
+  Generated on Fri Jul  4 21:27:27 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

data/docs/api/Brut/CLI.html

@@ -253,7 +253,7 @@ it via <code>bin/clean-files</code>, you'd create <code>bin/clean-files</code> l
 </div>
 
       <div id="footer">
-  Generated on Wed Jun 25 22:57:19 2025 by
+  Generated on Fri Jul  4 21:27:27 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

data/docs/api/Brut/FactoryBot.html

@@ -215,7 +215,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Jun 25 22:57:20 2025 by
+  Generated on Fri Jul  4 21:27:27 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

data/docs/api/Brut/Framework/App.html

@@ -1087,7 +1087,7 @@ actions where an app needs to exist inside some organizational context.</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Jun 25 22:57:20 2025 by
+  Generated on Fri Jul  4 21:27:27 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>

data/docs/api/Brut/Framework/Config.html

@@ -1035,7 +1035,7 @@ connection to your database.</p>
 </div>
 
       <div id="footer">
-  Generated on Wed Jun 25 22:57:20 2025 by
+  Generated on Fri Jul  4 21:27:28 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.37 (ruby-3.4.4).
 </div>