RubyGems - codnar - Versions diffs - 0.1.73 → 0.1.74 - Mend

codnar 0.1.73 → 0.1.74

Files changed (5) hide show

data/ChangeLog +1 -0
data/codnar.html +81 -88
data/lib/codnar/rake/split_task.rb +1 -1
data/lib/codnar/version.rb +1 -1
metadata +5 -5

data/ChangeLog CHANGED Viewed

@@ -1,5 +1,6 @@
 2012-03-18	Oren Ben-Kiki <github-oren@ben-kiki.org>
+	* Upgrade for latest gems.
 	* Fix JS comment.
 	* Fix JS issue; remove unneeded files.

data/codnar.html CHANGED Viewed

@@ -376,42 +376,40 @@ span.Comment    { color: Purple; }
 <body>
 <div id="contents"></div>
 <div class='rdoc doc markup'>
-<h1>Codnar</h1>
+<h1 id="label-Codnar">Codnar</h1>
 <p>
 Code Narrator - an inverse literate programming tool.
 </p>
-<h2>TL;DR</h2>
+<h2 id="label-TL%3BDR">TL;DR</h2>
-<h3>Description</h3>
+<h3 id="label-Description">Description</h3>
 <p>
 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.
 </p>
-<h3>Installation</h3>
+<h3 id="label-Installation">Installation</h3>
 <p>
-A simple <tt>gem install codnar</tt> should do the trick, assuming you have
-Ruby gems set up. If you want to use the VIM-based syntax highlighting, you
-also need to install <tt>gvim</tt>. Similarly, you need to install
-<tt>GraphViz</tt> to be able to embed SVG diagrams in your HTML.
+A simple <code>gem install codnar</code> should do the trick, assuming you
+have Ruby gems set up. If you want to use the VIM-based syntax
+highlighting, you also need to install <code>gvim</code>. Similarly, you
+need to install <code>GraphViz</code> to be able to embed SVG diagrams in
+your HTML.
 </p>
-<h3>Usage</h3>
+<h3 id="label-Usage">Usage</h3>
 <p>
 The basic usage is:
 </p>
-<pre>
-codnar-split [options] source-file &gt; chunks-file
-codnar-weave [options] chunks-files... &gt; codnar.html
-</pre>
+<pre>codnar-split [options] source-file &gt; chunks-file
+codnar-weave [options] chunks-files... &gt; codnar.html</pre>
 <p>
-Both programs accept a <tt>-h</tt> or <tt>--help</tt> flag to print more
-detailed usage messages. You can also invoke Codnar from a Rakefile:
+Both programs accept a <code>-h</code> or <code>--help</code> flag to print
+more detailed usage messages. You can also invoke Codnar from a Rakefile:
 </p>
-<pre>
-require &quot;codnar/rake&quot;
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&quot;codnar/rake&quot;</span>
-Codnar::Rake::SplitTask([ source-files... ], [ configurations... ])
-Codnar::Rake::WeaveTask(root-file, [ configurations... ], output)
+<span class="ruby-constant">Codnar</span><span class="ruby-operator">::</span><span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">SplitTask</span>([ <span class="ruby-identifier">source</span><span class="ruby-operator">-</span><span class="ruby-identifier">files</span><span class="ruby-operator">...</span> ], [ <span class="ruby-identifier">configurations</span><span class="ruby-operator">...</span> ])
+<span class="ruby-constant">Codnar</span><span class="ruby-operator">::</span><span class="ruby-constant">Rake</span><span class="ruby-operator">::</span><span class="ruby-constant">WeaveTask</span>(<span class="ruby-identifier">root</span><span class="ruby-operator">-</span><span class="ruby-identifier">file</span>, [ <span class="ruby-identifier">configurations</span><span class="ruby-operator">...</span> ], <span class="ruby-identifier">output</span>)
 </pre>
 </div>
 <div class='markdown doc markup'>
@@ -685,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.73</span><span class="Special">&quot;</span>
+  <span class="Type">VERSION</span> = <span class="Special">&quot;</span><span class="Constant">0.1.74</span><span class="Special">&quot;</span>
 end
 </pre>
@@ -970,8 +968,7 @@ Scan a file into classified lines.
 <p>
 Construct a scanner based on a syntax in the following structure:
 </p>
-<pre>
-patterns:
+<pre>patterns:
   &lt;name&gt;:
     name: &lt;name&gt;
     kind: &lt;kind&gt;
