marked-conductor 1.0.13 → 1.0.14

data/html/table_of_contents.html

@@ -103,9 +103,9 @@
     <span class="container">Conductor::Env</span>
 
   <li class="method">
-    <a href="Conductor/Script.html#method-c-new">::new</a>
+    <a href="Conductor/Config.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">Conductor::Script</span>
+    <span class="container">Conductor::Config</span>
 
   <li class="method">
     <a href="Conductor/Command.html#method-c-new">::new</a>
@@ -118,14 +118,14 @@
     <span class="container">Conductor::Condition</span>
 
   <li class="method">
-    <a href="Filter.html#method-c-new">::new</a>
+    <a href="Conductor/Script.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">Filter</span>
+    <span class="container">Conductor::Script</span>
 
   <li class="method">
-    <a href="Conductor/Config.html#method-c-new">::new</a>
+    <a href="Filter.html#method-c-new">::new</a>
     &mdash;
-    <span class="container">Conductor::Config</span>
+    <span class="container">Filter</span>
 
   <li class="method">
     <a href="Conductor.html#method-c-stdin">::stdin</a>
@@ -153,9 +153,9 @@
     <span class="container">String</span>
 
   <li class="method">
-    <a href="Conductor/Command.html#method-i-args-3D">#args=</a>
+    <a href="String.html#method-i-append">#append</a>
     &mdash;
-    <span class="container">Conductor::Command</span>
+    <span class="container">String</span>
 
   <li class="method">
     <a href="Conductor/Script.html#method-i-args-3D">#args=</a>
@@ -163,20 +163,25 @@
     <span class="container">Conductor::Script</span>
 
   <li class="method">
-    <a href="String.html#method-i-bool-3F">#bool?</a>
+    <a href="Conductor/Command.html#method-i-args-3D">#args=</a>
     &mdash;
-    <span class="container">String</span>
+    <span class="container">Conductor::Command</span>
 
   <li class="method">
-    <a href="TrueClass.html#method-i-bool-3F">#bool?</a>
+    <a href="String.html#method-i-bool-3F">#bool?</a>
     &mdash;
-    <span class="container">TrueClass</span>
+    <span class="container">String</span>
 
   <li class="method">
     <a href="FalseClass.html#method-i-bool-3F">#bool?</a>
     &mdash;
     <span class="container">FalseClass</span>
 
+  <li class="method">
+    <a href="TrueClass.html#method-i-bool-3F">#bool?</a>
+    &mdash;
+    <span class="container">TrueClass</span>
+
   <li class="method">
     <a href="String.html#method-i-bool_to_symbol">#bool_to_symbol</a>
     &mdash;
@@ -212,11 +217,26 @@
     &mdash;
     <span class="container">String</span>
 
+  <li class="method">
+    <a href="String.html#method-i-get_title">#get_title</a>
+    &mdash;
+    <span class="container">String</span>
+
   <li class="method">
     <a href="String.html#method-i-has_comment-3F">#has_comment?</a>
     &mdash;
     <span class="container">String</span>
 
+  <li class="method">
+    <a href="String.html#method-i-insert_script">#insert_script</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="String.html#method-i-insert_title">#insert_title</a>
+    &mdash;
+    <span class="container">String</span>
+
   <li class="method">
     <a href="String.html#method-i-meta-3F">#meta?</a>
     &mdash;
@@ -278,14 +298,14 @@
     <span class="container">String</span>
 
   <li class="method">
-    <a href="Conductor/Script.html#method-i-run">#run</a>
+    <a href="Conductor/Command.html#method-i-run">#run</a>
     &mdash;
-    <span class="container">Conductor::Script</span>
+    <span class="container">Conductor::Command</span>
 
   <li class="method">
-    <a href="Conductor/Command.html#method-i-run">#run</a>
+    <a href="Conductor/Script.html#method-i-run">#run</a>
     &mdash;
