coffeecake 0.0.1

data/node_modules/docco/lib/docco.js

@@ -0,0 +1,155 @@
+(function() {
+  var destination, docco_styles, docco_template, ensure_directory, exec, ext, fs, generate_documentation, generate_html, get_language, highlight, highlight_end, highlight_start, l, languages, parse, path, showdown, sources, spawn, template, _ref;
+  generate_documentation = function(source, callback) {
+    return fs.readFile(source, "utf-8", function(error, code) {
+      var sections;
+      if (error) {
+        throw error;
+      }
+      sections = parse(source, code);
+      return highlight(source, sections, function() {
+        generate_html(source, sections);
+        return callback();
+      });
+    });
+  };
+  parse = function(source, code) {
+    var code_text, docs_text, has_code, language, line, lines, save, sections, _i, _len;
+    lines = code.split('\n');
+    sections = [];
+    language = get_language(source);
+    has_code = docs_text = code_text = '';
+    save = function(docs, code) {
+      return sections.push({
+        docs_text: docs,
+        code_text: code
+      });
+    };
+    for (_i = 0, _len = lines.length; _i < _len; _i++) {
+      line = lines[_i];
+      if (line.match(language.comment_matcher) && !line.match(language.comment_filter)) {
+        if (has_code) {
+          save(docs_text, code_text);
+          has_code = docs_text = code_text = '';
+        }
+        docs_text += line.replace(language.comment_matcher, '') + '\n';
+      } else {
+        has_code = true;
+        code_text += line + '\n';
+      }
+    }
+    save(docs_text, code_text);
+    return sections;
+  };
+  highlight = function(source, sections, callback) {
+    var language, output, pygments, section, _i, _len, _results;
+    language = get_language(source);
+    pygments = spawn('pygmentize', ['-l', language.name, '-f', 'html', '-O', 'encoding=utf-8']);
+    output = '';
+    pygments.stderr.addListener('data', function(error) {
+      if (error) {
+        return console.error(error);
+      }
+    });
+    pygments.stdout.addListener('data', function(result) {
+      if (result) {
+        return output += result;
+      }
+    });
+    pygments.addListener('exit', function() {
+      var fragments, i, section, _len;
+      output = output.replace(highlight_start, '').replace(highlight_end, '');
+      fragments = output.split(language.divider_html);
+      for (i = 0, _len = sections.length; i < _len; i++) {
+        section = sections[i];
+        section.code_html = highlight_start + fragments[i] + highlight_end;
+        section.docs_html = showdown.makeHtml(section.docs_text);
+      }
+      return callback();
+    });
+    pygments.stdin.write((function() {
+      _results = [];
+      for (_i = 0, _len = sections.length; _i < _len; _i++) {
+        section = sections[_i];
+        _results.push(section.code_text);
+      }
+      return _results;
+    }()).join(language.divider_text));
+    return pygments.stdin.end();
+  };
+  generate_html = function(source, sections) {
+    var dest, html, title;
+    title = path.basename(source);
+    dest = destination(source);
+    html = docco_template({
+      title: title,
+      sections: sections,
+      sources: sources,
+      path: path,
+      destination: destination
+    });
+    console.log("docco: " + source + " -> " + dest);
+    return fs.writeFile(dest, html);
+  };
+  fs = require('fs');
+  path = require('path');
+  showdown = require('./../vendor/showdown').Showdown;
+  _ref = require('child_process'), spawn = _ref.spawn, exec = _ref.exec;
+  languages = {
+    '.coffee': {
+      name: 'coffee-script',
+      symbol: '#'
+    },
+    '.js': {
+      name: 'javascript',
+      symbol: '//'
+    },
+    '.rb': {
+      name: 'ruby',
+      symbol: '#'
+    },
+    '.py': {
+      name: 'python',
+      symbol: '#'
+    }
+  };
+  for (ext in languages) {
+    l = languages[ext];
+    l.comment_matcher = new RegExp('^\\s*' + l.symbol + '\\s?');
+    l.comment_filter = new RegExp('(^#![/]|^\\s*#\\{)');
+    l.divider_text = '\n' + l.symbol + 'DIVIDER\n';
+    l.divider_html = new RegExp('\\n*<span class="c1?">' + l.symbol + 'DIVIDER<\\/span>\\n*');
+  }
+  get_language = function(source) {
+    return languages[path.extname(source)];
+  };
+  destination = function(filepath) {
+    return 'docs/' + path.basename(filepath, path.extname(filepath)) + '.html';
+  };
+  ensure_directory = function(callback) {
+    return exec('mkdir -p docs', function() {
+      return callback();
+    });
+  };
+  template = function(str) {
+    return new Function('obj', 'var p=[],print=function(){p.push.apply(p,arguments);};' + 'with(obj){p.push(\'' + str.replace(/[\r\t\n]/g, " ").replace(/'(?=[^<]*%>)/g, "\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g, "',$1,'").split('<%').join("');").split('%>').join("p.push('") + "');}return p.join('');");
+  };
+  docco_template = template(fs.readFileSync(__dirname + '/../resources/docco.jst').toString());
+  docco_styles = fs.readFileSync(__dirname + '/../resources/docco.css').toString();
+  highlight_start = '<div class="highlight"><pre>';
+  highlight_end = '</pre></div>';
+  sources = process.ARGV.sort();
+  if (sources.length) {
+    ensure_directory(function() {
+      var files, next_file;
+      fs.writeFile('docs/docco.css', docco_styles);
+      files = sources.slice(0);
+      next_file = function() {
+        if (files.length) {
+          return generate_documentation(files.shift(), next_file);
+        }
+      };
+      return next_file();
+    });
+  }
+}).call(this);

