RubyGems - augment - Versions diffs - 1.0.0 - Mend

augment 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (28) hide show

data/COPYING +674 -0
data/History.txt +5 -0
data/Manifest.txt +27 -0
data/README.txt +103 -0
data/Rakefile +26 -0
data/TODO +5 -0
data/bin/augment +16 -0
data/lib/augment.rb +41 -0
data/lib/backends/backend.rb +14 -0
data/lib/backends/coloring_backend.rb +25 -0
data/lib/backends/test_unit_backend.rb +56 -0
data/lib/flet.rb +26 -0
data/lib/frontends/ansi_color_frontend.rb +38 -0
data/lib/frontends/augment.el +148 -0
data/lib/frontends/frontend.rb +8 -0
data/lib/frontends/html_frontend.rb +28 -0
data/lib/layer.rb +27 -0
data/spec/ansi_frontend_spec.rb +26 -0
data/spec/color_backend_spec.rb +32 -0
data/spec/emacs-frontend-test.el +63 -0
data/spec/fixtures/augment-output.txt +3 -0
data/spec/fixtures/drinks/lib/drink.rb +15 -0
data/spec/fixtures/drinks/test/test_drink.rb +19 -0
data/spec/fixtures/layers.json +3 -0
data/spec/html_frontend_spec.rb +24 -0
data/spec/spec_helper.rb +4 -0
data/spec/test_backend_spec.rb +28 -0
metadata +102 -0

data/lib/frontends/frontend.rb ADDED

@@ -0,0 +1,8 @@
+class Frontend
+  class << self
+    def run(file)
+      # TODO: deal with overlapping color ranges
+      Layer.read(file).inject(File.read(file)) { |text, layer| process_layer(text, layer) }
+    end
+  end
+end

data/lib/frontends/html_frontend.rb ADDED

@@ -0,0 +1,28 @@
+class String
+  def html_colorize(color)
+    "<span style='color: #{color};'>#{self}</span>"
+  end
+  def html_colorize_range(range, color)
+    "#{self[0 ... range.begin]}#{self[range].html_colorize(color)}#{self[range.end .. -1]}"
+  end
+end
+class HtmlFrontend < Frontend
+  class << self
+    def run(file)
+      puts "<html>
+  <head><title>#{file} - Augment</title></head>
+  <body>
+#{super(file).gsub("\n", "<br />").gsub('  ', '&nbsp; ')}
+  </body>
+</html>"
+    end
+    def process_layer(text, layer)
+      text.html_colorize_range(layer['range'], layer['color'])
+    end
+  end
+end
+Augment::FRONTENDS['html'] = HtmlFrontend

data/lib/layer.rb ADDED

@@ -0,0 +1,27 @@
+require 'json'
+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/, '')}
+  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
+  end
+  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
+  end
+  def [](attr)
+    @attrs[attr]
+  end
+end

data/spec/ansi_frontend_spec.rb ADDED

@@ -0,0 +1,26 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'spec_helper'
+describe Frontend, " when outputting ANSI color" do
+  before do
+    FileUtils.cd(PROJECT_ROOT)
+    FileUtils.rm_r('lib/.augment') rescue nil
+    FileUtils.rm_r('test/.augment') rescue nil
+    ColoringBackend.run('lib/drink.rb')
+    TestUnitBackend.run('test/test_drink.rb')
+  end
+  it "should color red as red" do
+    output = `../../../bin/augment ansi #{PROJECT_ROOT}/lib/drink.rb`
+    output.to_s.should include("#{'white'.colorize('white')}")
+    output.to_s.should include("#{'red'.colorize('red')}")
+  end
+  it "should color the test_drink" do
+    output = `../../../bin/augment ansi #{PROJECT_ROOT}/test/test_drink.rb`
+    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
+end

data/spec/color_backend_spec.rb ADDED

@@ -0,0 +1,32 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'spec_helper'
+describe Backend, " when augmenting by color" do
+  before do
+    FileUtils.cd(PROJECT_ROOT)
+    FileUtils.rm_r('lib/.augment') rescue nil
+    ColoringBackend.run('lib/drink.rb')
+  end
+  it "should create .augment directory and files" do
+    File.should exist('lib/.augment')
+    File.should exist('lib/.augment/drink.rb')
+  end
+  it "should color the colors and ranges" 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]['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']
+  end
+end

data/spec/emacs-frontend-test.el ADDED

