tool-shed 0.0.5 → 0.0.7

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tool-shed
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Simon Gregory
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-25 00:00:00 +00:00
+date: 2010-11-27 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -109,36 +109,38 @@ email: tool-shed@helvector.org
 executables: 
 - as-docp
 - as-manifest
-- as-class-detector
-- as-style-detector
+- as-class-vacuum
+- as-style-vacuum
+- as-asset-vacuum
 extensions: []
 
 extra_rdoc_files: 
 - LICENSE
 - README.md
 files: 
-- bin/as-asset-detector
-- bin/as-class-detector
+- bin/as-asset-vacuum
+- bin/as-class-vacuum
 - bin/as-docp
 - bin/as-manifest
-- bin/as-style-detector
+- bin/as-style-vacuum
+- bin/as-vacuum
 - Gemfile
 - Gemfile.lock
 - lib/shed/asdoc_package.rb
+- lib/shed/asset_vacuum.rb
+- lib/shed/class_vacuum.rb
 - lib/shed/manifest.rb
 - lib/shed/opts/asdoc_package_opts.rb
+- lib/shed/opts/asset_vacuum_opts.rb
+- lib/shed/opts/class_vacuum_opts.rb
 - lib/shed/opts/manifest_opts.rb
+- lib/shed/opts/style_vacuum_opts.rb
 - lib/shed/opts/tool_opts.rb
-- lib/shed/opts/unused_asset_opts.rb
-- lib/shed/opts/unused_class_opts.rb
-- lib/shed/opts/unused_style_opts.rb
 - lib/shed/project_tools.rb
 - lib/shed/search.rb
 - lib/shed/stripper.rb
+- lib/shed/style_vacuum.rb
 - lib/shed/tool.rb
-- lib/shed/unused_asset.rb
-- lib/shed/unused_class.rb
-- lib/shed/unused_style.rb
 - lib/shed/version.rb
 - lib/tool_shed.rb
 - LICENSE
@@ -156,14 +158,26 @@ files:
 - test/fixtures/src/org/helvector/three/package.asdoc
 - test/fixtures/src/org/helvector/two/HelTwo.as
 - test/fixtures/src/org/helvector/two/package.asdoc
+- test/fixtures/unused-asset/assets/audio/referenced.mp3
+- test/fixtures/unused-asset/assets/audio/un-referenced.mp3
+- test/fixtures/unused-asset/assets/css/referenced-in-mxml.css
 - test/fixtures/unused-asset/assets/css/referenced.css
 - test/fixtures/unused-asset/assets/css/un-referenced.css
+- test/fixtures/unused-asset/assets/fonts/referenced-in-css.ttf
+- test/fixtures/unused-asset/assets/fonts/referenced-in-unused-css.ttf
 - test/fixtures/unused-asset/assets/fonts/referenced.otf
 - test/fixtures/unused-asset/assets/fonts/un-referenced.otf
+- test/fixtures/unused-asset/assets/img/referenced.gif
 - test/fixtures/unused-asset/assets/img/referenced.jpg
 - test/fixtures/unused-asset/assets/img/referenced.png
+- test/fixtures/unused-asset/assets/img/referenced.svg
+- test/fixtures/unused-asset/assets/img/un-referenced.gif
 - test/fixtures/unused-asset/assets/img/un-referenced.jpg
 - test/fixtures/unused-asset/assets/img/un-referenced.png
+- test/fixtures/unused-asset/assets/img/un-referenced.svg
+- test/fixtures/unused-asset/assets/swf/referenced-in-css.swf
+- test/fixtures/unused-asset/assets/swf/referenced.swf
+- test/fixtures/unused-asset/assets/swf/un-referenced.swf
 - test/fixtures/unused-asset/src/org/helvector/ToolBox.mxml
 - test/fixtures/unused-asset/src/org/helvector/ToolShed.as
 - test/fixtures/unused-cla/link-report.xml
@@ -178,19 +192,19 @@ files:
 - test/test_helper.rb
 - test/unit/test_asdoc_package.rb
 - test/unit/test_asdoc_package_opts.rb
+- test/unit/test_asset_vacuum.rb
+- test/unit/test_asset_vacuum_opts.rb
+- test/unit/test_class_vacuum.rb
+- test/unit/test_class_vacuum_opts.rb
 - test/unit/test_manifest.rb
 - test/unit/test_manifest_opts.rb
 - test/unit/test_search.rb
 - test/unit/test_source_tools.rb
 - test/unit/test_stripper.rb
+- test/unit/test_style_vacuum.rb
+- test/unit/test_style_vacuum_opts.rb
 - test/unit/test_tool.rb
 - test/unit/test_tool_opts.rb
-- test/unit/test_unused_asset.rb
-- test/unit/test_unused_asset_opts.rb
-- test/unit/test_unused_class.rb
-- test/unit/test_unused_class_opts.rb
-- test/unit/test_unused_style.rb
-- test/unit/test_unused_style_opts.rb
 has_rdoc: true
 homepage: http://github.com/simongregory/tool-shed
 licenses: []
@@ -198,7 +212,7 @@ licenses: []
 post_install_message: |+
   Welcome to the Tool-Shed
   ========================
-  Get Tooled Up 0.0.5. Kick off.
+  Get Tooled Up 0.0.7. Kick off.
   
   Thanks for installing, the tools are under development. Don't expect reliability.
   

data/lib/shed/opts/unused_asset_opts.rb

@@ -1,24 +0,0 @@
-# encoding: utf-8
-
-#
-# Manages the command line interface for the unused assets detection tool.
-#
-class UnusedAssetOpts < ToolOpts
-
-  def self.name
-    "as-asset-detector"
-  end
-
-  def self.description
-    "ActionScript Unused Asset Detection Tool"
-  end
-
-  def self.default_config
-    dc = superclass.default_config
-    dc[:output] = 'assets.txt'
-    dc[:manifest] = 'manifest.xml'
-    dc[:link_report] = 'link-report.xml'
-    dc
-  end
-
-end

data/lib/shed/opts/unused_style_opts.rb

@@ -1,23 +0,0 @@
-# encoding: utf-8
-
-#
-# Manages the command line interface for the unused style detection tool.
-#
-class UnusedStyleOpts < ToolOpts
-
-  def self.name
-    "as-style-detector"
-  end
-
-  def self.description
-    "ActionScript Unused Style Detection Tool"
-  end
-
-  def self.default_config
-    dc = superclass.default_config
-    dc[:output] = 'styles.txt'
-    dc[:css_dir] = 'style'
-    dc
-  end
-
-end

data/lib/shed/unused_asset.rb

@@ -1,93 +0,0 @@
-# encoding: utf-8
-
-#
-# This script scans all Actionscript classes and CSS files in a project to
-# identify assets, like PNG files, that are in the project source tree but are
-# no longer used by the application.
-#
-class UnusedAsset < Tool
-  attr_reader :assets, :src_files, :declared, :unused
-
-  def initialize(opt,out=STDOUT)
-    super(opt,out)
-
-    @project_dir = opt[:project_dir]
-    @assets = []
-    @src_files = []
-    @declared = []
-
-    unless valid_opts
-      @out.puts "#{INVALID_OPTS} One or all of specified asset and source directories does not exist."
-      return
-    end
-
-    @declared_regex = /Embed\(source='([\w.\/]+)'/
-
-    detect
-
-    #@report = describe
-
-    #to_disk(@report)
-  end
-
-  def valid_opts
-    File.exist?(@project_dir) rescue false
-  end
-
-  private
-
-  def detect
-    Search.find_all(/\.(jpg|jpeg|png|otf)$/,@project_dir,@excludes) do |path|
-      @assets << path
-    end
-
-    @declared = scan_dirs(/\.(css|as|mxml)$/, @project_dir, @declared_regex)
-
-    @unused = []
-
-    @assets.each { |a|
-      @unused << a unless is_used(a)
-    }
-  end
-
-  def is_used(file)
-    used = false
-    @declared.each { |f|
-      if File.basename(f) == File.basename(file)
-        used = true
-      end
-    }
-    used
-  end
-
-  #
-  # Scans directories for all files that match the file extension regex, and
-  # for each match goes on to scan that document for items matching the syntax
-  # regex.
-  #
-  def scan_dirs(file_ext_regex,path,syntax_regex)
-    d = []
-
-    Search.find_all(file_ext_regex,path,@excludes) do |p|
-      @src_files << p
-      d << scan_doc(p,syntax_regex)
-    end
-
-    d.flatten!.sort!.uniq! unless d.empty?
-    d
-  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)
-    n = []
-    f = File.open(path,"r").read.strip
-    f = Stripper.comments(f)
-    f.scan(regex) do |style_name|
-      n << $1
-    end
-    n
-  end
-end

data/lib/shed/unused_style.rb

@@ -1,114 +0,0 @@
-# encoding: utf-8
-
-#
-# Detects styles that are not used in a Flex application.
-#
-# This needs to be provided with a source directory to search for used styles,
-# and a directory containing css files which will be loaded and parsed for
-# style definitions.
-#
-# NOTE: This tool needs further work before it can be considerd to cover all
-#       use cases.
-#
-class UnusedStyle < Tool
-  attr_reader :report,
-              :declared,
-              :used,
-              :unused,
-              :undeclared
-
-  def initialize(opt,out=STDOUT)
-    super(opt,out)
-
-    @css_dir = opt[:css_dir]
-
-    @style_regex = /styleName\s*=\s*["']\s*\{?\s*([\w.]+)\s*\}?\s*["']/
-    @declared_regex = /^\.(\w+)/
-
-    @declared, @used, @unused, @undeclared = []
-
-    unless valid_opts
-      @out.puts "#{INVALID_OPTS} The directory specified as containging css files does not exist, or does not contain css files."
-      return
-    end
-
-    detect
-
-    @report = describe
-  end
-
-  def valid_opts
-    return false unless File.exist?(@css_dir)
-
-    found = Dir.chdir("#{@css_dir}") do |d|
-      Dir.glob('*.css')
-    end
-
-    found.length > 0
-  end
-
-  def detect
-    @declared = scan_dirs(/\.(css)/, @css_dir, @declared_regex)
-    @used = scan_dirs(/\.(as|mxml)/, @src, @style_regex)
-
-    #Find any style names used in the source which haven't been declared.
-    @undeclared = @used-@declared
-
-    #Find any style names declared in the css but not used in the src.
-    @unused = @declared-@used
-  end
-
-  private
-
-  #
-  # Returns a string detailing the findings of the style detection.
-  #
-  def describe
-    desc = "#{generated_at}"
-    desc << add_desc("declared in CSS", @declared)
-    desc << add_desc("used in MXML",@used)
-    desc << add_desc("declared but not used (in a styleName property)",@unused)
-    desc << add_desc("used but not declared",@undeclared)
-    desc
-  end
-
-  #
-  # Prints a description category.
-  #
-  def add_desc(txt,list)
-    d = "\nStyles #{txt}: #{list.length.to_s}\n"
-    d << list.join("\n") unless list.empty?
-    d
-  end
-
-  #
-  # Scans directories for all files that match the file extension regex, and
-  # for each match goes on to scan that document for items matching the syntax
-  # regex.
-  #
-  def scan_dirs(extension_regex,path,syntax_regex)
-    d = []
-
-    Search.find_all(extension_regex,path,@excludes) do |path|
-      d << scan_doc(path,syntax_regex)
-    end
-
-    d.flatten!.sort!.uniq! unless d.empty?
-    d
-  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)
-    n = []
-    f = File.open(path,"r").read.strip
-    f = Stripper.comments(f)
-    f.scan(regex) do |style_name|
-      n << $1
-    end
-    n
-  end
-
-end

data/test/unit/test_unused_asset.rb

@@ -1,69 +0,0 @@
-# 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 = { :project_dir => "#{fix}" }
-
-        @out = StringIO.new
-        @tool = UnusedAsset.new(opt,@out)
-      end
-
-      should "find all assets in the project" do
-        assert_equal(6, @tool.assets.length)
-        assert_match(/\.jpg/, @tool.assets.to_s)
-        assert_match(/\.png/, @tool.assets.to_s)
-        assert_match(/\.otf/, @tool.assets.to_s)
-      end
-
-      should "locate all src files in the project" do
-        assert_equal(4, @tool.src_files.length)
-        assert_match(/\.mxml/, @tool.src_files.to_s)
-        assert_match(/\.as/, @tool.src_files.to_s)
-        assert_match(/\.css/, @tool.src_files.to_s)
-      end
-
-      should "search all loaded src files for asset references and store them in a list" do
-        assert_equal(3, @tool.declared.length)
-        assert_match('referenced.otf', @tool.declared.to_s)
-        assert_match('referenced.jpg', @tool.declared.to_s)
-        assert_match('referenced.png', @tool.declared.to_s)
-      end
-
-      should "produce a list of assets found in the project directory which are not referenced in the project src" do
-        assert_equal(3, @tool.unused.length)
-        assert_match('un-referenced.otf', @tool.unused.to_s)
-        assert_match('un-referenced.jpg', @tool.unused.to_s)
-        assert_match('un-referenced.png', @tool.unused.to_s)
-      end
-
-      should "load the project link report and look for assets compiled into the application" do
-        #TODO
-        #flunk
-      end
-
-    end
-
-    context "with incorrect arguments" do
-      setup do
-        opt = {:project_dir => "INVALID"}
-        @out = StringIO.new
-        @tool = UnusedAsset.new(opt,@out)
-      end
-
-      should "fail with a warning message" do
-        assert_match(/#{UnusedAsset::INVALID_OPTS}/, @out.string)
-      end
-    end
-  end
-
-end

data/test/unit/test_unused_class_opts.rb

@@ -1,59 +0,0 @@
-# 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 'class-vaccum.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
-
-    should "raise an exception if mandatory arguments are missing" do
-      #TODO assert_raise(Exception) { UnusedClassOpts.parse([]) }
-    end
-
-    should "exit with a useage message if mandatory options are not specified" do
-      #TODO: This is failing as the rescue is never entered.
-      #rescued = false;
-      #begin
-      #  out = StringIO.new
-      #  args = []
-      #  opts = UnusedClassOpts.parse(args,out)
-      #rescue SystemExit => e
-      #  assert_equal 0, e.status
-      #  assert_match(/Usage/, out.string)
-      #  rescued = true
-      #end
-      #flunk() unless rescued
-    end
-
-    should "set manifest and link-report properties" do
-      args = ['-m', 'custom-manifest.xml', '-l', 'custom-link-report.xml']
-      opts = UnusedClassOpts.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_opts.rb

@@ -1,31 +0,0 @@
-# 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