rundoc 2.0.1 → 3.0.1

data/test/integration/after_build_test.rb

@@ -0,0 +1,62 @@
+require "test_helper"
+
+class IntegrationAfterBuildTest < Minitest::Test
+  def test_modifies_directory_structure
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        dir = Pathname(dir)
+
+        source_path = dir.join("RUNDOC.md")
+        source_path.write <<~EOF
+          ```
+          :::>> $ mkdir lol
+          :::>> $ touch lol/rofl.txt
+          ```
+        EOF
+
+        io = StringIO.new
+
+        Rundoc::CLI.new(
+          io: io,
+          source_path: source_path,
+          on_success_dir: dir.join(SUCCESS_DIRNAME)
+        ).call
+
+        assert dir.join(SUCCESS_DIRNAME).join("lol").exist?
+        assert dir.join(SUCCESS_DIRNAME).join("lol").join("rofl.txt").exist?
+
+        FileUtils.remove_entry_secure(dir.join(SUCCESS_DIRNAME))
+
+        source_path.write <<~EOF
+          ```
+          :::-- rundoc.configure
+          Rundoc.configure do |config|
+            config.after_build do |context|
+              Dir.glob(context.output_dir.join("lol").join("*")).each do |item|
+                FileUtils.mv(item, context.output_dir)
+              end
+
+              FileUtils.rm_rf(context.output_dir.join("lol"))
+            end
+          end
+          ```
+
+          ```
+          :::>> $ mkdir lol
+          :::>> $ touch lol/rofl.txt
+          ```
+        EOF
+
+        io = StringIO.new
+
+        Rundoc::CLI.new(
+          io: io,
+          source_path: source_path,
+          on_success_dir: dir.join(SUCCESS_DIRNAME)
+        ).call
+
+        assert dir.join(SUCCESS_DIRNAME).join("rofl.txt").exist?
+      end
+    end
+  end
+end

data/test/integration/print_test.rb

@@ -1,6 +1,6 @@
 require "test_helper"
 
-class ParserTest < Minitest::Test
+class IntegrationPrintTest < Minitest::Test
   def test_erb_shared_binding_persists_values
     key = SecureRandom.hex
     contents = <<~RUBY
@@ -20,7 +20,7 @@ class ParserTest < Minitest::Test
           one
           #{key}
         EOF
-        parsed = Rundoc::Parser.new(contents)
+        parsed = parse_contents(contents)
         actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
         assert_equal expected, actual
       end
@@ -43,7 +43,7 @@ class ParserTest < Minitest::Test
         expected = <<~EOF
           one
         EOF
-        parsed = Rundoc::Parser.new(contents)
+        parsed = parse_contents(contents)
         actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
         assert_equal expected, actual
       end
@@ -69,7 +69,7 @@ class ParserTest < Minitest::Test
           there
           ```
         EOF
-        parsed = Rundoc::Parser.new(contents)
+        parsed = parse_contents(contents)
         actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
         assert_equal expected, actual
       end
@@ -93,7 +93,7 @@ class ParserTest < Minitest::Test
           Hello
           there
         EOF
-        parsed = Rundoc::Parser.new(contents)
+        parsed = parse_contents(contents)
         actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
         assert_equal expected, actual
       end
@@ -117,7 +117,7 @@ class ParserTest < Minitest::Test
           Hello
           there
         EOF
-        parsed = Rundoc::Parser.new(contents)
+        parsed = parse_contents(contents)
         actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
         assert_equal expected, actual
       end
@@ -141,7 +141,7 @@ class ParserTest < Minitest::Test
           Hello
           there
         EOF
-        parsed = Rundoc::Parser.new(contents)
+        parsed = parse_contents(contents)
         actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
         assert_equal expected, actual
       end
@@ -162,7 +162,7 @@ class ParserTest < Minitest::Test
         expected = <<~EOF
           Hello there
         EOF
-        parsed = Rundoc::Parser.new(contents)
+        parsed = parse_contents(contents)
         actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
         assert_equal expected, actual
       end
@@ -185,7 +185,7 @@ class ParserTest < Minitest::Test
           Hello there
           ```
         EOF
-        parsed = Rundoc::Parser.new(contents)
+        parsed = parse_contents(contents)
         actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
         assert_equal expected, actual
       end

data/test/integration/require_test.rb

@@ -0,0 +1,63 @@
+require "test_helper"
+
+class IntegrationRequireTest < Minitest::Test
+  def test_require_embeds_results
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        dir = Pathname(dir)
+        source_path = dir.join("RUNDOC.md")
+        source_path.write <<~EOF
+          ```
+          :::>> rundoc.require "./day_one/rundoc.md"
+          ```
+        EOF
+
+        dir.join("day_one").tap(&:mkpath).join("rundoc.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
+
+  def test_require_runs_code_but_embeds_nothing_if_hidden
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        dir = Pathname(dir)
+        source_path = dir.join("RUNDOC.md")
+        source_path.write <<~EOF
+          ```
+          :::-- rundoc.require "./day_one/rundoc.md"
+          ```
+        EOF
+
+        dir.join("day_one").tap(&:mkpath).join("rundoc.md").write <<~EOF
+          ```
+          :::-> print.text Hello World!
+          :::>> $ echo "echo hello world" > foo.txt
+          ```
+        EOF
+
+        parsed = parse_contents(
+          source_path.read,
+          source_path: source_path
+        )
+        actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
+        # Command was run
+        assert dir.join("foo.txt").exist?
+        assert "echo hello world", dir.join("foo.txt").read.strip
+
+        # But nothing was embedded
+        assert_equal "", actual.strip
+      end
+    end
+  end
+end

data/test/integration/website_test.rb

@@ -0,0 +1,35 @@
+require "test_helper"
+
+class IntegrationWebsiteTest < Minitest::Test
+  def test_screenshot_command
+    contents = <<~RUBY
+      ```
+      :::>> website.visit(name: "example", url: "http://example.com")
+      :::>> website.screenshot(name: "example")
+      ```
+    RUBY
+
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        env = {}
+        env[:before] = []
+
+        screenshots_dirname = "screenshots"
+        screenshots_dir = Pathname(dir).join(screenshots_dirname)
+        screenshot_1_path = screenshots_dir.join("screenshot_1.png")
+
+        parsed = parse_contents(
+          contents,
+          output_dir: screenshots_dir.parent,
+          screenshots_dirname: screenshots_dirname
+        )
+        actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
+
+        expected = "![Screenshot of https://example.com/](screenshots/screenshot_1.png)"
+        assert_equal expected, actual.strip
+
+        assert screenshot_1_path.exist?
+      end
+    end
+  end
+end

data/test/rundoc/cli_argument_parser_test.rb

@@ -0,0 +1,118 @@
+require "test_helper"
+
+class CliArgumentParserTest < Minitest::Test
+  def test_help
+    io = StringIO.new
+    exit_obj = FakeExit.new
+    parser = Rundoc::CLIArgumentParser.new(
+      io: io,
+      argv: ["--help"],
+      env: {},
+      exit_obj: exit_obj
+    )
+    parser.call
+    output = io.string
+
+    assert output.include?("Prints this help output")
+  end
+
+  def test_help_no_flag
+    io = StringIO.new
+    exit_obj = FakeExit.new
+    parser = Rundoc::CLIArgumentParser.new(
+      io: io,
+      argv: ["help"],
+      env: {},
+      exit_obj: exit_obj
+    )
+    parser.call
+    output = io.string
+
+    assert output.include?("Prints this help output")
+  end
+
+  def test_no_such_file
+    io = StringIO.new
+    exit_obj = FakeExit.new
+    parser = Rundoc::CLIArgumentParser.new(
+      io: io,
+      argv: ["fileDoesNotExist.txt"],
+      env: {},
+      exit_obj: exit_obj
+    )
+    parser.call
+    output = io.string
+
+    assert exit_obj.value == 1
+    assert_includes output, "No such file"
+  end
+
+  def test_dir_not_file
+    Dir.mktmpdir do |dir|
+      io = StringIO.new
+      exit_obj = FakeExit.new
+      parser = Rundoc::CLIArgumentParser.new(
+        io: io,
+        argv: [dir],
+        env: {},
+        exit_obj: exit_obj
+      )
+      parser.call
+      output = io.string
+
+      assert exit_obj.value == 1
+      assert_includes output, "Path is not a file"
+    end
+  end
+
+  def test_valid_inputs
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        tmp = Pathname(dir)
+        rundoc = tmp.join("rundoc.md")
+        rundoc.write("")
+
+        io = StringIO.new
+        exit_obj = FakeExit.new
+        parser = Rundoc::CLIArgumentParser.new(
+          io: io,
+          argv: [
+            rundoc,
+            "--on-success-dir=./success",
+            "--on-failure-dir=./failure",
+            "--dotenv-path=./lol/.env",
+            "--screenshots-dirname=pics",
+            "--output-filename=OUTPUT.md",
+            "--force"
+          ],
+          env: {},
+          exit_obj: exit_obj
+        )
+        parser.call
+        output = io.string
+
+        assert !exit_obj.called?
+        assert output.empty?
+
+        assert_equal "./success", parser.options[:on_success_dir]
+        assert_equal "./failure", parser.options[:on_failure_dir]
+        assert_equal "./lol/.env", parser.options[:dotenv_path]
+        assert_equal "pics", parser.options[:screenshots_dirname]
+        assert_equal "OUTPUT.md", parser.options[:output_filename]
+        assert_equal true, parser.options[:force]
+
+        expected = [
+          :on_success_dir,
+          :on_failure_dir,
+          :dotenv_path,
+          :screenshots_dirname,
+          :output_filename,
+          :force,
+          :io,
+          :source_path
+        ]
+        assert_equal expected.sort, parser.options.keys.sort
+      end
+    end
+  end
+end

data/test/rundoc/code_section_test.rb

@@ -15,7 +15,11 @@ class CodeSectionTest < Minitest::Test
     Dir.mktmpdir do |dir|
       Dir.chdir(dir) do
         match = contents.match(Rundoc::Parser::CODEBLOCK_REGEX)
-        result = Rundoc::CodeSection.new(match, keyword: ":::").render
+        result = Rundoc::CodeSection.new(
+          match,
+          keyword: ":::",
+          context: default_context
+        ).render
         assert_equal "", result
       end
     end
@@ -30,7 +34,11 @@ class CodeSectionTest < Minitest::Test
     RUBY
 
     match = contents.match(Rundoc::Parser::CODEBLOCK_REGEX)
-    result = Rundoc::CodeSection.new(match, keyword: ":::").render
+    result = Rundoc::CodeSection.new(
+      match,
+      keyword: ":::",
+      context: default_context
+    ).render
     assert_equal contents, result.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "\n")
   end
 
