fl-rocco 1.0.0

data/test/test_block_comment_styles.rb

@@ -0,0 +1,64 @@
+require File.expand_path('../helper', __FILE__)
+
+class RoccoBlockCommentTest < Test::Unit::TestCase
+  def test_one_liner
+    r = Rocco.new( 'test', '', { :language => "c" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        [ [ "Comment 1" ], [ "def codeblock", "end" ] ]
+      ],
+      r.parse( "/** Comment 1 */\ndef codeblock\nend\n" )
+    )
+  end
+
+  def test_block_start_with_comment
+    r = Rocco.new( 'test', '', { :language => "c" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        [ [ "Comment 1a", "Comment 1b" ], [ "def codeblock", "end" ] ]
+      ],
+      r.parse( "/** Comment 1a\n * Comment 1b\n */\ndef codeblock\nend\n" )
+    )
+  end
+
+  def test_block_end_with_comment
+    r = Rocco.new( 'test', '', { :language => "c" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        [ [ "Comment 1a", "Comment 1b" ], [ "def codeblock", "end" ] ]
+      ],
+      r.parse( "/**\n * Comment 1a\n Comment 1b */\ndef codeblock\nend\n" )
+    )
+  end
+
+  def test_block_end_with_comment_and_middle
+    r = Rocco.new( 'test', '', { :language => "c" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        [ [ "Comment 1a", "Comment 1b" ], [ "def codeblock", "end" ] ]
+      ],
+      r.parse( "/**\n * Comment 1a\n * Comment 1b */\ndef codeblock\nend\n" )
+    )
+  end
+
+  def test_block_start_with_comment_and_end_with_comment
+    r = Rocco.new( 'test', '', { :language => "c" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        [ [ "Comment 1a", "Comment 1b" ], [ "def codeblock", "end" ] ]
+      ],
+      r.parse( "/** Comment 1a\n Comment 1b */\ndef codeblock\nend\n" )
+    )
+  end
+
+  def test_block_start_with_comment_and_end_with_comment_and_middle
+    r = Rocco.new( 'test', '', { :language => "c" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        [ [ "Comment 1a", "Comment 1b" ], [ "def codeblock", "end" ] ]
+      ],
+      r.parse( "/** Comment 1a\n * Comment 1b */\ndef codeblock\nend\n" )
+    )
+  end
+
+end

data/test/test_block_comments.rb

