sprout-as3-bundle 0.1.34 → 0.1.37

data/lib/sprout/as3/version.rb

@@ -3,7 +3,7 @@ module Sprout # :nodoc:
     module VERSION #:nodoc:
       MAJOR = 0
       MINOR = 1
-      TINY  = 34
+      TINY  = 37
 
       STRING = [MAJOR, MINOR, TINY].join('.')
       MAJOR_MINOR = [MAJOR, MINOR].join('.')

data/lib/sprout/as3_tasks.rb

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

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

@@ -13,6 +13,7 @@ Sprout::ProjectModel.setup do |model|
   # model.swc_dir       = 'lib'
   # model.bin_dir       = 'bin'
   # model.test_dir      = 'test'
+  # model.doc_dir       = 'doc'
   # model.asset_dir     = 'assets'
   model.language      = 'as3'
   model.output        = "#{model.bin_dir}/<%= project_name %>.swf"
@@ -90,3 +91,9 @@ mxmlc model.test_output => [:asunit3, :corelib] do |t|
   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.output

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

data/lib/sprout/tasks/asdoc_task.rb

@@ -2,15 +2,10 @@
 
 module Sprout
   #
-  # *NOTE:* The AsDoc task has not yet been built, please let us know[http://groups.google.com/group/projectsprouts] if you're interested in contributing!
-  # http://livedocs.adobe.com/flex/201/html/wwhelp/wwhimpl/common/html/wwhelp.htm?context=LiveDocs_Book_Parts&file=asdoc_127_9.html#142061
-  #
-  # The AsDoc Task will provide Rake support for the asdoc documentation engine.
-  # The main idea behind this task is that one would simply name it after
-  # the documentation directory, and set an Sprout::MXMLCTask as a prerequisite.
-  # Then AsDoc should grab all of the compiler settings from the MXMLCTask and 
-  # generate the documentation as expected. Of course any parameters set directly
-  # would override what is found from the compiler task.
+  # The AsDoc Task provides Rake support for the asdoc documentation engine.
+  # If a Sprout::MXMLCTask or Sprout::COMPCTask are found as prerequisites
+  # to the AsDoc task, AsDoc will inherit the source_path and library_path
+  # from those tasks. You can also configure AsDoc normally if you wish.
   #
   # This configuration might look something like this:
   #
@@ -26,14 +21,256 @@ module Sprout
   #     t.input                     = 'src/SomeProject.as'
   #     t.default_size              = '800 600'
   #     t.default_background_color  = "#FFFFFF"
+  #     t.source_path               << 'src'
+  #     t.source_path               << 'lib/asunit'
+  #     t.source_path               << 'test'
   #   end
   #
   #   desc "Generate documentation"
-  #   asdoc 'doc' => 'bin/SomeProject.swf'
+  #   asdoc :doc => 'bin/SomeProject.swf'
   #
-  # This would then generate documentation in the relative path, 'doc', but only if
-  # The contents of the documentation directory werer older than the sources referenced by the compiler.
+  # This configuration will generate documentation in the relative path, 'doc', but only if
+  # The contents of the documentation directory are older than the sources referenced by the compiler.
   #
-  class AsDocTask < MXMLCTask
+  # For more information about using the asdoc command line compiler, check livedocs at:
+  # http://livedocs.adobe.com/flex/201/html/wwhelp/wwhimpl/common/html/wwhelp.htm?context=LiveDocs_Book_Parts&file=asdoc_127_1.html
+  # 
+  class AsDocTask < ToolTask
+
+    def initialize_task
+      super
+      @default_gem_name = 'sprout-flex2sdk-tool'
+      @default_gem_path = 'bin/asdoc'
+
+      add_param(:actionscript_file_encoding, :string) do |p|
+        p.description = "Sets the file encoding for ActionScript files. For more information see: http://livedocs.adobe.com/flex/2/docs/00001503.html#149244"
+      end
+
+      add_param(:benchmark, :boolean) do |p|
+        p.value = true
+        p.show_on_false = true
+        p.description = "Prints detailed compile times to the standard output. The default value is true."
+      end
+
+      add_param(:doc_classes, :strings) do |p|
+        p.description =<<EOF
+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).
+EOF
+      end
+    
+      add_param(:doc_namespaces, :strings) do |p|
+        p.description =<<EOF
+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)
+EOF
+      end
+
+      add_param(:doc_sources, :paths) do |p|
+        p.description =<<EOF
+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).
+EOF
+      end
+
+      add_param(:exclude_classes, :string) do |p|
+        p.description =<<EOF
+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.
+EOF
+      end
+
+      add_param(:exclude_dependencies, :boolean) do |p|
+        p.description =<<EOF
+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.
+EOF
+      end
+
+      add_param(:footer, :string) do |p|
+        p.description =<<EOF
+The text that appears at the bottom of the HTML pages in the output documentation.
+EOF
+      end
+
+      add_param(:left_frameset_width, :number) do |p|
+        p.description =<<EOF
+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.
+EOF
+      end
+
+      add_param(:library_path, :files) do |p|
+        p.description =<<EOF
+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.
+EOF
+      end
+
+      add_param(:load_config, :file) do |p|
+        p.description =<<EOF
+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).
+EOF
+      end
+
+      add_param(:main_title, :string) do |p|
+        p.description =<<EOF
+The text that appears at the top of the HTML pages in the output documentation.
+
+The default value is "API Documentation".
+EOF
+      end
+
+      add_param(:namespace, :string) do |p|
+        p.description =<<EOF
+Not sure about this option, it was in the CLI help, but not documented on the Adobe site
+EOF
+      end
+
+      add_param(:output, :path) do |p|
+        p.value = 'doc'
+        p.description =<<EOF
+The output directory for the generated documentation. The default value is "doc".
+EOF
+      end
+
+      add_param(:package, :string) do |p|
+        p.description =<<EOF
+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"
+EOF
+      end
+
+      add_param(:source_path, :paths) do |p|
+        p.description =<<EOF
+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.
+EOF
+      end
+
+      add_param(:strict, :boolean) do |p|
+        p.value = true
+        p.show_on_false = true
+        p.description =<<EOF
+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).
+EOF
+      end
+
+      add_param(:templates_path, :paths) do |p|
+        p.description =<<EOF
+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.
+EOF
+      end
+
+      add_param(:warnings, :boolean) do |p|
+        p.description =<<EOF
+Enables all warnings. Set to false to disable all warnings. This option overrides the warn-warning_type options.
+
+The default value is true.
+EOF
+      end
+
+      add_param(:window_title, :string) do |p|
+        p.description =<<EOF
+The text that appears in the browser window in the output documentation.
+
+The default value is "API Documentation".
+EOF
+      end
+    end
+
+    def define # :nodoc:
+      super
+      validate_templates
+      CLEAN.add(output)
+    end
+    
+    def prepare
+      super
+      prerequisite = nil
+      @prerequisites.each do |req|
+        prerequisite = @application[req]
+        if(prerequisite.is_a?(MXMLCTask))
+          prerequisite.source_path.each do |path|
+            doc_sources << path
+          end
+          prerequisite.library_path.each do |path|
+            library_path << path
+          end
+        end
+      end
+    end
+    
+    protected
+    
+    def validate_templates
+      if(templates_path.size == 0)
+        templates_dir = Sprout.get_executable(gem_name, 'asdoc/templates', gem_version)
+        templates_path << templates_dir
+      end
+    end
+    
+    def execute(*args)
+      update_helper_mode
+      begin
+        super
+      rescue ExecutionError => e
+        if(e.message.index('Warning:'))
+          # MXMLC sends warnings to stderr....
+          Log.puts(e.message.gsub('[ERROR]', '[WARNING]'))
+        else
+          raise e
+        end
+      end
+    end
+    
+    # The AsDoc packaage includes an asDocHelper binary that is packaged up without
+    # the executable flag, calling Sprout::get_executable with this target will
+    # automatically chmod it to 744.
+    def update_helper_mode
+      exe = Sprout.get_executable('sprout-flex2sdk-tool', 'asdoc/templates/asDocHelper', gem_version)
+    end
+
   end
-end
+end
+
+def asdoc(args, &block)
+  Sprout::AsDocTask.define_task(args, &block)
+end
+

data/lib/sprout/tasks/compc_doc.rb

@@ -480,29 +480,64 @@ def input=(file)
   @input = file
 end
 
+# Outputs the SWC file in an open directory format rather than a SWC file. You use this option with the output option to specify a destination directory, as the following example shows:
+# compc -directory -output destination_directory
+# 
+# You use this option when you create RSLs. For more information, see Using Runtime Shared Libraries (http://livedocs.adobe.com/flex/201/html/rsl_124_1.html#168690).
+def directory=(boolean)
+  @directory = boolean
+end
+
+# Specifies classes to include in the SWC file. You provide the class name (for example, MyClass) rather than the file name (for example, MyClass.as) to the file for this option. As a result, all classes specified with this option must be in the compiler's source path. You specify this by using the source-path compiler option.
+# 
+# You can use packaged and unpackaged classes. To use components in namespaces, use the include-namespaces option.
+# 
+# If the components are in packages, ensure that you use dot-notation rather than slashes to separate package levels.
+# 
+# This is the default option for the component compiler.
 def include_classes=(symbols)
   @include_classes = symbols
 end
 
-def include_file=(file)
-  @include_file = file
+# Adds the file to the SWC file. This option does not embed files inside the library.swf file. This is useful for skinning and theming, where you want to add non-compiled files that can be referenced in a style sheet or embedded as assets in MXML files.
+# 
+# If you use the [Embed] syntax to add a resource to your application, you are not required to use this option to also link it into the SWC file.
+# 
+# For more information, see Adding nonsource classes (http://livedocs.adobe.com/flex/201/html/compilers_123_39.html#158900).
+def include_file=(files)
+  @include_file = files
 end
 
+# 
 def include_lookup_only=(boolean)
   @include_lookup_only = boolean
 end
 
+# Specifies namespace-style components in the SWC file. You specify a list of URIs to include in the SWC file. The uri argument must already be defined with the namespace option.
+# 
+# To use components in packages, use the include-classes option.
 def include_namespaces=(urls)
   @include_namespaces = urls
 end
 
+# Specifies the resource bundles to include in this SWC file. All resource bundles specified with this option must be in the compiler's source path. You specify this using the source-path compiler option.
+# 
+# For more information on using resource bundles, see Localizing Flex Applications (http://livedocs.adobe.com/flex/201/html/l10n_076_1.html#129288) in Flex 2 Developer's Guide.
 def include_resource_bundles=(files)
   @include_resource_bundles = files
 end
 
+# Specifies classes or directories to add to the SWC file. When specifying classes, you specify the path to the class file (for example, MyClass.as) rather than the class name itself (for example, MyClass). This lets you add classes to the SWC file that are not in the source path. In general, though, use the include-classes option, which lets you add classes that are in the source path.
+# 
+# If you specify a directory, this option includes all files with an MXML or AS extension, and ignores all other files.
 def include_sources=(paths)
   @include_sources = paths
 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
+
 end
 end

data/lib/sprout/tasks/compc_task.rb

@@ -19,48 +19,6 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-Example compile directive from Mike Chambers at:
-http://www.mikechambers.com/blog/2006/05/19/quick-example-using-compc-to-compile-swcs/
-
-compc -namespace http://www.adobe.com/2006/foo manifest.xml -source-path .
-  -include-namespaces http://www.adobe.com/2006/foo -include-classes mx.containers.MyWindow
-  -include-file MyWindow.png mx/containers/MyWindow.png
-  -output='MyWindow.swc'
-
-manifext.xml file:
-<?xml version="1.0"?>
-<componentPackage>
-  <component id="MyWindow" class="mx.containers.MyWindow"/>
-</componentPackage>
-
-------------------------------
-
-Following is a diff of advanced options between compc and mxmlc:
-
-diff compc.advanced mxmlc.advanced 
-1c1
-< Adobe Flex Compiler (compc)
----
-> Adobe Flex Compiler (mxmlc)
-82d81
-< -directory
-87,92d85
-< -include-classes [class] [...]
-< -include-file <name> <path>
-< -include-lookup-only
-< -include-namespaces [uri] [...]
-< -include-resource-bundles [bundle] [...]
-< -include-sources [path-element] [...]
-112a106
-> -warnings
-
-------------------------------
-
-TODO: compc tasks:
- * Autogenerate the manifest based on a directory or FileList
- * Allow manual assignment of the manifest (instead of generated file)
-
 =end
 
 module Sprout
@@ -69,22 +27,94 @@ module Sprout
   class ExecutionError < StandardError #:nodoc:
   end
   
-  # The COMPCTask should work almost identically to the Sprout::MXMLCTask. We haven't 
-  # taken the time to investigate it fully, if you are able to get it working please submit
-  # sample code to the list at: projectsprouts@googlegroups.com
+  # The COMPCTask will emit SWC files that are usually used to easily distribute and include
+  # shared functionality.
+  #
+  # This task represents a superset of the features available to the MXMLCTask.
+  #
+  # A simple COMPC instance is as follows:
+  #
+  #   compc 'bin/SomeLibrary.swc' do |t|
+  #     t.input = 'SomeLibrary' # Class name, not file name
+  #     t.source_path << 'src'
+  #     t.source_path << 'test'
+  #   end
+  # 
   class COMPCTask < MXMLCTask
-    DEFAULT_GEM_NAME = 'sprout-flex2sdk-tool'
-    DEFAULT_GEM_PATH = 'bin/compc'
 
     def initialize_task
       super
-      add_param(:include_classes, :symbols)
+      @default_gem_name = 'sprout-flex2sdk-tool'
+      @default_gem_path = 'bin/compc'
+
+      add_param(:directory, :boolean) do |p|
+        p.hidden_value = true
+        p.description =<<EOF
+Outputs the SWC file in an open directory format rather than a SWC file. You use this option with the output option to specify a destination directory, as the following example shows:
+compc -directory -output destination_directory
+
+You use this option when you create RSLs. For more information, see Using Runtime Shared Libraries (http://livedocs.adobe.com/flex/201/html/rsl_124_1.html#168690).
+EOF
+      end
+
+      add_param(:include_classes, :symbols) do |p|
+        p.description =<<EOF
+Specifies classes to include in the SWC file. You provide the class name (for example, MyClass) rather than the file name (for example, MyClass.as) to the file for this option. As a result, all classes specified with this option must be in the compiler's source path. You specify this by using the source-path compiler option.
+
+You can use packaged and unpackaged classes. To use components in namespaces, use the include-namespaces option.
+
+If the components are in packages, ensure that you use dot-notation rather than slashes to separate package levels.
+
+This is the default option for the component compiler.
+EOF
+      end
+
       add_param_alias(:ic, :include_classes)
-      add_param(:include_file, :file)
-      add_param(:include_lookup_only, :boolean)
-      add_param(:include_namespaces, :urls)
-      add_param(:include_resource_bundles, :files)
-      add_param(:include_sources, :paths)
+
+      add_param(:include_file, :files) do |p|
+        p.description =<<EOF
+Adds the file to the SWC file. This option does not embed files inside the library.swf file. This is useful for skinning and theming, where you want to add non-compiled files that can be referenced in a style sheet or embedded as assets in MXML files.
+
+If you use the [Embed] syntax to add a resource to your application, you are not required to use this option to also link it into the SWC file.
+
+For more information, see Adding nonsource classes (http://livedocs.adobe.com/flex/201/html/compilers_123_39.html#158900).
+EOF
+      end
+
+      add_param(:include_lookup_only, :boolean) do |p|
+        p.description =<<EOF
+EOF
+      end
+
+      add_param(:include_namespaces, :urls) do |p|
+        p.description =<<EOF
+Specifies namespace-style components in the SWC file. You specify a list of URIs to include in the SWC file. The uri argument must already be defined with the namespace option.
+
+To use components in packages, use the include-classes option.
+EOF
+      end
+
+      add_param(:include_resource_bundles, :files) do |p|
+        p.description =<<EOF
+Specifies the resource bundles to include in this SWC file. All resource bundles specified with this option must be in the compiler's source path. You specify this using the source-path compiler option.
+
+For more information on using resource bundles, see Localizing Flex Applications (http://livedocs.adobe.com/flex/201/html/l10n_076_1.html#129288) in Flex 2 Developer's Guide.
+EOF
+      end
+
+      add_param(:include_sources, :paths) do |p|
+        p.description =<<EOF
+Specifies classes or directories to add to the SWC file. When specifying classes, you specify the path to the class file (for example, MyClass.as) rather than the class name itself (for example, MyClass). This lets you add classes to the SWC file that are not in the source path. In general, though, use the include-classes option, which lets you add classes that are in the source path.
+
+If you specify a directory, this option includes all files with an MXML or AS extension, and ignores all other files.
+EOF
+      end
+
+      add_param(:namespace, :string) do |p|
+        p.description =<<EOF
+Not sure about this option, it was in the CLI help, but not documented on the Adobe site
+EOF
+      end
     end
 
     def execute(*args)
@@ -95,6 +125,6 @@ module Sprout
 end
 
 def compc(args, &block)
-  Sprout::MXMLCTask.define_task(args, &block)
+  Sprout::COMPCTask.define_task(args, &block)
 end
 

data/rakefile.rb

@@ -25,6 +25,7 @@ lib_dir = File.dirname(__FILE__) + '/lib'
 
 add_tool(lib_dir + '/sprout/tasks/mxmlc_task.rb', Sprout::MXMLCTask)
 add_tool(lib_dir + '/sprout/tasks/compc_task.rb', Sprout::COMPCTask)
+add_tool(lib_dir + '/sprout/tasks/asdoc_task.rb', Sprout::AsDocTask)
 #########################
 
 PKG_LIST                = FileList['[a-zA-Z]*',
@@ -58,7 +59,7 @@ spec = Gem::Specification.new do |s|
   s.rdoc_options        << '-i'             << '.'
   s.files               = PKG_LIST.to_a
 
-  s.add_dependency('sprout', '>= 0.7.158')
+  s.add_dependency('sprout', '>= 0.7.167')
   s.add_dependency('sprout-flashplayer-bundle')
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sprout-as3-bundle
 version: !ruby/object:Gem::Version 
-  version: 0.1.34
+  version: 0.1.37
 platform: ruby
 authors: 
 - Pattern Park
@@ -9,7 +9,7 @@ autorequire: sprout/as3
 bindir: bin
 cert_chain: []
 
-date: 2008-02-23 00:00:00 -08:00
+date: 2008-02-24 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,7 +19,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.7.158
+        version: 0.7.167
     version: 
 - !ruby/object:Gem::Dependency 
   name: sprout-flashplayer-bundle
@@ -86,6 +86,7 @@ files:
 - lib/sprout/generators/test/test_generator.rb
 - lib/sprout/generators/test/USAGE
 - lib/sprout/tasks
+- lib/sprout/tasks/asdoc_doc.rb
 - lib/sprout/tasks/asdoc_task.rb
 - lib/sprout/tasks/asunit_task.rb
 - lib/sprout/tasks/compc_doc.rb