sprout-as3-bundle 0.2.9 → 1.0.8

data/lib/sprout/tasks/asdoc_task.rb

@@ -227,7 +227,13 @@ EOF
       end
     end
 
+    def exclude_expressions
+      @exclude_expressions ||= []
+    end
+
     def define # :nodoc:
+      apply_exclusions_from_expression unless @exclude_expressions.nil?
+
       super
       validate_templates
       CLEAN.add(output)
@@ -248,7 +254,7 @@ EOF
         end
       end
     end
-    
+
     protected
     
     def validate_templates
@@ -258,7 +264,7 @@ EOF
         templates_path << templates_dir
       end
     end
-    
+
     def execute(*args)
       update_helper_mode
       begin
@@ -291,6 +297,31 @@ EOF
       end
     end
 
+    # Requires that @exclude_expressions is not nil.
+    def apply_exclusions_from_expression
+      FileList[@exclude_expressions].each do |file_path|
+        import_file = remove_source_path_from_file_path(file_path) || file_path
+        import_class = filename_to_import_class(import_file)
+
+        exclude_classes << import_class unless import_class.nil?
+      end
+    end
+
+    def remove_source_path_from_file_path(file)
+        source_path.each do |source_dir|
+          import_file = file.sub(Regexp.new("^#{source_dir}"),"")
+          return import_file if import_file != file
+        end
+        
+        return file
+    end
+
+    def filename_to_import_class(filename)
+      name = filename.scan(/\w+/)
+      # Ignore the AS file extension.
+      name[0..-2].join('.') unless name[-1] != 'as'
+    end
+
   end
 end
 

data/lib/sprout/tasks/fcsh.rb

@@ -0,0 +1,10 @@
+require 'sprout/fcsh_socket'
+
+namespace :fcsh do
+
+  desc "Start FCSH Service"
+  task :start do
+    Sprout::FCSHSocket.server
+  end
+  
+end

data/lib/sprout/tasks/fdb_task.rb

@@ -25,29 +25,132 @@ module Sprout #:nodoc:
   #   end
   #
   # You can also point the FDBTask at HTML pages. These pages will be 
-  # launched in your default browswer. You will need to manually install
+  # launched in your default browser. You will need to manually install
   # a debug Flash Player in that particular browser.
-  # To use a browser instead of the desktop Flash Player, simply point
+  # 
+  # To use a browser instead of the desktop Flash Player, simply point the
   # file argument at an HTML document or remote URL. The SWF file loaded
-  # must be compiled using the -debug flag in order to connect to the 
-  # debugger.
+  # must be compiled using the -debug flag, and executed in a debug Flash Player
+  # in order to connect to properly connect to the debugger.
   #   fdb :debug do |t|
   #     t.file = 'bin/SomeProject-debug.html'
   #     t.run
   #     t.continue
   #   end
   #
+  # .h3 Continuous Integration
+  #
+  # The FDBTask is also the only effective way to execute SWF content
+  # in front of a CI (continuous integration) tool like Cruise Control.
+  # The biggest problem facing SWF execution for CI is uncaught
+  # runtime exceptions. The debug Flash Player throws uncaught exceptions
+  # up to the operating system GUI layer where a user must manually dismiss
+  # a dialog. In addition to blocking the CI process indefinitely, these
+  # messages are also difficult to capture and log. 
+  #
+  # Using Sprouts and the FDBTask, we can capture these messages along
+  # with additonal information (e.g. local variables and a complete stack trace)
+  # about the state of the SWF file, and then cleanly exit the Flash Player
+  # and log this information.
+  #
+  # The FDBTask has also been configured to work with the ASUnit XMLPrinter
+  # so that an XML artifact is created and written to disk that includes
+  # the results of running your test suites.
+  # 
+  # To use FDB with a CI tool do the following:
+  #
+  # 1) Create a new base runner class (we usually name this XMLRunner.as)
+  # and make it look like the following:
+  #
+  #   package {
+  #     import asunit.textui.TestRunner;
+  #     import asunit.textui.XMLResultPrinter;
+  # 
+  #     public class XMLRunner extends TestRunner {
+  # 
+  #       public function XMLRunner() {
+  #         setPrinter(new XMLResultPrinter());
+  #         start(AllTests, null, TestRunner.SHOW_TRACE);
+  #       }
+  #     }
+  #   }
+  #
+  # 2) Create a new MXMLCTask to compile the newly created runner.
+  # NOTE: Be sure you set +debug+ to true, otherwise the SWF will
+  # not connect to the debugger properly.
+  #
+  #   library :asunit3
+  #
+  #   desc 'Compile the CI SWF'
+  #   mxmlc 'bin/XMLRunner.swf' => :asunit3 do |t|
+  #     t.input = 'src/XMLRunner.as'
+  #     t.debug = true
+  #     t.source_path << 'test'
+  #     # Add additional configuration here.
+  #   end
+  #
+  # 3) Create a new FDBTask and set +kill_on_fault+ to true.
+  #
+  #   desc 'Execute the test harness for CI'
+  #   fdb :cruise do |t|
+  #     t.kill_on_fault = true
+  #     t.file = 'bin/XMLRunner.swf'
+  #     t.run
+  #     t.continue
+  #   end
+  #
+  # 4) Configure your CI task to call:
+  # 
+  #   rake cruise
+  #
+  # 5) That's it!
+  #
   class FDBTask < ToolTask
-    # The SWF file to debug.
-    attr_accessor :swf
+    TEST_RESULT_PRELUDE = '<XMLResultPrinter>'
+    TEST_RESULT_CLOSING = '</XMLResultPrinter>'
+    TEST_RESULT_FILE    = 'AsUnitResults.xml'
+    
+    # Relative or absolute path to where unit test results
+    # should be written to disk.
+    # This field can be used in conjunction with the AsUnit
+    # XMLResultPrinter which will trace out JUnit style XML 
+    # test results.
+    # By telling fdb where to write those test results, it
+    # will scan the trace output stream looking for +test_result_prelude+,
+    # and +test_result_closing+. Once the closing is encountered, the
+    # prelude and closing (and everything in between) will be written
+    # to disk in the file identified by +test_result_file+, and fdb
+    # will be closed down.
+    attr_writer :test_result_file
+
+    # String that indicates the beginning of printable test results
+    # Default value is '<XMLResultPrinter>'
+    attr_writer :test_result_prelude
+
+    # String that indicates the closing of printable test results
+    # Default value is '</XMLResultPrinter>'
+    # See test_result_prelude for more info.
+    attr_writer :test_result_closing
+
+    # Boolean value that tells fdb whether or not it should automatically
+    # shut down when an exception is encountered. This feature is used to
+    # prevent GUI prompts for unhandled exceptions, especially when running
+    # a test harness under a continuous integration tool - like cruise control.
+    # If an exception is encountered, fdb will automatically print the exception,
+    # a full stack trace and all local variables in the function where the failure 
+    # occured.
+    attr_writer :kill_on_fault
 
     def initialize_task # :nodoc:
       @default_gem_name = 'sprout-flex3sdk-tool'
       @default_gem_path = 'bin/fdb'
+      @kill_on_fault = false
       @queue = []
     end
 
     def define # :nodoc:
+      super
+      CLEAN.add(test_result_file)
       self
     end
     
@@ -59,16 +162,35 @@ module Sprout #:nodoc:
       @stdout ||= $stdout
     end
     
+    def validate_swf(swf)
+      # TODO: Ensure the SWF has been compiled with debugging
+      # turned on.
+      # I believe this will require actually parsing the SWF file and
+      # scanning for the EnableDebugger2 tag.
+      # http://www.adobe.com/devnet/swf/pdf/swf_file_format_spec_v9.pdf
+    end
+    
     def execute(*args) # :nodoc:
-      # TODO: First check the SWF file to ensure that debugging is enabled!
+      # Ensure that if we load a SWF it's been compiled with debugging turned on!
+      file_name = @file
+
+      if(file_name.match(/\.swf$/))
+        validate_swf(file_name)
+      end
+
       buffer = FDBBuffer.new(get_executable, stdout)
+      buffer.test_result_file = test_result_file
+      buffer.test_result_prelude = test_result_prelude
+      buffer.test_result_closing = test_result_closing
+      buffer.kill_on_fault = kill_on_fault?
       buffer.wait_for_prompt
 
       @queue.each do |command|
         handle_command(buffer, command)
       end
 
-      buffer.join
+      buffer.join # wait here until the buffer is closed.
+
       self
     end
     
@@ -95,6 +217,22 @@ module Sprout #:nodoc:
       @queue
     end
     
+    def kill_on_fault?
+      @kill_on_fault
+    end
+    
+    def test_result_file
+      @test_result_file ||= TEST_RESULT_FILE
+    end
+    
+    def test_result_prelude
+      @test_result_prelude ||= TEST_RESULT_PRELUDE
+    end
+    
+    def test_result_closing
+      @test_result_closing ||= TEST_RESULT_CLOSING
+    end
+    
     # Print backtrace of all stack frames
     def bt
       @queue << "bt"
@@ -174,6 +312,12 @@ module Sprout #:nodoc:
     def file=(file)
       @prerequisites << file
       @queue << "file #{file}"
+      @file = file
+    end
+    
+    # alias for self.file=
+    def input=(file)
+      self.file = file
     end
     
     # Execute until current function returns
@@ -303,7 +447,7 @@ module Sprout #:nodoc:
       @queue << "set #{value}"
     end
     
-    # Sleep until some 'str' String is sent to the output
+    # Sleep until some 'str' String is sent to the output,
     def sleep_until(str)
       @queue << "sleep #{str}"
     end
@@ -347,6 +491,11 @@ module Sprout #:nodoc:
   
   # A buffer that provides clean blocking support for the fdb command shell
   class FDBBuffer #:nodoc:
+    attr_accessor :test_result_file
+    attr_accessor :test_result_prelude
+    attr_accessor :test_result_closing
+    attr_writer :kill_on_fault
+
     PLAYER_TERMINATED = 'Player session terminated'
     EXIT_PROMPT = 'The program is running.  Exit anyway? (y or n)'
     PROMPT = '(fdb) '
@@ -363,6 +512,10 @@ module Sprout #:nodoc:
       listen exe
     end
     
+    def kill_on_fault?
+      @kill_on_fault
+    end
+    
     def user_input
       @user_input ||= $stdin
     end
@@ -388,6 +541,9 @@ module Sprout #:nodoc:
           $stdout.puts msg
         end
         
+        @inside_test_result = false
+        full_output = ''
+        test_result = ''
         char = ''
         line = ''
         while true do
@@ -403,14 +559,49 @@ module Sprout #:nodoc:
             line = ''
           else
             line << char
+            full_output << char
+          end
+
+          if(@inside_test_result)
+            test_result << char
+          else
+            @output.print char
+            @output.flush
           end
           
-          @output.print char
-          @output.flush
+          if(!test_result_prelude.nil? && line.index(test_result_prelude))
+            test_result = test_result_prelude
+            @inside_test_result = true
+          end
+          
+          if(@inside_test_result && line.index(test_result_closing))
+            write_test_result(test_result)
+            @inside_test_result = false
+            Thread.new {
+              write("\n")
+              write('y')
+              write('kill')
+              write('y')
+              write('quit')
+            }
+          end
 
           if(line == PROMPT || line.match(/\(y or n\) $/))
-            @prompted = true
+            full_output_cache = full_output
             line = ''
+            full_output = ''
+            @prompted = true
+            if(should_kill?(full_output_cache))
+              Thread.new {
+                wait_for_prompt
+                write('info stack') # Output the full stack trace
+                write('info locals') # Output local variables
+                write('kill') # Kill the running SWF file
+                write('y') # Confirm killing SWF
+                write('quit') # Quit FDB safely
+              }
+            end
+
           elsif(@pending_expression && line.match(/#{@pending_expression}/))
             @found_search = true
             @pending_expression = nil
@@ -424,6 +615,27 @@ module Sprout #:nodoc:
       end
       
     end
+    
+    def should_kill?(message)
+      return (@kill_on_fault && fault_found?(message))
+    end
+    
+    def fault_found?(message)
+      match = message.match(/\[Fault\]\s.*,.*$/) 
+      return !match.nil?
+    end
+    
+    def clean_test_result(result)
+      return result.gsub(/^\[trace\]\s/m, '')
+    end
+    
+    def write_test_result(result)
+      result = clean_test_result result
+      FileUtils.makedirs(File.dirname(test_result_file))
+      File.open(test_result_file, File::CREAT|File::TRUNC|File::RDWR) do |f|
+        f.puts(result)
+      end
+    end
 
     # Block for the life of the input process
     def join
@@ -431,13 +643,13 @@ module Sprout #:nodoc:
       print PROMPT
       $stdout.flush
 
-      Thread.new do
+      t = Thread.new {
         while true do
           msg = user_input.gets.chomp!
           @input.puts msg
           wait_for_prompt
         end
-      end
+      }
 
       @listener.join
     end

data/lib/sprout/tasks/mxmlc_ci.rb

@@ -0,0 +1,62 @@
+
+module Sprout
+
+  
+  # The MXMLCCruise helper wraps up the fdb and mxmlc unit test tasks by
+  # using either a Singleton or provided ProjectModel instance.
+  #
+  # The simple case that uses a Singleton ProjectModel:
+  #   ci :cruise
+  #
+  # Using a specific ProjectModel instance:
+  #   project_model :model
+  #
+  #   ci :cruise => :model
+  #
+  # Configuring the proxied MXMLCTask
+  #   ci :cruise do |t|
+  #     t.link_report = 'LinkReport.rpt'
+  #   end
+  #
+  class MXMLCCruise < MXMLCHelper
+
+    def initialize(args, &block)
+      super
+      library :asunit3
+      
+      mxmlc output do |t|
+        configure_mxmlc t
+        configure_mxmlc_application t
+        t.debug = true
+        t.prerequisites << :asunit3
+        t.source_path << model.test_dir
+        
+        if(model.test_width && model.test_height)
+          t.default_size = "#{model.test_width} #{model.test_height}"
+        end
+
+        yield t if block_given?
+      end
+
+      define_fdb
+      t = define_outer_task
+      t.prerequisites << output
+      t.prerequisites << player_task_name
+    end
+    
+    def create_output
+      return "#{create_output_base}XMLRunner.swf"
+    end
+
+    def create_input
+      input = super
+      input.gsub!(/#{input_extension}$/, "XMLRunner#{input_extension}") 
+      return input
+    end
+  
+  end
+end
+
+def ci(args, &block)
+  return Sprout::MXMLCCruise.new(args, &block)
+end

data/lib/sprout/tasks/mxmlc_helper.rb

@@ -3,6 +3,8 @@ module Sprout # :nodoc:
   class MXMLCHelper # :nodoc:
     attr_reader :model
     
+    attr_accessor :use_fcsh
+    
     def initialize(args, &block)
       resolve_task_args(args)
       @model = get_model args
@@ -51,9 +53,13 @@ module Sprout # :nodoc:
     end
     
     def configure_mxmlc(compiler, is_asdoc=false)
-      compiler.input                    = input unless is_asdoc
-      compiler.gem_name                 = model.compiler_gem_name
-      compiler.gem_version              = model.compiler_gem_version
+      if(!is_asdoc)
+        compiler.input       = input
+        compiler.use_fcsh    = use_fcsh || model.use_fcsh
+      end
+
+      compiler.gem_name    = model.compiler_gem_name
+      compiler.gem_version = model.compiler_gem_version
 
       # Set up library deps
       model.libraries.each do |lib|
@@ -94,6 +100,15 @@ module Sprout # :nodoc:
       end
     end
     
+    def define_fdb
+      fdb player_task_name do |t|
+        t.file = output_file
+        t.kill_on_fault = true
+        t.run
+        t.continue
+      end
+    end
+    
     def define_outer_task
       t = task task_name
       self.prerequisites.each do |dep|

data/lib/sprout/tasks/mxmlc_task.rb

@@ -60,6 +60,11 @@ module Sprout
   #
   class MXMLCTask < ToolTask
     
+    # Use a running instance of the FCSH command shell to speed up compilation.
+    # You need to run 'rake fcsh:start' in another terminal before turning on 
+    # this flag and compiling.
+    attr_accessor :use_fcsh
+
     # Interface and descriptions found here:
     # http://livedocs.adobe.com/flex/2/docs/wwhelp/wwhimpl/common/html/wwhelp.htm?context=LiveDocs_Parts&file=00001481.html
     def initialize_task
@@ -683,13 +688,9 @@ EOF
         end
       end
       
-      if(!input.match(/.css/) && File.exists?(input))
+      if(input && !input.match(/.css/) && File.exists?(input))
         source_path << File.dirname(input)
       end
-
-      if(!input)
-        raise MXMLCError.new('MXMLCTask.input is a required field')
-      end
       
       if(link_report)
         CLEAN.add(link_report)
@@ -743,9 +744,23 @@ EOF
       end
     end
     
+    def execute_with_fcsh(command)
+      begin
+        puts FCSHSocket.execute("mxmlc #{command}")
+      rescue FCSHError => fcsh_error
+        raise fcsh_error
+      rescue StandardError => std_error
+        raise StandardError("[ERROR] There was a problem connecting to the Flex Compiler SHell, run 'rake fcsh:start' in another terminal.")
+      end
+    end
+    
     def execute(*args)
       begin
-        super
+        if(@use_fcsh)
+          execute_with_fcsh(to_shell)
+        else
+          super
+        end
       rescue ExecutionError => e
         if(e.message.index('Warning:'))
           # MXMLC sends warnings to stderr....

data/lib/sprout/tasks/mxmlc_unit.rb

@@ -2,7 +2,7 @@
 module Sprout
 
   
-  # The MXMLCUnit helper wraps up fdb and mxmlc unit test tasks by
+  # The MXMLCUnit helper wraps up flashplayer and mxmlc unit test tasks by
   # using either a Singleton or provided ProjectModel instance.
   #
   # The simple case that uses a Singleton ProjectModel:

data/rakefile.rb

@@ -63,7 +63,8 @@ spec = Gem::Specification.new do |s|
   s.rdoc_options        << '-i'             << '.'
   s.files               = PKG_LIST.to_a
 
-  s.add_dependency('sprout', '>= 0.7.189')
+  s.add_dependency('sprout', '>= 0.7.196')
+  s.add_dependency('sprout-asunit3-library', '>= 3.2.6')
 end
 
 Rake::GemPackageTask.new(spec) do |p|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sprout-as3-bundle
 version: !ruby/object:Gem::Version 
-  version: 0.2.9
+  version: 1.0.8
 platform: ruby
 authors: 
 - Pattern Park
@@ -9,7 +9,7 @@ autorequire: sprout/as3
 bindir: bin
 cert_chain: []
 
-date: 2008-07-19 00:00:00 -07:00
+date: 2009-01-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,17 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.7.189
+        version: 0.7.196
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sprout-asunit3-library
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.2.6
     version: 
 description: Code Generation and Rake Tasks for ActionScript 3.0 Development
 email: projectsprouts@googlegroups.com
@@ -42,6 +52,9 @@ files:
 - lib/sprout/as3/version.rb
 - lib/sprout/as3.rb
 - lib/sprout/as3_tasks.rb
+- lib/sprout/fcsh_lexer.rb
+- lib/sprout/fcsh_service.rb
+- lib/sprout/fcsh_socket.rb
 - lib/sprout/generators
 - lib/sprout/generators/class
 - lib/sprout/generators/class/class_generator.rb
@@ -67,6 +80,7 @@ files:
 - lib/sprout/generators/project/templates/rakefile.rb
 - lib/sprout/generators/project/templates/README.txt
 - lib/sprout/generators/project/templates/TestRunner.as
+- lib/sprout/generators/project/templates/XMLRunner.as
 - lib/sprout/generators/suite
 - lib/sprout/generators/suite/suite_generator.rb
 - lib/sprout/generators/suite/templates
@@ -80,27 +94,23 @@ files:
 - lib/sprout/generators/test/USAGE
 - lib/sprout/tasks
 - lib/sprout/tasks/adl_documentation.rb
-- lib/sprout/tasks/adl_rdoc.rb
 - lib/sprout/tasks/adl_task.rb
 - lib/sprout/tasks/adt_cert_documentation.rb
-- lib/sprout/tasks/adt_cert_rdoc.rb
 - lib/sprout/tasks/adt_documentation.rb
-- lib/sprout/tasks/adt_rdoc.rb
 - lib/sprout/tasks/adt_task.rb
-- lib/sprout/tasks/asdoc_rdoc.rb
+- lib/sprout/tasks/asdoc_documentation.rb
 - lib/sprout/tasks/asdoc_task.rb
 - lib/sprout/tasks/compc_documentation.rb
-- lib/sprout/tasks/compc_rdoc.rb
 - lib/sprout/tasks/compc_task.rb
-- lib/sprout/tasks/fcsh_task.rb
+- lib/sprout/tasks/fcsh.rb
 - lib/sprout/tasks/fdb_task.rb
+- lib/sprout/tasks/mxmlc_ci.rb
 - lib/sprout/tasks/mxmlc_debug.rb
 - lib/sprout/tasks/mxmlc_deploy.rb
 - lib/sprout/tasks/mxmlc_document.rb
 - lib/sprout/tasks/mxmlc_documentation.rb
 - lib/sprout/tasks/mxmlc_flex_builder.rb
 - lib/sprout/tasks/mxmlc_helper.rb
-- lib/sprout/tasks/mxmlc_rdoc.rb
 - lib/sprout/tasks/mxmlc_stylesheet.rb
 - lib/sprout/tasks/mxmlc_swc.rb
 - lib/sprout/tasks/mxmlc_task.rb
@@ -136,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: sprout
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Project and Code Generators for ActionScript 3 Development