rundoc 4.1.0 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ca738c51da79babb0fba6093b9d2055e6efd6d435d56b3397aed926d002701d
-  data.tar.gz: be7e9bd2c06a3a0e92dd078a3cd66d67f77b7cf1f4490190281fb7e573f8696e
+  metadata.gz: 175e8af5e0beeb7acca8d32740f3379d68771ba207d723a1f51495848645249c
+  data.tar.gz: ac404b2c8337948628d7f18b90b20c57668f8a059d6e10c9c64354d21e04ac58
 SHA512:
-  metadata.gz: 7db578e4f26a9b347ca93d8ae5b4013ae9605feaff56ba937d1b22c1a78316764af8f96274d9f449c5640282df277a3ac06e0530e8f760e8153c029aa2f05a27
-  data.tar.gz: 4b71fb1cfd4851d58759ca443e9d17a365d485621d7c1763b570171557a89c79a52e67080f53c25f1d7c4057a2a4decd43e46df7aa34909dc627b2717668a77b
+  metadata.gz: 758367c980b07a1d57f63fd0272e16f4ac4a93c42e747b9da200891438e661cede3edde72bb23f25ceb3e8c35074c53a59cb0a7e141edcb78684569163134deb
+  data.tar.gz: 6250e519af65a9800d4bb41926adb1713ef8e12d22e4503bb8eb8369514ce82db1036e289b80d0bd0fa8fb5cdb5d2f92fc2dc6e9ce029f5fb4a873f872e8f310

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## HEAD
 