@@ -0,0 +1,101 @@
+require File.expand_path('../helper', __FILE__)
+
+class RoccoBlockCommentTest < Test::Unit::TestCase
+  def test_basics
+    r = Rocco.new( 'test', '', { :language => "c" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        [ [ "Comment 1" ], [ "def codeblock", "end" ] ]
+      ],
+      r.parse( "/**\n * Comment 1\n */\ndef codeblock\nend\n" )
+    )
+    assert_equal(
+      [
+        [ [ "Comment 1a", "Comment 1b" ], [ "def codeblock", "end" ] ]
+      ],
+      r.parse( "/**\n * Comment 1a\n * Comment 1b\n */\ndef codeblock\nend\n" )
+    )
+  end
+
+  def test_multiple_blocks
+    r = Rocco.new( 'test', '', { :language => "c" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        [ [ "Comment 1" ], [ "def codeblock", "end" ] ],
+        [ [ "Comment 2" ], [] ]
+      ],
+      r.parse( "/**\n * Comment 1\n */\ndef codeblock\nend\n/**\n * Comment 2\n */\n" )
+    )
+    assert_equal(
+      [
+        [ [ "Comment 1" ], [ "def codeblock", "end" ] ],
+        [ [ "Comment 2" ], [ "if false", "end" ] ]
+      ],
+      r.parse( "/**\n * Comment 1\n */\ndef codeblock\nend\n/**\n * Comment 2\n */\nif false\nend" )
+    )
+  end
+
+  def test_block_without_middle_character
+    r = Rocco.new( 'test', '', { :language => "python" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        [ [ "Comment 1" ], [ "def codeblock", "end" ] ],
+        [ [ "Comment 2" ], [] ]
+      ],
+      r.parse( "\"\"\"\n  Comment 1\n\"\"\"\ndef codeblock\nend\n\"\"\"\n  Comment 2\n\"\"\"\n" )
+    )
+    assert_equal(
+      [
+        [ [ "Comment 1" ], [ "def codeblock", "end" ] ],
+        [ [ "Comment 2" ], [ "if false", "end" ] ]
+      ],
+      r.parse( "\"\"\"\n  Comment 1\n\"\"\"\ndef codeblock\nend\n\"\"\"\n  Comment 2\n\"\"\"\nif false\nend" )
+    )
+  end
+
+  def test_language_without_single_line_comments_parse
+    r = Rocco.new( 'test', '', { :language => "css" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        [ [ "Comment 1" ], [ "def codeblock", "end" ] ],
+        [ [ "Comment 2" ], [ "if false", "end" ] ]
+      ],
+      r.parse( "/**\n * Comment 1\n */\ndef codeblock\nend\n/**\n * Comment 2\n */\nif false\nend" )
+    )
+  end
+
+  def test_language_without_single_line_comments_split
+    r = Rocco.new( 'test', '', { :language => "css" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        [ "Comment 1", "Comment 2" ],
+        [ "def codeblock\nend", "if false\nend" ]
+      ],
+      r.split( [
+        [ [ "Comment 1" ], [ "def codeblock", "end" ] ],
+        [ [ "Comment 2" ], [ "if false", "end" ] ]
+      ] )
+    )
+  end
+
+  def test_language_without_single_line_comments_highlight
+    r = Rocco.new( 'test', '', { :language => "css" } ) { "" } # Generate throwaway instance so I can test `parse`
+
+    highlighted = r.highlight( r.split( r.parse( "/**\n * This is a comment!\n */\n.rule { goes: here; }\n/**\n * Comment 2\n */\n.rule2 { goes: here; }" ) ) )
+    assert_equal(
+      "<p>This is a comment!</p>",
+      highlighted[0][0]
+    )
+    assert_equal(
+      fb_assert_val("<p>Comment 2</p>\n"),
+      highlighted[1][0]
+    )
+    assert(
+      !highlighted[0][1].include?("DIVIDER") &&
+      !highlighted[1][1].include?("DIVIDER"),
+      "`DIVIDER` stripped successfully."
+    )
+    assert( true )
+  end
+
+end

data/test/test_comment_normalization.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../helper', __FILE__)
+
+class RoccoCommentNormalization < Test::Unit::TestCase
+  def test_normal_comments
+    r = Rocco.new( 'test', '', { :language => "python" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+          [ [ "Comment 1a", "Comment 1b" ], [ "def codeblock", "end" ] ],
+          [ [ "Comment 2a", "  Comment 2b" ], [] ]
+      ],
+      r.parse( "\"\"\"\n  Comment 1a\n  Comment 1b\n\"\"\"\ndef codeblock\nend\n\"\"\"\n  Comment 2a\n    Comment 2b\n\"\"\"\n" )
+    )
+  end
+
+  def test_single_line_comments
+    r = Rocco.new( 'test', '', { :language => "python" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+          [ [ "Comment 1a", "Comment 1b" ], [ "def codeblock", "end" ] ],
+          [ [ "Comment 2a", "  Comment 2b" ], [] ]
+      ],
+      r.parse( "#   Comment 1a\n#   Comment 1b\ndef codeblock\nend\n#   Comment 2a\n#     Comment 2b\n" )
+    )
+  end
+end

