marked-conductor 1.0.27 → 1.0.28

data/lib/conductor/filter.rb

@@ -2,19 +2,33 @@
 
 # String helpers
 class ::String
+  ##
+  ## Search config folder for multiple subfolders and content
+  ##
+  ## @param      paths     [Array] The possible directory names
+  ## @param      filename  [String] The filename to search for
+  ## @param      ext       [String] The file extension
+  ##
   def find_file_in(paths, filename, ext)
     return filename if File.exist?(filename)
 
     filename = File.basename(filename, ".#{ext}")
 
     paths.each do |path|
-      exp = File.join(File.expand_path('~/.config/conductor/'), path, "#{filename}.#{ext}")
+      exp = File.join(File.expand_path("~/.config/conductor/"), path, "#{filename}.#{ext}")
       return exp if File.exist?(exp)
     end
 
     "#{filename}.#{ext}"
   end
 
+  ##
+  ## Normalize the filter name and parameters, downcasing and removing spaces,
+  ## underscores, splitting params by comma
+  ##
+  ## @return     [Array<String,Array>] array containing normalize filter and
+  ##             array of parameters
+  ##
   def normalize_filter
     parts = match(/(?<filter>[\w_]+)(?:\((?<paren>.*?)\))?$/i)
     filter = parts["filter"].downcase.gsub(/_/, "")
@@ -34,11 +48,18 @@ class ::String
       :yaml
     when /^ *[ \w]+: +\S+/
       :mmd
+    when /^% +\S/
+      :pandoc
     else
       :none
     end
   end
 
+  ##
+  ## Determine which line to use to insert after existing metadata
+  ##
+  ## @return     [Integer] line index
+  ##
   def meta_insert_point
     insert_point = 0
 
@@ -57,6 +78,14 @@ class ::String
       lines.each_with_index do |line, idx|
         next if line =~ /^ *[ \w]+: +\S+/
 
+        insert_point = idx
+        break
+      end
+    when :pandoc
+      lines = split(/\n/)
+      lines.each_with_index do |line, idx|
+        next if line =~ /^% +\S/
+
         insert_point = idx
         break
       end
@@ -65,10 +94,15 @@ class ::String
     insert_point
   end
 
+  ##
+  ## Locate the first H1 in the document
+  ##
+  ## @return     [Integer] index of first H1
+  ##
   def first_h1
-    first = 0
+    first = nil
     split(/\n/).each_with_index do |line, idx|
