marked-conductor 1.0.27 → 1.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab841b7eae48110c76bd6b8b8d86f8f02ddbff220672d80b40e89410c473f9e4
-  data.tar.gz: c077fa6c66ebad09df4047fc66f5a28b0202045d530de04dad338b707607ba9a
+  metadata.gz: 25fca33d78a755b6ab7b9dc4003d842723ca9b1a5eabb4357f665f91480e08cc
+  data.tar.gz: b75c35f4db0f8d96a8a62e7636ff3f268918f85aa98fd133d30621c16dc58ce1
 SHA512:
-  metadata.gz: cfe5a81efc6edf85876b749756fe175c7c6bfe272958c842e19a4f795f8a6339ff4ed32373a339e9921917902d4a589ad5cf3c5bd1f2f8a265c4e2b17326c849
-  data.tar.gz: 11344262daf5b09c48c7304267c3294125daa65e3e2f98c1e50dbc809bf6981e538304b7229208e9bd7a06bed67804ab2fb575d8105802243ca7c4d048049f8c
+  metadata.gz: 4bdd6b152729410fbd5f6752672169a41cdeab264f9b21ae8796eced90dcff3334817dd51038f8732ff6e9d5856776872b3d9cdcaf87898a74c405e8ce99a3a7
+  data.tar.gz: f26b8b7c39db572313b95b83fce5ac49cbd950171034a1bc99a092c62cc0104b1d28eb78e3dbdfa4c44bd1f54f90a4c0d79e0ea9173020fcc4e7e1ab1131eb0f

data/.irbrc

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

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+### 1.0.29
+
+2024-07-28 09:57
+
+#### NEW
+
+- Increase/decreaseHeaders(count) filter
+
+### 1.0.28
+
+2024-07-27 14:54
+
+#### IMPROVED
+
+- Code cleanup, fix for IRB
+- Switch to using #size for character counting
+- Begin adding test suite, fixing bugs as found
+
 ### 1.0.27
 
 2024-07-24 13:55

data/Gemfile

@@ -8,3 +8,4 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rubocop", "~> 1.21"
+gem "rspec", "~> 3.13"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    marked-conductor (1.0.25)
+    marked-conductor (1.0.28)
       chronic (~> 0.10.2)
       tty-which (~> 0.5.0)
 
@@ -43,10 +43,10 @@ GEM
       rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
@@ -93,7 +93,7 @@ DEPENDENCIES
   parse_gemspec-cli (~> 1.0)
   pry (~> 0.14.2)
   rake (~> 13.0)
-  rspec (~> 3.0)
+  rspec (~> 3.13)
   rubocop (~> 1.21)
   simplecov (~> 0.21)
   simplecov-console (~> 0.9)

data/README.md

@@ -167,6 +167,8 @@ The action can be `script`, `command`, or `filter`.
 | `insertCSS(path)` | insert custom CSS into document |
 | `autoLink()` | Turn bare URLs into \<self-linked\> urls |
 | `fixHeaders()` | Reorganize headline levels to semantic order |
