marked-conductor 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6a0da9f71e766f19edb6cb13fc27139af3934f3cdf013b0c51164cc3b20d73f
-  data.tar.gz: a0d4c8b2d37653632d8757f0704008fbc370a6edcc89c46e9f1eac8927cab9e7
+  metadata.gz: 3b5faacd380f833b615f2f848ed6f0bcb54dd955082b71228ab4f49c9e2bf0ac
+  data.tar.gz: 7c513f2fc4f75094e99ea27c48cf545ca738abe366271ec3da216f92ff0a4a5e
 SHA512:
-  metadata.gz: 5ccaa5df5811bf5433bea16f2ddc5b71c056592250b0757d83119e998a65426eaeb04e291f3b758bc0e74e64b1a6f58bcbcb59ed7a9eccdf5e58dfe26e474886
-  data.tar.gz: 340f3e73ff68f7026f169cc6c686de8dcd6651836c6b685e886e5a3c115f17b676ea889565929a6ec778ad017b914c0c796ac4e8b724fc8808288535bf5da54d
+  metadata.gz: c84b488b4cc93effd14039e59be3ea76ce4d8e0c5ab882ceb542e93d158fb82d11b5f46bfcd60d5942a265d6554107fa964bb8acafe2d9ced9e8302ea7eb10a6
+  data.tar.gz: 7e80a80708878d3ab4dbc515d5554c77af6bdd42b8ceb496c2b16bb48b054ea8696aa57351eeae0a35adb3de00ef2dce6c509e77c850aa8ebb4a71c2d672a4f2

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+### 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
+
+#### FIXED
+
+- Always wait for STDIN or Marked will crash. Still possible to use $file in script/command values
+- More string encoding fixes
+- "path contains" was returning $PATH instead of the filepath
+
 ### 1.0.5
 
 2024-04-25 17:00

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    marked-conductor (0.1.0)
+    marked-conductor (1.0.5)
       chronic (~> 0.10.2)
       tty-which (~> 0.5.0)
 

data/README.md

@@ -38,7 +38,7 @@ The top level key in the YAML file is `tracks:`. This is an array of hashes, eac
 
 A simple config would look like:
 
-```
+```yaml
 tracks:
   - condition: yaml includes comments
     script: blog-processor
@@ -52,7 +52,7 @@ Instead of a `script` or `command`, a track can contain another `tracks` key, in
  
 For example, the following functions the same as `condition: phase is pre AND tree contains .obsidian AND (extension is md or extension is markdown)`:
 
-```
+```yaml
 tracks:
   - condition: phase is pre
     tracks:
@@ -70,7 +70,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 itself, allowing conditions like `path contains _drafts` or `path does not contain _posts`.
+- `path`: This tests just the path to the file itself, allowing conditions like `path contains _drafts` or `path does not contain _posts`.
 - `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 +82,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`.
 - 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,6 +115,13 @@ 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.
 
+## 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.app -->"`
+- To run a custom processor for Obsidian, use the condition `tree contains .obsidian`
+
 ## Testing
 
 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`.

data/bin/conductor

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require_relative '../lib/conductor'
+require 'optparse'
 
 # raise 'No input on STDIN' unless Conductor.stdin
 
@@ -9,6 +10,8 @@ include Conductor
 
 config = Config.new
 
+stdin = Conductor.stdin
+
 def conduct(tracks, res = nil, condition = nil)
   tracks.each do |track|
     cond = Condition.new(track[:condition])
@@ -41,6 +44,23 @@ def conduct(tracks, res = nil, condition = nil)
   [res, condition]
 end
 
+options = {}
+optparse = OptionParser.new do|opts|
+  opts.banner = "Called from Marked 2 as a Custom Pre/Processor"
+
+  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
+    puts opts
+    exit
+  end
+end
+
+optparse.parse!
+
 tracks = config.tracks
 res, condition = conduct(tracks)
 

data/lib/conductor/command.rb

@@ -45,7 +45,6 @@ module Conductor
       if use_stdin
         `echo #{Shellwords.escape(stdin)} | #{Env} #{path} #{args}`
       else
-        puts "#{Env} #{path} #{args}"
         `#{Env} #{path} #{args}`
       end
     end

data/lib/conductor/condition.rb

@@ -150,7 +150,7 @@ module Conductor
     end
 
     def test_truthy(value1, value2, operator)
-      return false unless value2.bool?
+      return false unless value2&.bool?
 
       value2 = value2.to_bool if value2.is_a?(String)
 
@@ -159,6 +159,59 @@ module Conductor
       operator == :not_equal ? !res : res
     end
 
+    def test_yaml(content, value, key, operator)
+      yaml = YAML.safe_load(content.split(/^(?:---|\.\.\.)/)[1])
+
+      return operator == :not_equal ? true : false unless yaml
+
+      if key
+        value1 = yaml[key]
+        return operator == :not_equal ? true : false if value1.nil?
+
+        value1 = value1.join(',') if value1.is_a?(Array)
+        if %i[type_of not_type_of].include?(operator)
+          test_type(value1, value, operator)
+        elsif value1.bool?
+          test_truthy(value1, value, operator)
+        elsif value1.number? && value2.number? && %i[gt lt equal not_equal].include?(operator)
+          test_operator(value1, value, operator)
+        else
+          test_string(value1, value, operator)
+        end
+      else
+        res = value ? yaml.key?(value) : true
+        operator == :not_equal ? !res : res
+      end
+    end
+
+    def test_meta(content, value, key, operator)
+      headers = []
+      content.split(/\n/).each do |line|
+        break if line == /^ *\n$/ || line !~ /\w+: *\S/
+
+        headers << line
+      end
+
+      return operator == :not_equal if headers.empty?
+
+      return operator != :not_equal if value.nil?
+
+      meta = {}
+      headers.each do |h|
+        parts = h.split(/ *: */)
+        k = parts[0].strip.downcase.gsub(/ +/, '')
+        v = parts[1..].join(':').strip
+        meta[k] = v
+      end
+
+      if key
+        test_string(meta[key], value, operator)
+      else
+        res = value ? meta.key?(value) : true
+        operator == :not_equal ? !res : res
+      end
+    end
+
     def test_condition(condition)
       type, value, operator = split_condition(condition)
 
