h4oflashsdk 1.0.0

data/lib/flashsdk/generators/class_generator.rb

@@ -0,0 +1,87 @@
+
+module FlashSDK
+
+  ##
+  # This Generator will create a new ActionScript class
+  # based on the +ActionScript3Class.as+ template.
+  #
+  # This Generator should only be executed from within
+  # a project that has a Gemfile. If your Gemfile
+  # loads the "asunit4" gem, a test case and test suite
+  # will also be created whenever this generator is run.
+  #
+  # You can run this generator as follows:
+  #
+  #   $ sprout-class utils.MathUtil
+  # 
+  # You can prevent the creation of a test case and test 
+  # suite by sending in the +--no-test+ parameter as follows:
+  #
+  #   $ sprout-class utils.MathUtil --no-test
+  #
+  class ClassGenerator < Sprout::Generator::Base
+    include FlashHelper
+    
+    ##
+    # @return [String] The default package to use.    
+    add_param :package, String, { :default => ""}
+    
+    ##
+    # @return [String] The path where assets will be created.
+    add_param :assets, String, { :default => 'assets' }
+
+    ##
+    # @return [String] The path where skins will be created.
+    add_param :skins, String, { :default => 'skins' }
+
+    ##
+    # @return [String] The path where test cases should be created.
+    add_param :test, String, { :default => 'test' }
+
+    ##
+    # @return [String] The path where libraries should be added.
+    add_param :lib, String, { :default => 'lib' }
+
+    ##
+    # @return [String] The path where binaries should be created.
+    add_param :bin, String, { :default => 'bin' }
+
+    ##
+    # @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 }
+
+    def manifest
+      if(!input.match(/Test$/))
+        directory class_directory do
+          template "#{class_name}.as", 'ActionScript3Class.as'
+        end
+      end
+
+      if test_class
+        generator :test_class, :input => "#{fully_qualified_class_name}Test"
+      end
+    end
+
+  end
+end
+
+module FlashSDK
+  ##
+  # This is a null Generator, if you add a test library
+  # to your Gemfile, it should have it's own TestClassGenerator
+  # that supercedes this one.
+  class TestClassGenerator < Sprout::Generator::Base
+
+    def manifest
+    end
+  end
+end
+

data/lib/flashsdk/generators/flash_helper.rb

@@ -0,0 +1,234 @@
+
+module FlashSDK
+
+  ##
+  # The FlashHelper is a module that can be included into any {Sprout::Generator}
+  # in order to provide support for many common features.
+  #
+  # @example An example of how to use this helper:
+  #
+  #   require 'flashsdk'
+  #
+  #   class BigFatGenerator < Sprout::Generator::Base
+  #     include FlashSDK::FlashHelper
+  #
+  #     ...
+  #   end
+  #
+  module FlashHelper
+
+    protected
+    
+    ##
+    # @return [String] The directory of the package based on the +input+ string.
+    def package_directory
+      if package.include?('/')
+        remove_slashes package
+      end
+        split_package package
+    end
+    
+    ##
+    # @param [String] A directory or path on disk with slashes like ('/')
+    # @return [String] The provided value with slashes replaced by dots.
+    def remove_slashes(value)
+      if value.include?('/')
+        value = value.split('/').join('.')
+      end
+      return value
+    end
+    
+    ##
+    # @param value [String] A fully-qualified package or class name (com.example.project.SomeClass)
+    # @return [Array<String>] The provided package or class name split on the period.
+    #   split on dots.
+    def split_package(value) 
+      value.split('.')
+    end
+    
+    ##
+    # @return [String] The directory for test cases that are related to the class provided by +input+
+    def test_class_directory
+      parts = input_in_parts
+      if parts.size > 1
+        parts.pop
+        return File.join test, *parts
+      end
+      return test
+    end
+
+    ##
+    # @return [String] Glob that is used to search for test cases and build
+    #   up the test suites.
+    def test_glob
+      return @test_glob ||= File.join(path, test, '**', '?*Test.as')
+    end
+
+    # @return [String] The provided or default glob.
+    def test_glob= glob
+      @test_glob = glob
+    end
+
+    ##
+    # @return [Array<File>] Collection of all test case files either assigned or found
+    # using the test_glob as provided.
+    def test_cases
+      @test_cases ||= Dir.glob(test_glob)
+    end
+
+    ##
+    # @param [Array<String>] Set the collection of test cases as Files on disk. 
+    # @return [Array<String>] Collection of all test case files that were assigned or found.
+    def test_cases= collection
+      @test_cases = collection
+    end
+
+    ##
+    # @return [Array<String>] Get the list of test_cases (which are files) as a
+    # list of fully qualified class names.
+    def test_case_classes
+      classes = self.test_cases.dup
+      classes.collect do |file|
+        actionscript_file_to_class_name(file)
+      end
+    end
+
+    ##
+    # Transform a file name in the source or test path
+    # into a fully-qualified class name.
+    #
+    # @param file [File] The path to a file on disk that is in the +src+ or +test+ folder.
+    # @return [String] The fully-qualified class name.
+    def actionscript_file_to_class_name file
+      name = file.dup
+      name.gsub!(/^#{path}\//, '') if respond_to? :path
+      name.gsub!(/^#{test}\//, '') if respond_to? :test
+      name.gsub!(/^#{src}\//, '') if respond_to? :src
+      name.gsub!(/.as$/, '')
+      name.gsub!(/#{File::SEPARATOR}/, '.')
+      return name
+    end
+
+    ##
+    # @return [String] The directory that contains the +input+ class.
+    def class_directory
+      parts = input_in_parts
+      if parts.size > 1
+        parts.pop
+        return File.join src, *parts
+      end
+      return src
+    end
+
+    ##
+    # @return [String] The package that provided on the command line at +--package+
+    def default_package_name
+      remove_slashes package
+    end
+    
+    ##
+    # @return [String] The package that was provided on the command line at +--input+
+    def package_name
+      parts = input_in_parts
+      if parts.size > 1
+        parts.pop
+        return "#{parts.join('.')} "
+      end
+      return ""
+    end
+
+    ##
+    # @return [String] The fully-qualified class name provided on the command line at +--input+.
+    def class_name
+      parts = input_in_parts
+      name = parts.pop.camel_case
+      if(name.match(/Test$/))
+        return name.gsub(/Test$/, '')
+      end
+      name
+    end
+
+    ##
+    # @return [String] The fully-qualified test class name based on the +--input+ 
+    #   argument provided on the command line.
+    def test_class_name
+      source = class_name
+      if(!source.match(/Test$/))
+        return "#{source}Test"
+      end
+      source
+    end
+
+    ##
+    # @return [String] The project name provided as +--input+ on the command line.
+    #   This is probably only helpful for project generators.
+    def project_name
+      input.camel_case
+    end
+
+    ##
+    # @return [String] Currently returns hard-coded 'instance'.
+    def instance_name
+      # TODO: should uncapitalize class_name
+      # (not the same as lowercase)
+      # If the name is > 12 character, just
+      # use 'instance' instead.
+      'instance'
+    end
+
+    ##
+    # @param value [String] If no value is provided, will use +--input+ instead.
+    # @return [Array<String>] An Array of the provided string split on slahes
+    #   or dots with the file extension removed.
+    def input_in_parts(value=nil)
+      provided_input = value || input.dup
+      provided_input.gsub! /^#{src}\//, '' if respond_to? :src
+      provided_input = provided_input.split('/').join('.')
+
+      remove_file_extensions(provided_input).split('.')
+    end
+
+    ##
+    # @return [String] The fully qualified class name version of whatever was +input+.
+    def fully_qualified_class_name
+      remove_slashes remove_file_extensions(input)
+    end
+    
+    ##
+    # @param value [String] A string that may have a file extension.
+    # @return [String] A new String with common file extensions 
+    #   (.as, .mxml, .xml) removed from the provided value.
+    def remove_file_extensions value
+      value = value.dup
+      value.gsub!(/\.as$/, '')
+      value.gsub!(/\.mxml$/, '')
+      value.gsub!(/\.xml$/, '')
+      return value
+    end
+
+    ##
+    # @return [String] The +class_name+ with '.swf' appended.
+    def deploy_swf_name
+      "#{class_name}.swf"
+    end
+
+    ##
+    # @return [String] The +class_name+ with '-debug.swf' appended.
+    def debug_swf_name
+      "#{class_name}-debug.swf"
+    end
+
+    ##
+    # @return [String] The +class_name+ with '-test.swf' appendend.
+    def test_swf_name
+      "#{class_name}-test.swf"
+    end
+
+    ##
+    # @return [String] The +class_name+ with 'Runner.swf' appended.
+    def test_runner_name
+      "#{class_name}Runner"
+    end
+
+  end
+end

data/lib/flashsdk/generators/flex_project_generator.rb

@@ -0,0 +1,30 @@
+module FlashSDK
+  class FlexProjectGenerator < ProjectGenerator
+
+    def manifest
+      directory input do
+        template 'Rakefile', 'Flex4Rakefile.rb'
+        template 'Gemfile'
+
+        directory src do
+          template "#{input.camel_case}.mxml", 'Flex4Application.mxml'
+          template "#{test_runner_name}.mxml", 'Flex4RunnerClass.mxml'
+
+          directory assets do
+            directory css do
+              file 'Main.css', 'Flex4Main.css'
+            end
+            directory images
+            directory fonts
+          end
+
+        end
+
+        # Create empty directories:
+        directory lib
+        directory bin
+      end
+    end
+
+  end
+end

data/lib/flashsdk/generators/project_generator.rb

@@ -0,0 +1,31 @@
+module FlashSDK
+  class ProjectGenerator < ClassGenerator
+
+    add_param :css, Path, { :default => 'css' }
+    add_param :images, Path, { :default => 'images' }
+    add_param :fonts, Path, { :default => 'fonts' }    
+        
+    def manifest
+      directory input do
+        template 'rakefile.rb'
+        template 'Gemfile'
+
+        directory src do
+          template "#{input.camel_case}.as", 'ActionScript3MainClass.as'
+          template "#{test_runner_name}.as", 'ActionScript3RunnerClass.as'
+        end
+
+        directory assets do
+          directory skins do
+            file 'DefaultProjectImage.png'
+          end
+        end
+
+        # Create empty directories:
+        directory lib
+        directory bin
+      end
+    end
+
+  end
+end

data/lib/flashsdk/generators/templates/ActionScript3Class.as

@@ -0,0 +1,9 @@
+package <%= package_name %>{
+
+    public class <%= class_name %> {
+
+        public function <%= class_name %>() {
+        }
+    }
+}
+

data/lib/flashsdk/generators/templates/ActionScript3MainClass.as

@@ -0,0 +1,11 @@
+package <%= package_name %>{
+    import flash.display.Sprite;
+
+    public class <%= class_name %> extends Sprite {
+
+        public function <%= class_name %>() {
+            trace(">> <%= class_name %> Instantiated!");
+        }
+    }
+}
+

data/lib/flashsdk/generators/templates/ActionScript3RunnerClass.as

@@ -0,0 +1,19 @@
+package {
+    import asunit.core.TextCore;
+    import flash.display.MovieClip;
+
+    public class <%= test_runner_name %> extends MovieClip {
+        
+        private var core:TextCore;
+
+        public function <%= test_runner_name %>() {
+            core = new TextCore();
+            // You can run a single Test Case with:
+            // core.start(SomeTest, null, this);
+            // Or a single test method with:
+            // core.start(SomeTest, 'testMethod', this);
+            core.start(AllTests, null, this);
+        }
+    }
+}
+

data/lib/flashsdk/generators/templates/Flex4Application.mxml

@@ -0,0 +1,45 @@
+<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
+               xmlns:s="library://ns.adobe.com/flex/spark"
+               xmlns:mx="library://ns.adobe.com/flex/mx"
+               minWidth="800"
+               minHeight="600"
+               width="1024"
+               height="768"
+               pageTitle="<%= project_name %>"
+               applicationComplete="<%= project_name %>CompleteHandler()">
+
+    <fx:Declarations>
+
+        <!-- You have to put all non-visual object declarations here -->
+
+    </fx:Declarations>
+
+    <s:Label id="myLabel"
+             text="<%= project_name %>"
+             width="100%"
+             height="100%"
+             fontSize="200" />
+
+    <fx:Style source="./assets/css/Main.css" />
+
+    <fx:Script>
+
+        <![CDATA[
+             
+             //---------------------------------------
+             // PRIVATE METHODS
+             //---------------------------------------
+
+             /**
+              * @private
+              */
+             private function <%= project_name %>CompleteHandler():void
+             {
+                 trace("<%= project_name %>.mxml::<%= project_name %>CompleteHandler()");
+             }
+         ]]>
+
+</fx:Script>
+
+</s:Application>
+

data/lib/flashsdk/generators/templates/Flex4Main.css

@@ -0,0 +1,7 @@
+@namespace "library://ns.adobe.com/flex/spark";
+@namespace mx "library://ns.adobe.com/flex/mx";
+
+Application
+{
+    background-color: #666666;
+}

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

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require
+
+##############################
+# Debug
+
+# Compile the debug swf
+mxmlc "<%= bin %>/<%= debug_swf_name %>" do |t|
+  t.input = "<%= src %>/<%= class_name %>.mxml"
+  t.debug = true
+end
+
+desc "Compile and run the debug swf"
+flashplayer :debug => "<%= bin %>/<%= debug_swf_name %>"
+
+##############################
+# Test
+
+library :asunit4
+
+# Compile the test swf
+mxmlc "<%= bin %>/<%= test_swf_name %>" => :asunit4 do |t|
+  t.input = "<%= src %>/<%= test_runner_name %>.mxml"
+  t.source_path << "test"
+  t.default_size = "900,550"
+  t.debug = true
+end
+
+desc "Compile and run the test swf"
+flashplayer :test => "<%= bin %>/<%= test_swf_name %>"
+
+task :default => :debug
+

data/lib/flashsdk/generators/templates/Flex4RunnerClass.mxml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="utf-8"?>
+<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
+               xmlns:s="library://ns.adobe.com/flex/spark"
+               xmlns:mx="library://ns.adobe.com/flex/mx"
+               creationComplete="creationCompleteHandler(event)">
+
+    <fx:Script>
+
+        <![CDATA[
+            import asunit.core.TextCore;
+            import mx.core.UIComponent;
+
+            private var core:TextCore;
+            
+            private function creationCompleteHandler(event:Event):void 
+            {
+                // Flex 4 complains when we use UICompenent from MXML... Boo.
+                var visualContext:UIComponent = new UIComponent();
+                addElement(visualContext);
+
+                core = new TextCore();
+                core.start(AllTests, null, visualContext);
+            }
+        ]]>
+
+	</fx:Script>
+
+</s:Application>
+

data/lib/flashsdk/generators/templates/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem "h4oflashsdk", ">= 1.0.0"
+gem "asunit4", ">= 4.2.3.pre"
+

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

@@ -0,0 +1,79 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/setup'
+
+require 'rake/clean'
+require 'flashsdk'
+require 'asunit4'
+
+##
+# Set USE_FCSH to true in order to use FCSH for all compile tasks.
+#
+# You can also set this value by calling the :fcsh task 
+# manually like:
+#
+#   rake fcsh run
+#
+# These values can also be sent from the command line like:
+#
+#   rake run FCSH_PKG_NAME=flex3
+#
+# ENV['USE_FCSH']         = true
+# ENV['FCSH_PKG_NAME']    = 'flex4'
+# ENV['FCSH_PKG_VERSION'] = '1.0.14.pre'
+# ENV['FCSH_PORT']        = 12321
+
+##############################
+# Debug
+
+# Compile the debug swf
+mxmlc "<%= bin %>/<%= debug_swf_name %>" do |t|
+  t.input = "<%= src %>/<%= class_name %>.as"
+  t.static_link_runtime_shared_libraries = true
+  t.debug = true
+end
+
+desc "Compile and run the debug swf"
+flashplayer :run => "<%= bin %>/<%= debug_swf_name %>"
+
+##############################
+# Test
+
+library :asunit4
+
+# Compile the test swf
+mxmlc "<%= bin %>/<%= test_swf_name %>" => :asunit4 do |t|
+  t.input = "<%= src %>/<%= test_runner_name %>.as"
+  t.static_link_runtime_shared_libraries = true
+  t.source_path << 'test'
+  t.debug = true
+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.static_link_runtime_shared_libraries = true
+  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
+