tool-shed 0.0.4 → 0.0.5

data/Gemfile

@@ -1,9 +1,11 @@
 source "http://rubygems.org"
 
 gem "rake"
+gem "i18n"
 
 group :development do
   gem "shoulda"
   gem "mocha"
-  gem "rcov"
+  gem "metric_fu"
+  gem "ci_reporter"
 end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    Saikuro (1.1.0)
+    activesupport (3.0.3)
+    arrayfields (4.7.4)
+    builder (3.0.0)
+    chronic (0.2.3)
+      hoe (>= 1.2.1)
+    churn (0.0.12)
+      chronic (~> 0.2.3)
+      hirb
+      json_pure
+      main
+      ruby_parser (~> 2.0.4)
+      sexp_processor (~> 3.0.3)
+    ci_reporter (1.6.3)
+      builder (>= 2.1.2)
+    colored (1.2)
+    fattr (2.2.0)
+    flay (1.4.1)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    flog (2.5.0)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    hirb (0.3.5)
+    hoe (2.7.0)
+      rake (>= 0.8.7)
+      rubyforge (>= 2.0.4)
+    i18n (0.4.2)
+    json_pure (1.4.6)
+    main (4.3.0)
+      arrayfields (>= 4.7.4)
+      fattr (>= 2.1.0)
+    metric_fu (2.0.1)
+      Saikuro (>= 1.1.0)
+      activesupport (>= 2.0.0)
+      chronic (~> 0.2.3)
+      churn (>= 0.0.7)
+      flay (>= 1.2.1)
+      flog (>= 2.2.0)
+      rails_best_practices (>= 0.3.16)
+      rcov (>= 0.8.3.3)
+      reek (>= 1.2.6)
+      roodi (>= 2.1.0)
+    mocha (0.9.9)
+      rake
+    progressbar (0.9.0)
+    rails_best_practices (0.5.0)
+      activesupport
+      colored (~> 1.2)
+      progressbar (~> 0.9.0)
+      ruby_parser (~> 2.0.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.5)
+      sexp_processor (~> 3.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sexp_processor (3.0.5)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ci_reporter
+  i18n
+  metric_fu
+  mocha
+  rake
+  shoulda

data/README.md

@@ -1,6 +1,7 @@
-# ActionScript and Flex Project Tools
+# Tool Shed
 
-A collection of utility scripts for working with ActionScript and Flex projects.
+A collection of utility scripts to help working with ActionScript and Flex 
+projects. These scripts are under development, so **don't** expect reliability.
 
 ### as-docp
 
@@ -40,13 +41,14 @@ tree but are no longer referenced by the application.
 
 ## Using
 
-Once all the tools are ready to use examples will follow.
-
+Examples will follow once the tools are in a stable state.
+  
 ## Authors
 
 [Simon Gregory](http://simongregory.com)
 
 ## License
 
-Released under the MIT License. Please see the accompanying LICENSE document for
+Released under the MIT License. Please see the accompanying [LICENSE](LICENSE) document for
 details.
+

data/lib/shed/asdoc_package.rb

@@ -13,7 +13,7 @@ class ASDocPackage < Tool
 
     @asdoc = /\.asdoc$/
 
-    @header = "<?xml version='1.0' encoding='utf-8'?>\n<flex-config>\n\t<packages>"
+    @header = "<?xml version='1.0' encoding='utf-8'?>\n<flex-config>\n\t<packages>\n"
     @package = "\t\t<package>\n\t\t\t<string>%s</string>\n\t\t\t<string><![CDATA[%s]]></string>\n\t\t</package>\n"
     @footer = "\t</packages>\n</flex-config>"
 

data/lib/shed/manifest.rb

@@ -13,6 +13,7 @@ class Manifest < Tool
     super(opt,out)
 
     @filetypes = /\.(as|mxml)$/
+    @filter = opt[:filter] || ''
 
     build
   end
@@ -45,11 +46,21 @@ class Manifest < Tool
       found << add(p, cn) if cn =~ /^[A-Z]/
     end
 
-    found.uniq! unless found.empty?
+    found = process(found) unless found.empty?
 
     found
   end
 
+  #
+  # Proccesses the list to remove duplicates, sort alphabetically and reject any
+  # items that do not match the filter.
+  #
+  def process(list)
+    list.uniq!
+    list.sort! {|a,b| a[:xml] <=> b[:xml] }
+    list.select { |e| e[:xml].include?(@filter) }
+  end
+
   #
   # Build the manifest file and save it to disk.
   #
@@ -59,9 +70,6 @@ class Manifest < Tool
     if @components.empty?
       puts "No ActionScript or Mxml files found."
     else
-
-      @components.sort! {|a,b| a[:xml] <=> b[:xml] }
-
       @xml = create_xml(@components)
 
       #Open/Create the manifest file and write the output to it.

data/lib/shed/opts/manifest_opts.rb

@@ -5,18 +5,25 @@
 #
 class ManifestOpts < ToolOpts
 
-  def self.description
-    "ActionScript Manifest Generator Tool"
-  end
-
   def self.name
     "as-manifest"
   end
 
+  def self.description
+    "ActionScript Manifest Generator Tool"
+  end
+
   def self.default_config
     dc = superclass.default_config
     dc[:output] = "manifest.xml"
     dc
   end
 
+  def self.add_optional(op,config)
+    superclass.add_optional(op,config)
+    op.on("-f", "--filter [STRING]", String, "Package filter, in the form of 'org.helvector', to include in the generated manifest.") do |v|
+      config[:filter] = v
+    end
+  end
+
 end

data/lib/shed/opts/tool_opts.rb

@@ -19,7 +19,7 @@ class ToolOpts
   # A basic description of the tools use.
   #
   def self.description
-    'Tool'
+    'Abstract tool from the tool shed.'
   end
 
   #
@@ -68,11 +68,11 @@ class ToolOpts
       config[:src] = v
     end
 
-    op.on("-o", "--output [FILE PATH]", String, "Path to output file, defaults to #{config[:output]}") do |v|
+    op.on("-o", "--output [FILE]", String, "Path to output file, defaults to #{config[:output]}.") do |v|
       config[:output] = v
     end
 
-    op.on("-v", "--verbose", "Run verbosely") do |v|
+    op.on("-v", "--verbose", "Run verbosely.") do |v|
       config[:verbose] = v
     end
 
@@ -81,13 +81,16 @@ class ToolOpts
     end
   end
 
+  #
+  # Add tail arguments to the options parser.
+  #
   def self.add_tail(op,out)
-    op.on_tail("-h", "--help", "Show this help message") do
+    op.on_tail("-h", "--help", "Show this help message.") do
       out.puts op
       exit
     end
 
-    op.on_tail("--version", "Show version") do
+    op.on_tail("--version", "Show version.") do
       out.puts "#{description} version #{version}"
       exit
     end

data/lib/shed/opts/unused_asset_opts.rb

@@ -10,7 +10,7 @@ class UnusedAssetOpts < ToolOpts
   end
 
   def self.description
-    " ActionScript Unused Asset Detection Tool"
+    "ActionScript Unused Asset Detection Tool"
   end
 
   def self.default_config

data/lib/shed/opts/unused_class_opts.rb

@@ -15,10 +15,25 @@ class UnusedClassOpts < ToolOpts
 
   def self.default_config
     dc = superclass.default_config
-    dc[:output] = 'classes.txt'
+    dc[:output] = 'class-vaccum.txt'
     dc[:manifest] = 'manifest.xml'
     dc[:link_report] = 'link-report.xml'
     dc
   end
 
+  #
+  # Add all mandatory arguments to the options parser.
+  #
+  def self.add_mandatory(op,config)
+    superclass.add_mandatory(op,config)
+
+    op.on("-m", "--manifest FILE", "Path to the source manifest file.") do |v|
+      config[:manifest] = v
+    end
+
+    op.on("-l", "--link-report FILE", "Path to the compiler link-report file.") do |v|
+      config[:link_report] = v
+    end
+  end
+
 end

data/lib/shed/opts/unused_style_opts.rb

@@ -10,7 +10,7 @@ class UnusedStyleOpts < ToolOpts
   end
 
   def self.description
-    " ActionScript Unused Style Detection Tool"
+    "ActionScript Unused Style Detection Tool"
   end
 
   def self.default_config

data/lib/shed/search.rb

@@ -31,20 +31,21 @@ module Search
   #
   # Scans the path and its children for empty directories.
   #
-  def self.for_empties(path,excluding=[])
+  def self.for_empties(dir,excluding=['.svn','.git'])
 
-    Find.find(path) do |p|
+    Find.find(dir) do |path|
 
-      if FileTest.directory?(p)
-        if excluding.include?(File.basename(p))
+      if FileTest.directory?(path)
+        if excluding.include?(File.basename(path))
           Find.prune
         else
           # Any dir that only contains ., .., and .svn or .git are empty.
-          yield p if Dir.entries(p).join =~ /^\.\.\.(\.(svn|git))?$/
+          yield path if Dir.entries(path).join =~ /^\.\.\.(\.(svn|git))?$/
         end
       end
 
     end
 
   end
+
 end

data/lib/shed/tool.rb

@@ -1,12 +1,13 @@
 # encoding: utf-8
 
 #
-# Abstract base class for tools. Provides basic default settings, and allows
-# control over the level of logging to standard out.
+# Abstract base class for tools. Provides basic default settings, allows
+# control over the level of logging to standard out, and installs a sig int
+# handler.
 #
 class Tool
 
-  INVALID_OPTS = "Warning Invalid Options."
+  INVALID_OPTS = "Invalid options:"
 
   def initialize(opt,out=STDOUT)
     @src      = opt[:src] || '.'
@@ -15,6 +16,8 @@ class Tool
     @silent   = opt[:silent] || false
     @excludes = opt[:excludes] || ['.svn','.git']
     @out      = out
+
+    add_sigint_handler
   end
 
   #
@@ -57,4 +60,14 @@ class Tool
     "Generated at" + Time.now.strftime(" [%m/%d/%Y %H:%M:%S] ")
   end
 
+  #
+  # Installs a sigint handler.
+  #
+  def add_sigint_handler
+    trap 'INT' do
+      puts '\nCancelled. Bye Bye!'
+      exit!
+    end
+  end
+
 end

data/lib/shed/unused_asset.rb

@@ -6,46 +6,71 @@
 # no longer used by the application.
 #
 class UnusedAsset < Tool
+  attr_reader :assets, :src_files, :declared, :unused
+
   def initialize(opt,out=STDOUT)
     super(opt,out)
 
-    @link_report = opt[:link_report]
-    @manifest = opt[:manifest]
+    @project_dir = opt[:project_dir]
+    @assets = []
+    @src_files = []
+    @declared = []
 
     unless valid_opts
-      @out.puts "#{INVALID_OPTS} One or all of specified link report, manifest file, and source directories does not exist."
+      @out.puts "#{INVALID_OPTS} One or all of specified asset and source directories does not exist."
       return
     end
 
-    @declared_regex = /^TODO/
+    @declared_regex = /Embed\(source='([\w.\/]+)'/
 
     detect
 
-    @report = describe
+    #@report = describe
 
-    to_disk(@report)
+    #to_disk(@report)
   end
 
   def valid_opts
-    File.exist?(@link_report) && File.exist?(@manifest) && File.exist?(@src) rescue false
+    File.exist?(@project_dir) rescue false
   end
 
+  private
+
   def detect
-    @declared = scan_dirs(/\.(css|as|mxml)/, @src, @declared_regex)
+    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
 
-  private
+  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(extension_regex,path,syntax_regex)
+  def scan_dirs(file_ext_regex,path,syntax_regex)
     d = []
 
-    Search.find_all(extension_regex,path,@excludes) do |path|
-      d << scan_doc(path,syntax_regex)
+    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?

data/lib/shed/unused_class.rb

@@ -65,9 +65,9 @@ class UnusedClass < Tool
   # Returns a string detailing the findings of the unused class detection.
   #
   def describe
-    d = generated_at
-    d << add_desc(" classes are in the manifest but not in the link report:", @unused_classes)
-    d << add_desc(" packages appear to be empty:", @empty_packages)
+    d = "as-class-vaccum Report. #{generated_at}\n\n"
+    d << add_desc("classes are in the manifest but not in the link report:", @unused_classes)
+    d << add_desc("packages appear to be empty:", @empty_packages)
     d
   end
 
@@ -76,7 +76,7 @@ class UnusedClass < Tool
   #
   def add_desc(txt,list)
     l = list.empty? ? '' : list.join("\n")
-    "#{list.length} #{txt}\n#{l}"
+    "#{list.length} #{txt}\n#{l}\n\n"
   end
 
   #

data/lib/shed/version.rb

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

data/rakefile.rb

@@ -3,12 +3,26 @@ require 'bundler'
 
 Bundler.require
 
+require 'metric_fu'
+
 require 'rake/clean'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
+ENV['CI_REPORTS'] = 'tmp/reports' #Hide these here for now...
+require 'ci/reporter/rake/test_unit'
+
 require File.dirname(__FILE__) + '/lib/shed/version'
 
+MetricFu::Configuration.run do |config|
+  config.rcov[:test_files] = ['test/unit/**/test_*.rb']
+  config.flay ={:dirs_to_flay => ['lib'],
+                :minimum_score => 10,
+                :filetypes => ['rb'] }
+end
+
+CLEAN.add('tmp')
+
 Rake::RDocTask.new do |rdoc|
   rdoc.title = " ActionScript Tools v.#{ToolShed::VERSION::STRING}"
   rdoc.rdoc_dir = 'rdoc'
@@ -16,94 +30,16 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include("README.md", "LICENSE", "lib/**/*.rb")
 end
 
-CLEAN.add('rdoc')
-
-namespace :test do
-  Rake::TestTask.new(:units) do |test|
-    test.libs << "test"
-    test.test_files = Dir["test/unit/test_*.rb"]
-    test.verbose = true
-  end
-
-  # Thanks to Project Sprouts and Luke Bayes for the coverage, flog
-  # and flay tasks below.
-  #
-  namespace :coverage do
-    desc "Delete aggregate coverage data."
-    task(:clean) { rm_f "coverage.data" }
-  end
-
-  # Apparently, rcov does not work on Windows or Ubuntu?
-  # Hide these tasks so that we can at least
-  # run the others...
-  if(RUBY_PLATFORM =~ /darwin/i)
-    require 'rcov/rcovtask'
-
-    CLEAN.add('coverage.data')
-    CLEAN.add('coverage')
-
-    # Hold collection in case we need it:
-    #%w[unit functional integration].each do |target|
-    %w[unit].each do |target|
-      namespace :coverage do
-        Rcov::RcovTask.new(target) do |t|
-          t.libs = ["lib", "test"]
-          t.test_files = FileList["test/#{target}/**/test_*.rb"]
-          t.output_dir = "coverage/#{target}"
-          t.verbose = true
-          t.rcov_opts = ["--sort coverage",
-                         "--aggregate coverage.data",
-                         "--exclude .bundle",
-                         "--exclude .gem",
-                         "--exclude errors.rb",
-                         "--exclude progress_bar.rb"]
-        end
-      end
-      task :coverage => "test:coverage:#{target}"
-    end
-  end
-
-  namespace :torture do
-    desc "Flog the Sprouts"
-    task :flog do
-      puts "--------------------------"
-      puts "Flog Report:"
-      message =<<EOM
-According to Jake Scruggs at http://bit.ly/3QrvW a
-method average score of:
-
-Score       Means
-0-10        Awesome
-11-20       Good enough
-21-40       Might need refactoring
-41-60       Possible to justify
-61-100      Danger
-100-200     Whoop, whoop, whoop
-200 +       Someone please think of the children
-EOM
-      puts message
-      puts ""
-
-      sh "find lib -name '*.rb' | xargs flog"
-    end
-
-    desc "Flay the Sprouts"
-    task :flay do
-      puts "--------------------------"
-      puts "Flay Report:"
-      sh "flay lib/**/*.rb"
-    end
-  end
-
-  desc "Run all tortuous reports"
-  task :torture => ['torture:flog', 'torture:flay']
-
+Rake::TestTask.new(:test) do |test|
+  test.libs << "test"
+  test.test_files = Dir["test/unit/test_*.rb"]
+  test.verbose = true
 end
 
-task :test => 'test:units'
+CLEAN.add('rdoc')
 
 desc "Default"
 task :default => [:test]
 
 desc "Run all tests and reports"
-task :cruise => [:test, 'test:coverage', 'test:torture']
+task :hudson => ['ci:setup:testunit', :test, 'metrics:all']

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

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

data/test/test_helper.rb

@@ -7,3 +7,16 @@ require 'tool_shed'
 require 'bundler'
 
 Bundler.require :development
+
+#Create empty directories for the unit tests, as Git ignores empty directories.
+empties = ['test/fixtures/empty/borg',
+           'test/fixtures/empty/org',
+           'test/fixtures/empty/xorg',
+           'test/fixtures/empty/zorg',
+           'test/fixtures/unused-cla/src/org',
+           'test/fixtures/empty/sorg/.svn/sub/verted',
+           'test/fixtures/empty/gorg/.git/head']
+
+empties.each { |f|
+  `mkdir -p #{f}` unless File.exists?("#{f}")
+}

data/test/unit/test_manifest.rb

@@ -18,7 +18,6 @@ class ManifestTest < Test::Unit::TestCase
     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))
@@ -27,7 +26,6 @@ class ManifestTest < Test::Unit::TestCase
       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
@@ -50,4 +48,27 @@ class ManifestTest < Test::Unit::TestCase
     end
   end
 
+  context "A manifest builder invoked with a filter" 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, '-f', 'org.helvector.one', '--silent']
+      @manf = Manifest.new(opts)
+    end
+
+    teardown do
+      File.delete @output if File.exist?(@output)
+    end
+
+    should "only include files in the filter" do
+      assert_equal(false, @manf.xml.empty?)
+      assert((@manf.components.length > 1))
+      assert((@manf.components.length == 2))
+
+      assert_match(/org\.helvector\.one\.HelOneTwo/, @manf.xml)
+      assert_match(/org\.helvector\.one\.HelOne/, @manf.xml)
+    end
+
+  end
+
 end