data/node_modules/docco/package.json

@@ -0,0 +1,21 @@
+{
+  "name":         "docco",
+  "description":  "The Quick and Dirty Literate Programming Documentation Generator",
+  "keywords":     ["documentation", "docs", "generator", "coffeescript"],
+  "author":       "Jeremy Ashkenas",
+  "version":      "0.3.0",
+  "licenses": [{
+    "type":       "MIT",
+    "url":        "http://opensource.org/licenses/mit-license.php"
+  }],
+  "engines": {
+    "node":       ">=0.2.0"
+  },
+  "directories": {
+    "lib" :       "./lib"
+  },
+  "main" :        "./lib/docco",
+  "bin": {
+    "docco":      "./bin/docco"
+  }
+}

data/node_modules/docco/resources/docco.css

@@ -0,0 +1,186 @@
+/*--------------------- Layout and Typography ----------------------------*/
+body {
+  font-family: 'Palatino Linotype', 'Book Antiqua', Palatino, FreeSerif, serif;
+  font-size: 15px;
+  line-height: 22px;
+  color: #252519;
+  margin: 0; padding: 0;
+}
+a {
+  color: #261a3b;
+}
+  a:visited {
+    color: #261a3b;
+  }
+p {
+  margin: 0 0 15px 0;
+}
+h1, h2, h3, h4, h5, h6 {
+  margin: 0px 0 15px 0;
+}
+  h1 {
+    margin-top: 40px;
+  }
+#container {
+  position: relative;
+}
+#background {
+  position: fixed;
+  top: 0; left: 525px; right: 0; bottom: 0;
+  background: #f5f5ff;
+  border-left: 1px solid #e5e5ee;
+  z-index: -1;
+}
+#jump_to, #jump_page {
+  background: white;
+  -webkit-box-shadow: 0 0 25px #777; -moz-box-shadow: 0 0 25px #777;
+  -webkit-border-bottom-left-radius: 5px; -moz-border-radius-bottomleft: 5px;
+  font: 10px Arial;
+  text-transform: uppercase;
+  cursor: pointer;
+  text-align: right;
+}
+#jump_to, #jump_wrapper {
+  position: fixed;
+  right: 0; top: 0;
+  padding: 5px 10px;
+}
+  #jump_wrapper {
+    padding: 0;
+    display: none;
+  }
+    #jump_to:hover #jump_wrapper {
+      display: block;
+    }
+    #jump_page {
+      padding: 5px 0 3px;
+      margin: 0 0 25px 25px;
+    }
+      #jump_page .source {
+        display: block;
+        padding: 5px 10px;
+        text-decoration: none;
+        border-top: 1px solid #eee;
+      }
+        #jump_page .source:hover {
+          background: #f5f5ff;
+        }
+        #jump_page .source:first-child {
+        }
+table td {
+  border: 0;
+  outline: 0;
+}
+  td.docs, th.docs {
+    max-width: 450px;
+    min-width: 450px;
+    min-height: 5px;
+    padding: 10px 25px 1px 50px;
+    overflow-x: hidden;
+    vertical-align: top;
+    text-align: left;
+  }
+    .docs pre {
+      margin: 15px 0 15px;
+      padding-left: 15px;
+    }
+    .docs p tt, .docs p code {
+      background: #f8f8ff;
+      border: 1px solid #dedede;
+      font-size: 12px;
+      padding: 0 0.2em;
+    }
+    .pilwrap {
+      position: relative;
+    }
+      .pilcrow {
+        font: 12px Arial;
+        text-decoration: none;
+        color: #454545;
+        position: absolute;
+        top: 3px; left: -20px;
+        padding: 1px 2px;
+        opacity: 0;
+        -webkit-transition: opacity 0.2s linear;
+      }
+        td.docs:hover .pilcrow {
+          opacity: 1;
+        }
+  td.code, th.code {
+    padding: 14px 15px 16px 25px;
+    width: 100%;
+    vertical-align: top;
+    background: #f5f5ff;
+    border-left: 1px solid #e5e5ee;
+  }
+    pre, tt, code {
+      font-size: 12px; line-height: 18px;
+      font-family: Monaco, Consolas, "Lucida Console", monospace;
+      margin: 0; padding: 0;
+    }
+
+
+/*---------------------- Syntax Highlighting -----------------------------*/
+td.linenos { background-color: #f0f0f0; padding-right: 10px; }
+span.lineno { background-color: #f0f0f0; padding: 0 5px 0 5px; }
+body .hll { background-color: #ffffcc }
+body .c { color: #408080; font-style: italic }  /* Comment */
+body .err { border: 1px solid #FF0000 }         /* Error */
+body .k { color: #954121 }                      /* Keyword */
+body .o { color: #666666 }                      /* Operator */
+body .cm { color: #408080; font-style: italic } /* Comment.Multiline */
+body .cp { color: #BC7A00 }                     /* Comment.Preproc */
+body .c1 { color: #408080; font-style: italic } /* Comment.Single */
+body .cs { color: #408080; font-style: italic } /* Comment.Special */
+body .gd { color: #A00000 }                     /* Generic.Deleted */
+body .ge { font-style: italic }                 /* Generic.Emph */
+body .gr { color: #FF0000 }                     /* Generic.Error */
+body .gh { color: #000080; font-weight: bold }  /* Generic.Heading */
+body .gi { color: #00A000 }                     /* Generic.Inserted */
+body .go { color: #808080 }                     /* Generic.Output */
+body .gp { color: #000080; font-weight: bold }  /* Generic.Prompt */
+body .gs { font-weight: bold }                  /* Generic.Strong */
+body .gu { color: #800080; font-weight: bold }  /* Generic.Subheading */
+body .gt { color: #0040D0 }                     /* Generic.Traceback */
+body .kc { color: #954121 }                     /* Keyword.Constant */
+body .kd { color: #954121; font-weight: bold }  /* Keyword.Declaration */
+body .kn { color: #954121; font-weight: bold }  /* Keyword.Namespace */
+body .kp { color: #954121 }                     /* Keyword.Pseudo */
+body .kr { color: #954121; font-weight: bold }  /* Keyword.Reserved */
+body .kt { color: #B00040 }                     /* Keyword.Type */
+body .m { color: #666666 }                      /* Literal.Number */
+body .s { color: #219161 }                      /* Literal.String */
+body .na { color: #7D9029 }                     /* Name.Attribute */
+body .nb { color: #954121 }                     /* Name.Builtin */
+body .nc { color: #0000FF; font-weight: bold }  /* Name.Class */
+body .no { color: #880000 }                     /* Name.Constant */
+body .nd { color: #AA22FF }                     /* Name.Decorator */
+body .ni { color: #999999; font-weight: bold }  /* Name.Entity */
+body .ne { color: #D2413A; font-weight: bold }  /* Name.Exception */
+body .nf { color: #0000FF }                     /* Name.Function */
+body .nl { color: #A0A000 }                     /* Name.Label */
+body .nn { color: #0000FF; font-weight: bold }  /* Name.Namespace */
+body .nt { color: #954121; font-weight: bold }  /* Name.Tag */
+body .nv { color: #19469D }                     /* Name.Variable */
+body .ow { color: #AA22FF; font-weight: bold }  /* Operator.Word */
+body .w { color: #bbbbbb }                      /* Text.Whitespace */
+body .mf { color: #666666 }                     /* Literal.Number.Float */
+body .mh { color: #666666 }                     /* Literal.Number.Hex */
+body .mi { color: #666666 }                     /* Literal.Number.Integer */
+body .mo { color: #666666 }                     /* Literal.Number.Oct */
+body .sb { color: #219161 }                     /* Literal.String.Backtick */
+body .sc { color: #219161 }                     /* Literal.String.Char */
+body .sd { color: #219161; font-style: italic } /* Literal.String.Doc */
+body .s2 { color: #219161 }                     /* Literal.String.Double */
+body .se { color: #BB6622; font-weight: bold }  /* Literal.String.Escape */
+body .sh { color: #219161 }                     /* Literal.String.Heredoc */
+body .si { color: #BB6688; font-weight: bold }  /* Literal.String.Interpol */
+body .sx { color: #954121 }                     /* Literal.String.Other */
+body .sr { color: #BB6688 }                     /* Literal.String.Regex */
+body .s1 { color: #219161 }                     /* Literal.String.Single */
+body .ss { color: #19469D }                     /* Literal.String.Symbol */
+body .bp { color: #954121 }                     /* Name.Builtin.Pseudo */
+body .vc { color: #19469D }                     /* Name.Variable.Class */
+body .vg { color: #19469D }                     /* Name.Variable.Global */
+body .vi { color: #19469D }                     /* Name.Variable.Instance */
+body .il { color: #666666 }                     /* Literal.Number.Integer.Long */

data/node_modules/docco/resources/docco.jst

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+  <title><%= title %></title>
+  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+  <link rel="stylesheet" media="all" href="docco.css" />
+</head>
+<body>
+  <div id="container">
+    <div id="background"></div>
+    <% if (sources.length > 1) { %>
+      <div id="jump_to">
+        Jump To &hellip;
+        <div id="jump_wrapper">
+          <div id="jump_page">
+            <% for (var i=0, l=sources.length; i<l; i++) { %>
+              <% var source = sources[i]; %>
+              <a class="source" href="<%= path.basename(destination(source)) %>">
+                <%= path.basename(source) %>
+              </a>
+            <% } %>
+          </div>
+        </div>
+      </div>
+    <% } %>
+    <table cellpadding="0" cellspacing="0">
+      <thead>
+        <tr>
+          <th class="docs">
+            <h1>
+              <%= title %>
+            </h1>
+          </th>
+          <th class="code">
+          </th>
+        </tr>
+      </thead>
+      <tbody>
+        <% for (var i=0, l=sections.length; i<l; i++) { %>
+          <% var section = sections[i]; %>
+          <tr id="section-<%= i + 1 %>">
+            <td class="docs">
+              <div class="pilwrap">
+                <a class="pilcrow" href="#section-<%= i + 1 %>">&#182;</a>
+              </div>
+              <%= section.docs_html %>
+            </td>
+            <td class="code">
+              <%= section.code_html %>
+            </td>
+          </tr>
+        <% } %>
+      </tbody>
+    </table>
+  </div>
+</body>
+</html>

data/node_modules/docco/src/docco.coffee

@@ -0,0 +1,204 @@
+# **Docco** is a quick-and-dirty, hundred-line-long, literate-programming-style
+# documentation generator. It produces HTML that displays your comments
+# alongside your code. Comments are passed through
+# [Markdown](http://daringfireball.net/projects/markdown/syntax), and code is
+# passed through [Pygments](http://pygments.org/) syntax highlighting.
+# This page is the result of running Docco against its own source file.
+#
+# If you install Docco, you can run it from the command-line:
+#
+#     docco src/*.coffee
+#
+# ...will generate linked HTML documentation for the named source files, saving
+# it into a `docs` folder.
+#
+# The [source for Docco](http://github.com/jashkenas/docco) is available on GitHub,
+# and released under the MIT license.
+#
+# To install Docco, first make sure you have [Node.js](http://nodejs.org/),
+# [Pygments](http://pygments.org/) (install the latest dev version of Pygments
+# from [its Mercurial repo](http://dev.pocoo.org/hg/pygments-main)), and
+# [CoffeeScript](http://coffeescript.org/). Then, with NPM:
+#
+#     sudo npm install docco
+#
+# If **Node.js** doesn't run on your platform, or you'd prefer a more convenient
+# package, get [Rocco](http://rtomayko.github.com/rocco/), the Ruby port that's
+# available as a gem. If you're writing shell scripts, try
+# [Shocco](http://rtomayko.github.com/shocco/), a port for the **POSIX shell**.
+# Both are by [Ryan Tomayko](http://github.com/rtomayko). If Python's more
+# your speed, take a look at [Nick Fitzgerald](http://github.com/fitzgen)'s
+# [Pycco](http://fitzgen.github.com/pycco/).
+
+#### Main Documentation Generation Functions
+
+# Generate the documentation for a source file by reading it in, splitting it
+# up into comment/code sections, highlighting them for the appropriate language,
+# and merging them into an HTML template.
+generate_documentation = (source, callback) ->
+  fs.readFile source, "utf-8", (error, code) ->
+    throw error if error
+    sections = parse source, code
+    highlight source, sections, ->
+      generate_html source, sections
+      callback()
+
+# Given a string of source code, parse out each comment and the code that
+# follows it, and create an individual **section** for it.
+# Sections take the form:
+#
+#     {
+#       docs_text: ...
+#       docs_html: ...
+#       code_text: ...
+#       code_html: ...
+#     }
+#
+parse = (source, code) ->
+  lines    = code.split '\n'
+  sections = []
+  language = get_language source
+  has_code = docs_text = code_text = ''
+
+  save = (docs, code) ->
+    sections.push docs_text: docs, code_text: code
+
+  for line in lines
+    if line.match(language.comment_matcher) and not line.match(language.comment_filter)
+      if has_code
+        save docs_text, code_text
+        has_code = docs_text = code_text = ''
+      docs_text += line.replace(language.comment_matcher, '') + '\n'
+    else
+      has_code = yes
+      code_text += line + '\n'
+  save docs_text, code_text
+  sections
+
+# Highlights a single chunk of CoffeeScript code, using **Pygments** over stdio,
+# and runs the text of its corresponding comment through **Markdown**, using the
+# **Github-flavored-Markdown** modification of [Showdown.js](http://attacklab.net/showdown/).
+#
+# We process the entire file in a single call to Pygments by inserting little
+# marker comments between each section and then splitting the result string
+# wherever our markers occur.
+highlight = (source, sections, callback) ->
+  language = get_language source
+  pygments = spawn 'pygmentize', ['-l', language.name, '-f', 'html', '-O', 'encoding=utf-8']
+  output   = ''
+  pygments.stderr.addListener 'data',  (error)  ->
+    console.error error if error
+  pygments.stdout.addListener 'data', (result) ->
+    output += result if result
+  pygments.addListener 'exit', ->
+    output = output.replace(highlight_start, '').replace(highlight_end, '')
+    fragments = output.split language.divider_html
+    for section, i in sections
+      section.code_html = highlight_start + fragments[i] + highlight_end
+      section.docs_html = showdown.makeHtml section.docs_text
+    callback()
+  pygments.stdin.write((section.code_text for section in sections).join(language.divider_text))
+  pygments.stdin.end()
+
+# Once all of the code is finished highlighting, we can generate the HTML file
+# and write out the documentation. Pass the completed sections into the template
+# found in `resources/docco.jst`
+generate_html = (source, sections) ->
+  title = path.basename source
+  dest  = destination source
+  html  = docco_template {
+    title: title, sections: sections, sources: sources, path: path, destination: destination
+  }
+  console.log "docco: #{source} -> #{dest}"
+  fs.writeFile dest, html
+
+#### Helpers & Setup
+
+# Require our external dependencies, including **Showdown.js**
+# (the JavaScript implementation of Markdown).
+fs       = require 'fs'
+path     = require 'path'
+showdown = require('./../vendor/showdown').Showdown
+{spawn, exec} = require 'child_process'
+
+# A list of the languages that Docco supports, mapping the file extension to
+# the name of the Pygments lexer and the symbol that indicates a comment. To
+# add another language to Docco's repertoire, add it here.
+languages =
+  '.coffee':
+    name: 'coffee-script', symbol: '#'
+  '.js':
+    name: 'javascript', symbol: '//'
+  '.rb':
+    name: 'ruby', symbol: '#'
+  '.py':
+    name: 'python', symbol: '#'
+
+# Build out the appropriate matchers and delimiters for each language.
+for ext, l of languages
+
+  # Does the line begin with a comment?
+  l.comment_matcher = new RegExp('^\\s*' + l.symbol + '\\s?')
+
+  # Ignore [hashbangs](http://en.wikipedia.org/wiki/Shebang_(Unix))
+  # and interpolations...
+  l.comment_filter = new RegExp('(^#![/]|^\\s*#\\{)')
+
+  # The dividing token we feed into Pygments, to delimit the boundaries between
+  # sections.
+  l.divider_text = '\n' + l.symbol + 'DIVIDER\n'
+
+  # The mirror of `divider_text` that we expect Pygments to return. We can split
+  # on this to recover the original sections.
+  # Note: the class is "c" for Python and "c1" for the other languages
+  l.divider_html = new RegExp('\\n*<span class="c1?">' + l.symbol + 'DIVIDER<\\/span>\\n*')
+
+# Get the current language we're documenting, based on the extension.
+get_language = (source) -> languages[path.extname(source)]
+
+# Compute the destination HTML path for an input source file path. If the source
+# is `lib/example.coffee`, the HTML will be at `docs/example.html`
+destination = (filepath) ->
+  'docs/' + path.basename(filepath, path.extname(filepath)) + '.html'
+
+# Ensure that the destination directory exists.
+ensure_directory = (callback) ->
+  exec 'mkdir -p docs', -> callback()
+
+# Micro-templating, originally by John Resig, borrowed by way of
+# [Underscore.js](http://documentcloud.github.com/underscore/).
+template = (str) ->
+  new Function 'obj',
+    'var p=[],print=function(){p.push.apply(p,arguments);};' +
+    'with(obj){p.push(\'' +
+    str.replace(/[\r\t\n]/g, " ")
+       .replace(/'(?=[^<]*%>)/g,"\t")
+       .split("'").join("\\'")
+       .split("\t").join("'")
+       .replace(/<%=(.+?)%>/g, "',$1,'")
+       .split('<%').join("');")
+       .split('%>').join("p.push('") +
+       "');}return p.join('');"
+
+# Create the template that we will use to generate the Docco HTML page.
+docco_template  = template fs.readFileSync(__dirname + '/../resources/docco.jst').toString()
+
+# The CSS styles we'd like to apply to the documentation.
+docco_styles    = fs.readFileSync(__dirname + '/../resources/docco.css').toString()
+
+# The start of each Pygments highlight block.
+highlight_start = '<div class="highlight"><pre>'
+
+# The end of each Pygments highlight block.
+highlight_end   = '</pre></div>'
+
+# Run the script.
+# For each source file passed in as an argument, generate the documentation.
+sources = process.ARGV.sort()
+if sources.length
+  ensure_directory ->
+    fs.writeFile 'docs/docco.css', docco_styles
+    files = sources.slice(0)
+    next_file = -> generate_documentation files.shift(), next_file if files.length
+    next_file()
+