augment 1.0.0 → 1.0.1

data/History.txt

@@ -3,3 +3,6 @@
 * Works with a minimal set of backends and frontends
   * Birthday!
 
+== 1.0.1 / 2007-11-10
+
+* Works with newly-released miniunit 1.1.0.

data/Manifest.txt

@@ -1,27 +1,33 @@
 COPYING
-TODO
 History.txt
 Manifest.txt
 README.txt
 Rakefile
+TODO
 bin/augment
 lib/augment.rb
-lib/layer.rb
-lib/flet.rb
 lib/backends/backend.rb
+lib/backends/clear_backend.rb
 lib/backends/coloring_backend.rb
+lib/backends/flog_backend.rb
 lib/backends/test_unit_backend.rb
-lib/frontends/frontend.rb
 lib/frontends/ansi_color_frontend.rb
-lib/frontends/html_frontend.rb
 lib/frontends/augment.el
+lib/frontends/frontend.rb
+lib/frontends/html_frontend.rb
+lib/layer.rb
+lib/flet.rb
 spec/ansi_frontend_spec.rb
 spec/color_backend_spec.rb
 spec/emacs-frontend-test.el
-spec/html_frontend_spec.rb
-spec/spec_helper.rb
-spec/test_backend_spec.rb
+spec/layer_spec.rb
 spec/fixtures/augment-output.txt
-spec/fixtures/layers.json
 spec/fixtures/drinks/lib/drink.rb
 spec/fixtures/drinks/test/test_drink.rb
+spec/fixtures/layers.json
+spec/fixtures/fix_test.rb
+spec/fixtures/working_test.rb
+spec/html_frontend_spec.rb
+spec/spec_helper.rb
+spec/test_backend_spec.rb
+spec/flog_backend_spec.rb

data/README.txt

@@ -20,12 +20,11 @@ Example:
 
 $ augment test lib/foo.rb # will store metadata for test/test_foo.rb
 
-The various frontends have their own executables that provide access
-to the layer metadata once it's stored. The simplest frontend is
-+augment_color+ which outputs the layers via ANSI color codes to the
-shell:
+You can also use the +augment+ executable to display stored
+metadata. The simplest frontend is +color+ which outputs the
+layers via ANSI color codes to the shell:
 
-$ augment_color test/test_foo.rb
+$ augment color test/test_foo.rb
 
 Most other frontends are editor-specific.
 
@@ -73,13 +72,14 @@ Backends:
 Frontends:
 
 * ANSI color codes (for shells)
-* Emacs (planned)
-* Vim (planned)
+* HTML
+* Emacs
 * Textmate (planned)
+* Vim (planned, need help)
 
 == Issues
   
-* Not really, um, written yet.
+* A bit short on frontends and backends.
 
 == License
 

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'rubygems'
 require 'hoe'
+require 'erb'
 require 'spec/rake/spectask'
 require './lib/augment.rb'
 
@@ -13,12 +14,24 @@ Hoe.new('augment', Augment::VERSION) do |p|
   p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
   p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-  p.extra_deps << ['miniunit', '>= 1.0.1']
+  p.extra_deps << ['miniunit', '>= 1.1.0']
   p.extra_deps << ['json', '>= 1.1.1']
 end
 
 task :publish_html do
-  system("scp -r html/* technomancy@rubyforge.org:/var/www/gforge-projects/augment/")
+  system("scp html/* technomancy@rubyforge.org:/var/www/gforge-projects/augment/")
+end
+
+task :render_html do
+  FileUtils.cd(File.dirname(__FILE__) + '/html/src/')
+  TEMPLATE = File.read('html.erb')
+  Dir.glob('*html').each do |filename|
+    @title = ("Augment - " + filename.match(/(.*)\.html/)[1].gsub(/_/, ' ').capitalize).gsub(/ - Index/, '')
+    @body = File.read(filename)
+    
+    html = ERB.new(TEMPLATE).result( binding )
+    File.open("../#{filename}", 'w') { |f| f.puts html }
+  end
 end
 
 Spec::Rake::SpecTask.new

data/TODO

