marked-conductor 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9a26a3ab2e4ec5e86b55290f01f7af7d00ef589e74192550c36c37c2faa256
-  data.tar.gz: 0d2bd24779518b49d29c40e1b0f8936c15f040219abccca6341d80a89618e99b
+  metadata.gz: 7109f39eebaf5360cade0f07a0c9be229bef19f5ebd70aeac9cee944fbfd545a
+  data.tar.gz: abbe3d27d472dfbf3798b5a52399a51d156c58fe0c4baffa5e07613770446fb2
 SHA512:
-  metadata.gz: dec71a5077f59b7c4129dafa5fd74bf0dc093117b37b3cd6bd48e3f32693ed7a2f193e7f5f05334f9bb4e1f941337996ec73059143fe67041bdcb06c4148e01a
-  data.tar.gz: b2b2772e94096709bf4cb212f800789a37425edcb508e766ba21571521bcfd987a224d14ce8cf134c3afa43c49932bba81ea8e354f0f905ec5d0bf420adf87f5
+  metadata.gz: fc0d62a40dbd605af1af7a06144b9f0a598c1187a7892f3d3ec2d3cd56685e97900b64ee56c56d9d4fb8a3caedad9dcb2691b013214cdf35cfd806bad684ba08
+  data.tar.gz: 32040939e175a7e287c9c1fb9f8fc63e33fe0af4450a2f5d801a85f2f668046ceb157c265aaab38dfb553fcf917345a1062d3910716c188f2f5b25ad3baf37fb

data/.irbrc

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "irb/completion"
 require_relative "lib/conductor"
 

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### 1.0.10
+
+2024-04-28 14:05
+
+#### IMPROVED
+
+- Return NOCUSTOM if changes are not made by scripts/commands, even though condition was matched
+- Use YAML.load instead of .safe_load to allow more flexibility
+- Trap errors reading YAML and fail gracefully
+
+#### FIXED
+
+- Encoding errors on string methods
+
 ### 1.0.9
 
 2024-04-27 16:00

data/README.rdoc

@@ -1,4 +1,4 @@
-= Marked Commander
+= Marked Conductor
 
 A command line tool that functions as a custom processor handler for Marked 2.
 

data/bin/conductor

@@ -1,88 +1,82 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env ruby -W1
 # frozen_string_literal: true
 
-require_relative '../lib/conductor'
-require 'optparse'
+require_relative "../lib/conductor"
+require "optparse"
 
-# raise 'No input on STDIN' unless Conductor.stdin
+module Conductor
+  class << self
+    def execute_track(track)
+      if track[:sequence]
+        track[:sequence].each do |cmd|
+          if cmd[:script]
+            script = Script.new(cmd[:script])
 
-include Conductor
+            res = script.run
+          elsif cmd[:command]
+            command = Command.new(cmd[:command])
 
-config = Config.new
+            res = command.run
+          end
 
-stdin = Conductor.stdin
+          Conductor.stdin = res unless res.nil?
+        end
+      elsif track[:script]
+        script = Script.new(track[:script])
 
-def execute_track(track)
-  if track[:sequence]
-    track[:sequence].each do |cmd|
-      if cmd[:script]
-        script = Script.new(cmd[:script])
+        Conductor.stdin = script.run
+      elsif track[:command]
+        command = Command.new(track[:command])
 
-        res = script.run
-      elsif cmd[:command]
-        command = Command.new(cmd[:command])
-
-        res = command.run
+        Conductor.stdin = command.run
       end
 
-      Conductor.stdin = res unless res.nil?
+      Conductor.stdin
     end
-  elsif track[:script]
-    script = Script.new(track[:script])
-
-    Conductor.stdin = script.run
-  elsif track[:command]
-    command = Command.new(track[:command])
 
-    Conductor.stdin = command.run
-  end
-
-  Conductor.stdin
-end
+    def conduct(tracks, res = nil, condition = nil)
+      tracks.each do |track|
+        cond = Condition.new(track[:condition])
 
-def conduct(tracks, res = nil, condition = nil)
-  tracks.each do |track|
-    cond = Condition.new(track[:condition])
+        next unless cond.true?
 
-    next unless cond.true?
+        # Build "matched condition" message
+        title = track[:title] || track[:condition]
+        condition ||= [""]
+        condition << title
+        condition.push(track.key?(:continue) ? ", " : " -> ")
 
+        res = execute_track(track)
 
-    # Build "matched condition" message
-    title = track[:title] || track[:condition]
-    condition ||= ['']
-    condition << title
-    condition.push(track.key?(:continue) ? ', ' : ' -> ')
+        if track[:tracks]
+          ts = track[:tracks]
 