+## 4.1.2
+
+- Fix: Background task name lookup is now lazy, this fixes a bug when using `:::>- pre.erb background.start(...)` (https://github.com/zombocom/rundoc/pull/95)
+
+## 4.1.1
+
+- Fix: Visibility forwarding for `pre.erb` was accidentally reversed, this is now fixed. (https://github.com/zombocom/rundoc/pull/93)
+
 ## 4.1.0
 
 - Add: Rundoc command `pre.erb` command used for dynamically templating any command using ERB syntax. (https://github.com/zombocom/rundoc/pull/90)

data/README.md

@@ -74,7 +74,7 @@ This will generate a project folder with your project in it, and a markdown `REA
   - [$](#shell-commands)
   - [fail.$](#shell-commands)
 - Dynamic command templating
-  - [pre.erb](#pre.erb)
+  - [pre.erb](#preerb)
 - Printing
   - [print.text](#print)
   - [print.erb](#print)

data/lib/rundoc/code_command/background/log/clear.rb

@@ -1,7 +1,12 @@
 class Rundoc::CodeCommand::Background::Log
   class Clear < Rundoc::CodeCommand
     def initialize(name:)
-      @spawn = Rundoc::CodeCommand::Background::ProcessSpawn.find(name)
+      @name = name
+      @background = nil
+    end
+
+    def background
+      @background ||= Rundoc::CodeCommand::Background::ProcessSpawn.find(@name)
     end
 
     def to_md(env = {})
@@ -9,7 +14,7 @@ class Rundoc::CodeCommand::Background::Log
     end
 
     def call(env = {})
-      @spawn.log.truncate(0)
+      background.log.truncate(0)
       ""
     end
   end

data/lib/rundoc/code_command/background/log/read.rb

@@ -1,7 +1,12 @@
 class Rundoc::CodeCommand::Background::Log
   class Read < Rundoc::CodeCommand
     def initialize(name:)
-      @spawn = Rundoc::CodeCommand::Background::ProcessSpawn.find(name)
+      @name = name
+      @background = nil
+    end
+
+    def background
+      @background ||= Rundoc::CodeCommand::Background::ProcessSpawn.find(@name)
     end
 
     def to_md(env = {})
@@ -9,7 +14,7 @@ class Rundoc::CodeCommand::Background::Log
     end
 
     def call(env = {})
-      @spawn.log.read
+      background.log.read
     end
   end
 end

data/lib/rundoc/code_command/background/start.rb

@@ -3,20 +3,28 @@ require "tempfile"
 class Rundoc::CodeCommand::Background
   class Start < Rundoc::CodeCommand
     def initialize(command, name:, wait: nil, timeout: 5, log: Tempfile.new("log"), out: "2>&1", allow_fail: false)
+      @timeout = timeout
       @command = command
       @name = name
       @wait = wait
       @allow_fail = allow_fail
-      FileUtils.touch(log)
+      @log = log
+      @redirect = out
+      FileUtils.touch(@log)
 
-      @spawn = ProcessSpawn.new(
+      @background = nil
+    end
+
+    def background
+      @background ||= ProcessSpawn.new(
         @command,
-        timeout: timeout,
-        log: log,
-        out: out
-      )
-      puts "Spawning commmand: `#{@spawn.command}`"
-      ProcessSpawn.add(@name, @spawn)
+        timeout: @timeout,
+        log: @log,
+        out: @redirect
+      ).tap do |spawn|
+        puts "Spawning commmand: `#{spawn.command}`"
+        ProcessSpawn.add(@name, spawn)
+      end
     end
 
     def to_md(env = {})
@@ -24,14 +32,14 @@ class Rundoc::CodeCommand::Background
     end
 
     def call(env = {})
-      @spawn.wait(@wait)
-      @spawn.check_alive! unless @allow_fail
+      background.wait(@wait)
+      background.check_alive! unless @allow_fail
 
-      @spawn.log.read
+      background.log.read
     end
 
     def alive?
-      !!@spawn.alive?
+      !!background.alive?
     end
   end
 end

data/lib/rundoc/code_command/background/stdin_write.rb

@@ -6,10 +6,15 @@ class Rundoc::CodeCommand::Background
     def initialize(contents, name:, wait:, timeout: 5, ending: $/)
       @contents = contents
       @ending = ending
-      @spawn = Rundoc::CodeCommand::Background::ProcessSpawn.find(name)
       @wait = wait
+      @name = name
       @timeout_value = Integer(timeout)
       @contents_written = nil
+      @background = nil
+    end
+
+    def background
+      @background ||= Rundoc::CodeCommand::Background::ProcessSpawn.find(@name)
     end
 
     # The command is rendered (`:::>-`) by the output of the `def call` method.
@@ -20,11 +25,11 @@ class Rundoc::CodeCommand::Background
     # The contents produced by the command (`:::->`) are rendered by the `def to_md` method.
     def call(env = {})
       writecontents
-      @spawn.log.read
+      background.log.read
     end
 
     def writecontents
-      @contents_written ||= @spawn.stdin_write(
+      @contents_written ||= background.stdin_write(
         contents,
         wait: @wait,
         ending: @ending,

data/lib/rundoc/code_command/background/stop.rb

@@ -1,7 +1,12 @@
 class Rundoc::CodeCommand::Background
   class Stop < Rundoc::CodeCommand
     def initialize(name:)
-      @spawn = Rundoc::CodeCommand::Background::ProcessSpawn.find(name)
+      @name = name
+      @background = nil
+    end
+
+    def background
+      @background ||= Rundoc::CodeCommand::Background::ProcessSpawn.find(@name)
     end
 
     def to_md(env = {})
@@ -9,8 +14,8 @@ class Rundoc::CodeCommand::Background
     end
 
     def call(env = {})
-      @spawn.stop
-      @spawn.log.read
+      background.stop
+      background.log.read
     end
   end
 end

data/lib/rundoc/code_command/background/wait.rb

@@ -1,9 +1,14 @@
 class Rundoc::CodeCommand::Background
   class Wait < Rundoc::CodeCommand
     def initialize(name:, wait:, timeout: 5)
-      @spawn = Rundoc::CodeCommand::Background::ProcessSpawn.find(name)
+      @name = name
       @wait = wait
       @timeout_value = Integer(timeout)
+      @background = nil
+    end
+
+    def background
+      @background ||= Rundoc::CodeCommand::Background::ProcessSpawn.find(name)
     end
 
     def to_md(env = {})
@@ -11,7 +16,7 @@ class Rundoc::CodeCommand::Background
     end
 
     def call(env = {})
-      @spawn.wait(@wait, @timeout_value)
+      background.wait(@wait, @timeout_value)
       ""
     end
   end

data/lib/rundoc/code_command/pre/erb.rb

@@ -27,8 +27,8 @@ class Rundoc::CodeCommand
     def code
       @code ||= begin
         vis = +""
-        vis += @render_delegate_result ? ">" : "-"
         vis += @render_delegate_command ? ">" : "-"
+        vis += @render_delegate_result ? ">" : "-"
         code = [@line, @contents]
           .compact
           .reject(&:empty?)

data/lib/rundoc/version.rb

@@ -1,3 +1,3 @@
 module Rundoc
-  VERSION = "4.1.0"
+  VERSION = "4.1.2"
 end

data/test/integration/pre_erb_test.rb

@@ -1,6 +1,50 @@
 require "test_helper"
 
 class IntegrationPreErb < Minitest::Test
+  def test_result_visibility_forwarding
+    contents = <<~RUBY
+      ```
+      :::-> pre.erb $ echo <%= 1 + 1 %>
+      ```
+    RUBY
+
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        expected = <<~EOF
+          ```
+          2
+          ```
+        EOF
+
+        parsed = parse_contents(contents)
+        actual = parsed.to_md.gsub(Rundoc::FencedCodeBlock::AUTOGEN_WARNING, "").strip
+        assert_equal expected.strip, actual.strip
+      end
+    end
+  end
+
+  def test_command_visibility_forwarding
+    contents = <<~RUBY
+      ```
+      :::>- pre.erb $ echo <%= 1 + 1 %>
+      ```
+    RUBY
+
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        expected = <<~EOF
+          ```
+          $ echo 2
+          ```
+        EOF
+
+        parsed = parse_contents(contents)
+        actual = parsed.to_md.gsub(Rundoc::FencedCodeBlock::AUTOGEN_WARNING, "").strip
+        assert_equal expected.strip, actual.strip
+      end
+    end
+  end
+
   def test_file_write
     key = SecureRandom.hex
     contents = <<~RUBY

data/test/rundoc/code_commands/background_test.rb

@@ -4,15 +4,19 @@ class BackgroundTest < Minitest::Test
   def test_stdin_with_cat_echo
     Dir.mktmpdir do |dir|
       Dir.chdir(dir) do
-        background_start = Rundoc::CodeCommand::Background::Start.new("cat",
-          name: "cat")
-        background_start.call
-
-        output = Rundoc::CodeCommand::Background::StdinWrite.new(
+        # Intentionally out of order, should not raise an error as long as "cat"
+        # command exists at execution time
+        stdin_write = Rundoc::CodeCommand::Background::StdinWrite.new(
           "hello there",
           name: "cat",
           wait: "hello"
-        ).call
+        )
+
+        background_start = Rundoc::CodeCommand::Background::Start.new("cat",
+          name: "cat")
+
+        background_start.call
+        output = stdin_write.call
         assert_equal("hello there" + $/, output)
 
         Rundoc::CodeCommand::Background::Log::Clear.new(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rundoc
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.2
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-11 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor