sprout-as3-puremvc-bundle 0.1.0

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

@@ -0,0 +1,112 @@
+require 'sprout'
+require 'rakefonts'
+require 'rakeassets'
+# Optionally load gems from a server other than rubyforge:
+# set_sources 'http://gems.projectsprouts.org'
+sprout 'as3'
+
+############################################
+# Uncomment and modify any of the following:
+Sprout::ProjectModel.setup do |model|
+  model.project_name  = '<%= project_name %>'
+  # Default Values:
+  # model.src_dir       = 'src'
+  # model.lib_dir       = 'lib'
+  # model.swc_dir       = 'lib'
+  model.bin_dir       = 'deploy'
+  # model.test_dir      = 'test'
+  # model.doc_dir       = 'doc'
+  model.asset_dir     = 'embed'
+  model.language      = 'as3'
+  model.output        = "#{model.bin_dir}/<%= project_name.downcase %>.swf"
+  model.test_output   = "#{model.bin_dir}/<%= project_name.downcase %>_runner.swf"
+end
+
+model = Sprout::ProjectModel.instance
+
+############################################
+# 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://rubyforge.org/frs/?group_id=3688
+# You can also search that list directly from a
+# terminal as follows:
+# gem search -r sprout-*library
+
+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 => model.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 => model.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 model.output => [:corelib] do |t|
+# Uncomment to use the Flex 3 SDK
+  t.gem_name                  = 'sprout-flex3sdk-tool'
+  t.warnings                  = true
+  t.default_background_color  = '#FFFFFF'
+  t.default_frame_rate        = 30
+  t.default_size              = '800 600'
+  t.input                     = "#{model.src_dir}/<%= project_name %>.as"
+  t.source_path               << model.asset_dir
+# t.source_path               << "#{model.lib_dir}/non-sprout-src-library"
+
+  #added lib directory as a library path
+  #so that swc files can be dropped in lib
+  #and automatically picked up
+  t.library_path              << "#{model.lib_dir}"
+end
+
+############################################
+# Compile test harness using mxmlc
+
+desc "Compile test harness"
+mxmlc model.test_output => [:asunit3, :corelib] do |t|
+# Uncomment to use the Flex 3 SDK
+  t.gem_name                  = 'sprout-flex3sdk-tool'
+  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
+
+############################################
+# Build documentation for your application
+
+desc "Create documentation"
+asdoc model.doc_dir => model.test_output do |t|
+# Uncomment to use the Flex 3 SDK
+  t.gem_name                  = 'sprout-flex3sdk-tool'
+end

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

@@ -0,0 +1,170 @@
+require 'rexml/document'
+require 'rexml/element'
+require "erb"
+
+ERR_NO_TEMPLATE = "The template class does not exist.";
+ERR_NO_FONT_XML = "The font definition XML document does not exist.";
+
+task :fonts do |t|
+  
+  #folder for font definition files and for automatically
+  #generated class files
+  font_dir                      =  File.join( "embed", "fonts" );
+  
+  #path to erb template directory
+  template_dir                  =  File.join( "embed", "template" );
+  
+  #directory where compiled swf files containing the fonts
+  #will be generated
+  font_output_dir               = File.join( "deploy", "assets", "fonts" );
+  
+  #path to the template class file
+  font_template                 = File.join( template_dir, "FontTemplate.as" );
+  
+  #path to the XML document declaring which fonts should
+  #be embedded per locale
+  font_definition_document      = File.join( font_dir, "fonts.xml" );
+  
+  #path to write the converted xml document to
+  font_runtime_document = File.join( "deploy", "assets", "xml", "fonts.xml" );
+  
+  #a pattern to replace using gsub on the output file
+  #path before the path is written to the output
+  #xml document
+  movie_path_pattern = /^deploy\//
+  
+  movie_output_file = nil;
+  
+  #array of font groups
+  groups = [];
+  
+  #get the XML document
+  file = File.new( font_definition_document )
+  
+  if !File.exists?( file )
+    puts ERR_NO_FONT_XML;
+    exit( 1 );
+  end
+  
+  template = File.new( font_template )
+  
+  if !File.exists?( file )
+    puts ERR_NO_TEMPLATE;
+    exit( 1 );
+  end  
+  
+  #now read in the template file
+  fp = File.open( font_template );
+  contents = fp.read();
+  fp.close();  
+  
+  #start the XML parsing
+  doc = REXML::Document.new( file )
+  
+  #convert the document to an object structure
+  doc.elements.each( "TypeFaceManager/TypeFaceGroup" ) { |element|
+    group = { :lang => element.attributes["lang"], :fonts => [] };
+    
+      
+    output_movie_name = group[:lang] + ".swf";
+    movie_output_file = File.join( font_output_dir, output_movie_name );    
+    
+    path_element = REXML::Element.new( "path" );
+    path_element.add_text( movie_output_file.gsub( movie_path_pattern, "" ) );
+    
+    element.add_element( path_element );    
+    
+    element.each_element( "TypeFace" ) { |font_element|
+      font = { :id => font_element.attributes["id"] }
+      
+      #has an embed elements been declared
+      has_embed = ( font_element.get_elements("Embed").length > 0 );
+      
+      if has_embed
+        font[:source] =
+          font_element.get_elements("Embed/source")[ 0 ].get_text();
+        font[:fontFamily] =
+          font_element.get_elements("Embed/fontFamily")[ 0 ].get_text();
+        font[:fontWeight] =
+          font_element.get_elements("Embed/fontWeight")[ 0 ].get_text();
+        font[:mimeType] =
+          font_element.get_elements("Embed/mimeType")[ 0 ].get_text();  
+        font[:unicodeRange] =
+          font_element.get_elements("Embed/unicodeRange")[ 0 ].get_text();
+        font[:variable] =
+          font_element.get_elements("Embed/variable")[ 0 ].get_text();
+          
+        #only push the font onto the group list if this typeface
+        #is being embedded
+        group[:fonts].push( font );
+      end
+      
+      styles = font_element.get_elements("TypeFaceStyles/TypeFaceStyle");
+      
+      #add the correct text format font attribute
+      #which points to the fontFamily when embedding
+      #for all declared text formated
+      styles.each do |style|
+        
+        #this typeface has no embed declaration
+        #output a warning if no font element has been declared
+        #for the styles associated with the typeface
+        if !has_embed
+          has_style_font = ( style.get_elements("font").length > 0 );
+          
+          if !has_style_font
+            puts "Warning: a style for a non-embedded typeface has no font element."
+          end
+          
+        end
+        
+        style.add_element(
+          REXML::Element.new("font").add_text(font[:fontFamily] ) );
+      end
+      
+      #we're done with the Embed element at this point
+      #so remove it
+      font_element.delete_element( "Embed" );
+    }
+    
+    groups.push( group );
+  }
+  
+  #loop through all the groups
+  groups.each do |group|
+  
+    #set up the instance variables to
+    #be used for the template ERB parsing
+    @fontClassName = "TypeFaceGroup_" + group[:lang];
+  	sym = "@group".intern;
+  	instance_variable_set( sym, group );
+  	
+  	#set up the ERB instance using the template
+  	#previously loaded
+    erb = ERB.new <<-EOF
+#{contents}
+    EOF
+  	
+  	#now do the erb template parsing
+    result = erb.result( binding );
+    
+    #now write the parsed class file for the font group
+    output_file = File.join( font_dir, @fontClassName + ".as" );
+    fp = open( output_file, "w+" );
+    fp.write( result );
+    fp.close();
+    
+    #write out the modified xml document
+    fp = open( font_runtime_document, "w+" );
+    fp.write( doc.to_s() );
+    fp.close();
+    
+    #now compile the swf
+    compile_result = exec( "mxmlc #{output_file} -o #{movie_output_file}" );
+  	
+  	#output the result for compiling the swf movie
+  	puts "#{compile_result}"
+  	
+  end
+  
+end

data/lib/sprout/generators/suite/suite_generator.rb

@@ -0,0 +1,17 @@
+
+# Generate a new ActionScript 3.0 test suite
+# This generator can be executed as follows:
+# 
+#   sprout -n as3 SomeProject
+#   cd SomeProject
+#   script/generator suite
+#
+class SuiteGenerator < Sprout::Generator::NamedBase # :nodoc:
+
+  def manifest
+    record do |m|
+      m.template 'TestSuite.as', File.join(test_dir, 'AllTests.as')
+    end
+  end
+  
+end

data/lib/sprout/generators/suite/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/test/USAGE

@@ -0,0 +1,37 @@
+Description:
+    Stubs out a new ActionScript test case that depends on the AsUnit framework.
+
+	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:
+	
+	    Test Case:		test/utils/MathUtilTest.as

data/lib/sprout/generators/test/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/test/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/test/test_generator.rb

@@ -0,0 +1,20 @@
+
+# Generate a new ActionScript 3.0 TestCase and rebuild the test suites.
+# This generator can be executed as follows:
+# 
+#   sprout -n as3 SomeProject
+#   cd SomeProject
+#   script/generator test utils.MathUtilTest
+#
+class TestGenerator < Sprout::Generator::NamedBase # :nodoc:
+
+  def manifest
+    record do |m|
+      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/tasks/asdoc_doc.rb

@@ -0,0 +1,155 @@
+module Sprout
+class AsDocTask < ToolTask
+# Sets the file encoding for ActionScript files. For more information see: http://livedocs.adobe.com/flex/2/docs/00001503.html#149244
+def actionscript_file_encoding=(string)
+  @actionscript_file_encoding = string
+end
+
+# Prints detailed compile times to the standard output. The default value is true.
+def benchmark=(boolean)
+  @benchmark = boolean
+end
+
+# A list of classes to document. These classes must be in the source path. This is the default option.
+# 
+# This option works the same way as does the -include-classes option for the compc component compiler. For more information, see Using the component compiler (http://livedocs.adobe.com/flex/201/html/compilers_123_31.html#162910).
+def doc_classes=(strings)
+  @doc_classes = strings
+end
+
+# A list of URIs whose classes should be documented. The classes must be in the source path.
+# 
+# You must include a URI and the location of the manifest file that defines the contents of this namespace.
+# 
+# This option works the same way as does the -include-namespaces option for the compc component compiler. For more information, see Using the component compiler. (http://livedocs.adobe.com/flex/201/html/compilers_123_31.html#162910)
+def doc_namespaces=(strings)
+  @doc_namespaces = strings
+end
+
+# A list of files that should be documented. If a directory name is in the list, it is recursively searched.
+# 
+# This option works the same way as does the -include-sources option for the compc component compiler. For more information, see Using the component compiler (http://livedocs.adobe.com/flex/201/html/compilers_123_31.html#162910).
+def doc_sources=(paths)
+  @doc_sources = paths
+end
+
+# A list of classes that should not be documented. You must specify individual class names. Alternatively, if the ASDoc comment for the class contains the @private tag, is not documented.
+def exclude_classes=(string)
+  @exclude_classes = string
+end
+
+# Whether all dependencies found by the compiler are documented. If true, the dependencies of the input classes are not documented.
+# 
+# The default value is false.
+def exclude_dependencies=(boolean)
+  @exclude_dependencies = boolean
+end
+
+# The text that appears at the bottom of the HTML pages in the output documentation.
+def footer=(string)
+  @footer = string
+end
+
+# An integer that changes the width of the left frameset of the documentation. You can change this size to accommodate the length of your package names.
+# 
+# The default value is 210 pixels.
+def left_frameset_width=(number)
+  @left_frameset_width = number
+end
+
+# Links SWC files to the resulting application SWF file. The compiler only links in those classes for the SWC file that are required.
+# 
+# The default value of the library-path option includes all SWC files in the libs directory and the current locale. These are required.
+# 
+# To point to individual classes or packages rather than entire SWC files, use the source-path option.
+# 
+# If you set the value of the library-path as an option of the command-line compiler, you must also explicitly add the framework.swc and locale SWC files. Your new entry is not appended to the library-path but replaces it.
+# 
+# You can use the += operator to append the new argument to the list of existing SWC files.
+# 
+# In a configuration file, you can set the append attribute of the library-path tag to true to indicate that the values should be appended to the library path rather than replace it.
+def library_path=(files)
+  @library_path = files
+end
+
+# Specifies the location of the configuration file that defines compiler options.
+# 
+# If you specify a configuration file, you can override individual options by setting them on the command line.
+# 
+# All relative paths in the configuration file are relative to the location of the configuration file itself.
+# 
+# Use the += operator to chain this configuration file to other configuration files.
+# 
+# For more information on using configuration files to provide options to the command-line compilers, see About configuration files (http://livedocs.adobe.com/flex/2/docs/00001490.html#138195).
+def load_config=(file)
+  @load_config = file
+end
+
+# The text that appears at the top of the HTML pages in the output documentation.
+# 
+# The default value is "API Documentation".
+def main_title=(string)
+  @main_title = string
+end
+
+# Not sure about this option, it was in the CLI help, but not documented on the Adobe site
+def namespace=(string)
+  @namespace = string
+end
+
+# The output directory for the generated documentation. The default value is "doc".
+def output=(path)
+  @output = path
+end
+
+# The descriptions to use when describing a package in the documentation. You can specify more than one package option.
+# 
+# The following example adds two package descriptions to the output:
+# asdoc -doc-sources my_dir -output myDoc -package com.my.business "Contains business classes and interfaces" -package com.my.commands "Contains command base classes and interfaces"
+def package=(string)
+  @package = string
+end
+
+# Adds directories or files to the source path. The Flex compiler searches directories in the source path for MXML or AS source files that are used in your Flex applications and includes those that are required at compile time.
+# 
+# You can use wildcards to include all files and subdirectories of a directory.
+# 
+# To link an entire library SWC file and not individual classes or directories, use the library-path option.
+# 
+# The source path is also used as the search path for the component compiler's include-classes and include-resource-bundles options.
+# 
+# You can also use the += operator to append the new argument to the list of existing source path entries.
+def source_path=(paths)
+  @source_path = paths
+end
+
+# Prints undefined property and function calls; also performs compile-time type checking on assignments and options supplied to method calls.
+# 
+# The default value is true.
+# 
+# For more information about viewing warnings and errors, see Viewing warnings and errors (http://livedocs.adobe.com/flex/2/docs/00001517.html#182413).
+def strict=(boolean)
+  @strict = boolean
+end
+
+# The path to the ASDoc template directory. The default is the asdoc/templates directory in the ASDoc installation directory. This directory contains all the HTML, CSS, XSL, and image files used for generating the output.
+def templates_path=(paths)
+  @templates_path = paths
+end
+
+# Enables all warnings. Set to false to disable all warnings. This option overrides the warn-warning_type options.
+# 
+# The default value is true.
+def warnings=(boolean)
+  @warnings = boolean
+end
+
+# The text that appears in the browser window in the output documentation.
+# 
+# The default value is "API Documentation".
+def window_title=(string)
+  @window_title = string
+end
+
+end
+end