2 by Phil Hagelberg (c) 2007
3 http://augment.rubyforge.org
7 Augment is a framework for gathering metadata from code and displaying
8 it. This metadata would include test failures, test coverage levels,
9 complexity metrics, and others. Display frontends will be pluggable so
10 as to interface with many editors.
14 The +augment+ executable gathers metadata in the form of layers for a
15 given file via a backend. Some backends gather data for a file other
16 than the original one passed in. (The test backend will store data for
17 the test if you pass in the implementation.)
21 $ augment test lib/foo.rb # will store metadata for test/test_foo.rb
23 The various frontends have their own executables that provide access
24 to the layer metadata once it's stored. The simplest frontend is
25 +augment_color+ which outputs the layers via ANSI color codes to the
28 $ augment_color test/test_foo.rb
30 Most other frontends are editor-specific.
34 Augment is designed to be generalized; if you want to collect
35 different kinds of data you can just write a new backend. If you want
36 to display the data in an unsupported editor or output format, you can
41 Each backend takes a filename or glob and outputs the metadata about
42 that file into the .augment directory, created in the project root.
43 Metadata is stored as layer information in JSON. Each backend also
44 needs an initiator command to kick off the process that gathers the
45 metadata, with the exception of auto-initiating backends like autotest.
49 Most frontends are implemented within an editor or IDE. They watch
50 the .augment directory for changes and apply them to the open buffers
51 when they happen. The user can choose what augmentations he wants
52 displayed either globally or on a per-file basis. He can also control
53 when backend initiators should be started, though usually these will
54 be kicked off automatically upon saving a file.
58 A layer consists of a single piece of metadata about a file. This is
59 expressed in terms of the range it applies to in the file, its color,
60 and the message associated with it.
71 * Performance (planned)
75 * ANSI color codes (for shells)
82 * Not really, um, written yet.
86 This is free software; you can redistribute it and/or modify it under
87 the terms of the GNU General Public License as published by the Free
88 Software Foundation; either version 3, or (at your option) any later
91 This file is distributed in the hope that it will be useful, but
92 WITHOUT ANY WARRANTY; without even the implied warranty of
93 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
94 General Public License for more details.
96 You should have received a copy of the GNU General Public License
97 along with this software; see the file COPYING. If not, write to the
98 Free Software Foundation at this address:
100 Free Software Foundation
101 51 Franklin Street, Fifth Floor
102 Boston, MA 02110-1301