tool-shed 0.0.4

data/test/unit/test_source_tools.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class ProjectToolsTest < Test::Unit::TestCase
+
+  context "Utility source tools" do
+
+    should "truncate file paths to their source directory" do
+
+      p = 'a/b/src/com'
+      assert_equal('com', ProjectTools.truncate_to_src(p))
+
+      p = '/a/b/source/c/src/test/org/helvector/io'
+      assert_equal('org/helvector/io', ProjectTools.truncate_to_src(p))
+
+      p = '/a/b/source/org/helvector/io'
+      assert_equal('org/helvector/io', ProjectTools.truncate_to_src(p))
+
+      p = '/a/b/source/lib/tools/src/org/helvector/io'
+      assert_equal('org/helvector/io', ProjectTools.truncate_to_src(p))
+
+    end
+
+    should "convert an absolute file path to a package declaration" do
+
+      p = '/a/b/source/org/helvector/io'
+      assert_equal('org.helvector.io', ProjectTools.package(p))
+
+      p = '/a/b/source/c/src/test/org/helvector/io'
+      assert_equal('org.helvector.io', ProjectTools.package(p))
+
+      p = '/a/b/c/test/org/helvector/io/Vector.as'
+      assert_equal('org.helvector.io', ProjectTools.package(p))
+
+    end
+
+    should "convert a relative file path to a package declaration" do
+
+      p = 'a/b/src/com'
+      assert_equal('com', ProjectTools.package(p))
+
+      p = 'a/b/source/lib/tools/src/org/helvector/io'
+      assert_equal('org.helvector.io', ProjectTools.package(p))
+
+      p = 'a/b/source/lib/tools/src/org/helvector/io/Test.as'
+      assert_equal('org.helvector.io', ProjectTools.package(p))
+
+      p = 'a/b/source/lib/tools/src/org/helvector/io/Test.mxml'
+      assert_equal('org.helvector.io', ProjectTools.package(p))
+
+      p = './org/helvector/io/Test.mxml'
+      assert_equal('org.helvector.io', ProjectTools.package(p))
+
+      p = '../../org/helvector/io/Test.mxml'
+      assert_equal('org.helvector.io', ProjectTools.package(p))
+
+      p = 'org/helvector/io/Test.mxml'
+      assert_equal('org.helvector.io', ProjectTools.package(p))
+
+    end
+
+    should "convert an absolute file path to an import declaration" do
+
+      p = '/a/b/source/c/src/test/org/helvector/io/Foo.mxml'
+      assert_equal('org.helvector.io.Foo', ProjectTools.import(p))
+
+      p = '/a/b/source/org/helvector/io/Bar.as'
+      assert_equal('org.helvector.io.Bar', ProjectTools.import(p))
+
+      p = '/a/b/source/lib/tools/src/org/helvector/io'
+      assert_equal('org.helvector.io', ProjectTools.import(p))
+
+    end
+
+    should "convert a relative file path to an import declaration" do
+
+      p = 'a/b/src/com/Hello.as'
+      assert_equal('com.Hello', ProjectTools.import(p))
+
+      p = 'a/b/source/lib/tools/src/org/helvector/io/Test.as'
+      assert_equal('org.helvector.io.Test', ProjectTools.import(p))
+
+      p = 'a/b/source/lib/tools/src/org/helvector/io/Test.mxml'
+      assert_equal('org.helvector.io.Test', ProjectTools.import(p))
+
+      p = './a/b/source/lib/tools/src/org/helvector/io/Test.mxml'
+      assert_equal('org.helvector.io.Test', ProjectTools.import(p))
+
+      p = './../../a/b/source/lib/tools/src/org/helvector/io/Test.mxml'
+      assert_equal('org.helvector.io.Test', ProjectTools.import(p))
+
+    end
+
+  end
+
+end

