sprout-as3-puremvc-bundle 0.1.0

data/README

@@ -0,0 +1,48 @@
+
+= ActionScript 3.0 Bundle
+
+The ActionScript 3 Bundle provides support for ActionScript 3.0 project and class generators as well as Rake build tasks.
+
+You can install this bundle and run it's project generator as follows:
+
+  sprout -n as3 SomeProject
+
+Once you have generated a new project, using a terminal, you can change to the newly created directory
+and use script/generate to create a variety of other features.
+
+To generate a new ActionScript class, test case and test suite, simply run the following from the
+same directory as your rakefile.
+
+  script/generate class [fully-qualified-class-name]
+
+For example:
+
+  script/generate class utils.MathUtil
+
+While you can change where classes are created by modifying your ProjectModel, 
+if the default values are used, the following statements should be correct:
+
+The class will be created in:
+  src/utils/MathUtil.as
+The test case will will be created in:
+  test/utils/MathUtilTest.as
+The test suite will be created or updated at:
+  test/AllTests.as
+
+If the class name passed into this generator ends with 'Test', only a test case
+and test suite will be generated in the test package and no class will be generated.
+
+You can also only create the test case and test suite by calling it's generator directly as follows:
+
+  script/generate test utils.MathUtilTest
+
+You can update only your test suite by simply initiating the suite generator as follows:
+
+  script/generate suite
+
+= Available Rake Tasks
+
+* Sprout::AsDocTask
+* Sprout::AsUnitTask
+* Sprout::COMPCTask
+* Sprout::MXMLCTask

data/lib/sprout/as3.rb

@@ -0,0 +1,5 @@
+require 'sprout'
+require 'sprout/generator'
+require 'sprout/as3_tasks'
+
+Rails::Generator::Base.use_sprout_sources!('as3')

data/lib/sprout/as3/version.rb

@@ -0,0 +1,12 @@
+module Sprout # :nodoc:
+  class AS3 # :nodoc:
+    module VERSION #:nodoc:
+      MAJOR = 0
+      MINOR = 1
+      TINY  = 0
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+      MAJOR_MINOR = [MAJOR, MINOR].join('.')
+    end
+  end
+end

data/lib/sprout/as3_tasks.rb

@@ -0,0 +1,7 @@
+sprout 'sprout-flashplayer-bundle'
+require 'sprout/tasks/flashplayer_task'
+require 'sprout/tasks/fdb_task'
+require 'sprout/tasks/mxmlc_task'
+require 'sprout/tasks/compc_task'
+require 'sprout/tasks/asdoc_task'
+require 'sprout/tasks/asunit_task'

data/lib/sprout/generators/class/USAGE

@@ -0,0 +1,42 @@
+Description:
+    Stubs out a new ActionScript class and test case and then rebuilds all test 
+    suites. Pass the fully-qualified class name, either as a shell file target
+    or a dot-delimited string.
+
+	This command uses the Sprout::Generator::NamedBase class which will search
+	for configuration parameters as follows:
+	
+	1) Command line parameters will supercede any of the following.
+	2) Search the current working directory and all parent directories 
+	   for a valid Rakefile.
+	3) If a Rakefile is not found, classes will be created directly from the 
+	   current working directory.
+	4) If a Rakefile is found, it will be loaded. If the rakefile instantiates
+       a Sprout::ProjectModel, that configuration will be used for source and test
+       paths, language preferences, and other values.
+	5) If no ProjectModel is instantiated in your Rakefile, the Rakefile itself
+       will be treated as the project root, and classes will be created from that
+       directory.
+
+	You can edit the erb templates that this command uses in a variety of ways.
+	If you would like to edit the templates for all projects on your system,
+	simply copy the directory at: File.dirname(__FILE__) into: 
+
+	#{SPROUT_HOME}/sprout/generators/
+	
+	To edit templates for a single project, copy the directory to:
+
+	#{PROJECT_HOME}/script/generators/
+	
+	Once you have the contents of this package copied, simply edit the files found
+	in the templates/ folder to your satisfaction.
+	
+Example:
+    `./script/generate class utils.MathUtil`
+
+	Will create the follow files:
+	
+	    Class:			src/utils/MathUtil.as
+	    Test Case:		test/utils/MathUtilTest.as
+	    Test Suites:	test/AllTests.as
+	    				test/utils/AllTests.as

