marked-conductor 1.0.10 → 1.0.12

data/html/String.html

@@ -122,10 +122,12 @@
         </div>
 
         <div class="method-description">
-          
+          <p>Test if a string is a boolean</p>
+
+<p>@return     [Boolean] test result</p>
 
           <div class="method-source-code" id="bool-3F-source">
-            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 41</span>
+            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 77</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bool?</span>
   <span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">&quot;utf-8&quot;</span>).<span class="ruby-identifier">match?</span>(<span class="ruby-regexp">/^(?:y(?:es)?|no?|t(?:rue)?|f(?:alse)?)$/</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -145,10 +147,12 @@
         </div>
 
         <div class="method-description">
-          
+          <p>Convert a string boolean to symbol</p>
+
+<p>@return     [Symbol] symbolized version</p>
 
           <div class="method-source-code" id="bool_to_symbol-source">
-            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 5</span>
+            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 10</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bool_to_symbol</span>
   <span class="ruby-keyword">case</span> <span class="ruby-keyword">self</span>
   <span class="ruby-keyword">when</span> <span class="ruby-regexp">/(NOT|!!)/</span>
@@ -175,12 +179,14 @@
         </div>
 
         <div class="method-description">
-          
+          <p>Test a string to see if it’s a UTC date</p>
+
+<p>@return     [Boolean] test result</p>
 
           <div class="method-source-code" id="date-3F-source">
-            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 16</span>
+            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 26</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">date?</span>
-  <span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">&quot;utf-8&quot;</span>).<span class="ruby-identifier">match?</span>(<span class="ruby-regexp">/^\d{4}-\d{2}-\d{2}/</span>)
+  <span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">&quot;utf-8&quot;</span>).<span class="ruby-identifier">match?</span>(<span class="ruby-regexp">/^\d{4}-\d{2}-\d{2}( \d\d:\d\d)?$/</span>)
 <span class="ruby-keyword">end</span></pre>
           </div>
         </div>
@@ -198,10 +204,12 @@
         </div>
 
         <div class="method-description">
-          
+          <p>Test if a string starts with MMD metadata</p>
+
+<p>@return     [Boolean] test result</p>
 
           <div class="method-source-code" id="meta-3F-source">
-            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 49</span>
+            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 95</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">meta?</span>
   <span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">&#39;utf-8&#39;</span>).<span class="ruby-identifier">match?</span>(<span class="ruby-regexp">/^\w+: +\S+/m</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -221,10 +229,12 @@
         </div>
 
         <div class="method-description">
-          
+          <p>Test if a string is a number</p>
+
+<p>@return     [Boolean] test result</p>
 
           <div class="method-source-code" id="number-3F-source">
-            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 37</span>
+            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 68</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">number?</span>
   <span class="ruby-identifier">to_f</span>.<span class="ruby-identifier">positive?</span>
 <span class="ruby-keyword">end</span></pre>
@@ -244,10 +254,12 @@
         </div>
 
         <div class="method-description">
-          
+          <p>Remove time from string</p>
+
+<p>@return     [String] string with time removed</p>
 
           <div class="method-source-code" id="strip_time-source">
-            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 28</span>
+            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 54</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">strip_time</span>
   <span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">&quot;utf-8&quot;</span>).<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/ \d{1,2}(:\d\d)? *([ap]m)?/i</span>, <span class="ruby-string">&quot;&quot;</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -267,10 +279,12 @@
         </div>
 
         <div class="method-description">
-          
+          <p>Test a string to see if it includes a time</p>
+
+<p>@return     [Boolean] test result</p>
 
           <div class="method-source-code" id="time-3F-source">
-            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 20</span>
+            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 35</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">time?</span>
   <span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">&quot;utf-8&quot;</span>).<span class="ruby-identifier">match</span>(<span class="ruby-regexp">/ \d{1,2}(:\d\d)? *([ap]m)?/i</span>)
 <span class="ruby-keyword">end</span></pre>
@@ -295,7 +309,7 @@
 <p>@return     [Boolean] Bool representation of the object.</p>
 
           <div class="method-source-code" id="to_bool-source">
-            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 62</span>
+            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 114</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_bool</span>
   <span class="ruby-keyword">case</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">&#39;utf-8&#39;</span>)
   <span class="ruby-keyword">when</span> <span class="ruby-regexp">/^[yt]/i</span>
@@ -320,10 +334,12 @@
         </div>
 
         <div class="method-description">
-          
+          <p>Destructive version of <a href="String.html#method-i-to_bool"><code>to_bool</code></a></p>
+
+<p>@see        <a href="String.html#method-i-to_bool"><code>to_bool</code></a></p>
 
           <div class="method-source-code" id="to_bool-21-source">
