flashsdk 1.0.13.pre → 1.0.14.pre

data/Gemfile

@@ -1,6 +1,6 @@
 source "http://rubygems.org"
 
-gem 'sprout', '>= 1.0.31.pre'
+gem 'sprout', '>= 1.1.2.pre'
 
 group :development do
   gem "shoulda"

data/Gemfile.lock

@@ -6,15 +6,13 @@ GEM
       rake
     open4 (1.0.1)
     rake (0.8.7)
-    rdoc (2.5.11)
     rubyzip (0.9.4)
     shoulda (2.11.3)
-    sprout (1.0.31.pre)
+    sprout (1.1.2.pre)
       archive-tar-minitar (= 0.5.2)
       bundler (>= 0.9.19)
       open4 (>= 0.9.6)
       rake (>= 0.8.7)
-      rdoc (>= 2.5.8)
       rubyzip (= 0.9.4)
 
 PLATFORMS
@@ -23,4 +21,4 @@ PLATFORMS
 DEPENDENCIES
   mocha
   shoulda
-  sprout (>= 1.0.31.pre)
+  sprout (>= 1.1.2.pre)

data/VERSION

@@ -1 +1 @@
-1.0.13.pre
+1.0.14.pre

data/lib/flashplayer/specification.rb

@@ -1,41 +1,45 @@
-require 'flashsdk'
-
-Sprout::Specification.new do |s|
-  s.name        = FlashPlayer::NAME
-  s.version     = FlashPlayer::VERSION
+  require 'flashsdk'
 
   ##
-  # NOTE: The order of these declarations is important, the RubyFeature.load method
-  # will search for the first match that is appropriate for the end user system.
-  #
-  # Current releases of the Ruby One-Click Installer for Windows actually
-  # run on top of Mingw, and OSX is a *nix variant, which means that 
-  # all System types (in Ruby at least) derive from UnixSystem. 
-  #
-  # This means that the Linux/Unix declaration will
-  # match everyone, so it is effectively the same as ':universal'
-  s.add_remote_file_target do |t|
-    t.platform     = :windows
-    t.archive_type = :exe
-    t.url          = "http://download.macromedia.com/pub/flashplayer/updaters/10/flashplayer_10_sa_debug.exe"
-    t.md5          = "1f5e411f96817b56c99111a06f4c727f"
-    t.add_executable :flashplayer, "1f5e411f96817b56c99111a06f4c727f.exe"
-  end
+  # This is the Flash Player Sprout::Specification and is how
+  # we figure out from where to load the Flash Player for the
+  # current user system.
+  Sprout::Specification.new do |s|
+    s.name        = FlashPlayer::NAME
+    s.version     = FlashPlayer::VERSION
 
-  s.add_remote_file_target do |t|
-    t.platform     = :osx
-    t.archive_type = :zip
-    t.url          = "http://download.macromedia.com/pub/flashplayer/updaters/10/flashplayer_10_sa_debug.app.zip"
-    t.md5          = "1c5ef8aeb1aa4a6cee7970d5c7ee9a55"
-    t.add_executable :flashplayer, "Flash Player Debugger.app"
-  end
+    ##
+    # NOTE: The order of these declarations is important, the RubyFeature.load method
+    # will search for the first match that is appropriate for the end user system.
+    #
+    # Current releases of the Ruby One-Click Installer for Windows actually
+    # run on top of Mingw, and OSX is a *nix variant, which means that 
+    # all System types (in Ruby at least) derive from UnixSystem. 
+    #
+    # This means that the Linux/Unix declaration will
+    # match everyone, so it is effectively the same as ':universal'
+    s.add_remote_file_target do |t|
+      t.platform     = :windows
+      t.archive_type = :exe
+      t.url          = "http://download.macromedia.com/pub/flashplayer/updaters/10/flashplayer_10_sa_debug.exe"
+      t.md5          = "1f5e411f96817b56c99111a06f4c727f"
+      t.add_executable :flashplayer, "1f5e411f96817b56c99111a06f4c727f.exe"
+    end
+
+    s.add_remote_file_target do |t|
+      t.platform     = :osx
+      t.archive_type = :zip
+      t.url          = "http://download.macromedia.com/pub/flashplayer/updaters/10/flashplayer_10_sa_debug.app.zip"
+      t.md5          = "1c5ef8aeb1aa4a6cee7970d5c7ee9a55"
+      t.add_executable :flashplayer, "Flash Player Debugger.app"
+    end
 