data/lib/sprout/generators/class/class_generator.rb

@@ -0,0 +1,20 @@
+
+class ClassGenerator < Sprout::Generator::NamedBase  # :nodoc:
+
+  def manifest
+    record do |m|
+#      m.class_collisions class_dir, "#{class_name}Controller", "#{class_name}ControllerTest", "#{class_name}Helper"
+
+      if(!user_requested_test)
+        m.directory full_class_dir
+        m.template 'Class.as', full_class_path
+      end
+ 
+      m.directory full_test_dir
+      m.template 'TestCase.as', full_test_case_path
+      
+      m.template 'TestSuite.as', File.join(test_dir, 'AllTests.as')
+    end
+  end
+    
+end

data/lib/sprout/generators/class/templates/Class.as

@@ -0,0 +1,8 @@
+package <%= package_name %> {
+	
+	public class <%= class_name %> {
+		
+		public function <%= class_name %>() {
+		} 
+	}
+}

data/lib/sprout/generators/class/templates/Component.mxml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<mx:Container
+	xmlns:mx="http://www.adobe.com/2006/mxml" 
+	xmlns="<%= package_name %>.*"
+	width="100%" 
+	height="100%"
+	>
+</mx:Container>

data/lib/sprout/generators/class/templates/TestCase.as

@@ -0,0 +1,30 @@
+package <%= package_name %> {
+
+	import asunit.framework.TestCase;
+
+	public class <%= test_case_name  %> extends TestCase {
+		private var <%= instance_name %>:<%= class_name %>;
+
+		public function <%= test_case_name %>(methodName:String=null) {
+			super(methodName)
+		}
+
+		override protected function setUp():void {
+			super.setUp();
+			<%= instance_name %> = new <%= class_name %>();
+		}
+
+		override protected function tearDown():void {
+			super.tearDown();
+			<%= instance_name %> = null;
+		}
+
+		public function testInstantiated():void {
+			assertTrue("<%= instance_name %> is <%= class_name %>", <%= instance_name %> is <%= class_name %>);
+		}
+
+		public function testFailure():void {
+			assertTrue("Failing test", false);
+		}
+	}
+}

data/lib/sprout/generators/class/templates/TestSuite.as

@@ -0,0 +1,18 @@
+package {
+	/**
+	 * This file has been automatically created using
+	 * #!/usr/bin/ruby script/generate suite
+	 * If you modify it and run this script, your
+	 * modifications will be lost!
+	 */
+
+	import asunit.framework.TestSuite;<% test_case_classes.each do |test_case|  %>
+	import <%= test_case %>;<% end  %>
+
+	public class AllTests extends TestSuite {
+
+		public function AllTests() {<% test_case_classes.each do |test_case|  %>
+			addTest(new <%= test_case %>());<% end  %>
+		}
+	}
+}

data/lib/sprout/generators/component/component_generator.rb

@@ -0,0 +1,18 @@
+
+class ComponentGenerator < Sprout::Generator::NamedBase  # :nodoc:
+
+  def manifest
+    record do |m|
+      if(!user_requested_test)
+        m.directory full_class_dir
+        m.template 'Component.mxml', full_class_path.gsub(/.as$/, '.mxml')
+      end
+ 
+      m.directory full_test_dir
+      m.template 'VisualTestCase.as', full_test_case_path
+      
+      m.template 'TestSuite.as', File.join(test_dir, 'AllTests.as')
+    end
+  end
+    
+end

data/lib/sprout/generators/component/templates/Component.mxml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="utf-8"?>
+<mx:Canvas xmlns:mx="http://www.adobe.com/2006/mxml" width="100%" height="100%">
+</mx:Canvas>

data/lib/sprout/generators/component/templates/TestSuite.as

@@ -0,0 +1,18 @@
+package {
+	/**
+	 * This file has been automatically created using
+	 * #!/usr/bin/ruby script/generate suite
+	 * If you modify it and run this script, your
+	 * modifications will be lost!
+	 */
+
+	import asunit.framework.TestSuite;<% test_case_classes.each do |test_case|  %>
+	import <%= test_case %>;<% end  %>
+
+	public class AllTests extends TestSuite {
+
+		public function AllTests() {<% test_case_classes.each do |test_case|  %>
+			addTest(new <%= test_case %>());<% end  %>
+		}
+	}
+}

data/lib/sprout/generators/component/templates/VisualTestCase.as

@@ -0,0 +1,32 @@
+package <%= package_name %> {
+
+	import asunit.framework.TestCase;
+
+	public class <%= test_case_name  %> extends TestCase {
+		private var <%= instance_name %>:<%= class_name %>;
+
+		public function <%= test_case_name %>(methodName:String=null) {
+			super(methodName)
+		}
+
+		override protected function setUp():void {
+			super.setUp();
+			<%= instance_name %> = new <%= class_name %>();
+			addChild(<%= instance_name %>);
+		}
+
+		override protected function tearDown():void {
+			super.tearDown();
+			removeChild(<%= instance_name %>);
+			<%= instance_name %> = null;
+		}
+
+		public function testInstantiated():void {
+			assertTrue("<%= instance_name %> is <%= class_name %>", <%= instance_name %> is <%= class_name %>);
+		}
+
+		public function testFailure():void {
+			assertTrue("Failing test", false);
+		}
+	}
+}

data/lib/sprout/generators/project/project_generator.rb

@@ -0,0 +1,163 @@
+class ProjectGenerator < Sprout::Generator::NamedBase # :nodoc:
+
+  def manifest
+    record do |m|
+      
+      template_src = "#{source_path( './' )}";
+      
+      lib_dir = "lib";
+      opt_dir = "opt";
+      
+      #puts "template src #{template_src}";
+      
+      base = class_name;
+      m.directory( base );
+      
+      #directory for template files
+      m.directory( File.join( base, 'embed', 'template' ) );
+      
+      #directory for embedded images
+      m.directory( File.join( base, 'embed', 'images' ) );
+      
+      #directory for embedded audio
+      m.directory( File.join( base, 'embed', 'audio' ) );
+      
+      #directory for embedded font files
+      m.directory( File.join( base, 'embed', 'fonts' ) );
+      
+      #top level deploy runtime assets directory
+      m.directory( File.join( base, 'deploy', 'assets' ) );
+      
+      #runtime asset sub-directories
+      m.directory( File.join( base, 'deploy', 'assets', 'css' ) );
+      m.directory( File.join( base, 'deploy', 'assets', 'js' ) );
+      m.directory( File.join( base, 'deploy', 'assets', 'swf' ) );
+      m.directory( File.join( base, 'deploy', 'assets', 'xml' ) );
+      
+      #directory for swc libraries
+      m.directory( File.join( base, 'lib' ) );
+      
+      #directory for source libraries
+      m.directory( File.join( base, 'lib', 'src' ) );
+      
+      #directory for the script/generate stub script
+      m.directory( File.join( base, 'script' ) );
+      
+      #directory for all project classes
+      m.directory( File.join( base, 'src' ) );
+      
+      #directory for unit test classes
+      m.directory( File.join( base, 'test' ) );
+      
+      #add the fonts embed definition xml document
+      m.file(
+        File.join( 'embed', 'fonts', 'fonts.xml' ),
+        File.join( base, 'embed', 'fonts', 'fonts.xml' ) );
+      
+      #add the font class template
+      m.file(
+        File.join( 'embed', 'template', 'FontTemplate.as' ),
+        File.join( base, 'embed', 'template', 'FontTemplate.as' ) );
+      
+      #add the embed template
+      m.file(
+        File.join( 'embed', 'template', 'AssetEmbedTemplate.as' ),
+        File.join( base, 'embed', 'template', 'AssetEmbedTemplate.as' ) );
+      
+      #add the default embedded font
+      m.file(
+        File.join( 'embed', 'fonts', 'arial.ttf' ),
+        File.join( base, 'embed', 'fonts', 'arial.ttf' ) );
+      
+      #add the swfobject js file
+      m.file(
+        File.join( 'deploy', 'assets', 'js', 'swfobject.js' ),
+        File.join( base, 'deploy', 'assets', 'js', 'swfobject.js' ) );
+      
+      #add the express install file
+      m.file(
+        File.join( 'deploy', 'assets', 'swf', 'express_install.swf' ),
+        File.join( base, 'deploy', 'assets', 'swf', 'express_install.swf' ) );
+      
+      #add the main css file
+      m.file(
+        File.join( 'deploy', 'assets', 'css', 'main.css' ),
+        File.join( base, 'deploy', 'assets', 'css', 'main.css' ) );
+      
+      #copy all the lib swcs
+      lib_pattern = File.join( template_src, lib_dir, "*.{swc}" );
+      contents = Dir.glob( lib_pattern );
+      contents.each do |swc|
+        swc_name = File.basename( swc );
+        m.file File.join( lib_dir, swc_name ), File.join( base, lib_dir, swc_name );
+      end
+      
+      #copy optional libraries
+      opt_pattern = File.join( template_src, lib_dir, opt_dir, "**", "*.{swc}" );
+      opt_contents = Dir.glob( opt_pattern );
+      
+      opt_contents.each do |opt|
+        opt_path = opt.sub( File.join( template_src, lib_dir, opt_dir ), "" );
+        
+        target = File.join( base, lib_dir, opt_dir, opt_path );
+        parent = File.dirname( target );
+        
+        if !File.exists?( parent )
+          FileUtils.mkdir_p( parent );
+        end
+        m.file opt.sub( template_src, "" ), target;
+      end
+      
+      #add the main index file
+      m.template(
+        File.join( 'deploy', 'index.html' ),
+        File.join( base, 'deploy', 'index.html' ) );
+      
+      #rake files
+      m.template(
+        'rakefile.rb',
+        File.join( base, "rakefile.rb" ) );
+      m.template(
+        'rakefonts.rb',
+        File.join( base, "rakefonts.rb" ) );
+      m.template(
+        'rakeassets.rb',
+        File.join( base, "rakeassets.rb" ) );
+      
+      #readme
+      m.template(
+        'README.txt',
+        File.join( base, "README.txt" ) );
+      
+      #generate stub script
+      m.template(
+        'generate',
+        File.join( base, 'script', "generate" ), :chmod => 0755 );
+
+      m.template(
+        'MainClass.as',
+        File.join( base, 'src', "#{class_name}.as" ) );
+        
+      m.template(
+        'TestRunner.as',
+        File.join( base, 'src', "#{class_name}Runner.as" ) );
+    end
+  end
+
+  protected
+  # Not sure about the banner...
+#    def banner
+#      "Usage: #{$0} #{spec.name} ModelName [field:type, field:type]"
+#    end
+
+    def add_options!(opt)
+      opt.on('-m', '--mxml', "Create a Flex project") { |v| options[:mxml] = true }
+#      opt.on("--skip-migration", 
+#             "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+#      opt.on("--skip-fixture",
+#             "Don't generation a fixture file for this model") { |v| options[:skip_fixture] = v}
+      super
+
+    end
+
+end