marked-conductor 1.0.9 → 1.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.irbrc +2 -0
- data/CHANGELOG.md +23 -0
- data/README.rdoc +1 -1
- data/bin/conductor +98 -67
- data/html/Array.html +160 -0
- data/html/Conductor/Command.html +271 -0
- data/html/Conductor/Condition.html +791 -0
- data/html/Conductor/Config.html +170 -0
- data/html/Conductor/Env.html +220 -0
- data/html/Conductor/Script.html +288 -0
- data/html/Conductor.html +355 -0
- data/html/FalseClass.html +138 -0
- data/html/Hash.html +160 -0
- data/html/Object.html +138 -0
- data/html/README_rdoc.html +86 -0
- data/html/String.html +440 -0
- data/html/TrueClass.html +138 -0
- data/html/created.rid +14 -0
- data/html/css/fonts.css +167 -0
- data/html/css/rdoc.css +687 -0
- data/html/fonts/Lato-Light.ttf +0 -0
- data/html/fonts/Lato-LightItalic.ttf +0 -0
- data/html/fonts/Lato-Regular.ttf +0 -0
- data/html/fonts/Lato-RegularItalic.ttf +0 -0
- data/html/fonts/SourceCodePro-Bold.ttf +0 -0
- data/html/fonts/SourceCodePro-Regular.ttf +0 -0
- data/html/images/add.png +0 -0
- data/html/images/arrow_up.png +0 -0
- data/html/images/brick.png +0 -0
- data/html/images/brick_link.png +0 -0
- data/html/images/bug.png +0 -0
- data/html/images/bullet_black.png +0 -0
- data/html/images/bullet_toggle_minus.png +0 -0
- data/html/images/bullet_toggle_plus.png +0 -0
- data/html/images/date.png +0 -0
- data/html/images/delete.png +0 -0
- data/html/images/find.png +0 -0
- data/html/images/loadingAnimation.gif +0 -0
- data/html/images/macFFBgHack.png +0 -0
- data/html/images/package.png +0 -0
- data/html/images/page_green.png +0 -0
- data/html/images/page_white_text.png +0 -0
- data/html/images/page_white_width.png +0 -0
- data/html/images/plugin.png +0 -0
- data/html/images/ruby.png +0 -0
- data/html/images/tag_blue.png +0 -0
- data/html/images/tag_green.png +0 -0
- data/html/images/transparent.png +0 -0
- data/html/images/wrench.png +0 -0
- data/html/images/wrench_orange.png +0 -0
- data/html/images/zoom.png +0 -0
- data/html/index.html +105 -0
- data/html/js/darkfish.js +97 -0
- data/html/js/navigation.js +105 -0
- data/html/js/navigation.js.gz +0 -0
- data/html/js/search.js +110 -0
- data/html/js/search_index.js +1 -0
- data/html/js/search_index.js.gz +0 -0
- data/html/js/searcher.js +229 -0
- data/html/js/searcher.js.gz +0 -0
- data/html/table_of_contents.html +345 -0
- data/lib/conductor/condition.rb +25 -10
- data/lib/conductor/env.rb +18 -7
- data/lib/conductor/script.rb +40 -18
- data/lib/conductor/string.rb +58 -6
- data/lib/conductor/version.rb +1 -1
- data/lib/conductor.rb +1 -0
- data/marked-conductor.gemspec +3 -3
- metadata +89 -32
@@ -0,0 +1,288 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta charset="UTF-8">
|
6
|
+
|
7
|
+
<title>class Conductor::Script - Marked Conductor</title>
|
8
|
+
|
9
|
+
<script type="text/javascript">
|
10
|
+
var rdoc_rel_prefix = "../";
|
11
|
+
var index_rel_prefix = "../";
|
12
|
+
</script>
|
13
|
+
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
15
|
+
<script src="../js/search.js" defer></script>
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
19
|
+
|
20
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
21
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
22
|
+
|
23
|
+
|
24
|
+
<body id="top" role="document" class="class">
|
25
|
+
<nav role="navigation">
|
26
|
+
<div id="project-navigation">
|
27
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
28
|
+
<h2>
|
29
|
+
<a href="../index.html" rel="home">Home</a>
|
30
|
+
</h2>
|
31
|
+
|
32
|
+
<div id="table-of-contents-navigation">
|
33
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
34
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
35
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
36
|
+
</div>
|
37
|
+
</div>
|
38
|
+
|
39
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
40
|
+
<form action="#" method="get" accept-charset="utf-8">
|
41
|
+
<div id="search-field-wrapper">
|
42
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
43
|
+
aria-autocomplete="list" aria-controls="search-results"
|
44
|
+
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
|
45
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
46
|
+
</div>
|
47
|
+
|
48
|
+
<ul id="search-results" aria-label="Search Results"
|
49
|
+
aria-busy="false" aria-expanded="false"
|
50
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
51
|
+
</form>
|
52
|
+
</div>
|
53
|
+
|
54
|
+
</div>
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
<div id="class-metadata">
|
59
|
+
|
60
|
+
|
61
|
+
<div id="parent-class-section" class="nav-section">
|
62
|
+
<h3>Parent</h3>
|
63
|
+
|
64
|
+
<p class="link"><a href="../Object.html">Object</a>
|
65
|
+
</div>
|
66
|
+
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
<!-- Method Quickref -->
|
71
|
+
<div id="method-list-section" class="nav-section">
|
72
|
+
<h3>Methods</h3>
|
73
|
+
|
74
|
+
<ul class="link-list" role="directory">
|
75
|
+
<li ><a href="#method-c-new">::new</a>
|
76
|
+
<li ><a href="#method-i-args-3D">#args=</a>
|
77
|
+
<li ><a href="#method-i-path-3D">#path=</a>
|
78
|
+
<li ><a href="#method-i-run">#run</a>
|
79
|
+
</ul>
|
80
|
+
</div>
|
81
|
+
|
82
|
+
</div>
|
83
|
+
</nav>
|
84
|
+
|
85
|
+
<main role="main" aria-labelledby="class-Conductor::Script">
|
86
|
+
<h1 id="class-Conductor::Script" class="class">
|
87
|
+
class Conductor::Script
|
88
|
+
</h1>
|
89
|
+
|
90
|
+
<section class="description">
|
91
|
+
|
92
|
+
<p><a href="Script.html"><code>Script</code></a> runner</p>
|
93
|
+
|
94
|
+
</section>
|
95
|
+
|
96
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
<section class="attribute-method-details" class="method-section">
|
101
|
+
<header>
|
102
|
+
<h3>Attributes</h3>
|
103
|
+
</header>
|
104
|
+
|
105
|
+
<div id="attribute-i-args" class="method-detail">
|
106
|
+
<div class="method-heading attribute-method-heading">
|
107
|
+
<span class="method-name">args</span><span
|
108
|
+
class="attribute-access-type">[R]</span>
|
109
|
+
</div>
|
110
|
+
|
111
|
+
<div class="method-description">
|
112
|
+
|
113
|
+
</div>
|
114
|
+
</div>
|
115
|
+
<div id="attribute-i-path" class="method-detail">
|
116
|
+
<div class="method-heading attribute-method-heading">
|
117
|
+
<span class="method-name">path</span><span
|
118
|
+
class="attribute-access-type">[R]</span>
|
119
|
+
</div>
|
120
|
+
|
121
|
+
<div class="method-description">
|
122
|
+
|
123
|
+
</div>
|
124
|
+
</div>
|
125
|
+
</section>
|
126
|
+
|
127
|
+
|
128
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
129
|
+
<header>
|
130
|
+
<h3>Public Class Methods</h3>
|
131
|
+
</header>
|
132
|
+
|
133
|
+
<div id="method-c-new" class="method-detail ">
|
134
|
+
<div class="method-header">
|
135
|
+
<div class="method-heading">
|
136
|
+
<span class="method-name">new</span><span
|
137
|
+
class="method-args">(script)</span>
|
138
|
+
<span class="method-click-advice">click to toggle source</span>
|
139
|
+
</div>
|
140
|
+
</div>
|
141
|
+
|
142
|
+
<div class="method-description">
|
143
|
+
<p>Initializes the given script.</p>
|
144
|
+
|
145
|
+
<p>@param script The script/path</p>
|
146
|
+
|
147
|
+
<div class="method-source-code" id="new-source">
|
148
|
+
<pre><span class="ruby-comment"># File lib/conductor/script.rb, line 13</span>
|
149
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">script</span>)
|
150
|
+
<span class="ruby-identifier">parts</span> = <span class="ruby-constant">Shellwords</span>.<span class="ruby-identifier">split</span>(<span class="ruby-identifier">script</span>)
|
151
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">path</span> = <span class="ruby-identifier">parts</span>[<span class="ruby-value">0</span>]
|
152
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">args</span> = <span class="ruby-identifier">parts</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">" "</span>)
|
153
|
+
<span class="ruby-keyword">end</span></pre>
|
154
|
+
</div>
|
155
|
+
</div>
|
156
|
+
|
157
|
+
|
158
|
+
</div>
|
159
|
+
|
160
|
+
</section>
|
161
|
+
|
162
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
163
|
+
<header>
|
164
|
+
<h3>Public Instance Methods</h3>
|
165
|
+
</header>
|
166
|
+
|
167
|
+
<div id="method-i-args-3D" class="method-detail ">
|
168
|
+
<div class="method-header">
|
169
|
+
<div class="method-heading">
|
170
|
+
<span class="method-name">args=</span><span
|
171
|
+
class="method-args">(array)</span>
|
172
|
+
<span class="method-click-advice">click to toggle source</span>
|
173
|
+
</div>
|
174
|
+
</div>
|
175
|
+
|
176
|
+
<div class="method-description">
|
177
|
+
<p>Set the args array</p>
|
178
|
+
|
179
|
+
<p>@param array The array</p>
|
180
|
+
|
181
|
+
<div class="method-source-code" id="args-3D-source">
|
182
|
+
<pre><span class="ruby-comment"># File lib/conductor/script.rb, line 45</span>
|
183
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">args=</span>(<span class="ruby-identifier">array</span>)
|
184
|
+
<span class="ruby-ivar">@args</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">array</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
|
185
|
+
<span class="ruby-identifier">array</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">" "</span>)
|
186
|
+
<span class="ruby-keyword">else</span>
|
187
|
+
<span class="ruby-identifier">array</span>
|
188
|
+
<span class="ruby-keyword">end</span>
|
189
|
+
<span class="ruby-keyword">end</span></pre>
|
190
|
+
</div>
|
191
|
+
</div>
|
192
|
+
|
193
|
+
|
194
|
+
</div>
|
195
|
+
|
196
|
+
<div id="method-i-path-3D" class="method-detail ">
|
197
|
+
<div class="method-header">
|
198
|
+
<div class="method-heading">
|
199
|
+
<span class="method-name">path=</span><span
|
200
|
+
class="method-args">(path)</span>
|
201
|
+
<span class="method-click-advice">click to toggle source</span>
|
202
|
+
</div>
|
203
|
+
</div>
|
204
|
+
|
205
|
+
<div class="method-description">
|
206
|
+
<p>Set script path, automatically expands/tests</p>
|
207
|
+
|
208
|
+
<p>@param path The path</p>
|
209
|
+
|
210
|
+
<div class="method-source-code" id="path-3D-source">
|
211
|
+
<pre><span class="ruby-comment"># File lib/conductor/script.rb, line 24</span>
|
212
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">path=</span>(<span class="ruby-identifier">path</span>)
|
213
|
+
<span class="ruby-ivar">@path</span> = <span class="ruby-keyword">if</span> <span class="ruby-regexp">%r{^[%/]}</span>.<span class="ruby-identifier">match?</span>(<span class="ruby-identifier">path</span>)
|
214
|
+
<span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">path</span>)
|
215
|
+
<span class="ruby-keyword">else</span>
|
216
|
+
<span class="ruby-identifier">script_dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-string">"~/.config/conductor/scripts"</span>)
|
217
|
+
<span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">script_dir</span>, <span class="ruby-identifier">path</span>))
|
218
|
+
<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">script_dir</span>, <span class="ruby-identifier">path</span>)
|
219
|
+
<span class="ruby-keyword">elsif</span> <span class="ruby-constant">TTY</span><span class="ruby-operator">::</span><span class="ruby-constant">Which</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">path</span>)
|
220
|
+
<span class="ruby-constant">TTY</span><span class="ruby-operator">::</span><span class="ruby-constant">Which</span>.<span class="ruby-identifier">which</span>(<span class="ruby-identifier">path</span>)
|
221
|
+
<span class="ruby-keyword">else</span>
|
222
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-node">"Path to #{path} not found"</span>
|
223
|
+
|
224
|
+
<span class="ruby-keyword">end</span>
|
225
|
+
<span class="ruby-keyword">end</span>
|
226
|
+
<span class="ruby-keyword">end</span></pre>
|
227
|
+
</div>
|
228
|
+
</div>
|
229
|
+
|
230
|
+
|
231
|
+
</div>
|
232
|
+
|
233
|
+
<div id="method-i-run" class="method-detail ">
|
234
|
+
<div class="method-header">
|
235
|
+
<div class="method-heading">
|
236
|
+
<span class="method-name">run</span><span
|
237
|
+
class="method-args">()</span>
|
238
|
+
<span class="method-click-advice">click to toggle source</span>
|
239
|
+
</div>
|
240
|
+
</div>
|
241
|
+
|
242
|
+
<div class="method-description">
|
243
|
+
<p>Execute the script</p>
|
244
|
+
|
245
|
+
<p>@return [String] script results (STDOUT)</p>
|
246
|
+
|
247
|
+
<div class="method-source-code" id="run-source">
|
248
|
+
<pre><span class="ruby-comment"># File lib/conductor/script.rb, line 58</span>
|
249
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">run</span>
|
250
|
+
<span class="ruby-identifier">stdin</span> = <span class="ruby-constant">Conductor</span>.<span class="ruby-identifier">stdin</span>
|
251
|
+
|
252
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-string">"Script path not defined"</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@path</span>
|
253
|
+
|
254
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-string">"Script not executable"</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">executable?</span>(<span class="ruby-ivar">@path</span>)
|
255
|
+
|
256
|
+
<span class="ruby-identifier">use_stdin</span> = <span class="ruby-keyword">true</span>
|
257
|
+
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/\$\{?file\}?/</span>.<span class="ruby-identifier">match?</span>(<span class="ruby-identifier">args</span>)
|
258
|
+
<span class="ruby-identifier">use_stdin</span> = <span class="ruby-keyword">false</span>
|
259
|
+
<span class="ruby-identifier">args</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-regexp">/\$\{?file\}?/</span>, <span class="ruby-constant">Env</span>.<span class="ruby-identifier">env</span>[<span class="ruby-value">:filepath</span>])
|
260
|
+
<span class="ruby-keyword">else</span>
|
261
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-string">"No input"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">stdin</span>
|
262
|
+
|
263
|
+
<span class="ruby-keyword">end</span>
|
264
|
+
|
265
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">use_stdin</span>
|
266
|
+
<span class="ruby-node">`echo #{Shellwords.escape(stdin)} | #{Env} #{@path} #{@args}`</span>
|
267
|
+
<span class="ruby-keyword">else</span>
|
268
|
+
<span class="ruby-node">`#{Env} #{@path} #{@args}`</span>
|
269
|
+
<span class="ruby-keyword">end</span>
|
270
|
+
<span class="ruby-keyword">end</span></pre>
|
271
|
+
</div>
|
272
|
+
</div>
|
273
|
+
|
274
|
+
|
275
|
+
</div>
|
276
|
+
|
277
|
+
</section>
|
278
|
+
|
279
|
+
</section>
|
280
|
+
</main>
|
281
|
+
|
282
|
+
|
283
|
+
<footer id="validator-badges" role="contentinfo">
|
284
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
285
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
|
286
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
287
|
+
</footer>
|
288
|
+
|
data/html/Conductor.html
ADDED
@@ -0,0 +1,355 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta charset="UTF-8">
|
6
|
+
|
7
|
+
<title>module Conductor - Marked Conductor</title>
|
8
|
+
|
9
|
+
<script type="text/javascript">
|
10
|
+
var rdoc_rel_prefix = "./";
|
11
|
+
var index_rel_prefix = "./";
|
12
|
+
</script>
|
13
|
+
|
14
|
+
<script src="./js/navigation.js" defer></script>
|
15
|
+
<script src="./js/search.js" defer></script>
|
16
|
+
<script src="./js/search_index.js" defer></script>
|
17
|
+
<script src="./js/searcher.js" defer></script>
|
18
|
+
<script src="./js/darkfish.js" defer></script>
|
19
|
+
|
20
|
+
<link href="./css/fonts.css" rel="stylesheet">
|
21
|
+
<link href="./css/rdoc.css" rel="stylesheet">
|
22
|
+
|
23
|
+
|
24
|
+
<body id="top" role="document" class="module">
|
25
|
+
<nav role="navigation">
|
26
|
+
<div id="project-navigation">
|
27
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
28
|
+
<h2>
|
29
|
+
<a href="./index.html" rel="home">Home</a>
|
30
|
+
</h2>
|
31
|
+
|
32
|
+
<div id="table-of-contents-navigation">
|
33
|
+
<a href="./table_of_contents.html#pages">Pages</a>
|
34
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
35
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
36
|
+
</div>
|
37
|
+
</div>
|
38
|
+
|
39
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
40
|
+
<form action="#" method="get" accept-charset="utf-8">
|
41
|
+
<div id="search-field-wrapper">
|
42
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
43
|
+
aria-autocomplete="list" aria-controls="search-results"
|
44
|
+
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
|
45
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
46
|
+
</div>
|
47
|
+
|
48
|
+
<ul id="search-results" aria-label="Search Results"
|
49
|
+
aria-busy="false" aria-expanded="false"
|
50
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
51
|
+
</form>
|
52
|
+
</div>
|
53
|
+
|
54
|
+
</div>
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
<div id="class-metadata">
|
59
|
+
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
|
64
|
+
<!-- Method Quickref -->
|
65
|
+
<div id="method-list-section" class="nav-section">
|
66
|
+
<h3>Methods</h3>
|
67
|
+
|
68
|
+
<ul class="link-list" role="directory">
|
69
|
+
<li ><a href="#method-c-conduct">::conduct</a>
|
70
|
+
<li ><a href="#method-c-execute_track">::execute_track</a>
|
71
|
+
<li ><a href="#method-c-stdin">::stdin</a>
|
72
|
+
<li ><a href="#method-i-create_config">#create_config</a>
|
73
|
+
<li ><a href="#method-i-sample_config">#sample_config</a>
|
74
|
+
</ul>
|
75
|
+
</div>
|
76
|
+
|
77
|
+
</div>
|
78
|
+
</nav>
|
79
|
+
|
80
|
+
<main role="main" aria-labelledby="module-Conductor">
|
81
|
+
<h1 id="module-Conductor" class="module">
|
82
|
+
module Conductor
|
83
|
+
</h1>
|
84
|
+
|
85
|
+
<section class="description">
|
86
|
+
|
87
|
+
<p>Main <a href="Conductor.html"><code>Conductor</code></a> class</p>
|
88
|
+
|
89
|
+
</section>
|
90
|
+
|
91
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
92
|
+
|
93
|
+
|
94
|
+
<section class="constants-list">
|
95
|
+
<header>
|
96
|
+
<h3>Constants</h3>
|
97
|
+
</header>
|
98
|
+
<dl>
|
99
|
+
<dt id="VERSION">VERSION
|
100
|
+
<dd>
|
101
|
+
</dl>
|
102
|
+
</section>
|
103
|
+
|
104
|
+
<section class="attribute-method-details" class="method-section">
|
105
|
+
<header>
|
106
|
+
<h3>Attributes</h3>
|
107
|
+
</header>
|
108
|
+
|
109
|
+
<div id="attribute-c-original_input" class="method-detail">
|
110
|
+
<div class="method-heading attribute-method-heading">
|
111
|
+
<span class="method-name">original_input</span><span
|
112
|
+
class="attribute-access-type">[RW]</span>
|
113
|
+
</div>
|
114
|
+
|
115
|
+
<div class="method-description">
|
116
|
+
|
117
|
+
</div>
|
118
|
+
</div>
|
119
|
+
<div id="attribute-c-stdin" class="method-detail">
|
120
|
+
<div class="method-heading attribute-method-heading">
|
121
|
+
<span class="method-name">stdin</span><span
|
122
|
+
class="attribute-access-type">[W]</span>
|
123
|
+
</div>
|
124
|
+
|
125
|
+
<div class="method-description">
|
126
|
+
|
127
|
+
</div>
|
128
|
+
</div>
|
129
|
+
</section>
|
130
|
+
|
131
|
+
|
132
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
133
|
+
<header>
|
134
|
+
<h3>Public Class Methods</h3>
|
135
|
+
</header>
|
136
|
+
|
137
|
+
<div id="method-c-conduct" class="method-detail ">
|
138
|
+
<div class="method-header">
|
139
|
+
<div class="method-heading">
|
140
|
+
<span class="method-name">conduct</span><span
|
141
|
+
class="method-args">(tracks, res = nil, condition = nil)</span>
|
142
|
+
<span class="method-click-advice">click to toggle source</span>
|
143
|
+
</div>
|
144
|
+
</div>
|
145
|
+
|
146
|
+
<div class="method-description">
|
147
|
+
<p>Main function to parse conditions and</p>
|
148
|
+
|
149
|
+
<pre>execute actions. Executes recursively for
|
150
|
+
sub-tracks.</pre>
|
151
|
+
|
152
|
+
<p>@param tracks The tracks to process @param res The current result @param condition The current condition</p>
|
153
|
+
|
154
|
+
<p>@return [Array] result, matched condition(s)</p>
|
155
|
+
|
156
|
+
<div class="method-source-code" id="conduct-source">
|
157
|
+
<pre><span class="ruby-comment"># File bin/conductor, line 56</span>
|
158
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">conduct</span>(<span class="ruby-identifier">tracks</span>, <span class="ruby-identifier">res</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">condition</span> = <span class="ruby-keyword">nil</span>)
|
159
|
+
<span class="ruby-identifier">tracks</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">track</span><span class="ruby-operator">|</span>
|
160
|
+
<span class="ruby-identifier">cond</span> = <span class="ruby-constant">Condition</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">track</span>[<span class="ruby-value">:condition</span>])
|
161
|
+
|
162
|
+
<span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">cond</span>.<span class="ruby-identifier">true?</span>
|
163
|
+
|
164
|
+
<span class="ruby-comment"># Build "matched condition" message</span>
|
165
|
+
<span class="ruby-identifier">title</span> = <span class="ruby-identifier">track</span>[<span class="ruby-value">:title</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">track</span>[<span class="ruby-value">:condition</span>]
|
166
|
+
<span class="ruby-identifier">condition</span> <span class="ruby-operator">||=</span> [<span class="ruby-string">""</span>]
|
167
|
+
<span class="ruby-identifier">condition</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">title</span>
|
168
|
+
<span class="ruby-identifier">condition</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">track</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-value">:continue</span>) <span class="ruby-operator">?</span> <span class="ruby-string">" -> "</span> <span class="ruby-operator">:</span> <span class="ruby-string">", "</span>)
|
169
|
+
|
170
|
+
<span class="ruby-identifier">res</span> = <span class="ruby-identifier">execute_track</span>(<span class="ruby-identifier">track</span>)
|
171
|
+
|
172
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">track</span>[<span class="ruby-value">:tracks</span>]
|
173
|
+
<span class="ruby-identifier">ts</span> = <span class="ruby-identifier">track</span>[<span class="ruby-value">:tracks</span>]
|
174
|
+
|
175
|
+
<span class="ruby-identifier">res</span>, <span class="ruby-identifier">condition</span> = <span class="ruby-identifier">conduct</span>(<span class="ruby-identifier">ts</span>, <span class="ruby-identifier">res</span>, <span class="ruby-identifier">condition</span>)
|
176
|
+
|
177
|
+
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">nil?</span>
|
178
|
+
<span class="ruby-keyword">end</span>
|
179
|
+
|
180
|
+
<span class="ruby-keyword">break</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">track</span>[<span class="ruby-value">:continue</span>]
|
181
|
+
<span class="ruby-keyword">end</span>
|
182
|
+
|
183
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">res</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Conductor</span>.<span class="ruby-identifier">original_input</span>
|
184
|
+
[<span class="ruby-keyword">nil</span>, <span class="ruby-string">"No change in output"</span>]
|
185
|
+
<span class="ruby-keyword">else</span>
|
186
|
+
[<span class="ruby-identifier">res</span>, <span class="ruby-identifier">condition</span>]
|
187
|
+
<span class="ruby-keyword">end</span>
|
188
|
+
<span class="ruby-keyword">end</span></pre>
|
189
|
+
</div>
|
190
|
+
</div>
|
191
|
+
|
192
|
+
|
193
|
+
</div>
|
194
|
+
|
195
|
+
<div id="method-c-execute_track" class="method-detail ">
|
196
|
+
<div class="method-header">
|
197
|
+
<div class="method-heading">
|
198
|
+
<span class="method-name">execute_track</span><span
|
199
|
+
class="method-args">(track)</span>
|
200
|
+
<span class="method-click-advice">click to toggle source</span>
|
201
|
+
</div>
|
202
|
+
</div>
|
203
|
+
|
204
|
+
<div class="method-description">
|
205
|
+
<p>Execute commands/scripts in the track</p>
|
206
|
+
|
207
|
+
<p>@param track The track</p>
|
208
|
+
|
209
|
+
<p>@return Resulting STDOUT output</p>
|
210
|
+
|
211
|
+
<div class="method-source-code" id="execute_track-source">
|
212
|
+
<pre><span class="ruby-comment"># File bin/conductor, line 17</span>
|
213
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">execute_track</span>(<span class="ruby-identifier">track</span>)
|
214
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">track</span>[<span class="ruby-value">:sequence</span>]
|
215
|
+
<span class="ruby-identifier">track</span>[<span class="ruby-value">:sequence</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">cmd</span><span class="ruby-operator">|</span>
|
216
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">cmd</span>[<span class="ruby-value">:script</span>]
|
217
|
+
<span class="ruby-identifier">script</span> = <span class="ruby-constant">Script</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">cmd</span>[<span class="ruby-value">:script</span>])
|
218
|
+
|
219
|
+
<span class="ruby-identifier">res</span> = <span class="ruby-identifier">script</span>.<span class="ruby-identifier">run</span>
|
220
|
+
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">cmd</span>[<span class="ruby-value">:command</span>]
|
221
|
+
<span class="ruby-identifier">command</span> = <span class="ruby-constant">Command</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">cmd</span>[<span class="ruby-value">:command</span>])
|
222
|
+
|
223
|
+
<span class="ruby-identifier">res</span> = <span class="ruby-identifier">command</span>.<span class="ruby-identifier">run</span>
|
224
|
+
<span class="ruby-keyword">end</span>
|
225
|
+
|
226
|
+
<span class="ruby-constant">Conductor</span>.<span class="ruby-identifier">stdin</span> = <span class="ruby-identifier">res</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">nil?</span>
|
227
|
+
<span class="ruby-keyword">end</span>
|
228
|
+
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">track</span>[<span class="ruby-value">:script</span>]
|
229
|
+
<span class="ruby-identifier">script</span> = <span class="ruby-constant">Script</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">track</span>[<span class="ruby-value">:script</span>])
|
230
|
+
|
231
|
+
<span class="ruby-constant">Conductor</span>.<span class="ruby-identifier">stdin</span> = <span class="ruby-identifier">script</span>.<span class="ruby-identifier">run</span>
|
232
|
+
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">track</span>[<span class="ruby-value">:command</span>]
|
233
|
+
<span class="ruby-identifier">command</span> = <span class="ruby-constant">Command</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">track</span>[<span class="ruby-value">:command</span>])
|
234
|
+
|
235
|
+
<span class="ruby-constant">Conductor</span>.<span class="ruby-identifier">stdin</span> = <span class="ruby-identifier">command</span>.<span class="ruby-identifier">run</span>
|
236
|
+
<span class="ruby-keyword">end</span>
|
237
|
+
|
238
|
+
<span class="ruby-constant">Conductor</span>.<span class="ruby-identifier">stdin</span>
|
239
|
+
<span class="ruby-keyword">end</span></pre>
|
240
|
+
</div>
|
241
|
+
</div>
|
242
|
+
|
243
|
+
|
244
|
+
</div>
|
245
|
+
|
246
|
+
<div id="method-c-stdin" class="method-detail ">
|
247
|
+
<div class="method-header">
|
248
|
+
<div class="method-heading">
|
249
|
+
<span class="method-name">stdin</span><span
|
250
|
+
class="method-args">()</span>
|
251
|
+
<span class="method-click-advice">click to toggle source</span>
|
252
|
+
</div>
|
253
|
+
</div>
|
254
|
+
|
255
|
+
<div class="method-description">
|
256
|
+
|
257
|
+
|
258
|
+
<div class="method-source-code" id="stdin-source">
|
259
|
+
<pre><span class="ruby-comment"># File lib/conductor.rb, line 26</span>
|
260
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">stdin</span>
|
261
|
+
<span class="ruby-identifier">warn</span> <span class="ruby-string">"input on STDIN required"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">$stdin</span>.<span class="ruby-identifier">stat</span>.<span class="ruby-identifier">size</span>.<span class="ruby-identifier">positive?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">$stdin</span>.<span class="ruby-identifier">fcntl</span>(<span class="ruby-constant">Fcntl</span><span class="ruby-operator">::</span><span class="ruby-constant">F_GETFL</span>, <span class="ruby-value">0</span>).<span class="ruby-identifier">zero?</span>
|
262
|
+
<span class="ruby-ivar">@stdin</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">$stdin</span>.<span class="ruby-identifier">read</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">"utf-8"</span>)
|
263
|
+
<span class="ruby-keyword">end</span></pre>
|
264
|
+
</div>
|
265
|
+
</div>
|
266
|
+
|
267
|
+
|
268
|
+
</div>
|
269
|
+
|
270
|
+
</section>
|
271
|
+
|
272
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
273
|
+
<header>
|
274
|
+
<h3>Public Instance Methods</h3>
|
275
|
+
</header>
|
276
|
+
|
277
|
+
<div id="method-i-create_config" class="method-detail ">
|
278
|
+
<div class="method-header">
|
279
|
+
<div class="method-heading">
|
280
|
+
<span class="method-name">create_config</span><span
|
281
|
+
class="method-args">(config_file)</span>
|
282
|
+
<span class="method-click-advice">click to toggle source</span>
|
283
|
+
</div>
|
284
|
+
</div>
|
285
|
+
|
286
|
+
<div class="method-description">
|
287
|
+
|
288
|
+
|
289
|
+
<div class="method-source-code" id="create_config-source">
|
290
|
+
<pre><span class="ruby-comment"># File lib/conductor/config.rb, line 19</span>
|
291
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_config</span>(<span class="ruby-identifier">config_file</span>)
|
292
|
+
<span class="ruby-identifier">config_dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">config_file</span>)
|
293
|
+
<span class="ruby-identifier">scripts_dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">config_dir</span>, <span class="ruby-string">"scripts"</span>))
|
294
|
+
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">config_dir</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">config_dir</span>)
|
295
|
+
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">scripts_dir</span>) <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">scripts_dir</span>)
|
296
|
+
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">config_file</span>, <span class="ruby-string">"w"</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">sample_config</span> }
|
297
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-node">"Sample config created at #{config_file}"</span>
|
298
|
+
|
299
|
+
<span class="ruby-constant">Process</span>.<span class="ruby-identifier">exit</span> <span class="ruby-value">0</span>
|
300
|
+
<span class="ruby-keyword">end</span></pre>
|
301
|
+
</div>
|
302
|
+
</div>
|
303
|
+
|
304
|
+
|
305
|
+
</div>
|
306
|
+
|
307
|
+
<div id="method-i-sample_config" class="method-detail ">
|
308
|
+
<div class="method-header">
|
309
|
+
<div class="method-heading">
|
310
|
+
<span class="method-name">sample_config</span><span
|
311
|
+
class="method-args">()</span>
|
312
|
+
<span class="method-click-advice">click to toggle source</span>
|
313
|
+
</div>
|
314
|
+
</div>
|
315
|
+
|
316
|
+
<div class="method-description">
|
317
|
+
|
318
|
+
|
319
|
+
<div class="method-source-code" id="sample_config-source">
|
320
|
+
<pre><span class="ruby-comment"># File lib/conductor/config.rb, line 30</span>
|
321
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">sample_config</span>
|
322
|
+
<span class="ruby-identifier"><<~EOCONFIG</span>
|
323
|
+
<span class="ruby-value"> tracks:
|
324
|
+
- condition: phase is pre
|
325
|
+
tracks:
|
326
|
+
- condition: tree contains .obsidian
|
327
|
+
tracks:
|
328
|
+
- condition: extension is md
|
329
|
+
script: obsidian-md-filter
|
330
|
+
- condition: extension is md
|
331
|
+
command: rdiscount $file
|
332
|
+
- condition: yaml includes comments
|
333
|
+
script: blog-processor
|
334
|
+
- condition: any
|
335
|
+
command: echo 'NOCUSTOM'
|
336
|
+
</span><span class="ruby-identifier"> EOCONFIG</span>
|
337
|
+
<span class="ruby-keyword">end</span></pre>
|
338
|
+
</div>
|
339
|
+
</div>
|
340
|
+
|
341
|
+
|
342
|
+
</div>
|
343
|
+
|
344
|
+
</section>
|
345
|
+
|
346
|
+
</section>
|
347
|
+
</main>
|
348
|
+
|
349
|
+
|
350
|
+
<footer id="validator-badges" role="contentinfo">
|
351
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
352
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
|
353
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
354
|
+
</footer>
|
355
|
+
|