@@ -1,5 +1,15 @@
-= Backends
-== test/unit
-* Discover char range from exception
-
-* Report rubyforge bug when doing "rubyforge config" on project rinari
+Layers:
+ - determine char range from ambiguous method names and class methods
+ - get the char range for a whole method
+ - get the char range for the "def" line of a method
+FlogBackend:
+ - color layers based on the severity of complexity
+General:
+ - allow "--interactive" use to specify what backends to use
+ - allow for a broader range of colors (html colors?) (how to handle ANSI?)
+ - overlapping layers?
+ - publish html+docs using rsync
+Emacs:
+ - stability issues
+ - augment-show-message
+ - specify what backends to use

data/bin/augment

@@ -3,13 +3,19 @@ $LOAD_PATH << File.dirname(__FILE__) + '/../lib'
 
 require 'augment'
 
+# TODO: real option parsing?
 if ARGV.first == '--interactive'
   Augment.interactive
   exit 0
 elsif ARGV.size != 2
-  puts "Usage: augment BACKEND/FRONTEND FILE"
-  puts "   or: augment --interactive"
-  puts "Output or store metadata regarding code."
+  puts "Usage: augment BACKEND/FRONTEND FILE
+   or: augment --interactive
+Output or store metadata regarding code.
+
+Available backends:
+#{Augment::BACKENDS.map { |k, v| "  #{k}:#{v}"}.join("\n")}
+Available frontends:
+#{Augment::FRONTENDS.map { |k, v| "  #{k}:#{v}"}.join("\n")}"
   exit 1
 end
 

data/lib/augment.rb

@@ -10,7 +10,7 @@ require 'backend'
 require 'frontend'
 
 class Augment
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
   BACKENDS = {}
   FRONTENDS = {}
   
@@ -20,8 +20,12 @@ class Augment
   end
 
   class << self
+    ##
+    # Interactive mode allows you to repeatedly give augment a filename and have
+    # it spit back layer JSON immediately. By default only uses the test backend.
+    #
     def interactive(backend_names = 'test')
-      while true
+      loop do
         begin
           filename = STDIN.gets.chomp
           backend_names.each { |backend| BACKENDS[backend].run(filename) }
@@ -31,11 +35,13 @@ class Augment
         end
       end
     end
-    
+
+    # Where should the JSON layer files be given a file?
     def augment_path(original)
       "#{File.dirname(File.expand_path(original))}/.augment/#{File.basename(original)}"
     end
   end
 end
 
+# Load up backends and frontends
 Dir.glob(File.dirname(__FILE__) + '/*ends/*rb').each { |b| require b[0 .. -4] }

data/lib/backends/backend.rb

@@ -1,7 +1,19 @@
 require 'fileutils'
 
+##
+# Base class from which to subclass other backends. Subclasses must
+# implement the +run+ method that gets passed a file name and must (0)
+# set the +@layers+ instance var to a hash of layers containing the
+# metadata gathered and call the +write_layers+ method when finished
+# to save that data.
+#
 class Backend
   class << self
+    def run(file)
+      raise "Base Backend class shouldn't be used for real augmentation."
+    end
+
+    # Output the +@layers+ hash as JSON where augment expects it.
     def write_layers
       @layers.each do |file, layers|
         FileUtils.mkpath(File.dirname(file) + '/.augment')
@@ -10,5 +22,13 @@ class Backend
         end
       end
     end
+
+    # Suppress STDOUT while a block runs.
+    def with_no_output
+      old_stdout = $stdout.clone
+      $stdout.reopen(File.new('/dev/null','w'))
+      yield
+      $stdout.reopen(old_stdout)
+    end
   end
 end

data/lib/backends/clear_backend.rb

@@ -0,0 +1,14 @@
+require 'find'
+require 'fileutils'
+
+##
+# This backend just gets rid of all .augment files in a directory, recursively.
+class ClearBackend < Backend
+  class << self
+    def run(file)
+      Find.find(file) { |f| FileUtils.rm_rf(f) if f =~ /\.augment$/ }
+    end
+  end
+  
+  Augment::BACKENDS['clear'] = self
+end

data/lib/backends/coloring_backend.rb

@@ -1,3 +1,7 @@
+##
+# This backend is just a dummy that isn't actually useful for anything
+# other than testing purposes.
+#
 class ColoringBackend < Backend
   COLORS = ['white', 'red', 'green', 'blue', 'black']
   
@@ -20,6 +24,6 @@ class ColoringBackend < Backend
       write_layers
     end
   end
+  
+  Augment::BACKENDS['color'] = self
 end
-
-Augment::BACKENDS['color'] = ColoringBackend

data/lib/backends/flog_backend.rb

@@ -0,0 +1,27 @@
+require 'flog'
+
+##
+# Gather complexity metrics about a piece of code via flog
+#
+class FlogBackend < Backend
+  class << self
+    def run(file)
+      @file = file
+      @layers = {}
+
+      flogger = Flog.new
+      flogger.flog_files @file
+      flogger.totals.each { |method, score| record method, score }
+      write_layers
+    end
+
+    def record(method, score)
+      return if method =~ /\#none$/ # tossing this stuff
+      color = 'red' # TODO: determine color smartly
+      message = "#{method} flogs at #{score}"
+      (@layers[@file] ||= []) << Layer.new(method, color, message, self, @file)
+    end
+  end
+
+  Augment::BACKENDS['flog'] = self
+end

data/lib/backends/test_unit_backend.rb

@@ -1,19 +1,26 @@
 Object.flet(:at_exit => lambda {}) do
   # keep miniunit's at_exit block from running
-  gem 'miniunit', ">= 1.0.1"
+  gem 'miniunit', ">= 1.1.0"
   require 'test/unit'
 end
 
-module Test
-  def Unit.puke(*args) # pass on failure info
-    TestUnitBackend.record_failure(*args)
+module MiniTest
+  class Unit
+    # Puke failures/errors in a bucket
+    def puke(*args) 
+      TestUnitBackend.failure_bucket(*args)
+    end
   end
-
-  def Unit.puts(*args); end # muffle test output
 end
 
+##
+# Backend for gathering test results. Instead of ntalbott's test/unit
+# which ships with Ruby as of 1.8.6, this uses miniunit, a vastly
+# simpler mostly-compatible replacement.
+#
 class TestUnitBackend < Backend
   class << self
+    # Kicks off a miniunit run and captures the failures
     def run(file)
       @file = file
       @layers = {}
@@ -24,33 +31,21 @@ class TestUnitBackend < Backend
       write_layers
     end
 
-    def record_failure(klass, method, exception)
+    def failure_bucket(klass, method, exception)
       # FIXME: errors here could actually occur in impl rather than test file
-      (@layers[@file] ||= []) << Layer.from_failure(@file, klass, method, exception)
+      color = Test::Assertion === exception ? 'red' : 'yellow'
+      line = exception.backtrace.grep(Regexp.new(@file))[0].match(/:(\d*):/)[1].to_i
+
+      (@layers[@file] ||= []) << Layer.new(line, color, exception.message, self, @file)
     end
 
+    # This should allow us to augment a test by running its associated
+    # implementation
     def find_test_for(file)
       # TODO: return test for implementation if possible
       file
     end
-
-    def with_no_output
-      old_stdout = $stdout.clone
-      $stdout.reopen(File.new('/dev/null','w'))
-      yield
-      $stdout.reopen(old_stdout)
-    end
   end
+  
+  Augment::BACKENDS['test'] = self
 end
-
-def Layer.from_failure(file, klass, method, exception)
-  color = Test::Assertion === exception ? 'red' : 'yellow'
-
-  trace = exception.backtrace.detect { |e| e =~ /test_drink/ }
-  line = trace.match(/:(\d*):/)[1]
-
-  range = Layer.line_to_char_range(file, line.to_i)
-  Layer.new(range, color, exception.message, TestUnitBackend)
-end
-
-Augment::BACKENDS['test'] = TestUnitBackend

data/lib/flet.rb

@@ -1,20 +1,29 @@
-def Object.flet(bindings, &block)
-  old_methods = {}
+##
+# Horribly disregard any OOP best practices by temporarily redefining
+# methods for the duration of a block. Stolen from Common Lisp.
+#
+# DON'T USE THIS! (unless your *really* mean it and there's no other way)
+#
+class Object
+  def flet(bindings) # :nodoc:all
+    old_methods = {}
 