-            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 53</span>
+            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 105</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_bool!</span>
   <span class="ruby-identifier">replace</span> <span class="ruby-identifier">to_bool</span>
 <span class="ruby-keyword">end</span></pre>
@@ -343,10 +359,15 @@
         </div>
 
         <div class="method-description">
-          
+          <p>Convert a natural language string to a Date</p>
+
+<pre class="ruby"><span class="ruby-identifier">object</span>
+</pre>
+
+<p>@return     [Date] Resulting Date object</p>
 
           <div class="method-source-code" id="to_date-source">
-            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 24</span>
+            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 45</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_date</span>
   <span class="ruby-constant">Chronic</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">&quot;utf-8&quot;</span>))
 <span class="ruby-keyword">end</span></pre>
@@ -369,7 +390,7 @@
           
 
           <div class="method-source-code" id="to_day-source">
-            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 32</span>
+            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 58</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_day</span>(<span class="ruby-identifier">time</span> = <span class="ruby-value">:end</span>)
   <span class="ruby-identifier">t</span> = <span class="ruby-identifier">time</span> <span class="ruby-operator">==</span> <span class="ruby-value">:end</span> <span class="ruby-operator">?</span> <span class="ruby-string">&quot;23:59&quot;</span> <span class="ruby-operator">:</span> <span class="ruby-string">&quot;00:00&quot;</span>
   <span class="ruby-constant">Chronic</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-node">&quot;#{strip_time} #{t}&quot;</span>)
@@ -390,10 +411,12 @@
         </div>
 
         <div class="method-description">
-          
+          <p>Test if string starts with YAML</p>
+
+<p>@return     [Boolean] test result</p>
 
           <div class="method-source-code" id="yaml-3F-source">
-            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 45</span>
+            <pre><span class="ruby-comment"># File lib/conductor/string.rb, line 86</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">yaml?</span>
   <span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">&#39;utf-8&#39;</span>).<span class="ruby-identifier">match?</span>(<span class="ruby-regexp">/^---/m</span>)
 <span class="ruby-keyword">end</span></pre>

data/html/created.rid

@@ -1,14 +1,14 @@
-Sun, 28 Apr 2024 14:05:58 -0500
+Wed, 01 May 2024 13:06:18 -0500
 README.rdoc	Sun, 28 Apr 2024 13:21:34 -0500
-lib/conductor.rb	Sun, 28 Apr 2024 13:46:38 -0500
+lib/conductor.rb	Wed, 01 May 2024 13:05:15 -0500
 lib/conductor/array.rb	Sat, 27 Apr 2024 11:54:28 -0500
 lib/conductor/boolean.rb	Thu, 25 Apr 2024 14:25:59 -0500
 lib/conductor/command.rb	Sat, 27 Apr 2024 11:54:28 -0500
-lib/conductor/condition.rb	Sun, 28 Apr 2024 13:52:45 -0500
+lib/conductor/condition.rb	Mon, 29 Apr 2024 09:19:15 -0500
 lib/conductor/config.rb	Sat, 27 Apr 2024 11:54:28 -0500
-lib/conductor/env.rb	Sun, 28 Apr 2024 13:31:54 -0500
+lib/conductor/env.rb	Mon, 29 Apr 2024 09:28:21 -0500
 lib/conductor/hash.rb	Sat, 27 Apr 2024 11:54:28 -0500
-lib/conductor/script.rb	Sat, 27 Apr 2024 11:54:28 -0500
-lib/conductor/string.rb	Sun, 28 Apr 2024 13:50:26 -0500
-lib/conductor/version.rb	Sat, 27 Apr 2024 16:00:44 -0500
-bin/conductor	Sun, 28 Apr 2024 14:01:55 -0500
+lib/conductor/script.rb	Sun, 28 Apr 2024 16:21:49 -0500
+lib/conductor/string.rb	Mon, 29 Apr 2024 09:46:03 -0500
+lib/conductor/version.rb	Mon, 29 Apr 2024 09:46:58 -0500
+bin/conductor	Sun, 28 Apr 2024 16:24:45 -0500

