marked-conductor 1.0.6 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 684cf7a82ae4cce7240617f832ce52572b0373e578aaff487fbc50b47e2f5afd
-  data.tar.gz: a6c5a9db2ee07216abd703f9ca833e4f83110b19eeba0ad993327ad2ef963623
+  metadata.gz: fc01f58de2ca4d81c45420e08128c3ae0dd3f125badce5d62a8cc568c599d202
+  data.tar.gz: ad0724664a346aea50e4467d7a492737d885b6b2916f04077a73866b3ba0e915
 SHA512:
-  metadata.gz: e47df55cfed559207ddf931b2c08b98cae32709534d2b612b6b94afd3bee3b79342a7c4dc558ca4eefc77a6e894c0e8d37bb09358275fa260c2ccaffac480235
-  data.tar.gz: 077e24abc630b9588671e2eb8b3af7736f88299063e76b5176b84b681690c81eb89532057121a795ce2c50fcf34ad3c4356f298064186e156c778f2f9fdb7184
+  metadata.gz: b812adad30a746bc2b38f302047a595796d8ec2886b503a198b1384dd570d0b61d41de1029788c95b3f6a579c98c4571bef01c00c8f866aeb6245028676ab104
+  data.tar.gz: 11f506aa92cdc7ea0c5f219b84d694615c32da729ba57dfafa0f4eb9aa258d33c69c36383d858b0d0764c03362eb7e6db0b3fe4862b441db3d326e5c5f678f36

data/.irbrc

@@ -1,3 +1,9 @@
-require_relative 'lib/conductor'
-include Conductor
+require "irb/completion"
+require_relative "lib/conductor"
 
+include Conductor # standard:disable all
+
+IRB.conf[:AUTO_INDENT] = true
+
+require "awesome_print"
+AwesomePrint.irb!

data/.rubocop.yml

@@ -3,11 +3,11 @@ AllCops:
 
 Style/StringLiterals:
   Enabled: true
-  EnforcedStyle: single_quotes
+  EnforcedStyle: double_quotes
 
 Style/StringLiteralsInInterpolation:
   Enabled: true