data/test/unit/test_stripper.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class StripperTest < Test::Unit::TestCase
+
+  context "Comment stripper" do
+
+    should "remove single line xml comments from a string" do
+
+      s = "<!--single-line-->"
+      s = Stripper.xml_comments(s)
+
+      assert s.empty?
+
+    end
+
+    should "remove multi line xml comments from a string" do
+
+      s = "\n\n<!--\nmulti-line\n-->\n"
+      s = Stripper.xml_comments(s)
+
+      assert_equal(s, "\n\n\n")
+
+    end
+
+    should "remove single line ecma script comments" do
+
+      s = "//single-line"
+      s = Stripper.ecma_comments(s)
+
+      assert s.empty?
+
+    end
+
+    should "remove multi line ecma script comments" do
+
+      s = "\n\n/*\nmulti-line\n*/\n"
+      s = Stripper.ecma_comments(s)
+
+      assert_equal(s, "\n\n\n")
+
+    end
+
+    should "remove multi and single line ecma script and xml comments" do
+
+      s = "\n/*\nmulti-line\n*/\n<!--single-line-->\n//single-line\n<!--\nmulti-line\n-->\n"
+      s = Stripper.comments(s)
+
+      assert_equal(s, "\n\n\n\n\n")
+
+    end
+
+  end
+
+end

data/test/unit/test_tool.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class ToolTest < Test::Unit::TestCase
+
+  context "A default tool-shed" do
+
+    setup do
+      @out = StringIO.new
+      @tool = Tool.new({:output => '/tmp/tool-shed.txt'},@out)
+    end
+
+    should "puts messages" do
+      @tool.puts 'hello'
+      assert_equal("hello\n", @out.string)
+    end
+
+    should "not log messages" do
+      @tool.log 'hello'
+      assert_equal('', @out.string)
+    end
+
+    should "have valid options" do
+      assert @tool.valid_opts
+    end
+
+    should "provide a 'generated at' time stamp" do
+      assert_match(/Generated at/, @tool.generated_at)
+      assert_match(/\d\d:\d\d:\d\d/, @tool.generated_at)
+    end
+
+  end
+
+  context "A silent tool-shed" do
+
+    setup do
+      @out = StringIO.new
+      @tool = Tool.new({:silent => true, :output => '/tmp/tool-shed.txt'}, @out)
+    end
+
+    should "not puts messages" do
+      @tool.puts 'hello'
+      assert @out.string.empty?
+    end
+
+    should "not log messages" do
+      @tool.log 'hello'
+      assert @out.string.empty?
+    end
+
+  end
+
+  context "A verbose tool-shed" do
+    setup do
+      @out = StringIO.new
+      @tool = Tool.new({:verbose => true, :output => '/tmp/tool-shed.txt'}, @out)
+    end
+
+    should "puts messages" do
+      @tool.puts 'hello'
+      assert_equal("hello\n", @out.string)
+    end
+
+    should "not log messages" do
+      @tool.log 'hello'
+      assert_equal("hello\n", @out.string)
+    end
+
+  end
+
+end
+

data/test/unit/test_tool_opts.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class ToolOptsTest < Test::Unit::TestCase
+
+  context "A  Tool Options Parser" do
+
+    should "return default hash if no arguments are specified" do
+
+      args = []
+      opts = ToolOpts.parse(args)
+
+      assert_equal 'output.xml', opts[:output]
+      assert_equal '.', opts[:src]
+      assert_equal false, opts[:verbose]
+
+    end
+
+    should "define verbose mode when -v is set" do
+
+      args = ['-v']
+      opts = ToolOpts.parse(args)
+
+      assert opts[:verbose]
+
+    end
+
+    should "set source when -s or --source is specified" do
+
+      path = '/dummy/path'
+      args = ['-s', path]
+      opts = ToolOpts.parse(args)
+
+      assert_equal path, opts[:src]
+
+      args = ['--source', path]
+      opts = ToolOpts.parse(args)
+
+      assert_equal path, opts[:src]
+
+    end
+
+    should "display a help message" do
+      begin
+        out = StringIO.new
+        args = ['-h']
+        opts = ToolOpts.parse(args,out)
+      rescue SystemExit => e
+        assert_equal 0, e.status
+        assert_match(/Usage/, out.string)
+      end
+    end
+
+    should "display version information" do
+      begin
+        out = StringIO.new
+        args = ['--version']
+        opts = ToolOpts.parse(args,out)
+      rescue SystemExit => e
+        assert_equal 0, e.status
+        assert_match(/version/, out.string)
+        assert_match(/\d/, out.string)
+      end
+    end
+
+    should "display a name" do
+      assert_match(/\w+/, ToolOpts.name)
+    end
+
+    should "describe itself" do
+      assert_match(/\w+/, ToolOpts.description)
+    end
+
+    should "show a version number" do
+      assert_match(/\d+/, ToolOpts.version)
+    end
+
+  end
+
+end

