flashsdk 1.0.1.pre

data/lib/flashsdk/tasks/mxmlc_legacy.rb

@@ -0,0 +1,135 @@
+
+=begin
+    def define # :nodoc:
+      super
+
+      if(!output)
+        if(name.match(/.swf/) || name.match(/swc/))
+          self.output = name
+        end
+      end
+      
+      if(input && !input.match(/.css/) && File.exists?(input))
+        source_path << File.dirname(input)
+      end
+      
+      if(include_path)
+        include_path.each do |path|
+          process_include_path(path) if(File.directory?(path))
+        end
+      end
+      
+      self.include_path = []
+      
+      if(link_report)
+        CLEAN.add(link_report)
+      end
+      
+      source_path.uniq!
+      param_hash['source_path'].value = clean_nested_source_paths(source_path)
+      
+      CLEAN.add(output)
+      if(incremental)
+        CLEAN.add(FileList['**/**/*.cache'])
+      end
+
+      self
+    end
+    
+    protected 
+    
+    def process_include_path(path)
+      symbols = []
+      FileList["#{path}/**/*[.as|.mxml]"].each do |file|
+        next if File.directory?(file)
+        file.gsub!(path, '')
+        file.gsub!(/^\//, '')
+        file.gsub!('/', '.')
+        file.gsub!(/.as$/, '')
+        file.gsub!(/.mxml$/, '')
+        file.gsub!(/.css$/, '')
+        symbols << file
+      end
+      
+      symbols.each do |symbol|
+        self.includes << symbol
+      end
+    end
+    
+    def clean_nested_source_paths(paths)
+      results = []
+      paths.each do |path|
+        # TODO: This should only happen if: allow_source_path_overlap != true
+        if(check_nested_source_path(results, path))
+          results << path
+        end
+      end
+      return results
+    end
+    
+    def check_nested_source_path(array, path)
+      array.each_index do |index|
+        item = array[index]
+        if(item =~ /^#{path}/)
+          array.slice!(index, 1)
+        elsif(path =~ /^#{item}/)
+          return false
+        end
+      end
+      return true
+    end
+
+    # Use the swc path if possible
+    # Otherwise add to source
+    def resolve_library(library_task)
+      #TODO: Add support for libraries that don't get
+      # copied into the project
+      path = library_task.project_path
+      if(path.match(/.swc$/))
+        library_path << library_task.project_path
+      else
+        source_path << library_task.project_path
+      end
+    end
+    
+    def execute_with_fcsh(command)
+      begin
+        display_preprocess_message
+        puts FCSHSocket.execute("mxmlc #{command}")
+      rescue FCSHError => fcsh_error
+        raise fcsh_error
+      rescue StandardError => std_error
+        # TODO: Capture a more concrete error here...
+        raise MXMLCError.new("[ERROR] There was a problem connecting to the Flex Compiler SHell, run 'rake fcsh:start' in another terminal.")
+      end
+    end
+    
+    def execute(*args)
+      begin
+        start = Time.now.to_i
+        if(@use_fcsh)
+          execute_with_fcsh(to_shell)
+        else
+          super
+        end
+        Log.puts "mxmlc finished compiling #{name} in #{Time.now.to_i - start} seconds"
+      rescue ExecutionError => e
+        if(e.message.index('Warning:'))
+          # MXMLC sends warnings to stderr....
+          Log.puts(e.message.gsub('[ERROR]', '[WARNING]'))
+        else
+          raise e
+        end
+      end
+    end
+
+  end
+end
+
+# Helper method for definining and accessing MXMLC instances in a rakefile
+def mxmlc(args, &block)
+  AS3::MXMLC.define_task(args, &block)
+end
+
+=end
+

data/lib/flashsdk.rb

@@ -0,0 +1,12 @@
+require 'sprout'
+
+lib = File.expand_path File.dirname(__FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'flashsdk/module'
+require 'flashsdk/generators/flash_helper'
+require 'flashsdk/generators/class_generator'
+require 'flashsdk/generators/project_generator'
+require 'flashsdk/tasks/mxmlc'
+require 'flashplayer'
+

data/lib/flex3.rb

@@ -0,0 +1,53 @@
+
+Sprout::Specification.new do |s|
+  s.name    = 'flex3'
+  s.version = FlashSDK::VERSION
+
+  # Create an independent remote_file_target for each
+  # platform that must be supported independently.
+  #
+  # If the archive includes support for all platforms (:windows, :osx, :unix)
+  # then set platform = :universal
+  #
+  s.add_remote_file_target do |t|
+    # Apply the windows-specific configuration:
+    t.platform = :universal
+    # Apply the shared platform configuration:
+    # Remote Archive:
+    t.archive_type = :zip
+    t.url          = "http://fpdownload.adobe.com/pub/flex/sdk/builds/flex3/flex_sdk_3.4.0.9271_mpl.zip"
+    t.md5          = "ba0df5a5b7a9c901540bedaf8a4fec9e"
+
+    # Executables: (add .exe suffix if it was passed in)
+    t.add_executable :aasdoc,     "bin/aasdoc"
+    t.add_executable :acompc,     "bin/acompc"
+    t.add_executable :adl,        "bin/adl"
+    t.add_executable :adt,        "bin/adt"
+    t.add_executable :amxmlc,     "bin/amxmlc"
+    t.add_executable :asdoc,      "bin/asdoc"
+    t.add_executable :compc,      "bin/compc"
+    t.add_executable :copylocale, "bin/compc"
+    t.add_executable :digest,     "bin/digest"
+    t.add_executable :fcsh,       "bin/fcsh"
+    t.add_executable :fdb,        "bin/fdb"
+    t.add_executable :mxmlc,      "bin/mxmlc"
+    t.add_executable :optimizer,  "bin/optimizer"
+
+    # Flex framework SWCs:
+    t.add_library :flex,            "frameworks/libs/flex.swc"
+    t.add_library :framework,       "frameworks/libs/framework.swc"
+    t.add_library :rpc,             "frameworks/libs/rpc.swc"
+    t.add_library :utilities,       "frameworks/libs/utilities.swc"
+    t.add_library :playerglobal_9,  "frameworks/libs/player/9/playerglobal.swc"
+    t.add_library :playerglobal_10, "frameworks/libs/player/10/playerglobal.swc"
+
+    # AsDoc templates:
+    t.add_library :asdoc_templates, "asdoc/templates"
+
+    # Locale-Specific Flex SWCs:
+    t.add_library :airframework_en_US, "frameworks/locale/en_US/airframework_rb.swc"
+    t.add_library :framework_en_US, "frameworks/locale/en_US/framework_rb.swc"
+    t.add_library :rpc_en_US, "frameworks/locale/en_US/rpc_rb.swc"
+  end
+end
+

data/lib/flex4.rb

@@ -0,0 +1,58 @@
+
+Sprout::Specification.new do |s|
+  s.name    = 'flex4'
+  s.version = FlashSDK::VERSION
+
+  s.add_remote_file_target do |t|
+    # Apply the windows-specific configuration:
+    t.platform = :universal
+    # Apply the shared platform configuration:
+    # Remote Archive:
+    t.archive_type = :zip
+    t.url          = "http://download.macromedia.com/pub/labs/flex/4/flex4sdk_b2_100509.zip"
+    t.md5          = "6a0838c5cb33145fe88933778ddb966d"
+
+    # Executables: (add .exe suffix if it was passed in)
+    t.add_executable :aasdoc,     "bin/aasdoc"
+    t.add_executable :acompc,     "bin/acompc"
+    t.add_executable :adl,        "bin/adl"
+    t.add_executable :adt,        "bin/adt"
+    t.add_executable :amxmlc,     "bin/amxmlc"
+    t.add_executable :asdoc,      "bin/asdoc"
+    t.add_executable :compc,      "bin/compc"
+    t.add_executable :copylocale, "bin/compc"
+    t.add_executable :digest,     "bin/digest"
+    t.add_executable :fcsh,       "bin/fcsh"
+    t.add_executable :fdb,        "bin/fdb"
+    t.add_executable :mxmlc,      "bin/mxmlc"
+    t.add_executable :optimizer,  "bin/optimizer"
+
+    # Flex framework SWCs:
+    t.add_library :flex,            "frameworks/libs/flex.swc"
+    t.add_library :flex4,           "frameworks/libs/flex4.swc"
+    t.add_library :f_textlayout,    "frameworks/libs/framework_textLayout.swc"
+    t.add_library :framework,       "frameworks/libs/framework.swc"
+    t.add_library :rpc,             "frameworks/libs/rpc.swc"
+    t.add_library :sparkskins,      "frameworks/libs/sparkskins.swc"
+    t.add_library :textlayout,      "frameworks/libs/textLayout.swc"
+    t.add_library :utilities,       "frameworks/libs/utilities.swc"
+    t.add_library :playerglobal_9,  "frameworks/libs/player/9/playerglobal.swc"
+    t.add_library :playerglobal_10, "frameworks/libs/player/10/playerglobal.swc"
+
+    # AsDoc templates:
+    t.add_library :asdoc_templates, "asdoc/templates"
+
+    # Locale-Specific Flex SWCs:
+    [
+      'da_DK', 'de_DE', 'en_US', 'es_ES', 'fi_FL', 'fr_FR', 'it_IT', 'ja_JP', 
+      'ko_KR', 'nb_NO', 'nl_NL', 'pt_BR', 'ru_RU', 'sv_SE', 'zh_CN', 'zh_TW'
+    ].each do |locale|
+      t.add_library "flex_4_#{locale}".to_sym,       "frameworks/locale/#{locale}/flex4_rb.swc"
+      t.add_library "airframework_#{locale}".to_sym, "frameworks/locale/#{locale}/airframework_rb.swc"
+      t.add_library "framework_#{locale}".to_sym,    "frameworks/locale/#{locale}/framework_rb.swc"
+      t.add_library "rpc_#{locale}".to_sym,          "frameworks/locale/#{locale}/rpc_rb.swc"
+    end
+  end
+end
+
+

data/rakefile.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup
+
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+
+namespace :test do
+
+  Rake::TestTask.new(:units) do |t|
+    t.libs << "test/unit"
+    t.test_files = FileList["test/unit/*_test.rb"]
+    t.verbose = true
+  end
+
+end
+
+task :test => 'test:units'

data/test/fixtures/mxmlc/simple/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/class_generator_test.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class ClassGeneratorTest < Test::Unit::TestCase
+  include SproutTestCase
+
+  context "a new class generator" do
+
+    setup do
+      @temp = File.join(fixtures, 'generators', 'tmp')
+      FileUtils.mkdir_p @temp
+      @generator = FlashSDK::ClassGenerator.new
+      @generator.path = @temp
+      @generator.logger = StringIO.new
+
+      Sprout::Generator.register FlashSDK::ClassGenerator
+      Sprout::Generator.register FlashSDK::TestClassGenerator
+      Sprout::Generator.register FlashSDK::SuiteClassGenerator
+    end
+
+    teardown do
+      remove_file @temp
+    end
+
+    should "work with a simple class" do
+      @generator.input = 'utils.MathUtil'
+      @generator.execute
+      assert_file File.join(@temp, 'src', 'utils', 'MathUtil.as')
+    end
+
+    should "work with no package" do
+      @generator.input = 'MathUtil'
+      @generator.execute
+      assert_file File.join(@temp, 'src', 'MathUtil.as')
+    end
+
+    should "work with directory instead of dots" do
+      @generator.input = 'src/utils/MathUtil.as'
+      @generator.execute
+      assert_file File.join(@temp, 'src', 'utils', 'MathUtil.as')
+    end
+
+    should "work with directory but no source" do
+      @generator.input = 'utils/MathUtil.as'
+      @generator.execute
+      assert_file File.join(@temp, 'src', 'utils', 'MathUtil.as')
+    end
+  end
+
+end
+

data/test/unit/flash_helper_test.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class FlashHelperTest < Test::Unit::TestCase
+  include SproutTestCase
+
+  context "A FlashHelper" do
+    
+    [
+      { :input => 'com.foo.Bar', :expected => 'com.foo.Bar' }
+      #{ :input => 'com/foo/Bar.as', :expected => 'com.foo.Bar' },
+      #{ :input => 'com.out.HTML', :expected => 'com.out.HTML' },
+      #{ :input => 'bar', :expected => 'Bar' }
+    ].each do |input|
+      
+      should "return fully qualified classname for #{input[:input]}" do
+        instance = FakeGenerator.new
+        instance.input = input[:input]
+        assert_equal input[:expected], instance.fully_qualified_class_name
+      end
+    end
+  end
+end
+
+class FakeGenerator < Sprout::Generator::Base
+  include FlashSDK::FlashHelper
+end
+

data/test/unit/flashplayer_test.rb

@@ -0,0 +1,56 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class FlashPlayerTest < Test::Unit::TestCase
+  include SproutTestCase
+
+  context "The FlashPlayer module" do
+
+    context "should find home" do
+
+      setup do
+        @fixture = File.join(fixtures, 'home')
+
+        @osx_home1 = File.join(@fixture, 'Preferences', 'Macromedia', 'Flash Player')
+        @osx_home2 = File.join(@fixture, 'Application Support', 'Macromedia')
+        @win_home1 = File.join(@fixture, 'Application Data', 'Macromedia', 'Flash Player')
+        @win_home2 = File.join(@fixture, 'AppData', 'Roaming', 'Macromedia', 'Flash Player')
+        @nix_home1 = File.join(@fixture, '.macromedia', 'Flash_Player')
+
+        # Ensure the looks in our Fixtures folder instead of system:
+        FlashPlayer.stubs(:system_library).returns @fixture
+        FlashPlayer.stubs(:system_home).returns @fixture
+      end
+
+      teardown do
+        remove_file File.join(@fixture)
+      end
+
+      should "find home on osx" do
+        FileUtils.mkdir_p @osx_home1
+        assert_equal @osx_home1, FlashPlayer.home
+      end
+
+      should "find home on osx 2" do
+        FileUtils.mkdir_p @osx_home2
+        assert_equal @osx_home2, FlashPlayer.home
+      end
+
+      should "find home on win 1" do
+        FileUtils.mkdir_p @win_home1
+        assert_equal @win_home1, FlashPlayer.home
+      end
+
+      should "find home on win 2" do
+        FileUtils.mkdir_p @win_home2
+        assert_equal @win_home2, FlashPlayer.home
+      end
+
+      should "find home on nix 1" do
+        FileUtils.mkdir_p @nix_home1
+        assert_equal @nix_home1, FlashPlayer.home
+      end
+    end
+
+  end
+end
+

data/test/unit/log_file_test.rb

@@ -0,0 +1,47 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class LogFileTest < Test::Unit::TestCase
+  include SproutTestCase
+
+  context "A LogFile" do
+
+    setup do
+      @logger = StringIO.new
+      @flashlog = File.join(fixtures, 'flashlog.txt')
+      @reader = FlashPlayer::LogFile.new
+      @reader.logger = @logger
+      @reader.stubs(:flashlog_path).returns @flashlog
+
+      FileUtils.touch @flashlog
+    end
+
+    teardown do
+      remove_file @flashlog
+    end
+
+    should "read until killed" do
+      blocked = true
+      t = Thread.new {
+        @reader.tail
+        blocked = false
+      }
+
+      assert blocked
+      t.kill
+    end
+
+
+    # This method only works when run alone -
+    # Under normal circumstances, the SproutTestCase
+    # clears out any Rake tasks that have been defined
+    # and we don't have an easy way to redefine the
+    # task...
+    #should "read from rake task" do
+      #FlashPlayer::LogFile.any_instance.stubs(:logger).returns StringIO.new
+      #FlashPlayer::LogFile.any_instance.expects(:read_flashlog_at)
+      #Rake.application[:flashlog].invoke
+    #end
+
+  end
+end
+

data/test/unit/mm_config_test.rb

@@ -0,0 +1,74 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class MMConfigTest < Test::Unit::TestCase
+  include SproutTestCase
+
+  context "An MMConfig" do
+
+    setup do
+      @home = File.join(fixtures, 'home')
+      @osx_fp  = File.join(@home, 'Application Support', 'Macromedia')
+      @linux_fp = File.join(@home, '.macromedia', 'Flash_Player')
+
+      FileUtils.mkdir_p @home
+
+      @mm_config = FlashPlayer::MMConfig.new
+      @mm_config.stubs(:user_confirmation?).returns true
+      @mm_config.logger = StringIO.new
+    end
+
+    teardown do
+      remove_file @home
+    end
+
+    should "ignore failure if flashplayer has never run" do
+      # No creation of expected FlashPlayer folders...
+      
+      as_a_mac_system do
+        @mm_config.stubs(:system_library).returns @home
+        @mm_config.stubs(:flashplayer_home).returns @osx_fp
+        @mm_config.create
+      end
+    end
+
+    should "create a config file on OS X with FP 9" do
+      FileUtils.mkdir_p @osx_fp
+      flashlog = File.expand_path(File.join(@osx_fp, 'Logs', 'flashlog.txt'))
+
+      as_a_mac_system do
+        @mm_config.stubs(:system_library).returns @home
+        @mm_config.stubs(:flashplayer_home).returns @osx_fp
+        @mm_config.stubs(:flashlog_path).returns flashlog
+        @mm_config.create
+        mm_cfg = File.join(@osx_fp, mm_config_file)
+        assert_file mm_cfg do |content|
+          assert_matches /#{@flashlog}/, content
+        end
+      end
+    end
+
+    should "create a config file on linux" do
+      FileUtils.mkdir_p @linux_fp
+      flashlog = File.expand_path(File.join(@linux_fp, 'Logs', 'flashlog.txt'))
+
+      as_a_unix_system do
+        @mm_config.stubs(:system_library).returns @home
+        @mm_config.stubs(:system_home).returns @home
+        @mm_config.stubs(:flashlog_path).returns flashlog
+        @mm_config.stubs(:flashplayer_home).returns @linux_fp
+        @mm_config.create
+        mm_cfg = File.join(@home, mm_config_file)
+        assert_file mm_cfg do |content|
+          assert_matches /#{flashlog}/, content
+        end
+      end
+    end
+  end
+
+  private
+
+  def mm_config_file
+    FlashPlayer::MMConfig::FILE_NAME
+  end
+end
+

data/test/unit/mxmlc_test.rb

@@ -0,0 +1,45 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class MXMLCTest < Test::Unit::TestCase
+  include SproutTestCase
+
+  context "An MXMLC tool" do
+
+    setup do
+      @fixture         = File.join 'test', 'fixtures', 'mxmlc', 'simple'
+      @input           = File.join @fixture, 'SomeFile.as'
+      @expected_output = File.join @fixture, 'SomeFile.swf'
+      #Sprout::Log.debug = false
+    end
+
+    teardown do
+      remove_file @expected_output
+    end
+
+    should "accept input" do
+      as_a_unix_system do
+        mxmlc = FlashSDK::MXMLC.new
+        mxmlc.input = @input
+        mxmlc.source_path << @fixture
+        assert_equal '--source-path+=test/fixtures/mxmlc/simple test/fixtures/mxmlc/simple/SomeFile.as', mxmlc.to_shell
+      end
+    end
+
+    should "compile a swf" do
+      mxmlc = FlashSDK::MXMLC.new
+      mxmlc.input = @input
+      # Turn on to trigger an actual compilation:
+      # (This is too damn slow to leave in the every-time test run)
+      mxmlc.execute
+      assert_file @expected_output
+    end
+
+    should "assign simple output" do
+      t = mxmlc 'bin/SomeProject.swf' do |t|
+        t.input = @input
+      end
+      assert_equal 'bin/SomeProject.swf', t.output
+    end
+  end
+end
+

data/test/unit/project_generator_test.rb

@@ -0,0 +1,53 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class ProjectGeneratorTest < Test::Unit::TestCase
+  include SproutTestCase
+
+  context "A new project generator" do
+
+    setup do
+      @temp             = File.join(fixtures, 'generators', 'tmp')
+      FileUtils.mkdir_p @temp
+      @generator        = FlashSDK::ProjectGenerator.new
+      @generator.path   = @temp
+      @generator.logger = StringIO.new
+    end
+
+    teardown do
+      remove_file @temp
+    end
+
+    should "generate a new application" do
+      @generator.input = 'SomeProject'
+      @generator.execute
+      project = File.join(@temp, 'SomeProject')
+      assert_directory project
+      assert_file File.join(project, 'Gemfile') do |content|
+        assert_matches /asunit4/, content
+      end
+      assert_file File.join(project, 'rakefile.rb') do |content|
+        assert_matches /bin\/SomeProject-debug.swf\"/, content
+        assert_matches /src\/SomeProject.as/, content
+      end
+      assert_file File.join(project, 'src', 'SomeProject.as') do |content|
+        assert_matches /flash.display.Sprite;/, content
+      end
+      assert_directory File.join(project, 'lib')
+      assert_directory File.join(project, 'bin')
+    end
+
+    should "accept alternate bin dir" do
+      @generator.bin = 'other'
+      @generator.input = 'OtherProject'
+      @generator.execute
+      project = File.join(@temp, 'OtherProject')
+      assert_directory project
+      assert_directory File.join(project, 'other')
+      assert_file File.join(project, 'rakefile.rb') do |content|
+        assert_matches /other\/OtherProject-debug.swf/, content
+      end
+    end
+
+  end
+end
+