codnar 0.1.68 → 0.1.73

data/lib/codnar/string_extensions.rb

@@ -13,10 +13,11 @@ class String
   # empty lines for no apparent reason. Cleaning it up seems to be safe enough,
   # and eliminates the ugly additional vertical space in the final HTML.
   def clean_markup_html
-    return gsub(/\n*<p>\n*/, "\n<p>\n") \
+    return gsub("\r\n", "\n") \
+          .gsub(/\n*<p>\n*/, "\n<p>\n") \
           .gsub(/\n*<\/p>\n*/, "\n</p>\n") \
-          .gsub(/\n*<pre>\n*/, "\n<pre>\n") \
-          .gsub(/\n*<\/pre>\n*/, "\n</pre>\n") \
+          .gsub(/\n*<pre>\n+/, "\n<pre>\n") \
+          .gsub(/\n+<\/pre>\n*/, "\n</pre>\n") \
           .sub(/^\n*/, "")
   end
 

data/lib/codnar/version.rb

@@ -3,6 +3,6 @@ module Codnar
 
   # This version number. The third number is automatically updated to track the
   # number of Git commits by running <tt>rake version</tt>.
-  VERSION = "0.1.68"
+  VERSION = "0.1.73"
 
 end

data/test/expand_haddock.rb

@@ -0,0 +1,23 @@
+require "codnar"
+require "test/spec"
+
+# Test expanding Haddock text.
+class TestExpandHaddock < Test::Unit::TestCase
+
+  def test_normal_text
+    Codnar::Haddock.to_html("normal").should == "<p>normal\n</p>\n"
+  end
+
+  def test_identifier_text
+    Codnar::Haddock.to_html("'Int'").should == "<p><code>Int</code>\n</p>\n"
+  end
+
+  def test_emphasis_text
+    Codnar::Haddock.to_html("/emphasis/").should == "<p><em>emphasis</em>\n</p>\n"
+  end
+
+  def test_code_text
+    Codnar::Haddock.to_html("@code@").should == "<pre>code</pre>\n"
+  end
+
+end

data/test/expand_rdoc.rb

@@ -9,12 +9,12 @@ class TestExpandRDoc < Test::Unit::TestCase
   end
 
   def test_strong_text
-    Codnar::RDoc.to_html("*text*").should == "<p>\n<b>text</b>\n</p>\n"
+    Codnar::RDoc.to_html("*text*").should == "<p>\n<strong>text</strong>\n</p>\n"
   end
 
   def test_indented_pre
     Codnar::RDoc.to_html("base\n  indented\n    more\nback\n").should \
-                      == "<p>\nbase\n</p>\n<pre>\nindented\n  more\n</pre>\n<p>\nback\n</p>\n"
+                      == "<p>\nbase\n</p>\n<pre>indented\n  more</pre>\n<p>\nback\n</p>\n"
   end
 
 end

data/test/format_comment_configurations.rb

@@ -33,7 +33,7 @@ class TestFormatCommentsConfigurations < Test::Unit::TestCase
     <td class='html'>
     <div class='rdoc comment markup'>
     <p>
-    Comment <b>text</b>.
+    Comment <strong>text</strong>.
     </p>
     </div>
     </td>

data/test/run_weave.rb

@@ -54,10 +54,9 @@ class TestRunWeave < Test::Unit::TestCase
   def test_run_weave_missing_file
     write_fake_file("root", FILE_CHUNKS.to_yaml)
     Codnar::Application.with_argv(%w(-e stderr -o stdout root)) { Codnar::Weave.new(true).run }.should == 1
-    double_message = "No such file or directory - " * 2 # Something weird in Ruby Exception.to_s
-    File.read("stdout").should == "Root\nFILE: included.file EXCEPTION: #{double_message}\n"
+    File.read("stdout").should == "Root\nFILE: included.file EXCEPTION: No such file or directory - included.file\n"
     File.read("stderr").should \
-      == "#{$0}: Reading file: included.file exception: #{double_message} in file: root at line: 1\n"
+      == "#{$0}: Reading file: included.file exception: No such file or directory - included.file in file: root at line: 1\n"
   end
 
   def test_run_weave_existing_file

data/test/split_code.rb

@@ -79,7 +79,7 @@ protected
       <td class='html'>
       <div class='rdoc rdoc markup'>
       <p>
-      This is <b>rdoc</b>.
+      This is <strong>rdoc</strong>.
       </p>
       </div>
       </td>

data/test/split_combined_configurations.rb