@@ -177,35 +230,27 @@ module Conductor
       when /^tree/i
         test_tree(@env[:origin], value, operator)
       when /^(path|dir)/i
-        test_string(@env[:origin], value, operator) ? true : false
+        test_string(@env[:filepath], value, operator) ? true : false
       when /^phase/i
         test_string(@env[:phase], value, :starts_with) ? true : false
       when /^text/i
-        test_string(IO.read(@env[:filepath]), value, operator) ? true : false
+        test_string(IO.read(@env[:filepath]).force_encoding('utf-8'), value, operator) ? true : false
       when /^(yaml|headers|frontmatter)(?::(.*?))?$/i
         m = Regexp.last_match
+
+        key = m[2] || nil
+
         content = IO.read(@env[:filepath]).force_encoding('utf-8')
-        return false unless content =~ /^---/
-
-        yaml = YAML.safe_load(content.split(/^(?:---|\.\.\.)/)[1])
-
-        return false unless yaml
-        if m[2]
-          value1 = yaml[m[2]]
-          value1 = value1.join(',') if value1.is_a?(Array)
-          if %i[type_of not_type_of].include?(operator)
-            test_type(value1, value, operator)
-          elsif value1.bool?
-            test_truthy(value1, value, operator)
-          elsif value1.number? && value2.number? && %i[gt lt equal not_equal].include?(operator)
-            test_operator(value1, value, operator)
-          else
-            test_string(value1, value, operator)
-          end
-        else
-          res = value? ? yaml.key?(value) : true
-          operator == :not_equal ? !res : res
-        end
+
+        content.yaml? ? test_yaml(content, value, key, operator) : false
+      when /^(mmd|meta(?:data)?)(?::(.*?))?$/i
+        m = Regexp.last_match
+
+        key = m[2] || nil
+
+        content = IO.read(@env[:filepath]).force_encoding('utf-8')
+
+        content.meta? ? test_meta(content, value, key, operator) : false
       else
         false
       end

data/lib/conductor/env.rb

@@ -28,8 +28,8 @@ module Conductor
         css_path: '/Applications/Marked 2.app/Contents/Resources/swiss.css',
         ext: 'md',
         includes: [],
-        origin: '/Users/ttscoff/Dropbox/Writing/brettterpstra.com/_drafts/',
-        filepath: '/Users/ttscoff/Dropbox/Writing/brettterpstra.com/_drafts/marked-2-and-obsidian.md',
+        origin: '/Users/ttscoff/Desktop/Code/marked-conductor/',
+        filepath: '/Users/ttscoff/Desktop/Code/marked-conductor/README.md',
         phase: 'PREPROCESS',
         outline: 'NONE',
         path: '/Developer/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin:/Users/ttscoff/Dropbox/Writing/brettterpstra.com/_drafts/'

data/lib/conductor/string.rb

@@ -42,6 +42,14 @@ class ::String
     dup.force_encoding('utf-8').match(/^(?:y(?:es)?|no?|t(?:rue)?|f(?:alse)?)$/) ? true : false
   end
 
+  def meta?
+    self =~ /^---/m
+  end
+
+  def yaml?
+    self =~ /^\w+: +\S+/m
+  end
+
   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.5'
+  VERSION = '1.0.7'
 end

data/lib/conductor.rb

@@ -7,6 +7,7 @@ require 'fcntl'
 require 'time'
 require 'chronic'
 require 'fileutils'
+require_relative 'conductor/version'
 require_relative 'conductor/env'
 require_relative 'conductor/config'
 require_relative 'conductor/hash'
@@ -20,7 +21,8 @@ require_relative 'conductor/condition'
 module Conductor
   class << self
     def stdin
-      @stdin ||= $stdin.read.strip.force_encoding('utf-8') if $stdin.stat.size.positive? || $stdin.fcntl(Fcntl::F_GETFL, 0).zero?
+      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')
     end
   end
 end

data/src/_README.md

@@ -38,7 +38,7 @@ The top level key in the YAML file is `tracks:`. This is an array of hashes, eac
 
 A simple config would look like:
 
-```
+```yaml
 tracks:
   - condition: yaml includes comments
     script: blog-processor
@@ -52,7 +52,7 @@ Instead of a `script` or `command`, a track can contain another `tracks` key, in
  
 For example, the following functions the same as `condition: phase is pre AND tree contains .obsidian AND (extension is md or extension is markdown)`:
 
-```
+```yaml
 tracks:
   - condition: phase is pre
     tracks:
@@ -70,7 +70,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 itself, allowing conditions like `path contains _drafts` or `path does not contain _posts`.
+- `path`: This tests just the path to the file itself, allowing conditions like `path contains _drafts` or `path does not contain _posts`.
 - `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 +82,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`.
 - 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,6 +115,13 @@ 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.
 
+## 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.app -->"`
+- To run a custom processor for Obsidian, use the condition `tree contains .obsidian`
+
 ## Testing
 
 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`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marked-conductor
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2024-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry