rundoc 4.1.4 → 5.0.0

data/test/rundoc/code_commands/comment_test.rb

@@ -0,0 +1,116 @@
+require "test_helper"
+
+class CommentTest < Minitest::Test
+  def test_comment_runner_call_returns_empty_string
+    io = StringIO.new
+    runner = Rundoc::CodeCommand::CommentRunner.new(
+      render_command: false,
+      render_result: false,
+      io: io,
+      user_args: Rundoc::CodeCommand::CommentArgs.new("$ cat hello")
+    )
+    assert_equal "", runner.call
+    assert_equal "", runner.to_md
+    assert_equal "Skipping command (commented out): # $ cat hello\n", io.string
+  end
+
+  def test_comment_with_contents
+    io = StringIO.new
+    runner = Rundoc::CodeCommand::CommentRunner.new(
+      render_command: false,
+      render_result: false,
+      io: io,
+      user_args: Rundoc::CodeCommand::CommentArgs.new("$ tail -n 2"),
+      contents: "foo\nbar\nbaz\n"
+    )
+    assert_equal "", runner.call
+    expected = <<~EOF
+      Skipping command (commented out): # $ tail -n 2
+      foo
+      bar
+      baz
+    EOF
+    assert_equal expected.strip, io.string.strip
+  end
+
+  def test_comment_is_noop_in_document
+    contents = <<~EOF
+      before
+
+      ```
+      :::>> # $ cat hello
+      ```
+
+      after
+    EOF
+
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        parsed = parse_contents(contents)
+        actual = strip_autogen_warning(parsed.to_md)
+        assert_equal "before\n\n\nafter\n", actual
+      end
+    end
+  end
+
+  def test_smudged_comment
+    contents = <<~EOF
+      before
+
+      ```
+      :::>> #$ cat hello
+      ```
+
+      after
+    EOF
+
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        parsed = parse_contents(contents)
+        actual = strip_autogen_warning(parsed.to_md)
+        assert_equal "before\n\n\nafter\n", actual
+      end
+    end
+  end
+
+  def test_bare_comment_is_noop
+    contents = <<~EOF
+      before
+
+      ```
+      :::>> #
+      ```
+
+      after
+    EOF
+
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        parsed = parse_contents(contents)
+        actual = strip_autogen_warning(parsed.to_md)
+        assert_equal "before\n\n\nafter\n", actual
+      end
+    end
+  end
+
+  def test_comment_does_not_affect_other_commands
+    contents = <<~EOF
+      before
+
+      ```
+      :::>> # this is commented out
+      :::>> $ echo "hello"
+      ```
+
+      after
+    EOF
+
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        parsed = parse_contents(contents)
+        actual = strip_autogen_warning(parsed.to_md)
+        assert_equal "before\n\n```\n$ echo \"hello\"\nhello\n```\n\nafter\n", actual
+      end
+    end
+  end
+end

data/test/rundoc/code_commands/pipe_test.rb

@@ -5,7 +5,7 @@ class PipeTest < Minitest::Test
     pipe_cmd = "tail -n 2"
     cmd = "ls"
     out = `#{cmd}`
-    pipe = Rundoc::CodeCommand::Pipe.new(pipe_cmd)
+    pipe = Rundoc::CodeCommand::PipeRunner.new(render_command: false, render_result: false, io: StringIO.new, user_args: Rundoc::CodeCommand::PipeArgs.new(pipe_cmd))
     actual = pipe.call(commands: [{command: cmd, output: out}])
 
     expected = `#{cmd} | #{pipe_cmd}`
@@ -16,7 +16,7 @@ class PipeTest < Minitest::Test
     pipe_cmd = "tail -n 2"
     cmd = "ls"
     out = `#{cmd}`
-    pipe = Rundoc::CodeCommand::Pipe.new("$ #{pipe_cmd}")
+    pipe = Rundoc::CodeCommand::PipeRunner.new(render_command: false, render_result: false, io: StringIO.new, user_args: Rundoc::CodeCommand::PipeArgs.new("$ #{pipe_cmd}"))
     actual = pipe.call(commands: [{command: cmd, output: out}])
 
     expected = `#{cmd} | #{pipe_cmd}`

data/test/rundoc/code_commands/print_test.rb

