codnar 0.1.67 → 0.1.68

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.67"
+  VERSION = "0.1.68"
 
 end

data/test/coderay_highlight_syntax.rb

@@ -0,0 +1,25 @@
+require "codnar"
+require "test/spec"
+
+# Test highlighting syntax using CodeRay.
+class TestCodeRayHighlightSyntax < Test::Unit::TestCase
+
+  def test_coderay_lines
+    Codnar::CodeRay.lines_to_html([
+      { "kind" => "ruby_code", "number" => 1, "indentation" => "",   "payload" => "def foo"  },
+      { "kind" => "ruby_code", "number" => 2, "indentation" => "  ", "payload" => "return 1" },
+      { "kind" => "ruby_code", "number" => 3, "indentation" => "",   "payload" => "end"      },
+    ], "ruby").should == [
+      { "kind" => "html", "number" => 1,
+        "payload" => <<-EOF.unindent.chomp
+          <div class="CodeRay">
+            <div class="code"><pre><span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">foo</span>
+            <span style="color:#080;font-weight:bold">return</span> <span style="color:#00D">1</span>
+          <span style="color:#080;font-weight:bold">end</span></pre></div>
+          </div>
+        EOF
+      },
+    ]
+  end
+
+end

data/test/expand_markdown.rb

@@ -5,23 +5,23 @@ require "test/spec"
 class TestExpandMarkdown < Test::Unit::TestCase
 
   def test_emphasis_text
-    Markdown.to_html("*text*").should == "<p>\n<em>text</em>\n</p>\n"
+    Codnar::Markdown.to_html("*text*").should == "<p>\n<em>text</em>\n</p>\n"
   end
 
   def test_strong_text
-    Markdown.to_html("**text**").should == "<p>\n<strong>text</strong>\n</p>\n"
+    Codnar::Markdown.to_html("**text**").should == "<p>\n<strong>text</strong>\n</p>\n"
   end
 
   def test_embed_chunk
-    Markdown.to_html("[[Chunk|template]]").should == "<p>\n<embed src='chunk' type='x-codnar/template'/>\n</p>\n"
+    Codnar::Markdown.to_html("[[Chunk|template]]").should == "<p>\n<embed src='chunk' type='x-codnar/template'/>\n</p>\n"
   end
 
   def test_embed_anchor
-    Markdown.to_html("[[#Name]]").should == "<p>\n<a id='name'/>\n</p>\n"
+    Codnar::Markdown.to_html("[[#Name]]").should == "<p>\n<a id='name'/>\n</p>\n"
   end
 
   def test_embed_link
-    Markdown.to_html("[Label](#Name)").should == "<p>\n<a href=\"#name\">Label</a>\n</p>\n"
+    Codnar::Markdown.to_html("[Label](#Name)").should == "<p>\n<a href=\"#name\">Label</a>\n</p>\n"
   end
 
 end

data/test/expand_rdoc.rb

@@ -5,16 +5,16 @@ require "test/spec"
 class TestExpandRDoc < Test::Unit::TestCase
 
   def test_emphasis_text
-    RDoc.to_html("_text_").should == "<p>\n<em>text</em>\n</p>\n"
+    Codnar::RDoc.to_html("_text_").should == "<p>\n<em>text</em>\n</p>\n"
   end
 
   def test_strong_text
-    RDoc.to_html("*text*").should == "<p>\n<b>text</b>\n</p>\n"
+    Codnar::RDoc.to_html("*text*").should == "<p>\n<b>text</b>\n</p>\n"
   end
 
   def test_indented_pre
-    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"
+    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"
   end
 
 end

data/test/format_code_configurations.rb