@@ -0,0 +1,63 @@
+;;; augment.el --- Display metadata about code
+;; Copyright (C) 2007 Phil Hagelberg
+;; Author: Phil Hagelberg <technomancy@gmail.com>
+;; Created: 19 Oct 2007
+;; Version: 0.1
+;; Keywords: augment testing metadata
+;; This file is part of the Augment system:
+;; http://augment.rubyforge.org
+(require 'elunit) ;; See http://www.emacswiki.org/cgi-bin/wiki/ElUnit
+(require 'augment)
+(require 'flymake)
+;; in case it hasn't been properly installed
+(add-to-list 'exec-path (expand-file-name "../bin"))
+(elunit-clear-suites)
+(defsuite augment-suite nil)
+(deftest layer-from-plist augment-suite
+  "The layer struct should populated from a plist."
+  (let ((layer (augment-layer-from-plist (list :message "message" :color "color"
+					       :range "221...226"))))
+    (assert-equal 221 (layer-begin layer))
+    (assert-equal 226 (layer-end layer))
+    (assert-equal "color" (layer-color layer))
+    (assert-equal "message" (layer-message layer))))
+(deftest augment-file-path augment-suite
+  (assert-equal "/foo/bar/.augment/baz.rb" (augment-file-path "/foo/bar/baz.rb")))
+(deftest render-layers augment-suite
+  "Rendering layers should create overlays in a buffer."
+  (with-test-buffer
+    ;; Fill the buffer with some garbage
+    (dotimes (i 5) (insert "hello world.\n"))
+    (augment-render-layer (augment-layer-from-plist (list :message "hello"
+							  :color "red"
+							  :range "0...10")))
+    (assert-overlay 1)
+    (assert-overlay 9)))
+(deftest layer-message augment-suite
+  "Finding message at point should get the message of the layer the point is in."
+  (let* ((json-object-type 'plist)
+	 (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))))
+(deftest augment-filter augment-suite
+  (with-test-buffer
+    (make-local-variable 'layers)
+    (dotimes (i 3) (insert "hello world\n"))
+    (augment-filter nil (flymake-read-file-to-string "fixtures/augment-output.txt"))
+    (assert-overlay 2)))
+(elunit "augment-suite")

data/spec/fixtures/augment-output.txt ADDED

@@ -0,0 +1,3 @@
+{"/home/phil/*elunit-output*":[{"message":"cons", "color":"red", "range":"1...12"},
+ {"message":"car", "color":"green", "range":"13...24"},
+ {"message":"cdr", "color":"blue", "range":"25...36"}]}

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

@@ -0,0 +1,15 @@
+class Drink
+  attr_accessor :name, :proof, :color
+  def initialize args
+    @name = args[:name]
+    @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'

data/spec/fixtures/drinks/test/test_drink.rb ADDED

@@ -0,0 +1,19 @@
+require 'test/unit'
+class SampleTest < Test::Unit::TestCase
+  def test_might_error
+    junk.foo
+  end
+  def test_should_pass_longer
+    foo = 2 + 0
+    assert_equal 2, foo
+    assert_match /foo(.*)/, "foobarbunkle"
+  end
+  def test_will_fail
+    a = "hello world"
+    a.split(' ')
+    assert_equal 88, a.length, "bad length"
+  end
+end

data/spec/fixtures/layers.json ADDED

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

data/spec/html_frontend_spec.rb ADDED

@@ -0,0 +1,24 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'spec_helper'
+describe Frontend, " when outputting HTML" do
+  before do
+    FileUtils.cd(PROJECT_ROOT)
+    FileUtils.rm_r('lib/.augment') rescue nil
+    ColoringBackend.run('lib/drink.rb')
+  end
+  it "should create styled spans around colors" do
+    output = `../../../bin/augment html #{PROJECT_ROOT}/lib/drink.rb`
+    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/spec_helper.rb ADDED

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

data/spec/test_backend_spec.rb ADDED

@@ -0,0 +1,28 @@
+$LOAD_PATH << File.dirname(__FILE__)
+require 'spec_helper'
+describe Backend, " when augmenting test results" do
+  before do
+    FileUtils.cd(PROJECT_ROOT)
+    FileUtils.rm_r('test/.augment') rescue nil
+    TestUnitBackend.run('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['range'].should == (289 ... 332)
+  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']
+  end
+end

metadata ADDED

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+rubygems_version: 0.9.2
+specification_version: 1
+name: augment
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+date: 2007-10-27 00:00:00 -07:00
+summary: Augment is a system for collecting and displaying code metadata.
+require_paths:
+- lib
+email: technomancy@gmail.com
+homepage: "    by Phil Hagelberg (c) 2007"
+rubyforge_project: augment
+description: "== Usage  The +augment+ executable gathers metadata in the form of layers for a given file via a backend. Some backends gather data for a file other than the original one passed in. (The test backend will store data for the test if you pass in the implementation.)  Example:  $ augment test lib/foo.rb # will store metadata for test/test_foo.rb"
+autorequire:
+default_executable:
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 0.0.0
+  version:
+platform: ruby
+signing_key:
+cert_chain:
+post_install_message:
+authors:
+- Phil Hagelberg
+files:
+- COPYING
+- TODO
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/augment
+- lib/augment.rb
+- lib/layer.rb
+- lib/flet.rb
+- lib/backends/backend.rb
+- lib/backends/coloring_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
+- 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/fixtures/augment-output.txt
+- spec/fixtures/layers.json
+- spec/fixtures/drinks/lib/drink.rb
+- spec/fixtures/drinks/test/test_drink.rb
+test_files: []
+rdoc_options:
+- --main
+- README.txt
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+- spec/fixtures/augment-output.txt
+executables:
+- augment
+extensions: []
+requirements: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: miniunit
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Version::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    version:
+- !ruby/object:Gem::Dependency
+  name: json
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Version::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+    version:
+- !ruby/object:Gem::Dependency
+  name: hoe
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Version::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+    version: