getNodes and getFullName moved to helpers.coffee

lmaccherone · Aug 4, 2011 · cc83ab7 · cc83ab7
1 parent 9ef1500
commit cc83ab7
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 54 deletions.
diff --git a/lib/coffeedoc.js b/lib/coffeedoc.js
diff --git a/lib/docgen.js b/lib/docgen.js
diff --git a/lib/helpers.js b/lib/helpers.js
diff --git a/src/coffeedoc.coffee b/src/coffeedoc.coffee
@@ -1,11 +1,14 @@
 ###
 Documentation functions
 =======================
+
 These functions extract relevant documentation info from AST nodes as returned
 by the coffeescript parser.
 ###
 
-coffeescript = require('coffee-script')
+helpers = require(__dirname + '/helpers')
+getNodes = helpers.getNodes
+getFullName = helpers.getFullName
 
 exports.documentModule = (script, parser) ->
     ###
@@ -35,26 +38,6 @@ exports.documentModule = (script, parser) ->
 
     return doc
 
-getNodes = (script) ->
-    ###
-    Generates the AST from coffeescript source code.  Adds a 'type' attribute
-    to each node containing the name of the node's constructor, and returns
-    the expressions array
-    ###
-    root_node = coffeescript.nodes(script)
-    root_node.traverseChildren false, (node) ->
-        node.type = node.constructor.name
-    return root_node.expressions
-
-getFullName = (variable) ->
-    ###
-    Given a variable node, returns its full name
-    ###
-    name = variable.base.value
-    if variable.properties.length > 0
-        name += '.' + (p.name.value for p in variable.properties).join('.')
-    return name
-
 documentClass = (cls) ->
     ###
     Evaluates a class object as returned by the coffeescript parser, returning

diff --git a/src/docgen.coffee b/src/docgen.coffee
@@ -1,6 +1,7 @@
 ###
 Documentation generator
 =======================
+
 This script generates html documentation from a coffeescript source file
 ###
 

diff --git a/src/helpers.coffee b/src/helpers.coffee
@@ -0,0 +1,29 @@
+###
+AST helper functions
+====================
+
+Useful functions for dealing with the CoffeeScript parse tree.
+###
+
+coffeescript = require('coffee-script')
+
+exports.getNodes = (script) ->
+    ###
+    Generates the AST from coffeescript source code.  Adds a 'type' attribute
+    to each node containing the name of the node's constructor, and returns
+    the expressions array
+    ###
+    root_node = coffeescript.nodes(script)
+    root_node.traverseChildren false, (node) ->
+        node.type = node.constructor.name
+    return root_node.expressions
+
+exports.getFullName = (variable) ->
+    ###
+    Given a variable node, returns its full name
+    ###
+    name = variable.base.value
+    if variable.properties.length > 0
+        name += '.' + (p.name.value for p in variable.properties).join('.')
+    return name
+