data/test/test_commentchar_detection.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../helper', __FILE__)
+
+class RoccoAutomaticCommentChars < Test::Unit::TestCase
+  def test_basic_detection
+    r = Rocco.new( 'filename.js' ) { "" }
+    assert_equal "//", r.options[:comment_chars][:single]
+  end
+
+  def test_fallback_language
+    r = Rocco.new( 'filename.an_extension_with_no_meaning_whatsoever', '', { :language => "js" } ) { "" }
+    assert_equal "//", r.options[:comment_chars][:single]
+  end
+
+  def test_fallback_default
+    r = Rocco.new( 'filename.an_extension_with_no_meaning_whatsoever' ) { "" }
+    assert_equal "#", r.options[:comment_chars][:single], "`:comment_chars` should be `#` when falling back to defaults."
+  end
+
+  def test_fallback_user
+    r = Rocco.new( 'filename.an_extension_with_no_meaning_whatsoever', '', { :comment_chars => "user" } ) { "" }
+    assert_equal "user", r.options[:comment_chars][:single], "`:comment_chars` should be the user's default when falling back to user-provided settings."
+  end
+
+  def test_fallback_user_with_unknown_language
+    r = Rocco.new( 'filename.an_extension_with_no_meaning_whatsoever', '', { :language => "not-a-language", :comment_chars => "user" } ) { "" }
+    assert_equal "user", r.options[:comment_chars][:single], "`:comment_chars` should be the user's default when falling back to user-provided settings."
+  end
+end

data/test/test_descriptive_section_names.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../helper', __FILE__)
+
+class RoccoDescriptiveSectionNamesTests < Test::Unit::TestCase
+  def test_section_name
+    r = roccoize( "filename.rb", "# # Comment 1\ndef codeblock\nend\n" )
+    html = r.to_html
+    assert(
+      html.include?( "<tr id='section-Comment_1'>" ),
+      "The first section should be named"
+    )
+    assert(
+      html.include?( '<a class="pilcrow" href="#section-Comment_1">' ),
+      "The rendered HTML should link to a named section"
+    )
+  end
+
+  def test_section_numbering
+    r = roccoize( "filename.rb", "# # Header 1\ndef codeblock\nend\n# Comment 1\ndef codeblock1\nend\n# # Header 2\ndef codeblock2\nend" )
+    html = r.to_html
+    assert(
+      html.include?( '<a class="pilcrow" href="#section-Header_1">' ) &&
+      html.include?( '<a class="pilcrow" href="#section-Header_2">' ),
+      "First and second headers should be named sections"
+    )
+    assert(
+      html.include?( '<a class="pilcrow" href="#section-2">' ),
+      "Sections should continue numbering as though headers were counted."
+    )
+  end
+end

data/test/test_docblock_annotations.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../helper', __FILE__)
+
+class RoccoDocblockAnnotationsTest < Test::Unit::TestCase
+  def test_basics
+    r = Rocco.new( 'test', '', { :language => "c", :docblocks => true } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        "Comment\n\n> **param** mixed foo  \n> **return** void  "
+      ],
+      r.docblock( ["Comment\n\n@param mixed foo\n@return void"] )
+    )
+  end
+
+  def test_highlighted_in_blocks
+    r = Rocco.new( 'test', '', { :language => "c", :docblocks => true } ) { "" } # Generate throwaway instance so I can test `parse`
+    highlighted = r.highlight( r.split( r.parse( "/**\n * Comment\n *\n * @param type name\n */\ndef codeblock\nend\n" ) ) )
+
+    assert_equal(
+      Rocco::MD_BLUECLOTH ? "<p>Comment</p>\n\n<blockquote><p><strong>param</strong> type name</p></blockquote>" : "<p>Comment</p>\n<blockquote>\n<p><strong>param</strong> type name  </p>\n</blockquote>",
+      highlighted[0][0]
+    )
+  end
+end

data/test/test_heredoc.rb

@@ -0,0 +1,13 @@
+require File.expand_path('../helper', __FILE__)
+
+class RoccoHeredocTest < Test::Unit::TestCase
+  def test_basics
+    r = Rocco.new( 'test', '', { :language => "rb" } ) { "" } # Generate throwaway instance so I can test `parse`
+    assert_equal(
+      [
+        [ [ "Comment 1" ], [ "heredoc <<-EOH", "#comment", "code", "EOH" ] ]
+      ],
+      r.parse( "# Comment 1\nheredoc <<-EOH\n#comment\ncode\nEOH" )
+    )
+  end
+end