@@ -0,0 +1,71 @@
+require "codnar"
+require "olag/test"
+require "test/spec"
+require "test_with_configurations"
+
+# Test built-in split code formatting configurations.
+class TestFormatCodeConfigurations < Test::Unit::TestCase
+
+  include Test::WithConfigurations
+  include Test::WithErrors
+  include Test::WithTempfile
+
+  def test_gvim_html_code
+    check_any_code(<<-EOF.unindent.chomp, Codnar::Configuration::FORMAT_CODE_GVIM_HTML.call("c"))
+      <div class='c code syntax' bgcolor=\"#ffffff\" text=\"#000000\">
+      <font face=\"monospace\">
+      <font color=\"#00ff00\">int</font>&nbsp;x;<br />
+      </font>
+      </div>
+    EOF
+  end
+
+  def test_gvim_css_code
+    check_any_code(<<-EOF.unindent.chomp, Codnar::Configuration::FORMAT_CODE_GVIM_CSS.call("c"))
+      <pre class='c code syntax'>
+      <span class=\"Type\">int</span> x;
+      </pre>
+    EOF
+  end
+
+  def test_coderay_html_code
+    check_any_code(<<-EOF.unindent.chomp, Codnar::Configuration::FORMAT_CODE_CODERAY_HTML.call("c"))
+      <div class="CodeRay">
+        <div class="code"><pre><span style="color:#0a5;font-weight:bold">int</span> x;</pre></div>
+      </div>
+    EOF
+  end
+
+  def test_coderay_css_code
+    check_any_code(<<-EOF.unindent.chomp, Codnar::Configuration::FORMAT_CODE_CODERAY_CSS.call("c"))
+      <div class="CodeRay">
+        <div class="code"><pre><span class="predefined-type">int</span> x;</pre></div>
+      </div>
+    EOF
+  end
+
+  def test_sunlight_code
+    check_any_code(<<-EOF.unindent.chomp, Codnar::Configuration::FORMAT_CODE_SUNLIGHT.call("c"))
+      <pre class='sunlight-highlight-c'>
+      int x;
+      </pre>
+    EOF
+  end
+
+protected
+
+  def check_any_code(html, configuration)
+    check_split_file("int x;\n",
+                     Codnar::Configuration::CLASSIFY_SOURCE_CODE.call("c"),
+                     configuration) do |path|
+      [ {
+        "name" => path,
+        "locations" => [ { "file" => path, "line" => 1 } ],
+        "containers" => [],
+        "contained" => [],
+        "html" => html,
+      } ]
+    end
+  end
+
+end

data/test/split_code.rb

@@ -38,7 +38,7 @@ protected
       "code" => "Formatter.cast_lines(lines, 'ruby')",
       "comment" => "Formatter.cast_lines(lines, 'rdoc')",
       "ruby" => "GVim.lines_to_html(lines, 'ruby')",
-      "rdoc" => "Formatter.markup_lines_to_html(lines, 'RDoc')",
+      "rdoc" => "Formatter.markup_lines_to_html(lines, Codnar::RDoc, 'rdoc')",
       "begin_chunk" => "[]",
       "end_chunk" => "[]",
       "nested_chunk" => "Formatter.nested_chunk_lines_to_html(lines)",

data/test/split_documentation.rb