-    res = execute_track(track)
+          res, condition = conduct(ts, res, condition)
 
-    if track[:tracks]
-      ts = track[:tracks]
+          next if res.nil?
+        end
 
-      res, condition = conduct(ts, res, condition)
+        break unless track[:continue]
+      end
 
-      next if res.nil?
+      if res == Conductor.original_input
+        [nil, "No change in output"]
+      else
+        [res, condition]
+      end
     end
-
-    break unless track[:continue]
   end
-
-  [res, condition]
 end
 
-def clean_condition(condition)
-  condition.join('').sub(/ *(->|,) *$/, '')
-end
-
-options = {}
-optparse = OptionParser.new do|opts|
+optparse = OptionParser.new do |opts|
   opts.banner = "Called from Marked 2 as a Custom Pre/Processor"
 
-  opts.on('-v', '--version', 'Show version number') do
+  opts.on("-v", "--version", "Show version number") do
     puts "conductor v#{Conductor::VERSION}"
     Process.exit 0
   end
 
-  opts.on('-h', '--help', 'Display this screen') do
+  opts.on("-h", "--help", "Display this screen") do
     puts opts
     exit
   end
@@ -90,14 +84,27 @@ end
 
 optparse.parse!
 
+config = Conductor::Config.new
+
+Conductor.stdin
+Conductor.original_input = Conductor.stdin
+
 tracks = config.tracks
-res, condition = conduct(tracks)
+res, condition = Conductor.conduct(tracks)
+
+def clean_condition(condition)
+  condition.join("").sub(/ *(->|,) *$/, "")
+end
 
 if res.nil?
-  $stderr.puts('No conditions satisfied')
-  puts 'NOCUSTOM'
+  warn "No conditions satisfied"
+  puts "NOCUSTOM"
 else
-  $stderr.puts("Met condition: #{clean_condition(condition)}")
-  puts res
+  if res == Conductor.original_input
+    warn "No change in output"
+    puts "NOCUSTOM"
+  else
+    warn "Met condition: #{clean_condition(condition)}"
+    puts res
+  end
 end
-

data/html/Array.html

@@ -0,0 +1,160 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Array - Marked Conductor</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+
+<script src="./js/navigation.js" defer></script>
+<script src="./js/search.js" defer></script>
+<script src="./js/search_index.js" defer></script>
+<script src="./js/searcher.js" defer></script>
+<script src="./js/darkfish.js" defer></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    
+<div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  <p class="link"><a href="Object.html">Object</a>
+</div>
+
+    
+    
+    
+<!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    <li ><a href="#method-i-symbolize_keys">#symbolize_keys</a>
+    <li ><a href="#method-i-symbolize_keys-21">#symbolize_keys!</a>
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Array">
+  <h1 id="class-Array" class="class">
+    class Array
+  </h1>
+
+  <section class="description">
+    
+  </section>
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+
+
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Instance Methods</h3>
+       </header>
+
+      <div id="method-i-symbolize_keys" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">symbolize_keys</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          
+
+          <div class="method-source-code" id="symbolize_keys-source">
+            <pre><span class="ruby-comment"># File lib/conductor/array.rb, line 8</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">symbolize_keys</span>
+  <span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">h</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>.<span class="ruby-identifier">symbolize_keys</span> }
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+      <div id="method-i-symbolize_keys-21" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">symbolize_keys!</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          
+
+          <div class="method-source-code" id="symbolize_keys-21-source">
+            <pre><span class="ruby-comment"># File lib/conductor/array.rb, line 4</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">symbolize_keys!</span>
+  <span class="ruby-identifier">replace</span> <span class="ruby-identifier">symbolize_keys</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+    </section>
+
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+

data/html/Conductor/Command.html