-  s.add_remote_file_target do |t|
-    t.platform     = :linux
-    t.archive_type = :tgz
-    t.url          = "http://download.macromedia.com/pub/flashplayer/updaters/10/flashplayer_10_sa_debug.tar.gz"
-    t.md5          = "1efa254bc7d6e0c11a61984ae34bfaa7"
-    t.add_executable :flashplayer, "flashplayerdebugger"
+    s.add_remote_file_target do |t|
+      t.platform     = :linux
+      t.archive_type = :tgz
+      t.url          = "http://download.macromedia.com/pub/flashplayer/updaters/10/flashplayer_10_sa_debug.tar.gz"
+      t.md5          = "1efa254bc7d6e0c11a61984ae34bfaa7"
+      t.add_executable :flashplayer, "flashplayerdebugger"
+    end
   end
-end
 

data/lib/flashplayer/system_mixins.rb

@@ -1,9 +1,6 @@
-##
-# Update the native System instances
-# to handle FlashPlayer launching in 
-# order to overcome non-cli limitations.
-#
+
 module Sprout
+
   module System
     
     class WinSystem

data/lib/flashplayer/task.legacy.rb

@@ -130,7 +130,7 @@
       @test_result ||= ''
     end
 
-    def define # :nodoc:
+    def define 
       CLEAN.add(test_result_file)
     end
 

data/lib/flashsdk/adl.rb

@@ -1,7 +1,6 @@
 module FlashSDK
 
-  class ADL
-    include Sprout::Executable
+  class ADL < Sprout::Executable::Base
 
     add_param :runtime, Path
 
@@ -41,6 +40,10 @@ module FlashSDK
   end
 end
 
+##
+# TODO: This should NOT be here!
+# This is preventing that method from working
+# as expected only after this FILE is required.
 class Sprout::System::UnixSystem
 
     def should_repair_executable path

data/lib/flashsdk/adt.rb

@@ -33,8 +33,7 @@ module FlashSDK
   #   desc "Compile, certify and package the AIR application"
   #   task package => 'bin/SomeProject.air'
   #
-  class ADT
-    include Sprout::Executable
+  class ADT < Sprout::Executable::Base
     #NOTE:
     # The order of these parameters is important!
     # Please do not alphabetize or rearrange unless you're

data/lib/flashsdk/amxmlc.rb

@@ -2,8 +2,7 @@ module FlashSDK
 
   ##
   # This is a wrapper for the AIR MXMLC compiler.
-  class AMXMLC < MXMLC
-    include Sprout::Executable
+  class AMXMLC < MXMLC 
 
     ##
     # The default executable target.

data/lib/flashsdk/compc.rb

@@ -1,7 +1,6 @@
 module FlashSDK
 
   class COMPC < CompilerBase
-    include Sprout::Executable
 
     ##
     # Outputs the SWC file into an open directory format rather than a SWC file

data/lib/flashsdk/compiler_base.rb

@@ -1,15 +1,21 @@
 module FlashSDK
   
-  class CompilerBase
-    include Sprout::Executable
+  ##
+  # This is the abstract base class that defines common fields for ActionScript compilers like {FlashSDK::MXMLC} and {FlashSDK::COMPC}.
+  #
+  # @abstract
+  #
+  class CompilerBase < Sprout::Executable::Base
 
     ##
     # Enables accessibility features when compiling the Flex application or SWC file. The default value is false.
     #
+    #   t.accessible = true
+    #
     add_param :accessible, Boolean, { :hidden_value => true }
     
     ##
-    # Sets the file encoding for ActionScript files. For more information see: http://livedocs.adobe.com/flex/2/docs/00001503.html#149244
+    # Sets the file encoding for ActionScript files.
     #
     add_param :actionscript_file_encoding, String
     
@@ -34,22 +40,20 @@ module FlashSDK
     ##
     # Sets the value of the {context.root} token in channel definitions in the flex-services.xml file. If you do not specify the value of this option, Flex uses an empty string.
     #
-    # For more information on using the {context.root} token, see http://livedocs.adobe.com/flex/2/docs/00001446.html#205687.
-    #
     add_param :context_root, Path
     
     ##
-    # Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files (http://livedocs.adobe.com/flex/2/docs/00001502.html#145380).
+    # Sets metadata in the resulting SWF file. 
     #
     add_param :contributor, String
     
     ##
-    # Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files. (http://livedocs.adobe.com/flex/2/docs/00001502.html#145380)
+    # Sets metadata in the resulting SWF file.
     #
     add_param :creator, String
     
     ##
-    # Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files. (http://livedocs.adobe.com/flex/2/docs/00001502.html#145380)
+    # Sets metadata in the resulting SWF file.
     #
     add_param :date, String
     
@@ -76,7 +80,7 @@ module FlashSDK
     # 
     #     -default-background-color=0xCCCCFF
     #
-    # The default value is null. The default background of a Flex application is an image of a gray gradient. You must override this image for the value of the default-background-color option to be visible. For more information, see Editing application settings (http://livedocs.adobe.com/flex/2/docs/00001504.html#138781).
+    # The default value is null. The default background of a Flex application is an image of a gray gradient. You must override this image for the value of the default-background-color option to be visible.
     #
     # This is an advanced option.
     # 
@@ -122,10 +126,6 @@ module FlashSDK
     ##
     # Defines the location of the default style sheet. Setting this option overrides the implicit use of the defaults.css style sheet in the framework.swc file.
     #
-    # For more information on the defaults.css file, see Using Styles and Themes (http://livedocs.adobe.com/flex/2/docs/00000751.html#241755) in Flex 2 Developer's Guide.
-    #
-    # This is an advanced option.
-    #
     add_param :default_css_url, Url
 
     ##
@@ -136,7 +136,7 @@ module FlashSDK
     add_param :define_conditional, Strings, { :shell_name => "-define" }
     
     ##
-    # Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files (http://livedocs.adobe.com/flex/2/docs/00001502.html#145380).
+    # Sets metadata in the resulting SWF file.
     #
     add_param :description, String
     
@@ -165,8 +165,6 @@ module FlashSDK
     #
     # This option provides compile-time link checking for external references that are dynamically linked.
     #
-    # For more information about dynamic linking, see About linking (http://livedocs.adobe.com/flex/2/docs/00001521.html#205852).
-    #
     # This is an advanced option.
     # 
     add_param :externs, Strings
@@ -174,8 +172,6 @@ module FlashSDK
     ##
     # Specifies a list of SWC files or directories to exclude from linking when compiling a SWF file. This option provides compile-time link checking for external components that are dynamically linked.
     #
-    # For more information about dynamic linking, see About linking (http://livedocs.adobe.com/flex/2/docs/00001521.html#205852).
-    #
     # You can use the += operator to append the new SWC file to the list of external libraries.
     #
     # This parameter has been aliased as +el+.
@@ -193,28 +189,28 @@ module FlashSDK
     add_param :file_specs, Files
     
     ##
-    # Specifies the range of Unicode settings for that language. For more information, see Using Styles and Themes (http://livedocs.adobe.com/flex/2/docs/00000751.html#241755) in Flex 2 Developer's Guide.
+    # Specifies the range of Unicode settings for that language.
     #
     # This is an advanced option.
     #
     add_param :fonts_languages_language_range, String, { :shell_name => "-compiler.fonts.languages.language-range" }
 
     ##
-    # Defines the font manager. The default is flash.fonts.JREFontManager. You can also use the flash.fonts.BatikFontManager. For more information, see Using Styles and Themes in Flex 2 Developer's Guide (http://livedocs.adobe.com/flex/2/docs/00000751.html#241755).
+    # Defines the font manager. The default is flash.fonts.JREFontManager. You can also use the flash.fonts.BatikFontManager.
     #
     # This is an advanced option.
     #
     add_param :fonts_managers, Strings
     
     ##
-    # Sets the maximum number of fonts to keep in the server cache. For more information, see Caching fonts and glyphs (http://livedocs.adobe.com/flex/2/docs/00001469.html#208457).
+    # Sets the maximum number of fonts to keep in the server cache.
     #
     # This is an advanced option.
     #
     add_param :fonts_max_cached_fonts, Number
     
     ##
-    # Sets the maximum number of character glyph-outlines to keep in the server cache for each font face. For more information, see Caching fonts and glyphs (http://livedocs.adobe.com/flex/2/docs/00001469.html#208457).
+    # Sets the maximum number of character glyph-outlines to keep in the server cache for each font face.
     #
     # This is an advanced option.
     # 
@@ -271,7 +267,7 @@ module FlashSDK
     add_param :include_path, Paths
     
     ##
-    # Enables incremental compilation. For more information, see About incremental compilation (http://livedocs.adobe.com/flex/2/docs/00001506.html#153980).
+    # Enables incremental compilation.
     # 
     # This option is true by default for the Flex Builder application compiler. For the command-line compiler, the default is false. The web-tier compiler does not support incremental compilation.
     #
@@ -311,7 +307,7 @@ module FlashSDK
     add_param :keep_generated_actionscript, Boolean
     
     ##
-    # Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files (http://livedocs.adobe.com/flex/2/docs/00001502.html#145380).
+    # Sets metadata in the resulting SWF file.
     #
     add_param :language, String
     
@@ -375,8 +371,6 @@ module FlashSDK
     #
     # The file format output by this command can be used to write a file for input to the load-externs option.
     #
-    # For more information on the report, see Examining linker dependencies (http://livedocs.adobe.com/flex/2/docs/00001394.html#211202).
-    #
     # This is an advanced option.
     #
     add_param :link_report, File
@@ -390,8 +384,6 @@ module FlashSDK
     #
     # 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).
-    #
     add_param :load_config, Files
     
     ##
@@ -403,14 +395,8 @@ module FlashSDK
     #
     # The XML file uses the same syntax as the one produced by the link-report option. 
     #
-    # For more information on the report, see Examining linker dependencies (http://livedocs.adobe.com/flex/2/docs/00001394.html#211202).
-    #
     # This option provides compile-time link checking for external components that are dynamically linked.
     #
-    # For more information about dynamic linking, see About linking (http://livedocs.adobe.com/flex/2/docs/00001521.html#205852).
-    #
-    # This is an advanced option.
-    #
     add_param :load_externs, File
     
     ##
@@ -424,25 +410,21 @@ module FlashSDK
     #
     #      mxmlc -locale en_EN -source-path locale/{locale} -file-specs MainApp.mxml
     #
-    # For more information, see Localizing Flex Applicationsin (http://livedocs.adobe.com/flex/2/docs/00000898.html#129288) Flex 2 Developer's Guide.
-    #
     add_param :locale, String
     
     ##
-    # Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files (http://livedocs.adobe.com/flex/2/docs/00001502.html#145380).
+    # Sets metadata in the resulting SWF file. 
     #
     add_param :localized_description, String
 
     ##
-    # Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files (http://livedocs.adobe.com/flex/2/docs/00001502.html#145380)."
+    # Sets metadata in the resulting SWF file.
     #
     add_param :localized_title, String
     
     ##
     # Specifies a namespace for the MXML file. You must include a URI and the location of the manifest file that defines the contents of this namespace. This path is relative to the MXML file.
     #
-    # For more information about manifest files, see About manifest files (http://livedocs.adobe.com/flex/2/docs/00001519.html#134676).
-    #
     add_param :namespaces_namespace, String
     
     ##
@@ -466,7 +448,7 @@ module FlashSDK
     add_param :output, File, { :file_task_name => true }
     
     ##
-    # Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files (http://livedocs.adobe.com/flex/2/docs/00001502.html#145380).
+    # Sets metadata in the resulting SWF file. 
     #
     add_param :publisher, String
 
@@ -478,8 +460,6 @@ module FlashSDK
     ##
     # Prints a list of resource bundles to input to the compc compiler to create a resource bundle SWC file. The filename argument is the name of the file that contains the list of bundles.
     #
-    # For more information, see Localizing Flex Applications (http://livedocs.adobe.com/flex/2/docs/00000898.html#129288) in Flex 2 Developer's Guide.
-    #
     add_param :resource_bundle_list, File
     
     ##
@@ -487,8 +467,6 @@ module FlashSDK
     #
     # You specify the location of the SWF file relative to the deployment location of the application. For example, if you store a file named library.swf file in the web_root/libraries directory on the web server, and the application in the web root, you specify libraries/library.swf.
     #
-    # For more information about RSLs, see Using Runtime Shared Libraries. (http://livedocs.adobe.com/flex/2/docs/00001520.html#168690)
-    #
     add_param :runtime_shared_libraries, Strings
 
     ## 
@@ -497,9 +475,12 @@ module FlashSDK
     add_param_alias :rsl, :runtime_shared_libraries
 
     ##
-    # [path-element] [rsl-url] [policy-file-url] [rsl-url] [policy-file-url]
-    # alias -rslp
-    # (repeatable)
+    # Runtime shared library path.
+    #
+    #   t.runtime_shared_library_path << "[path-element] [rsl-url] [policy-file-url]"
+    #
+    # @see Sprout::MXMLC#rslp
+    #
     add_param :runtime_shared_library_path, Strings
     
     ##
@@ -517,8 +498,6 @@ module FlashSDK
     #
     # 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).
-    #
     add_param :show_actionscript_warnings, Boolean, { :default => true, :show_on_false => true }
 
     ##
@@ -526,8 +505,6 @@ module FlashSDK
     #
     # The default value is true.
     #
-    # For more information about compiler warnings, see Using SWC files (http://livedocs.adobe.com/flex/2/docs/00001505.html#158337).
-    #
     add_param :show_binding_warnings, Boolean, { :default => true, :show_on_false => true }
     
     ##
@@ -535,8 +512,6 @@ module FlashSDK
     #
     # The default value is true.
     #
-    # For more information about viewing warnings and errors, see Viewing warnings and errors.
-    #
     add_param :show_deprecation_warnings, Boolean, { :default => true, :show_on_false => true }
     
     ##
@@ -571,8 +546,6 @@ module FlashSDK
     #
     # 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).
-    #
     add_param :strict, Boolean, { :default => true, :show_on_false => true }
     
     ##
@@ -590,10 +563,10 @@ module FlashSDK
     add_param :theme, Files
     
     ##
-    # Sets metadata in the resulting SWF file. For more information, see Adding metadata to SWF files (http://livedocs.adobe.com/flex/2/docs/00001502.html#145380).
+    # Sets metadata in the resulting SWF file.
     #
     add_param :title, String
-    
+
     ##
     # Specifies that the current application uses network services.
     #
@@ -601,8 +574,6 @@ module FlashSDK
     #
     # When the use-network property is set to false, the application can access the local filesystem (for example, use the XML.load() method with file: URLs) but not network services. In most circumstances, the value of this property should be true.
     #
-    # For more information about the use-network property, see Applying Flex Security (http://livedocs.adobe.com/flex/2/docs/00001328.html#137544).
-    #
     add_param :use_network, Boolean, { :default => true, :show_on_false => true }
     
     ##
@@ -618,7 +589,7 @@ module FlashSDK
     add_param :verify_digests, Boolean
   
     ##
-    # Enables specified warnings. For more information, see Viewing warnings and errors (http://livedocs.adobe.com/flex/2/docs/00001517.html#182413).
+    # Enables specified warnings.
     #
     add_param :warn_warning_type, Boolean
     
@@ -629,12 +600,91 @@ module FlashSDK
     #
     add_param :warnings, Boolean
 
+    ##
+    # Set to true in order to compile with the Flex Compiler Shell (FCSH).
+    #
+    # You can set this value directly on a single compiler instance like:
+    #
+    #   mxmlc 'bin/SomeProject.swf' do |t|
+    #     t.input = 'src/SomeProject.as'
+    #     t.use_fcsh = true
+    #   end
+    #
+    # This value can also be set to true by sending it into Ruby as
+    # an environment variable like:
+    #
+    #   rake test USE_FCSH=true
+    #
+    # If you always want to use FCSH, you can set this value in your .bashrc
+    # or .bash_profile like:
+    #
+    #   export USE_FCSH=true
+    #
+    # There is also an :fcsh helper rake task that will set this value
+    # simply by executing it before your build tasks. You can do this
+    # from the terminal like:
+    #
+    #   rake fcsh test
+    #
+    # Or:
+    #
+    #   rake fcsh debug
+    #
+    # Or you can make it a prerequisite to any other build task like:
+    #
+    #   mxmlc 'bin/SomeProject.swf' => :fcsh do |t|
+    #     ...
+    #   end
+    #
+    attr_accessor :use_fcsh
+
+    ##
+    # Temporary override while waiting for integration of next version!
+    # TODO: Remove this method override.
+    def execute
+      prepare
+      super
+    end
+
+    protected
+
+    ##
+    # Template method called by {Sprout::Executable} when
+    # a {Sprout::Library} is found in the Rake::Task prerequisite list.
+    #
+    # @param path [File] The path within the project where the library was copied.
+    #
+    # @return [File] The path that was provided.
+    #
     def library_added path
       if(path =~ /\.swc$/)
         self.library_path << path
       else
         self.source_path << path
       end
+      path
+    end
+
+    ##
+    # @override
+    def prepare
+      # Check for USE_FCSH on the environment
+      # variable hash, update instance value
+      # if found to be true:
+      if ENV['USE_FCSH'].to_s == 'true'
+        self.use_fcsh = true
+      end
+      super
+    end
+
+    ##
+    # @override
+    def execute_delegate
+      (use_fcsh) ? execute_with_fcsh : super
+    end
+
+    def execute_with_fcsh
+      #puts "[execute_with_fcsh] #{executable} #{to_shell}"
     end
 
   end

data/lib/flashsdk/fcsh.rb

@@ -0,0 +1,65 @@
+
+module FlashSDK
+
+  class FCSH < Sprout::Daemon
+
+    ##
+    # The the Ruby file that will load the expected
+    # Sprout::Specification.
+    #
+    # Default value is 'flex4'
+    set :pkg_name, 'flex4'
+
+    ##
+    # The default pkg version
+    #
+    set :pkg_version, ">= #{FlashSDK::VERSION}"
+
+    ##
+    # The default executable target.
+    #
+    set :executable, :fcsh
+
+    ##
+    # Set the default prompt that should be presented
+    #  on stdout when fcsh is ready for input.
+    set :prompt, /^\(fcsh\) /
+
+    ##
+    # Clear the saved compilation target
+    # from memory.
+    #
+    # @param id [Integer]
+    #
+    add_action :clear
+
+    ##
+    # Perform compilation using COMPC and the
+    # provided arguments.
+    #
+    # @param options [String]
+    #
+    add_action :compc
+
+    ##
+    # Execute a saved compilation from the provided
+    # id number.
+    #
+    # @param id [Integer]
+    #
+    add_action :compile
+
+    ##
+    # Perform compilation using MXMLC and the
+    # provided arguments.
+    #
+    # @param options [String]
+    #
+    add_action :mxmlc
+
+    ##
+    # Exit FCSH
+    add_action :quit
+  end
+end
+