tool-shed 0.0.4

data/lib/shed/unused_style.rb

@@ -0,0 +1,114 @@
+# 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/lib/shed/version.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module ToolShed #:nodoc:
+  NAME = 'tool-shed'
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 4
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/tool_shed.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'shed/tool'
+require 'shed/opts/tool_opts'
+
+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/project_tools'
+require 'shed/search'
+require 'shed/stripper'
+require 'shed/unused_asset'
+require 'shed/unused_class'
+require 'shed/unused_style'
+require 'shed/version'

data/rakefile.rb

@@ -0,0 +1,109 @@
+
+require 'bundler'
+
+Bundler.require
+
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require File.dirname(__FILE__) + '/lib/shed/version'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.title = " ActionScript Tools v.#{ToolShed::VERSION::STRING}"
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.main = "ToolShed::ToolShed"
+  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']
+
+end
+
+task :test => 'test:units'
+
+desc "Default"
+task :default => [:test]
+
+desc "Run all tests and reports"
+task :cruise => [:test, 'test:coverage', 'test:torture']

data/rdoc/classes/ASDocPackage.html

@@ -0,0 +1,281 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: ASDocPackage</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">ASDocPackage</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/hel/asdoc_package_rb.html">
+                lib/hel/asdoc_package.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="Tool.html">
+                Tool
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Reads &#8217;.asdoc&#8217; files from a specified source tree and
+concatencates them into a xml configuration file that can be used to
+generate ActionScript documentation for the Actionscript packages.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000008">build</a>&nbsp;&nbsp;
+      <a href="#M000009">create_xml</a>&nbsp;&nbsp;
+      <a href="#M000006">new</a>&nbsp;&nbsp;
+      <a href="#M000007">scan</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">xml</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+
+        <div class="method-heading">
+          <a href="#M000006" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(opt,out=STDOUT)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000006-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/hel/asdoc_package.rb, line 11</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">opt</span>,<span class="ruby-identifier">out</span>=<span class="ruby-constant">STDOUT</span>)
+    <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">opt</span>,<span class="ruby-identifier">out</span>)
+
+    <span class="ruby-ivar">@asdoc</span> = <span class="ruby-regexp re">/\.asdoc$/</span>
+
+    <span class="ruby-ivar">@header</span> = <span class="ruby-value str">&quot;&lt;?xml version='1.0' encoding='utf-8'?&gt;\n&lt;flex-config&gt;\n\t&lt;packages&gt;&quot;</span>
+    <span class="ruby-ivar">@package</span> = <span class="ruby-value str">&quot;\t\t&lt;package&gt;\n\t\t\t&lt;string&gt;%s&lt;/string&gt;\n\t\t\t&lt;string&gt;&lt;![CDATA[%s]]&gt;&lt;/string&gt;\n\t\t&lt;/package&gt;\n&quot;</span>
+    <span class="ruby-ivar">@footer</span> = <span class="ruby-value str">&quot;\t&lt;/packages&gt;\n&lt;/flex-config&gt;&quot;</span>
+
+    <span class="ruby-identifier">build</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+
+        <div class="method-heading">
+          <a href="#M000008" class="method-signature">
+          <span class="method-name">build</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Build the flex compiler config file that can be passed to the asdoc tool.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000008-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/hel/asdoc_package.rb, line 43</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">build</span>
+    <span class="ruby-identifier">asdocs</span> = <span class="ruby-identifier">scan</span>(<span class="ruby-ivar">@src</span>)
+
+    <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">asdocs</span>.<span class="ruby-identifier">empty?</span>
+      <span class="ruby-identifier">puts</span> <span class="ruby-value str">&quot;No .asdoc files found.&quot;</span>
+    <span class="ruby-keyword kw">else</span>
+      <span class="ruby-ivar">@xml</span> = <span class="ruby-identifier">create_xml</span>(<span class="ruby-identifier">asdocs</span>)
+      <span class="ruby-identifier">to_disk</span>(<span class="ruby-ivar">@xml</span>)
+    <span class="ruby-keyword kw">end</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+
+        <div class="method-heading">
+          <a href="#M000009" class="method-signature">
+          <span class="method-name">create_xml</span><span class="method-args">(asdocs)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Constructs the flex complier config file when given a list of paths to
+asdoc files.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000009-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/hel/asdoc_package.rb, line 58</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_xml</span>(<span class="ruby-identifier">asdocs</span>)
+    <span class="ruby-identifier">x</span> = <span class="ruby-ivar">@header</span>
+    <span class="ruby-identifier">asdocs</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">x</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">sprintf</span>(<span class="ruby-ivar">@package</span>, <span class="ruby-identifier">d</span>[<span class="ruby-identifier">:package</span>], <span class="ruby-constant">IO</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">d</span>[<span class="ruby-identifier">:path</span>])) }
+    <span class="ruby-identifier">x</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@footer</span>
+    <span class="ruby-identifier">x</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+
+        <div class="method-heading">
+          <a href="#M000007" class="method-signature">
+          <span class="method-name">scan</span><span class="method-args">(path)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Scan the given path and it&#8216;s child directories for all .asdoc files.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000007-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/hel/asdoc_package.rb, line 26</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">scan</span>(<span class="ruby-identifier">path</span>)
+    <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Scanning '#{path}' for asdoc files...&quot;</span>
+
+    <span class="ruby-identifier">found</span> = []
+
+    <span class="ruby-constant">Search</span>.<span class="ruby-identifier">find_all</span>(<span class="ruby-ivar">@asdoc</span>,<span class="ruby-identifier">path</span>,<span class="ruby-ivar">@excludes</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span>
+      <span class="ruby-identifier">found</span> <span class="ruby-operator">&lt;&lt;</span> {<span class="ruby-identifier">:path</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">p</span>, <span class="ruby-identifier">:package</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-constant">ProjectTools</span>.<span class="ruby-identifier">package</span>(<span class="ruby-identifier">p</span>)}
+    <span class="ruby-keyword kw">end</span>
+
+    <span class="ruby-identifier">found</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">log</span>(<span class="ruby-node">&quot;Adding #{f[:path]}&quot;</span>) }
+
+    <span class="ruby-identifier">found</span>
+  <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>