@@ -77,7 +77,7 @@ class TestSplitCombinedConfigurations < Test::Unit::TestCase
     <td class='html'>
     <div class='rdoc comment markup'>
     <p>
-    Hello, <b>world</b>!
+    Hello, <strong>world</strong>!
     </p>
     </div>
     </td>

data/test/{split_complex_comment_configurations.rb → split_delimited_comment_configurations.rb}

@@ -3,8 +3,8 @@ require "olag/test"
 require "test/spec"
 require "test_with_configurations"
 
-# Test built-in split complex comment configurations.
-class TestSplitComplexCommentsConfigurations < Test::Unit::TestCase
+# Test built-in split delimited comment configurations.
+class TestSplitDelimitedCommentsConfigurations < Test::Unit::TestCase
 
   include Test::WithConfigurations
   include Test::WithErrors
@@ -13,7 +13,7 @@ class TestSplitComplexCommentsConfigurations < Test::Unit::TestCase
   def test_custom_comments
     # Since the prefix/inner/suffix passed to the configuration are regexps,
     # we need to escape special characters such as "{" and "|".
-    check_any_comment([ "@{", " |", " }@" ], Codnar::Configuration::CLASSIFY_COMPLEX_COMMENTS.call("@\\{", " \\|", " \\}@"))
+    check_any_comment([ "@{", " |", " }@" ], Codnar::Configuration::CLASSIFY_DELIMITED_COMMENTS.call("@\\{", " \\|", " \\}@"))
   end
 
   def test_c_comments
@@ -26,16 +26,16 @@ class TestSplitComplexCommentsConfigurations < Test::Unit::TestCase
 
 protected
 
-  # The "<<<" will be replaced by the complex comment prefix,
+  # The "<<<" will be replaced by the start comment prefix,
   # the "<>" will be replaced by the inner line comment prefix,
-  # and the ">>>" will be replaced by the complex comment suffix.
+  # and the ">>>" will be replaced by the end comment suffix.
   ANY_COMMENT_CODE = <<-EOF.unindent
-    /-- One-line comment --/
+    <<< One-line comment >>>
     Code
-    /--
-     - Multi-line
-     - comment.
-    --/
+    <<<
+    <> Multi-line
+    <> comment.
+    >>>
   EOF
 
   ANY_COMMENT_HTML = <<-EOF.unindent.chomp # ((( html
@@ -56,7 +56,7 @@ protected
 
   def check_any_comment(patterns, configuration)
     prefix, inner, suffix = patterns
-    check_split_file(ANY_COMMENT_CODE.gsub("/--", prefix).gsub("--/", suffix).gsub(" -", inner),
+    check_split_file(ANY_COMMENT_CODE.gsub("<<<", prefix).gsub(">>>", suffix).gsub("<>", inner),
                      Codnar::Configuration::CLASSIFY_SOURCE_CODE.call("any"),
                      Codnar::Configuration::FORMAT_PRE_COMMENTS,
                      configuration) do |path|

data/test/split_denoted_comment_configurations.rb

@@ -0,0 +1,62 @@
+require "codnar"
+require "olag/test"
+require "test/spec"
+require "test_with_configurations"
+
+# Test built-in split denoted comment configurations.
+class TestSplitDenotedCommentsConfigurations < Test::Unit::TestCase
+
+  include Test::WithConfigurations
+  include Test::WithErrors
+  include Test::WithTempfile
+
+  def test_custom_comments
+    check_any_comment("// @", "//", Codnar::Configuration::CLASSIFY_DENOTED_COMMENTS.call("// @", "//"))
+  end
+
+  def test_haddoc_comments
+    check_any_comment("-- |", "--", Codnar::Configuration::CLASSIFY_HADDOCK_COMMENTS.call)
+  end
+
+protected
+
+  # The "<<<" will be replaced by the start comment prefix,
+  # and the ">>>" will be replaced by the continue comment prefix.
+  ANY_COMMENT_CODE = <<-EOF.unindent
+    >>> Not start comment
+    <<< Start comment
+    >>> Continue comment
+    Not a comment
+  EOF
+
+  # The ">>>" will be replaced by the continue comment prefix.
+  ANY_COMMENT_HTML = <<-EOF.unindent.chomp # ((( html
+    <pre class='code'>
+    >>> Not start comment
+    </pre>
+    <pre class='comment'>
+    Start comment
+    Continue comment
+    </pre>
+    <pre class='code'>
+    Not a comment
+    </pre>
+  EOF
+  # )))
+
+  def check_any_comment(start_prefix, continue_prefix, configuration)
+    check_split_file(ANY_COMMENT_CODE.gsub("<<<", start_prefix).gsub(">>>", continue_prefix),
+                     Codnar::Configuration::CLASSIFY_SOURCE_CODE.call("any"),
+                     Codnar::Configuration::FORMAT_PRE_COMMENTS,
+                     configuration) do |path|
+      [ {
+        "name" => path,
+        "locations" => [ { "file" => path, "line" => 1 } ],
+        "containers" => [],
+        "contained" => [],
+        "html" => ANY_COMMENT_HTML.gsub(">>>", continue_prefix),
+      } ]
+    end
+  end
+
+end

data/test/split_documentation.rb

@@ -46,7 +46,7 @@ class TestSplitDocumentation < Test::Unit::TestCase
       "containers" => [],
       "contained" => [],
       "locations" => [ { "file" => "rdoc.rdoc", "line" => 1 } ],
-      "html" => "<div class='rdoc rdoc markup'>\n<p>\n<b>foo</b> bar\n</p>\n</div>"
+      "html" => "<div class='rdoc rdoc markup'>\n<p>\n<strong>foo</strong> bar\n</p>\n</div>"
     } ]
   end
 