data/html/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["array","conductor","command","condition","config","env","script","falseclass","hash","object","string","trueclass","args=()","args=()","bool?()","bool?()","bool?()","bool_to_symbol()","clean_condition()","conduct()","create_config()","date?()","env()","execute_track()","load_test_env()","meta?()","new()","new()","new()","new()","number?()","operator_to_symbol()","parse_condition()","path=()","path=()","run()","run()","sample_config()","split_booleans()","split_condition()","stdin()","strip_time()","symbolize_keys()","symbolize_keys()","symbolize_keys!()","symbolize_keys!()","test_condition()","test_meta()","test_operator()","test_pandoc()","test_string()","test_tree()","test_truthy()","test_type()","test_yaml()","time?()","to_bool()","to_bool!()","to_date()","to_day()","to_s()","true?()","yaml?()","readme"],"longSearchIndex":["array","conductor","conductor::command","conductor::condition","conductor::config","conductor::env","conductor::script","falseclass","hash","object","string","trueclass","conductor::command#args=()","conductor::script#args=()","falseclass#bool?()","string#bool?()","trueclass#bool?()","string#bool_to_symbol()","object#clean_condition()","conductor::conduct()","conductor#create_config()","string#date?()","conductor::env::env()","conductor::execute_track()","conductor::env::load_test_env()","string#meta?()","conductor::command::new()","conductor::condition::new()","conductor::config::new()","conductor::script::new()","string#number?()","conductor::condition#operator_to_symbol()","conductor::condition#parse_condition()","conductor::command#path=()","conductor::script#path=()","conductor::command#run()","conductor::script#run()","conductor#sample_config()","conductor::condition#split_booleans()","conductor::condition#split_condition()","conductor::stdin()","string#strip_time()","array#symbolize_keys()","hash#symbolize_keys()","array#symbolize_keys!()","hash#symbolize_keys!()","conductor::condition#test_condition()","conductor::condition#test_meta()","conductor::condition#test_operator()","conductor::condition#test_pandoc()","conductor::condition#test_string()","conductor::condition#test_tree()","conductor::condition#test_truthy()","conductor::condition#test_type()","conductor::condition#test_yaml()","string#time?()","string#to_bool()","string#to_bool!()","string#to_date()","string#to_day()","conductor::env::to_s()","conductor::condition#true?()","string#yaml?()",""],"info":[["Array","","Array.html","",""],["Conductor","","Conductor.html","",""],["Conductor::Command","","Conductor/Command.html","","<p>Command runner\n"],["Conductor::Condition","","Conductor/Condition.html","",""],["Conductor::Config","","Conductor/Config.html","","<p>Configuration methods\n"],["Conductor::Env","","Conductor/Env.html","",""],["Conductor::Script","","Conductor/Script.html","","<p>Script runner\n"],["FalseClass","","FalseClass.html","","<p>False class\n"],["Hash","","Hash.html","",""],["Object","","Object.html","",""],["String","","String.html","","<p>String helpers\n"],["TrueClass","","TrueClass.html","","<p>True class\n"],["args=","Conductor::Command","Conductor/Command.html#method-i-args-3D","(array)",""],["args=","Conductor::Script","Conductor/Script.html#method-i-args-3D","(array)",""],["bool?","FalseClass","FalseClass.html#method-i-bool-3F","()",""],["bool?","String","String.html#method-i-bool-3F","()",""],["bool?","TrueClass","TrueClass.html#method-i-bool-3F","()",""],["bool_to_symbol","String","String.html#method-i-bool_to_symbol","()",""],["clean_condition","Object","Object.html#method-i-clean_condition","(condition)",""],["conduct","Conductor","Conductor.html#method-c-conduct","(tracks, res = nil, condition = nil)",""],["create_config","Conductor","Conductor.html#method-i-create_config","(config_file)",""],["date?","String","String.html#method-i-date-3F","()",""],["env","Conductor::Env","Conductor/Env.html#method-c-env","()",""],["execute_track","Conductor","Conductor.html#method-c-execute_track","(track)",""],["load_test_env","Conductor::Env","Conductor/Env.html#method-c-load_test_env","()",""],["meta?","String","String.html#method-i-meta-3F","()",""],["new","Conductor::Command","Conductor/Command.html#method-c-new","(command)",""],["new","Conductor::Condition","Conductor/Condition.html#method-c-new","(condition)",""],["new","Conductor::Config","Conductor/Config.html#method-c-new","()",""],["new","Conductor::Script","Conductor/Script.html#method-c-new","(script)",""],["number?","String","String.html#method-i-number-3F","()",""],["operator_to_symbol","Conductor::Condition","Conductor/Condition.html#method-i-operator_to_symbol","(operator)",""],["parse_condition","Conductor::Condition","Conductor/Condition.html#method-i-parse_condition","()",""],["path=","Conductor::Command","Conductor/Command.html#method-i-path-3D","(path)",""],["path=","Conductor::Script","Conductor/Script.html#method-i-path-3D","(path)",""],["run","Conductor::Command","Conductor/Command.html#method-i-run","()",""],["run","Conductor::Script","Conductor/Script.html#method-i-run","()",""],["sample_config","Conductor","Conductor.html#method-i-sample_config","()",""],["split_booleans","Conductor::Condition","Conductor/Condition.html#method-i-split_booleans","(condition)","<p>@brief      Splits booleans and tests components.\n<p>@param      condition  The condition to test\n<p>@return …\n"],["split_condition","Conductor::Condition","Conductor/Condition.html#method-i-split_condition","(condition)","<p>@brief      Splits a natural language condition.\n<p>@param      condition  The condition @return [Array] …\n"],["stdin","Conductor","Conductor.html#method-c-stdin","()",""],["strip_time","String","String.html#method-i-strip_time","()",""],["symbolize_keys","Array","Array.html#method-i-symbolize_keys","()",""],["symbolize_keys","Hash","Hash.html#method-i-symbolize_keys","()",""],["symbolize_keys!","Array","Array.html#method-i-symbolize_keys-21","()",""],["symbolize_keys!","Hash","Hash.html#method-i-symbolize_keys-21","()",""],["test_condition","Conductor::Condition","Conductor/Condition.html#method-i-test_condition","(condition)",""],["test_meta","Conductor::Condition","Conductor/Condition.html#method-i-test_meta","(content, value, key, operator)","<p>@brief      Test for MultiMarkdown metadata,\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">optionally</span> <span class=\"ruby-identifier\">key</span> <span class=\"ruby-keyword\">and</span> <span class=\"ruby-identifier\">value</span>\n</pre>\n<p>@param      content   [String] The …\n"],["test_operator","Conductor::Condition","Conductor/Condition.html#method-i-test_operator","(value1, value2, operator)","<p>@brief      Test operators\n<p>@param      value1    Value @param      value2    Value to test @param     …\n"],["test_pandoc","Conductor::Condition","Conductor/Condition.html#method-i-test_pandoc","(content, operator)",""],["test_string","Conductor::Condition","Conductor/Condition.html#method-i-test_string","(val1, val2, operator)","<p>@brief      Compare a string based on operator\n<p>@param      val1      The string to test against @param …\n"],["test_tree","Conductor::Condition","Conductor/Condition.html#method-i-test_tree","(origin, value, operator)","<p>@brief      Test for the existince of a\n\n<pre>file/directory in the parent tree</pre>\n<p>@param      origin    Starting …\n"],["test_truthy","Conductor::Condition","Conductor/Condition.html#method-i-test_truthy","(value1, value2, operator)","<p>@brief      Test “truthiness”\n<p>@param      value1    Value to test against @param      value2 …\n"],["test_type","Conductor::Condition","Conductor/Condition.html#method-i-test_type","(val1, val2, operator)","<p>@brief      Test for type of value\n<p>@param      val1      value @param      val2      value to test against …\n"],["test_yaml","Conductor::Condition","Conductor/Condition.html#method-i-test_yaml","(content, value, key, operator)","<p>@brief      Test for presence of yaml, optionall for\n\n<pre>a key, optionally for a key&#39;s value</pre>\n<p>@param      content …\n"],["time?","String","String.html#method-i-time-3F","()",""],["to_bool","String","String.html#method-i-to_bool","()","<p>Returns a bool representation of the string.\n<p>@return     [Boolean] Bool representation of the object. …\n"],["to_bool!","String","String.html#method-i-to_bool-21","()",""],["to_date","String","String.html#method-i-to_date","()",""],["to_day","String","String.html#method-i-to_day","(time = :end)",""],["to_s","Conductor::Env","Conductor/Env.html#method-c-to_s","()",""],["true?","Conductor::Condition","Conductor/Condition.html#method-i-true-3F","()",""],["yaml?","String","String.html#method-i-yaml-3F","()",""],["README","","README_rdoc.html","","<p>Marked Conductor\n<p>A command line tool that functions as a custom processor handler for Marked 2.\n"]]}}
+var search_data = {"index":{"searchIndex":["array","conductor","command","condition","config","env","script","falseclass","hash","object","string","trueclass","args=()","args=()","bool?()","bool?()","bool?()","bool_to_symbol()","clean_condition()","conduct()","create_config()","date?()","env()","execute_track()","load_test_env()","meta?()","new()","new()","new()","new()","number?()","operator_to_symbol()","parse_condition()","path=()","path=()","run()","run()","sample_config()","split_booleans()","split_condition()","stdin()","strip_time()","symbolize_keys()","symbolize_keys()","symbolize_keys!()","symbolize_keys!()","test_condition()","test_meta()","test_operator()","test_pandoc()","test_string()","test_tree()","test_truthy()","test_type()","test_yaml()","time?()","to_bool()","to_bool!()","to_date()","to_day()","to_s()","true?()","yaml?()","readme"],"longSearchIndex":["array","conductor","conductor::command","conductor::condition","conductor::config","conductor::env","conductor::script","falseclass","hash","object","string","trueclass","conductor::command#args=()","conductor::script#args=()","falseclass#bool?()","string#bool?()","trueclass#bool?()","string#bool_to_symbol()","object#clean_condition()","conductor::conduct()","conductor#create_config()","string#date?()","conductor::env::env()","conductor::execute_track()","conductor::env::load_test_env()","string#meta?()","conductor::command::new()","conductor::condition::new()","conductor::config::new()","conductor::script::new()","string#number?()","conductor::condition#operator_to_symbol()","conductor::condition#parse_condition()","conductor::command#path=()","conductor::script#path=()","conductor::command#run()","conductor::script#run()","conductor#sample_config()","conductor::condition#split_booleans()","conductor::condition#split_condition()","conductor::stdin()","string#strip_time()","array#symbolize_keys()","hash#symbolize_keys()","array#symbolize_keys!()","hash#symbolize_keys!()","conductor::condition#test_condition()","conductor::condition#test_meta()","conductor::condition#test_operator()","conductor::condition#test_pandoc()","conductor::condition#test_string()","conductor::condition#test_tree()","conductor::condition#test_truthy()","conductor::condition#test_type()","conductor::condition#test_yaml()","string#time?()","string#to_bool()","string#to_bool!()","string#to_date()","string#to_day()","conductor::env::to_s()","conductor::condition#true?()","string#yaml?()",""],"info":[["Array","","Array.html","",""],["Conductor","","Conductor.html","","<p>Main Conductor class\n"],["Conductor::Command","","Conductor/Command.html","","<p>Command runner\n"],["Conductor::Condition","","Conductor/Condition.html","",""],["Conductor::Config","","Conductor/Config.html","","<p>Configuration methods\n"],["Conductor::Env","","Conductor/Env.html","","<p>Environment variables\n"],["Conductor::Script","","Conductor/Script.html","","<p>Script runner\n"],["FalseClass","","FalseClass.html","","<p>False class\n"],["Hash","","Hash.html","",""],["Object","","Object.html","",""],["String","","String.html","","<p>String helpers\n"],["TrueClass","","TrueClass.html","","<p>True class\n"],["args=","Conductor::Command","Conductor/Command.html#method-i-args-3D","(array)",""],["args=","Conductor::Script","Conductor/Script.html#method-i-args-3D","(array)","<p>Set the args array\n<p>@param      array  The array\n"],["bool?","FalseClass","FalseClass.html#method-i-bool-3F","()",""],["bool?","String","String.html#method-i-bool-3F","()","<p>Test if a string is a boolean\n<p>@return     [Boolean] test result\n"],["bool?","TrueClass","TrueClass.html#method-i-bool-3F","()",""],["bool_to_symbol","String","String.html#method-i-bool_to_symbol","()","<p>Convert a string boolean to symbol\n<p>@return     [Symbol] symbolized version\n"],["clean_condition","Object","Object.html#method-i-clean_condition","(condition)","<p>Clean up conditions for output\n<p>@param      condition  The condition\n"],["conduct","Conductor","Conductor.html#method-c-conduct","(tracks, res = nil, condition = nil)","<p>Main function to parse conditions and\n\n<pre>execute actions. Executes recursively for\nsub-tracks.</pre>\n<p>@param     …\n"],["create_config","Conductor","Conductor.html#method-i-create_config","(config_file)",""],["date?","String","String.html#method-i-date-3F","()","<p>Test a string to see if it’s a UTC date\n<p>@return     [Boolean] test result\n"],["env","Conductor::Env","Conductor/Env.html#method-c-env","()","<p>Define @env using Marked environment variables\n"],["execute_track","Conductor","Conductor.html#method-c-execute_track","(track)","<p>Execute commands/scripts in the track\n<p>@param      track  The track\n<p>@return     Resulting STDOUT output …\n"],["load_test_env","Conductor::Env","Conductor/Env.html#method-c-load_test_env","()","<p>Loads a test environment.\n"],["meta?","String","String.html#method-i-meta-3F","()","<p>Test if a string starts with MMD metadata\n<p>@return     [Boolean] test result\n"],["new","Conductor::Command","Conductor/Command.html#method-c-new","(command)",""],["new","Conductor::Condition","Conductor/Condition.html#method-c-new","(condition)","<p>Initializes the given condition.\n<p>@param      condition  The condition\n"],["new","Conductor::Config","Conductor/Config.html#method-c-new","()",""],["new","Conductor::Script","Conductor/Script.html#method-c-new","(script)","<p>Initializes the given script.\n<p>@param      script  The script/path\n"],["number?","String","String.html#method-i-number-3F","()","<p>Test if a string is a number\n<p>@return     [Boolean] test result\n"],["operator_to_symbol","Conductor::Condition","Conductor/Condition.html#method-i-operator_to_symbol","(operator)",""],["parse_condition","Conductor::Condition","Conductor/Condition.html#method-i-parse_condition","()",""],["path=","Conductor::Command","Conductor/Command.html#method-i-path-3D","(path)",""],["path=","Conductor::Script","Conductor/Script.html#method-i-path-3D","(path)","<p>Set script path, automatically expands/tests\n<p>@param      path  The path\n"],["run","Conductor::Command","Conductor/Command.html#method-i-run","()",""],["run","Conductor::Script","Conductor/Script.html#method-i-run","()","<p>Execute the script\n<p>@return     [String] script results (STDOUT)\n"],["sample_config","Conductor","Conductor.html#method-i-sample_config","()",""],["split_booleans","Conductor::Condition","Conductor/Condition.html#method-i-split_booleans","(condition)","<p>Splits booleans and tests components.\n<p>@param      condition  The condition to test\n<p>@return     [Boolean] …\n"],["split_condition","Conductor::Condition","Conductor/Condition.html#method-i-split_condition","(condition)","<p>Splits a natural language condition.\n<p>@param      condition  The condition @return [Array] Value, value …\n"],["stdin","Conductor","Conductor.html#method-c-stdin","()",""],["strip_time","String","String.html#method-i-strip_time","()","<p>Remove time from string\n<p>@return     [String] string with time removed\n"],["symbolize_keys","Array","Array.html#method-i-symbolize_keys","()",""],["symbolize_keys","Hash","Hash.html#method-i-symbolize_keys","()",""],["symbolize_keys!","Array","Array.html#method-i-symbolize_keys-21","()",""],["symbolize_keys!","Hash","Hash.html#method-i-symbolize_keys-21","()",""],["test_condition","Conductor::Condition","Conductor/Condition.html#method-i-test_condition","(condition)",""],["test_meta","Conductor::Condition","Conductor/Condition.html#method-i-test_meta","(content, value, key, operator)","<p>Test for MultiMarkdown metadata,\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">optionally</span> <span class=\"ruby-identifier\">key</span> <span class=\"ruby-keyword\">and</span> <span class=\"ruby-identifier\">value</span>\n</pre>\n<p>@param      content   [String] The text content …\n"],["test_operator","Conductor::Condition","Conductor/Condition.html#method-i-test_operator","(value1, value2, operator)","<p>Test operators\n<p>@param      value1    Value @param      value2    Value to test @param      operator   …\n"],["test_pandoc","Conductor::Condition","Conductor/Condition.html#method-i-test_pandoc","(content, operator)",""],["test_string","Conductor::Condition","Conductor/Condition.html#method-i-test_string","(val1, val2, operator)","<p>Compare a string based on operator\n<p>@param      val1      The string to test against @param      val2  …\n"],["test_tree","Conductor::Condition","Conductor/Condition.html#method-i-test_tree","(origin, value, operator)","<p>Test for the existince of a\n\n<pre>file/directory in the parent tree</pre>\n<p>@param      origin    Starting directory …\n"],["test_truthy","Conductor::Condition","Conductor/Condition.html#method-i-test_truthy","(value1, value2, operator)","<p>Test “truthiness”\n<p>@param      value1    Value to test against @param      value2    Value to …\n"],["test_type","Conductor::Condition","Conductor/Condition.html#method-i-test_type","(val1, val2, operator)","<p>Test for type of value\n<p>@param      val1      value @param      val2      value to test against @param …\n"],["test_yaml","Conductor::Condition","Conductor/Condition.html#method-i-test_yaml","(content, value, key, operator)","<p>Test for presence of yaml, optionall for\n\n<pre>a key, optionally for a key&#39;s value</pre>\n<p>@param      content   Text …\n"],["time?","String","String.html#method-i-time-3F","()","<p>Test a string to see if it includes a time\n<p>@return     [Boolean] test result\n"],["to_bool","String","String.html#method-i-to_bool","()","<p>Returns a bool representation of the string.\n<p>@return     [Boolean] Bool representation of the object. …\n"],["to_bool!","String","String.html#method-i-to_bool-21","()","<p>Destructive version of #to_bool\n<p>@see        #to_bool\n"],["to_date","String","String.html#method-i-to_date","()","<p>Convert a natural language string to a Date\n\n<pre class=\"ruby\"><span class=\"ruby-identifier\">object</span>\n</pre>\n<p>@return     [Date] Resulting Date object\n"],["to_day","String","String.html#method-i-to_day","(time = :end)",""],["to_s","Conductor::Env","Conductor/Env.html#method-c-to_s","()","<p>env to string\n<p>@return     [String] shell-compatible string representation of @env\n"],["true?","Conductor::Condition","Conductor/Condition.html#method-i-true-3F","()","<p>Tests condition\n<p>@return     [Boolean] test result\n"],["yaml?","String","String.html#method-i-yaml-3F","()","<p>Test if string starts with YAML\n<p>@return     [Boolean] test result\n"],["README","","README_rdoc.html","","<p>Marked Conductor\n<p>A command line tool that functions as a custom processor handler for Marked 2.\n"]]}}

data/lib/conductor/condition.rb

@@ -2,17 +2,28 @@
 
 module Conductor
   class Condition
+
+    ##
+    ## Initializes the given condition.
+    ##
+    ## @param      condition  The condition
+    ##
     def initialize(condition)
       @condition = condition
       @env = Conductor::Env.env
     end
 
+    ##
+    ## Tests condition
+    ##
+    ## @return     [Boolean] test result
+    ##
     def true?
       parse_condition
     end
 
     ##
-    ## @brief      Splits booleans and tests components.
+    ## Splits booleans and tests components.
     ##
     ## @param      condition  The condition to test
     ##
@@ -52,7 +63,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Test operators
+    ## Test operators
     ##
     ## @param      value1    Value
     ## @param      value2    Value to test
@@ -80,7 +91,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Splits a natural language condition.
+    ## Splits a natural language condition.
     ##
     ## @param      condition  The condition
     ## @return [Array] Value, value to compare, operator
@@ -105,7 +116,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Test for type of value
+    ## Test for type of value
     ##
     ## @param      val1      value
     ## @param      val2      value to test against
@@ -130,7 +141,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Compare a string based on operator
+    ## Compare a string based on operator
     ##
     ## @param      val1      The string to test against
     ## @param      val2      The value to test
@@ -194,7 +205,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Test for the existince of a
+    ## Test for the existince of a
     ##             file/directory in the parent tree
     ##
     ## @param      origin    Starting directory
