marked-conductor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5d347b6741e69e739cca5e8884cc77c156e2f451297d68a47e34b0593355736
+  data.tar.gz: 8c2bf87b1a8ce9f044cde76cb734d416b70d5a7a5ff701430df0c80344ddfe58
+SHA512:
+  metadata.gz: b99b245f450a1977b77bceffa87290217465451356e0674c04f66e831c8fac450ec478c8fd25ab84ab532aa9d4a5496e9e8a6269a120d8cf4a00dcc2f6e795c9
+  data.tar.gz: d4282745b2540640262c850000e893bc7cbf545674e233982e1ff64a543546c7070b23d0240b82dfdf5ca88ad7a26f20ab1017d6b632c30ad921285657b17ad0

data/.irbrc

@@ -0,0 +1,3 @@
+require_relative 'lib/conductor'
+include Conductor
+

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### 1.0.0
+
+2024-04-25 10:51
+
+#### NEW
+
+- 1.0 release
+
+### 0.1.0
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at me@brettterpstra.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in marked-conductor.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    marked-conductor (0.1.0)
+      chronic (~> 0.10.2)
+      tty-which (~> 0.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    awesome_print (1.9.2)
+    chronic (0.10.2)
+    coderay (1.1.3)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    method_source (1.1.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rubocop (1.63.3)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.2)
+      parser (>= 3.3.0.4)
+    ruby-progressbar (1.13.0)
+    tty-which (0.5.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  awesome_print (~> 1.9.2)
+  marked-conductor!
+  pry (~> 0.14.2)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.2.29

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Brett Terpstra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,145 @@
+
+
+# Marked Conductor
+
+A "train conductor" for [Marked 2](https://marked2app.com). Conductor can be set up as a Custom Preprocessor or Custom Processor for Marked, and can run different commands and scripts based on conditions in a YAML configuration file, allowing you to have multiple processors that run based on predicates.
+
+## Installation
+
+    $ gem install marked-conductor
+
+If you run into errors, try running with the `--user-install` flag:
+
+    $ gem install --user-install marked-conductor
+
+> I've noticed lately with `asdf` that I have to run `asdf reshim` after installing gems containing binaries.
+
+If you use Homebrew, you can run 
+
+    $ brew gem install marked-conductor
+
+## Usage
+
+To use Conductor, you need to set up a configuration file in `~/.config/conductor/tracks.yaml`. Run `conductor` once to create the directory and an empty configuration. See [Configuration](#configuration) below for details on setting up your "tracks." 
+
+Once configured, you can set up conductor as a Custom Processor in Marked. Run `which conductor | pbcopy` to get the full path to the binary and copy it, then open <b>Marked Preferences > Advanced</b> and select either Custom Processor or Custom Preprocessor (or both) and paste into the <b>Path:</b> field. You can select <i>Automatically enable for new windows</i> to have the processor enabled by default when opening documents.
+
+
+![Marked preferences](images/preferences.jpg)
+
+Conductor requires that it be run from Marked 2, and won't function on the command line. This is because Marked defines special environment variables that can be used in scripts, and these won't exist when running from your shell. If you want to be able to test Conductor from the command line, see [Testing](#testing).
+
+## Configuration
+
+Configuration is done in a YAML file located at `~/.config/conductor/tracks.yaml`. Run `conductor` from the command line to generate the necessary directories and sample config file if it doesn't already exist.
+
+The top level key in the YAML file is `tracks:`. This is an array of hashes, each hash containing a `condition` and either a `script` or `command` key.
+
+A simple config would look like:
+
+```
+tracks:
+  - condition: yaml includes comments
+    script: blog-processor
+  - condition: any
+    command: echo 'NOCUSTOM'
+```
+
+This would run a script at `~/.config/conductor/scripts/blog-processor` if there was YAML present in the document and it included a key called `comments`. If not, the `condition: any` would echo `NOCUSTOM` to Marked, indicating it should skip any Custom Processor. If no condition is met, NOCUSTOM is automatically sent, so this particular example is redundant. In practice you would include a catchall processor to act as the default if no prior conditions were met.
+
+Instead of a `script` or `command`, a track can contain another `tracks` key, in which case the parent condition will branch and it will cycle through the tracks contained in the `tracks` key for the hash. `tracks` keys can be repeatedly nested to create AND conditions.
+ 
+For example, the following functions the same as `condition: phase is pre AND tree contains .obsidian AND (extension is md or extension is markdown)`:
+
+```
+tracks:
+  - condition: phase is pre
+    tracks:
+    - condition: tree contains .obsidian
+      tracks:
+      - condition: extension is md
+        command: obsidian-md-filter
+      - condition: extension is markdown
+        command: obsidian-md-filter
+```
+
+### Conditions
+
+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`.
+- `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 matches @\w+`.
+- `yaml`, `headers`, or `frontmatter` will test for YAML headers. If a `yaml:KEY` is defined, a specific YAML key will be tested for. If a value is defined with an operator, it will be tested against the value key.
+    - `yaml` tests for the presence of YAML frontmatter.
+    - `yaml:comments` tests for the presence of a `comments` key.
+    - `yaml:comments is true` tests whether `comments: true` exists.
+    - `yaml:tags contains appreview` will test whether the tags array contains `appreview`.
+    - 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`)
+- 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`
+    - `all`
+    - `true`
+    - `catchall`
+
+Available comparison operators are:
+
+- `is` or `equals` (negate with `is not` or `does not equal`) tests for equality on strings, numbers, or dates
+- `contains` or `includes` (negate with `does not contain`) tests on strings or array values
+- `begins with` (or `starts with`) or `ends with` (negate with `does not begin with`) tests on strings
+- `greater than` or `less than` (tests on numbers or dates)
+
+Conditions can be combined with AND or OR (must be uppercase) and simple parenthetical operations will work (parenthesis can not be nested). A boolean condition would look like `path contains _posts AND extension is md` or `(tree includes .obsidian AND extension is todo) OR extension is taskpaper`.
+
+### Actions
+
+The action can be either `script` or `command`. 
+
+Scripts are located in `~/.config/conductor/scripts/` and should be executable files that take input on STDIN (unless `$file` is specified in the `script` definition). If a script is defined starting with `~` or `/`, that will be interpreted as a full path to an alternate location.
+
+Commands are interpreted as shell commands. If a command exists in the `$PATH`, a full path will automatically be determined, so a command can be as simple as just `pandoc`. Add any arguments needed after the command.
+
+Using `$file` as an argument to a script or command will bypass processing of STDIN input, and instead use the value of $MARKED_PATH to read the contents of the specified file.
+
+## 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`.
+
+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.
+
+```
+HOME=$HOME
+MARKED_CSS_PATH="" # The path to CSS, can be empty
+MARKED_EXT="md" # The extension of the current file in Marked, set as needed for testing
+MARKED_INCLUDES="" # Files included in the document, can be empty
+MARKED_ORIGIN="/Users/ttscoff/notes/" # Base directory for the file being tested
+MARKED_PATH="/Users/ttscoff/notes/markdown_file.md" # Full path to Markdown file
+MARKED_PHASE="PREPROCESS" # either "PROCESS" or "PREPROCESS"
+OUTLINE="none" # Outline mode, can be "none"
+PATH=$PATH # The system $PATH variable
+```
+
+Further, input on STDIN is required, unless the script/command being matched contains `$file`, in which case $MARKED_PATH will be read and operated on. For the purpose of testing, you can use `echo` or `cat FILE` and pipe to conductor, e.g. `echo "TESTING" | conductor`.
+
+To test which conditions are being met, you can just set the `command:` for a track to `echo "meaningful message"`, where the message is something that indicates which condition(s) have passed.
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/ttscoff/marked-conductor>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ttscoff/marked-conductor/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Marked::Conductor project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ttscoff/marked-conductor/blob/main/CODE_OF_CONDUCT.md).
+

data/Rakefile

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop
+
+desc "Alias for build"
+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]
+  res = `grep VERSION lib/conductor/version.rb`
+  version = res.match(/VERSION *= *['"](\d+\.\d+\.\d+(\w+)?)/)[1]
+  puts "git tag: #{gver}"
+  puts "version.rb: #{version}"
+  puts "changelog: #{cver}"
+end
+
+desc "Changelog version check"
+task :cver do
+  puts IO.read(File.join(File.dirname(__FILE__), "CHANGELOG.md")).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+end
+
+desc "Bump incremental version number"
+task :bump, :type do |_, args|
+  args.with_defaults(type: "inc")
+  version_file = "lib/conductor/version.rb"
+  content = IO.read(version_file)
+  content.sub!(/VERSION = ["'](?<major>\d+)\.(?<minor>\d+)\.(?<inc>\d+)(?<pre>\S+)?["']/) do
+    m = Regexp.last_match
+    major = m["major"].to_i
+    minor = m["minor"].to_i
+    inc = m["inc"].to_i
+    pre = m["pre"]
+
+    case args[:type]
+    when /^maj/
+      major += 1
+      minor = 0
+      inc = 0
+    when /^min/
+      minor += 1
+      inc = 0
+    else
+      inc += 1
+    end
+
+    $stdout.puts "At version #{major}.#{minor}.#{inc}#{pre}"
+    "VERSION = '#{major}.#{minor}.#{inc}#{pre}'"
+  end
+  File.open(version_file, "w+") { |f| f.puts content }
+end

data/bin/conductor

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/conductor'
+
+# raise 'No input on STDIN' unless Conductor.stdin
+
+include Conductor
+
+config = Config.new
+
+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
+
+    condition = condition.nil? ? track[:condition] : "#{track[:condition]} > #{condition}"
+
+    if track[:script]
+      script = Script.new(track[:script])
+
+      res = script.run
+    elsif track[:command]
+      command = Command.new(track[:command])
+
+      res = command.run
+    end
+
+    break
+  end
+
+  [res, condition]
+end
+
+tracks = config.tracks
+res, condition = conduct(tracks)
+
+if res.nil?
+  $stderr.puts('No conditions satisfied')
+  puts 'NOCUSTOM'
+else
+  $stderr.puts("Met condition: #{condition}")
+  puts res
+end
+

data/lib/conductor/array.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class ::Array
+
+  def symbolize_keys!
+    replace symbolize_keys
+  end
+
+  def symbolize_keys
+    map { |h| h.symbolize_keys }
+  end
+end

data/lib/conductor/command.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Conductor
+  # Command runner
+  class Command
+    attr_reader :args, :path
+
+    def initialize(command)
+      parts = Shellwords.split(command)
+      self.path = parts[0]
+      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
+    end
+
+    def args=(array)
+      @args = if array.is_a?(Array)
+                array.join(' ')
+              else
+                array
+              end
+    end
+
+    def run
+      stdin = Conductor.stdin
+
+      raise 'Command path not found' unless @path
+
+      use_stdin = true
+      if args =~ /\$\{?file\}?/
+        use_stdin = false
+        args.sub!(/\$\{?file\}?/, %("#{Env.env[:filepath]}"))
+      else
+        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
+  end
+end