sprout-as3-bundle 0.2.9 → 1.0.8

data/lib/sprout/as3/version.rb

@@ -1,9 +1,9 @@
 module Sprout # :nodoc:
   class AS3 # :nodoc:
     module VERSION #:nodoc:
-      MAJOR = 0
-      MINOR = 2
-      TINY  = 9
+      MAJOR = 1
+      MINOR = 0
+      TINY  = 8
 
       STRING = [MAJOR, MINOR, TINY].join('.')
       MAJOR_MINOR = [MAJOR, MINOR].join('.')

data/lib/sprout/as3_tasks.rb

@@ -16,3 +16,6 @@ require 'sprout/tasks/mxmlc_deploy'
 require 'sprout/tasks/mxmlc_document'
 require 'sprout/tasks/mxmlc_stylesheet'
 require 'sprout/tasks/mxmlc_swc'
+require 'sprout/tasks/mxmlc_ci'
+
+require 'sprout/tasks/fcsh'

data/lib/sprout/fcsh_lexer.rb

@@ -0,0 +1,144 @@
+=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 Sprout
+  
+  # This class should allow us to parse the stream output that FCSH provides.
+  # It was largely inspired by "LittleLexer" (http://rubyforge.org/projects/littlelexer/)
+  # which is a beautiful and concise general purpose lexer written by John Carter.
+  # Unfortunately, LittleLexer did not support streamed input, which 
+  # we definitely need.
+  class FCSHLexer
+    PROMPT  = ':prompt'
+    WARNING = ':warning'
+    ERROR   = ':error'
+    PRELUDE = ':prelude'
+
+    PRELUDE_EXPRESSION = /(Adobe Flex Compiler.*\n.*\nCopyright.*\n)/m
+
+    def initialize(out=nil)
+      @out = out || $stdout
+      @regex_to_token = [
+                        [/(.*Warning:.*\^.*)\n/m,   WARNING], # Warning encountered
+                        [/(.*Error:.*\^.*)\n/m,     ERROR], # Error encountered
+                        [PRELUDE_EXPRESSION,        PRELUDE],
+                        [/\n\(fcsh\)/,              PROMPT] # Prompt for input
+                       ]
+    end
+    
+    def scan_process(process_runner)
+      tokens = [];
+      # Collect Errors and Warnings in a way that doesn't
+      # Block forever when we have none....
+      t = Thread.new {
+        scan_stream(process_runner.e) do |token|
+          yield token if block_given?
+          tokens << token
+        end
+      }
+      
+      # Collect stdout from the process:
+      scan_stream(process_runner.r) do |token|
+        yield token if block_given?
+        tokens << token
+      end
+      
+      process_runner.e.sync = true
+
+      # GROSS HACK! 
+      # It seems we need to wait
+      # for the fsch $stderr buffer to flush?
+      # There must be a better way... Anyone?
+      # Should we move to Highline for interactive
+      # shell applications?
+      # http://rubyforge.org/projects/highline/
+      # In fact - this problem actually ruins
+      # the entire implementation, the larger/longer
+      # it takes for errors to be bufferred, the more
+      # likely it is we'll return without displaying them.
+      # The only way to overcome this with the current 
+      # implementation, is to increase the timeout so that
+      # FCSH takes a long, long time on every compilation!!!
+      sleep(0.2)
+      
+      t.kill
+      return tokens
+    end
+
+    # We need to scan the stream as FCSH writes to it. Since FCSH is a
+    # persistent CLI application, it never sends an EOF or even a consistent
+    # EOL. In order to tokenize the output, we need to attempt to check 
+    # tokens with each character added.
+    # scan_stream will block and read characters from the reader provided until
+    # it encounters a PROMPT token, at that time, it will return an array
+    # of all tokens found.
+    # It will additionally yield each token as it's found if a block is provided.
+    def scan_stream(reader)
+      tokens = []
+      partial = ''
+      index = 0
+      while(true) do
+        code = reader.getc
+        return if code.nil?
+        
+        partial << code.chr
+        token = next_token(partial)
+        if(token)
+          tokens << token
+          yield token if block_given?
+          partial = ''
+          break if(token[:name] == PROMPT || token[:name] == ERROR)
+        end
+      end
+      
+      return tokens
+    end
+    
+    private
+
+    # Retrieve the next token from the string, and
+    # return nil if no token is found
+    def next_token(string)
+      # puts "checking: #{string}"
+      @regex_to_token.each do |regex, token_name|
+        match = regex.match(string)
+        if match
+          return {:name => token_name, :match => match, :output => get_output(token_name, match)}
+        end
+      end
+      return nil
+    end
+    
+    def get_output(name, match)
+      if(name == PROMPT)
+        return match.pre_match + "\n"
+      else
+        return match[0] + "\n"
+      end
+    end
+
+    def out
+      @out
+    end
+  end
+end