data/test/test_language_detection.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../helper', __FILE__)
+
+class RoccoLanguageDetection < Test::Unit::TestCase
+  def test_basic_detection
+    r = Rocco.new( 'filename.py' ) { "" }
+    if r.pygmentize?
+      assert_equal "python", r.detect_language(), "`detect_language()` should return the correct language"
+      assert_equal "python", r.options[:language], "`@options[:language]` should be set to the correct language"
+    end
+  end
+
+  def test_fallback_default
+    r = Rocco.new( 'filename.an_extension_with_no_meaning_whatsoever' ) { "" }
+    if r.pygmentize?
+      assert_equal "text", r.detect_language(), "`detect_language()` should return `text` when nothing else is detected"
+      assert_equal "ruby", r.options[:language], "`@options[:language]` should be set to `ruby` when nothing else is detected"
+    end
+  end
+
+  def test_fallback_user
+    r = Rocco.new( 'filename.an_extension_with_no_meaning_whatsoever', '', { :language => "c" } ) { "" }
+    if r.pygmentize?
+      assert_equal "text", r.detect_language(), "`detect_language()` should return `text` nothing else is detected"
+      assert_equal "c", r.options[:language], "`@options[:language]` should be set to the user's setting when nothing else is detected"
+    end
+  end
+end

data/test/test_reported_issues.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+require File.expand_path('../helper', __FILE__)
+
+class RoccoIssueTests < Test::Unit::TestCase
+  def test_issue07_incorrect_parsing_in_c_mode
+    # Precursor to issue #13 below, Rocco incorrectly parsed C/C++
+    # http://github.com/rtomayko/rocco/issues#issue/7
+    r = Rocco.new( 'issue7.c', [], { :language => 'c' } ) {
+        "// *stdio.h* declares *puts*\n#include <stdio.h>\n\n//### code hello world\n\n// every C program contains function *main*.\nint main (int argc, char *argv[]) {\n  puts('hello world');\n  return 0;\n}\n\n// that's it!"
+    }
+    r.sections.each do | section |
+      if not section[1].nil?
+        assert(
+            !section[1].include?("<span class=\"c\"># DIVIDER</span>"),
+            "`# DIVIDER` present in code text, which means the highligher screwed up somewhere."
+        )
+      end
+    end
+  end
+
+  def test_issue10_utf8_processing
+    # Rocco has issues with strange UTF-8 characters: need to explicitly set the encoding for Pygments
+    # http://github.com/rtomayko/rocco/issues#issue/10
+    r = Rocco.new( File.dirname(__FILE__) + "/fixtures/issue10.utf-8.rb" )
+    assert_equal(
+      fb_assert_val("<p>hello ąćęłńóśźż</p>\n"),
+      r.sections[0][0],
+      "UTF-8 input files ought behave correctly."
+    )
+    # and, just for grins, ensure that iso-8859-1 works too.
+    r = Rocco.new( File.dirname(__FILE__) + "/fixtures/issue10.iso-8859-1.rb", [], :encoding => 'ISO-8859-1' )
+    assert_equal(
+      fb_assert_val("<p>hello wörld</p>\n"),
+      r.sections[0][0],
+      "ISO-8859-1 input should probably also behave correctly."
+    )
+  end
+
+  def test_issue12_css_octothorpe_classname_change
+    # Docco changed some CSS classes.  Rocco needs to update its default template.
+    # http://github.com/rtomayko/rocco/issues#issue/12
+    r = Rocco.new( 'issue12.sh' ) {
+      "# Comment 1\n# Comment 1\nprint 'omg!'"
+    }
+    html = r.to_html
+    assert(
+      !html.include?( "<div class=\"octowrap\">" ),
+      "`octowrap` wrapper is present in rendered HTML.  This ought be replaced with `pilwrap`."
+    )
+    assert(
+      !html.include?( "<a class=\"octothorpe\" href=\"#section-1\">" ),
+      "`octothorpe` link is present in rendered HTML.  This ought be replaced with `pilcrow`."
+    )
+  end
+
+  def test_issue13_incorrect_code_divider_parsing
+    # In `bash` mode (among others), the comment class is `c`, not `c1`.
+    # http://github.com/rtomayko/rocco/issues#issue/13
+    r = Rocco.new( 'issue13.sh', [], { :language => 'bash' } ) {
+      "# Comment 1\necho 'code';\n# Comment 2\necho 'code';\n# Comment 3\necho 'code';\n"
+    }
+    r.sections.each do | section |
+      if not section[1].nil?
+        assert(
+          !section[1].include?("<span class=\"c\"># DIVIDER</span>"),
+          "`# DIVIDER` present in code text, which means the highligher screwed up somewhere."
+        )
+      end
+    end
+  end
+
+  def test_issue15_extra_space_after_comment_character_remains
+    # After the comment character, a single space should be removed.
+    # http://github.com/rtomayko/rocco/issues#issue/15
+    r = Rocco.new( 'issue15.sh') {
+      "# Comment 1\n# ---------\necho 'code';"
+    }
+    assert(
+      !r.sections[0][0].include?( "<hr />" ),
+      "`<hr />` present in rendered documentation text.  It should be a header, not text followed by a horizontal rule."
+    )
+    assert_equal(fb_assert_val("<h2>Comment 1</h2>\n"), r.sections[0][0])
+  end
+end