+| `increaseHeaders(count) | Increase header levels by count (default 1) |
+| `decreaseHeaders(count) | Decrease header levels by count (default 1) |
 
 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`.
 

data/bin/conductor

@@ -4,97 +4,6 @@
 require_relative "../lib/conductor"
 require "optparse"
 
-# Main Conductor class
-module Conductor
-  class << self
-    ##
-    ## Execute commands/scripts in the track
-    ##
-    ## @param      track  The track
-    ##
-    ## @return     Resulting STDOUT output
-    ##
-    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
-          elsif cmd[:filter]
-            filter = Filter.new(cmd[:filter])
-
-            res = filter.process
-          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
-      elsif track[:filter]
-        filter = Filter.new(track[:filter])
-
-        Conductor.stdin = filter.process
-      end
-
-      Conductor.stdin
-    end
-
-    ##
-    ## Main function to parse conditions and
-    ##             execute actions. Executes recursively for
-    ##             sub-tracks.
-    ##
-    ## @param      tracks     The tracks to process
-    ## @param      res        The current result
-    ## @param      condition  The current condition
-    ##
-    ## @return     [Array] result, matched condition(s)
-    ##
-    def conduct(tracks, res = nil, condition = nil)
-      tracks.each do |track|
-        cond = Condition.new(track[:condition])
-
-        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)
-
-        if track[:tracks]
-          ts = track[:tracks]
-
-          res, condition = conduct(ts, res, condition)
-
-          next if res.nil?
-        end
-
-        break unless track[:continue]
-      end
-
-      if res == Conductor.original_input
-        [nil, "No change in output"]
-      else
-        [res, condition]
-      end
-    end
-  end
-end
-
 optparse = OptionParser.new do |opts|
   opts.banner = "Called from Marked 2 as a Custom Pre/Processor"
 
@@ -112,6 +21,9 @@ end
 optparse.parse!
 
 config = Conductor::Config.new
+res = config.configure
+
+Process.exit 0 unless res
 
 Conductor.stdin
 Conductor.original_input = Conductor.stdin
@@ -132,12 +44,10 @@ if res.nil?
   warn "No conditions satisfied"
   # puts Conductor::Env
   puts "NOCUSTOM"
+elsif res == Conductor.original_input
+  warn "No change in output"
+  puts "NOCUSTOM"
 else
-  if res == Conductor.original_input
-    warn "No change in output"
-    puts "NOCUSTOM"
-  else
-    warn "Met condition: #{clean_condition(condition)}"
-    puts res
-  end
+  warn "Met condition: #{clean_condition(condition)}"
+  puts res
 end

data/lib/conductor/array.rb

@@ -1,22 +1,48 @@
 # frozen_string_literal: true
 
+# Array helpers
 class ::Array
+  ##
+  ## Destructive version of #symbolize_keys
+  ##
+  ## @see #symbolize_keys
+  ##
+  ## @return     [Array] symbolized arrays
+  ##
   def symbolize_keys!
     replace symbolize_keys
   end
 
+  ##
+  ## Symbolize the keys of an array of hashes
+  ##
+  ## @return     [Array] array of hashes with keys converted to symbols
+  ##
   def symbolize_keys
     map { |h| h.symbolize_keys }
   end
 
+  ##
+  ## Join components within an array
+  ##
+  ## @return     [Array] array of strings joined by Shellwords
+  ##
   def shell_join
     map { |p| Shellwords.join(p) }
   end
 
+  ##
+  ## Test if any path in array matches filename
+  ##
+  ## @param      filename  [String] The filename
+  ##
+  ## @return     [Boolean] whether file is found
+  ##
   def includes_file?(filename)
     inc = false
     each do |path|
-      if path.join =~ /#{Regexp.escape(filename)}$/i
+      path = path.join if path.is_a?(Array)
+      if path =~ /#{Regexp.escape(filename)}$/i
         inc = true
         break
       end
@@ -24,10 +50,18 @@ class ::Array
     inc
   end
 
+  ##
+  ## Test if any path in an array contains any matching fragment
+  ##
+  ## @param      frag  [String] The fragment
+  ##
+  ## @return     [Boolean] whether fragment is found
+  ##
   def includes_frag?(frag)
     inc = false
     each do |path|
-      if path.join =~ /#{Regexp.escape(frag)}/i
+      path = path.join if path.is_a?(Array)
+      if path =~ /#{Regexp.escape(frag)}/i
         inc = true
         break
       end

data/lib/conductor/boolean.rb

@@ -2,6 +2,11 @@
 
 # True class
 class ::TrueClass
+  ##
+  ## If TrueClass, it's a boolean
+  ##
+  ## @return     [Boolean] always true
+  ##
   def bool?
     true
   end
@@ -9,6 +14,11 @@ end
 
 # False class
 class ::FalseClass
+  ##
+  ## If FalseClass, it's a boolean
+  ##
+  ## @return     [Boolean] always true
+  ##
   def bool?
     true
   end

data/lib/conductor/command.rb

@@ -5,14 +5,26 @@ module Conductor
   class Command
     attr_reader :args, :path
 
+    ##
+    ## Instantiate a command runner
+    ##
+    ## @param      command  [String] The command
+    ##
     def initialize(command)
       parts = Shellwords.split(command)
       self.path = parts[0]
       self.args = parts[1..].join(" ")
     end
 
+    ##
+    ## Writer method for command path
+    ##
+    ## @param      path  [String] The path
+    ##
+    ## @return     [String] New path
+    ##
     def path=(path)
-      @path = if %r{^[%/]}.match?(path)
+      @path = if %r{^[~/.]}.match?(path)
         File.expand_path(path)
       else
         which = TTY::Which.which(path)
@@ -20,6 +32,13 @@ module Conductor
       end
     end
 
+    ##
+    ## Writer method for arguments
+    ##
+    ## @param      array  [Array] Array of arguments
+    ##
+    ## @return     [String] Arguments as string
+    ##
     def args=(array)
       @args = if array.is_a?(Array)
         array.join(" ")
@@ -28,6 +47,11 @@ module Conductor
       end
     end
 
+    ##
+    ## Run the command
+    ##
+    ## @return     [String] result of running STDIN through command
+    ##
     def run
       stdin = Conductor.stdin
 

data/lib/conductor/condition.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 module Conductor
+  # Condition class
   class Condition
+    # R/W condition
+    attr_accessor :condition
 
     ##
     ## Initializes the given condition.
@@ -77,6 +80,8 @@ module Conductor
         value1.to_f > value2.to_f
       when :lt
         value1.to_f < value2.to_f
+      when :not_contains
+        value1.to_s !~ /#{value2}/i
       when :contains
         value1.to_s =~ /#{value2}/i
       when :starts_with
@@ -97,7 +102,7 @@ module Conductor
     ## @return [Array] Value, value to compare, operator
     ##
     def split_condition(condition)
-      if condition.match(/(?:((?:does )?not)?(?:ha(?:s|ve)|contains?|includes?) +)?(yaml|headers|frontmatter|mmd|meta(?:data)?|pandoc)(:\S+)?/i)
+      if condition.match(/(?:((?:does )?not)?(?:ha(?:s|ve)|contains?|includes?) +)?(yaml|headers|frontmatter|mmd|meta(?:data)?|pandoc)(:[\S_ ]+)?/i)
         m = Regexp.last_match
         op = m[1].nil? ? :contains : :not_contains
         type = case m[2]
@@ -111,7 +116,7 @@ module Conductor
         return ["#{type}#{m[3]}", nil, op]
       end
 
-      res = condition.match(/(?i)^(?<val1>.*?)(?:(?:\s+(?<bool>(?:is|does)?\s*(?:not)?\s*)(?<op>(?:an?|type(?:\sof)?|equals?(?:\sto))?|[!*$]?==?|[gl]t|(?:greater|less)(?:\sthan)?|<|>|(?:starts|ends) with|(?:ha(?:s|ve)\s)?(?:prefix|suffix)|(?:contains?|includes?)\s+(?:file|path)|has|contains?|includes?|match(?:es)?)\s+)(?<val2>.*?))?$/)
+      res = condition.match(/(?i)^(?<val1>.*?)(?:(?:\s+(?<bool>(?:is|do(?:es)?)?\s*(?:not)?\s*)(?<op>(?:an?|type(?:\sof)?|equals?(?:\sto))?|[!*$]?==?|[gl]t|(?:greater|less)(?:\sthan)?|<|>|(?:starts|ends) with|(?:ha(?:s|ve)\s)?(?:prefix|suffix)|(?:contains?|includes?)\s+(?:file|path)|has|contains?|includes?|match(?:es)?)\s+)(?<val2>.*?))?$/)
       operator = res["bool"] ? "#{res["bool"]}#{res["op"]}" : res["op"]
       [res["val1"], res["val2"], operator_to_symbol(operator)]
     end
@@ -177,7 +182,7 @@ module Conductor
 
       return operator == :not_equal if val1.nil?
 
-      val2 = val2.force_encoding("utf-8")
+      val2 = val2.to_s.dup.force_encoding("utf-8")
 
       if val1.date?
         if val2.time?
@@ -185,7 +190,7 @@ module Conductor
           date2 = val2.to_date
         else
           date1 = operator == :gt ? val1.to_day(:end) : val1.to_day
-          date2 = operator == :gt ? val2.to_day(:end) : val1.to_day
+          date2 = operator == :gt ? val2.to_day(:end) : val2.to_day
         end
 
         res = case operator
@@ -209,19 +214,19 @@ module Conductor
       val1 = val1.dup.to_s.force_encoding("utf-8")
       case operator
       when :contains
-        val1 =~ /#{val2}/i
+        val1 =~ /#{val2}/i ? true : false
       when :not_starts_with
-        val1 !~ /^#{val2}/i
+        val1 !~ /^#{val2}/i ? true : false
       when :not_ends_with
-        val1 !~ /#{val2}$/i
+        val1 !~ /#{val2}$/i ? true : false
       when :starts_with
-        val1 =~ /^#{val2}/i
+        val1 =~ /^#{val2}/i ? true : false
       when :ends_with
-        val1 =~ /#{val2}$/i
+        val1 =~ /#{val2}$/i ? true : false
       when :equal
-        val1 =~ /^#{val2}$/i
+        val1 =~ /^#{val2}$/i ? true : false
       when :not_equal
-        val1 !~ /^#{val2}$/i
+        val1 !~ /^#{val2}$/i ? true : false
       else
         false
       end
@@ -306,9 +311,9 @@ module Conductor
 
         value1 = value1.join(",") if value1.is_a?(Array)
 
-        if value1.bool?
+        if value1.to_s.bool?
           test_truthy(value1, value, operator)
-        elsif value1.number? && value.number? && %i[gt lt equal not_equal].include?(operator)
+        elsif value1.to_s.number? && value.to_s.number? && %i[gt lt equal not_equal].include?(operator)
           test_operator(value1, value, operator)
         else
           test_string(value1, value, operator)
@@ -351,6 +356,10 @@ module Conductor
       end
 
       if key
+        if %i[type_of not_type_of].include?(operator)
+          return test_type(meta[key], value, operator)
+        end
+
         test_string(meta[key], value, operator)
       else
         res = value ? meta.key?(value) : true
@@ -358,8 +367,14 @@ module Conductor
       end
     end
 
+    ##
+    ## Test for Pandoc headers
+    ##
+    ## @param      content   [String] The content to test
+    ## @param      operator  [Symbol] The operator
+    ##
     def test_pandoc(content, operator)
-      res = content.match(/^%% /)
+      res = content.meta_type == :pandoc
       %i[not_contains not_equal].include?(operator) ? !res.nil? : res.nil?
     end
 
@@ -403,6 +418,13 @@ module Conductor
       end
     end
 
+    ##
+    ## Convert an operator string to a symbol
+    ##
+    ## @param      operator  [String] The operator
+    ##
+    ## @return     [Symbol] the operator symbol
+    ##
     def operator_to_symbol(operator)
       return operator if operator.nil?
 
@@ -419,8 +441,6 @@ module Conductor
         :includes_file
       when /(ha(?:s|ve)|contains?|includes?|\*=) +path/i
         :includes_path
-      when /(ha(?:s|ve)|contains|includes|match(es)?|\*=)/i
-        :contains
       when /not (ha(?:s|ve)|contains|includes|match(es)?)/i
         :not_contains
       when /(ha(?:s|ve)|contains|includes|match(es)?|\*=)/i
@@ -444,6 +464,11 @@ module Conductor
       end
     end
 
+    ##
+    ## Parse a condition, handling parens and booleans
+    ##
+    ## @return     [Boolean] condition result
+    ##
     def parse_condition
       cond = @condition.to_s.gsub(/\((.*?)\)/) do
         condition = Regexp.last_match(1)

data/lib/conductor/config.rb

@@ -3,31 +3,60 @@
 module Conductor
   # Configuration methods
   class Config
-    attr_reader :config, :tracks
+    # Configuration
+    attr_reader :config
+    # Tracks element
+    attr_reader :tracks
+    # Config file path
+    attr_writer :config_file
 
+    ##
+    ## Instantiate a configuration
+    ##
+    ## @return     [Config] Config object
+    ##
     def initialize
-      config_file = File.expand_path("~/.config/conductor/tracks.yaml")
+      @config_file = File.expand_path("~/.config/conductor/tracks.yaml")
+    end
 
-      create_config(config_file) unless File.exist?(config_file)
+    def configure
+      res = create_config(@config_file)
+      return false unless res
 
-      @config ||= YAML.safe_load(IO.read(config_file))
+      @config ||= YAML.safe_load(IO.read(@config_file))
 
       @tracks = @config["tracks"].symbolize_keys
+
+      return true
     end
 
     private
 
-    def create_config(config_file)
+    ##
+    ## Generate a blank config and directory structure
+    ##
+    ## @param      config_file  [String] The configuration file to create
+    ##
+    def create_config(config_file = nil)
+      config_file ||= @config_file
       config_dir = File.dirname(config_file)
       scripts_dir = File.dirname(File.join(config_dir, "scripts"))
       FileUtils.mkdir_p(config_dir) unless File.directory?(config_dir)
       FileUtils.mkdir_p(scripts_dir) unless File.directory?(scripts_dir)
-      File.open(config_file, "w") { |f| f.puts sample_config }
-      puts "Sample config created at #{config_file}"
+      unless File.exist?(config_file)
+        File.open(config_file, "w") { |f| f.puts sample_config }
+        puts "Sample config created at #{config_file}"
+        return false
+      end
 
-      Process.exit 0
+      return true
     end
 
+    ##
+    ## Content for sample configuration
+    ##
+    ## @return     [String] sample config
+    ##
     def sample_config
       <<~EOCONFIG
         tracks:

data/lib/conductor/env.rb

@@ -14,7 +14,7 @@ module Conductor
           home: ENV["HOME"],
           css_path: ENV["MARKED_CSS_PATH"],
           ext: ENV["MARKED_EXT"],
-          includes: ENV["MARKED_INCLUDES"].split(/,/).map { |s| Shellwords.shellsplit(s) },
+          includes: ENV["MARKED_INCLUDES"].split_list,
           origin: ENV["MARKED_ORIGIN"],
           filepath: ENV["MARKED_PATH"],
           filename: File.basename(ENV["MARKED_PATH"]),
@@ -35,7 +35,7 @@ module Conductor
         home: "/Users/ttscoff",
         css_path: "/Applications/Marked 2.app/Contents/Resources/swiss.css",
         ext: "md",
-        includes: [],
+        includes: "".split_list,
         origin: "/Users/ttscoff/Sites/dev/bt/source/_posts/",
         filepath: "/Users/ttscoff/Sites/dev/bt/source/_posts/2024-04-01-automating-the-dimspirations-workflow.md",
         filename: "advanced-features.md",
@@ -46,7 +46,7 @@ module Conductor
     end
 
     ##
-    ## env to string
+    ## env to shell-compatible string
     ##
     ## @return     [String] shell-compatible string representation of @env
     ##