tool-shed 0.0.5 → 0.0.7

data/lib/shed/tool.rb

@@ -14,7 +14,7 @@ class Tool
     @output   = opt[:output] || 'tool-shed.txt'
     @verbose  = opt[:verbose] || false
     @silent   = opt[:silent] || false
-    @excludes = opt[:excludes] || ['.svn','.git']
+    @excludes = opt[:excludes] || ['.svn','.git', 'bin', 'bin-debug']
     @out      = out
 
     add_sigint_handler
@@ -45,10 +45,10 @@ class Tool
   # Write the requested string to the output file.
   #
   def to_disk(str)
-    f = File.open(@output, "w")
-    f.puts str
-    f.flush
-    f.close
+    file = File.open(@output, "w")
+    file.puts str
+    file.flush
+    file.close
 
     puts "Saved result to #{File.expand_path(@output)}."
   end
@@ -57,7 +57,7 @@ class Tool
   # Generate a timestamp to include in reports.
   #
   def generated_at
-    "Generated at" + Time.now.strftime(" [%m/%d/%Y %H:%M:%S] ")
+    "Generated at " + Time.now.strftime("[%m/%d/%Y %H:%M:%S]")
   end
 
   #
@@ -70,4 +70,41 @@ class Tool
     end
   end
 
+  protected
+
+  #
+  # Describes a list of collected data.
+  #
+  def add_desc(heading,list)
+    description = "\n\n#{heading}: #{list.length.to_s}\n\n\t"
+    description << list.join("\n\t") unless list.empty?
+    description
+  end
+
+  #
+  # Opens the document specified by path and returns a list of all first capture
+  # group matches, after stripping comments.
+  #
+  def scan_doc(path,regex)
+    caputres = []
+    file = File.open(path,"r").read.strip
+    file = Stripper.comments(file)
+    file.scan(regex) { caputres << $1 }
+    caputres
+  end
+
+  #
+  # Scans directories for all files that match the regex, and for each match
+  # goes on to scan that document for items matching the syntax regex.
+  #
+  def scan_dirs(extension,dir,syntax_regex)
+    declarations = []
+
+    Search.find_all(extension,dir,@excludes) do |path|
+      declarations << scan_doc(path,syntax_regex)
+    end
+
+    declarations.flatten!.sort!.uniq! unless declarations.empty?
+    declarations
+  end
 end

data/lib/shed/version.rb

@@ -5,7 +5,7 @@ module ToolShed #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 5
+    TINY  = 7
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/tool_shed.rb

@@ -7,13 +7,13 @@ require 'shed/asdoc_package'
 require 'shed/manifest'
 require 'shed/opts/asdoc_package_opts'
 require 'shed/opts/manifest_opts'
-require 'shed/opts/unused_asset_opts'
-require 'shed/opts/unused_class_opts'
-require 'shed/opts/unused_style_opts'
+require 'shed/opts/asset_vacuum_opts'
+require 'shed/opts/class_vacuum_opts'
+require 'shed/opts/style_vacuum_opts'
 require 'shed/project_tools'
 require 'shed/search'
 require 'shed/stripper'
-require 'shed/unused_asset'
-require 'shed/unused_class'
-require 'shed/unused_style'
+require 'shed/asset_vacuum'
+require 'shed/class_vacuum'
+require 'shed/style_vacuum'
 require 'shed/version'

data/test/fixtures/unused-asset/assets/css/referenced.css

@@ -0,0 +1,12 @@
+
+@font-face {  		
+	src		  		: url("/../assets/fonts/referenced-in-css.ttf");
+	fontFamily		: Phwack;
+	fontWeight		: Semibold;
+	unicode-range	: "Basic Latin";
+}
+
+Thwacker
+{
+	thwackSkin : Embed(source="/../assets/swf/referenced-in-css.swf", symbol="ThwackerDisabledSkin");
+}

data/test/fixtures/unused-asset/assets/css/un-referenced.css

@@ -0,0 +1,7 @@
+
+@font-face {  		
+	src		  		: url("/../assets/fonts/referenced-in-unused-css.ttf");
+	fontFamily		: Phwack;
+	fontWeight		: Semibold;
+	unicode-range	: "Basic Latin";
+}

data/test/fixtures/unused-asset/src/org/helvector/ToolBox.mxml

@@ -1,4 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <mx:Canvas xmlns:mx="http://www.adobe.com/2006/mxml">
+    
+    <mx:Style source="/../assets/css/referenced-in-mxml.css"/>
+    
+    <mx:Image source="@Embed('/../assets/img/referenced.gif')"/>
+    <mx:Image source='@Embed("/../assets/img/referenced.svg")'/>
 	
 </mx:Canvas>

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

@@ -21,9 +21,14 @@ public class ToolShed extends Object
     [Embed(source='/../assets/img/referenced.jpg')]
     private var jpgEg:Class;
 