data/lib/sprout/fcsh_service.rb

@@ -0,0 +1,111 @@
+=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.
+
+TODO: Investigate jruby support, especially:
+    http://livedocs.adobe.com/flex/201/html/wwhelp/wwhimpl/common/html/wwhelp.htm?context=LiveDocs_Book_Parts&file=compilers_123_09.html
+=end
+
+require 'sprout/fcsh_lexer'
+require 'digest/md5'
+
+module Sprout
+  class FCSHError < StandardError #:nodoc:
+  end
+
+  class FCSHService
+    
+    def initialize(out=nil)
+      @out = out || $stdout
+      @tasks = []
+      @lexer = FCSHLexer.new @out
+
+      # TODO: This should use configurable SDK destinations:
+      exe = Sprout.get_executable('sprout-flex3sdk-tool', 'bin/fcsh')
+      @process = User.execute_silent(exe)
+      
+      response = ''
+      @lexer.scan_process(@process).each do |token|
+        response << token[:output]
+      end
+      out.puts response
+    end
+    
+    # Temporarily pulled support for clear - 
+    # since it's easier to just stop and start the server.
+    # The clear feature continues to increment task ids
+    # and requires deeper changes for full support...
+    # def clear
+    #   @tasks.each_index do |index|
+    #     write("clear #{index+1}")
+    #   end
+    #   @tasks = []
+    #   return "[fcsh] All tasks have been cleared"
+    # end
+    
+    def execute(request)
+      # if(request =~ /^clear/)
+      #   return clear
+      # end
+      hashed = Digest::MD5.hexdigest(request)
+      
+      # First, see if we've already received a task with this
+      # Exact command:
+      @tasks.each_index do |index|
+        task = @tasks[index]
+        if(task[:hash] == hashed)
+          out.puts "[fcsh] #{request})"
+          # Compile with an existing task at index+1
+          return write("compile #{index+1}")
+        end
+      end
+
+      # No existing task found with this hash, create a new
+      # task, store it for later, execute and return the result:
+      task = {:hash => hashed, :request => request, :executed => false}
+      @tasks << task
+      return write(task[:request])
+    end
+    
+    def close
+      write("quit")
+    end
+    
+    private
+    
+    def write(message)
+      result = ''
+      out.puts "[fcsh] #{message}"
+      @process.puts "#{message}\n"
+      @lexer.scan_process(@process) do |token|
+        yield token if block_given?
+        result << token[:output]
+      end
+      out.puts "[fcsh] #{result.strip}\n"
+      return result
+    end
+    
+    def out
+      @out
+    end
+
+  end
+end

data/lib/sprout/fcsh_socket.rb

@@ -0,0 +1,36 @@
+require 'socket'
+require 'sprout/fcsh_service'
+
+module Sprout #:nodoc
+
+  class FCSHSocket
+
+    def self.server(port=12321, out=nil)
+      out = out || $stdout
+      server = TCPServer.new(port)
+      @fcsh = FCSHService.new(out)
+      out.puts ">> fcsh started, waiting for connections on port #{port}"
+      while(session = server.accept)
+        response = @fcsh.execute(session.gets)
+        session.puts(response)
+        session.flush
+        session.close
+      end
+    end
+    
+    def self.execute(command, port=12321)
+      session = TCPSocket.new('localhost', port)
+      session.puts(command)
+      response = session.read
+      
+      error = response =~ /(.*Error:.*\^.*)\n/m
+      if(error)
+        raise FCSHError.new(response)
+      end
+      
+      session.close
+      return response
+    end
+
+  end
+end

data/lib/sprout/generators/project/project_generator.rb

@@ -21,6 +21,7 @@ class ProjectGenerator < Sprout::Generator::NamedBase # :nodoc:
 
       m.template 'MainClass.as', File.join(base, 'src', "#{class_name}.as")
       m.template 'TestRunner.as', File.join(base, 'src', "#{class_name}Runner.as")
+      m.template 'XMLRunner.as', File.join(base, 'src', "#{class_name}XMLRunner.as")
     end
   end
 

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

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

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

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

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

@@ -11,6 +11,7 @@ project_model :model do |m|
   m.background_color        = '#FFFFFF'
   m.width                   = 970
   m.height                  = 550
+  # m.use_fcsh                = true
   # m.src_dir               = 'src'
   # m.lib_dir               = 'lib'
   # m.swc_dir               = 'lib'
@@ -40,5 +41,8 @@ document :doc
 desc 'Compile a SWC file'
 swc :swc
 
+desc 'Compile and run the test harness for CI'
+ci :cruise
+
 # set up the default rake task
 task :default => :debug

data/lib/sprout/generators/test/templates/TestCase.as

@@ -6,7 +6,7 @@ package <%= package_name %> {
 		private var <%= instance_name %>:<%= class_name %>;
 
 		public function <%= test_case_name %>(methodName:String=null) {
-			super(methodName)
+			super(methodName);
 		}
 
 		override protected function setUp():void {
@@ -27,4 +27,4 @@ package <%= package_name %> {
 			assertTrue("Failing test", false);
 		}
 	}
-}
+}

data/lib/sprout/tasks/adl_documentation.rb

@@ -1,53 +1,87 @@
 module Sprout
-class ADLTask < ToolTask
-#         Specifies the directory containing the runtime to use. If not 
-#         specified, the runtime directory in the same SDK as the ADL program
-#         will be used. If you move ADL out of its SDK folder, then you must 
-#         specify the runtime directory. On Windows, specify the directory 
-#         containing the Adobe AIR directory. On Mac OSX, specify the directory 
-#         containing Adobe AIR.framework.
-def runtime=(file)
-  @runtime = file
-end
-
-#         Turns off debugging support. If used, the application process cannot 
-#         connect to the Flash debugger and dialogs for unhandled exceptions are
-#         suppressed. 
-#         
-#         Trace statements still print to the console window. Turning off 
-#         debugging allows your application to run a little faster and also 
-#         emulates the execution mode of an installed application more closely.
-def nodebug=(boolean)
-  @nodebug = boolean
-end
-
-#         Assigns the specified value as the publisher ID of the AIR application 
-#         for this run. Specifying a temporary publisher ID allows you to test 
-#         features of an AIR application, such as communicating over a local 
-#         connection, that use the publisher ID to help uniquely identify an 
-#         application. 
-#         
-#         The final publisher ID is determined by the digital certificate used to 
-#         sign the AIR installation file.
-def pubid=(string)
-  @pubid = string
-end
-
-# The application descriptor file.
-def application_descriptor=(file)
-  @application_descriptor = file
+class ADTTask < ToolTask
+# Using -package option as default.
+def package=(boolean)
+  @package = boolean
+end
+
+#         The alias of a key in the keystore. Specifying an alias is not 
+#         necessary when a keystore only contains a single certificate. If no 
+#         alias is specified, ADT uses the first key in the keystore.
+def alias=(string)
+  @alias = string
+end
+
+#         The type of keystore, determined by the keystore implementation. The 
+#         default keystore implementation included with most installations of 
+#         Java supports the JKS and PKCS12 types. Java 5.0 includes support for 
+#         the PKCS11 type, for accessing keystores on hardware tokens, and 
+#         Keychain type, for accessing the Mac OS-X keychain. Java 6.0 includes 
+#         support for the MSCAPI type (on Windows). If other JCA providers have 
+#         been installed and configured, additional keystore types might be 
+#         available. If no keystore type is specified, the default type for the 
+#         default JCA provider is used.
+def storetype=(string)
+  @storetype = string
+end
+
+#         The JCA provider for the specified keystore type. If not specified, 
+#         then ADT uses the default provider for that type of keystore.
+def providerName=(string)
+  @providerName = string
+end
+
+# The path to the keystore file for file-based store types.
+def keystore=(file)
+  @keystore = file
 end
 
-#         The root directory of the application to run. If not 
-#         specified, the directory containing the application 
-#         descriptor file is used.
-def root_directory=(file)
-  @root_directory = file
+#         The password required to access the keystore. If not specified, ADT 
+#         prompts for the password.
+def storepass=(string)
+  @storepass = string
+end
+
+#         The password required to access the private key that will be used to 
+#         sign the AIR application. If not specified, ADT prompts for the password.
+def keypass=(string)
+  @keypass = string
+end
+
+#         Specifies the URL of an RFC3161-compliant time stamp server to time 
+#         stamp the digital signature. If no URL is specified, a default time 
+#         stamp server provided by Geotrust is used. When the signature of an AIR
+#         application is time stamped, the application can still be installed 
+#         after the signing certificate expires, because the time stamp verifies 
+#         that the certificate was valid at the time of signing. 
+def tsa=(url)
+  @tsa = url
+end
+
+# The name of the AIR file to be created.
+def output=(file)
+  @output = file
+end
+
+#         The path to the application descriptor file. The path can be specified 
+#         relative to the current directory or as an absolute path. (The 
+#         application descriptor file is renamed as "application.xml" in the AIR 
+#         file.)
+def application_descriptor=(file)
+  @application_descriptor = file
 end
 
-#         Passed to the application as command-line arguments.
-def arguments=(string)
-  @arguments = string
+#         The files and directories to package in the AIR file. Any number of 
+#         files and directories can be specified, delimited by whitespace. If you
+#         list a directory, all files and subdirectories within, except hidden 
+#         files, are added to the package. (In addition, if the application 
+#         descriptor file is specified, either directly, or through wildcard or 
+#         directory expansion, it is ignored and not added to the package a 
+#         second time.) Files and directories specified must be in the current 
+#         directory or one of its subdirectories. Use the -C option to change the 
+#         current directory.
+def files=(files)
+  @files = files
 end
 
 end

data/lib/sprout/tasks/adt_documentation.rb

@@ -1,87 +1,53 @@
 module Sprout
-class ADTTask < ToolTask
-# Using -package option as default.
-def package=(boolean)
-  @package = boolean
-end
-
-#         The alias of a key in the keystore. Specifying an alias is not 
-#         necessary when a keystore only contains a single certificate. If no 
-#         alias is specified, ADT uses the first key in the keystore.
-def alias=(string)
-  @alias = string
-end
-
-#         The type of keystore, determined by the keystore implementation. The 
-#         default keystore implementation included with most installations of 
-#         Java supports the JKS and PKCS12 types. Java 5.0 includes support for 
-#         the PKCS11 type, for accessing keystores on hardware tokens, and 
-#         Keychain type, for accessing the Mac OS-X keychain. Java 6.0 includes 
-#         support for the MSCAPI type (on Windows). If other JCA providers have 
-#         been installed and configured, additional keystore types might be 
-#         available. If no keystore type is specified, the default type for the 
-#         default JCA provider is used.
-def storetype=(string)
-  @storetype = string
-end
-
-#         The JCA provider for the specified keystore type. If not specified, 
-#         then ADT uses the default provider for that type of keystore.
-def providerName=(string)
-  @providerName = string
-end
-
-# The path to the keystore file for file-based store types.
-def keystore=(file)
-  @keystore = file
-end
-
-#         The password required to access the keystore. If not specified, ADT 
-#         prompts for the password.
-def storepass=(string)
-  @storepass = string
-end
-
-#         The password required to access the private key that will be used to 
-#         sign the AIR application. If not specified, ADT prompts for the password.
-def keypass=(string)
-  @keypass = string
-end
-
-#         Specifies the URL of an RFC3161-compliant time stamp server to time 
-#         stamp the digital signature. If no URL is specified, a default time 
-#         stamp server provided by Geotrust is used. When the signature of an AIR
-#         application is time stamped, the application can still be installed 
-#         after the signing certificate expires, because the time stamp verifies 
-#         that the certificate was valid at the time of signing. 
-def tsa=(url)
-  @tsa = url
-end
-
-# The name of the AIR file to be created.
-def output=(file)
-  @output = file
-end
-
-#         The path to the application descriptor file. The path can be specified 
-#         relative to the current directory or as an absolute path. (The 
-#         application descriptor file is renamed as "application.xml" in the AIR 
-#         file.)
+class ADLTask < ToolTask
+#         Specifies the directory containing the runtime to use. If not 
+#         specified, the runtime directory in the same SDK as the ADL program
+#         will be used. If you move ADL out of its SDK folder, then you must 
+#         specify the runtime directory. On Windows, specify the directory 
+#         containing the Adobe AIR directory. On Mac OSX, specify the directory 
+#         containing Adobe AIR.framework.
+def runtime=(file)
+  @runtime = file
+end
+
+#         Turns off debugging support. If used, the application process cannot 
+#         connect to the Flash debugger and dialogs for unhandled exceptions are
+#         suppressed. 
+#         
+#         Trace statements still print to the console window. Turning off 
+#         debugging allows your application to run a little faster and also 
+#         emulates the execution mode of an installed application more closely.
+def nodebug=(boolean)
+  @nodebug = boolean
+end
+
+#         Assigns the specified value as the publisher ID of the AIR application 
+#         for this run. Specifying a temporary publisher ID allows you to test 
+#         features of an AIR application, such as communicating over a local 
+#         connection, that use the publisher ID to help uniquely identify an 
+#         application. 
+#         
+#         The final publisher ID is determined by the digital certificate used to 
+#         sign the AIR installation file.
+def pubid=(string)
+  @pubid = string
+end
+
+# The application descriptor file.
 def application_descriptor=(file)
   @application_descriptor = file
 end
 
-#         The files and directories to package in the AIR file. Any number of 
-#         files and directories can be specified, delimited by whitespace. If you
-#         list a directory, all files and subdirectories within, except hidden 
-#         files, are added to the package. (In addition, if the application 
-#         descriptor file is specified, either directly, or through wildcard or 
-#         directory expansion, it is ignored and not added to the package a 
-#         second time.) Files and directories specified must be in the current 
-#         directory or one of its subdirectories. Use the -C option to change the 
-#         current directory.
-def files=(files)
-  @files = files
+#         The root directory of the application to run. If not 
+#         specified, the directory containing the application 
+#         descriptor file is used.
+def root_directory=(file)
+  @root_directory = file
+end
+
+#         Passed to the application as command-line arguments.
+def arguments=(string)
+  @arguments = string
 end
 
 end