rundoc 2.0.0 → 3.0.0

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

data/test/rundoc/regex_test.rb

@@ -190,4 +190,26 @@ class RegexTest < Minitest::Test
 
     assert_equal contents.strip, match.to_s.strip
   end
+
+  def test_codeblock_optional_newline_regex
+    code_block_with_newline = <<~MD
+      hi
+      ```
+      :::>> $ echo "hello"
+      ```
+    MD
+    code_block_without_newline = code_block_with_newline.strip
+
+    expected = <<~MD.strip
+      ```
+      :::>> $ echo "hello"
+      ```
+    MD
+    regex = Rundoc::Parser::CODEBLOCK_REGEX
+    match = code_block_with_newline.match(regex)
+    assert_equal expected, match.to_s.strip
+
+    match = code_block_without_newline.match(regex)
+    assert_equal expected, match.to_s.strip
+  end
 end

data/test/system/exe_cli_test.rb

@@ -0,0 +1,231 @@
+require "test_helper"
+
+class SystemsCliTest < Minitest::Test
+  def exe_path
+    root_dir.join("bin").join("rundoc")
+  end
+
+  def test_git
+    Dir.mktmpdir do |dir|
+      dir = Pathname(dir)
+      contents = fixture_path("simple_git").join("rundoc.md").read
+
+      dir.join("rundoc.md").write(contents)
+      run!("#{exe_path} #{dir.join("rundoc.md")}")
+
+      output_dir = dir.join(SUCCESS_DIRNAME)
+        .tap { |p| assert p.exist? }
+
+      assert output_dir.join(".git").exist?
+
+      readme = output_dir
+        .join("README.md")
+        .tap { |p| assert p.exist? }
+
+      assert readme.exist?
+
+      actual = strip_autogen_warning(readme.read)
+      assert actual.include?("$ echo \"hello world\"")
+    end
+  end
+
+  def test_help
+    output = run!("#{exe_path} --help")
+    assert output.include?("Usage:")
+  end
+
+  def test_force_fail_dir_protection
+    Dir.mktmpdir do |dir|
+      dir = Pathname(dir)
+      rundoc = dir.join("RUNDOC.md")
+      rundoc.write "Done"
+
+      not_empty = dir.join(FAILURE_DIRNAME).tap(&:mkpath).join("not_empty.txt")
+      not_empty.write("Not empty")
+
+      run!("#{exe_path} #{rundoc}", raise_on_nonzero_exit: false)
+      assert !$?.success?
+
+      assert not_empty.exist?
+
+      run!("#{exe_path} #{rundoc} --force", raise_on_nonzero_exit: false)
+      assert $?.success?
+      assert !not_empty.exist?
+    end
+  end
+
+  def test_force_success_dir_protection
+    Dir.mktmpdir do |dir|
+      dir = Pathname(dir)
+
+      rundoc = dir.join("RUNDOC.md")
+      rundoc.write "Done"
+
+      not_empty = dir.join(SUCCESS_DIRNAME).tap(&:mkpath).join("not_empty.txt")
+      not_empty.write("Not empty")
+
+      run!("#{exe_path} #{rundoc}", raise_on_nonzero_exit: false)
+      assert !$?.success?
+
+      assert not_empty.exist?
+
+      run!("#{exe_path} #{rundoc} --force", raise_on_nonzero_exit: false)
+      assert $?.success?
+      assert !not_empty.exist?
+    end
+  end
+
+  def test_dotenv
+    Dir.mktmpdir do |dir|
+      key = SecureRandom.hex
+      dir = Pathname(dir)
+      dotenv = dir.join("another").join("directory").tap(&:mkpath).join(".env")
+
+      dotenv.write <<~EOF
+        FLORP="#{key}"
+      EOF
+
+      rundoc = dir.join("RUNDOC.md")
+      rundoc.write <<~EOF
+        ```
+        :::>> $ echo $FLORP
+        ```
+      EOF
+
+      run!("#{exe_path} #{rundoc} --dotenv-path #{dotenv}")
+
+      readme = dir.join(SUCCESS_DIRNAME)
+        .tap { |p| assert p.exist? }
+        .join("README.md")
+        .tap { |p| assert p.exist? }
+
+      actual = strip_autogen_warning(readme.read)
+      expected = <<~EOF
+        ```
+        $ echo $FLORP
+        #{key}
+        ```
+      EOF
+      assert_equal expected.strip, actual.strip
+    end
+  end
+
+  def test_screenshots_dir
+    Dir.mktmpdir do |dir|
+      dir = Pathname(dir)
+      rundoc = dir.join("RUNDOC.md")
+      screenshots_dirname = "lol_screenshots"
+      rundoc.write <<~EOF
+        ```
+        :::>> website.visit(name: "example", url: "http://example.com")
+        :::>> website.screenshot(name: "example")
+        ```
+      EOF
+
+      run!("#{exe_path} #{rundoc} --screenshots-dir #{screenshots_dirname}")
+
+      dir.join(SUCCESS_DIRNAME)
+        .tap { |p| assert p.exist? }
+        .join(screenshots_dirname)
+        .tap { |p| assert p.exist? }
+
+      readme = dir.join(SUCCESS_DIRNAME).join("README.md").read
+      actual = strip_autogen_warning(readme)
+
+      expected = "![Screenshot of http://example.com/](#{screenshots_dirname}/screenshot_1.png)"
+      assert_equal expected, actual.strip
+    end
+  end
+
+  def test_output_filename
+    Dir.mktmpdir do |dir|
+      dir = Pathname(dir)
+      rundoc = dir.join("RUNDOC.md")
+      failure_dir = dir.join("lol")
+      rundoc.write "Done"
+
+      assert !failure_dir.exist?
+
+      run!("#{exe_path} #{rundoc} --output-filename tutorial.md")
+
+      tutorial_md = dir.join(SUCCESS_DIRNAME)
+        .tap { |p| assert p.exist? }
+        .join("tutorial.md")
+        .tap { |p| assert p.exist? }
+
+      actual = strip_autogen_warning(tutorial_md.read)
+      expected = "Done"
+
+      assert_equal expected.strip, actual.strip
+    end
+  end
+
+  def test_on_failure_dir
+    Dir.mktmpdir do |dir|
+      dir = Pathname(dir)
+      rundoc = dir.join("RUNDOC.md")
+      failure_dir = dir.join("lol")
+      rundoc.write <<~EOF
+        ```
+        :::>> $ touch lol.txt
+        :::>> $ echo "hello world" && exit 1
+        ```
+      EOF
+
+      assert !failure_dir.exist?
+
+      run!("#{exe_path} #{rundoc} --on-failure-dir #{failure_dir}", raise_on_nonzero_exit: false)
+      assert !$?.success?
+
+      assert failure_dir.exist?
+      assert !Dir.exist?(dir.join(FAILURE_DIRNAME))
+      assert failure_dir.join("lol.txt").exist?
+    end
+  end
+
+  def test_on_success_dir
+    Dir.mktmpdir do |dir|
+      dir = Pathname(dir)
+      rundoc = dir.join("RUNDOC.md")
+      success_dir = dir.join("lol")
+      rundoc.write "Done"
+
+      assert !success_dir.exist?
+      run!("#{exe_path} #{rundoc} --on-success-dir #{success_dir}")
+
+      assert success_dir.exist?
+      assert !Dir.exist?(dir.join(SUCCESS_DIRNAME))
+
+      readme = success_dir.join("README.md")
+      actual = strip_autogen_warning(readme.read)
+      expected = "Done"
+
+      assert_equal expected.strip, actual.strip
+    end
+  end
+
+  def test_simple_file
+    Dir.mktmpdir do |dir|
+      dir = Pathname(dir)
+      rundoc = dir.join("RUNDOC.md")
+      rundoc.write <<~EOF
+        ```
+        :::>> $ echo "hello world"
+        ```
+      EOF
+
+      run!("#{exe_path} #{rundoc}")
+
+      readme = dir.join(SUCCESS_DIRNAME).join("README.md")
+      actual = strip_autogen_warning(readme.read)
+      expected = <<~EOF
+        ```
+        $ echo "hello world"
+        hello world
+        ```
+      EOF
+
+      assert_equal expected.strip, actual.strip
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,3 +1,6 @@
+require "simplecov"
+SimpleCov.start
+
 require "bundler"
 
 Bundler.require