@@ -42,7 +50,11 @@ class CodeSectionTest < Minitest::Test
     RUBY
 
     match = contents.match(Rundoc::Parser::CODEBLOCK_REGEX)
-    code_section = Rundoc::CodeSection.new(match, keyword: ":::")
+    code_section = Rundoc::CodeSection.new(
+      match,
+      keyword: ":::",
+      context: default_context
+    )
     code_section.render
 
     code_command = code_section.commands.first
@@ -56,7 +68,11 @@ class CodeSectionTest < Minitest::Test
     RUBY
 
     match = contents.match(Rundoc::Parser::CODEBLOCK_REGEX)
-    code_section = Rundoc::CodeSection.new(match, keyword: ":::")
+    code_section = Rundoc::CodeSection.new(
+      match,
+      keyword: ":::",
+      context: default_context
+    )
     code_section.render
 
     code_command = code_section.commands.first
@@ -72,7 +88,11 @@ class CodeSectionTest < Minitest::Test
     RUBY
 
     match = contents.match(Rundoc::Parser::CODEBLOCK_REGEX)
-    code_section = Rundoc::CodeSection.new(match, keyword: ":::")
+    code_section = Rundoc::CodeSection.new(
+      match,
+      keyword: ":::",
+      context: default_context
+    )
     code_section.render
 
     puts code_section.commands.inspect
@@ -89,7 +109,11 @@ class CodeSectionTest < Minitest::Test
     RUBY
 
     match = contents.match(Rundoc::Parser::CODEBLOCK_REGEX)
