mdless 2.1.23 → 2.1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5706f3396d726dcdd4d8c0e7a6e93f60f43ed35d8ab56e55cdb76f812230123c
-  data.tar.gz: 6be63ef01249321bcb16aedfbbb9cb1320c99f0dd74f2ab39071fe30f9328ef3
+  metadata.gz: daa606283636cef493f39150cf92cba89cb92774e1a1d864f08b8e3f30c1d956
+  data.tar.gz: 22aa99bdb5ecf9eb1e29a79595048098101ccb12b676481cf219bf00fff56ff2
 SHA512:
-  metadata.gz: e333519a46675abb2a8aaf9092c9ea1274faf67d156fc6754fda18d86b53fa92efe78a75ccbdd493c822a124afcd1a855fcfe286dbb7cc156d5380d72de770e9
-  data.tar.gz: 691565d52e2f9fe3e652ad7c02f435957df92ad72cc98ddb1133262bace8d3a167e97c9ad3e740aa153700c90f8403f014e76cf2cba6877739aef3434096a7b0
+  metadata.gz: 351d4923b3d652d4ca6900ad691ceea22f33be02127c2ed5c654a4a48ef2b3feb6daa1f086cb98c398bc4f2ed40b7e797d6946d2358c0fb3c721ee5068437176
+  data.tar.gz: 992a8936d9426acbd56f146606d0b3f42c49900a9e60a70e943a17eef17b450fbe40ee106150135cc755c61407ee05aa2ba2337f400ad38528e0c8a0d0949f03

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+2.1.24
+: Save MultiMarkdown metadata into a hash
+: Allow [%metakey] replacements
+: Allow {{filename}} transcusions (MultiMarkdown), respects "transclude base:" metadata
+: Transclude documents with `{{filename}}`, nesting allowed, "transclude base:" metadata respected (even in YAML)
+: Metadata can be used in `[%key]` format to have it replaced in the output based on metadata values
+
 2.1.23
 : Fix release pipeline to get version number correct in git release
 : Changelog mismatch

data/lib/mdless/console.rb

@@ -743,15 +743,16 @@ module Redcarpet
       def color_meta(text)
         input = text.dup
         input.clean_empty_lines!
-
+        MDLess.meta = {}
         first_line = input.split("\n").first
         if first_line =~ /(?i-m)^---[ \t]*?$/
           MDLess.log.info('Found YAML')
           # YAML
           in_yaml = true
-          input.sub!(/(?i-m)^---[ \t]*\n([\s\S]*?)\n[-.]{3}[ \t]*\n/m) do
+          input.sub!(/(?i-m)^---[ \t]*\n(?<content>(?:[\s\S]*?))\n[-.]{3}[ \t]*\n/m) do
             m = Regexp.last_match
             MDLess.log.info('Processing YAML Header')
+            MDLess.meta = YAML.safe_load(m['content']).map { |k, v| "#{k.downcase}" => v }
             lines = m[0].split(/\n/)
             longest = lines.longest_element.length
             longest = longest < MDLess.cols ? longest + 1 : MDLess.cols
@@ -779,18 +780,47 @@ module Redcarpet
 
             lines.map do |line|
               line.sub!(/^(.*?:)[ \t]+(\S)/, '\1 \2')
+              parts = line.match(/[ \t]*(.*?): +(.*?)$/)
+              key = parts[1].gsub(/[^a-z0-9\-_]/i, '')
+              value = parts[2].strip
+              MDLess.meta[key] = value
               line = "#{color('metadata marker')}%#{color('metadata color')}#{line}"
               line += "\u00A0" * (longest - line.uncolor.strip.length) if (longest - line.uncolor.strip.length).positive?
               line + xc
-            end.join("\n") + "#{"\u00A0" * longest}#{xc}\n"
+            end.join("\n") + "#{xc}\n"
           end
         end
 
         input
       end
 
+      def mmd_transclude(input)
+        input.gsub(/^{{(.*?)}}/) do |m|
+          filename = Regexp.last_match(1).strip
+          file = if MDLess.meta.key?('transcludebase')
+            File.join(File.expand_path(MDLess.meta['transcludebase']), filename)
+          else
+            File.join(File.dirname(MDLess.file), filename)
+          end
+          File.exist?(file) ? "\n\n#{mmd_transclude(IO.read(file).remove_meta)}\n\n" : m
+        end
+      end
+
+      def mmd_metadata_replace(input)
+        input.gsub(/\[%(.*?)\]/) do |m|
+          key = Regexp.last_match(1)
+          if MDLess.meta.key?(key)
+            MDLess.meta[key]
+          else
+            m
+          end
+        end
+      end
+
       def preprocess(input)
         input = color_meta(input)
+        input = mmd_transclude(input) if MDLess.options[:transclude]
+        input = mmd_metadata_replace(input) if MDLess.options[:mmd_metadata]
 
         replaced_input = input.clone
         ## Replace setex headers with ATX

data/lib/mdless/converter.rb

@@ -184,6 +184,11 @@ module CLIMarkdown
           MDLess.options[:preserve_linebreaks] = opt
         end
 
