rundoc 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d21f4ac48ad2eab762969c03ce386aeb097f99162d38716e4736de44c9bbac83
-  data.tar.gz: 79f9be265a84d8474e3ed7d55d90781e9999790b6cf5e578943db89e0fec7ee9
+  metadata.gz: 2c2298eda9572df3a7acbb3d9a81ba5bdc2b5c80ba5ebc913d22308780aeff47
+  data.tar.gz: d9b2f86f1cfe167657f4d0d76c23f44340b6f992b959864401c1496241fbcbea
 SHA512:
-  metadata.gz: fcf456c89f09000ddeeaf7aa22654acf419f36294b9e88dec9735f9ec3fcab315085dd6ee97cbd63eb580078e009968219b5240a6fe7a6db4c022d1b878d97cb
-  data.tar.gz: 8e2ee0bd6fa26b8b8906ec9b2267a9e98feedc40b54dc53ca457937a7199865c2c6b7663837a067802426321fc93740da3038289ea516139a573a1e5679c8724
+  metadata.gz: 0db0233ad2b0773f453f2eb487bebc2d3cd3fb114f44aaf2295206250722ca3c4a29ceb558d1546de88865cdb120bc113ac828397b9a50c04c06b50e9aa0a0d2
+  data.tar.gz: d89e65b47bca1d1bd76f5894621c2ea53a957215008b043e3be6e672e87093e3a6af3a8696c9ab03e1dcf2ebb39b8362b882bc38235a0e4c1718744f30d2592c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## HEAD
 
+## 3.1.2
+
+- Fix: Using `rundoc.require` inside of a document that was `rundoc.require`-d now sources files from the correct relative document path (https://github.com/zombocom/rundoc/pull/84)
+- Fix: `rundoc <file> --with-contents <dir>` now expands the path passed in to the `--with-contents` so relative paths can safely be used (https://github.com/zombocom/rundoc/pull/83)
+
 ## 3.1.1
 
 - Fix: Include all code sections in the event of a failure, not just the last one (https://github.com/zombocom/rundoc/pull/71)

data/lib/rundoc/cli_argument_parser.rb

@@ -111,7 +111,7 @@ module Rundoc
         end
 
         opts.on("--with-contents <dir>", "Copies contents of directory into the tmp working dir") do |v|
-          options[:with_contents_dir] = v
+          options[:with_contents_dir] = File.expand_path(v)
         end
 
         opts.on("--on-success-dir <dir>", "Success dir, relative to CWD. i.e. `<rundoc.md/dir>/#{CLI::DEFAULTS::ON_SUCCESS_DIR}/`.") do |v|

data/lib/rundoc/code_command/rundoc/require.rb

@@ -14,12 +14,17 @@ class ::Rundoc::CodeCommand
       end
 
       def call(env = {})
-        document_path = @path.expand_path(env[:context].source_dir)
+        execution_context = env[:context]
+        document_path = @path.expand_path(execution_context.source_dir)
 
-        puts "rundoc.require: Start executing #{@path.to_s.inspect}"
         output = Rundoc::Parser.new(
           document_path.read,
-          context: env[:context]
+          context: Rundoc::Context::Execution.new(
+            source_path: document_path,
+            output_dir: execution_context.output_dir,
+            screenshots_dirname: execution_context.screenshots_dir,
+            with_contents_dir: execution_context.with_contents_dir
+          )
         ).to_md
 
         if render_result?

data/lib/rundoc/version.rb

@@ -1,3 +1,3 @@
 module Rundoc
-  VERSION = "3.1.1"
+  VERSION = "3.1.2"
 end

data/test/integration/require_test.rb

@@ -60,4 +60,38 @@ class IntegrationRequireTest < Minitest::Test
       end
     end
   end
+
+  def test_require_is_relative_to_current_file_not_source_file
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        dir = Pathname(dir)
+
+        source_path = dir.join("RUNDOC.md")
+        source_path.write <<~EOF
+          ```
+          :::>> rundoc.require "./src/a.md"
+          ```
+        EOF
+
+        dir.join("src").tap(&:mkpath).join("a.md").write <<~EOF
+          ```
+          :::-> rundoc.require "./b.md"
+          ```
+        EOF
+
+        dir.join("src").join("b.md").write <<~EOF
+          ```
+          :::-> print.text Hello World!
+          ```
+        EOF
+
+        parsed = parse_contents(
+          source_path.read,
+          source_path: source_path
+        )
+        actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
+        assert_equal "Hello World!", actual.strip
+      end
+    end
+  end
 end

metadata

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