donna/src/nodes/file.coffee

A CoffeeScript documentation generator.

Path     = require 'path'
Class    = require './class'
Method   = require './method'
Variable = require './variable'
Doc      = require './doc'

# Public: The file class is a `fake` class that wraps the
# file body to capture top-level assigned methods.
#
module.exports = class File extends Class

  # Public: Construct a `File` object.
  #
  # node - The class node (a {Object})
  # filename - A {String} representing the current filename
  # lineMapping - An object mapping the actual position of a member to its Donna one
  # options - Any additional parser options
  constructor: (@node, @fileName, @lineMapping, @options) ->
    try
      @methods = []
      @variables = []

      previousExp = null

      for exp in @node.expressions
        switch exp.constructor.name

          when 'Assign'
            doc = previousExp if previousExp?.constructor.name is 'Comment'

            switch exp.value?.constructor.name
              when 'Code'
                @methods.push(new Method(@, exp, @lineMapping, @options, doc))
              when 'Value'
                if exp.value.base.value
                  @variables.push new Variable(@, exp, @lineMapping, @options, true, doc)

            doc = null

          when 'Value'
            previousProp = null

            for prop in exp.base.properties
              doc = previousProp if previousProp?.constructor.name is 'Comment'

              if prop.value?.constructor.name is 'Code'
                @methods.push new Method(@, prop, @lineMapping, @options, doc)

              doc = null
              previousProp = prop
        previousExp = exp

    catch error
      console.warn('File class error:', @node, error) if @options.verbose


  # Public: Get the full file name with path
  #
  # Returns the file name with path as a {String}.
  getFullName: ->
    fullName = @fileName

    for input in @options.inputs
      input = input.replace(///^\.[\/]///, '')                        # Clean leading `./`
      input = input + Path.sep unless ///#{ Path.sep }$///.test input # Append trailing `/`
      input = input.replace(/([.?*+^$[\]\\(){}|-])/g, "\\$1")         # Escape String
      fullName = fullName.replace(new RegExp(input), '')

    fullName.replace(Path.sep, '/')

  # Public: Returns the file class name.
  #
  # Returns the file name without path as a {String}.
  getFileName: ->
    Path.basename @getFullName()

  # Public: Get the file path
  #
  # Returns the file path as a {String}.
  getPath: ->
    path = Path.dirname @getFullName()
    path = '' if path is '.'
    path