TomParse is a TomDoc parser for Ruby. It provides no other functionality than to take a code comment and parse it in to a convenient object-oriented structure in accordance with the TomDoc standard. See TomDoc for more information about the TomDoc format.
The primary interface is the TomParse.parse method. It will parse the
comment and return a TomParse::TomDoc instance.
TomParse.parse(comment) #=> TomParse::TomDoc
The comment string can have comment markers ('#') or not. The
parse will remove them if present. The resulting TomDoc object
then has a selection of methods that provide information from
the comment, such as #arguments, #examples, etc.
See the API documention for more details on this.
If you are unfamiliar with TomDoc, an example TomDoc comment for a method looks something like this:
# Duplicate some text an arbitrary number of times.
#
# text - The String to be duplicated.
# count - The Integer number of times to duplicate the text.
#
# Examples
# multiplex('Tom', 4)
# # => 'TomTomTomTom'
#
# Returns the duplicated String.
def multiplex(text, count)
text * count
end
TomParse is available as a Ruby gem.
$ gem install tomparse
Use with Bundler by adding to your Gemfile (gems.rb file in the future).
gem "tomparse"
Okay, we told a little white lie in the description. TomParse does take some liberties with the specification to offer up some additional documentation goodness.
The TomDoc specification is rather strict about how arguments are written --they
have to be the second section just after the description. TomParse offers a little
more flexability by allowing for an Arguments header to be used.
# Method to do fooey.
#
# Examples
# foo(name)
#
# Arguments
# name - Name of the fooey.
#
# Returns nothing.
def foo(name)
...We still recommend putting the arguments right after the desciption in most cases,
but there are times when its reads better to put them lower, such when using a
Signatures section (see below).
Ruby 2.0 finally introduces keyword arguments to the language. TomDoc's current
support of argument options, as a secondary argument list of a Hash argument,
doesn't take keyword arguments into good account. To remedy this TomParse provides
an Options section. It is written just like one would an Arguments section.
# Method to do fooey.
#
# Options
# debug - Turn on debug mode? (default: false)
#
# Returns nothing.
def foo(**options)
...One really nice new feature of TomParse is it's ability to recoginize sections starting with a capitalized word followed by a colon and a space, as special section tags or labels (call them what you will). Here is an example:
# Method to do something.
#
# TODO: This is a todo note.
#
# Returns nothing.
def dosomething
...When this is parsed, rather than lumping the TODO line in with the description,
the TomDoc instance will have a tags/labels entry containing ['TODO', 'This is a todo note.'].
It is important for consumer applications to recognize this. They can either just
add the tags back into the description when generating documentation, or handle
them separately. But tags don't have to occur right after the description. They
can occur any place in the documentation.
TomParse does not support the Signature sections in exactly the same fashion as the TomDoc specification describes. Rather than define dynamic methods, signatures are used to specify alternate argument patterns, one signature per line.
# Method to do something.
#
# name - The name of the thing.
# pattern - The pattern of the thing.
#
# Signatures
#
# dosomething(name)
# dosomething(name=>pattern)
#
# Returns nothing.
def dosomething(*args)
...Technically the Signatures section can still be used to designate a dynamic method, but as you can see by the above example, TomParse does not support the field list. If needed just use the arguments list for these as well.
This choice was made because support for signatures as defined by the spec
leads to very non-optimal code. It requires scanning every chunk of documentation
for a Signature section in order to determine how to treat it. What is needed
is a more universal syntax, that can be easily recognized by some clear identifier
at the top of a comment --and one that doesn't confuse dynamic method definitions
with the more traditional concept of method signatures.
- Website
- Source Code (Github)
- API Reference
- IRC Chat
- Upstream Repo
TomParse is copyrighted open-source software.
Copyright (c) 2012 Rubyworks. All rights reserved.
TomParse is distributable under the terms of the [BSD-2-Clause]((http://www.spdx.org/licenses/BSD-2-Clause) license.
See LICENSE.txt for details.