@@ -985,8 +982,7 @@ states:
     - pattern: &lt;pattern&gt;
       kind: &lt;kind&gt;
       next_state: &lt;state&gt;
-start_state: &lt;state&gt;
-</pre>
+start_state: &lt;state&gt;</pre>
 <p>
 To allow for cleaner YAML files to specify the syntax, the following
 shorthands are supported:
@@ -1012,13 +1008,13 @@ A pattern regexp can be presented by a plain string.
 </p>
 </li><li>
 <p>
-The pattern groups field can be ommitted or contain <tt>nil</tt> if it is
-equal to [ “indentation”, “payload” ].
+The pattern groups field can be ommitted or contain <code>nil</code> if it
+is equal to [ “indentation”, “payload” ].
 </p>
 </li><li>
 <p>
 The kind field of a transition can be ommitted; by default it is assumed to
-be identical to the pattern kind. If it ends up <tt>nil</tt>, this
+be identical to the pattern kind. If it ends up <code>nil</code>, this
 indicates that there’s no kind assigned by the pattern, and the current
 line should be classified again by the next state.
 </p>
@@ -1030,7 +1026,7 @@ be identical to the containing state.
 </li><li>
 <p>
 The start state can be ommitted; by default it is assumed to be named
-<tt>start</tt>.
+<code>start</code>.
 </p>
 </li></ul>
 <p>
@@ -1063,11 +1059,9 @@ detected during this process are pushed into the errors.
 Scan a disk file into classified lines in the following format (where the
 groups contain the text extracted by the matching pattern):
 </p>
-<pre>
-- kind: &lt;kind&gt;
+<pre>- kind: &lt;kind&gt;
   line: &lt;text&gt;
-  &lt;group&gt;: &lt;text&gt;
-</pre>
+  &lt;group&gt;: &lt;text&gt;</pre>
 <p>
 By convention, each classified line has a “payload” group that contains
 the “main” content of the line (chunk name for begin/end/nested chunk
@@ -1080,13 +1074,11 @@ If at some state, a file line does not match any pattern, the scanner will
 push a message into the errors. In addition it will classify the line as
 follows:
 </p>
-<pre>
-- kind: error
+<pre>- kind: error
   state: &lt;name&gt;
   line: &lt;text&gt;
   indentation: &lt;leading white space&gt;
-  payload: &lt;line text following the indentation&gt;
-</pre>
+  payload: &lt;line text following the indentation&gt;</pre>
 </div>
 </td>
 </tr>
@@ -1264,7 +1256,7 @@ Fill in the name field for state or pattern object.
 A pattern that matches any line and extracts no data; is meant to be used
 for catch-all transitions that transfer the scanning to a different state.
 It is used if no explicit pattern is specified in a transition (that is,
-you can think of this as the <tt>nil</tt> pattern).
+you can think of this as the <code>nil</code> pattern).
 </p>
 </div>
 </td>
@@ -2537,23 +2529,23 @@ Format chunks into HTML.
 Construct a Formatter based on a mapping from a classified line kind, to a
 Ruby expression, that converts an array of classified lines of that kind,
 into an array of lines of another kind. This expression is simply
-<tt>eval</tt>-ed, and is expected to make use of a variable called
-<tt>lines</tt> that contains an array of classified lines, as produced by a
-Scanner. The result of evaluating the expressions is expected to be an
+<code>eval</code>-ed, and is expected to make use of a variable called
+<code>lines</code> that contains an array of classified lines, as produced
+by a Scanner. The result of evaluating the expressions is expected to be an
 array of any number of classified lines of any kind.
 </p>
 <p>
 Formatting repeatedly applies these formatting expressions, until the
 result is an array containing a single classified line, which has the kind
-<tt>html</tt> and whose payload field contains the unified final HTML
+<code>html</code> and whose payload field contains the unified final HTML
 presentation of the original classified lines. In each processing round,
 all consecutive lines of the same kind are formated together. This allows
 for properly formating line kinds that use a multi-line notation such as
 Markdown.
 </p>
 <p>
-The default formatting expression for the kind <tt>html</tt> simply joins
-all the payloads of all the classified lines into a single html, and
+The default formatting expression for the kind <code>html</code> simply
+joins all the payloads of all the classified lines into a single html, and
 returns a single “line” containing this joined HTML. All other line
 kinds need to have a formatting expression explicitly specified in the
 formatters mapping.
@@ -2561,10 +2553,10 @@ formatters mapping.
 <p>
 If no formatting expression is specified for some classified line kind, an
 error is reported and the classified lines are wrapped in a pre HTML
-element with a <tt>missing_formatter</tt> CSS class. Similarly, if a
+element with a <code>missing_formatter</code> CSS class. Similarly, if a
 formatting expression fails (raises an exception), an error is reported and
 the lines are wrapped in a pre HTML element with a
-<tt>failed_formatter</tt> CSS class.
+<code>failed_formatter</code> CSS class.
 </p>
 </div>
 </td>
@@ -3230,7 +3222,7 @@ above.
 <div class='rdoc comment markup'>
 <p>
 Expand “[[chunk|template]]” to HTML embed tags. Use identifiers instead
-of names in the <tt>src</tt> field for safety, unless the template is a
+of names in the <code>src</code> field for safety, unless the template is a
 magical file template, in which case we must preserve the file path.
 </p>
 </div>
@@ -4009,7 +4001,7 @@ Syntax highlight using GVim.
 <p>
 Convert a sequence of classified code lines to HTML using GVim syntax
 highlighting. The commands array allows configuring the way that GVim will
-format the output (see the <tt>cached_syntax_to_html</tt> method for
+format the output (see the <code>cached_syntax_to_html</code> method for
 details).
 </p>
 </div>
@@ -4081,16 +4073,16 @@ that GVim will format the output. For example:
 </p>
 <ul><li>
 <p>
-The command <tt>&quot;+:colorscheme &lt;name&gt;&quot;</tt> will override
-the default color scheme used.
+The command <code>&quot;+:colorscheme &lt;name&gt;&quot;</code> will
+override the default color scheme used.
 </p>
 </li><li>
 <p>
-The command <tt>&quot;+:let html_use_css=1&quot;</tt> will just annotate
-each HTML tag with a CSS class, instead of embedding some specific style
-directly into the tag. In this case the colorscheme and background are
-ignored; you will need to provide your own CSS stylesheet as part of the
-final woven document to style the marked-up words.
+The command <code>&quot;+:let html_use_css=1&quot;</code> will just
+annotate each HTML tag with a CSS class, instead of embedding some specific
+style directly into the tag. In this case the colorscheme and background
+are ignored; you will need to provide your own CSS stylesheet as part of
+the final woven document to style the marked-up words.
 </p>
 </li></ul>
 <p>
@@ -4100,8 +4092,8 @@ environment so there is no theoretical limit to what can be done here.
 <p>
 Since GVim is as slow as molasses to start up, we cache the results of
 highlighting the syntax of each code fragment in a directory called
-<tt>.gvim-cache</tt>, which can appear at the current working directory or
-in any of its parents.
+<code>.gvim-cache</code>, which can appear at the current working directory
+or in any of its parents.
 </p>
 </div>
 </td>
@@ -4122,9 +4114,9 @@ in any of its parents.
 <td class='html'>
 <div class='rdoc comment markup'>
 <p>
-Highlight syntax of text using GVim, without caching. This is <b>slow</b>
-(measured in seconds), due to GVim’s start-up tim. See the
-<tt>cached_syntax_to_html</tt> method for a faster variant and
+Highlight syntax of text using GVim, without caching. This is
+<strong>slow</strong> (measured in seconds), due to GVim’s start-up tim.
+See the <code>cached_syntax_to_html</code> method for a faster variant and
 functionality details.
 </p>
 </div>
@@ -4700,7 +4692,7 @@ Convert a sequence of classified code lines to HTML using CodeRay syntax
 highlighting. The options control the way CodeRay behaves (e.g.,
 &lt;tt&gt;:css
 </p>
-<h1>&gt; :class&lt;/tt&gt;).</h1>
+<h1 id="label-%3E+%3Aclass%3C%2Ftt%3E%29.">&gt; :class&lt;/tt&gt;).</h1>
 </div>
 </td>
 </tr>
@@ -4829,11 +4821,11 @@ Syntax highlight using Sunlight.
 <div class='rdoc comment markup'>
 <p>
 Convert a sequence of classified code lines to HTML using Sunlight syntax
-highlighting. All we need to do is wrap the lines in an HTML <tt>pre</tt>
-element with the correct class
-(<tt>sunlight-highlight-<em>syntax</em></tt>). The actual highlighting is
-done in the HTML DOM using Javascript. Embedding this Javascript into the
-final HTML should be done separately.
+highlighting. All we need to do is wrap the lines in an HTML
+<code>pre</code> element with the correct class
+(<code>sunlight-highlight-<em>syntax</em></code>). The actual highlighting
+is done in the HTML DOM using Javascript. Embedding this Javascript into
+the final HTML should be done separately.
 </p>
 </div>
 </td>
