h4oflashsdk 1.0.0

data/lib/flashsdk/adt.rb

@@ -0,0 +1,276 @@
+module FlashSDK
+
+  ##
+  # Creates AIR certificates and compiles AIR packages for distribution.
+  #
+  # Following is an example of how this tool might be used to create
+  # a certificate and AIR package:
+  #
+  #   mxmlc 'bin/SomeProject.swf' do |t|
+  #     t.input = 'src/SomeProject.as'
+  #   end
+  #
+  #   adt 'cert/SomeProject.pfx' do |t|
+  #     t.certificate = true
+  #     t.cn          = 'SelfCertificate'
+  #     t.key_type    = '2048-RSA'
+  #     t.pfx_file    = 'cert/SomeProject.pfx'
+  #     # Don't check the .password file into version control:
+  #     t.password    = File.read('cert/.password')
+  #   end
+  #
+  #   adt 'bin/SomeProject.air' => ['bin/SomeProject.swf', 'cert/SomeProject.pfx'] do |t|
+  #     t.package        = true
+  #     t.package_input  = 'SomeProject.xml'
+  #     t.package_output = 'bin/SomeProject.air'
+  #     t.storetype      = 'PKCS12'
+  #     t.keystore       = 'cert/SomeProject.pfx'
+  #     # Don't check the .password file into version control:
+  #     t.storepass      = File.read('cert/.password')
+  #     t.included_files << 'bin/SomeProject.swf'
+  #   end
+  #
+  #   desc "Compile, certify and package the AIR application"
+  #   task package => 'bin/SomeProject.air'
+  #
+  class ADT < Sprout::Executable::Base
+    #NOTE:
+    # The order of these parameters is important!
+    # Please do not alphabetize or rearrange unless you're
+    # fixing a bug related to how ADT actually expects
+    # the arguments...
+    
+    ##
+    # Install an app on a device
+    #
+    add_param :installApp, Boolean, { :hidden_value => true }
+
+    ##
+    # Uninstall an app from a device
+    #
+    add_param :uninstallApp, Boolean, { :hidden_value => true }
+    
+    ##
+    # Launch an app on a device
+    #
+    add_param :launchApp, Boolean, { :hidden_value => true }
+    
+    ##
+    # The platform to use (ex: android)
+    #
+    add_param :platform, String, { :delimiter => ' ' }
+
+    ##
+    # The appid of the app being installed/uninstalled (ex: com.foo.Bar)
+    #
+    add_param :appid, String, { :delimiter => ' ' }
+    
+    ##
+    # Create an AIR package.
+    #
+    add_param :package, Boolean, { :hidden_value => true }
+
+    ##
+    # Set true to create a certificate.
+    #
+    # If this value is true, you can optionally set org_unit, org_name and country.
+    # 
+    # If this value is true, you MUST set +cn+, +key_type+, and +pfx_file+.
+    #
+    #  adt 'cert/SampleCert.pfx' do |t|
+    #    t.certificate = true
+    #    t.cn = 'SelfCertificate'
+    #    t.key_type = '1024-RSA'
+    #    t.pfx_file = 'cert/SampleCert.pfx'
+    #    t.password = 'samplepassword'
+    #  end
+    #
+    add_param :certificate, Boolean, { :hidden_value => true }
+
+    ##
+    # A Signing Option
+    #
+    add_param :storetype, String, { :delimiter => ' ' }
+
+
+    ##
+    # A Signing Option
+    #
+    add_param :keystore, String, { :delimiter => ' ' }
+
+    ##
+    # Provide the password directly to the ADT task
+    # so that it doesn't attempt to prompt.
+    #
+    add_param :storepass, String, { :delimiter => ' ' }
+
+
+    ##
+    # A Signing Option
+    #
+    add_param :keypass, String, { :delimiter => ' ' }
+
+
+    ##
+    # A Signing Option
+    #
+    add_param :providername, String, { :delimiter => ' ' }
+
+
+    ##
+    # A Signing Option
+    #
+    add_param :tsa, String
+    
+    ##
+    # Check Store Signing options
+    #
+    add_param :checkstore, String
+
+    ##
+    # Provisioning profile for iOS apps
+    #
+    add_param :provisioning_profile, String, { :delimiter => ' ' }
+
+    ##
+    # Expects two files:
+    #
+    # 1) The Airi file (?)
+    # 2) The application description
+    #add_param :prepare, Files
+
+    ##
+    # Expects two files:
+    #
+    # 1) The Airi file (?)
+    # 2) The Air file
+    add_param :sign, Files, { :delimiter => ' ' }
+
+
+    ##
+    # The AIR runtime version to use.
+    add_param :version, String, { :delimiter => ' ' }
+
+
+    ##
+    # Use a specific target, like apk-debug for Android or ipa-debug for iOS
+    #
+    add_param :target, String, { :delimiter => ' ' }
+
+    ##
+    # The AIR file that should be created
+    # after packaging is complete.
+    #
+    add_param :package_output, String, { :hidden_name => true }
+
+    ##
+    # The XML application descriptor that
+    # should be used to create an AIR
+    # application.
+    #
+    add_param :package_input, File, { :hidden_name => true }
+
+    ##
+    # Organization unit, follows certificate.
+    #
+    add_param :org_unit, String
+
+    ##
+    # Organization name, follows certificate.
+    #
+    add_param :org_name, String
+
+    ##
+    # Country, follows certificate.
+    #
+    add_param :country, String
+
+    ##
+    # The Certificate name.
+    #
+    add_param :cn, String, { :delimiter => ' ' }
+
+    ##
+    # Key Type, follows certificate.
+    #
+    add_param :key_type, String, { :hidden_name => true }
+
+    ##
+    # PFX File
+    #
+    add_param :pfx_file, String, { :hidden_name => true }
+
+    ##
+    # When creating a certificate, this is the file
+    # where the password can be found.
+    #
+    add_param :password, String, { :hidden_name => true, :delimiter => ' ' }
+
+    ##
+    # Expects Signing Options, plus
+    # two files:
+    #
+    # 1) The Air file in
+    # 2) The Air file out
+    #
+    add_param :migrate, Files
+
+    ##
+    # A list of files to include in the 
+    #
+    add_param :included_files, Files, { :hidden_name => true }
+
+    ##
+    # A list of paths (directories) to search
+    # for contents that will be included in the
+    # packaged AIR application.
+    #
+    # If files are hidden from the file system,
+    # they will not be included.
+    #
+    add_param :included_paths, Paths, { :hidden_name => true }
+    
+    ##
+    # Allows file options in the form of -C <dir> <fileOrDir>+
+    #
+    # For example if you defined:
+    #
+    #    t.file_options    << 'dir path/to/asset.xml'
+    #
+    # In your adt task defintion, then:
+    #
+    #    -C dir path/to/asset.xml
+    #
+    # Would be appended to your arguments.
+    #
+    add_param :file_options, Strings, { :shell_name => '-C', :delimiter => ' ' }
+
+    ##
+    # 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, :adt
+
+    ##
+    # Ensure the default prefix is '-'
+    set :default_prefix, '-'
+  end
+end
+
+def adt *args, &block
+  exe = FlashSDK::ADT.new
+  exe.to_rake(*args, &block)
+  exe
+end

data/lib/flashsdk/amxmlc.rb

@@ -0,0 +1,28 @@
+module FlashSDK
+
+  ##
+  # This is a wrapper for the AIR MXMLC compiler.
+  class AMXMLC < MXMLC 
+
+    ##
+    # The default executable target.
+    #
+    set :executable, :amxmlc
+
+    ##
+    # TODO: Remove this method once this bug is fixed:
+    # http://www.pivotaltracker.com/story/show/4194771
+    #
+    def execute *args
+      self.executable = :amxmlc
+      super
+    end
+  end
+end
+
+def amxmlc *args, &block
+  exe = FlashSDK::AMXMLC.new
+  exe.to_rake *args, &block
+  exe
+end
+

data/lib/flashsdk/asdoc.rb

@@ -0,0 +1,164 @@
+module FlashSDK
+
+  ##
+  # The AsDoc executable is a wrapper around the Flex SDK binary of the same name.
+  #
+  # Following is a simple example of the asdoc Rake task:
+  #
+  #   desc "Generate documentation at <%= doc %>/"
+  #   asdoc 'doc' do |t|
+  #     t.doc_sources << 'src'
+  #
+  #     # Exclude test main file
+  #     t.exclude_sources << 'src/SomeProjectRunner.as'
+  #   end
+  #
+  # @see CompilerBase
+  #
+  class AsDoc < CompilerBase
+
+    ##
+    # The default prefix for shell params.
+    set :default_prefix, '-'
+
+    ##
+    # 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, :asdoc
+
+    ##
+    # Boolean specifies whether to include the date in the footer.
+    add_param :date_in_footer, Boolean
+
+    ##
+    # List of source file to include in the documentation.
+    add_param :doc_sources, Files
+    add_param_alias :ds, :doc_sources
+
+    ##
+    # List of classes to include in the documentation.
+    add_param :doc_classes, Strings
+
+    ##
+    # List of namespaces to include in the documentation.
+    add_param :doc_namespaces, Strings
+
+    ##
+    # Path to look for the example files.
+    add_param :examples_path, Paths
+
+    ##
+    # Classes to exclude from documentation.
+    add_param :exclude_classes, Strings
+
+    ##
+    # Boolean specifying whether to exclude dependencies.
+    add_param :exclude_dependencies, Boolean
+
+    ##
+    # List of source files to exclude form the documentation.
+    add_param :exclude_sources, Files
+
+    ##
+    # Footer string to be displayed in the documentation.
+    add_param :footer, String
+
+    add_param :include_all_for_asdoc, Boolean
+
+    ##
+    # If true, manifest entries with lookupOnly=true are included in SWC 
+    # catalog. Default is false. (advanced)
+    add_param :include_lookup_only, Boolean, { :default => false }
+
+    ##
+    # Width of the left frame.
+    add_param :left_frameset_width, Number
+
+    ##
+    # Report well-formed HTML errors as warnings.
+    add_param :lenient, Boolean
+
+    ##
+    # Title to be displayed in the title bar.
+    add_param :main_title, String
+
+    ##
+    # File containing description for packages.
+    add_param :package_description_file, Files
+
+    ##
+    # Specifies a description for a package name.
+    add_param :package, Strings, { :delimiter => ' ' }
+    
+    ##
+    # Path for custom templates.
+    add_param :templates_path, Path
+
+    ##
+    # Title to be displayed in the browser window.
+    add_param :window_title, String
+
+    # TODO: Possibly remove the following from the CompilerBase
+    #
+    # include_resource_bundles
+
+    def execute
+      # Never use fcsh for asdoc
+      # (overused inheritance smell)
+      self.use_fcsh = false
+      duration = Benchmark.measure { super }
+      Sprout.stdout.puts "[ASDOC] Creation complete in #{duration} seconds."
+    end
+
+    protected
+
+    ##
+    # Override the default behavior that creates a file task, 
+    # and create a 'task' instead. This will force the docs
+    # to get recreated with every run, instead of failing to
+    # create when the outer folder still exists.
+    def create_outer_task *args
+      Rake::Task.define_task *args do
+        execute
+      end
+    end
+  end
+end
+
+##
+# Create a new Rake::File task that will execute {FlashSDK::AsDoc}.
+#
+# @return [FlashSDK::AsDoc]
+#
+# @example The following is a simple AsDoc task:
+#
+#   desc "Compile the SWF"
+#   mxmlc 'bin/SomeProject.swf' do |t|
+#     t.library_path << 'lib/corelib.swc'
+#     t.input = 'src/SomeProject.as'
+#   end
+#
+#   desc "Generate documentation"
+#   asdoc 'docs/' do |t|
+#     t.doc_sources << 'src'
+#   end
+#
+def asdoc args, &block
+  exe = FlashSDK::AsDoc.new
+  exe.to_rake args, &block
+  exe
+end
+

data/lib/flashsdk/compc.rb

@@ -0,0 +1,124 @@
+module FlashSDK
+
+  ##
+  # The COMPC compiler is a tool that creates SWC libraries from source code.
+  #
+  # Following is an example of the creation of a simple SWC file:
+  #
+  #   compc 'bin/SomeProject.swc' do |t|
+  #     t.include_classes << 'SomeProject'
+  #     t.source_path << 'src'
+  #   end
+  #
+  #   desc 'Compile the SWC'
+  #   task :swc => 'bin/SomeProject.swc'
+  #
+  class COMPC < CompilerBase
+
+    ##
+    # Outputs the SWC content as a SWF into an open directory format rather than a SWC file.
+    #
+    # This is especially useful for creating Runtime Shared Libraries.
+    #
+    #   compc "bin/rsls/foo" do |t|
+    #     t.directory = true
+    #     t.include_sources = 'src'
+    #   end
+    #
+    # @see Sprout::COMPC#include_sources
+    #
+    add_param :directory, Boolean
+
+    ##
+    # Specifies classes to include in the SWC file. You provide the class name (for example, MyClass) rather than the file name (for example, MyClass.as) to the file for this option. As a result, all classes specified with this option must be in the compiler's source path. You specify this by using the source-path compiler option.
+    #
+    # You can use packaged and unpackaged classes. To use components in namespaces, use the include-namespaces option.
+    #
+    # If the components are in packages, ensure that you use dot-notation rather than slashes to separate package levels.
+    #
+    # This is the default option for the component compiler.
+    #
+    add_param :include_classes, Strings
+
+    add_param_alias :ic, :include_classes
+
+
+    ##
+    # Adds the file to the SWC file. This option does not embed files inside the library.swf file. This is useful for skinning and theming, where you want to add non-compiled files that can be referenced in a style sheet or embedded as assets in MXML files.
+    #
+    # If you use the [Embed] syntax to add a resource to your application, you are not required to use this option to also link it into the SWC file.
+    #
+    # For more information, see Adding nonsource classes (http://livedocs.adobe.com/flex/201/html/compilers_123_39.html#158900).
+    #
+    add_param :include_file, Files
+
+    add_param :include_lookup_only, Boolean
+
+    ##
+    # Specifies namespace-style components in the SWC file. You specify a list of URIs to include in the SWC file. The uri argument must already be defined with the namespace option.
+    #
+    # To use components in packages, use the include-classes option.
+    #
+    add_param :include_namespaces, Strings
+
+    ##
+    # Specifies the resource bundles to include in this SWC file. All resource bundles specified with this option must be in the compiler's source path. You specify this using the source-path compiler option.
+    #
+    # For more information on using resource bundles, see Localizing Flex Applications (http://livedocs.adobe.com/flex/201/html/l10n_076_1.html#129288) in Flex 2 Developer's Guide.
+    #
+    add_param :include_resource_bundles, Files
+
+    ##
+    # Specifies classes or directories to add to the SWC file. When specifying classes, you specify the path to the class file (for example, MyClass.as) rather than the class name itself (for example, MyClass). This lets you add classes to the SWC file that are not in the source path. In general, though, use the include-classes option, which lets you add classes that are in the source path.
+    #
+    # If you specify a directory, this option includes all files with an MXML or AS extension, and ignores all other files.
+    #
+    #   compc "bin/SomeProject.swc" do |t|
+    #     t.include_sources << 'src'
+    #     t.library_path << 'lib/somelib.swc'
+    #   end
+    #
+    # You'll need to be sure your source path and library path are both set up properly for this work.
+    #
+    add_param :include_sources, Paths
+
+    ##
+    # Defines the mapping between your namespaces and the manifest.xml file describing the classes in that namespace.
+    #
+    #   compc "bin/SomeProject.swc" do |t|
+    #     t.namespace = 'http://sprouts.org/ui sprouts-manifest.xml'
+    #   end
+    add_param :namespace, String
+
+    ##
+    # Main source Class to send compiler.
+    # If used, this should be the last item in the list
+    add_param :input_class, String, { :hidden_name => true }
+
+
+    ##
+    # 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, :compc
+  end
+end
+
+def compc args, &block
+  exe = FlashSDK::COMPC.new
+  exe.to_rake(args, &block)
+  exe
+end
+