flashsdk 1.0.21.pre → 1.0.22.pre

data/lib/flashsdk/generators/class_generator.rb

@@ -50,6 +50,10 @@ module FlashSDK
     # @return [String] The path where source files should be created.
     add_param :src, String, { :default => 'src' }
 
+    ##
+    # @return [String] The path where documentation should be created.
+    add_param :doc, String, { :default => 'doc' }
+
     ##
     # @return [Boolean] Call the TestClassGenerator after creating class.
     add_param :test_class, Boolean, { :default => true }

data/lib/flashsdk/generators/templates/rakefile.rb

@@ -35,17 +35,6 @@ end
 desc "Compile and run the debug swf"
 flashplayer :run => "<%= bin %>/<%= debug_swf_name %>"
 
-##############################
-# SWC
-
-compc "<%= bin %>/<%= class_name %>.swc" do |t|
-  t.input_class = "<%= class_name %>"
-  t.source_path << 'src'
-end
-
-desc "Compile the SWC file"
-task :swc => '<%= bin %>/<%= class_name %>.swc'
-
 ##############################
 # Test
 
@@ -61,5 +50,27 @@ end
 desc "Compile and run the test swf"
 flashplayer :test => "<%= bin %>/<%= test_swf_name %>"
 
+##############################
+# SWC
+
+compc "<%= bin %>/<%= class_name %>.swc" do |t|
+  t.input_class = "<%= class_name %>"
+  t.source_path << 'src'
+end
+
+desc "Compile the SWC file"
+task :swc => '<%= bin %>/<%= class_name %>.swc'
+
+##############################
+# DOC
+
+desc "Generate documentation at <%= doc %>/"
+asdoc '<%= doc %>' do |t|
+  t.doc_sources << "<%= src %>"
+  t.exclude_sources << "<%= src %>/<%= test_runner_name %>.as"
+end
+
+##############################
+# DEFAULT
 task :default => :run
 

data/lib/flashsdk/mxmlc.rb

@@ -1,5 +1,6 @@
 module FlashSDK
 
+  ##
   # The MXMLC task provides a rake front end to the Flex MXMLC command line compiler.
   # This task is integrated with the LibraryTask so that if any dependencies are
   # library tasks, they will be automatically added to the library_path or source_path
@@ -46,6 +47,45 @@ module FlashSDK
   #     t.input = 'src/SomeProjectRunner.as'
   #   end
   #
+  # == FCSH
+  #
+  # Building with MXMLC can be quite slow. If you'd like 
+  # to measure your build times in fractions of a second
+  # rather than minutes, you can use the Flex Compiler 
+  # SHell (FCSH).
+  #
+  # Sprouts makes it incredibly easy to 
+  # use FCSH, following are some simple instructions:
+  #
+  # Open up a new terminal, cd into your project
+  # directory and run:
+  #
+  #    rake fcsh:start
+  #
+  # Open up a new terminal, cd into your project
+  # directory and run whatever Rake task depends
+  # on at least one MXMLC task, and call the
+  # +fcsh+ task first. This can be done on the
+  # terminal like this:
+  #
+  #    rake fcsh test
+  #
+  # More information about FCSH can be found on the {Project Sprouts Blog}[http://projectsprouts.org/2011/01/18/using-fcsh.html].
+  #
+  # == Flex Debugger (FDB)
+  #
+  # Like FCSH, the Flex Debugger can be initiated
+  # by calling (or depending on) the +fdb+ Rake task.
+  #
+  #    rake fdb test
+  #
+  # This will drop you into the Flex Debugger shell
+  # environment, you can type +help+ at anytime to 
+  # learn more about what commands are available.
+  #
+  # You can also type +quit+ or hit CTRL+C to exit
+  # FDB.
+  #
   # @see FlashSDK::CompilerBase
   # @see Sprout::Executable
   #

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 21
+  - 22
   - pre
-  version: 1.0.21.pre
+  version: 1.0.22.pre
 platform: ruby
 authors: 
 - Luke Bayes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-26 00:00:00 -08:00
+date: 2011-01-29 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,11 +72,6 @@ extra_rdoc_files: []
 files: 
 - bin/sprout-as3
 - bin/sprout-flex
-- doc/adl-list.txt
-- doc/adt-list.txt
-- doc/compc-list.txt
-- doc/mxmlc-advanced-list.txt
-- doc/mxmlc-list.txt
 - ext/CloseFlashPlayerForDumbassOSX.scpt
 - ext/OpenFlashPlayerForDumbassOSX.scpt
 - flashsdk.gemspec

data/doc/adl-list.txt

@@ -1,4 +0,0 @@
-application descriptor file not specified
-usage:
-  adl ( -runtime <runtime-dir> )? ( -pubid <pubid> )? -nodebug? ( -profile mobileDevice|extendedMobileDevice|desktop|extendedDesktop )? ( -screensize <size> )? <app-desc> <root-dir>? ( -- ... )?
-  adl -help

data/doc/adt-list.txt

@@ -1,12 +0,0 @@
-usage:
-  adt -checkstore SIGNING_OPTIONS
-  adt -certificate -cn <name> ( -ou <org-unit> )? ( -o <org-name> )? ( -c <country> )? <key-type> <pfx-file> <password>
-  adt -help
-  adt -migrate SIGNING_OTIONS <air-file-in> <air-file-out>
-  adt -package SIGNING_OPTIONS <air-file> <app-desc> FILE_ARGS
-  adt -prepare <airi-file> <app-desc> FILE_ARGS
-  adt -sign SIGNING_OPTIONS <airi-file> <air-file>
-  adt -version
-
-SIGNING_OPTIONS: -storetype <type> ( -keystore <store> )? ( -storepass <pass> )? ( -keypass <pass> )? ( -providerName <name> )? ( -tsa <url> )?
-FILE_ARGS: <fileOrDir>* (( -C <dir> <fileOrDir>+ ) | ( -e <file> <path> ))*

data/doc/compc-list.txt

@@ -1,130 +0,0 @@
-Adobe Flex Compiler (compc)
-Version 4.0.0 build 10485
-Copyright (c) 2004-2009 Adobe Systems, Inc. All rights reserved.
-
-
--benchmark
--compiler.accessible
--compiler.actionscript-file-encoding <string>
--compiler.allow-source-path-overlap
--compiler.as3
--compiler.context-root <context-path>
--compiler.debug
--compiler.defaults-css-files [filename] [...]
--compiler.defaults-css-url <string>
--compiler.define <name> <value>
--compiler.enable-runtime-design-layers
--compiler.es
--compiler.extensions.extension [extension] [parameters] [...]
--compiler.external-library-path [path-element] [...]
--compiler.fonts.advanced-anti-aliasing
--compiler.fonts.flash-type
--compiler.fonts.languages.language-range <lang> <range>
--compiler.fonts.local-font-paths [path-element] [...]
--compiler.fonts.local-fonts-snapshot <string>
--compiler.fonts.managers [manager-class] [...]
--compiler.fonts.max-cached-fonts <string>
--compiler.fonts.max-glyphs-per-face <string>
--compiler.headless-server
--compiler.include-libraries [library] [...]
--compiler.incremental
--compiler.keep-all-type-selectors
--compiler.keep-as3-metadata [name] [...]
--compiler.keep-generated-actionscript
--compiler.library-path [path-element] [...]
--compiler.locale [locale-element] [...]
--compiler.mxml.compatibility-version <version>
--compiler.mxml.qualified-type-selectors
--compiler.namespaces.namespace [uri] [manifest] [...]
--compiler.optimize
--compiler.services <filename>
--compiler.show-actionscript-warnings
--compiler.show-binding-warnings
--compiler.show-shadowed-device-font-warnings
--compiler.show-unused-type-selector-warnings
--compiler.source-path [path-element] [...]
--compiler.strict
--compiler.theme [filename] [...]
--compiler.use-resource-bundle-metadata
--compiler.verbose-stacktraces
--compiler.warn-array-tostring-changes
--compiler.warn-assignment-within-conditional
--compiler.warn-bad-array-cast
--compiler.warn-bad-bool-assignment
--compiler.warn-bad-date-cast
--compiler.warn-bad-es3-type-method
--compiler.warn-bad-es3-type-prop
--compiler.warn-bad-nan-comparison
--compiler.warn-bad-null-assignment
--compiler.warn-bad-null-comparison
--compiler.warn-bad-undefined-comparison
--compiler.warn-boolean-constructor-with-no-args
--compiler.warn-changes-in-resolve
--compiler.warn-class-is-sealed
--compiler.warn-const-not-initialized
--compiler.warn-constructor-returns-value
--compiler.warn-deprecated-event-handler-error
--compiler.warn-deprecated-function-error
--compiler.warn-deprecated-property-error
--compiler.warn-duplicate-argument-names
--compiler.warn-duplicate-variable-def
--compiler.warn-for-var-in-changes
--compiler.warn-import-hides-class
--compiler.warn-instance-of-changes
--compiler.warn-internal-error
--compiler.warn-level-not-supported
--compiler.warn-missing-namespace-decl
--compiler.warn-negative-uint-literal
--compiler.warn-no-constructor
--compiler.warn-no-explicit-super-call-in-constructor
--compiler.warn-no-type-decl
--compiler.warn-number-from-string-changes
--compiler.warn-scoping-change-in-this
--compiler.warn-slow-text-field-addition
--compiler.warn-unlikely-function-value
--compiler.warn-xml-class-has-changed
--compute-digest
--debug-password <string>
--default-background-color <int>
--default-frame-rate <int>
--default-script-limits <max-recursion-depth> <max-execution-time>
--default-size <width> <height>
--directory
--dump-config <filename>
--externs [symbol] [...]
--frames.frame [label] [classname] [...]
--framework <string>
--help [keyword] [...]
--include-classes [class] [...]
--include-file <name> <path>
--include-lookup-only
--include-namespaces [uri] [...]
--include-resource-bundles [bundle] [...]
--include-sources [path-element] [...]
--include-stylesheet <name> <path>
--includes [symbol] [...]
--licenses.license <product> <serial-number>
--link-report <filename>
--load-config <filename>
--load-externs <filename>
--metadata.contributor <name>
--metadata.creator <name>
--metadata.date <text>
--metadata.description <text>
--metadata.language <code>
--metadata.localized-description <text> <lang>
--metadata.localized-title <title> <lang>
--metadata.publisher <name>
--metadata.title <text>
--output <filename>
--raw-metadata <text>
--resource-bundle-list <filename>
--runtime-shared-libraries [url] [...]
--runtime-shared-library-path [path-element] [rsl-url] [policy-file-url] [rsl-url] [policy-file-url]
--static-link-runtime-shared-libraries
--target-player <version>
--use-network
--verify-digests
--version
--warnings
-

data/doc/mxmlc-advanced-list.txt

@@ -1,122 +0,0 @@
-Adobe Flex Compiler (mxmlc)
-Version 4.0.0 build 10485
-Copyright (c) 2004-2009 Adobe Systems, Inc. All rights reserved.
-
-
--benchmark
--compiler.accessible
--compiler.actionscript-file-encoding <string>
--compiler.allow-source-path-overlap
--compiler.as3
--compiler.context-root <context-path>
--compiler.debug
--compiler.defaults-css-files [filename] [...]
--compiler.defaults-css-url <string>
--compiler.define <name> <value>
--compiler.enable-runtime-design-layers
--compiler.es
--compiler.extensions.extension [extension] [parameters] [...]
--compiler.external-library-path [path-element] [...]
--compiler.fonts.advanced-anti-aliasing
--compiler.fonts.flash-type
--compiler.fonts.languages.language-range <lang> <range>
--compiler.fonts.local-font-paths [path-element] [...]
--compiler.fonts.local-fonts-snapshot <string>
--compiler.fonts.managers [manager-class] [...]
--compiler.fonts.max-cached-fonts <string>
--compiler.fonts.max-glyphs-per-face <string>
--compiler.headless-server
--compiler.include-libraries [library] [...]
--compiler.incremental
--compiler.keep-all-type-selectors
--compiler.keep-as3-metadata [name] [...]
--compiler.keep-generated-actionscript
--compiler.library-path [path-element] [...]
--compiler.locale [locale-element] [...]
--compiler.mxml.compatibility-version <version>
--compiler.mxml.qualified-type-selectors
--compiler.namespaces.namespace [uri] [manifest] [...]
--compiler.optimize
--compiler.services <filename>
--compiler.show-actionscript-warnings
--compiler.show-binding-warnings
--compiler.show-shadowed-device-font-warnings
--compiler.show-unused-type-selector-warnings
--compiler.source-path [path-element] [...]
--compiler.strict
--compiler.theme [filename] [...]
--compiler.use-resource-bundle-metadata
--compiler.verbose-stacktraces
--compiler.warn-array-tostring-changes
--compiler.warn-assignment-within-conditional
--compiler.warn-bad-array-cast
--compiler.warn-bad-bool-assignment
--compiler.warn-bad-date-cast
--compiler.warn-bad-es3-type-method
--compiler.warn-bad-es3-type-prop
--compiler.warn-bad-nan-comparison
--compiler.warn-bad-null-assignment
--compiler.warn-bad-null-comparison
--compiler.warn-bad-undefined-comparison
--compiler.warn-boolean-constructor-with-no-args
--compiler.warn-changes-in-resolve
--compiler.warn-class-is-sealed
--compiler.warn-const-not-initialized
--compiler.warn-constructor-returns-value
--compiler.warn-deprecated-event-handler-error
--compiler.warn-deprecated-function-error
--compiler.warn-deprecated-property-error
--compiler.warn-duplicate-argument-names
--compiler.warn-duplicate-variable-def
--compiler.warn-for-var-in-changes
--compiler.warn-import-hides-class
--compiler.warn-instance-of-changes
--compiler.warn-internal-error
--compiler.warn-level-not-supported
--compiler.warn-missing-namespace-decl
--compiler.warn-negative-uint-literal
--compiler.warn-no-constructor
--compiler.warn-no-explicit-super-call-in-constructor
--compiler.warn-no-type-decl
--compiler.warn-number-from-string-changes
--compiler.warn-scoping-change-in-this
--compiler.warn-slow-text-field-addition
--compiler.warn-unlikely-function-value
--compiler.warn-xml-class-has-changed
--debug-password <string>
--default-background-color <int>
--default-frame-rate <int>
--default-script-limits <max-recursion-depth> <max-execution-time>
--default-size <width> <height>
--dump-config <filename>
--externs [symbol] [...]
--frames.frame [label] [classname] [...]
--framework <string>
--help [keyword] [...]
--include-resource-bundles [bundle] [...]
--includes [symbol] [...]
--licenses.license <product> <serial-number>
--link-report <filename>
--load-config <filename>
--load-externs <filename>
--metadata.contributor <name>
--metadata.creator <name>
--metadata.date <text>
--metadata.description <text>
--metadata.language <code>
--metadata.localized-description <text> <lang>
--metadata.localized-title <title> <lang>
--metadata.publisher <name>
--metadata.title <text>
--output <filename>
--raw-metadata <text>
--resource-bundle-list <filename>
--runtime-shared-libraries [url] [...]
--runtime-shared-library-path [path-element] [rsl-url] [policy-file-url] [rsl-url] [policy-file-url]
--static-link-runtime-shared-libraries
--target-player <version>
--use-network
--verify-digests
--version
--warnings
-

data/doc/mxmlc-list.txt

@@ -1,55 +0,0 @@
-Adobe Flex Compiler (mxmlc)
-Version 4.0.0 build 10485
-Copyright (c) 2004-2009 Adobe Systems, Inc. All rights reserved.
-
-
--benchmark
--compiler.accessible
--compiler.actionscript-file-encoding <string>
--compiler.context-root <context-path>
--compiler.debug
--compiler.enable-runtime-design-layers
--compiler.extensions.extension [extension] [parameters] [...]
--compiler.external-library-path [path-element] [...]
--compiler.fonts.advanced-anti-aliasing
--compiler.fonts.flash-type
--compiler.fonts.max-glyphs-per-face <string>
--compiler.include-libraries [library] [...]
--compiler.incremental
--compiler.library-path [path-element] [...]
--compiler.locale [locale-element] [...]
--compiler.mxml.compatibility-version <version>
--compiler.namespaces.namespace [uri] [manifest] [...]
--compiler.optimize
--compiler.services <filename>
--compiler.show-actionscript-warnings
--compiler.show-binding-warnings
--compiler.show-shadowed-device-font-warnings
--compiler.show-unused-type-selector-warnings
--compiler.source-path [path-element] [...]
--compiler.strict
--compiler.theme [filename] [...]
--compiler.use-resource-bundle-metadata
--framework <string>
--help [keyword] [...]
--include-resource-bundles [bundle] [...]
--licenses.license <product> <serial-number>
--load-config <filename>
--metadata.contributor <name>
--metadata.creator <name>
--metadata.date <text>
--metadata.description <text>
--metadata.language <code>
--metadata.localized-description <text> <lang>
--metadata.localized-title <title> <lang>
--metadata.publisher <name>
--metadata.title <text>
--output <filename>
--runtime-shared-libraries [url] [...]
--runtime-shared-library-path [path-element] [rsl-url] [policy-file-url] [rsl-url] [policy-file-url]
--static-link-runtime-shared-libraries
--target-player <version>
--use-network
--version
--warnings
-