+        default(:mmd_metadata, true)
+        opts.on('--[no-]metadata', 'Replace [%key] with values from metadata') do |opt|
+          MDLess.options[:mmd_metadata] = opt
+        end
+
         default(:syntax_higlight, false)
         opts.on('--[no-]syntax', 'Syntax highlight code blocks') do |opt|
           MDLess.options[:syntax_higlight] = opt
@@ -212,6 +217,11 @@ module CLIMarkdown
                                  end
         end
 
+        default(:transclude, true)
+        opts.on('--[no-]transclude', 'Transclude documents with {{filename}} syntax') do |opt|
+          MDLess.options[:transclude] = opt
+        end
+
         default(:update_config, false)
         opts.on('--update-config', '--update_config', 'Update the configuration file with new keys and current command line options') do
           MDLess.options[:update_config] = true

data/lib/mdless/string.rb

@@ -56,6 +56,7 @@ class ::String
     @cols = cols
     input = dup
     input.clean_empty_lines!
+    MDLess.meta = {}
 
     in_yaml = false
     first_line = input.split("\n").first
@@ -63,10 +64,11 @@ class ::String
       MDLess.log.info('Found YAML')
       # YAML
       in_yaml = true
-      input.sub!(/(?i-m)^---[ \t]*\n([\s\S]*?)\n[-.]{3}[ \t]*\n/m) do
+      input.sub!(/(?i-m)^---[ \t]*\n(?<content>[\s\S]*?)\n[-.]{3}[ \t]*\n/m) do
         m = Regexp.last_match
         MDLess.log.info('Processing YAML Header')
-        lines = m[0].split(/\n/)
+        MDLess.meta = YAML.safe_load(m['content']).map { |k, v| "#{k.downcase}" => v }
+        lines = m['content'].split(/\n/)
         longest = lines.inject { |memo, word| memo.length > word.length ? memo : word }.length
         longest = longest < @cols ? longest + 1 : @cols
         lines.map do |line|
@@ -93,7 +95,11 @@ class ::String
         longest = longest < @cols ? longest + 1 : @cols
         lines.map do |line|
           line.sub!(/^(.*?:)[ \t]+(\S)/, '\1 \2')
-          line = "#{color('metadata color')}#{line}"
+          parts = line.match(/[ \t]*(.*?): +(.*?)$/)
+          key = parts[1].gsub(/[^a-z0-9\-_]/i, '')
+          value = parts[2].strip
+          MDLess.meta[key] = value
+          line = "#{color('metadata color')}#{line}#{xc}"
           line += "\u00A0" * (longest - line.uncolor.strip.length) if (longest - line.uncolor.strip.length).positive?
           line + xc
         end.join("\n") + "#{"\u00A0" * longest}#{xc}\n"
@@ -139,6 +145,17 @@ class ::String
     MDLess.pygments_styles.include?(self)
   end
 
+  def remove_meta
+    first_line = split("\n").first
+    if first_line =~ /(?i-m)^---[ \t]*?$/
+      sub(/(?im)^---[ \t]*\n([\s\S\n]*?)\n[-.]{3}[ \t]*\n/, '')
+    elsif first_line =~ /(?i-m)^[\w ]+:\s+\S+/
+      sub(/(?im)^([\S ]+:[\s\S]*?)+(?=\n *\n)/, '')
+    else
+      self
+    end
+  end
+
   def valid_lexer?
     return false unless TTY::Which.exist?('pygmentize')
 

data/lib/mdless/taskpaper.rb

@@ -36,16 +36,6 @@ module CLIMarkdown
         end
       end
 
-      def remove_meta(input)
-        first_line = input.split("\n").first
-        if first_line =~ /(?i-m)^---[ \t]*?$/
-          input.sub!(/(?im)^---[ \t]*\n([\s\S\n]*?)\n[-.]{3}[ \t]*\n/, '')
-        elsif first_line =~ /(?i-m)^[\w ]+:\s+\S+/
-          input.sub!(/(?im)^([\S ]+:[\s\S]*?)+(?=\n\n)/, '')
-        end
-        input
-      end
-
       def is_taskpaper?(input)
         return true if MDLess.file =~ /\.taskpaper$/
 
@@ -61,7 +51,7 @@ module CLIMarkdown
         if tasks >= 6
           return true
         else
-          tst = remove_meta(input.dup)
+          tst = input.dup.remove_meta
           tst = tst.gsub(PROJECT_RX, '')
           tst = tst.gsub(TASK_RX, '')
           tst = tst.gsub(NOTE_RX, '')

data/lib/mdless/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CLIMarkdown
-  VERSION = '2.1.23'
+  VERSION = '2.1.24'
 end

data/lib/mdless.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 require 'shellwords'
 require 'open3'
@@ -7,7 +9,7 @@ require 'tty-which'
 require 'tty-screen'
 require 'tty-spinner'
 require 'rouge'
-require 'mdless/version.rb'
+require 'mdless/version'
 require 'mdless/colors'
 require 'mdless/tables'
 require 'mdless/hash'
@@ -26,7 +28,7 @@ end
 module MDLess
   class << self
     include CLIMarkdown::Theme
-    attr_accessor :options, :cols, :file
+    attr_accessor :options, :cols, :file, :meta
 
     def log
       @log ||= Logger.new($stderr)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdless
 version: !ruby/object:Gem::Version
-  version: 2.1.23
+  version: 2.1.24
 platform: ruby
 authors:
 - Brett Terpstra