tool-shed 0.0.4

data/rdoc/rdoc-style.css

@@ -0,0 +1,208 @@
+
+body {
+    font-family: Verdana,Arial,Helvetica,sans-serif;
+    font-size:   90%;
+    margin: 0;
+    margin-left: 40px;
+    padding: 0;
+    background: white;
+}
+
+h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
+h1 { font-size: 150%; }
+h2,h3,h4 { margin-top: 1em; }
+
+a { background: #eef; color: #039; text-decoration: none; }
+a:hover { background: #039; color: #eef; }
+
+/* Override the base stylesheet's Anchor inside a table cell */
+td > a {
+  background: transparent;
+  color: #039;
+  text-decoration: none;
+}
+
+/* and inside a section title */
+.section-title > a {
+  background: transparent;
+  color: #eee;
+  text-decoration: none;
+}
+
+/* === Structural elements =================================== */
+
+div#index {
+    margin: 0;
+    margin-left: -40px;
+    padding: 0;
+    font-size: 90%;
+}
+
+
+div#index a {
+    margin-left: 0.7em;
+}
+
+div#index .section-bar {
+   margin-left: 0px;
+   padding-left: 0.7em;
+   background: #ccc;
+   font-size: small;
+}
+
+
+div#classHeader, div#fileHeader {
+    width: auto;
+    color: white;
+    padding: 0.5em 1.5em 0.5em 1.5em;
+    margin: 0;
+    margin-left: -40px;
+    border-bottom: 3px solid #006;
+}
+
+div#classHeader a, div#fileHeader a {
+    background: inherit;
+    color: white;
+}
+
+div#classHeader td, div#fileHeader td {
+    background: inherit;
+    color: white;
+}
+
+
+div#fileHeader {
+    background: #057;
+}
+
+div#classHeader {
+    background: #048;
+}
+
+
+.class-name-in-header {
+  font-size:  180%;
+  font-weight: bold;
+}
+
+
+div#bodyContent {
+    padding: 0 1.5em 0 1.5em;
+}
+
+div#description {
+    padding: 0.5em 1.5em;
+    background: #efefef;
+    border: 1px dotted #999;
+}
+
+div#description h1,h2,h3,h4,h5,h6 {
+    color: #125;;
+    background: transparent;
+}
+
+div#validator-badges {
+    text-align: center;
+}
+div#validator-badges img { border: 0; }
+
+div#copyright {
+    color: #333;
+    background: #efefef;
+    font: 0.75em sans-serif;
+    margin-top: 5em;
+    margin-bottom: 0;
+    padding: 0.5em 2em;
+}
+
+
+/* === Classes =================================== */
+
+table.header-table {
+    color: white;
+    font-size: small;
+}
+
+.type-note {
+    font-size: small;
+    color: #DEDEDE;
+}
+
+.xxsection-bar {
+    background: #eee;
+    color: #333;
+    padding: 3px;
+}
+
+.section-bar {
+   color: #333;
+   border-bottom: 1px solid #999;
+    margin-left: -20px;
+}
+
+
+.section-title {
+    background: #79a;
+    color: #eee;
+    padding: 3px;
+    margin-top: 2em;
+    margin-left: -30px;
+    border: 1px solid #999;
+}
+
+.top-aligned-row {  vertical-align: top }
+.bottom-aligned-row { vertical-align: bottom }
+
+/* --- Context section classes ----------------------- */
+
+.context-row { }
+.context-item-name { font-family: monospace; font-weight: bold; color: black; }
+.context-item-value { font-size: small; color: #448; }
+.context-item-desc { color: #333; padding-left: 2em; }
+
+/* --- Method classes -------------------------- */
+.method-detail {
+    background: #efefef;
+    padding: 0;
+    margin-top: 0.5em;
+    margin-bottom: 1em;
+    border: 1px dotted #ccc;
+}
+.method-heading {
+  color: black;
+  background: #ccc;
+  border-bottom: 1px solid #666;
+  padding: 0.2em 0.5em 0 0.5em;
+}
+.method-signature { color: black; background: inherit; }
+.method-name { font-weight: bold; }
+.method-args { font-style: italic; }
+.method-description { padding: 0 0.5em 0 0.5em; }
+
+/* --- Source code sections -------------------- */
+
+a.source-toggle { font-size: 90%; }
+div.method-source-code {
+    background: #262626;
+    color: #ffdead;
+    margin: 1em;
+    padding: 0.5em;
+    border: 1px dashed #999;
+    overflow: hidden;
+}
+
+div.method-source-code pre { color: #ffdead; overflow: hidden; }
+
+/* --- Ruby keyword styles --------------------- */
+
+.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
+
+.ruby-constant  { color: #7fffd4; background: transparent; }
+.ruby-keyword { color: #00ffff; background: transparent; }
+.ruby-ivar    { color: #eedd82; background: transparent; }
+.ruby-operator  { color: #00ffee; background: transparent; }
+.ruby-identifier { color: #ffdead; background: transparent; }
+.ruby-node    { color: #ffa07a; background: transparent; }
+.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
+.ruby-regexp  { color: #ffa07a; background: transparent; }
+.ruby-value   { color: #7fffd4; background: transparent; }

data/test/fixtures/src/org/helvector/Helvector.as

@@ -0,0 +1,16 @@
+package org.helvector
+{
+
+import flash.display.Sprite;
+
+public class Helvector
+{
+
+    public function Helvector()
+    {
+        super();
+    }
+
+}
+
+}

data/test/fixtures/src/org/helvector/one/HelOne.as

@@ -0,0 +1,14 @@
+package org.helvector.one
+{
+
+public class HelOne
+{
+
+    public function HelOne()
+    {
+        super();
+    }
+
+}
+
+}

data/test/fixtures/src/org/helvector/one/package.asdoc

@@ -0,0 +1 @@
+Package One

data/test/fixtures/src/org/helvector/package.asdoc

@@ -0,0 +1 @@
+Package

data/test/fixtures/src/org/helvector/three/HelThree.as

@@ -0,0 +1,14 @@
+package org.helvector.three
+{
+
+public class HelThree
+{
+
+    public function HelThree()
+    {
+        super();
+    }
+
+}
+
+}

data/test/fixtures/src/org/helvector/three/package.asdoc

@@ -0,0 +1 @@
+Package Three

data/test/fixtures/src/org/helvector/two/HelTwo.as

@@ -0,0 +1,14 @@
+package org.helvector.two
+{
+
+public class HelTwo
+{
+
+    public function HelTwo()
+    {
+        super();
+    }
+
+}
+
+}

data/test/fixtures/src/org/helvector/two/package.asdoc

@@ -0,0 +1 @@
+Package Two

data/test/fixtures/unused-asset/src/org/helvector/ToolShed.as

@@ -0,0 +1,30 @@
+//AS3///////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2010 the original author or authors.
+//
+////////////////////////////////////////////////////////////////////////////////
+
+package org.helvector
+{
+
+public class ToolShed extends Object
+{
+
+    public function ToolShed()
+    {
+        super();
+    }
+
+    [Embed(source='/../assets/fonts/referenced.otf', fontFamily='RaRa')]
+    private var fontEg:Class;
+
+    [Embed(source='/../assets/img/referenced.jpg')]
+    private var jpgEg:Class;
+
+    [Embed(source='/../assets/img/referenced.png')]
+    private var pngEG:Class
+
+
+}
+
+}

data/test/fixtures/unused-cla/link-report.xml

@@ -0,0 +1,17 @@
+<report>
+  <scripts>
+		<script name="/Users/simon/ipd/electra/src/uk/co/bbc/electra/views/settingsview/AboutBBCDesktop.mxml" mod="1282818220809" size="1360" optimizedsize="1236">
+	      <def id="uk.co.bbc.electra.views.settingsview.AboutBBCDesktop" />
+	      <pre id="mx.binding:IWatcherSetupUtil" />
+	      <pre id="flash.display:Sprite" />
+	    </script>
+	    <script name="/Users/simon/ipd/electra/src/uk/co/bbc/electra/views/components/AboutWindow.mxml" mod="1280142913000" size="4461" optimizedsize="4268">
+	      <def id="uk.co.bbc.electra.views.components:AboutWindow" />
+	      <pre id="flash.events:IEventDispatcher" />
+	    </script>	    
+	</scripts>
+  <external-defs>
+  </external-defs>
+</report>
+
+

data/test/fixtures/unused-cla/manifest.xml

@@ -0,0 +1,6 @@
+<?xml version='1.0'?>
+<componentPackage>
+	<component id="AboutBBCDesktop" class="uk.co.bbc.electra.views.settingsview.AboutBBCDesktop" />
+	<component id="AboutWindow" class="uk.co.bbc.electra.views.components.AboutWindow" />
+	<component id="UnusedClass" class="uk.co.bbc.electra.views.components.UnusedClass" />
+</componentPackage>

data/test/fixtures/unused-css/css/styles.css

@@ -0,0 +1,2 @@
+.usedStyle {}
+.unUsedStyle {}

data/test/fixtures/unused-css/css-multiple/more.css

@@ -0,0 +1,2 @@
+.moreUsedStyle {}
+.moreUnUsedStyle {}

data/test/fixtures/unused-css/css-multiple/styles.css

@@ -0,0 +1,2 @@
+.usedStyle {}
+.unUsedStyle {}

data/test/fixtures/unused-css/css-with-comments/commented.css

@@ -0,0 +1,6 @@
+.moreUsedStyle {}
+.moreUnUsedStyle {}
+
+/*
+.aCommentedOutStyle {}
+*/

data/test/fixtures/unused-css/src/CSSApp.mxml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<mx:Canvas xmlns:mx="http://www.adobe.com/2006/mxml">
+    <mx:Button styleName="usedStyle"/>
+    <mx:Button styleName="undeclaredStyle"/>
+</mx:Canvas>

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+$:.push File.join(File.dirname(__FILE__), "..", "lib")
+$:.push File.dirname(__FILE__)
+
+require 'tool_shed'
+require 'bundler'
+
+Bundler.require :development

data/test/unit/test_asdoc_package.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class ASDocPackageTest < Test::Unit::TestCase
+
+  context "An ASDdoc Package Tool" do
+
+    setup do
+      @out = '/tmp/asdoc-package-tool-test-output.xml'
+      src  = File.expand_path(File.dirname(__FILE__)+ "/../fixtures/src")
+      opts = ASDocPackageOpts.parse ['-s', src,'-o', @out, '--silent']
+      @pack = ASDocPackage.new(opts)
+    end
+
+    teardown do
+      File.delete(@out)
+      @out = nil
+      @pack = nil
+    end
+
+    should "find .asdoc files in src directories" do
+      assert_not_nil(@pack.xml)
+      assert_equal(false, @pack.xml.empty?)
+
+      assert_match(/<flex-config>/, @pack.xml)
+      assert_match(/Package One/, @pack.xml)
+      assert_match(/Package Two/, @pack.xml)
+      assert_match(/Package Three/, @pack.xml)
+    end
+
+    should "output the results to a file" do
+      assert File.exist? @out
+    end
+
+  end
+
+  context "A ASDocPackage tool should skip specified directories" do
+    setup do
+      src  = File.expand_path(File.dirname(__FILE__)+ "/../fixtures/src")
+      opts = { :verbose => true,
+               :src => src,
+               :output => '/tmp/asdoc-package-tool-test-output.xml',
+               :excludes => ['one'],
+               :silent => true }
+
+      @pack = ASDocPackage.new(opts)
+    end
+
+    should "not search excluded directories" do
+      assert_not_nil(@pack.xml)
+      assert_equal(false, @pack.xml.empty?)
+      p = @pack.xml =~ /Package One/ ? true : false
+      assert_equal(false,p)
+    end
+  end
+
+  context "A asdoc package builder tool invoked on a empty directory" do
+    setup do
+      @output = '/tmp/as-manifest-tool-test.xml'
+      src  = File.expand_path(File.dirname(__FILE__)+ "/../fixtures/empty")
+      opts = ASDocPackageOpts.parse ['-s', src,'-o', @output]
+      @out = StringIO.new
+      @manf = ASDocPackage.new(opts,@out)
+    end
+
+    should "not find any files" do
+      assert_match(/No.*files found\./, @out.string)
+    end
+  end
+
+end

data/test/unit/test_asdoc_package_opts.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class ASDocPackageOptsTest < Test::Unit::TestCase
+
+  context "A AsDoc Package Tool Options Parser" do
+
+    should "return default hash if no arguments are specified" do
+      args = []
+      opts = ASDocPackageOpts.parse(args)
+
+      assert_equal 'package-asdoc.xml', opts[:output]
+      assert_equal '.', opts[:src]
+      assert_equal false, opts[:verbose]
+    end
+
+    should "display a name" do
+      assert_match(/\w+/, ASDocPackageOpts.name)
+    end
+
+    should "describe itself" do
+      assert_match(/\w+/, ASDocPackageOpts.description)
+    end
+
+  end
+
+end

data/test/unit/test_manifest.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class ManifestTest < Test::Unit::TestCase
+
+  context "A manifest builder tool" do
+
+    setup do
+      @output = '/tmp/as-manifest-tool-test.xml'
+      src  = File.expand_path(File.dirname(__FILE__)+ "/../fixtures/src")
+      opts = ManifestOpts.parse ['-s', src,'-o', @output, '--silent']
+      @manf = Manifest.new(opts)
+    end
+
+    teardown do
+      File.delete @output
+    end
+
+    should "find all actionscript and .mxml files in src tree" do
+
+      assert_equal(false, @manf.xml.empty?)
+      assert((@manf.components.length > 1))
+      assert((@manf.components.length == 5))
+
+      assert_match(/org\.helvector\.one\.HelOneTwo/, @manf.xml)
+      assert_match(/org\.helvector\.one\.HelOne/, @manf.xml)
+      assert_match(/org\.helvector\.three\.HelThree/, @manf.xml)
+      assert_match(/org\.helvector\.Helvector/, @manf.xml)
+
+    end
+
+    should "write the results to disk" do
+      assert File.exist?(@output)
+    end
+
+  end
+
+  context "A manifest builder tool invoked on a empty directory" do
+    setup do
+      @output = '/tmp/as-manifest-tool-test.xml'
+      src  = File.expand_path(File.dirname(__FILE__)+ "/../fixtures/empty")
+      opts = ManifestOpts.parse ['-s', src,'-o', @output]
+      @out = StringIO.new
+      @manf = Manifest.new(opts,@out)
+    end
+
+    should "not find any files" do
+      assert_match(/No.*files found\./, @out.string)
+    end
+  end
+
+end

data/test/unit/test_manifest_opts.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class ManifestOptTest < Test::Unit::TestCase
+
+  context "A Manifest Tool Options Parser" do
+
+    should "return default hash if no arguments are specified" do
+      args = []
+      opts = ManifestOpts.parse(args)
+
+      assert_equal 'manifest.xml', opts[:output]
+      assert_equal '.', opts[:src]
+      assert_equal false, opts[:verbose]
+    end
+
+    should "display a name" do
+      assert_match(/\w+/, ManifestOpts.name)
+    end
+
+    should "describe itself" do
+      assert_match(/\w+/, ManifestOpts.description)
+    end
+
+  end
+
+end

data/test/unit/test_search.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class SearchTest < Test::Unit::TestCase
+
+  context "A file search utility" do
+
+    setup do
+      @path = File.expand_path(File.dirname(__FILE__)+ "/../fixtures/search")
+      @found = []
+    end
+
+    should "find all files with the specified extensions" do
+
+      Search.find_all(/\.(as|mxml)$/,@path) { |f| @found << f }
+
+      assert_equal(3, @found.length)
+      assert_match(/App\.mxml/, @found.to_s)
+      assert_match(/Main\.as/, @found.to_s)
+      assert_match(/Hidden\.as/, @found.to_s)
+
+    end
+
+    should "find only find files with a specific extension" do
+
+      Search.find_all(/\.as$/,@path) { |f| @found << f }
+
+      assert_equal(2, @found.length)
+      assert_match(/Main\.as/, @found.to_s)
+      assert_match(/Hidden\.as/, @found.to_s)
+
+    end
+
+    should "not search directories specified in the exclude list" do
+
+      Search.find_all(/\.(as|mxml)$/,@path,['hide']) { |f| @found << f }
+
+      assert_equal(2, @found.length)
+      assert_match(/App\.mxml/, @found.to_s)
+      assert_match(/Main\.as/, @found.to_s)
+
+    end
+
+  end
+
+  context "A empty directory search" do
+    setup do
+      @path = File.expand_path(File.dirname(__FILE__)+ "/../fixtures/empty")
+      @found = []
+    end
+
+    should "list all directories in a sub tree that are empty" do
+      Search.for_empties(@path) { |f| @found << f }
+      assert_equal(4, @found.length)
+      assert_match(/(b|x|z)org/, @found.to_s)
+    end
+
+    should "list all directories in a sub tree that are empty but skipping specified exclusions" do
+      Search.for_empties(@path, ['org']) { |f| @found << f }
+      assert_equal(3, @found.length)
+      assert_match(/(b|x|z)org/, @found.to_s)
+    end
+
+  end
+
+end