codnar 0.1.74 → 0.1.76

data/ChangeLog

@@ -1,3 +1,11 @@
+2012-04-13	Oren Ben-Kiki <github-oren@ben-kiki.org>
+
+	* Handle Haddock structured module comments.
+
+2012-03-25	Oren Ben-Kiki <github-oren@ben-kiki.org>
+
+	* Get rid of more Rake
+
 2012-03-18	Oren Ben-Kiki <github-oren@ben-kiki.org>
 
 	* Upgrade for latest gems.

data/codnar.html

@@ -683,7 +683,7 @@ number of Git commits by running <code>rake version</code>.
 </tr>
 </table>
 <pre class='ruby code syntax'>
-  <span class="Type">VERSION</span> = <span class="Special">&quot;</span><span class="Constant">0.1.74</span><span class="Special">&quot;</span>
+  <span class="Type">VERSION</span> = <span class="Special">&quot;</span><span class="Constant">0.1.76</span><span class="Special">&quot;</span>
 
 end
 </pre>
@@ -3494,10 +3494,33 @@ run Haddock to generate HTML from it.
     <span class="PreProc">def</span> <span class="Constant">self</span>.<span class="Identifier">write_temporary_file</span>(path, haddock)
       <span class="Type">File</span>.open(path + <span class="Special">&quot;</span><span class="Constant">/wrapper.hs</span><span class="Special">&quot;</span>, <span class="Special">&quot;</span><span class="Constant">w</span><span class="Special">&quot;</span>) <span class="Statement">do</span> |<span class="Identifier">file</span>|
         file.write(<span class="Type">HADDOCK_HEADER</span>)
+        haddock = <span class="Constant">self</span>.patch_module_comments(haddock)
         file.write(<span class="Special">&quot;</span><span class="Constant">-- </span><span class="Special">&quot;</span> + haddock.gsub(<span class="Special">&quot;</span><span class="Special">\n</span><span class="Special">&quot;</span>, <span class="Special">&quot;</span><span class="Special">\n</span><span class="Constant">-- </span><span class="Special">&quot;</span>))
       <span class="Statement">end</span>
     <span class="PreProc">end</span>
 
+</pre>
+    <table class='layout'>
+<tr>
+<td class='indentation'>
+<pre>    </pre>
+</td>
+<td class='html'>
+<div class='rdoc comment markup'>
+<p>
+Convert structured module comments to a definition list. TODO: This is
+rather flaky.
+</p>
+</div>
+</td>
+</tr>
+</table>
+<pre class='ruby code syntax'>
+    <span class="PreProc">def</span> <span class="Constant">self</span>.<span class="Identifier">patch_module_comments</span>(haddock)
+      haddock.sub!(<span class="Special">/</span><span class="Special">^</span><span class="Special">\s</span><span class="Special">*</span><span class="Constant">Module</span><span class="Special">\s</span><span class="Special">*</span><span class="Constant">:</span><span class="Special">\s</span><span class="Special">*</span><span class="Special">\$</span><span class="Special">\s</span><span class="Special">*</span><span class="Constant">header</span><span class="Special">\s</span><span class="Special">*</span><span class="Special">\$</span><span class="Special">\s</span><span class="Special">*</span><span class="Special">$</span><span class="Special">/i</span>, <span class="Special">&quot;</span><span class="Constant">Module</span><span class="Special">&quot;</span>)
+      <span class="Statement">return</span> haddock.gsub(<span class="Special">/</span><span class="Special">^</span><span class="Special">(</span><span class="Special">\s</span><span class="Special">*</span><span class="Special">)(</span><span class="Constant">Module</span><span class="Special">|</span><span class="Constant">Description</span><span class="Special">|</span><span class="Constant">Copyright</span><span class="Special">|</span><span class="Constant">License</span><span class="Special">|</span><span class="Constant">Maintainer</span><span class="Special">|</span><span class="Constant">Stability</span><span class="Special">|</span><span class="Constant">Portability</span><span class="Special">)(</span><span class="Special">\s</span><span class="Special">*</span><span class="Special">)</span><span class="Constant">:</span><span class="Special">/</span>, <span class="Special">&quot;</span><span class="Special">\n\\</span><span class="Constant">1[@</span><span class="Special">\\</span><span class="Constant">2@]</span><span class="Special">\\</span><span class="Constant">3</span><span class="Special">&quot;</span>)
+    <span class="PreProc">end</span>
+
 </pre>
     <table class='layout'>
 <tr>

data/lib/codnar/haddock.rb

@@ -45,10 +45,18 @@ module Codnar
     def self.write_temporary_file(path, haddock)
       File.open(path + "/wrapper.hs", "w") do |file|
         file.write(HADDOCK_HEADER)
+        haddock = self.patch_module_comments(haddock)
         file.write("-- " + haddock.gsub("\n", "\n-- "))
       end
     end
 
+    # Convert structured module comments to a definition list. TODO: This is
+    # rather flaky.
+    def self.patch_module_comments(haddock)
+      haddock.sub!(/^\s*Module\s*:\s*\$\s*header\s*\$\s*$/i, "Module")
+      return haddock.gsub(/^(\s*)(Module|Description|Copyright|License|Maintainer|Stability|Portability)(\s*):/, "\n\\1[@\\2@]\\3")
+    end
+
     # Run Haddock to convert the wrapper Haskell file into HTML documentation.
     def self.run_haddock(path)
       system("cd #{path} && haddock --html wrapper.hs > haddock.out 2>&1")

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.74"
+  VERSION = "0.1.76"
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: codnar
 version: !ruby/object:Gem::Version 
-  hash: 143
+  hash: 131
   prerelease: 
   segments: 
   - 0
   - 1
-  - 74
-  version: 0.1.74
+  - 76
+  version: 0.1.76
 platform: ruby
 authors: 
 - Oren Ben-Kiki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-25 00:00:00 Z
+date: 2012-04-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: andand
@@ -323,7 +323,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --title
-- Code Narrator 0.1.74
+- Code Narrator 0.1.76
 - --main
 - README.rdoc
 - --line-numbers