-    [Embed(source='/../assets/img/referenced.png')]
-    private var pngEG:Class
+    [Embed(source="/../assets/img/referenced.png")]
+    private var pngEG:Class;
 
+    [Embed(source='/../assets/swf/referenced.swf')]
+    private var swfEG:Class;
+
+    [Embed(source='/../assets/audio/referenced.mp3')]
+    private var mp3Eg:Class;
 
 }
 

data/test/unit/test_asdoc_package_opts.rb

@@ -10,7 +10,7 @@ class ASDocPackageOptsTest < Test::Unit::TestCase
       args = []
       opts = ASDocPackageOpts.parse(args)
 
-      assert_equal 'package-asdoc.xml', opts[:output]
+      assert_equal 'asdoc-package-config.xml', opts[:output]
       assert_equal '.', opts[:src]
       assert_equal false, opts[:verbose]
     end

data/test/unit/test_asset_vacuum.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class TestAssetVacuum < Test::Unit::TestCase
+
+  def fix
+    File.expand_path(File.dirname(__FILE__)+ "/../fixtures/unused-asset")
+  end
+
+  context "A asset vacuum tool" do
+
+    context "with correct arguments" do
+      setup do
+        opt = { :src => "#{fix}",
+                :output => "/tmp/as-asset-vacuum.txt" }
+
+        @out = StringIO.new
+        @tool = AssetVacuum.new(opt,@out)
+      end
+
+      should "find all assets in the project" do
+        assert_match(/\.gif/, @tool.assets.to_s)
+        assert_match(/\.jpg/, @tool.assets.to_s)
+        assert_match(/\.mp3/, @tool.assets.to_s)
+        assert_match(/\.otf/, @tool.assets.to_s)
+        assert_match(/\.png/, @tool.assets.to_s)
+        assert_match(/\.svg/, @tool.assets.to_s)
+        assert_match(/\.swf/, @tool.assets.to_s)
+        assert_match(/\.ttf/, @tool.assets.to_s)
+        assert_equal(17, @tool.assets.length)
+      end
+
+      should "search all loaded src files for asset references and store them in a list" do
+        assert_match('referenced.gif', @tool.declared.to_s)
+        assert_match('referenced.jpg', @tool.declared.to_s)
+        assert_match('referenced.mp3', @tool.declared.to_s)
+        assert_match('referenced.otf', @tool.declared.to_s)
+        assert_match('referenced.png', @tool.declared.to_s)
+        assert_match('referenced.svg', @tool.declared.to_s)
+        assert_match('referenced.swf', @tool.declared.to_s)
+        assert_match('referenced-in-css.swf', @tool.declared.to_s)
+        assert_match('referenced-in-css.ttf', @tool.declared.to_s)
+        assert_match('referenced-in-unused-css.ttf', @tool.declared.to_s)
+        assert_equal(10, @tool.declared.length)
+      end
+
+      should "produce a list of assets found in the project directory which are not referenced in the project src" do
+        assert_match('un-referenced.jpg', @tool.unused.to_s)
+        assert_match('un-referenced.gif', @tool.unused.to_s)
+        assert_match('un-referenced.mp3', @tool.unused.to_s)
+        assert_match('un-referenced.otf', @tool.unused.to_s)
+        assert_match('un-referenced.png', @tool.unused.to_s)
+        assert_match('un-referenced.svg', @tool.unused.to_s)
+        assert_match('un-referenced.swf', @tool.unused.to_s)
+        assert_equal(7, @tool.unused.length)
+      end
+
+      should "only search css files referenced in as/mxml for asset references" do
+        #Tecnically yes. Sounds like a pain in the ass to me though.
+      end
+    end
+
+    context "with incorrect arguments" do
+      setup do
+        opt = {:src => "INVALID", :output => "/tmp/as-asset-vacuum.txt"}
+        @out = StringIO.new
+        @tool = AssetVacuum.new(opt,@out)
+      end
+
+      should "fail with a warning message" do
+        assert_match(/#{AssetVacuum::INVALID_OPTS}/, @out.string)
+      end
+    end
+  end
+
+end

data/test/unit/{test_unused_asset_opts.rb → test_asset_vacuum_opts.rb}

@@ -2,29 +2,27 @@
 
 require File.join(File.dirname(__FILE__), "/../test_helper")
 
-class UnusedAssetOptsTest < Test::Unit::TestCase
+class TestAssetVacuumOpts < Test::Unit::TestCase
 
-  context "A Unused Asset Tool Options Parser" do
+  context "An Asset Vacuum Tool Options Parser" do
 
     should "return default hash if no arguments are specified" do
 
       args = []
-      opts = UnusedAssetOpts.parse(args)
+      opts = AssetVacuumOpts.parse(args)
 
       assert_equal 'assets.txt', opts[:output]
-      assert_equal 'manifest.xml', opts[:manifest]
-      assert_equal 'link-report.xml', opts[:link_report]
       assert_equal '.', opts[:src]
       assert_equal false, opts[:verbose]
 
     end
 
     should "display a name" do
-      assert_match(/\w+/, UnusedAssetOpts.name)
+      assert_match(/\w+/, AssetVacuumOpts.name)
     end
 
     should "describe itself" do
-      assert_match(/\w+/, UnusedAssetOpts.description)
+      assert_match(/\w+/, AssetVacuumOpts.description)
     end
 
   end

data/test/unit/{test_unused_class.rb → test_class_vacuum.rb}

@@ -2,9 +2,9 @@
 
 require File.join(File.dirname(__FILE__), "/../test_helper")
 
-class TestUnusedClass < Test::Unit::TestCase
+class TestClassVacuum < Test::Unit::TestCase
 
-  context "A unused class detector" do
+  context "A class vacuum tool" do
 
     context "with correct arguments" do
       setup do
@@ -12,10 +12,10 @@ class TestUnusedClass < Test::Unit::TestCase
         opt = { :src => "#{fix}/src",
                 :manifest => "#{fix}/manifest.xml",
                 :link_report => "#{fix}/link-report.xml",
-                :output => '/tmp/hel-unused-class-tool.txt' }
+                :output => '/tmp/as-class-vacuum.txt' }
 
         @out = StringIO.new
