fiat 0.0.2 → 0.0.3

data/Readme.md

@@ -1,18 +1,29 @@
-## Fiat: the auto-`make`-er
+# Fiat: an auto-Make-er
+
+![Alt screenshot](http://i.imgur.com/EMu57.png)
+
+## What?
 
 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.
+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.
+
+## Requirements
+
+- [Ruby](http://www.ruby-lang.org/)
+- [RubyGems](https://rubygems.org/)
 
 ## Installation
 
-Fiat depends on ruby and rubygems, so make sure they're installed. Then:
+	gem install fiat
 
-	$ gem install fiat
+If you haven't installed any gems before, you *may* need to add rubygems' directory to your `$PATH`.
 
-If you haven't installed any gems before, you *may* need to add rubygems' installation directory to your `$PATH`.
+## Usage
 
-## A Usage Example
+	fiat [task]**
+
+## An Example
 
 Suppose we're developing a little C program, and we'd like to automatically run it each time we make changes.
 
@@ -30,14 +41,15 @@ We can execute:
 	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.
+If the output of a task includes one of the defined key terms (`failure_terms`), fiat interprets that run as a failure and prints the end-of-run bar in red.
 
-## `.fiatrc`
+## .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:
 
@@ -56,6 +68,7 @@ Since we're not using a testing package, there's (probably) no reason to define
 	gcc -o hello hello_world.c
 	./hello
 	Hello, world!
+	
 	########################################
 	...
 
@@ -65,4 +78,9 @@ So, our `.fiatrc` is just:
 
 	failure_terms = ["Failed:"]
 
-Easy-peasy.
+Easy-peasy.
+
+## Feedback
+
+This thing's still very much a work-in-progress, so please feel free to shoot me an email if you love it/hate it/want me to fix something about it. =)
+

data/bin/fiat

@@ -3,14 +3,17 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'fiat'
 
+# Default values
 instruction = "test"
 failure_terms = ["failed", "error"]
 poll_interval = 0.5 # seconds
 
+# Overwrite the defaults if there's a .fiatrc in this directory
 if File.exists? ".fiatrc"
   eval File.open(".fiatrc").read
 end
 
+# Overwrite the instruction if one's given on the cmd line
 instruction = ARGV.length == 1 ? ARGV[0] : instruction
 
 unless File.exists? "Makefile"
@@ -27,8 +30,11 @@ puts "Running \"make #{instruction}\" on changes..."
 
 dependencies = Fiat::deps(instruction, Fiat::dep_tree)
 ctimes = Fiat::file_ctimes(dependencies)
+
+# Initial test run
 Fiat::run_tests(dependencies, ctimes, instruction, failure_terms)
 
+# Main loop
 begin
   while true
     if Fiat::anything_changed?(dependencies, ctimes)

data/fiat.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Harry Schwartz"]
   s.email       = ["hrs@cs.wm.edu"]
   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.}
+  s.summary     = %q{The "auto-Make-er."}
+  s.description = %q{Like autotest for Makefiles: fiat automatically and repeatedly executes a given make task every time one of the task's dependencies is saved.}
 
   s.rubyforge_project = "fiat"
 

data/lib/fiat.rb

@@ -1,22 +1,23 @@
-require "fiat/version"
+require 'fiat/version'
 require 'colorize'
 
 module Fiat
   def self.dep_tree
     tree = {}
-    IO.readlines("Makefile").each do |line|
-      if line.include? ":"
-        k = line.split(":").first
-        line = line.split(":")[1..-1].join(":")
-        tree[k] = line.strip.split
-      end
+    task_headers = IO.readlines("Makefile").select{ |l| l.include? ":" }
+    
+    task_headers.each do |line|
+      k = line.split(":").first
+      reqs = line.split(":")[1..-1].join(":")
+      tree[k] = reqs.strip.split
     end
+    
     tree
   end
 
   def self.deps(key, tree)
     if tree.include? key
-      tree[key].map { |d| deps(d, tree) }.flatten.uniq
+      tree[key].map{ |d| deps(d, tree) }.flatten.uniq
     else
       key
     end
@@ -24,11 +25,12 @@ module Fiat
 
   def self.file_ctimes(filenames)
     hash = {}
-    filenames.each do |f|
-      if File.exists? f
+    real_files = filenames.select{ |f| File.exists? f }
+
+    real_files.each do |f|
         hash[f] = File.ctime(f)
-      end
     end
+    
     hash
   end
 
@@ -37,12 +39,7 @@ module Fiat
   end
 
   def self.passed_tests?(result_string, failure_terms)
-    failure_terms.each do |f|
-      if result_string.include? f
-        return false
-      end
-    end
-    true
+    failure_terms.select{ |term| result_string.include? term }.empty?
   end
 
   def self.crashed?(process)
@@ -53,10 +50,11 @@ module Fiat
     results = `make #{instruction}`
     puts results + "\n"
 
+    bar = "#" * 40
     if crashed?($?) or not passed_tests?(results, failure_terms)
-      puts ("#" * 40).red
+      puts bar.red
     else
-      puts ("#" * 40).green
+      puts bar.green
     end
   end
 end

data/lib/fiat/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiat
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-07 00:00:00.000000000Z
+date: 2011-11-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &70327233685920 !ruby/object:Gem::Requirement
+  requirement: &70143896551360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,9 +21,9 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  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.'
+  version_requirements: *70143896551360
+description: ! 'Like autotest for Makefiles: fiat automatically and repeatedly executes
+  a given make task every time one of the task''s dependencies is saved.'
 email:
 - hrs@cs.wm.edu
 executables:
@@ -62,5 +62,5 @@ rubyforge_project: fiat
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: The "auto-Maker."
+summary: The "auto-Make-er."
 test_files: []