raindown 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae1eb87d8271ddcfcc3fb956311e11229421188a33f5bd7e0af70cffd2f49719
-  data.tar.gz: 380a98d835cfa9de899c5870828ba157e89aa0d3a4b8621a495f1a0ecd1e9bf6
+  metadata.gz: 9e35dfde9371c5f805bff304124c0abe22ca89254f14c5c70d2996e14d0dbb0f
+  data.tar.gz: 76774aa6b06fec8b50e0929b9ac86259511fb1ab9417ce48fcfa56afd20c90cf
 SHA512:
-  metadata.gz: b3e74f64840850c572446865664e5368915df5065f09e9483d530d58392acb13f0e20ce872b9f8ee1930154af82d4c3baf8bf6fbd7c370399315e3b7a3a3b480
-  data.tar.gz: '09a95ee90ef2568aff8c783ecee3b2ac06590f0a71f1bde6e14e99e7e8f5c6e05776ca6ff3c7dcce22fd55a56e456273ecb0de2475fceb0785a312a022cd48fa'
+  metadata.gz: 454c35bfd6c74cc2c125d8229ffe971cb178fb40f4d87affad0fc5d345301fd4d5a0e32a15852f05eb35231e0054b2a5b55ff2a4eb7253cc85aef17f4d17e178
+  data.tar.gz: 33b41ed491f7cc8238f3c3d99b2d72e2b0197dce29146dd14bdc704dd0ea6fa64788c97ed5d60bda60ef4602e9e6dedb2d22b02a1f8886a5c4592a522d96886e

data/lib/raindown/actions.rb

@@ -30,7 +30,7 @@ module Raindown
       raise NotAnEndpoint, "#{directive.name} on line #{directive.line} isn't an endpoint" unless directive.endpoint?
 
       content = File.read(path, encoding: Encoding::UTF_8)
-      rewritten = EndpointRunner.new(content:, bare: BareDirectives.file?(path), only: directive.line - 1).rewrite
+      rewritten = EndpointRunner.new(content:, bare: BareDirectives.enabled?(path:, content:), only: directive.line - 1).rewrite
       return false if rewritten == content
 
       File.write(path, rewritten)

data/lib/raindown/bare_directives.rb

@@ -5,7 +5,8 @@ require_relative 'front_matter'
 
 module Raindown
   # Raindown files (.rd/.raindown) can write a directive like <{ if: draft }> as a bare if: draft on its own line.
-  # Markdown files opt in with the --bare flag. Nodes like toc: and files: are handled by NodeBlocks, before the rest.
+  # Markdown files opt in with "raindown: true" in their front matter, or with the --bare flag.
+  # Nodes like toc: and files: are handled by NodeBlocks, before the rest.
   #
   # Bare directives have no end tag. A bare block directive closes itself after the content it applies to,
   # so where a block needs to wrap more than that, write it with delimiters and an end tag instead:
@@ -24,8 +25,8 @@ module Raindown
 
     module_function
 
-    def enabled?(path: nil, bare: false)
-      bare || file?(path)
+    def enabled?(path: nil, content: nil, bare: false)
+      bare || file?(path) || front_matter?(content)
     end
 
     def file?(path)
@@ -34,6 +35,16 @@ module Raindown
       EXTENSIONS.include?(File.extname(path).downcase)
     end
 
+    # Whether the front matter has "raindown: true". Front matter that isn't valid YAML fails when the file renders,
+    # so here it only means no.
+    def front_matter?(content)
+      return false unless content&.start_with?('---')
+
+      FrontMatter.parse(content).first[:raindown] == true
+    rescue Psych::Exception
+      false
+    end
+
     # Wrap each bare directive in Antlers delimiters and close its block, leaving code and front matter as-is.
     def expand(content)
       lines = content.lines

data/lib/raindown/document.rb

@@ -32,8 +32,8 @@ module Raindown
       new(markdown:, bare:)
     end
 
-    # Raindown files read bare directives. A project's own nodes are only directives once they're loaded,
-    # like with Nodes.load(path), the same as when the file renders.
+    # Raindown files read bare directives, as do Markdown files with "raindown: true" front matter.
+    # A project's own nodes are only directives once they're loaded, like with Nodes.load(path), the same as when the file renders.
     def self.read(path)
       new(markdown: File.read(path, encoding: Encoding::UTF_8), bare: BareDirectives.file?(path))
     end
@@ -41,7 +41,7 @@ module Raindown
     def initialize(markdown:, bare: false)
       @markdown = markdown
       @lines = markdown.lines
-      @bare = bare
+      @bare = bare || BareDirectives.front_matter?(markdown)
     end
 
     # The headings in the order they appear, with their source text, like "Notes for {name}" before it's rendered.

data/lib/raindown/endpoint/endpoint_runner.rb

@@ -26,7 +26,7 @@ module Raindown
     FETCHED = /\A {0,3}<!-- raindown:fetched [^\n]*? -->[ \t]*$/
 
     def self.rewrite(content:, path: nil, bare: false, execute: false, **)
-      new(content:, bare: BareDirectives.enabled?(path:, bare:), execute:).rewrite
+      new(content:, bare: BareDirectives.enabled?(path:, content:, bare:), execute:).rewrite
     end
 
     def initialize(content:, bare: false, execute: false, only: nil)

data/lib/raindown/node_injector.rb

@@ -18,7 +18,7 @@ module Raindown
 
     def initialize(content:, path: nil, bare: false, metadata: NoMetadata)
       @content = content
-      @bare = BareDirectives.enabled?(path:, bare:)
+      @bare = BareDirectives.enabled?(path:, content:, bare:)
       @metadata = metadata
     end
 

data/lib/raindown.rb

@@ -47,6 +47,8 @@ module Raindown
   # Directives like "toc:" export to HTML as bold or comments depending on hide_directives config.
   # Code blocks are highlighted, unless highlight_code is false for a site that highlights code in the browser.
   def render(markdown:, metadata: NoMetadata, bare: false, hide_directives: false, highlight_code: true)
+    bare ||= BareDirectives.front_matter?(markdown)
+
     highlighting(highlight_code) do
       Fragments.collect do
         # Components' HTML goes back in, then their headings get unique ids, before nodes like the TOC see it.

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Raindown
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raindown
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - maedi