@@ -5049,11 +5041,9 @@ Split disk files into chunks.
 <p>
 Construct a splitter based on a configuration in the following structure:
 </p>
-<pre>
-syntax: &lt;syntax&gt;
+<pre>syntax: &lt;syntax&gt;
 formatters:
-  &lt;kind&gt;: &lt;expression&gt;
-</pre>
+  &lt;kind&gt;: &lt;expression&gt;</pre>
 <p>
 Where the syntax is passed as-is to (and expanded in-place by) a Scanner,
 and the formatters are passed as-is to a Formatter to convert the chunk’s
@@ -5712,7 +5702,7 @@ Configurations for “splitting” documentation files.
 <div class='rdoc comment markup'>
 <p>
 “Split” a documentation file. All lines are assumed to have the same
-kind <tt>doc</tt> and no indentation is collected. Unless overriden by
+kind <code>doc</code> and no indentation is collected. Unless overriden by
 additional configuration(s), the lines are assumed to contain formatted
 HTML, and are passed as-is to the output.
 </p>
@@ -5923,9 +5913,9 @@ single chunk:
 Classify all lines as source code of some syntax (kind). This doesn’t
 distinguish between comment and code lines; to do that, you need to combine
 this with comment classification configuration(s). Also, it just formats
-the lines in an HTML <tt>pre</tt> element, without any syntax highlighting;
-to do that, you need to combine this with syntax highlighting formatting
-configuration(s).
+the lines in an HTML <code>pre</code> element, without any syntax
+highlighting; to do that, you need to combine this with syntax highlighting
+formatting configuration(s).
 </p>
 </div>
 </td>
@@ -6265,7 +6255,7 @@ treated as a comment.
 <p>
 This configuration is typically complemented by an additional one
 specifying how to format the (stripped!) comments; by default they are just
-displayed as-is using an HTML <tt>pre</tt> element, which isn’t very
+displayed as-is using an HTML <code>pre</code> element, which isn’t very
 useful.
 </p>
 </div>
@@ -6495,7 +6485,7 @@ continues in additional simple comment lines.
 <p>
 This configuration is typically complemented by an additional one
 specifying how to format the (stripped!) comments; by default they are just
-displayed as-is using an HTML <tt>pre</tt> element, which isn’t very
+displayed as-is using an HTML <code>pre</code> element, which isn’t very
 useful.
 </p>
 </div>
@@ -6771,7 +6761,7 @@ classified as a comment.
 <p>
 This configuration is typically complemented by an additional one
 specifying how to format the (stripped!) comments; by default they are just
-displayed as-is using an HTML <tt>pre</tt> element, which isn’t very
+displayed as-is using an HTML <code>pre</code> element, which isn’t very
 useful.
 </p>
 </div>
@@ -7068,7 +7058,7 @@ supported, as well as simply wrapping the comment in an HTML pre element:
 <div class='rdoc comment markup'>
 <p>
 Format comments as HTML pre elements. Is used to complement a configuration
-that classifies some lines as <tt>comment</tt>.
+that classifies some lines as <code>comment</code>.
 </p>
 </div>
 </td>
@@ -7091,7 +7081,7 @@ that classifies some lines as <tt>comment</tt>.
 <div class='rdoc comment markup'>
 <p>
 Format comments that use the RDoc notation. Is used to complement a
-configuration that classifies some lines as <tt>comment</tt>.
+configuration that classifies some lines as <code>comment</code>.
 </p>
 </div>
 </td>
@@ -7115,7 +7105,7 @@ configuration that classifies some lines as <tt>comment</tt>.
 <div class='rdoc comment markup'>
 <p>
 Format comments that use the Markdown notation. Is used to complement a
-configuration that classifies some lines as <tt>comment</tt>.
+configuration that classifies some lines as <code>comment</code>.
 </p>
 </div>
 </td>
@@ -7139,7 +7129,7 @@ configuration that classifies some lines as <tt>comment</tt>.
 <div class='rdoc comment markup'>
 <p>
 Format comments that use the Haddock notation. Is used to complement a
-configuration that classifies some lines as <tt>comment</tt>.
+configuration that classifies some lines as <code>comment</code>.
 </p>
 </div>
 </td>
@@ -9391,7 +9381,7 @@ the following regular expressions must be on a single line.
 <td class='html'>
 <div class='rdoc comment markup'>
 <p>
