tool-shed 0.0.7 → 0.0.9

data/test/unit/test_concrete.rb

@@ -0,0 +1,236 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class TestConcrete < Test::Unit::TestCase
+
+  def fix
+    File.expand_path(File.dirname(__FILE__)+ "/../fixtures/interface")
+  end
+
+  context "A concrete generator tool running with a missing interface file" do
+
+    should "exit with an error message" do
+
+      opts = ConcreteOpts.parse ['-i', "#{fix}/IDoNotExist.as"]
+      out = StringIO.new
+
+      begin
+        Concrete.new(opts,out)
+        flunk
+      rescue SystemExit => e
+        assert_equal 0, e.status
+        assert_match(/#{Tool::INVALID_OPTS}/, out.string)
+      end
+
+    end
+
+  end
+
+  context "A concrete generator tool given an invalid interface file" do
+
+    should "exit with an error message" do
+
+      opts = ConcreteOpts.parse ['-i', "#{fix}/Shed.as"]
+      out = StringIO.new
+
+      begin
+        Concrete.new(opts,out)
+        flunk
+      rescue SystemExit => e
+        assert_equal 0, e.status
+        assert_match(/#{Tool::INVALID_OPTS} The specified/, out.string)
+      end
+
+    end
+
+  end
+
+  context "A concrete generator tool" do
+
+    context "outputting actionscript classes" do
+
+      setup do
+        opts = ConcreteOpts.parse ['-i', "#{fix}/IShed.as"]
+        @out = StringIO.new
+        @concrete = Concrete.new(opts,@out)
+      end
+
+      should "output a string" do
+        assert_not_nil(@out.string)
+      end
+
+      should "output a package declaration" do
+        assert_match(/^package/, @out.string)
+      end
+
+      should "output a class declaration" do
+        assert_match(/^class Shed/, @out.string)
+      end
+
+      should "implement the expected interface" do
+        assert_match(/implements IShed$/, @out.string)
+      end
+
+      should "output getters with the expected return type" do
+        assert_match(/public function get windows\(\):int/, @out.string)
+        assert_match(/public function get doors\(\):uint/, @out.string)
+      end
+
+      should "output setters with the correct return type" do
+        assert_match(/public function set windows\(value:int\):void/, @out.string)
+      end
+
+      should "output setters with correct argument type" do
+        assert_match(/set windows\(value:int\)/, @out.string)
+        assert_match(/public function set windows\(value:int\)/, @out.string)
+      end
+
+      should "output methods" do
+        assert_match(/public function startHeater\(/, @out.string)
+        assert_match(/public function countTools\(\):Number/, @out.string)
+      end
+
+      should "output methods with the expected arguments" do
+        assert_match(/public function startHeater\(temperature:Number, fuel:String\):void/, @out.string)
+      end
+
+      should "output methods which return the expected values" do
+        assert_match(/return;/, @out.string)
+      end
+
+      should "have valid options" do
+        assert @concrete.valid_opts
+      end
+    end
+
+    context "outputting mock 4 as classes" do
+
+      setup do
+        opts = ConcreteOpts.parse ['-i', "#{fix}/IShed.as", '-t', 'mock4as']
+        @out = StringIO.new
+        @concrete = Concrete.new(opts,@out)
+      end
+
+      should "output a string" do
+        assert_not_nil(@out.string)
+      end
+
+      should "output a package declaration" do
+        assert_match(/^package/, @out.string)
+      end
+
+      should "output a class declaration" do
+        assert_match(/^class ShedMock/, @out.string)
+      end
+
+      should "extend a Mock" do
+        assert_match(/import org\.mock4as\.Mock;/, @out.string)
+        assert_match(/extends Mock/, @out.string)
+      end
+
+      should "implement the expected interface" do
+        assert_match(/implements IShed$/, @out.string)
+      end
+
+      should "output getters with the expected return type" do
+        assert_match(/public function get windows\(\):int/, @out.string)
+        assert_match(/public function get doors\(\):uint/, @out.string)
+      end
+
+      should "output getters with record statements" do
+        assert_match(/record\('windows'\);/, @out.string)
+      end
+
+      should "output setters with the correct return type" do
+        assert_match(/public function set windows\(value:int\):void/, @out.string)
+      end
+
+      should "output setters with correct argument type" do
+        assert_match(/set windows\(value:int\)/, @out.string)
+        assert_match(/public function set windows\(value:int\)/, @out.string)
+      end
+
+      should "output methods" do
+        assert_match(/public function startHeater\(/, @out.string)
+        assert_match(/public function countTools\(\):Number/, @out.string)
+      end
+
+      should "output methods with the expected arguments" do
+        assert_match(/public function startHeater\(temperature:Number, fuel:String\):void/, @out.string)
+      end
+
+      should "output methods with record statements" do
+        assert_match(/record\('openDoor'\);/, @out.string)
+        assert_match(/record\('countTools'\);/, @out.string)
+        assert_match(/record\('startHeater', temperature, fuel\);/, @out.string)
+      end
+
+      should "output methods which return the expected values" do
+        assert_match(/return expectedReturnFor\('countTools'\) as Number;/, @out.string)
+      end
+
+      should "have valid options" do
+        assert @concrete.valid_opts
+      end
+    end
+
+    context "outputting interface implementation" do
+
+      setup do
+        opts = ConcreteOpts.parse ['-i', "#{fix}/IShed.as", '-t', 'imp']
+        @out = StringIO.new
+        @concrete = Concrete.new(opts,@out)
+      end
+
+      should "output a string" do
+        assert_not_nil(@out.string)
+      end
+
+      should "not output a package declaration" do
+        assert_no_match(/^package/, @out.string)
+      end
+
+      should "not output a class declaration" do
+        assert_no_match(/^class Shed/, @out.string)
+      end
+
+      should "not implement the expected interface" do
+        assert_no_match(/implements IShed$/, @out.string)
+      end
+
+      should "output getters with the expected return type" do
+        assert_match(/public function get windows\(\):int/, @out.string)
+        assert_match(/public function get doors\(\):uint/, @out.string)
+      end
+
+      should "output setters with the correct return type" do
+        assert_match(/public function set windows\(value:int\):void/, @out.string)
+      end
+
+      should "output setters with correct argument type" do
+        assert_match(/set windows\(value:int\)/, @out.string)
+        assert_match(/public function set windows\(value:int\)/, @out.string)
+      end
+
+      should "output methods" do
+        assert_match(/public function startHeater\(/, @out.string)
+        assert_match(/public function countTools\(\):Number/, @out.string)
+      end
+
+      should "output methods with the expected arguments" do
+        assert_match(/public function startHeater\(temperature:Number, fuel:String\):void/, @out.string)
+      end
+
+      should "output methods which return the expected values" do
+        assert_match(/return;/, @out.string)
+      end
+
+      should "have valid options" do
+        assert @concrete.valid_opts
+      end
+    end
+
+  end
+
+end

data/test/unit/test_concrete_opts.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class TestConcreteOpt < Test::Unit::TestCase
+
+  context "A Concrete Tool Options Parser" do
+
+    should "return default hash if no arguments are specified" do
+      args = []
+      opts = ConcreteOpts.parse(args)
+
+      assert_equal false, opts[:verbose]
+    end
+
+    should "display a name" do
+      assert_match(/\w+/, ConcreteOpts.name)
+    end
+
+    should "describe itself" do
+      assert_match(/\w+/, ConcreteOpts.description)
+    end
+
+    should "define a type when -t is set" do
+      arg = 'olate'
+      opts = ConcreteOpts.parse ['-t', arg]
+
+      assert_equal arg, opts[:type]
+    end
+
+    should "define a type when --type is set" do
+      arg = '4as'
+      opts = ConcreteOpts.parse ['--type', arg]
+
+      assert_equal arg, opts[:type]
+    end
+
+    should "define a interface when -i is set" do
+      arg = 'org.helvector.IShed'
+      opts = ConcreteOpts.parse ['-i', arg]
+
+      assert_equal arg, opts[:interface]
+    end
+
+    should "define a interface when --interface is set" do
+      arg = 'org.helvector.IShed'
+      opts = ConcreteOpts.parse ['--interface', arg]
+
+      assert_equal arg, opts[:interface]
+    end
+
+  end
+
+end

data/test/unit/test_interface.rb

@@ -0,0 +1,142 @@
+# encoding: utf-8
+
+require File.join(File.dirname(__FILE__), "/../test_helper")
+
+class TestInterface < Test::Unit::TestCase
+
+  def fix
+    File.expand_path(File.dirname(__FILE__)+ "/../fixtures/interface")
+  end
+
+  context "load an interface with multiline methods and tokenise the contents" do
+    #TODO
+    setup do
+      file = File.new("#{fix}/ISeedPacket.as").read.strip
+      @parser = Interface.new(file)
+    end
+
+   should "identify the interface name" do
+      assert_equal('ISeedPacket', @parser.name)
+    end
+
+    should "identify the interface package" do
+      assert_equal('org.shed.bench.box', @parser.package)
+    end
+
+    should "identify the accessors" do
+      p = @parser.get_property('material')
+
+      assert_not_nil(p)
+      assert(p[:gets])
+      assert(p[:sets])
+      assert_equal('String', p[:type])
+      assert_equal(1, @parser.properties.length)
+    end
+
+    should "identify multiline methods defined in the interface" do
+      m = @parser.get_method('variety')
+
+      assert_not_nil(m)
+      assert_equal('variety', m[:name])
+      assert_equal(['one:Number', 'two:String', 'three:Function'], m[:arguments])
+      assert_equal('String', m[:return])
+    end
+
+    should "identify multiline methods with default arguments" do
+      m = @parser.get_method('age')
+
+      assert_not_nil(m)
+      assert_equal('age', m[:name])
+      assert_equal(['planted:Date', 'details:String="a,b,c"'], m[:arguments])
+      assert_equal('Date', m[:return])
+
+      m = nil
+      m = @parser.get_method('plant')
+
+      assert_not_nil(m)
+      assert_equal('plant', m[:name])
+      assert_equal(['a:String', 'b:Boolean=false', 'c:Seed=pod'], m[:arguments])
+      assert_equal('Boolean', m[:return])
+    end
+
+    should "identify methods with ...rest arguments" do
+      m = @parser.get_method('have')
+
+      assert_not_nil(m)
+      assert_equal('have', m[:name])
+      assert_equal(['a:String', '...rest'], m[:arguments])
+      assert_equal('Boolean', m[:return])
+    end
+
+  end
+
+  context "load an interface and tokenise the contents" do
+    setup do
+      file = File.new("#{fix}/IShed.as").read.strip
+      @parser = Interface.new(file)
+    end
+
+    should "identify the interface name" do
+      assert_equal('IShed', @parser.name)
+    end
+
+    should "identify the interface package" do
+      assert_equal('', @parser.package)
+    end
+
+    should "identify the accessors" do
+      p = @parser.get_property('windows')
+
+      assert_not_nil(p)
+      assert(p[:gets])
+      assert(p[:sets])
+      assert_equal('int', p[:type])
+      assert_equal(3, @parser.properties.length)
+    end
+
+    should "identify the setters" do
+      p = @parser.get_property('lamps')
+
+      assert_not_nil(p)
+      assert(!p[:gets])
+      assert(p[:sets])
+      assert_equal('Number', p[:type])
+    end
+
+    should "identify getters" do
+      p = @parser.get_property('doors')
+
+      assert_not_nil(p)
+      assert(p[:gets])
+      assert(!p[:sets])
+      assert_equal('uint', p[:type])
+    end
+
+    should "identify all methods defined in the interface" do
+      m = @parser.get_method('openDoor')
+
+      assert_not_nil(m)
+      assert_equal('openDoor', m[:name])
+      assert_equal([], m[:arguments])
+      assert_equal('void', m[:return])
+
+      m = @parser.get_method('startHeater')
+
+      assert_not_nil(m)
+      assert_equal('startHeater', m[:name])
+      assert_equal(['temperature:Number','fuel:String'], m[:arguments])
+      assert_equal('void', m[:return])
+
+      m = @parser.get_method('countTools')
+
+      assert_not_nil(m)
+      assert_equal('countTools', m[:name])
+      assert_equal([], m[:arguments])
+      assert_equal('Number', m[:return])
+
+      assert_equal(3, @parser.methods.length)
+    end
+
+  end
+
+end

data/test/unit/test_manifest.rb

@@ -2,7 +2,7 @@
 
 require File.join(File.dirname(__FILE__), "/../test_helper")
 
-class ManifestTest < Test::Unit::TestCase
+class TestManifest < Test::Unit::TestCase
 
   context "A manifest builder tool" do
 

data/test/unit/test_manifest_opts.rb

@@ -2,7 +2,7 @@
 
 require File.join(File.dirname(__FILE__), "/../test_helper")
 
-class ManifestOptTest < Test::Unit::TestCase
+class TestManifestOpt < Test::Unit::TestCase
 
   context "A Manifest Tool Options Parser" do
 
@@ -13,7 +13,6 @@ class ManifestOptTest < Test::Unit::TestCase
       assert_equal 'manifest.xml', opts[:output]
       assert_equal '.', opts[:src]
       assert_equal false, opts[:verbose]
-
     end
 
     should "display a name" do

data/test/unit/test_search.rb

@@ -2,7 +2,7 @@
 
 require File.join(File.dirname(__FILE__), "/../test_helper")
 
-class SearchTest < Test::Unit::TestCase
+class TestSearch < Test::Unit::TestCase
 
   context "A file search utility" do
 

data/test/unit/test_source_tools.rb

@@ -2,7 +2,7 @@
 
 require File.join(File.dirname(__FILE__), "/../test_helper")
 
-class ProjectToolsTest < Test::Unit::TestCase
+class TestSourceTools < Test::Unit::TestCase
 
   context "Utility source tools" do
 

data/test/unit/test_stripper.rb

@@ -2,7 +2,7 @@
 
 require File.join(File.dirname(__FILE__), "/../test_helper")
 
-class StripperTest < Test::Unit::TestCase
+class TestStripper < Test::Unit::TestCase
 
   context "Comment stripper" do
 

data/test/unit/test_style_vacuum.rb

@@ -11,6 +11,7 @@ class TestStyleVacuum < Test::Unit::TestCase
   context "A style vacuum tool" do
 
     context "with correct arguments" do
+
       setup do
         opt = { :src => "#{fix}/src",
                 :css_dir => "#{fix}/css",
@@ -32,25 +33,29 @@ class TestStyleVacuum < Test::Unit::TestCase
         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",
-                :output => '/tmp/as-style-vacuum.txt' }
-
-        @out = StringIO.new
-        @tool = StyleVacuum.new(opt,@out)
-      end
 
       should "fail with a warning message" do
-        assert_match(/#{StyleVacuum::INVALID_OPTS}/, @out.string)
-        assert_equal(false, @tool.valid_opts)
+        opt = { :src => "#{fix}/src", :css_dir => "#{fix}/src",
+                :output => '/tmp/as-style-vacuum.txt' }
+        out = StringIO.new
+
+        begin
+          StyleVacuum.new(opt,out)
+          flunk
+        rescue SystemExit => e
+          assert_equal 0, e.status
+          assert_match(/#{Tool::INVALID_OPTS} The specified/, out.string)
+        end
       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",
@@ -67,9 +72,11 @@ class TestStyleVacuum < 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",
@@ -87,9 +94,11 @@ class TestStyleVacuum < Test::Unit::TestCase
       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",
@@ -102,6 +111,7 @@ class TestStyleVacuum < Test::Unit::TestCase
       should "find all values of syleName attributes" do
         assert @tool.used.length == 2
       end
+
     end
 
   end

data/test/unit/test_tool.rb

@@ -2,7 +2,7 @@
 
 require File.join(File.dirname(__FILE__), "/../test_helper")
 
-class ToolTest < Test::Unit::TestCase
+class TestTool < Test::Unit::TestCase
 
   context "A default tool-shed" do
 
@@ -52,6 +52,7 @@ class ToolTest < Test::Unit::TestCase
   end
 
   context "A verbose tool-shed" do
+
     setup do
       @out = StringIO.new
       @tool = Tool.new({:verbose => true, :output => '/tmp/tool-shed.txt'}, @out)

data/test/unit/test_tool_opts.rb

@@ -2,7 +2,7 @@
 
 require File.join(File.dirname(__FILE__), "/../test_helper")
 
-class ToolOptsTest < Test::Unit::TestCase
+class TestToolOpts < Test::Unit::TestCase
 
   context "A  Tool Options Parser" do
 
@@ -17,13 +17,26 @@ class ToolOptsTest < Test::Unit::TestCase
 
     end
 
-    should "define verbose mode when -v is set" do
+    should "recognise default arguments if no switches are present" do
+      args = ['path/to/a/text.file']
+      opts = ToolOpts.parse(args)
 
-      args = ['-v']
+      assert_equal 'path/to/a/text.file', opts[:default]
+    end
+
+    should "recognise default arguments when switches are present" do
+      args = ['-v','path/to/a/text.file', '-s', 'path/to/source']
       opts = ToolOpts.parse(args)
 
+      assert_equal 'path/to/a/text.file', opts[:default]
       assert 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