data/test/test_skippable_lines.rb

@@ -0,0 +1,64 @@
+require File.expand_path('../helper', __FILE__)
+
+class RoccoSkippableLines < Test::Unit::TestCase
+  def test_shebang_first_line
+    r = Rocco.new( 'filename.sh' ) { "" }
+    assert_equal(
+      [
+        [ [ "Comment 1" ], [ "def codeblock" ] ],
+        [ [ "Comment 2" ], [ "end" ] ]
+      ],
+      r.parse( "#!/usr/bin/env bash\n# Comment 1\ndef codeblock\n# Comment 2\nend\n" ),
+      "Shebang should be stripped when it appears as the first line."
+    )
+  end
+
+  def test_shebang_in_content
+    r = Rocco.new( 'filename.sh' ) { "" }
+    assert_equal(
+      [
+        # @TODO: `#!/` shouldn't be recognized as a comment.
+        [ [ "Comment 1", "!/usr/bin/env bash" ], [ "def codeblock" ] ],
+        [ [ "Comment 2" ], [ "end" ] ]
+      ],
+      r.parse( "# Comment 1\n#!/usr/bin/env bash\ndef codeblock\n# Comment 2\nend\n" ),
+      "Shebang shouldn't be stripped anywhere other than as the first line."
+    )
+  end
+
+  def test_encoding_in_ruby
+    r = Rocco.new( 'filename.rb' ) { "" }
+    assert_equal(
+      [
+        [ [ "Comment 1" ], [ "def codeblock" ] ],
+        [ [ "Comment 2" ], [ "end" ] ]
+      ],
+      r.parse( "#!/usr/bin/env bash\n# encoding: utf-8\n# Comment 1\ndef codeblock\n# Comment 2\nend\n" ),
+      "Strings matching the PEP 263 encoding definition regex should be stripped when they appear at the top of a python document."
+    )
+  end
+
+  def test_encoding_in_python
+    r = Rocco.new( 'filename.py', [], {:language => "python"} ) { "" }
+    assert_equal(
+      [
+        [ [ "Comment 1" ], [ "def codeblock" ] ],
+        [ [ "Comment 2" ], [ "end" ] ]
+      ],
+      r.parse( "#!/usr/bin/env bash\n# encoding: utf-8\n# Comment 1\ndef codeblock\n# Comment 2\nend\n" ),
+      "Strings matching the PEP 263 encoding definition regex should be stripped when they appear at the top of a python document."
+    )
+  end
+
+  def test_encoding_in_notpython
+    r = Rocco.new( 'filename.sh' ) { "" }
+    assert_equal(
+      [
+        [ [ "encoding: utf-8", "Comment 1" ], [ "def codeblock" ] ],
+        [ [ "Comment 2" ], [ "end" ] ]
+      ],
+      r.parse( "#!/usr/bin/env bash\n# encoding: utf-8\n# Comment 1\ndef codeblock\n# Comment 2\nend\n" ),
+      "Strings matching the PEP 263 encoding definition regex should be stripped when they appear at the top of a python document."
+    )
+  end
+end