-  EnforcedStyle: single_quotes
+  EnforcedStyle: double_quotes
 
 Layout/LineLength:
   Max: 120

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+### 1.0.8
+
+2024-04-27 14:01
+
+#### NEW
+
+- Add sequence: key to allow running a series of scripts/commands, each piping to the next
+- Add `continue: true` for tracks to allow processing to continue after a script/command is successful
+- `filename` key for comparing to just filename (instead of full
+- Add `is a` tests for `number`, `integer`, and `float`
+- Tracks in YAML config can have a title key that will be shown in STDERR 'Conditions met:' output
+- Add `does not contain` handling for string and metadata comparisons
+
+#### IMPROVED
+
+- Allow `has yaml` or `has meta` (MultiMarkdown) as conditions
+
+#### FIXED
+
+- Use STDIN instead of reading file for conditionals
+- String tests read STDIN input, not reading the file itself, allowing for piping between multiple scripts
+
+### 1.0.7
+
+2024-04-26 11:53
+
+#### NEW
+
+- Added test for MMD metadata, either for presence of meta or for specific keys or key values
+
+#### FIXED
+
+- Remove some debugging garbage
+
 ### 1.0.6
 
 2024-04-26 11:17

data/Gemfile.lock

@@ -1,22 +1,32 @@
 PATH
   remote: .
   specs:
-    marked-conductor (1.0.5)
+    marked-conductor (1.0.8)
       chronic (~> 0.10.2)
       tty-which (~> 0.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ansi (1.5.0)
     ast (2.4.2)
     awesome_print (1.9.2)
     chronic (0.10.2)
     coderay (1.1.3)
+    diff-lcs (1.5.1)
+    docile (1.4.0)
+    gem-release (2.2.2)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     method_source (1.1.0)
+    multi_json (1.15.0)
     parallel (1.24.0)
-    parser (3.3.0.5)
+    parse_gemspec (1.0.0)
+    parse_gemspec-cli (1.0.0)
+      multi_json
+      parse_gemspec
+      thor
+    parser (3.3.1.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -27,7 +37,20 @@ GEM
     rake (13.2.1)
     regexp_parser (2.9.0)
     rexml (3.2.6)
-    rubocop (1.63.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.62.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -41,18 +64,39 @@ GEM
     rubocop-ast (1.31.2)
       parser (>= 3.3.0.4)
     ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-console (0.9.1)
+      ansi
+      simplecov
+      terminal-table
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.3.1)
     tty-which (0.5.0)
     unicode-display_width (2.5.0)
+    yard (0.9.36)
 
 PLATFORMS
   arm64-darwin-20
 
 DEPENDENCIES
   awesome_print (~> 1.9.2)
+  bundler (~> 2.0)
+  gem-release (~> 2.2)
   marked-conductor!
+  parse_gemspec-cli (~> 1.0)
   pry (~> 0.14.2)
   rake (~> 13.0)
+  rspec (~> 3.0)
   rubocop (~> 1.21)
+  simplecov (~> 0.21)
+  simplecov-console (~> 0.9)
+  yard (~> 0.9, >= 0.9.26)
 
 BUNDLED WITH
    2.2.29

data/README.md

@@ -64,6 +64,26 @@ tracks:
         command: obsidian-md-filter
 ```
 
+#### Adding a title
+
+Tracks can contain a `title` key. This is only used in the STDERR output of the track, where 'Met condition: ...' is shown for debugging. If a title is not present, the condition itself will be shown for debugging. If a title is defined, it replaces the condition in the STDERR output. This is mostly for shortening long condition strings to something more meaningful for debugging.
+
+### Sequencing
+
+A track can also contain a sequence of scripts and/or commands. STDIN will be passed into the first script/command, then the STDOUT of that will be piped to the next script/command. To do this, add a key called `sequence` that contains an array of scripts and commands:
+
+```yaml
+tracks:
+  - condition: phase is pro AND path contains README.md
+    sequence:
+      - script: strip_emoji
+      - command: rdiscount
+```
+
+A sequence can not contain nested tracks.
+
+By default, processing stops when a condition is met. If you want to continue processing after a condition is successful, add the `continue: true` to the track. This will only apply to tracks containing this key, and processing will stop when it gets to a successful condition that doesn't contain the `continue` key (or reaches the end of the tracks without another match).
+
 ### Conditions
 
 Available conditions are:
@@ -71,6 +91,7 @@ Available conditions are:
 - `extension` (or `ext`): This will test the extension of the file, e.g. `ext is md` or `ext contains task`
 - `tree contains ...`: This will test whether a given file or directory exists in any of the parent folders of the current file, starting with the current directory of the file. Example: `tree contains .obsidian` would test whether there was an `.obsidian` directory in any of the directories above the file (indicating it's within an Obsidian vault)
 - `path`: This tests just the path to the file itself, allowing conditions like `path contains _drafts` or `path does not contain _posts`.
+- `filename`: Tests only the filename, can be any string comparison (`starts with`, `is`, `contains`, etc.).
 - `phase`: Tests whether Marked is in Preprocessor or Processor phase, allowing conditions like `phase is preprocess` or `phase is process` (which can be shortened to `pre` and `pro`).
 - `text`: This tests for any string match within the text of the document being processed. This can be used with operators `starts with`, `ends with`, or `contains`, e.g. `text contains @taskpaper` or `text does not contain <!--more-->`. 
     - If the test value is surrounded by forward slashes, it will be treated as a regular expression. Regexes are always flagged as case insensitive. Use it like `text contains /@\w+/`.
@@ -82,6 +103,7 @@ Available conditions are:
     - If the YAML key is a date, it can be tested against with `before`, `after`, and `is`, and the value can be a natural language date, e.g. `yaml:date is after may 3, 2024`
     - If both the YAML key value and the test value are numbers, you can use operators `greater than` (`>`), `less than` (`<`), `equal`/`is` (`=`/`==`), and `is not equal`/`not equals` (`!=`/`!==`). Numbers will be interpreted as floats.
     - If the YAML value is a boolean, you can test with `is true` or `is not true` (or `is false`)
+- `mmd` or `meta` will test for MultiMarkdown metadata using the same formatting as `yaml` above.
 - The following keywords act as a catchall and can be used as the last track in the config to act on any documents that aren't matched by preceding rules:
     - `any`
     - `else`
@@ -114,14 +136,24 @@ All of the [capabilities and requirements](https://marked2app.com/help/Custom_Pr
 
 A script run by Conductor already knows it has the right type of file with the expected data and path, so your script can focus on just processing one file type. It's recommended to separate all of that logic you may already have written out into separate scripts and let Conductor handle the forking based on various criteria.
 
+> Custom processors **must** wait for input on STDIN. Most markdown CLIs will do this automatically, but scripts should include a call to read STDIN. This will pause the script and wait for the data to be sent. Without this, Marked will launch the script, and if it closes the pipe, it will try to write data to a closed pipe and crash immediately. This is a very difficult error to trap in Marked, so it's crucial that all scripts keep the STDIN pipe open.
+
+
 ## Tips
 
+- Config file must be valid YAML. Any value containing colons, brackets, or other special characters should be quoted, e.g. (`condition: "text contains my:text"`)
 - You can see what condition matched in Marked by opening <b>Help->Show Custom Processor Log</b> and checking the STDERR output.
-- To run [a custom processor for Bear](https://brettterpstra.com/2023/10/08/marked-and-bear/), use the condition `text contains /source: *bear/`
+- To run [a custom processor for Bear](https://brettterpstra.com/2023/10/08/marked-and-bear/), use the condition `"text contains <!-- source: bear.app -->"`
 - To run a custom processor for Obsidian, use the condition `tree contains .obsidian`
 
 ## Testing
 
+You can test conductor setups using Marked's `Help->Show Custom Processor Log`, or by running from the command line. The easiest way to test conditions is to set the track's command to `echo "meaningful definition"` and see what conditions are met when conductor is run.
+
+In Marked's Custom Processor Log, you can see both the STDOUT output and the STDERR messages. When running Conductor, the STDERR output will show what conditions were met (as well as any errors reported).
+
+### From the command line
+
 In order to test from the command line, you'll need certain environment variables set. This can be done by exporting the following variables with your own definitions, or by running conductor with all of the variables preceding the command, e.g. `$ MARKED_ORIGIN=/path/to/markdown_file.md [...] conductor`.
 
 The following need to be defined. Some can be left as empty or to defaults, such as `MARKED_INCLUDES` and `MARKED_OUTLINE`, but all need to be set to something.

data/README.rdoc

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

data/Rakefile

@@ -2,6 +2,43 @@
 
 require "bundler/gem_tasks"
 require "rubocop/rake_task"
+require "rspec/core/rake_task"
+require "rdoc/task"
+require "yard"
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb", "bin/**/*")
+  rd.title = "Marked Conductor"
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["lib/conductor/*.rb"]
+  t.options = ["--markup-provider=redcarpet", "--markup=markdown", "--no-private", "-p", "yard_templates"]
+  # t.stats_options = ['--list-undoc']
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--pattern spec/*_spec.rb"
+end
+
+task default: %i[test]
+
+desc "Alias for build"
+task package: :build
+
+task test: "spec"
+task lint: "standard"
+task format: "standard:fix"
+
+desc "Open an interactive ruby console"
+task :console do
+  require "irb"
+  require "bundler/setup"
+  require "conductor"
+  ARGV.clear
+  IRB.start
+end
 
 RuboCop::RakeTask.new
 
@@ -13,7 +50,7 @@ task package: :build
 desc "Development version check"
 task :ver do
   gver = `git ver`
-  cver = IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+  cver = IO.read(File.join(File.dirname(__FILE__), "CHANGELOG.md")).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
   res = `grep VERSION lib/conductor/version.rb`
   version = res.match(/VERSION *= *['"](\d+\.\d+\.\d+(\w+)?)/)[1]
   puts "git tag: #{gver}"

data/bin/conductor

@@ -12,38 +12,67 @@ config = Config.new
 
 stdin = Conductor.stdin
 
+def execute_track(track)
+  if track[:sequence]
+    track[:sequence].each do |cmd|
+      if cmd[:script]
+        script = Script.new(cmd[:script])
+
+        res = script.run
+      elsif cmd[:command]
+        command = Command.new(cmd[:command])
+
+        res = command.run
+      end
+
+      Conductor.stdin = res unless res.nil?
+    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])
 
     next unless cond.true?
 
-    if track[:tracks]
-      ts = track[:tracks].symbolize_keys
-
-      res, condition = conduct(ts, res, condition)
 
-      next if res.nil?
-    end
+    # Build "matched condition" message
+    title = track[:title] || track[:condition]
+    condition ||= ['']
+    condition << title
+    condition.push(track.key?(:continue) ? ', ' : ' -> ')
 
-    condition = condition.nil? ? track[:condition] : "#{track[:condition]} > #{condition}"
+    res = execute_track(track)
 
-    if track[:script]
-      script = Script.new(track[:script])
+    if track[:tracks]
+      ts = track[:tracks]
 
-      res = script.run
-    elsif track[:command]
-      command = Command.new(track[:command])
+      res, condition = conduct(ts, res, condition)
 
-      res = command.run
+      next if res.nil?
     end
 
-    break
+    break unless track[:continue]
   end
 
   [res, condition]
 end
 
+def clean_condition(condition)
+  condition.join('').sub(/ *(->|,) *$/, '')
+end
+
 options = {}
 optparse = OptionParser.new do|opts|
   opts.banner = "Called from Marked 2 as a Custom Pre/Processor"
@@ -68,7 +97,7 @@ if res.nil?
   $stderr.puts('No conditions satisfied')
   puts 'NOCUSTOM'
 else
-  $stderr.puts("Met condition: #{condition}")
+  $stderr.puts("Met condition: #{clean_condition(condition)}")
   puts res
 end
 

data/lib/conductor/array.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 class ::Array
-
   def symbolize_keys!
     replace symbolize_keys
   end

data/lib/conductor/command.rb

@@ -8,44 +8,43 @@ module Conductor
     def initialize(command)
       parts = Shellwords.split(command)
       self.path = parts[0]
-      self.args = parts[1..].join(' ')
+      self.args = parts[1..].join(" ")
     end
 
     def path=(path)
-      @path = if path =~ %r{^[%/]}
-                File.expand_path(path)
-              else
-                which = TTY::Which.which(path)
-                which || path
-              end
+      @path = if %r{^[%/]}.match?(path)
+        File.expand_path(path)
+      else
+        which = TTY::Which.which(path)
+        which || path
+      end
     end
 
     def args=(array)
       @args = if array.is_a?(Array)
-                array.join(' ')
-              else
-                array
-              end
+        array.join(" ")
+      else
+        array
+      end
     end
 
     def run
       stdin = Conductor.stdin
 
-      raise 'Command path not found' unless @path
+      raise "Command path not found" unless @path
 
       use_stdin = true
-      if args =~ /\$\{?file\}?/
+      if /\$\{?file\}?/.match?(args)
         use_stdin = false
         args.sub!(/\$\{?file\}?/, %("#{Env.env[:filepath]}"))
       else
-        raise 'No input' unless stdin
+        raise "No input" unless stdin
 
       end
 
       if use_stdin
         `echo #{Shellwords.escape(stdin)} | #{Env} #{path} #{args}`
       else
-        puts "#{Env} #{path} #{args}"
         `#{Env} #{path} #{args}`
       end
     end