-    <span class="container">Conductor::Command</span>
+    <span class="container">Conductor::Script</span>
 
   <li class="method">
     <a href="Conductor.html#method-i-sample_config">#sample_config</a>
@@ -318,14 +338,14 @@
     <span class="container">String</span>
 
   <li class="method">
-    <a href="Hash.html#method-i-symbolize_keys">#symbolize_keys</a>
+    <a href="Array.html#method-i-symbolize_keys">#symbolize_keys</a>
     &mdash;
-    <span class="container">Hash</span>
+    <span class="container">Array</span>
 
   <li class="method">
-    <a href="Array.html#method-i-symbolize_keys">#symbolize_keys</a>
+    <a href="Hash.html#method-i-symbolize_keys">#symbolize_keys</a>
     &mdash;
-    <span class="container">Array</span>
+    <span class="container">Hash</span>
 
   <li class="method">
     <a href="Array.html#method-i-symbolize_keys-21">#symbolize_keys!</a>
@@ -387,6 +407,16 @@
     &mdash;
     <span class="container">String</span>
 
+  <li class="method">
+    <a href="String.html#method-i-title_from_slug">#title_from_slug</a>
+    &mdash;
+    <span class="container">String</span>
+
+  <li class="method">
+    <a href="String.html#method-i-titleize">#titleize</a>
+    &mdash;
+    <span class="container">String</span>
+
   <li class="method">
     <a href="String.html#method-i-to_bool">#to_bool</a>
     &mdash;

data/lib/conductor/filter.rb

@@ -47,6 +47,73 @@ class ::String
     insert_point
   end
 