@@ -0,0 +1,271 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>class Conductor::Command - Marked Conductor</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+  var index_rel_prefix = "../";
+</script>
+
+<script src="../js/navigation.js" defer></script>
+<script src="../js/search.js" defer></script>
+<script src="../js/search_index.js" defer></script>
+<script src="../js/searcher.js" defer></script>
+<script src="../js/darkfish.js" defer></script>
+
+<link href="../css/fonts.css" rel="stylesheet">
+<link href="../css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" role="document" class="class">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="../index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="../table_of_contents.html#pages">Pages</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+
+  <div id="class-metadata">
+    
+    
+<div id="parent-class-section" class="nav-section">
+  <h3>Parent</h3>
+
+  <p class="link"><a href="../Object.html">Object</a>
+</div>
+
+    
+    
+    
+<!-- Method Quickref -->
+<div id="method-list-section" class="nav-section">
+  <h3>Methods</h3>
+
+  <ul class="link-list" role="directory">
+    <li ><a href="#method-c-new">::new</a>
+    <li ><a href="#method-i-args-3D">#args=</a>
+    <li ><a href="#method-i-path-3D">#path=</a>
+    <li ><a href="#method-i-run">#run</a>
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-labelledby="class-Conductor::Command">
+  <h1 id="class-Conductor::Command" class="class">
+    class Conductor::Command
+  </h1>
+
+  <section class="description">
+    
+<p><a href="Command.html"><code>Command</code></a> runner</p>
+
+  </section>
+
+  <section id="5Buntitled-5D" class="documentation-section">
+
+
+
+    <section class="attribute-method-details" class="method-section">
+      <header>
+        <h3>Attributes</h3>
+      </header>
+
+      <div id="attribute-i-args" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">args</span><span
+            class="attribute-access-type">[R]</span>
+        </div>
+
+        <div class="method-description">
+        
+        </div>
+      </div>
+      <div id="attribute-i-path" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">path</span><span
+            class="attribute-access-type">[R]</span>
+        </div>
+
+        <div class="method-description">
+        
+        </div>
+      </div>
+    </section>
+
+
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Class Methods</h3>
+       </header>
+
+      <div id="method-c-new" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">new</span><span
+              class="method-args">(command)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          
+
+          <div class="method-source-code" id="new-source">
+            <pre><span class="ruby-comment"># File lib/conductor/command.rb, line 8</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">command</span>)
+  <span class="ruby-identifier">parts</span> = <span class="ruby-constant">Shellwords</span>.<span class="ruby-identifier">split</span>(<span class="ruby-identifier">command</span>)
+  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">path</span> = <span class="ruby-identifier">parts</span>[<span class="ruby-value">0</span>]
+  <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">&quot; &quot;</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+    </section>
+
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
+       <header>
+         <h3>Public Instance Methods</h3>
+       </header>
+
+      <div id="method-i-args-3D" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">args=</span><span
+              class="method-args">(array)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          
+
+          <div class="method-source-code" id="args-3D-source">
+            <pre><span class="ruby-comment"># File lib/conductor/command.rb, line 23</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">args=</span>(<span class="ruby-identifier">array</span>)
+  <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>)
+    <span class="ruby-identifier">array</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot; &quot;</span>)
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-identifier">array</span>
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+      <div id="method-i-path-3D" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">path=</span><span
+              class="method-args">(path)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          
+
+          <div class="method-source-code" id="path-3D-source">
+            <pre><span class="ruby-comment"># File lib/conductor/command.rb, line 14</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">path=</span>(<span class="ruby-identifier">path</span>)
+  <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>)
+    <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">path</span>)
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-identifier">which</span> = <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>)
+    <span class="ruby-identifier">which</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">path</span>
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+      <div id="method-i-run" class="method-detail ">
+        <div class="method-header">
+          <div class="method-heading">
+            <span class="method-name">run</span><span
+              class="method-args">()</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+        </div>
+
+        <div class="method-description">
+          
+
+          <div class="method-source-code" id="run-source">
+            <pre><span class="ruby-comment"># File lib/conductor/command.rb, line 31</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">run</span>
+  <span class="ruby-identifier">stdin</span> = <span class="ruby-constant">Conductor</span>.<span class="ruby-identifier">stdin</span>
+
+  <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Command path not found&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@path</span>
+
+  <span class="ruby-identifier">use_stdin</span> = <span class="ruby-keyword">true</span>
+  <span class="ruby-keyword">if</span> <span class="ruby-regexp">/\$\{?file\}?/</span>.<span class="ruby-identifier">match?</span>(<span class="ruby-identifier">args</span>)
+    <span class="ruby-identifier">use_stdin</span> = <span class="ruby-keyword">false</span>
+    <span class="ruby-identifier">args</span>.<span class="ruby-identifier">sub!</span>(<span class="ruby-regexp">/\$\{?file\}?/</span>, <span class="ruby-node">%(&quot;#{Env.env[:filepath]}&quot;)</span>)
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;No input&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">stdin</span>
+
+  <span class="ruby-keyword">end</span>
+
+  <span class="ruby-keyword">if</span> <span class="ruby-identifier">use_stdin</span>
+    <span class="ruby-node">`echo #{Shellwords.escape(stdin)} | #{Env} #{path} #{args}`</span>
+  <span class="ruby-keyword">else</span>
+    <span class="ruby-node">`#{Env} #{path} #{args}`</span>
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div>
+        </div>
+
+
+      </div>
+
+    </section>
+
+  </section>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+