@@ -6,9 +6,7 @@ class PrintTest < Minitest::Test
     env[:before] = []
 
     input = %($ rails new myapp # Not a command since it's missing the ":::>>")
-    cmd = Rundoc::CodeCommand::PrintText.new(input)
-    cmd.render_command = false
-    cmd.render_result = true
+    cmd = Rundoc::CodeCommand::PrintTextRunner.new(user_args: Rundoc::CodeCommand::PrintTextArgs.new(input), io: StringIO.new, render_command: false, render_result: true)
 
     assert_equal "", cmd.to_md(env)
     assert_equal "", cmd.call
@@ -20,9 +18,7 @@ class PrintTest < Minitest::Test
     env[:before] = []
 
     input = %($ rails new myapp # Not a command since it's missing the ":::>>")
-    cmd = Rundoc::CodeCommand::PrintText.new(input)
-    cmd.render_command = true
-    cmd.render_result = true
+    cmd = Rundoc::CodeCommand::PrintTextRunner.new(user_args: Rundoc::CodeCommand::PrintTextArgs.new(input), io: StringIO.new, render_command: true, render_result: true)
 
     assert_equal "", cmd.to_md(env)
     assert_equal input, cmd.call
@@ -35,9 +31,7 @@ class PrintTest < Minitest::Test
     env[:before] = []
 
     input = %($ rails new <%= 'myapp' %> # Not a command since it's missing the ":::>>")
-    cmd = Rundoc::CodeCommand::PrintERB.new(input)
-    cmd.render_command = false
-    cmd.render_result = true
+    cmd = Rundoc::CodeCommand::PrintERBRunner.new(user_args: Rundoc::CodeCommand::PrintERBArgs.new(input), io: StringIO.new, render_command: false, render_result: true)
 
     assert_equal "", cmd.to_md(env)
     assert_equal "", cmd.call
@@ -49,10 +43,7 @@ class PrintTest < Minitest::Test
     env = {}
     env[:before] = []
 
-    cmd = Rundoc::CodeCommand::PrintERB.new
-    cmd.contents = %(<%= "foo" %>)
-    cmd.render_command = true
-    cmd.render_result = true
+    cmd = Rundoc::CodeCommand::PrintERBRunner.new(user_args: Rundoc::CodeCommand::PrintERBArgs.new, io: StringIO.new, render_command: true, render_result: true, contents: %(<%= "foo" %>))
 
     assert_equal "", cmd.to_md(env)
     assert_equal "foo", cmd.call
@@ -62,10 +53,13 @@ class PrintTest < Minitest::Test
   def test_binding_is_preserved
     env = {}
     env[:before] = []
-    cmd = Rundoc::CodeCommand::PrintERB.new
-    cmd.contents = %{<%= @foo = SecureRandom.hex(16) %>}
-    cmd.render_command = true
-    cmd.render_result = true
+    cmd = Rundoc::CodeCommand::PrintERBRunner.new(
+      user_args: Rundoc::CodeCommand::PrintERBArgs.new,
+      io: StringIO.new,
+      contents: %{<%= @foo = SecureRandom.hex(16) %>},
+      render_command: true,
+      render_result: true
+    )
 
     assert_equal "", cmd.to_md(env)
     assert_equal [], env[:before]
@@ -73,19 +67,13 @@ class PrintTest < Minitest::Test
 
     assert !expected.empty?
 
-    cmd = Rundoc::CodeCommand::PrintERB.new
-    cmd.contents = %(<%= @foo %>)
-    cmd.render_command = true
-    cmd.render_result = true
+    cmd = Rundoc::CodeCommand::PrintERBRunner.new(user_args: Rundoc::CodeCommand::PrintERBArgs.new, io: StringIO.new, render_command: true, render_result: true, contents: %(<%= @foo %>))
 
     assert_equal "", cmd.to_md(env)
     assert_equal expected, cmd.call
     assert_equal [], env[:before]
 
-    cmd = Rundoc::CodeCommand::PrintERB.new(binding: "different")
-    cmd.contents = %(<%= @foo %>)
-    cmd.render_command = true
-    cmd.render_result = true
+    cmd = Rundoc::CodeCommand::PrintERBRunner.new(user_args: Rundoc::CodeCommand::PrintERBArgs.new(binding: "different"), io: StringIO.new, render_command: true, render_result: true, contents: %(<%= @foo %>))
 
     assert_equal "", cmd.to_md(env)
     assert_equal "", cmd.call

data/test/rundoc/code_commands/remove_contents_test.rb

@@ -21,8 +21,13 @@ class RemoveContentsTest < Minitest::Test
 
         assert_match(/sqlite3/, File.read(@file))
 
-        cc = Rundoc::CodeCommand::FileCommand::Remove.new(@file)
-        cc << "gem 'sqlite3'"
+        cc = Rundoc::CodeCommand::FileCommand::RemoveRunner.new(
+          render_command: false,
+          render_result: false,
+          user_args: Rundoc::CodeCommand::FileCommand::RemoveArgs.new(@file),
+          contents: "gem 'sqlite3'",
+          io: StringIO.new
+        )
         cc.call
 
         refute_match(/sqlite3/, File.read(@file))
@@ -33,7 +38,7 @@ class RemoveContentsTest < Minitest::Test
         env[:fence_start] = "```ruby"
         cc.to_md(env)
 
-        assert_equal ["In file `foo.rb` remove:", Rundoc::CodeCommand::NEWLINE], env[:before]
+        assert_equal ["In file `foo.rb` remove:", Rundoc::CodeCommand::FileCommand::RemoveRunner::NEWLINE], env[:before]
       end
     end
   end

data/test/rundoc/code_section_test.rb

@@ -19,7 +19,8 @@ class CodeSectionTest < Minitest::Test
           fence: match[:fence],
           lang: match[:lang],
           code: match[:contents],
-          context: default_context
+          context: default_context,
+          io: StringIO.new
         ).render
         assert_equal "", result
       end
@@ -39,7 +40,8 @@ class CodeSectionTest < Minitest::Test
       fence: match[:fence],
       lang: match[:lang],
       code: match[:contents],
-      context: default_context
+      context: default_context,
+      io: StringIO.new
     ).render
     assert_equal contents, result.gsub(Rundoc::FencedCodeBlock::AUTOGEN_WARNING, "\n")
   end
@@ -56,13 +58,14 @@ class CodeSectionTest < Minitest::Test
       fence: match[:fence],
       lang: match[:lang],
       code: match[:contents],
-      context: default_context
+      context: default_context,
+      io: StringIO.new
     )
     code_section.render
 
     code_command = code_section.executed_commands.first
