rundoc 0.0.2 → 1.1.2

data/test/rundoc/code_commands/bash_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class BashTest < Test::Unit::TestCase
+class BashTest < Minitest::Test
 
   def test_bash_returns_cd
     original_dir = `pwd`

data/test/rundoc/code_commands/pipe_test.rb

@@ -1,7 +1,6 @@
 require 'test_helper'
 
-class PipeTest < Test::Unit::TestCase
-
+class PipeTest < Minitest::Test
   def test_pipe
     pipe_cmd = "tail -n 2"
     cmd      = "ls"
@@ -12,4 +11,15 @@ class PipeTest < Test::Unit::TestCase
     expected = `#{cmd} | #{pipe_cmd}`
     assert_equal expected, actual
   end
+
+  def test_moar_pipe_with_dollar
+    pipe_cmd = "tail -n 2"
+    cmd      = "ls"
+    out      = `#{cmd}`
+    pipe     = Rundoc::CodeCommand::Pipe.new("$ #{pipe_cmd}")
+    actual   = pipe.call(commands: [{command: cmd, output: out}])
+
+    expected = `#{cmd} | #{pipe_cmd}`
+    assert_equal expected, actual
+  end
 end

data/test/rundoc/code_commands/remove_contents_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class RemoveContentsTest < Test::Unit::TestCase
+class RemoveContentsTest < Minitest::Test
 
   def setup
     @gemfile = <<-RUBY

data/test/rundoc/code_section_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class CodeSectionTest < Test::Unit::TestCase
+class CodeSectionTest < Minitest::Test
 
   def setup
   end
@@ -10,7 +10,7 @@ class CodeSectionTest < Test::Unit::TestCase
 sup
 
 ```
-:::-  $ mkdir foo
+:::--  $ mkdir foo
 ```
 
 yo
@@ -42,7 +42,7 @@ RUBY
   def test_show_command_hide_render
     contents = <<-RUBY
 ```
-:::> $ echo "foo"
+:::>- $ echo "foo"
 ```
 RUBY
 
@@ -80,15 +80,16 @@ RUBY
     code_section = Rundoc::CodeSection.new(match, keyword: ":::")
     code_section.render
 
+    puts code_section.commands.inspect
     code_command = code_section.commands.first
-    assert_equal true,  code_command.render_command
+    assert_equal true, code_command.render_command
     assert_equal true, code_command.render_result
   end
 
   def test_hide_command_hide_render
     contents = <<-RUBY
 ```
-:::- $ echo "foo"
+:::-- $ echo "foo"
 ```
 RUBY
 

data/test/rundoc/parser_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class ParserTest < Test::Unit::TestCase
+class ParserTest < Minitest::Test
 
   def setup
   end
@@ -10,7 +10,7 @@ class ParserTest < Test::Unit::TestCase
 sup
 
 ```
-:::>  $ mkdir foo
+:::>-  $ mkdir foo
 :::>> $ ls
 ```
 
@@ -24,11 +24,6 @@ RUBY
         parsed = Rundoc::Parser.new(contents)
         actual = parsed.to_md
         assert_equal expected, actual
-
-        parsed = Rundoc::Parser.new("\n```\n:::= $ ls\n```\n")
-        actual = parsed.to_md
-        expected = "\n```\n$ ls\nfoo\n```\n"
-        assert_equal expected, actual
       end
     end
   end
