rundoc 4.1.1 → 4.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 406f197901506713b700c1ff8511fb05904400f806c7dc9d1a134e2b04ab13ab
-  data.tar.gz: 5b09bdd1560879915be2b52f1f36a13626fe2edfd696a14e66f90d5849b999fc
+  metadata.gz: b65a04eca7d7099223b2a626c47eb78e14a8e102266cf880cddc747a0d9fc4a5
+  data.tar.gz: 840585e8f0c6b3cddbb1d15354f4fdf862d2440b20054cd1b5344c026adb23d9
 SHA512:
-  metadata.gz: '089c0ed9bb56187b8d18ff8eb55662ddf88f592329c028ff24478723bf044e87e75fbc6c84e903bb34bb3e111134a48a6b54861d6af1eb0e2cb9dc533a812da4'
-  data.tar.gz: f616697430af9d1948d64a9a97a7902ccc3dfa8a61cc4bc4a5b7d3e109944ec50e1475b6889c1168fceba5a733b4d34adc5dd0d068ddff85fcfbff40ee2e8438
+  metadata.gz: 99661d14543918c21a988bd1c4cffc1d5c9d73a852a95c16b0905b5ddde312dc986d970b4082921752cd2eac4d786a0ae37f42f3577fdea2df54c6de50376810
+  data.tar.gz: 6819d3babc4cb2a7ad1f76386e3d7e7f28886a989e6a31ef052ea87b3b226a6979cc1c2092653fa7aadadd34d3f8af9b268464c2a14c70f385b559ee8a13ca9a

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## HEAD
 
+## 4.1.3
+
+- Fix: Internal error in `background.wait` introduced in 4.1.2 (https://github.com/zombocom/rundoc/pull/97)
+- Fix: Website commands such as `:::>> website.visit(...)` now use lazy lookup (like Background tasks since 4.1.2). This allows `pre.erb` to be used with these commands (https://github.com/zombocom/rundoc/pull/98)
+
+## 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)

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/website/navigate.rb

@@ -2,7 +2,11 @@ class Rundoc::CodeCommand::Website
   class Navigate < Rundoc::CodeCommand
     def initialize(name:)
       @name = name
-      @driver = Rundoc::CodeCommand::Website::Driver.find(name)
+      @driver = nil
+    end
+
+    def driver
+      @driver ||= Rundoc::CodeCommand::Website::Driver.find(@name)
     end
 
     def to_md(env = {})
@@ -11,7 +15,7 @@ class Rundoc::CodeCommand::Website
 
     def call(env = {})
       puts "website.navigate [#{@name}]: #{contents}"
-      @driver.safe_eval(contents, env)
+      driver.safe_eval(contents, env)
       ""
     end
 

data/lib/rundoc/code_command/website/screenshot.rb

@@ -1,8 +1,13 @@
 class Rundoc::CodeCommand::Website
   class Screenshot < Rundoc::CodeCommand
     def initialize(name:, upload: false)
-      @driver = Rundoc::CodeCommand::Website::Driver.find(name)
+      @name = name
       @upload = upload
+      @driver = nil
+    end
+
+    def driver
+      @driver ||= Rundoc::CodeCommand::Website::Driver.find(@name)
     end
 
     def to_md(env = {})
@@ -10,14 +15,14 @@ class Rundoc::CodeCommand::Website
     end
 
     def call(env = {})
-      puts "Taking screenshot: #{@driver.current_url}"
-      filename = @driver.screenshot(
+      puts "Taking screenshot: #{driver.current_url}"
+      filename = driver.screenshot(
         upload: @upload,
         screenshots_dir: env[:context].screenshots_dir
       )
 
       relative_filename = filename.relative_path_from(env[:context].output_dir)
-      env[:before] << "![Screenshot of #{@driver.current_url}](#{relative_filename})"
+      env[:before] << "![Screenshot of #{driver.current_url}](#{relative_filename})"
       ""
     end
 

data/lib/rundoc/code_command/website/visit.rb

@@ -6,14 +6,21 @@ class Rundoc::CodeCommand::Website
       @name = name
       @url = url
       @scroll = scroll
-      @driver = Driver.new(
-        name: name,
-        url: url,
-        height: height,
-        width: width,
-        visible: visible
-      )
-      Driver.add(@name, @driver)
+      @height = height
+      @width = width
+      @visible = visible
+    end
+
+    def driver
+      @driver ||= Driver.new(
+        name: @name,
+        url: @url,
+        height: @height,
+        width: @width,
+        visible: @visible
+      ).tap do |driver|
+        Driver.add(@name, driver)
+      end
     end
 
     def to_md(env = {})
@@ -26,11 +33,11 @@ class Rundoc::CodeCommand::Website
 
       puts message
 
-      @driver.visit(@url) if @url
-      @driver.scroll(@scroll) if @scroll
+      driver.visit(@url) if @url
+      driver.scroll(@scroll) if @scroll
 
       return "" if contents.nil? || contents.empty?
-      @driver.safe_eval(contents, env)
+      driver.safe_eval(contents, env)
 
       ""
     end

data/lib/rundoc/version.rb

@@ -1,3 +1,3 @@
 module Rundoc
-  VERSION = "4.1.1"
+  VERSION = "4.1.3"
 end

data/test/integration/website_test.rb

@@ -6,6 +6,8 @@ class IntegrationWebsiteTest < Minitest::Test
       ```
       :::>> website.visit(name: "example", url: "http://example.com")
       :::>> website.screenshot(name: "example")
+      :::>> website.navigate(name: "example")
+      session.execute_script "window.scrollBy(0,10)"
       ```
     RUBY
 

data/test/rundoc/code_commands/background_test.rb

@@ -4,16 +4,25 @@ class BackgroundTest < Minitest::Test
   def test_stdin_with_cat_echo
     Dir.mktmpdir do |dir|
       Dir.chdir(dir) do
+        # 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"
+        )
+
         background_start = Rundoc::CodeCommand::Background::Start.new("cat",
           name: "cat")
+
         background_start.call
+        output = stdin_write.call
+        assert_equal("hello there" + $/, output)
 
-        output = Rundoc::CodeCommand::Background::StdinWrite.new(
-          "hello there",
+        Rundoc::CodeCommand::Background::Wait.new(
           name: "cat",
           wait: "hello"
         ).call
-        assert_equal("hello there" + $/, output)
 
         Rundoc::CodeCommand::Background::Log::Clear.new(
           name: "cat"

metadata

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