-    assert_equal true, code_command.render_command
-    assert_equal false, code_command.render_result
+    assert_equal true, code_command.render_command?
+    assert_equal false, code_command.render_result?
 
     contents = <<~RUBY
       ```
@@ -75,13 +78,14 @@ class CodeSectionTest < Minitest::Test
       fence: match[:fence],
       lang: match[:lang],
       code: match[:contents],
-      context: default_context
+      context: default_context,
+      io: StringIO.new
     )
     code_section.render
 
     code_command = code_section.executed_commands.first
-    assert_equal true, code_command.render_command
-    assert_equal false, code_command.render_result
+    assert_equal true, code_command.render_command?
+    assert_equal false, code_command.render_result?
   end
 
   def test_show_command_show_render
@@ -96,14 +100,14 @@ class CodeSectionTest < Minitest::Test
       fence: match[:fence],
       lang: match[:lang],
       code: match[:contents],
-      context: default_context
+      context: default_context,
+      io: StringIO.new
     )
     code_section.render
 
-    puts code_section.executed_commands.inspect
     code_command = code_section.executed_commands.first
-    assert_equal true, code_command.render_command
-    assert_equal true, code_command.render_result
+    assert_equal true, code_command.render_command?
+    assert_equal true, code_command.render_result?
   end
 
   def test_hide_command_hide_render
@@ -118,13 +122,14 @@ class CodeSectionTest < Minitest::Test
       fence: match[:fence],
       lang: match[:lang],
       code: match[:contents],
-      context: default_context
+      context: default_context,
+      io: StringIO.new
     )
     code_section.render
 
     code_command = code_section.executed_commands.first
-    assert_equal false, code_command.render_command
-    assert_equal false, code_command.render_result
+    assert_equal false, code_command.render_command?
+    assert_equal false, code_command.render_result?
 
     contents = <<~RUBY
       ```
@@ -137,13 +142,14 @@ class CodeSectionTest < Minitest::Test
       fence: match[:fence],
       lang: match[:lang],
       code: match[:contents],
-      context: default_context
+      context: default_context,
+      io: StringIO.new
     )
     code_section.render
 
     code_command = code_section.executed_commands.first
-    assert_equal false, code_command.render_command
-    assert_equal false, code_command.render_result
+    assert_equal false, code_command.render_command?
+    assert_equal false, code_command.render_result?
   end
 
   def test_hide_command_show_render
@@ -158,12 +164,13 @@ class CodeSectionTest < Minitest::Test
       fence: match[:fence],
       lang: match[:lang],
       code: match[:contents],
-      context: default_context
+      context: default_context,
+      io: StringIO.new
     )
     code_section.render
 
     code_command = code_section.executed_commands.first
-    assert_equal false, code_command.render_command
-    assert_equal true, code_command.render_result
+    assert_equal false, code_command.render_command?
+    assert_equal true, code_command.render_result?
   end
 end

data/test/rundoc/peg_parser_test.rb