@@ -7,5 +10,75 @@ require "minitest/autorun"
 require "mocha/minitest"
 require "tmpdir"
 
-def assert_tests_run
+class Minitest::Test
+  SUCCESS_DIRNAME = Rundoc::CLI::DEFAULTS::ON_SUCCESS_DIR
+  FAILURE_DIRNAME = Rundoc::CLI::DEFAULTS::ON_FAILURE_DIR
+
+  def default_context(
+    output_dir: nil,
+    source_path: nil,
+    screenshots_dirname: nil
+  )
+
+    Rundoc::Context::Execution.new(
+      output_dir: output_dir || Pathname("/dev/null"),
+      source_path: source_path || Pathname("/dev/null"),
+      screenshots_dirname: screenshots_dirname || Pathname("/dev/null")
+    )
+  end
+
+  def parse_contents(
+    contents,
+    output_dir: nil,
+    source_path: nil,
+    screenshots_dirname: nil
+  )
+    context = default_context(
+      output_dir: output_dir,
+      source_path: source_path,
+      screenshots_dirname: screenshots_dirname
+    )
+    Rundoc::Parser.new(
+      contents,
+      context: context
+    )
+  end
+
+  def root_dir
+    Pathname(__dir__).join("..").expand_path
+  end
+
+  def fixture_path(dir = "")
+    root_dir.join("test").join("fixtures").join(dir)
+  end
+
+  def run!(cmd, raise_on_nonzero_exit: true)
+    out = `#{cmd} 2>&1`
+    raise "Command: #{cmd} failed: #{out}" if !$?.success? && raise_on_nonzero_exit
+    out
+  end
+
+  def strip_autogen_warning(string)
+    string.gsub!(Rundoc::CodeSection::AUTOGEN_WARNING, "")
+    string.gsub!(/<!-- STOP.*STOP -->/m, "")
+    string
+  end
+
+  class FakeExit
+    def initialize
+      @called = false
+      @value = nil
+    end
+
+    def exit(value = nil)
+      @called = true
+      @value = value
+    end
+
+    def called?
+      @called
+    end
+
+    attr_reader :value
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rundoc
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-09 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: RunDOC turns docs to runable code
 email:
 - richard.schneeman+rubygems@gmail.com