-    code_section = Rundoc::CodeSection.new(match, keyword: ":::")
+    code_section = Rundoc::CodeSection.new(
+      match,
+      keyword: ":::",
+      context: default_context
+    )
     code_section.render
 
     code_command = code_section.commands.first
@@ -103,7 +127,11 @@ class CodeSectionTest < Minitest::Test
     RUBY
 
     match = contents.match(Rundoc::Parser::CODEBLOCK_REGEX)
-    code_section = Rundoc::CodeSection.new(match, keyword: ":::")
+    code_section = Rundoc::CodeSection.new(
+      match,
+      keyword: ":::",
+      context: default_context
+    )
     code_section.render
 
     code_command = code_section.commands.first
@@ -119,7 +147,11 @@ class CodeSectionTest < Minitest::Test
     RUBY
 
     match = contents.match(Rundoc::Parser::CODEBLOCK_REGEX)
-    code_section = Rundoc::CodeSection.new(match, keyword: ":::")
+    code_section = Rundoc::CodeSection.new(
+      match,
+      keyword: ":::",
+      context: default_context
+    )
     code_section.render
 
     code_command = code_section.commands.first

data/test/rundoc/parser_test.rb

@@ -16,7 +16,7 @@ class ParserTest < Minitest::Test
     Dir.mktmpdir do |dir|
       Dir.chdir(dir) do
         expected = "sup\n\n```\n$ mkdir foo\n$ ls\nfoo\n```\n\nyo\n"
-        parsed = Rundoc::Parser.new(contents)
+        parsed = parse_contents(contents)
         actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
         assert_equal expected, actual
       end
@@ -38,7 +38,7 @@ class ParserTest < Minitest::Test
     Dir.mktmpdir do |dir|
       Dir.chdir(dir) do
         expected = "sup\n\nIn file `foo/code.rb` write:\n\n```\na = 1 + 1\nb = a * 2\n```\nyo\n"
-        parsed = Rundoc::Parser.new(contents)
+        parsed = parse_contents(contents)
         actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
         assert_equal expected, actual
       end
@@ -56,7 +56,7 @@ class ParserTest < Minitest::Test
     Dir.mktmpdir do |dir|
       Dir.chdir(dir) do
         expected = "\nIn file `foo/newb.rb` write:\n\n```\nputs 'hello world'\n$ cat foo/newb.rb\nputs 'hello world'\n```\n"
-        parsed = Rundoc::Parser.new(contents)
+        parsed = parse_contents(contents)
         actual = parsed.to_md.gsub(Rundoc::CodeSection::AUTOGEN_WARNING, "")
         assert_equal expected, actual
       end

data/test/rundoc/peg_parser_test.rb

@@ -270,36 +270,36 @@ class PegParserTest < Minitest::Test
 
   def test_rundoc_sub_commands_no_quotes
     input = +""
-    input << %(:::-- rundoc.depend_on ../foo/bar.md\n)
+    input << %(:::-- rundoc.require ../foo/bar.md\n)
 
     parser = Rundoc::PegParser.new.command_with_stdin
     tree = parser.parse_with_debug(input)
 
     actual = @transformer.apply(tree)
-    assert_equal :"rundoc.depend_on", actual.keyword
+    assert_equal :"rundoc.require", actual.keyword
   end
 
   def test_seattle_style_method_call
     input = +""
-    input << %(rundoc.depend_on '../foo/bar.md')
+    input << %(rundoc.require '../foo/bar.md')
     parser = Rundoc::PegParser.new.method_call
     tree = parser.parse_with_debug(input)
 
     actual = @transformer.apply(tree)
 
-    assert_equal :"rundoc.depend_on", actual.keyword
+    assert_equal :"rundoc.require", actual.keyword
   end
 
   def test_rundoc_seattle_sub_command
     input = +""
-    input << %(:::>> rundoc.depend_on '../foo/bar.md'\n)
+    input << %(:::>> rundoc.require '../foo/bar.md'\n)
 
     parser = Rundoc::PegParser.new.command
     tree = parser.parse_with_debug(input)
 
     actual = @transformer.apply(tree)
 
-    assert_equal :"rundoc.depend_on", actual.keyword
+    assert_equal :"rundoc.require", actual.keyword
   end
 
   def test_positional_args