Build::Graph is a framework for build systems, with specific functionality for dealing with file based processes.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install build-graph
A build graph is an abstract set of
[input, process, output] nodes. A node executes it's process within the context of a
Task which represents a specific set of inputs and outputs and is managed within a
Walker that walks over graph nodes, regenerating tasks where required. If inputs or outputs change (i.e. become dirty), the old task is nullified.
Walker is used to traverse the build graph once. As it walks over the graph it builds a set of
Edge relationships between nodes and only traverses relationships which are complete
Walker#wait_on_paths. Parent nodes also wait until all their children are complete
Walker#wait_on_nodes It also keeps track of failures
Walker#failed? and fails all dependencies of a node.
Task is instantiated once per node when traversing the graph. The task represents a specific process being applied to the graph, e.g. build, clean, etc. It is responsible for actually performing any real actions and providing the methods to do so. A
Task contains all details about the specific graph state at that point in time, e.g.
Task#children and updating the node state in
Task#exit. Statistics on the build graph are also captured through
Walker, e.g. number of nodes visited, etc.
Inputs and Outputs
Inputs to a node should be all on-disk state and any additional parameters which cause it's behavior to produce different results.
Outputs from a node should be all files that are generated directly by the processes within the node and sometimes it's children.
Node has a set of
#outputs but these are abstract. For example,
#outputs could be
:inherit which means that the node symbolically has all the outputs of all it's direct children. A
Task, at the time of execution, captures it's inputs and outputs and these may be monitored for changes in real time.
File changes are currently detected using
File::mtime as this is generally a good trade off between efficiency and accuracy.
When a task is marked as dirty, it also marks all it's outputs as being dirty, which in cause could mark other tasks as dirty. This is the mechanism for which dirtiness propagates through the graph. The walker should only have to traverse the graph once to build it completely. If multiple updates are required (i.e. buidling one part of the graph implicitly dirties another part of the graph), the specification of the graph is incomplete and this may lead to problems within the build graph.
target("Library/UnitTest",  -> :inherit) do library([UnitTest.cpp] -> UnitTest.a) do compile([UnitTest.cpp] -> UnitTest.o) link([UnitTest.o] -> libUnitTest.a) end copy headers: [UnitTest.hpp] # Outputs become libUnitTest.a and UnitTest.hpp end target("Executable/UnitTest",  -> :inherit) do depends("Library/UnitTest") executable(main.cpp -> UnitTest) do compile(main.cpp -> main.o) link([main.o, libUnitTest.a] -> UnitTest) end # Outputs become UnitTest end
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request
Released under the MIT license.
Copyright, 2012, 2014, 2016, by Samuel G. D. Williams.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.