sprout-as3-puremvc-bundle 0.1.0

data/lib/sprout/tasks/asdoc_rdoc.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

@@ -0,0 +1,276 @@
+
+
+module Sprout
+  #
+  # 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:
+  #
+  #   # Create a remote library dependency on the corelib swc.
+  #   library :corelib
+  # 
+  #   # Alias the compilation task with one that is easier to type
+  #   # task :compile => 'SomeProject.swf'
+  #
+  #   # Create an MXMLCTask named for the output file that it creates. This task depends on the
+  #   # corelib library and will automatically add the corelib.swc to it's library_path
+  #   mxmlc 'bin/SomeProject.swf' => :corelib do |t|
+  #     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'
+  #
+  # 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.
+  #
+  # 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
+
+def asdoc(args, &block)
+  Sprout::AsDocTask.define_task(args, &block)
+end
+

data/lib/sprout/tasks/asunit_task.rb

@@ -0,0 +1,148 @@
+=begin
+Copyright (c) 2007 Pattern Park
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+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.
+=end
+
+module Rake # :nodoc:
+  class Tasks # :nodoc:
+
+    # Override Rake::Task.actions so that we can
+    # pull them from our dependent tasks
+    def actions
+      @actions
+    end
+  end
+
+end
+
+module Sprout
+  class AsUnitError < StandardError # :nodoc:
+  end
+
+  # This task does not yet work!
+  # The AsUnitTask provides a shortcut to compiling a test harness
+  # directly from a related MXMLCTask. The first prerequisite
+  # that is an MXMLCTask or MTASCTask will be copied and modified
+  # to generate a test swf using ProjectModel.instance.test_dir
+  # and the AsUnit library gem.
+  #
+  #   mxmlc 'bin/SomeProject.swf' => :corelib do |t|
+  #     t.input = 'src/SomeProject.as'
+  #   end
+  #  
+  #   asunit :test => 'bin/SomeProject.swf'
+  #
+  class AsUnitTask < Rake::FileTask # :nodoc:
+    attr_accessor :input
+    attr_accessor :output
+    attr_accessor :asunit_gem
+    attr_accessor :source_path
+
+=begin
+    def initialize(name, app) # :nodoc:
+      super
+      @asunit_gem = :asunit3
+      @spawned = []
+      @source_path = []
+    end
+    
+    def self.define_task(args, &block)
+      t = super
+      yield t if block_given?
+      t.define
+      return t
+    end
+    
+    def define
+      puts ">> DEFINE CALLED with: #{prerequisites.size}"
+      library @asunit_gem
+      
+      reqs = prerequisites.dup
+      req = nil
+      reqs.each_index do |index|
+        req = reqs[index]
+        puts "req: #{req}"
+        t = get_task_instance(req)
+        if(is_mxmlc?(t))
+          spawn_mxmlc_task(t)
+          reqs.slice!(index)
+        end
+      end
+
+      @spawned.each do |req|
+        @prerequisites << req
+      end
+
+      @spawned = []
+    end
+    
+    def get_spawned_task_name
+      
+    end
+    
+    def spawn_mxmlc_task(task)
+      puts "SPAWNING MXMLC TASK"
+      cloned = task.dup
+      task.actions.each do |action|
+        cloned.actions << action
+      end
+#      cloned.name = 'bin/SomeProjectRunner.swf'
+      cloned.input = 'src/SomeProjectRunner.as'
+      cloned.output = 'bin/SomeProjectRunner.swf'
+      cloned.prerequisites << asunit_gem
+      cloned.define
+
+      source_path.each do |path|
+        cloned.source_path << path
+      end
+      
+      @spawned << cloned
+    end
+    
+    # Alias for source_path so that MTASCTasks can also use this feature
+    def class_path=(path)
+      @source_path = path
+    end
+    
+    def class_path
+      return self.source_path
+    end
+    
+    def is_mxmlc?(task)
+      task.is_a?(MXMLCTask)
+    end
+    
+    def get_task_instance(name)
+      Rake::application[name]
+    end
+
+    def execute(*args)
+      puts ">> asunit task"
+#      FileUtils.touch(name)
+    end
+=end
+
+  end
+end
+
+def asunit(args, &block)
+  Sprout::AsUnitTask.define_task(args, &block)
+end