@@ -88,7 +83,6 @@ puts b
 ```
 RUBY
 
-
     Dir.mktmpdir do |dir|
       Dir.chdir(dir) do
 

data/test/rundoc/peg_parser_test.rb

@@ -0,0 +1,391 @@
+require 'test_helper'
+require 'parslet/convenience'
+
+class PegParserTest < Minitest::Test
+  def setup
+    @transformer = Rundoc::PegTransformer.new
+  end
+
+  def test_string
+    input = %Q{"hello world"}
+    parser = Rundoc::PegParser.new.string
+    tree = parser.parse_with_debug(input)
+    expected = {:string => "hello world"}
+    assert_equal expected, tree
+
+    actual = @transformer.apply(tree)
+    assert_equal "hello world", actual
+  end
+
+  def test_keyword_args
+    input = %Q{foo: 'bar', baz: "boo"}
+    parser = Rundoc::PegParser.new.named_args
+    tree = parser.parse_with_debug(input)
+    actual = @transformer.apply(tree)
+    expected = {foo: 'bar', baz: "boo"}
+    assert_equal expected, actual
+  end
+
+  def test_method_call
+    input = %Q{sup(foo: 'bar')}
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal :sup, actual.keyword
+    assert_equal({foo: 'bar'}, actual.original_args)
+
+    # seattle style
+    input = %Q{sup foo: 'bar' }
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+    actual = @transformer.apply(tree)
+    assert_equal :sup, actual.keyword
+    assert_equal({foo: 'bar'}, actual.original_args)
+
+    # with a dot
+    input = %Q{sup.you foo: 'bar' }
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+    actual = @transformer.apply(tree)
+    assert_equal :"sup.you", actual.keyword
+    assert_equal({foo: 'bar'}, actual.original_args)
+  end
+
+  def test_with_string_arg
+    input = %Q{sup("hey")}
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal :sup, actual.keyword
+    assert_equal("hey", actual.original_args)
+
+    input = %Q{sup "hey"}
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal :sup, actual.keyword
+    assert_equal("hey", actual.original_args)
+
+    input = %Q{sup hey}
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal :sup, actual.keyword
+    assert_equal("hey", actual.original_args)
+
+    input = %Q{ $ cat foo.rb}
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal :"$", actual.keyword
+    assert_equal("cat foo.rb", actual.original_args)
+  end
+
+  def test_visability
+    input = %Q{>>}
+    parser = Rundoc::PegParser.new.visability
+    tree = parser.parse_with_debug(input)
+    actual = @transformer.apply(tree)
+    assert_equal true, actual.command?
+    assert_equal true, actual.result?
+
+    input = %Q{->}
+    parser = Rundoc::PegParser.new.visability
+    tree = parser.parse_with_debug(input)
+    actual = @transformer.apply(tree)
+    assert_equal false, actual.command?
+    assert_equal true, actual.result?
+
+    input = %Q{--}
+    parser = Rundoc::PegParser.new.visability
+    tree = parser.parse_with_debug(input)
+    actual = @transformer.apply(tree)
+    assert_equal false, actual.command?
+    assert_equal false, actual.result?
+
+    input = %Q{>-}
+    parser = Rundoc::PegParser.new.visability
+    tree = parser.parse_with_debug(input)
+    actual = @transformer.apply(tree)
+    assert_equal true, actual.command?
+    assert_equal false, actual.result?
+  end
+
+  def test_blerg_method_call
+    input = %Q{$ cat foo.rb}
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal :"$", actual.keyword
+    assert_equal("cat foo.rb", actual.original_args)
+  end
+
+  def test_command
+    input = %Q{:::>> $ cat foo.rb\n}
+    parser = Rundoc::PegParser.new.command
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal :"$", actual.keyword
+    assert_equal("cat foo.rb", actual.original_args)
+  end
+
+  def test_command_with_stdin
+    input = String.new
+    input << ":::>> file.write hello.txt\n"
+    input << "world\n"
+
+    parser = Rundoc::PegParser.new.command_with_stdin
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal :"file.write", actual.keyword
+    assert_equal("hello.txt", actual.original_args)
+    assert_equal("world\n", actual.contents)
+  end
+
+  def test_command_with_stdin_no_string
+    input = String.new
+    input << ":::>> file.write hello.txt\n"
+
+    parser = Rundoc::PegParser.new.command_with_stdin
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+
+    assert_equal :"file.write", actual.keyword
+    assert_equal("hello.txt", actual.original_args)
+  end
+
+  def test_multiple_commands_stdin
+    input = String.new
+    input << ":::>> file.write hello.txt\n"
+    input << "world\n"
+    input << ":::>> file.write cinco.txt\n"
+    input << "\n\n\n"
+    input << "  river\n"
+
+    parser = Rundoc::PegParser.new.multiple_commands
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+
+    assert_equal :"file.write", actual.first.keyword
+    assert_equal("hello.txt", actual.first.original_args)
+    assert_equal("world\n", actual.first.contents)
+
+    assert_equal :"file.write", actual.last.keyword
+    assert_equal("cinco.txt", actual.last.original_args)
+    assert_equal("\n\n\n  river\n", actual.last.contents)
+  end
+
+  def test_multiple_commands_with_fence
+    input = String.new
+    input << "```\n"
+    input << ":::>> file.write hello.txt\n"
+    input << "world\n"
+    input << "```\n"
+
+    parser = Rundoc::PegParser.new.fenced_commands
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+
+    assert_equal :"file.write", actual.first.keyword
+    assert_equal("hello.txt", actual.first.original_args)
+    assert_equal("world\n", actual.first.contents)
+  end
+
+  def test_raw
+    input = String.new
+    input << "hello.txt\n"
+    input << "world\n"
+    input << ":::>> $ cd foo\n"
+
+    parser = Rundoc::PegParser.new.raw_code
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+
+    assert_equal "hello.txt\nworld\n", actual.first.contents
+    assert_equal :"$", actual.last.keyword
+    assert_equal("cd foo", actual.last.original_args)
+  end
+
+
+  def test_quotes_in_shell_commands
+    input = %Q{:::>- $ git commit -m "init"\n}
+    parser = Rundoc::PegParser.new.code_block
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+
+    assert_equal :"$", actual.last.keyword
+    assert_equal('git commit -m "init"', actual.last.original_args)
+  end
+
+  def test_raises_on_syntax
+    input = %Q{:::> $ git commit -m "init"\n}
+    assert_raises(Rundoc::PegTransformer::TransformError) do
+      parser = Rundoc::PegParser.new.code_block
+      tree = parser.parse_with_debug(input)
+
+      actual = @transformer.apply(tree)
+    end
+  end
+
+
+  def test_no_args
+    # input = String.new
+    # input << %Q{rundoc}
+    # parser = Rundoc::PegParser.new.no_args_method
+    # tree = parser.parse_with_debug(input)
+    # actual = @transformer.apply(tree)
+    # assert_equal("rundoc", actual.to_s)
+
+    # input = String.new
+    # input << %Q{:::-- rundoc\n}
+    # parser = Rundoc::PegParser.new.command
+    # tree = parser.parse_with_debug(input)
+
+    # actual = @transformer.apply(tree)
+    # assert_equal :rundoc, actual.keyword
+    # assert_nil(actual.original_args)
+
+
+    input = String.new
+    input << %Q{:::-- rundoc\n}
+    input << %Q{email = ENV['HEROKU_EMAIL'] || `heroku auth:whoami`\n}
+
+    parser = Rundoc::PegParser.new.command_with_stdin
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal :rundoc, actual.keyword
+    assert_equal("email = ENV['HEROKU_EMAIL'] || `heroku auth:whoami`", actual.original_args)
+  end
+
+  def test_rundoc_sub_commands_no_quotes
+    input = String.new
+    input << %Q{:::-- rundoc.depend_on ../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
+  end
+
+  def test_seattle_style_method_call
+    input = String.new
+    input << %Q{rundoc.depend_on '../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
+  end
+
+  def test_rundoc_seattle_sub_command
+    input = String.new
+    input << %Q{:::>> rundoc.depend_on '../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
+  end
+
+  def test_positional_args
+    input = +""
+    input << %Q{call("foo", "bar", biz: "baz")}
+
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+
+    # =====================================
+    #
+    # Handles more than one value, but not only one value
+    actual = @transformer.apply(tree)
+    assert_equal ["foo", "bar", { biz: "baz"}], actual.original_args
+
+    input = +""
+    input << %Q{call("foo", biz: "baz")}
+
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal ["foo", { biz: "baz"}], actual.original_args
+
+    input = +""
+    input << %Q{call("rails server", name: "server")}
+
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal ["rails server", {name: "server"}], actual.original_args
+
+    # input = +""
+    # input << %Q{background.start("rails server", name: "server")}
+    # parser = Rundoc::PegParser.new.method_call
+
+    # tree = parser.parse_with_debug(input)
+
+    # puts tree.inspect
+
+    # actual = @transformer.apply(tree)
+    # assert_equal :"background.start", actual.keyword
+
+    # ================
+
+    input = +""
+    input << %Q{call("foo", "bar")}
+
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+
+    # puts tree.inspect
+
+    actual = @transformer.apply(tree)
+    assert_equal ["foo", "bar"], actual.original_args
+
+    # ======================
+
+    input = +""
+    input << %Q{call("foo", "bar", biz: "baz")}
+
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal ["foo", "bar", { biz: "baz"}], actual.original_args
+  end
+
+  def test_positional_args_code_block
+
+    input = +""
+    input << %Q{:::>> background.start("rails server", name: "server")\n}
+    # input << %Q{:::-- background.stop(name: "server")\n}
+
+    parser = Rundoc::PegParser.new.command
+
+    tree = parser.parse_with_debug(input)
+
+    # puts tree.inspect
+
+    actual = @transformer.apply(tree)
+    assert_equal :"background.start", actual.keyword
+    assert_equal ["rails server", {:name=>"server"}], actual.original_args
+  end
+end