-      if line =~ /^(# *\S|={2,} *$)/
+      if line =~ /^(# *[^#]|={2,} *$)/
         first = idx
         break
       end
@@ -76,10 +110,18 @@ class ::String
     first
   end
 
+  ##
+  ## Locate the first H2 in the document
+  ##
+  ## @return     [Integer] index of first H2
+  ##
   def first_h2
-    first = 0
+    first = nil
+    meta_end = meta_insert_point
     split(/\n/).each_with_index do |line, idx|
-      if line =~ /^(## *\S|-{2,} *$)/
+      next if idx <= meta_end
+
+      if line =~ /^(## *[^#]|-{2,} *$)/
         first = idx
         break
       end
@@ -88,44 +130,60 @@ class ::String
   end
 
   ##
-  ## Count the characters in a string
+  ## Decrease all headers by given amount
   ##
-  ## @return     [Integer] number of characters
+  ## @param      amt   [Integer] The amount to decrease
   ##
-  def chars
-    split(//).count
-  end
-
   def decrease_headers(amt = 1)
     gsub(/^(\#{1,6})(?!=#)/) do
       m = Regexp.last_match
-      level = m[1].chars
+      level = m[1].size
       level -= amt
       level = 1 if level < 1
-      "#{"#" * level}"
+      "#" * level
     end
   end
 
-  def decrease_headers!(amt = 1)
-    replace decrease_headers(amt)
-  end
-
+  ##
+  ## Increase all header levels by amount
+  ##
+  ## @param      amt   [Integer] number to increase by (1-5)
+  ##
+  ## @return     [String] content with headers increased
+  ##
   def increase_headers(amt = 1)
-    gsub(/^#/, "#{"#" * amt}#").gsub(/^\#{7,}/, '######')
+    gsub(/^#/, "#{"#" * amt}#").gsub(/^\#{7,}/, "######")
   end
 
+  ##
+  ## Destructive version of #increase_headers
+  ##
+  ## @see        #increase_headers
+  ##
+  ## @param      amt   [Integer] The amount
+  ##
+  ## @return     [String] content with headers increased
+  ##
   def increase_headers!(amt = 1)
     replace increase_headers(amt)
   end
 
+  ##
+  ## Insert a Table of Contents at given position
+  ##
+  ## @param      max    [Integer] The maximum depth of the TOC
+  ## @param      after  [Symbol] Where to place TOC after (:top, :h1, :h2)
+  ##
+  ## @return     [String] content with TOC tag added
+  ##
   def insert_toc(max = nil, after = :h1)
     lines = split(/\n/)
     max = max.to_i&.positive? ? " max#{max}" : ""
     line = case after.to_sym
            when :h2
-             first_h2.positive? ? first_h2 + 1 : 0
+             first_h2.nil? ? 0 : first_h2 + 1
            when :h1
-             first_h1.positive? ? first_h1 + 1 : 0
+             first_h1.nil? ? 0 : first_h1 + 1
            else
              meta_insert_point.positive? ? meta_insert_point + 1 : 0
            end
@@ -133,6 +191,11 @@ class ::String
     lines.insert(line, "\n<!--toc#{max}-->\n").join("\n")
   end
 
+  ##
+  ## Wrap content in <style> tag if needed
+  ##
+  ## @return     [String] wrapped content
+  ##
   def wrap_style
     if match(%r{<style>.*?</style>}m)
       self
@@ -141,30 +204,41 @@ class ::String
     end
   end
 
+  ##
+  ## Insert a <link> tag for the given path
+  ##
+  ## @param      path  [String] path to CSS files
+  ##
+  ## @return     [String] path with <style> link added
+  ##
   def insert_stylesheet(path)
-    path = find_file_in(['css', 'styles'], path, 'css') unless path =~ /^http/
+    path = find_file_in(%w[css styles], path, "css") unless path =~ /^http/
     inject_after_meta(%(<link rel="stylesheet" href="#{path.strip}">))
   end
 
+  ##
+  ## Insert raw CSS into the document, reading from a file and compressing
+  ## contents
+  ##
+  ## @param      path  [String]  The CSS file path
+  ##
+  ## @return     [String] content with raw CSS injected
+  ##
   def insert_css(path)
     return insert_stylesheet(path) if path.strip =~ /^http/
 
-    path.sub!(/(\.css)?$/, '.css')
+    path = path.sub(/(\.css)?$/, ".css")
 
-    if path =~ %r{^[~/]}
+    if path =~ %r{^[~/.]}
       path = File.expand_path(path)
-    elsif File.directory?(File.expand_path("~/.config/conductor/css"))
-      new_path = File.expand_path("~/.config/conductor/css/#{path}")
-      path = new_path if File.exist?(new_path)
-    elsif File.directory?(File.expand_path("~/.config/conductor/files"))
-      new_path = File.expand_path("~/.config/conductor/files/#{path}")
-      path = new_path if File.exist?(new_path)
+    else
+      path = find_file_in(%w[css styles files], path, "css")
     end
 
     if File.exist?(path)
       content = IO.read(path)
       yui = YuiCompressor::Yui.new
-      content = yui.compress(content)
+      content = yui.compress(content.force_encoding('utf-8'))
       inject_after_meta(content.wrap_style)
     else
       warn "File not found (#{path})"
@@ -172,6 +246,13 @@ class ::String
     end
   end
 
+  ##
+  ## Insert the given content after any existing metadata
+  ##
+  ## @param      content  [String] The content
+  ##
+  ## @return     [String] string with content injected
+  ##
   def inject_after_meta(content)
     lines = split(/\n/)
     insert_point = meta_insert_point
@@ -180,15 +261,23 @@ class ::String
     lines.join("\n")
   end
 
+  ##
+  ## Insert a file include syntax for various types
+  ##
+  ## @param      path      [String] The file path
+  ## @param      type      [Symbol] The type (:file, :code, :raw)
+  ## @param      position  [Symbol] The position (:start, :h1, :h2, :end)
+  ##
   def insert_file(path, type = :file, position = :end)
-    path.strip!
+    path = path.strip
 
-    if path =~ %r{^[~/]}
-      path = File.expand_path(path)
-    elsif File.directory?(File.expand_path("~/.config/conductor/files"))
-      new_path = File.expand_path("~/.config/conductor/files/#{path}")
-      path = new_path if File.exist?(new_path)
-    end
+    path = if path =~ %r{^[.~/]}
+             File.expand_path(path)
+           else
+             find_file_in(%w[files], path, File.extname(path))
+           end
+
+    warn "File not found: #{path}" unless File.exist?(path)
 
     out = case type
           when :code
@@ -204,53 +293,87 @@ class ::String
     when :start
       inject_after_meta(out)
     when :h1
-      split(/\n/).insert(first_h1 + 1, out).join("\n")
+      h1 = first_h1.nil? ? 0 : first_h1 + 1
+      split(/\n/).insert(h1, out).join("\n")
     when :h2
-      split(/\n/).insert(first_h2 + 1, out).join("\n")
+      h2 = first_h2.nil? ? 0 : first_h2 + 1
+      split(/\n/).insert(h2, out).join("\n")
     else
       "#{self}\n#{out}"
     end
   end
 
+  ##
+  ## Append string to self
+  ##
+  ## @param      string  [String] The string to append
+  ##
+  ## @return self with string appended
+  ##
   def append(string)
     "#{self}\n#{string}"
   end
 
+  ##
+  ## Destructive version of #append
+  ## @see        #append
+  ##
+  ## @return     self with string appended
+  ##
   def append!(string)
     replace append(string)
   end
 
+  ##
+  ## Append a <script> tag for a given path
+  ##
+  ## @param      path  [String] The path
+  ##
+  ## @return     self with javascript tag appended
+  ##
   def insert_javascript(path)
-    %(#{self}\n<script type="javascript" src="#{ERB::Util.url_encode(path.strip)}"></script>\n)
+    %(#{self}\n<script type="javascript" src="#{path.strip}"></script>\n)
   end
 
+  ##
+  ## Append raw javascript
+  ##
+  ## @param      content  [String] The content
+  ##
+  ## @return     self with script tag containing contents appended
+  ##
   def insert_raw_javascript(content)
-    %(#{self}\n<script>#{content}</script>)
+    %(#{self}\n<script>#{content}</script>\n)
   end
 
+  ##
+  ## Insert javascript, detecting raw js and files, inserting appropriately
+  ##
+  ## Paths that are just a filename will be searched for in various .config
+  ## directories. If found, a full path will be used.
+  ##
+  ## @param      path  [String] The path or raw content to inject
+  ##
   def insert_script(path)
-    path.strip!
+    path = path.strip
+    orig_path = path
+
     return insert_javascript(path) if path =~ /^http/
 
     return insert_raw_javascript(path) if path =~ /\(.*?\)/
 
-    path.sub!(/(\.js)?$/, '.js')
+    path = if path =~ %r{^[~/.]}
+             File.expand_path(path)
+           else
+             find_file_in(%w[javascript javascripts js scripts], path.sub(/(\.js)?$/, ".js"), "js")
+           end
 
-    if path =~ %r{^[~/]}
-      path = File.expand_path(path)
+    if File.exist?(path)
+      insert_javascript(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)
+      warn "Javascript not found: #{path}"
+      insert_javascript(orig_path)
     end
-
-    insert_javascript(path)
   end
 
   def title_from_slug
@@ -258,10 +381,10 @@ class ::String
     filename.sub!(/-?\d{4}-\d{2}-\d{2}-?/, "")
     filename.sub!(/\bdot\b/, ".")
     filename.sub!(/ dash /, "-")
-    filename
+    filename.gsub(/-/, ' ')
   end
 
-  def get_title
+  def read_title
     title = nil
 
     case meta_type
@@ -276,6 +399,15 @@ class ::String
           break
         end
       end
+    when :pandoc
+      title = nil
+      split(/\n/).each do |line|
+        if line =~ /^% +(.*?)$/
+          title = Regexp.last_match(1)
+          break
+        end
+      end
+      title
     else
       m = match(/title: (.*?)$/i)
       title = m ? m[0] : nil
@@ -288,7 +420,7 @@ class ::String
 
   def insert_title(shift: 0)
     content = dup
-    title = get_title
+    title = read_title
     content.increase_headers!(shift) if shift.positive?
     lines = content.split(/\n/)
     insert_point = content.meta_insert_point
@@ -336,7 +468,7 @@ class ::String
     else
       lines = split(/\n/)
       lines.insert(meta_insert_point, "#{key}: #{value}")
-      lines.join("\n") + "\n"
+      "#{lines.join("\n")}\n"
     end
   end
 
@@ -344,16 +476,16 @@ class ::String
     sub(/^ *#{key}:.*?\n/i, "")
   end
 
-  def has_comment?(key)
+  def comment?(key)
     match(/^<!--.*?#{key}: \S.*?-->/m)
   end
 
   def add_comment(key, value)
-    if has_comment?(key)
+    if comment?(key)
       sub(/ *#{key}: .*?$/, "#{key}: #{value}")
     else
       lines = split(/\n/)
-      lines.insert(meta_insert_point + 1, "<!--\n#{key}: #{value}\n-->")
+      lines.insert(meta_insert_point + 1, "\n<!--\n#{key}: #{value}\n-->")
       lines.join("\n")
     end
   end
@@ -364,6 +496,8 @@ class ::String
       delete_yaml(key)
     when :mmd
       delete_mmd(key)
+    else
+      self
     end
   end
 
@@ -373,7 +507,12 @@ class ::String
       sub(/^---.*?(---|\.\.\.)/m, "")
     when :mmd
       lines = split(/\n/)
-      lines[meta_insert_point..]
+      lines[meta_insert_point..].join("\n")
+    when :pandoc
+      lines = split(/\n/)
+      lines[meta_insert_point..].join("\n")
+    else
+      gsub(/(\n|^)<!--\n[\w\d\s]+: ([\w\d\s]+)\n-->\n/m, '')
     end
   end
 
@@ -393,7 +532,7 @@ class ::String
   ##
   ## Count the number of h1 headers in the document
   ##
-  ## @return     Number of h1s.
+  ## @return     [Integer] Number of h1s.
   ##
   def count_h1s
     scan(/^#[^#]/).count
@@ -405,10 +544,10 @@ class ::String
   ## @return [String] content with headers updated
   ##
   def normalize_headers
-    gsub(/^(?<=\n\n)(\S.*)\n([=-]+)\n/) do
+    gsub(/^(?<=\n\n|^)(\S[^\n]+)\n([=-]{2,})\n/) do
       m = Regexp.last_match
       case m[2]
-      when /\=/
+      when /=/
         "# #{m[1]}\n\n"
       else
         "## #{m[1]}\n\n"
@@ -416,29 +555,42 @@ class ::String
     end
   end
 
+  ##
+  ## Destructive version of #normalize_headers
+  ## @see        #normalize_headers
+  ##
+  ## @return     String with setext headers converted to ATX
+  ##
   def normalize_headers!
     replace normalize_headers
   end
 
   ##
-  ## Ensure there's at least 1 h1 in the document
+  ## Ensure there's at least one H1 in the document
   ##
-  ## If no h1 is found, converts the lowest level header (first one) into an h1
+  ## If no H1 is found, converts the lowest level header (first one) into an H1
   ##
-  ## @return     [String] content with at least 1 h1
+  ## @return     [String] content with at least 1 H1
   ##
   def ensure_h1
     headers = to_enum(:scan, /(\#{1,6})([^#].*?)$/m).map { Regexp.last_match }
-    return self if headers.select { |h| h[1].chars == 1 }.count.positive?
+    return self if headers.select { |h| h[1].size == 1 }.count.positive?
 
-    lowest_header = headers.min_by { |h| h[1].chars }
+    lowest_header = headers.min_by { |h| h[1].size }
     return self if lowest_header.nil?
 
-    level = lowest_header[1].chars
+    level = lowest_header[1].size - 1
 
     sub(/#{Regexp.escape(lowest_header[0])}/, "# #{lowest_header[2].strip}").decrease_headers(level)
   end
 
+  ##
+  ## Destructive version of #ensure_h1
+  ##
+  ## @see        #ensure_h1
+  ##
+  ## @return     Content with at least one H1
+  ##
   def ensure_h1!
     replace ensure_h1
   end
@@ -451,14 +603,14 @@ class ::String
   def fix_headers
     return self if count_h1s == 1
 
-    first_h1 = true
+    h1 = true
 
-    gsub(%r/^(\#{1,6})([^#].*?)$/m) do
+    gsub(/^(\#{1,6})([^#].*?)$/) do
       m = Regexp.last_match
-      level = m[1].chars
+      level = m[1].size
       content = m[2].strip
-      if level == 1 && first_h1
-        first_h1 = false
+      if level == 1 && h1
+        h1 = false
         m[0]
       else
         level += 1 if level < 6
@@ -468,6 +620,14 @@ class ::String
     end
   end
 
+  ##
+  ## Destructive version of #fix_headers
+  ##
+  ##
+  ## @see        #fix_headers # #
+  ##
+  ## @return     [String] headers fixed #
+  ##
   def fix_headers!
     replace fix_headers
   end
@@ -485,7 +645,7 @@ class ::String
     content = dup
     last = 1
     headers.each do |h|
-      level = h[1].chars
+      level = h[1].size
       if level <= last + 1
         last = level
         next
@@ -497,131 +657,116 @@ class ::String
 
     content
   end
-
-  ##
-  ## Convert a string to a regular expression
-  ##
-  ## If the string matches /xxx/, it will be interpreted
-  ## directly as a regex. Otherwise it will be escaped and
-  ## converted to regex.
-  ##
-  ## @return     [Regexp] Regexp representation of the string.
-  ##
-  def to_rx
-    if self =~ %r{^/(.*?)/([im]+)?$}
-      m = Regexp.last_match
-      regex = m[1]
-      flags = m[2]
-      Regexp.new(regex, flags)
-    else
-      Regexp.new(Regexp.escape(self))
-    end
-  end
-
-  ##
-  ## Convert a string containing $1, $2 to a Regexp replace pattern
-  ##
-  ## @return     [String] Pattern representation of the object.
-  ##
-  def to_pattern
-    gsub(/\$(\d+)/, '\\\\\1').gsub(/(^["']|["']$)/, "")
-  end
 end
 
-# String filtering
-class Filter < String
-  attr_reader :filter, :params
-
-  def initialize(filter)
-    @filter, @params = filter.normalize_filter
-    super
-  end
+module Conductor
+  # String filtering
+  class Filter < String
+    attr_reader :filter, :params
+
+    ##
+    ## Instantiate a filter
+    ##
+    ## @param      filter  [Filter] The filter
+    ##
+    def initialize(filter)
+      @filter, @params = filter.normalize_filter
+      super
+    end
 
-  def process
-    content = Conductor.stdin
+    ##
+    ## Process STDIN with @filter
+    ##
+    ## @return     [String] processed text
+    ##
+    def process
+      content = Conductor.stdin
+
+      case @filter
+      when /(insert|add|inject)stylesheet/
+        @params.each do |sheet|
+          content = content.insert_stylesheet(sheet)
+        end
+        content
+      when /(insert|add|inject)(css|style)/
+        @params.each do |css|
+          content = content.insert_css(css)
+        end
+        content
+      when /(insert|add|inject)title/
+        amt = 0
+        if @params
+          amt = if @params[0] =~ /^[yts]/
+                  1
+                else
+                  @params[0].to_i
+                end
+        end
+        content.insert_title(shift: amt)
+      when /(insert|add|inject)script/
+        content.append!("\n\n<div>")
+        @params.each do |script|
+          content = content.insert_script(script)
+        end
+        "#{content}</div>"
+      when /(prepend|append|insert|inject)(raw|file|code)/
+        m = Regexp.last_match
+
+        position = if @params.count == 2
+                     @params[1].normalize_position
+                   else
+                     m[1].normalize_position
+                   end
+        content.insert_file(@params[0], m[2].normalize_include_type, position)
+      when /inserttoc/
+        max = @params.nil? || @params.empty? ? nil : @params[0]
+
+        after = if @params && @params.count == 2
+                  @params[1] =~ /2/ ? :h2 : :h1
+                else
+                  :start
+                end
+
+        content.insert_toc(max, after)
+      when /(add|set)meta/
+        unless @params.count == 2
+          warn "Invalid filter parameters: #{@filter}(#{@params.join(",")})"
+          return content
+        end
 
-    case @filter
-    when /(insert|add|inject)stylesheet/
-      @params.each do |sheet|
-        content = content.insert_stylesheet(sheet)
-      end
-      content
-    when /(insert|add|inject)(css|style)/
-      @params.each do |css|
-        content = content.insert_css(css)
-      end
-      content
-    when /(insert|add|inject)title/
-      amt = 0
-      if @params
-        amt = if @params[0] =~ /^[yts]/
-                1
-              else
-                @params[0].to_i
-              end
-      end
-      content.insert_title(shift: amt)
-    when /(insert|add|inject)script/
-      content.append!("\n\n<div>")
-      @params.each do |script|
-        content = content.insert_script(script)
-      end
-      "#{content}</div>"
-    when /(prepend|append|insert|inject)(raw|file|code)/
-      m = Regexp.last_match
+        # needs to test for existing meta, setting key if exists, adding if not
+        # should recognize yaml and mmd
+        content.set_meta(@params[0], @params[1], style: content.meta_type)
+      when /(strip|remove|delete)meta/
+        if @params&.count&.positive?
+          content.delete_meta(@params[0])
+        else
+          content.strip_meta
+        end
+      when /setstyle/
+        # Should check for existing style first
+        content.set_meta("marked style", @params[0], style: :comment)
+      when /replaceall/
+        unless @params.count == 2
+          warn "Invalid filter parameters: #{@filter}(#{@params.join(",")})"
+          return content
+        end
 
-      position = if @params.count == 2
-                   @params[1].normalize_position
-                 else
-                   m[1].normalize_position
-                 end
-      content.insert_file(@params[0], m[2].normalize_include_type, position)
-    when /inserttoc/
-      max = @params.count.positive? ? @params[0] : nil
-
-      after = if @params.count == 2
-                @params[1] =~ /2/ ? :h2 : :h1
-              else
-                :start
-              end
-
-      content.insert_toc(max, after)
-    when /(add|set)meta/
-      unless @params.count == 2
-        warn "Invalid filter parameters: #{@filter}(#{@params.join(",")})"
-        return content
-      end
+        content.replace_all(@params[0], @params[1])
+      when /replace$/
+        unless @params.count == 2
+          warn "Invalid filter parameters: #{@filter}(#{@params.join(",")})"
+          return content
+        end
 
-      # needs to test for existing meta, setting key if exists, adding if not
-      # should recognize yaml and mmd
-      content.set_meta(@params[0], @params[1], style: content.meta_type)
-    when /(strip|remove|delete)meta/
-      if @params&.count&.positive?
-        content.delete_meta(@params[0])
+        content.replace_one(@params[0], @params[1])
+      when /(auto|self)link/
+        content.autolink
+      when /fix(head(lines|ers)|hierarchy)/
+        content.fix_hierarchy
       else
-        content.strip_meta
+        content
       end
-    when /setstyle/
-      # Should check for existing style first
-      content.set_meta("marked style", @params[0], style: :comment)
-    when /replaceall/
-      unless @params.count == 2
-        warn "Invalid filter parameters: #{@filter}(#{@params.join(",")})"
-        return content
-      end
-
-      content.replace_all(@params[0], @params[1])
-    when /replace$/
-      unless @params.count == 2
-        warn "Invalid filter parameters: #{@filter}(#{@params.join(",")})"
-        return content
-      end
-
-      content.replace_one(@params[0], @params[1])
-    when /(auto|self)link/
-      content.autolink
-    when /fix(head(lines|ers)|hierarchy)/
-      content.fix_hierarchy
     end
   end
 end