@@ -71,7 +71,7 @@ protected
       "formatters" => {
         "markdown" => "Formatter.markup_lines_to_html(lines, Markdown, 'markdown')",
         "unindented_html" => "Formatter.unindented_lines_to_html(lines)",
-        "rdoc" => "Formatter.markup_lines_to_html(lines, 'RDoc')",
+        "rdoc" => "Formatter.markup_lines_to_html(lines, Codnar::RDoc, 'rdoc')",
       },
       "syntax" => {
         "start_state" => kind,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: codnar
 version: !ruby/object:Gem::Version 
-  hash: 157
+  hash: 147
   prerelease: 
   segments: 
   - 0
   - 1
-  - 67
-  version: 0.1.67
+  - 68
+  version: 0.1.68
 platform: ruby
 authors: 
 - Oren Ben-Kiki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-13 00:00:00 Z
+date: 2011-09-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: andand
@@ -32,7 +32,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rdiscount
+  name: coderay
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -46,7 +46,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: olag
+  name: rdiscount
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -60,7 +60,7 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: Saikuro
+  name: olag
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -71,10 +71,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: codnar
+  name: Saikuro
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -88,7 +88,7 @@ dependencies:
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: fakefs
+  name: codnar
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -102,7 +102,7 @@ dependencies:
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: flay
+  name: fakefs
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
@@ -116,7 +116,7 @@ dependencies:
   type: :development
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: flay
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
@@ -130,7 +130,7 @@ dependencies:
   type: :development
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  name: rcov
+  name: rake
   prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
@@ -144,7 +144,7 @@ dependencies:
   type: :development
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
-  name: rdoc
+  name: rcov
   prerelease: false
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
@@ -158,7 +158,7 @@ dependencies:
   type: :development
   version_requirements: *id010
 - !ruby/object:Gem::Dependency 
-  name: reek
+  name: rdoc
   prerelease: false
   requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
@@ -172,7 +172,7 @@ dependencies:
   type: :development
   version_requirements: *id011
 - !ruby/object:Gem::Dependency 
-  name: roodi
+  name: reek
   prerelease: false
   requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
@@ -186,7 +186,7 @@ dependencies:
   type: :development
   version_requirements: *id012
 - !ruby/object:Gem::Dependency 
-  name: test-spec
+  name: roodi
   prerelease: false
   requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
@@ -199,6 +199,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id013
+- !ruby/object:Gem::Dependency 
+  name: test-spec
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id014
 description: Code Narrator (Codnar) is an inverse literate programming tool. It splits the source files into "chunks" (including structured comments) and weaves them back into a narrative that describes the overall system.
 email: rubygems-oren@ben-kiki.org
 executables: 
@@ -213,8 +227,11 @@ extra_rdoc_files:
 files: 
 - lib/codnar/application.rb
 - lib/codnar/cache.rb
+- lib/codnar/coderay.rb
+- lib/codnar/data/coderay.css
 - lib/codnar/data/contents.js
 - lib/codnar/data/control_chunks.js
+- lib/codnar/data/gvim.css
 - lib/codnar/data/style.css
 - lib/codnar/data/sunlight/css-min.js
 - lib/codnar/data/sunlight/default.css
@@ -257,12 +274,12 @@ files:
 - Rakefile
 - codnar.html
 - test/cache_computations.rb
+- test/coderay_highlight_syntax.rb
 - test/deep_merge.rb
 - test/embed_images.rb
 - test/expand_markdown.rb
 - test/expand_rdoc.rb
-- test/format_code_gvim_configurations.rb
-- test/format_code_sunlight_configurations.rb
+- test/format_code_configurations.rb
 - test/format_comment_configurations.rb
 - test/format_lines.rb
 - test/graphviz_diagrams.rb
@@ -299,7 +316,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --title
-- Code Narrator 0.1.67
+- Code Narrator 0.1.68
 - --main
 - README.rdoc
 - --line-numbers
@@ -334,12 +351,12 @@ specification_version: 3
 summary: Code narrator - an inverse literate programming tool.
 test_files: 
 - test/cache_computations.rb
+- test/coderay_highlight_syntax.rb
 - test/deep_merge.rb
 - test/embed_images.rb
 - test/expand_markdown.rb
 - test/expand_rdoc.rb
-- test/format_code_gvim_configurations.rb
-- test/format_code_sunlight_configurations.rb
+- test/format_code_configurations.rb
 - test/format_comment_configurations.rb
 - test/format_lines.rb
 - test/graphviz_diagrams.rb

data/test/format_code_gvim_configurations.rb

@@ -1,55 +0,0 @@
-require "codnar"
-require "olag/test"
-require "test/spec"
-require "test_with_configurations"
-
-# Test built-in split code formatting configurations using GVim.
-class TestGVimFormatCodeConfigurations < Test::Unit::TestCase
-
-  include Test::WithConfigurations
-  include Test::WithErrors
-  include Test::WithTempfile
-
-  CODE_TEXT = <<-EOF.unindent
-    int x;
-  EOF
-
-  GVIM_HTML = <<-EOF.unindent.chomp
-    <div class='c code syntax' bgcolor=\"#ffffff\" text=\"#000000\">
-    <font face=\"monospace\">
-    <font color=\"#00ff00\">int</font>&nbsp;x;<br />
-    </font>
-    </div>
-  EOF
-
-  def test_html_code
-    check_any_code(GVIM_HTML, Codnar::Configuration::FORMAT_CODE_GVIM_HTML.call("c"))
-  end
-
-  GVIM_CSS = <<-EOF.unindent.chomp
-    <pre class='c code syntax'>
-    <span class=\"Type\">int</span> x;
-    </pre>
-  EOF
-
-  def test_css_code
-    check_any_code(GVIM_CSS, Codnar::Configuration::FORMAT_CODE_GVIM_CSS.call("c"))
-  end
-
-protected
-
-  def check_any_code(html, configuration)
-    check_split_file(CODE_TEXT,
-                     Codnar::Configuration::CLASSIFY_SOURCE_CODE.call("c"),
-                     configuration) do |path|
-      [ {
-        "name" => path,
-        "locations" => [ { "file" => path, "line" => 1 } ],
-        "containers" => [],
-        "contained" => [],
-        "html" => html,
-      } ]
-    end
-  end
-
-end

data/test/format_code_sunlight_configurations.rb

@@ -1,37 +0,0 @@
-require "codnar"
-require "olag/test"
-require "test/spec"
-require "test_with_configurations"
-
-# Test built-in split code formatting configurations using Sunlight.
-class TestSunlightFormatCodeConfigurations < Test::Unit::TestCase
-
-  include Test::WithConfigurations
-  include Test::WithErrors
-  include Test::WithTempfile
-
-  CODE_TEXT = <<-EOF.unindent
-    local = $global;
-  EOF
-
-  SUNLIGHT_HTML = <<-EOF.unindent.chomp
-    <pre class='sunlight-highlight-ruby'>
-    local = $global;
-    </pre>
-  EOF
-
-  def test_sunlight_code
-    check_split_file(CODE_TEXT,
-                     Codnar::Configuration::CLASSIFY_SOURCE_CODE.call("ruby"),
-                     Codnar::Configuration::FORMAT_CODE_SUNLIGHT.call("ruby")) do |path|
-      [ {
-        "name" => path,
-        "locations" => [ { "file" => path, "line" => 1 } ],
-        "containers" => [],
-        "contained" => [],
-        "html" => SUNLIGHT_HTML,
-      } ]
-    end
-  end
-
-end