-  bindings.each do |the_method, body|
-    old_methods[the_method] = method(the_method)
-    define_method(the_method, body)
-  end
-  
-  begin
-    block.call
-  ensure
     bindings.each do |the_method, body|
-      define_method(the_method) { |*args| old_methods[the_method].call(*args) }
+      old_methods[the_method] = method(the_method)
+      define_method(the_method, body)
+    end
+  
+    begin
+      yield
+    ensure
+      bindings.each do |the_method, body|
+        define_method(the_method) { |*args| old_methods[the_method].call(*args) }
+      end
     end
   end
 end
 
+# Demo:
 if $0 == __FILE__
   puts "foo" # should output "foo"
   

data/lib/frontends/ansi_color_frontend.rb

@@ -30,9 +30,8 @@ class AnsiColorFrontend < Frontend
     end
     
     def process_layer(text, layer)
-      text.colorize_range(layer['range'], layer['color'])
+      text.colorize_range(layer.range, layer.color)
     end
   end
+  Augment::FRONTENDS['ansi'] = self
 end
-
-Augment::FRONTENDS['ansi'] = AnsiColorFrontend

data/lib/frontends/augment.el

@@ -52,6 +52,8 @@
 
 (defstruct layer begin end color message backend)
 
+(setq augment-debug t)
+
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
 (defun augment-layer-from-plist (plist)
@@ -75,7 +77,7 @@
    (file-name-directory file) ".augment/"
    (file-name-nondirectory file)))
 