@@ -177,6 +191,7 @@ files:
 - ".gitignore"
 - ".standard.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Dockerfile
 - Gemfile
 - README.md
@@ -184,6 +199,7 @@ files:
 - bin/rundoc
 - lib/rundoc.rb
 - lib/rundoc/cli.rb
+- lib/rundoc/cli_argument_parser.rb
 - lib/rundoc/code_command.rb
 - lib/rundoc/code_command/background.rb
 - lib/rundoc/code_command/background/log/clear.rb
@@ -211,11 +227,26 @@ files:
 - lib/rundoc/code_command/website/visit.rb
 - lib/rundoc/code_command/write.rb
 - lib/rundoc/code_section.rb
+- lib/rundoc/context/after_build.rb
+- lib/rundoc/context/execution.rb
 - lib/rundoc/parser.rb
 - lib/rundoc/peg_parser.rb
 - lib/rundoc/version.rb
 - rundoc.gemspec
 - test/fixtures/build_logs/rundoc.md
+- test/fixtures/cnb/ruby/download.md
+- test/fixtures/cnb/ruby/image_structure.md
+- test/fixtures/cnb/ruby/intro.md
+- test/fixtures/cnb/ruby/multiple_langs.md
+- test/fixtures/cnb/ruby/rundoc.md
+- test/fixtures/cnb/ruby/what_is_pack_build.md
+- test/fixtures/cnb/shared/call_to_action.md
+- test/fixtures/cnb/shared/configure_builder.md
+- test/fixtures/cnb/shared/install_pack.md
+- test/fixtures/cnb/shared/pack_build.md
+- test/fixtures/cnb/shared/procfile.md
+- test/fixtures/cnb/shared/use_the_image.md
+- test/fixtures/cnb/shared/what_is_a_builder.md
 - test/fixtures/depend_on/dependency/rundoc.md
 - test/fixtures/depend_on/main/rundoc.md
 - test/fixtures/java/rundoc.md
@@ -227,7 +258,12 @@ files:
 - test/fixtures/require/dependency/rundoc.md
 - test/fixtures/require/main/rundoc.md
 - test/fixtures/screenshot/rundoc.md
+- test/fixtures/simple_git/rundoc.md
+- test/integration/after_build_test.rb
 - test/integration/print_test.rb
+- test/integration/require_test.rb
+- test/integration/website_test.rb
+- test/rundoc/cli_argument_parser_test.rb
 - test/rundoc/code_commands/append_file_test.rb
 - test/rundoc/code_commands/background_test.rb
 - test/rundoc/code_commands/bash_test.rb
@@ -239,6 +275,7 @@ files:
 - test/rundoc/peg_parser_test.rb
 - test/rundoc/regex_test.rb
 - test/rundoc/test_parse_java.rb
+- test/system/exe_cli_test.rb
 - test/test_helper.rb
 homepage: https://github.com/schneems/rundoc
 licenses:
@@ -259,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: RunDOC generates runable code from docs