data/test/split_documentation_configurations.rb

@@ -54,7 +54,7 @@ class TestSplitDocumentationConfigurations < Test::Unit::TestCase
   RDOC_HTML = <<-EOF.unindent.chomp #! ((( html
     <div class='rdoc doc markup'>
     <p>
-    This is a <b>marked-up</b> file.
+    This is a <strong>marked-up</strong> file.
     </p>
     </div>
   EOF

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: codnar
 version: !ruby/object:Gem::Version 
-  hash: 147
+  hash: 137
   prerelease: 
   segments: 
   - 0
   - 1
-  - 68
-  version: 0.1.68
+  - 73
+  version: 0.1.73
 platform: ruby
 authors: 
 - Oren Ben-Kiki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-23 00:00:00 Z
+date: 2012-03-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: andand
@@ -228,6 +228,10 @@ files:
 - lib/codnar/application.rb
 - lib/codnar/cache.rb
 - lib/codnar/coderay.rb
+- lib/codnar/configuration/code.rb
+- lib/codnar/configuration/comments.rb
+- lib/codnar/configuration/documentation.rb
+- lib/codnar/configuration/highlighting.rb
 - lib/codnar/data/coderay.css
 - lib/codnar/data/contents.js
 - lib/codnar/data/control_chunks.js
@@ -246,6 +250,7 @@ files:
 - lib/codnar/graphviz.rb
 - lib/codnar/grouper.rb
 - lib/codnar/gvim.rb
+- lib/codnar/haddock.rb
 - lib/codnar/hash_extensions.rb
 - lib/codnar/markdown.rb
 - lib/codnar/merger.rb
@@ -277,6 +282,7 @@ files:
 - test/coderay_highlight_syntax.rb
 - test/deep_merge.rb
 - test/embed_images.rb
+- test/expand_haddock.rb
 - test/expand_markdown.rb
 - test/expand_rdoc.rb
 - test/format_code_configurations.rb
@@ -298,7 +304,8 @@ files:
 - test/split_code.rb
 - test/split_code_configurations.rb
 - test/split_combined_configurations.rb
-- test/split_complex_comment_configurations.rb
+- test/split_delimited_comment_configurations.rb
+- test/split_denoted_comment_configurations.rb
 - test/split_documentation.rb
 - test/split_documentation_configurations.rb
 - test/split_simple_comment_configurations.rb
@@ -316,7 +323,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --title
-- Code Narrator 0.1.68
+- Code Narrator 0.1.73
 - --main
 - README.rdoc
 - --line-numbers
@@ -354,6 +361,7 @@ test_files:
 - test/coderay_highlight_syntax.rb
 - test/deep_merge.rb
 - test/embed_images.rb
+- test/expand_haddock.rb
 - test/expand_markdown.rb
 - test/expand_rdoc.rb
 - test/format_code_configurations.rb
@@ -375,7 +383,8 @@ test_files:
 - test/split_code.rb
 - test/split_code_configurations.rb
 - test/split_combined_configurations.rb
-- test/split_complex_comment_configurations.rb
+- test/split_delimited_comment_configurations.rb
+- test/split_denoted_comment_configurations.rb
 - test/split_documentation.rb
 - test/split_documentation_configurations.rb
 - test/split_simple_comment_configurations.rb