data/test/unit/test_unused_asset.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class TestUnusedAsset < Test::Unit::TestCase
+
+  def fix
+    File.expand_path(File.dirname(__FILE__)+ "/../fixtures/unused-asset")
+  end
+
+  context "A unused asset detector" do
+
+    context "with correct arguments" do
+      setup do
+        opt = { :src => "#{fix}/src",
+                :css_dir => "#{fix}/assets" }
+
+        @out = StringIO.new
+        @tool = UnusedAsset.new(opt,@out)
+      end
+
+      should "find all assets in the project" do
+        #store list
+      end
+
+      should "load all src files in the project" do
+        #css
+        #mxml
+        #as
+      end
+
+      should "search all loaded src files for asset references and store them in a list" do
+        #store list
+      end
+
+      should "produce a list of assets found in the project which are not referenced in the project src" do
+        #print list..
+      end
+
+      should "load the project link report and look for assets compiled into the application" do
+
+      end
+
+    end
+
+    context "with incorrect arguments" do
+      setup do
+        opt = {:manifest => "INVALID", :output => '/tmp/unused-asset-tool.txt'}
+        @out = StringIO.new
+        @tool = UnusedClass.new(opt,@out)
+      end
+
+      should "fail with a warning message" do
+        assert_match(/#{UnusedClass::INVALID_OPTS}/, @out.string)
+      end
+    end
+  end
+
+end

data/test/unit/test_unused_asset_opts.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class UnusedAssetOptsTest < Test::Unit::TestCase
+
+  context "A Unused Asset Tool Options Parser" do
+
+    should "return default hash if no arguments are specified" do
+
+      args = []
+      opts = UnusedAssetOpts.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)
+    end
+
+    should "describe itself" do
+      assert_match(/\w+/, UnusedAssetOpts.description)
+    end
+
+  end
+
+end

data/test/unit/test_unused_class.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class TestUnusedClass < Test::Unit::TestCase
+
+  context "A unused class detector" do
+
+    context "with correct arguments" do
+      setup do
+        fix = File.expand_path(File.dirname(__FILE__)+ "/../fixtures/unused-cla")
+        opt = { :src => "#{fix}/src",
+                :manifest => "#{fix}/manifest.xml",
+                :link_report => "#{fix}/link-report.xml",
+                :output => '/tmp/hel-unused-class-tool.txt' }
+
+        @out = StringIO.new
+        @tool = UnusedClass.new(opt,@out)
+      end
+
+      should "find unused classes" do
+        assert @tool.unused_classes.length == 1
+        assert @tool.unused_classes[0] == 'UnusedClass'
+      end
+
+      should "find empty packages" do
+        assert @tool.empty_packages.length > 0
+        assert_equal('org/helvector', @tool.empty_packages[0])
+      end
+
+      should "have valid options" do
+        assert @tool.valid_opts
+      end
+    end
+
+    context "with incorrect arguments" do
+      setup do
+        opt = {:manifest => "INVALID", :output => '/tmp/unused-class-tool.txt'}
+        @out = StringIO.new
+        @tool = UnusedClass.new(opt,@out)
+      end
+
+      should "fail with a warning message" do
+        assert_match(/#{UnusedClass::INVALID_OPTS}/, @out.string)
+      end
+    end
+
+  end
+
+end

data/test/unit/test_unused_class_opts.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class UnusedClassOptsTest < Test::Unit::TestCase
+
+  context "A Unused Class Tool Options Parser" do
+
+    should "return default hash if no arguments are specified" do
+
+      args = []
+      opts = UnusedClassOpts.parse(args)
+
+      assert_equal 'classes.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+/, UnusedClassOpts.name)
+    end
+
+    should "describe itself" do
+      assert_match(/\w+/, UnusedClassOpts.description)
+    end
+
+  end
+
+end

data/test/unit/test_unused_style.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class TestUnusedStyle < Test::Unit::TestCase
+
+  def fix
+    File.expand_path(File.dirname(__FILE__)+ "/../fixtures/unused-css")
+  end
+
+  context "A  unused style detector" do
+
+    context "with correct arguments" do
+      setup do
+        opt = { :src => "#{fix}/src",
+                :css_dir => "#{fix}/css" }
+
+        @out = StringIO.new
+        @tool = UnusedStyle.new(opt,@out)
+      end
+
+      should "find declared styles" do
+        assert @tool.declared.length == 2
+      end
+
+      should "find unused styles" do
+        assert @tool.unused.length == 1
+      end
+
+      should "have valid options" do
+        assert_not_equal("The required options were not specified\n", @out.string)
+        assert @tool.valid_opts
+      end
+    end
+
+    context "with incorrect arguments" do
+      setup do
+        opt = { :src => "#{fix}/src",
+                :css_dir => "#{fix}/src" }
+
+        @out = StringIO.new
+        @tool = UnusedStyle.new(opt,@out)
+      end
+
+      should "fail with a warning message" do
+        assert_match(/#{UnusedStyle::INVALID_OPTS}/, @out.string)
+        assert_equal(false, @tool.valid_opts)
+      end
+    end
+
+    context "when given a css directory containing more than one css" do
+      setup do
+        opt = { :src => "#{fix}/src",
+                :css_dir => "#{fix}/css-multiple" }
+
+        @tool = UnusedStyle.new(opt)
+      end
+
+      should "find declared styles" do
+        assert @tool.declared.length == 4
+      end
+
+      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" }
+
+        @tool = UnusedStyle.new(opt)
+      end
+
+      should "find basic declarations" do
+        assert @tool.declared.include? 'moreUsedStyle'
+        assert @tool.declared.include? 'moreUnUsedStyle'
+      end
+
+      should "ignore declarations that are commented out" do
+        assert_equal(false, @tool.declared.include?('aCommentedOutStyle'))
+      end
+    end
+
+    context "when searching mxml documents for style useage" do
+      setup do
+        opt = { :src => "#{fix}/src",
+                :css_dir => "#{fix}/css" }
+
+        @tool = UnusedStyle.new(opt)
+      end
+
+      should "find all values of syleName attributes" do
+        assert @tool.used.length == 2
+      end
+
+    end
+
+  end
+
+end

data/test/unit/test_unused_style_opts.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class UnusedStyleOptsTest < Test::Unit::TestCase
+
+  context "A Unused Style Tool Options Parser" do
+
+    should "return default hash if no arguments are specified" do
+
+      args = []
+      opts = UnusedStyleOpts.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+/, UnusedStyleOpts.name)
+    end
+
+    should "describe itself" do
+      assert_match(/\w+/, UnusedStyleOpts.description)
+    end
+
+  end
+
+end

data/tool-shed.gemspec

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+lib = File.expand_path File.join(File.dirname(__FILE__), 'lib')
+$:.unshift lib unless $:.include?(lib)
+
+require 'bundler'
+require 'rake'
+require 'tool_shed'
+
+#
+# For gem spec reference see:
+# http://docs.rubygems.org/read/chapter/20#rubyforge_project
+#
+Gem::Specification.new do |s|
+  s.name                      = ToolShed::NAME
+  s.version                   = ToolShed::VERSION::STRING
+  s.platform                  = Gem::Platform::RUBY
+  s.authors                   = ["Simon Gregory"]
+  s.email                     = "tool-shed@helvector.org"
+  s.homepage                  = "http://github.com/simongregory/tool-shed"
+  s.summary                   = "ActionScript and Flex Project Tools"
+  s.description               = <<EOF
+Utility scripts for working with ActionScript and Flex projects.
+EOF
+  s.has_rdoc                  = true
+  s.rdoc_options              = ["--charset=UTF-8"]
+  s.extra_rdoc_files          = ['LICENSE', 'README.md']
+  s.required_rubygems_version = ">= 1.3.6"
+  s.require_path              = ['lib']
+  s.files                     = FileList['**/**/*'].exclude /.git|.svn|.DS_Store|.tmproj/
+  s.test_files                = Dir["test/*_test.rb"]
+  s.executables               = ['as-docp', 'as-manifest', 'as-class-detector', 'as-style-detector']
+  s.post_install_message      = <<EOF
+Welcome to the Tool-Shed
+========================
+Get Tooled Up #{ToolShed::VERSION::STRING}. Kick off.
+
+EOF
+  s.add_bundler_dependencies
+
+end