@@ -249,7 +249,8 @@ class PegParserTest < Minitest::Test
 
     actual = @transformer.apply(tree)
     assert_equal :rundoc, actual.keyword
-    assert_equal("email = ENV['HEROKU_EMAIL'] || `heroku auth:whoami`", actual.original_args)
+    assert_nil actual.original_args
+    assert_equal("email = ENV['HEROKU_EMAIL'] || `heroku auth:whoami`\n", actual.contents)
   end
 
   def test_rundoc_sub_commands_no_quotes
@@ -351,4 +352,19 @@ class PegParserTest < Minitest::Test
     assert_equal :"background.start", actual.keyword
     assert_equal ["rails server", {name: "server"}], actual.original_args
   end
+
+  def test_no_args_preserves_newlines_in_stdin
+    input = <<~EOF.strip
+      :::>> rundoc
+      first = 1 # comment
+      second = 2
+    EOF
+
+    parser = Rundoc::PegParser.new.command_with_stdin
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal :rundoc, actual.keyword
+    assert_equal "first = 1 # comment\nsecond = 2".strip, actual.contents.strip
+  end
 end

data/test/test_helper.rb

@@ -33,7 +33,8 @@ class Minitest::Test
     contents,
     output_dir: nil,
     source_path: nil,
-    screenshots_dirname: nil
+    screenshots_dirname: nil,
+    io: StringIO.new
   )
     context = default_context(
       output_dir: output_dir,
@@ -42,7 +43,8 @@ class Minitest::Test
     )
     Rundoc::Document.new(
       contents,
-      context: context
+      context: context,
+      io: io
     )
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rundoc
 version: !ruby/object:Gem::Version
-  version: 4.1.4
+  version: 5.0.0
 platform: ruby
 authors:
 - Richard Schneeman
@@ -210,6 +210,8 @@ files:
 - lib/rundoc/code_command/background/wait.rb
 - lib/rundoc/code_command/bash.rb
 - lib/rundoc/code_command/bash/cd.rb
+- lib/rundoc/code_command/comment.rb
+- lib/rundoc/code_command/deferred.rb
 - lib/rundoc/code_command/file_command/append.rb
 - lib/rundoc/code_command/file_command/remove.rb
 - lib/rundoc/code_command/no_such_command.rb
@@ -218,7 +220,6 @@ files:
 - lib/rundoc/code_command/print/erb.rb
 - lib/rundoc/code_command/print/text.rb
 - lib/rundoc/code_command/raw.rb
-- lib/rundoc/code_command/rundoc/depend_on.rb
 - lib/rundoc/code_command/rundoc/require.rb
 - lib/rundoc/code_command/rundoc_command.rb
 - lib/rundoc/code_command/website.rb
@@ -248,8 +249,6 @@ files:
 - 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
 - test/fixtures/play/source.md
 - test/fixtures/rails_4/rundoc.md
@@ -273,6 +272,7 @@ files:
 - test/rundoc/code_commands/append_file_test.rb
 - test/rundoc/code_commands/background_test.rb
 - test/rundoc/code_commands/bash_test.rb
+- test/rundoc/code_commands/comment_test.rb
 - test/rundoc/code_commands/pipe_test.rb
 - test/rundoc/code_commands/print_test.rb
 - test/rundoc/code_commands/remove_contents_test.rb
@@ -294,14 +294,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: RunDOC generates runable code from docs
 test_files: []

data/lib/rundoc/code_command/rundoc/depend_on.rb

@@ -1,13 +0,0 @@
-class ::Rundoc::CodeCommand
-  class RundocCommand
-    class DependOn < ::Rundoc::CodeCommand
-      # Pass in the relative path of another rundoc document in order to
-      # run all of it's commands (but not to )
-      def initialize(path)
-        raise "rundoc.depend_on has been removed, use `:::-- rundoc.require` instead"
-      end
-    end
-  end
-end
-
-Rundoc.register_code_command(:"rundoc.depend_on", ::Rundoc::CodeCommand::RundocCommand::DependOn)

data/test/fixtures/depend_on/dependency/rundoc.md

@@ -1,5 +0,0 @@
-```
-:::>> $ mkdir foo
-:::>> $ cd foo
-:::>> $ echo "hello" >> hello.txt
-```

data/test/fixtures/depend_on/main/rundoc.md

@@ -1,10 +0,0 @@
-# Hello
-
-```
-:::-- rundoc.depend_on "../dependency/rundoc.md"
-```
-
-```
-:::>> $ ruby -e "raise 'nope' unless File.read('hello.txt').chomp == 'hello'"
-```
-