-Detect embedded chunks (<tt>type</tt> before <tt>src</tt>).
+Detect embedded chunks (<code>type</code> before <code>src</code>).
 </p>
 </div>
 </td>
@@ -9409,7 +9399,7 @@ Detect embedded chunks (<tt>type</tt> before <tt>src</tt>).
 <td class='html'>
 <div class='rdoc comment markup'>
 <p>
-Detect embedded chunks (<tt>src</tt> before <tt>type</tt>).
+Detect embedded chunks (<code>src</code> before <code>type</code>).
 </p>
 </div>
 </td>
@@ -9540,7 +9530,8 @@ And here are the pre-defined weaving template configurations:
 <td class='html'>
 <div class='rdoc comment markup'>
 <p>
-Weave configuration providing a single simple <tt>include</tt> template.
+Weave configuration providing a single simple <code>include</code>
+template.
 </p>
 </div>
 </td>
@@ -9777,8 +9768,9 @@ Here is the implementation:
 <td class='html'>
 <div class='rdoc comment markup'>
 <p>
-Create an <tt>img</tt> tag with an embedded data URL. Different browsers
-have different constraints about the size of the resulting URL, so YMMV.
+Create an <code>img</code> tag with an embedded data URL. Different
+browsers have different constraints about the size of the resulting URL, so
+YMMV.
 </p>
 </div>
 </td>
@@ -11246,7 +11238,7 @@ Actually create common Rake split tasks.
         desc <span class="Special">&quot;</span><span class="Constant">Split all files into chunks</span><span class="Special">&quot;</span>
         ::<span class="Type">Rake</span>::<span class="Type">Task</span>.define_task(<span class="Special">&quot;</span><span class="Constant">codnar_split</span><span class="Special">&quot;</span>)
         desc <span class="Special">&quot;</span><span class="Constant">Clean all split chunks</span><span class="Special">&quot;</span>
-        ::<span class="Type">Rake</span>::<span class="Type">Task</span>.define_task(<span class="Special">&quot;</span><span class="Constant">clean_codnar</span><span class="Special">&quot;</span>) { rm_rf(<span class="Type">Rake</span>.chunks_dir) }
+        ::<span class="Type">Rake</span>::<span class="Type">Task</span>.define_task(<span class="Special">&quot;</span><span class="Constant">clean_codnar</span><span class="Special">&quot;</span>) { <span class="Type">FileUtils</span>.rm_rf(<span class="Type">Rake</span>.chunks_dir) }
         ::<span class="Type">Rake</span>::<span class="Type">Task</span>.define_task(<span class="Constant">:clean</span> =&gt; <span class="Special">&quot;</span><span class="Constant">clean_codnar</span><span class="Special">&quot;</span>)
       <span class="PreProc">end</span>
@@ -11442,8 +11434,9 @@ Run the Weave application for a single source file.
 <td class='html'>
 <div class='rdoc comment markup'>
 <p>
-Connect the task for cleaning up after weaving (<tt>clobber_codnar</tt>) to
-the common task of cleaning up everything (<tt>clobber</tt>).
+Connect the task for cleaning up after weaving
+(<code>clobber_codnar</code>) to the common task of cleaning up everything
+(<code>clobber</code>).
 </p>
 </div>
 </td>

data/lib/codnar/rake/split_task.rb CHANGED Viewed

@@ -53,7 +53,7 @@ module Codnar
         desc "Split all files into chunks"
         ::Rake::Task.define_task("codnar_split")
         desc "Clean all split chunks"
-        ::Rake::Task.define_task("clean_codnar") { rm_rf(Rake.chunks_dir) }
+        ::Rake::Task.define_task("clean_codnar") { FileUtils.rm_rf(Rake.chunks_dir) }
         ::Rake::Task.define_task(:clean => "clean_codnar")
       end

data/lib/codnar/version.rb CHANGED Viewed

@@ -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.73"
+  VERSION = "0.1.74"
 end

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: codnar
 version: !ruby/object:Gem::Version
-  hash: 137
+  hash: 143
   prerelease:
   segments:
   - 0
   - 1
-  - 73
-  version: 0.1.73
+  - 74
+  version: 0.1.74
 platform: ruby
 authors:
 - Oren Ben-Kiki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-03-18 00:00:00 Z
+date: 2012-03-25 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.73
+- Code Narrator 0.1.74
 - --main
 - README.rdoc
 - --line-numbers