-        @tool = UnusedClass.new(opt,@out)
+        @tool = ClassVacuum.new(opt,@out)
       end
 
       should "find unused classes" do
@@ -35,13 +35,13 @@ class TestUnusedClass < Test::Unit::TestCase
 
     context "with incorrect arguments" do
       setup do
-        opt = {:manifest => "INVALID", :output => '/tmp/unused-class-tool.txt'}
+        opt = {:manifest => "INVALID", :output => '/tmp/as-class-vacuum.txt'}
         @out = StringIO.new
-        @tool = UnusedClass.new(opt,@out)
+        @tool = ClassVacuum.new(opt,@out)
       end
 
       should "fail with a warning message" do
-        assert_match(/#{UnusedClass::INVALID_OPTS}/, @out.string)
+        assert_match(/#{ClassVacuum::INVALID_OPTS}/, @out.string)
       end
     end
 

data/test/unit/test_class_vacuum_opts.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class TestClassVacuumOpts < Test::Unit::TestCase
+
+  context "A Class Vacuum Tool Options Parser" do
+
+    should "return default hash if no arguments are specified" do
+      args = []
+      opts = ClassVacuumOpts.parse(args)
+
+      assert_equal 'class-vacuum.txt', opts[:output]
+      assert_equal 'manifest.xml', opts[:manifest]
+      assert_equal 'link-report.xml', opts[:link_report]
+      assert_equal '.', opts[:src]
+      assert_equal false, opts[:verbose]
+    end
+
+    should "display a name" do
+      assert_match(/\w+/, ClassVacuumOpts.name)
+    end
+
+    should "describe itself" do
+      assert_match(/\w+/, ClassVacuumOpts.description)
+    end
+
+    should "raise an exception if mandatory arguments are missing" do
+      assert_raise(OptionParser::MissingArgument) { ClassVacuumOpts.parse(['-m']) }
+      assert_raise(OptionParser::MissingArgument) { ClassVacuumOpts.parse(['--manifest']) }
+      assert_raise(OptionParser::MissingArgument) { ClassVacuumOpts.parse(['-l']) }
+      assert_raise(OptionParser::MissingArgument) { ClassVacuumOpts.parse(['--link-report']) }
+    end
+
+    should "raise an exception if incorrect arguments are specified" do
+      assert_raise(OptionParser::InvalidOption) { ClassVacuumOpts.parse(['-z']) }
+      assert_raise(OptionParser::InvalidOption) { ClassVacuumOpts.parse(['--kapow']) }
+      assert_raise(OptionParser::InvalidOption) { ClassVacuumOpts.parse(['--shlock']) }
+    end
+
+    should "set manifest and link-report properties" do
+      args = ['-m', 'custom-manifest.xml', '-l', 'custom-link-report.xml']
+      opts = ClassVacuumOpts.parse(args)
+
+      assert_equal 'custom-manifest.xml', opts[:manifest]
+      assert_equal 'custom-link-report.xml', opts[:link_report]
+    end
+
+  end
+
+end

data/test/unit/{test_unused_style.rb → test_style_vacuum.rb}

@@ -2,21 +2,22 @@
 
 require File.join(File.dirname(__FILE__), "/../test_helper")
 
-class TestUnusedStyle < Test::Unit::TestCase
+class TestStyleVacuum < Test::Unit::TestCase
 
   def fix
     File.expand_path(File.dirname(__FILE__)+ "/../fixtures/unused-css")
   end
 
-  context "A  unused style detector" do
+  context "A style vacuum tool" do
 
     context "with correct arguments" do
       setup do
         opt = { :src => "#{fix}/src",
-                :css_dir => "#{fix}/css" }
+                :css_dir => "#{fix}/css",
+                :output => '/tmp/as-style-vacuum.txt' }
 
         @out = StringIO.new
-        @tool = UnusedStyle.new(opt,@out)
+        @tool = StyleVacuum.new(opt,@out)
       end
 
       should "find declared styles" do
@@ -36,14 +37,15 @@ class TestUnusedStyle < Test::Unit::TestCase
     context "with incorrect arguments" do
       setup do
         opt = { :src => "#{fix}/src",
-                :css_dir => "#{fix}/src" }
+                :css_dir => "#{fix}/src",
+                :output => '/tmp/as-style-vacuum.txt' }
 
         @out = StringIO.new