@@ -219,7 +230,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Test "truthiness"
+    ## Test "truthiness"
     ##
     ## @param      value1    Value to test against
     ## @param      value2    Value to test
@@ -238,7 +249,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Test for presence of yaml, optionall for
+    ## Test for presence of yaml, optionall for
     ##             a key, optionally for a key's value
     ##
     ## @param      content   Text content containing YAML
@@ -286,7 +297,7 @@ module Conductor
     end
 
     ##
-    ## @brief      Test for MultiMarkdown metadata,
+    ## Test for MultiMarkdown metadata,
     ##             optionally key and value
     ##
     ## @param      content   [String] The text content

data/lib/conductor/env.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 module Conductor
+  # Environment variables
   module Env
+    ##
+    ## Define @env using Marked environment variables
+    ##
     def self.env
-      @env ||= if ENV["CONDUCTOR_TEST"] == "true"
+      if ENV["CONDUCTOR_TEST"] == "true"
         load_test_env
       else
         @env ||= {
@@ -23,23 +27,31 @@ module Conductor
       @env
     end
 
+    ##
+    ## Loads a test environment.
+    ##
     def self.load_test_env
       @env = {
         home: "/Users/ttscoff",
         css_path: "/Applications/Marked 2.app/Contents/Resources/swiss.css",
         ext: "md",
         includes: [],
-        origin: "/Users/ttscoff/Desktop/Code/nvultra-docs/content/",
-        filepath: "/Users/ttscoff/Desktop/Code/nvultra-docs/content/advanced-features.md",
+        origin: "/Users/ttscoff/Sites/dev/bt/source/_posts/",
+        filepath: "/Users/ttscoff/Sites/dev/bt/source/_posts/2024-04-01-automating-the-dimspirations-workflow.md",
         filename: "advanced-features.md",
         phase: "PROCESS",
         outline: "NONE",
-        path: "/Developer/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin:/Users/ttscoff/Desktop/Code/nvultra-docs/content/"
+        path: "/Developer/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin:/Users/ttscoff/Sites/dev/bt/source/_posts"
       }
     end
 
+    ##
+    ## env to string
+    ##
+    ## @return     [String] shell-compatible string representation of @env
+    ##
     def self.to_s
-      out_h = {
+      {
         "HOME" => @env[:home],
         "MARKED_CSS_PATH" => @env[:css_path],
         "MARKED_EXT" => @env[:ext],
@@ -49,8 +61,7 @@ module Conductor
         "MARKED_PHASE" => @env[:phase],
         "OUTLINE" => @env[:outline],
         "PATH" => @env[:path]
-      }
-      out_h.map { |k, v| %(#{k}="#{v}") }.join(" ")
+      }.map { |k, v| %(#{k}="#{v}") }.join(" ")
     end
   end
 end

data/lib/conductor/script.rb

@@ -5,41 +5,63 @@ module Conductor
   class Script
     attr_reader :args, :path
 
+    ##
+    ## Initializes the given script.
+    ##
+    ## @param      script  The script/path
+    ##
     def initialize(script)
       parts = Shellwords.split(script)
       self.path = parts[0]
       self.args = parts[1..].join(" ")
     end
 
+    ##
+    ## Set script path, automatically expands/tests
+    ##
+    ## @param      path  The path
+    ##
     def path=(path)
       @path = if %r{^[%/]}.match?(path)
-        File.expand_path(path)
-      else
-        script_dir = File.expand_path("~/.config/conductor/scripts")
-        if File.exist?(File.join(script_dir, path))
-          File.join(script_dir, path)
-        elsif TTY::Which.exist?(path)
-          TTY::Which.which(path)
-        else
-          raise "Path to #{path} not found"
-
-        end
-      end
+                File.expand_path(path)
+              else
+                script_dir = File.expand_path("~/.config/conductor/scripts")
+                if File.exist?(File.join(script_dir, path))
+                  File.join(script_dir, path)
+                elsif TTY::Which.exist?(path)
+                  TTY::Which.which(path)
+                else
+                  raise "Path to #{path} not found"
+
+                end
+              end
     end
 
+    ##
+    ## Set the args array
+    ##
+    ## @param      array  The array
+    ##
     def args=(array)
       @args = if array.is_a?(Array)
-        array.join(" ")
-      else
-        array
-      end
+                array.join(" ")
+              else
+                array
+              end
     end
 
+    ##
+    ## Execute the script
+    ##
+    ## @return     [String] script results (STDOUT)
+    ##
     def run
       stdin = Conductor.stdin
 
       raise "Script path not defined" unless @path
 
+      raise "Script not executable" unless File.executable?(@path)
+
       use_stdin = true
       if /\$\{?file\}?/.match?(args)
         use_stdin = false
@@ -50,9 +72,9 @@ module Conductor
       end
 
       if use_stdin
-        `echo #{Shellwords.escape(stdin)} | #{Env} #{path} #{args}`
+        `echo #{Shellwords.escape(stdin)} | #{Env} #{@path} #{@args}`
       else
-        `#{Env} #{path} #{args}`
+        `#{Env} #{@path} #{@args}`
       end
     end
   end

data/lib/conductor/string.rb

@@ -2,6 +2,11 @@
 
 # String helpers
 class ::String
+  ##
+  ## Convert a string boolean to symbol
+  ##
+  ## @return     [Symbol] symbolized version
+  ##
   def bool_to_symbol
     case self
     when /(NOT|!!)/
@@ -13,18 +18,39 @@ class ::String
     end
   end
 
+  ##
+  ## Test a string to see if it's a UTC date
+  ##
+  ## @return     [Boolean] test result
+  ##
   def date?
-    dup.force_encoding("utf-8").match?(/^\d{4}-\d{2}-\d{2}/)
+    dup.force_encoding("utf-8").match?(/^\d{4}-\d{2}-\d{2}( \d\d:\d\d)?$/)
   end
 
+  ##
+  ## Test a string to see if it includes a time
+  ##
+  ## @return     [Boolean] test result
+  ##
   def time?
     dup.force_encoding("utf-8").match(/ \d{1,2}(:\d\d)? *([ap]m)?/i)
   end
 
+  ##
+  ## Convert a natural language string to a Date
+  ##             object
+  ##
+  ## @return     [Date] Resulting Date object
+  ##
   def to_date
     Chronic.parse(dup.force_encoding("utf-8"))
   end
 
+  ##
+  ## Remove time from string
+  ##
+  ## @return     [String] string with time removed
+  ##
   def strip_time
     dup.force_encoding("utf-8").sub(/ \d{1,2}(:\d\d)? *([ap]m)?/i, "")
   end
@@ -34,22 +60,48 @@ class ::String
     Chronic.parse("#{strip_time} #{t}")
   end
 
+  ##
+  ## Test if a string is a number
+  ##
+  ## @return     [Boolean] test result
+  ##
   def number?
     to_f.positive?
   end
 
+  ##
+  ## Test if a string is a boolean
+  ##
+  ## @return     [Boolean] test result
+  ##
   def bool?
     dup.force_encoding("utf-8").match?(/^(?:y(?:es)?|no?|t(?:rue)?|f(?:alse)?)$/)
   end
 
+  ##
+  ## Test if string starts with YAML
+  ##
+  ## @return     [Boolean] test result
+  ##
   def yaml?
     dup.force_encoding('utf-8').match?(/^---/m)
   end
 
+  ##
+  ## Test if a string starts with MMD metadata
+  ##
+  ## @return     [Boolean] test result
+  ##
   def meta?
     dup.force_encoding('utf-8').match?(/^\w+: +\S+/m)
   end
 
+  ##
+  ## Destructive version of #to_bool
+  ##
+  ##
+  ## @see        #to_bool
+  ##
   def to_bool!
     replace to_bool
   end

data/lib/conductor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Conductor
-  VERSION = '1.0.10'
+  VERSION = '1.0.12'
 end

data/lib/conductor.rb

@@ -25,7 +25,7 @@ module Conductor
 
     def stdin
       warn "input on STDIN required" unless $stdin.stat.size.positive? || $stdin.fcntl(Fcntl::F_GETFL, 0).zero?
-      @stdin ||= $stdin.read.strip.force_encoding("utf-8")
+      @stdin ||= $stdin.read.force_encoding("utf-8")
     end
   end
 end