sprout-as3-bundle 0.1.27

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  = 27
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+      MAJOR_MINOR = [MAJOR, MINOR].join('.')
+    end
+  end
+end

data/lib/sprout/as3_tasks.rb

@@ -0,0 +1,7 @@
+sprout 'flashplayer'
+require 'sprout/tasks/flashplayer_task'
+require 'sprout/tasks/asunit_task'
+require 'sprout/tasks/fdb_task'
+require 'sprout/tasks/mxmlc_task'
+require 'sprout/tasks/asdoc_task'
+require 'sprout/tasks/compc_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/project/project_generator.rb

@@ -0,0 +1,26 @@
+
+class ProjectGenerator < Sprout::Generator::NamedBase # :nodoc:
+
+  def manifest
+    record do |m|
+      base = class_name
+      m.directory base
+      m.directory File.join(base, 'assets/skins', project_name)
+      m.directory File.join(base, 'bin')
+      m.directory File.join(base, 'lib')
+      m.directory File.join(base, 'script')
+      m.directory File.join(base, 'src')
+      m.directory File.join(base, 'test')
+
+      m.file 'ProjectSprouts.jpg', File.join(base, 'assets/skins', project_name, 'ProjectSprouts.jpg')
+      m.template 'rakefile.rb', File.join(base, "rakefile.rb")
+      m.template 'README.txt', File.join(base, "README.txt")
+
+      m.template 'generate', File.join(base, 'script', "generate"), :chmod => 0755
+      m.template 'DefaultSkin.as', File.join(base, 'assets/skins', project_name + "Skin.as")
+
+      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
+end

data/lib/sprout/generators/project/templates/DefaultSkin.as

@@ -0,0 +1,7 @@
+
+package skins {
+	public class <%= project_name %>Skin {
+		[Embed(source="<%= project_name %>/ProjectSprouts.jpg")]
+		public static var ProjectSprouts:Class;
+	}
+}

data/lib/sprout/generators/project/templates/MainClass.as

@@ -0,0 +1,12 @@
+package {
+	import flash.display.Sprite;
+	import skins.<%= project_name %>Skin;
+	
+	public class <%= project_name %> extends Sprite {
+
+		public function <%= project_name %>() {
+			addChild(new <%= project_name %>Skin.ProjectSprouts());
+			trace("<%= project_name %> instantiated!");
+		}
+	}
+}

data/lib/sprout/generators/project/templates/README.txt

@@ -0,0 +1,56 @@
+
+########################################
+This project was generated using Sprouts
+http://code.google.com/p/projectsprouts/
+
+Please report any bugs to:
+http://code.google.com/p/projectsprouts/issues/list
+
+Please feel free to ask questions at:
+http://groups.google.com/group/projectsprouts
+
+########################################
+Using your favorite terminal, cd to this directory have fun!
+
+########################################
+To create a new ActionScript class, TestCase and rebuild all project TestSuites:
+
+script/generate class -s utils.MathUtil
+
+########################################
+To create a new Interface begin the name with I + Capital letter (eg: ISomeName)
+or end the name with 'able'
+
+Name begins with Capital 'I' followed by another capital letter
+script/generate class utils.ISomeName 
+
+or
+
+Name ends with 'able'
+script/generate class utils.Observable
+
+or
+
+Explicitly identify interface creation
+script/generate interface utils.SomeInterface
+
+########################################
+To create a new TestCase only, enter the following:
+
+script/generate test utils.SomeTest
+
+########################################
+To compile and launch your application:
+
+rake
+
+########################################
+To compile and launch your test suites:
+
+rake test
+
+########################################
+To see all available rake tasks:
+
+rake -T
+

data/lib/sprout/generators/project/templates/TestRunner.as

@@ -0,0 +1,15 @@
+package {
+	import asunit.textui.TestRunner;
+	
+	public class <%= project_name %>Runner extends TestRunner {
+
+		public function <%= project_name %>Runner() {
+			// start(clazz:Class, methodName:String, showTrace:Boolean)
+			// NOTE: sending a particular class and method name will
+			// execute setUp(), the method and NOT tearDown.
+			// This allows you to get visual confirmation while developing
+			// visual entities
+			start(AllTests, null, TestRunner.SHOW_TRACE);
+		}
+	}
+}

data/lib/sprout/generators/project/templates/generate

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'sprout'
+sprout 'sprout-as3-bundle'
+
+# Add a class name if TestSuites were generated
+if(ARGV.size == 1 && ARGV[0] == 'suite')
+  ARGV << 'AllTests'
+end
+
+# Insert class type by default
+if(ARGV.size == 1)
+  ARGV.unshift('class')
+end
+
+# Execute generators like this:
+# script/generate class utils.MathUtil
+# script/generate suite
+# script/generate test utils.MathUtilTest
+
+Sprout::Sprout.generate('as3', ARGV.shift, ARGV, File.dirname(File.dirname(__FILE__)))

data/lib/sprout/generators/project/templates/rakefile.rb

@@ -0,0 +1,91 @@
+require 'sprout'
+sprout 'as3'
+
+############################################
+# Uncomment and modify any of the following:
+model = Sprout::ProjectModel.instance
+model.project_name  = '<%= project_name %>'
+
+# Default Values:
+# model.src_dir       = 'src'
+# model.lib_dir       = 'lib'
+# model.swc_dir       = 'lib'
+# model.bin_dir       = 'bin'
+# model.test_dir      = 'test'
+# model.asset_dir     = 'assets'
+model.language      = 'as3'
+
+output              = "#{model.bin_dir}/<%= project_name %>.swf"
+test_output         = "#{model.bin_dir}/<%= project_name %>Runner.swf"
+
+############################################
+# Set up remote library tasks
+# the task name will be converted to a string
+# and modified as follows sprout-#{name}-library
+# unless you pass t.gem_name = 'full-sprout-name'
+# For libraries that contain source code, the
+# task name will also be the folder name that 
+# will be added to ProjectModel.lib_dir
+# For a complete list of available sprout gems:
+# http://gems.projectsprouts.org/quick/index
+# You can also search that list directly from a
+# terminal as follows:
+# gem search -r library
+# Any gems with 'sprout-' prefix and '-library'
+# suffix can be be used as a library task.
+
+library :asunit3
+library :corelib
+
+############################################
+# Launch the application using the Flash Player
+# NOTE: double-quoted strings in ruby enable
+# runtime expression evaluation using the
+# following syntax:
+# "Some String with: #{variable}"
+
+desc "Compile and run main application"
+flashplayer :run => output
+
+# Make 'run' the default task
+task :default => :run
+
+############################################
+# Launch the test suites using the Flash Player
+
+desc "Compile and run test suites"
+flashplayer :test => test_output
+
+############################################
+# Compile your application using mxmlc
+# Any library tasks that are set as 
+# dependencies will automatically be added
+# to the compiler source or swc paths
+
+desc "Compile application"
+mxmlc output => :corelib do |t|
+  t.warnings                  = true
+  t.default_background_color  = '#FFFFFF'
+  t.default_frame_rate        = 24
+  t.default_size              = '600 400'
+  t.input                     = "#{model.src_dir}/<%= project_name %>.as"
+  t.source_path               << model.asset_dir
+# t.source_path               << "#{model.lib_dir}/non-sprout-src-library"
+# t.library_path              << "#{model.lib_dir}/non-sprout.swc"
+end
+
+############################################
+# Compile test harness using mxmlc
+
+desc "Compile test harness"
+mxmlc test_output => [:asunit3, :corelib] do |t|
+  t.warnings                  = true
+  t.default_background_color  = '#FFFFFF'
+  t.default_frame_rate        = 24
+  t.verbose_stacktraces        = true
+  t.default_size              = "800 450"
+  t.input                     = "#{model.src_dir}/<%= project_name %>Runner.as"
+  t.source_path               << model.src_dir
+  t.source_path               << model.test_dir
+  t.source_path               << model.asset_dir
+end