+  def append(string)
+    "#{self}\n#{string}"
+  end
+
+  def insert_script(path)
+    path.strip!
+    path = "#{path}.js" unless path =~ /\.js$/
+
+    if path =~ %r{^[~/]}
+      path = File.expand_path(path)
+    else
+      new_path = if File.directory?(File.expand_path("~/.config/conductor/javascript"))
+                   File.expand_path("~/.config/conductor/javascript/#{path}")
+                 elsif File.directory?(File.expand_path("~/.config/conductor/javascripts"))
+                   File.expand_path("~/.config/conductor/javascripts/#{path}")
+                 else
+                   File.expand_path("~/.config/conductor/scripts/#{path}")
+                 end
+
+      path = new_path if File.exist?(new_path)
+    end
+
+    %(#{self}\n<script type="javascript" src="#{path}"></script>\n)
+  end
+
+  def title_from_slug
+    filename = File.basename(Conductor::Env.env[:filepath]).sub(/\.[a-z]+$/i, "")
+    filename.sub!(/-?\d{4}-\d{2}-\d{2}-?/, "")
+    filename.sub!(/\bdot\b/, ".")
+    filename.sub!(/ dash /, "-")
+    filename
+  end
+
+  def get_title
+    title = nil
+
+    case meta_type
+    when :yaml
+      m = match(/^---.*?\n(---|\.\.\.)/m)
+      yaml = YAML.load(m[0])
+      title = yaml["title"]
+    when :mmd
+      split(/\n/).each do |line|
+        if line =~ /^ *title: *(\S.*?)$/i
+          title = Regexp.last_match(1)
+          break
+        end
+      end
+    else
+      m = match(/title: (.*?)$/i)
+      title = m ? m[0] : nil
+    end
+
+    title ||= title_from_slug.titleize
+
+    title
+  end
+
+  def insert_title
+    title = get_title
+    lines = split(/\n/)
+    insert_point = meta_insert_point
+    insert_at = insert_point.positive? ? insert_point + 1 : 0
+    lines.insert(insert_at, "# #{title}\n")
+    lines.join("\n")
+  end
+
   def set_meta(key, value, style: :comment)
     case style
     when :yaml
@@ -143,7 +210,7 @@ class ::String
   end
 
   def to_pattern
-    gsub(/\$(\d+)/, '\\\\\1').gsub(/(^["']|["']$)/, '')
+    gsub(/\$(\d+)/, '\\\\\1').gsub(/(^["']|["']$)/, "")
   end
 end
 
@@ -153,12 +220,21 @@ class Filter < String
 
   def initialize(filter)
     @filter, @params = filter.normalize_filter
+    super
   end
 
   def process
     content = Conductor.stdin
 
     case @filter
+    when /(insert|add|inject)title/
+      content.insert_title
+    when /(insert|add|inject)script/
+      content = content.append("\n\n<div>")
+      @params.each do |script|
+        content = content.insert_script(script)
+      end
+      "#{content}</div>"
     when /(add|set)meta/
       unless @params.count == 2
         warn "Invalid filter parameters: #{@filter}(#{@params.join(",")})"

data/lib/conductor/string.rb

@@ -2,6 +2,15 @@
 
 # String helpers
 class ::String
+  ##
+  ## Titlecase a string
+  ##
+  ## @return     Titleized string
+  ##
+  def titleize
+    split(/(\W)/).map(&:capitalize).join
+  end
+
   ##
   ## Convert a string boolean to symbol
   ##

data/lib/conductor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Conductor
-  VERSION = '1.0.13'
+  VERSION = '1.0.14'
 end

data/src/_README.md

@@ -23,7 +23,7 @@ If you use Homebrew, you can run
 
 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.
+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 **Marked Preferences > Advanced** and select either Custom Processor or Custom Preprocessor (or both) and paste into the **Path:** field. You can select *Automatically enable for new windows* to have the processor enabled by default when opening documents.
 
 <!--JEKYLL {% img aligncenter /uploads/2024/04/marked-preferences-conductor.jpg 593 673 "marked-preferences-conductor.jpg" %}-->
 <!--GITHUB-->![Marked preferences](images/preferences.jpg)<!--END GITHUB-->
@@ -122,13 +122,45 @@ Conditions can be combined with AND or OR (must be uppercase) and simple parenth
 
 ### Actions
 
-The action can be either `script` or `command`. 
+The action can be `script`, `command`, or `filter`. 
 
-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.
+**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.
+> Example:
+> 
+>    script: github_pre
 
-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.
+**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.
+
+> Example:
+> 
+>    command: multimarkdown
+
+
+> 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.
+
+**Filters** are simple actions that can be run on the content without having to write a separate script for it. Available filters are:
+| filter | description |
+| :----  | :---------- |
+| `setMeta(key, value)` | adds or updates a meta key, aware of YAML and MMD |
+| `stripMeta` | strips all metadata (YAML or MMD) from the content |
+| `stripMeta(key)` | removes a specific key (YAML or MMD) |
+| `setStyle(name)` | sets the Marked preview style to a preconfigured Style name
+| `replace(search, replace)` | performs a (single) search and replace on content | 
+| `replaceAll(search, replace)` | global version of `replaceAll`) |
+| `insertTitle` | adds a title to the document, either from metadata or filename |
+| `insertScript(path[,path])` | injects javascript(s) |
+
+For `insertScript`, if path is just a filename it will look for a match in `~/.config/conductor/javascript` or `~/.config/conductor/scripts` and turn that into an absolute path if the file is found.
+
+For `replace` and `replaceAll`: If *search* is surrounded with forward slashes followed by optional flags (*i* for case-insensitive, *m* to make dot match newlines), e.g. `/contribut(ing)?/i`, it will be interpreted as a regular expression. The *replace* value can include numeric capture groups, e.g. `Follow$2`.
+
+> Example:
+> 
+>    filter: setStyle(github)
+
+
+> Filters can be camel case (replaceAll) or snake case (replace_all), either will work, case insensitive.
 
 ## Custom Processors
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marked-conductor
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.0.14
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-24 00:00:00.000000000 Z
+date: 2024-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -212,6 +212,7 @@ files:
 - html/Conductor/Env.html
 - html/Conductor/Script.html
 - html/FalseClass.html
+- html/Filter.html
 - html/Hash.html
 - html/Object.html
 - html/README_rdoc.html