-(defun augment-message-at-point (&optional point)
+(defun augment-show-message (&optional point)
   (interactive)
   ;; find the first layer that the point is between begin and end
   (layer-message (find (or point (point)) layers :test
@@ -93,7 +95,7 @@
 
   (define-key augment-mode-map (kbd "C-c C-s") 'augment-initiate)
   (define-key augment-mode-map (kbd "C-c C-k") 'augment-clear)
-  (define-key augment-mode-map (kbd "C-c C-i") 'augment-message-at-point)
+  (define-key augment-mode-map (kbd "C-c C-i") 'augment-show-message)
   
   (make-local-variable 'layers)
 
@@ -107,7 +109,13 @@
   (setq layers nil)
   (augment-clear)
   (augment-start-process)
-  (process-send-string "augment" (concat (or file (buffer-file-name)) "\n")))
+  (setq in (concat (or file
+		       (expand-file-name (buffer-file-name)))
+		   "\n"))
+   
+  (process-send-string "augment" (concat (or file
+					     (expand-file-name (buffer-file-name)))
+					 "\n")))
 
 (defun augment-start-process ()
   (unless (get-process "augment") ;; only one should be running at a time
@@ -117,6 +125,9 @@
      'augment-filter)))
 
 (defun augment-filter (process output)
+  (setq out output)
+;;  (if augment-debug (with-current-buffer "*augment-debug*"
+;;		      (insert output)))
   (if (string-match "^Error augmenting \\(.*\\)\\." output)
       (error "Error augmenting %s." (match-string 1 output))
     ;; layers need to be cached in local var for messages
@@ -141,7 +152,8 @@
 
 (defun augment-reset ()
   (interactive)
-  (kill-process "augment")
+  (if (get-process "augment")
+    (kill-process "augment"))
   (augment-clear))
 
 (provide 'augment)

data/lib/frontends/html_frontend.rb

@@ -20,9 +20,8 @@ class HtmlFrontend < Frontend
     end
     
     def process_layer(text, layer)
-      text.html_colorize_range(layer['range'], layer['color'])
+      text.html_colorize_range(layer.range, layer.color)
     end
   end
+  Augment::FRONTENDS['html'] = self
 end
-
-Augment::FRONTENDS['html'] = HtmlFrontend

data/lib/layer.rb

@@ -1,27 +1,79 @@
 require 'json'
 
+##
+# Stores metadata about a file. Fields stored are:
+#
+# * range - the character range the layer applies to
+# * color - the color with which to highlight the piece of code
+# * message - what to display to the user
+# * backend - which backend generated this layer
+#
+# Layer data is stored and emitted in JSON format.
+#
+# Note that ranges are always exclusive, so always use three dots!
+#
 class Layer
-  def initialize(range, color, message, backend)
-    range = (range.split('...').first.to_i ... range.split('...').last.to_i) if range.is_a? String
-    @attrs = { 'range' => range, 'color' => color, 'message' => message,
-      'backend' => backend.to_s.downcase.gsub(/backend/, '')}
+  attr_accessor :range, :color, :message, :backend
+
+  def initialize(where, color, message, backend, file = nil)
+    @range, @color, @message, @backend = [Layer.interpret_where(where, file),
+                                          color, message,
+                                          backend.to_s.downcase.gsub(/backend/, '')]
   end
 
-  def self.read(original_file)
-    JSON.parse(File.read(Augment.augment_path(original_file))).map{ |l| Layer.new(l['range'], l['color'], l['message'], l['backend']) }.sort_by{ |l| l['range'].begin }.reverse
+  ##
+  # Determines the correct range as defined by a few rules:
+  #
+  # * Numbers get interpreted as line numbers
+  # * Strings get converted into Ranges if they include '...'
+  # * Otherwise Strings are interpreted as Class#method names
+  # * Ranges pass through untouched
+  #
+  def Layer.interpret_where where, file = nil
+    case where
+    when Fixnum
+      Layer.line_to_char_range file, where
+    when String
+      if where =~ /\.\.\./ # grabbing this from JSON strings
+        Layer.range_string_to_char_range where
+      else
+        Layer.method_to_char_range file, where
+      end
+    else
+      where
+    end
   end
 
+  # Convert a line number to a character range given a file.
   def self.line_to_char_range(file, line)
     file = File.read(file).split("\n")
     start = file[0 ... line - 1].join("\n").size + 2
     (start ... start + file[line - 1].size)
   end
 
-  def to_json
-    @attrs.to_json
+  # Basically implements the inverse of Range#to_s
+  def self.range_string_to_char_range(range)
+    (range.split('...').first.to_i ... range.split('...').last.to_i)
+  end
+
+  # Convert a method name to a character range given a file.
+  def self.method_to_char_range(file, method)
+    # TODO: get smart about what class the method is defined on... ugh
+    start = File.read(file) =~ Regexp.new("def .*#{method.split(/#/).last}")
+    finish = start + 5 # TODO: fix
+    (start ... finish) # we're just layering the word "def" for now
   end
 
-  def [](attr)
-    @attrs[attr]
+  # Slurp up layer data from stored JSON given the original file.
+  def self.read(original_file)
+    return [] if !File.exist?(Augment.augment_path(original_file))
+    layers = JSON.parse(File.read(Augment.augment_path(original_file)))
+    layers.map!{ |l| Layer.new(l['range'], l['color'], l['message'], l['backend']) }
+    layers.sort_by{ |l| l.range.begin }.reverse
+  end
+
+  def to_json
+    { 'range' => @range, 'color' => @color, 'message' => @message,
+      'backend' => @backend}.to_json
   end
 end

data/spec/ansi_frontend_spec.rb

@@ -23,4 +23,8 @@ describe Frontend, " when outputting ANSI color" do
     output.to_s.should match(/\e\[#{String::COLOR_LOOKUP['red']}m *assert/)
     output.to_s.should match(/\e\[#{String::COLOR_LOOKUP['yellow']}m *junk/)
   end
+
+  it "shouldn't complain if the layer file doesn't exist" do
+    Layer.read(__FILE__) # should not raise error
+  end
 end

data/spec/color_backend_spec.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH << File.dirname(__FILE__)
 require 'spec_helper'
 
-describe Backend, " when augmenting by color" do
+describe ColoringBackend, " when augmenting by color" do
   before do
     FileUtils.cd(PROJECT_ROOT)
     FileUtils.rm_r('lib/.augment') rescue nil
@@ -18,15 +18,15 @@ describe Backend, " when augmenting by color" do
     layers = Layer.read('lib/drink.rb')
     layers.size.should == 4
 
-    layers[0]['color'].should == 'black'
-    layers[1]['color'].should == 'green'
-    layers[2]['color'].should == 'red'
-    layers[3]['color'].should == 'white'
+    layers[0].color.should == 'black'
+    layers[1].color.should == 'green'
+    layers[2].color.should == 'red'
+    layers[3].color.should == 'white'
 
-    layers[0]['range'].should == (531 ... 536)
-    layers[1]['range'].should == (456 ... 461)
-    layers[2]['range'].should == (371 ... 374)
-    layers[3]['range'].should == (221 ... 226)
-    layers.map{ |l| l['backend'] }.uniq.should == ['coloring']
+    layers[0].range.should == (575 ... 580)
+    layers[1].range.should == (495 ... 500)
+    layers[2].range.should == (405 ... 408)
+    layers[3].range.should == (245 ... 250)
+    layers.map{ |l| l.backend }.uniq.should == ['coloring']
   end
 end

data/spec/emacs-frontend-test.el

@@ -12,13 +12,16 @@
 
 (require 'elunit) ;; See http://www.emacswiki.org/cgi-bin/wiki/ElUnit
 (require 'augment)
-(require 'flymake)
+(require 'flymake) ;; for flymake-read-file-to-string
 
 ;; in case it hasn't been properly installed
 (add-to-list 'exec-path (expand-file-name "../bin"))
 
 (elunit-clear-suites)
-(defsuite augment-suite nil)
+(lexical-let ((spec-dir (file-name-nondirectory (buffer-file-name (current-buffer)))))
+  (defsuite augment-suite nil :setup-hook (lambda () (cd spec-dir))))
+                                            
+(augment-reset)
 
 (deftest layer-from-plist augment-suite
   "The layer struct should populated from a plist."
@@ -49,9 +52,9 @@
 	 (json-array-type 'list)
 	 (layers (mapcar #'augment-layer-from-plist
 			 (json-read-file "fixtures/layers.json"))))
-    (assert-equal "cons" (augment-message-at-point 5))
-    (assert-equal "car" (augment-message-at-point 16))
-    (assert-equal "cdr" (augment-message-at-point 29))))
+    (assert-equal "cons" (augment-show-message 5))
+    (assert-equal "car" (augment-show-message 16))
+    (assert-equal "cdr" (augment-show-message 29))))
 
 (deftest augment-filter augment-suite
   (with-test-buffer
@@ -60,4 +63,25 @@
     (augment-filter nil (flymake-read-file-to-string "fixtures/augment-output.txt"))
     (assert-overlay 2)))
 
-(elunit "augment-suite")
+(deftest no-problems-file augment-suite
+  (save-excursion
+    (find-file "fixtures/working_test.rb")
+    (augment-initiate)
+    (sleep-for 1)
+    (kill-buffer "working_test.rb")))
+
+(deftest fix-all-problems augment-suite
+  (save-excursion
+    (find-file "fixtures/fix_test.rb")
+    (augment-initiate)
+    (sleep-for 1)
+    (assert-overlay 88)
+    (beginning-of-buffer)
+    (replace-regexp "assert false" "assert true")
+    (augment-initiate)
+    (sleep-for 1)
+    (assert-no-overlay 77)
+    (revert-buffer t t)
+    (kill-buffer "fix_test.rb")))
+  
+(elunit-quiet "augment-suite")

data/spec/fixtures/drinks/lib/drink.rb

@@ -6,10 +6,12 @@ class Drink
     @proof = args[:proof]
     @color = args[:color]
   end
-end
 
-Vodka = Drink.new :name => 'Vodka', :proof => 80, :color => 'white'
-Kahlua = Drink.new :name => 'Kahlua', :proof => 40, :color => 'brown'
-TomatoJuice = Drink.new :name => 'Tomato Juice', :proof => 0, :color => 'red'
-MikesHardLime = Drink.new :name => 'Mike\'s Hard Lime', :proof => 8, :color => 'green'
-Jager = Drink.new :name => 'Jagermeister', :proof => 40, :color => 'black'
+  def self.load_drinks
+    @vodka = Drink.new :name => 'Vodka', :proof => 80, :color => 'white'
+    @kahlua = Drink.new :name => 'Kahlua', :proof => 40, :color => 'brown'
+    @tomatoJuice = Drink.new :name => 'Tomato Juice', :proof => 0, :color => 'red'
+    @mikesHardLime = Drink.new :name => 'Mike\'s Hard Lime', :proof => 8, :color => 'green'
+    @jager = Drink.new :name => 'Jagermeister', :proof => 40, :color => 'black'
+  end
+end

data/spec/fixtures/fix_test.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class FixTest < Test::Unit::TestCase
+  def test_might_error
+    assert false
+  end
+end

data/spec/fixtures/layers.json

@@ -1,3 +1,3 @@
-[{"message":"cons", "color":"red", "range":"1...12"},
- {"message":"car", "color":"green", "range":"13...24"},
- {"message":"cdr", "color":"blue", "range":"25...36"}]
+[{"message":"cons", "color":"red", "range":"1...12", "backend":"coloring"},
+ {"message":"car", "color":"green", "range":"13...24", "backend":"coloring"},
+ {"message":"cdr", "color":"blue", "range":"25...36", "backend":"coloring"}]

data/spec/fixtures/working_test.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class WorkingTest < Test::Unit::TestCase
+  def test_works_fine
+    assert_equal 2, 1 + 1
+  end
+end

data/spec/flog_backend_spec.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH << File.dirname(__FILE__)
+
+require 'spec_helper'
+
+describe FlogBackend, " when augmenting flog results" do
+  before do
+    FileUtils.cd(PROJECT_ROOT)
+    FileUtils.rm_r('lib/.augment') rescue nil
+    
+    FlogBackend.run('lib/drink.rb')
+    @layers = Layer.read('lib/drink.rb')
+  end
+
+  it "should create layers for all methods" do
+    @layers.size.should == 2
+  end
+  
+  it "should include flog levels in the messages" do
+    @layers.first.message.should =~ /9.5/
+    @layers.last.message.should =~ /5.0/
+  end
+  
+  it "should color different levels of ugliness different colors"
+end

data/spec/html_frontend_spec.rb

@@ -14,11 +14,3 @@ describe Frontend, " when outputting HTML" do
     output.to_s.should include("<span style='color: white;'>white</span>")
   end
 end
-
-describe Layer, " when converting line range to char range" do
-  it "should convert properly" do
-    Layer.line_to_char_range('test/test_drink.rb', 10).should == (153 ... 176)
-    Layer.line_to_char_range('test/test_drink.rb', 3).should == (22 ... 61)
-    Layer.line_to_char_range('test/test_drink.rb', 17).should == (289 ... 332)
-  end
-end

data/spec/layer_spec.rb

@@ -0,0 +1,59 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'spec_helper'
+
+describe Layer, " when creating ranges" do
+  before do
+    FileUtils.cd(PROJECT_ROOT)
+    @filename = "test/test_drink.rb"
+  end
+
+  it "should get range from a line number" do
+    Layer.interpret_where(5, @filename).should == (85 ... 97)
+  end
+  
+  it "should get range from a range string" do
+    Layer.interpret_where("22 ... 33").should == (22 ... 33)
+  end
+  
+  it "should get range from a method name" do
+    Layer.interpret_where("#test_might_error", @filename).should == (63 ... 68)
+    Layer.interpret_where("#test_will_fail", @filename).should == (230 ... 235)
+  end
+
+  it "should get range from an ambiguous method name"
+  it "should get range from a class method name"
+end
+
+describe Layer, " when working with JSON" do
+  before do
+    FileUtils.cd(PROJECT_ROOT + '/..')
+    # have to create this on the fly since "augment clear"ing the spec dir will erase it. =(
+    Dir.mkdir('.augment') rescue nil
+    FileUtils.cp('layers.json', '.augment/layers.json')
+    @layers = Layer.read('layers.json').reverse
+  end
+  
+  it "should read from a file" do
+    @layers.map{ |l| l.message }.should == ['cons', 'car', 'cdr']
+    @layers.map{ |l| l.color }.should == ['red', 'green', 'blue']
+    @layers.map{ |l| l.range }.should == [(1...12), (13...24), (25...36)]
+    @layers.map{ |l| l.backend }.uniq.should == ['coloring']
+  end
+  
+  it "should output valid JSON" do
+    @layers.to_json.should == File.read('layers.json').gsub(/[ \n]/, '')
+  end
+
+  after do
+    FileUtils.rm_rf('.augment')
+  end
+end
+
+describe Layer, " when converting line range to char range" do
+  it "should convert properly" do
+    FileUtils.cd(PROJECT_ROOT)
+    Layer.line_to_char_range('test/test_drink.rb', 10).should == (153 ... 176)
+    Layer.line_to_char_range('test/test_drink.rb', 3).should == (22 ... 61)
+    Layer.line_to_char_range('test/test_drink.rb', 17).should == (289 ... 332)
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 $LOAD_PATH << File.dirname(__FILE__) + '/../lib'
 require 'augment'
+require 'fileutils'
 
 PROJECT_ROOT = File.expand_path(File.dirname(__FILE__) + '/fixtures/drinks/') unless defined? PROJECT_ROOT

data/spec/test_backend_spec.rb

@@ -2,27 +2,32 @@ $LOAD_PATH << File.dirname(__FILE__)
 
 require 'spec_helper'
 
-describe Backend, " when augmenting test results" do
+describe TestUnitBackend, " when augmenting test results" do
   before do
     FileUtils.cd(PROJECT_ROOT)
     FileUtils.rm_r('test/.augment') rescue nil
     
     TestUnitBackend.run('test/test_drink.rb')
+    @layers = Layer.read('test/test_drink.rb')
   end
   
   it "should color failing/erroring tests" do
-    File.should exist(Augment.augment_path('test/test_drink.rb'))
-    layers = Layer.read('test/test_drink.rb')
-    layers.first['color'].should == 'red'
-    layers.last['color'].should == 'yellow'
+    @layers.first.color.should == 'red'
+    @layers.last.color.should == 'yellow'
+  end
 
-    layers.first['range'].should == (289 ... 332)
+  it "should set the range to the line of the error/failure" do
+    @layers.first.range.should == (289 ... 332)
+    @layers.last.range.should == (85 ... 97)
   end
   
   it "should include failure message" do
-    layers = Layer.read('test/test_drink.rb')
-    layers.first['message'].should =~ /bad length/
-    layers.last['message'].should =~ /undefined local variable or method/
-    layers.map{ |l| l['backend'] }.uniq.should == ['testunit']
+    @layers = Layer.read('test/test_drink.rb')
+    @layers.first.message.should =~ /bad length/
+    @layers.last.message.should =~ /undefined local variable or method/
+  end
+
+  it "should set the backend field" do
+    @layers.map{ |l| l.backend }.uniq.should == ['testunit']
   end
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: augment
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2007-10-27 00:00:00 -07:00
+  version: 1.0.1
+date: 2007-11-10 00:00:00 -08:00
 summary: Augment is a system for collecting and displaying code metadata.
 require_paths: 
 - lib
@@ -30,32 +30,38 @@ authors:
 - Phil Hagelberg
 files: 
 - COPYING
-- TODO
 - History.txt
 - Manifest.txt
 - README.txt
 - Rakefile
+- TODO
 - bin/augment
 - lib/augment.rb
-- lib/layer.rb
-- lib/flet.rb
 - lib/backends/backend.rb
+- lib/backends/clear_backend.rb
 - lib/backends/coloring_backend.rb
+- lib/backends/flog_backend.rb
 - lib/backends/test_unit_backend.rb
-- lib/frontends/frontend.rb
 - lib/frontends/ansi_color_frontend.rb
-- lib/frontends/html_frontend.rb
 - lib/frontends/augment.el
+- lib/frontends/frontend.rb
+- lib/frontends/html_frontend.rb
+- lib/layer.rb
+- lib/flet.rb
 - spec/ansi_frontend_spec.rb
 - spec/color_backend_spec.rb
 - spec/emacs-frontend-test.el
-- spec/html_frontend_spec.rb
-- spec/spec_helper.rb
-- spec/test_backend_spec.rb
+- spec/layer_spec.rb
 - spec/fixtures/augment-output.txt
-- spec/fixtures/layers.json
 - spec/fixtures/drinks/lib/drink.rb
 - spec/fixtures/drinks/test/test_drink.rb
+- spec/fixtures/layers.json
+- spec/fixtures/fix_test.rb
+- spec/fixtures/working_test.rb
+- spec/html_frontend_spec.rb
+- spec/spec_helper.rb
+- spec/test_backend_spec.rb
+- spec/flog_backend_spec.rb
 test_files: []
 
 rdoc_options: 
@@ -80,7 +86,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.1
+        version: 1.1.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -98,5 +104,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.2
+        version: 1.3.0
     version: