flashsdk 1.0.20.pre → 1.0.21.pre

data/POSTINSTALL.rdoc

@@ -32,6 +32,26 @@ Next Steps:
   sprout-
   (followed by the TAB key)
 
+++++++++++++++++++++++++++++++++
+To use FCSH, simply start the service,
+and call the fcsh task before any other
+mxmlc or compc task:
+
+  # Open a new terminal and from your project:
+  rake fcsh:start
+
+  # Open a new terminal and from your project:
+  rake fcsh test
+
+++++++++++++++++++++++++++++++++
+To use FDB, simply call the fdb task
+before any flashplayer task:
+
+  # Run the default task with FDB:
+  rake fdb test
+
+  (type, 'help' for more info when prompted)
+
 ++++++++++++++++++++++++++++++++
 Issues or Questions? 
 

data/VERSION

@@ -1 +1 @@
-1.0.20.pre
+1.0.21.pre

data/lib/flashsdk/asdoc.rb

@@ -0,0 +1,140 @@
+module FlashSDK
+
+  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, Path
+    
+    ##
+    # 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
+      start = Time.now
+      super
+      duration = (Time.now - start).seconds
+      Sprout.stdout.puts "[ASDOC] Creation complete in #{duration} seconds."
+    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/compiler_base.rb

@@ -661,6 +661,19 @@ module FlashSDK
 
     protected
 
+    def update_fcsh
+      # 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
+
+      if !ENV['FCSH_PORT'].nil?
+        self.fcsh_port = ENV['FCSH_PORT']
+      end
+    end
+
     ##
     # Template method called by {Sprout::Executable} when
     # a {Sprout::Library} is found in the Rake::Task prerequisite list.
@@ -681,17 +694,7 @@ module FlashSDK
     ##
     # 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
-
-      if !ENV['FCSH_PORT'].nil?
-        self.fcsh_port = ENV['FCSH_PORT']
-      end
-
+      update_fcsh if use_fcsh.nil?
       super
     end
 

data/lib/flashsdk/mxmlc.rb

@@ -56,6 +56,8 @@ module FlashSDK
     # This must be the last item in this list
     add_param :input, File, { :required => true, :hidden_name => true }
 
+    ##
+    # The default prefix for shell params.
     set :default_prefix, '-'
 
     ##
@@ -96,7 +98,7 @@ end
 ##
 # Create a new Rake::File task that will execute {FlashSDK::MXMLC}.
 # 
-# @return [Sprout::MXMLC]
+# @return [FlashSDK::MXMLC]
 #
 # @example The following is a simple MXMLC task:
 #
@@ -107,7 +109,7 @@ end
 #
 def mxmlc args, &block
   exe = FlashSDK::MXMLC.new
-  exe.to_rake(args, &block)
+  exe.to_rake args, &block
   exe
 end
 

data/lib/flashsdk.rb

@@ -11,6 +11,7 @@ require 'flashsdk/generators/flex_project_generator'
 require 'flashsdk/fcsh'
 require 'flashsdk/fcsh_socket'
 require 'flashsdk/compiler_base'
+require 'flashsdk/asdoc'
 require 'flashsdk/mxmlc'
 require 'flashsdk/compc'
 require 'flashsdk/amxmlc'

data/test/fixtures/asdoc/lib/OtherFile.as

@@ -0,0 +1,17 @@
+package {
+    import flash.display.Sprite;
+
+    /**
+     * Hello Documentation!
+     */
+    public class OtherFile extends Sprite {
+
+        /**
+         * This is the constructor!
+         */
+        public function OtherFile() {
+            trace(">> OtherFile instantiated");
+        }
+    }
+}
+

data/test/fixtures/asdoc/src/SomeFile.as

@@ -0,0 +1,11 @@
+package {
+    import flash.display.Sprite;
+
+    public class SomeFile extends Sprite {
+
+        public function SomeFile() {
+            trace(">> SomeFile instantiated");
+        }
+    }
+}
+

data/test/unit/asdoc_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+class AsDocTest < Test::Unit::TestCase
+  include Sprout::TestHelper
+
+  context "An AsDoc tool" do
+
+    setup do
+      @original_use_fcsh_value = ENV['USE_FCSH']
+      @fixture                 = File.join fixtures, 'asdoc'
+      @source_path             = File.join @fixture, 'src'
+      @lib_path                = File.join @fixture, 'lib'
+      @doc_output              = File.join @fixture, 'docs'
+
+      @swf_input               = File.join @fixture, 'src', 'SomeFile.as'
+      @swf_output              = File.join @fixture, 'bin', 'SomeFile.swf'
+    end
+
+    teardown do
+      remove_file @doc_output
+    end
+
+    should "generate simple documentation" do
+      t = FlashSDK::AsDoc.new
+      t.doc_sources << @source_path
+      t.doc_sources << @lib_path
+      t.output = @doc_output
+      t.execute
+
+      assert_file File.join(@doc_output, 'index.html')
+    end
+
+=begin
+    should "work with a rake task too" do
+      exe = asdoc @doc_output do |t|
+        t.doc_sources << @source_path
+        t.doc_sources << @lib_path
+      end
+      exe.execute
+    end
+=end
+
+  end
+end
+

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 20
+  - 21
   - pre
-  version: 1.0.20.pre
+  version: 1.0.21.pre
 platform: ruby
 authors: 
 - Luke Bayes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-18 00:00:00 -08:00
+date: 2011-01-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -95,6 +95,7 @@ files:
 - lib/flashsdk/adl.rb
 - lib/flashsdk/adt.rb
 - lib/flashsdk/amxmlc.rb
+- lib/flashsdk/asdoc.rb
 - lib/flashsdk/compc.rb
 - lib/flashsdk/compiler_base.rb
 - lib/flashsdk/fcsh.rb
@@ -128,6 +129,8 @@ files:
 - test/fixtures/air/simple/SomeProject.pfx
 - test/fixtures/air/simple/SomeProject.swf
 - test/fixtures/air/simple/SomeProject.xml
+- test/fixtures/asdoc/lib/OtherFile.as
+- test/fixtures/asdoc/src/SomeFile.as
 - test/fixtures/compc/simple/SomeFile.as
 - test/fixtures/flashplayer/AsUnit Runner.swf
 - test/fixtures/mxmlc/broken/SomeFile.as
@@ -137,6 +140,7 @@ files:
 - test/unit/adl_test.rb
 - test/unit/adt_test.rb
 - test/unit/amxmlc_test.rb
+- test/unit/asdoc_test.rb
 - test/unit/class_generator_test.rb
 - test/unit/compc_test.rb
 - test/unit/fcsh_socket_test.rb
@@ -192,6 +196,26 @@ post_install_message: |+
     sprout-
     (followed by the TAB key)
   
+  ++++++++++++++++++++++++++++++++
+  To use FCSH, simply start the service,
+  and call the fcsh task before any other
+  mxmlc or compc task:
+  
+    # Open a new terminal and from your project:
+    rake fcsh:start
+  
+    # Open a new terminal and from your project:
+    rake fcsh test
+  
+  ++++++++++++++++++++++++++++++++
+  To use FDB, simply call the fdb task
+  before any flashplayer task:
+  
+    # Run the default task with FDB:
+    rake fdb test
+  
+    (type, 'help' for more info when prompted)
+  
   ++++++++++++++++++++++++++++++++
   Issues or Questions?