fiat 0.0.1 → 0.0.2

data/Readme.md

@@ -0,0 +1,68 @@
+## Fiat: the auto-`make`-er
+
+Fiat's a bit like [autotest](http://www.zenspider.com/ZSS/Products/ZenTest/) for `make`-managed projects.
+
+Fiat monitors a `make` task's dependencies. Each time one of those dependencies changes, fiat executes the task, prints the results, and reports whether the process succeeded or failed. It can be used to check program output or run tests without having to manually execute the task.
+
+## Installation
+
+Fiat depends on ruby and rubygems, so make sure they're installed. Then:
+
+	$ gem install fiat
+
+If you haven't installed any gems before, you *may* need to add rubygems' installation directory to your `$PATH`.
+
+## A Usage Example
+
+Suppose we're developing a little C program, and we'd like to automatically run it each time we make changes.
+
+Sample Makefile:
+
+	all: hello_world.c
+		gcc -o hello hello_world.c
+	run: my_proj
+		./hello
+		
+We can execute:
+
+	$ fiat run
+	Running "make run" on changes...
+	gcc -o hello hello_world.c
+	./hello
+	Hello, world!
+	######################################## // <- this line should be green =)
+	...
+
+Each time we save changes to `my_proj.c`, fiat will execute `make run` and print the results, followed by a line of hashes. This line is <span style="color: green;">green</span> if the program exited cleanly (with exit status == 0) and didn't include one of the failure terms (see below) or <span style="color: red;">red</span> if the program failed in some way. This makes it easy to tell at a glance whether our tests succeeded or failed.
+
+If the output of a task includes one of the defined key terms (`failure_terms`), fiat interprets that run to have been a failure and prints the end-of-run bar in red.
+
+## `.fiatrc`
+
+In the same directory as the Makefile, we can optionally define a `.fiatrc` file which is interpreted when fiat is executed. In it we can set two variables:
+
+- `instruction` -- the `make` task to be run. Defaults to `"test"`.
+- `failure_terms` -- a list of strings that imply failure if any of them appear in the program's output. Defaults to `["failed", "error"]`.
+
+For example, the `.fiatrc` for the sample project above might look like:
+
+	failure_terms = []
+	instruction = "run"
+
+Since we're not using a testing package, there's (probably) no reason to define `failure_terms`; we'll only get a red end-of-run bar when the program returns a non-zero exit status.  However, the `make` task we're using is `run`, so setting `instruction = "run"` allows us to run fiat without arguments:
+
+	$ fiat
+	Running "make run" on changes...
+	gcc -o hello hello_world.c
+	./hello
+	Hello, world!
+	########################################
+	...
+
+Alternately, suppose we're using `make` to manage an Erlang project with EUnit tests, and we'd like to know when our tests fail. The `make` task to execute our tests is fiat's default, `test`.  For fiat's purposes, we'd like to define a failed test to be one in which the term "Failed:" appears.
+
+So, our `.fiatrc` is just:
+
+	failure_terms = ["Failed:"]
+
+Easy-peasy.

data/bin/fiat

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'fiat'
 
 instruction = "test"
-failing_words = ["Failed"]
+failure_terms = ["failed", "error"]
 poll_interval = 0.5 # seconds
 
 if File.exists? ".fiatrc"
@@ -27,12 +27,12 @@ puts "Running \"make #{instruction}\" on changes..."
 
 dependencies = Fiat::deps(instruction, Fiat::dep_tree)
 ctimes = Fiat::file_ctimes(dependencies)
-Fiat::run_tests(dependencies, ctimes, instruction)
+Fiat::run_tests(dependencies, ctimes, instruction, failure_terms)
 
 begin
   while true
     if Fiat::anything_changed?(dependencies, ctimes)
-      Fiat::run_tests(dependencies, ctimes, instruction)
+      Fiat::run_tests(dependencies, ctimes, instruction, failure_terms)
       ctimes = Fiat::file_ctimes(dependencies)
     end
     sleep poll_interval

data/fiat.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Fiat::VERSION
   s.authors     = ["Harry Schwartz"]
   s.email       = ["hrs@cs.wm.edu"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/hrs/fiat"
   s.summary     = %q{The "auto-Maker."}
   s.description = %q{Autotest for Makefiles: fiat automatically and repeatedly executes a given make task every time one of the task's dependencies changes.}
 

data/lib/fiat/version.rb

@@ -1,3 +1,3 @@
 module Fiat
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/fiat.rb

@@ -36,8 +36,8 @@ module Fiat
     ctimes != file_ctimes(filenames)
   end
 
-  def self.passed_tests?(result_string)
-    $failing_words.each do |f|
+  def self.passed_tests?(result_string, failure_terms)
+    failure_terms.each do |f|
       if result_string.include? f
         return false
       end
@@ -49,11 +49,11 @@ module Fiat
     process.exitstatus != 0
   end
 
-  def self.run_tests(dependencies, ctimes, instruction)
+  def self.run_tests(dependencies, ctimes, instruction, failure_terms)
     results = `make #{instruction}`
     puts results + "\n"
 
-    if crashed?($?) or not passed_tests?(results)
+    if crashed?($?) or not passed_tests?(results, failure_terms)
       puts ("#" * 40).red
     else
       puts ("#" * 40).green

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-06 00:00:00.000000000Z
+date: 2011-11-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &70336088014720 !ruby/object:Gem::Requirement
+  requirement: &70327233685920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70336088014720
+  version_requirements: *70327233685920
 description: ! 'Autotest for Makefiles: fiat automatically and repeatedly executes
   a given make task every time one of the task''s dependencies changes.'
 email:
@@ -34,11 +34,12 @@ files:
 - .gitignore
 - Gemfile
 - Rakefile
+- Readme.md
 - bin/fiat
 - fiat.gemspec
 - lib/fiat.rb
 - lib/fiat/version.rb
-homepage: ''
+homepage: https://github.com/hrs/fiat
 licenses: []
 post_install_message: 
 rdoc_options: []