-        @tool = UnusedStyle.new(opt,@out)
+        @tool = StyleVacuum.new(opt,@out)
       end
 
       should "fail with a warning message" do
-        assert_match(/#{UnusedStyle::INVALID_OPTS}/, @out.string)
+        assert_match(/#{StyleVacuum::INVALID_OPTS}/, @out.string)
         assert_equal(false, @tool.valid_opts)
       end
     end
@@ -51,9 +53,11 @@ class TestUnusedStyle < Test::Unit::TestCase
     context "when given a css directory containing more than one css" do
       setup do
         opt = { :src => "#{fix}/src",
-                :css_dir => "#{fix}/css-multiple" }
+                :css_dir => "#{fix}/css-multiple",
+                :output => '/tmp/as-style-vacuum.txt' }
 
-        @tool = UnusedStyle.new(opt)
+        @out = StringIO.new
+        @tool = StyleVacuum.new(opt,@out)
       end
 
       should "find declared styles" do
@@ -63,15 +67,16 @@ class TestUnusedStyle < Test::Unit::TestCase
       should "find unused styles" do
         assert @tool.unused.length == 3
       end
-
     end
 
     context "when searching css files for style definitions" do
       setup do
         opt = { :src => "#{fix}/src",
-                :css_dir => "#{fix}/css-with-comments" }
+                :css_dir => "#{fix}/css-with-comments",
+                :output => '/tmp/as-style-vacuum.txt' }
 
-        @tool = UnusedStyle.new(opt)
+        @out = StringIO.new
+        @tool = StyleVacuum.new(opt,@out)
       end
 
       should "find basic declarations" do
@@ -87,15 +92,16 @@ class TestUnusedStyle < Test::Unit::TestCase
     context "when searching mxml documents for style useage" do
       setup do
         opt = { :src => "#{fix}/src",
-                :css_dir => "#{fix}/css" }
+                :css_dir => "#{fix}/css",
+                :output => '/tmp/as-style-vacuum.txt' }
 
-        @tool = UnusedStyle.new(opt)
+        @out = StringIO.new
+        @tool = StyleVacuum.new(opt,@out)
       end
 
       should "find all values of syleName attributes" do
         assert @tool.used.length == 2
       end
-
     end
 
   end

data/test/unit/test_style_vacuum_opts.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class TestStyleVacuumOpts < Test::Unit::TestCase
+
+  context "A Style Vacuum Tool Options Parser" do
+
+    should "return default hash if no arguments are specified" do
+      args = []
+      opts = StyleVacuumOpts.parse(args)
+
+      assert_equal 'styles.txt', opts[:output]
+      assert_equal 'style', opts[:css_dir]
+      assert_equal '.', opts[:src]
+      assert_equal false, opts[:verbose]
+    end
+
+    should "display a name" do
+      assert_match(/\w+/, StyleVacuumOpts.name)
+    end
+
+    should "describe itself" do
+      assert_match(/\w+/, StyleVacuumOpts.description)
+    end
+
+    should "raise an exception if mandatory arguments are missing" do
+      assert_raise(OptionParser::MissingArgument) { StyleVacuumOpts.parse(['--css']) }
+    end
+
+    should "raise an exception if incorrect arguments are specified" do
+      assert_raise(OptionParser::InvalidOption) { StyleVacuumOpts.parse(['--ccs']) }
+      assert_raise(OptionParser::InvalidOption) { StyleVacuumOpts.parse(['--zaaap']) }
+      assert_raise(OptionParser::InvalidOption) { StyleVacuumOpts.parse(['--vrrooom']) }
+    end
+
+    should "set manifest and link-report properties" do
+      args = ['--css', 'custom/ccs/directory']
+      opts = StyleVacuumOpts.parse(args)
+
+      assert_equal 'custom/ccs/directory', opts[:css_dir]
+    end
+
+  end
+
+end