flashsdk 1.0.23.pre → 1.0.25.pre

data/POSTINSTALL.rdoc

@@ -52,6 +52,22 @@ before any flashplayer task:
 
   (type, 'help' for more info when prompted)
 
+++++++++++++++++++++++++++++++++
+You can also launch any SWF file using
+a debug Flash Player with:
+
+  flashplayer bin/SomeProject.swf
+
+Or run a SWF with FDB like:
+
+  flashplayer --fdb bin/SomeProject.swf
+
+++++++++++++++++++++++++++++++++
+You can also tail your system's flashlog
+while running a SWF or HTML page with:
+
+  flashlog
+
 ++++++++++++++++++++++++++++++++
 Issues or Questions? 
 

data/VERSION

@@ -1 +1 @@
-1.0.23.pre
+1.0.25.pre

data/bin/flashlog

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'flashsdk'
+
+reader = FlashPlayer::LogFile.new
+reader.tail
+

data/bin/flashplayer

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'flashsdk'
+
+player = FlashPlayer::Executable.new
+player.parse! ARGV
+player.execute
+

data/flashsdk.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.homepage             = "http://www.adobe.com/products/flex"
   s.summary              = "Adobe Flash SDK including mxmlc, compc, asdoc, adl, adt, optimizer and fdb"
   s.description          = "The Flash SDK Rubygem is brought to you by Project Sprouts (http://projectsprouts.org)"
-  s.executables          =  ['sprout-as3', 'sprout-flex']
+  s.executables          =  ['sprout-as3', 'sprout-flex', 'flashplayer', 'flashlog']
   s.post_install_message = File.read 'POSTINSTALL.rdoc'
   s.files                = FileList['**/**/*'].exclude /.git|.svn|.DS_Store/
   s.add_bundler_dependencies

data/lib/flashplayer/executable.rb

@@ -0,0 +1,143 @@
+
+module FlashPlayer
+
+  class Executable < Sprout::Executable::Base
+
+    attr_accessor :stdout
+    attr_accessor :stderr
+
+    ##
+    # The file that the Flash Player should launch.
+    #
+    #   flashplayer bin/SomeProject.swf
+    #
+    add_param :input, String, { :hidden_name => true, :required => true }
+
+    ##
+    # Drop into FDB after launching the Player.
+    #
+    #   flashplayer --fdb bin/SomeProject.swf
+    #
+    add_param :fdb, Boolean, { :hidden_value => true }
+
+    ##
+    # The Flash Player version to use.
+    add_param :version, String, { :default => FlashPlayer::VERSION }
+
+    def initialize
+      super
+      @mm_config = MMConfig.new
+      @reader = LogFile.new
+      @trust_config = Trust.new
+      @process = nil
+      @stdout = $stdout
+      @stderr = $stderr
+      @logger = $stdout
+      self.pkg_name = FlashPlayer::NAME
+      self.pkg_version = FlashPlayer::VERSION
+    end
+
+    def execute *args
+      execute_safely do
+        update_mm_config
+        update_trust_config_with input
+      end
+
+      if use_fdb?
+        launch_fdb_and_player_with input
+      else
+        player_thread = launch_player_with input
+        tail_flashlog player_thread
+      end
+    end
+
+    def use_fdb?
+      # Check as string b/c this is
+      # how the boolean value comes
+      # accross the command line input.
+      fdb || ENV['USE_FDB'].to_s == 'true'
+    end
+
+    def logger=(logger)
+      @logger              = logger
+      @mm_config.logger    = logger
+      @reader.logger       = logger
+      @trust_config.logger = logger
+    end
+
+    def logger
+      @logger
+    end
+
+    private
+
+    def launch_fdb_and_player_with input
+      # Keep getting a fatal lock error which I believe
+      # is being caused by the FlashPlayer and FDB attempting
+      # to write to stdout simultaneously.
+      # Trying to give fdb a fake stream until after the
+      # player is launched...
+      fake_out = Sprout::OutputBuffer.new
+      fake_err = Sprout::OutputBuffer.new
+
+      fdb_instance = FlashSDK::FDB.new
+      fdb_instance.stdout = fake_out
+      fdb_instance.stderr = fake_err
+      fdb_instance.execute false
+      fdb_instance.run
+      player_thread = launch_player_with input
+
+      # Emit whatever messages have been passed:
+      stdout.puts fake_out.read
+      stdout.flush
+      stderr.puts fake_err.read
+      stdout.flush
+      # Replace the fdb instance streams with
+      # the real ones:
+      fdb_instance.stdout = stdout
+      fdb_instance.stderr = stderr
+
+      # Let the user interact with fdb:
+      fdb_instance.handle_user_input
+
+      fdb_instance.wait
+      player_thread.join if player_thread.alive?
+    end
+
+    def execute_safely
+      begin
+        Thread.abort_on_exception = true
+        yield if block_given?
+      rescue FlashPlayer::PathError => e
+        logger.puts ">> [WARNING] It seems this was the first time FlashPlayer was launched on this system and as a result, the expected folders were not found. Please close the Player and run again - this message should only ever be displayed once."
+      end
+    end
+
+    def update_mm_config
+      @mm_config.create
+    end
+
+    def update_trust_config_with swf
+      @trust_config.add File.dirname(swf)
+    end
+
+    def clean_path path
+      current_system.clean_path path
+    end
+
+    def current_system
+      @current_system ||= Sprout.current_system
+    end
+
+    def launch_player_with swf
+      player = Sprout::Executable.load(:flashplayer, pkg_name, pkg_version).path
+      current_system.open_flashplayer_with player, clean_path(swf)
+    end
+
+    def tail_flashlog player_thread
+      @reader.tail player_thread
+    end
+
+  end
+end
+

data/lib/flashplayer/task.rb

@@ -7,52 +7,31 @@ module FlashPlayer
     attr_accessor :pkg_name
     attr_accessor :pkg_version
 
-    attr_accessor :stdout
-    attr_accessor :stderr
-
     ##
     # This is the Rake::Task constructor
     # signature...
     def initialize task_name, rake_application
       super
-      @mm_config    = MMConfig.new
-      @reader       = LogFile.new
-      @trust_config = Trust.new
-      @process      = nil
-      @input        = task_name
-      @stdout       = $stdout
-      @stderr       = $stderr
-      @logger       = $stdout
-
-      @pkg_name     = FlashPlayer::NAME
-      @pkg_version  = FlashPlayer::VERSION
+      @input = task_name
+      @player = FlashPlayer::Executable.new
+      @pkg_name = FlashPlayer::NAME
+      @pkg_version = FlashPlayer::VERSION
     end
 
     def execute *args
       super
       update_input_if_necessary
-      execute_safely do
-        update_mm_config
-        update_trust_config_with input
-      end
-
-      if use_fdb?
-        launch_fdb_and_player_with input
-      else
-        player_thread = launch_player_with input
-        tail_flashlog player_thread
-      end
+      @player.input = input
+      @player.fdb = use_fdb?
+      @player.execute
     end
 
     def logger=(logger)
-      @logger              = logger
-      @mm_config.logger    = logger
-      @reader.logger       = logger
-      @trust_config.logger = logger
+      @player.logger = logger
     end
 
     def logger
-      @logger
+      @player.logger
     end
 
     private
@@ -64,48 +43,6 @@ module FlashPlayer
       ENV['USE_FDB'].to_s == 'true'
     end
 
-    def launch_fdb_and_player_with input
-      # Keep getting a fatal lock error which I believe
-      # is being caused by the FlashPlayer and FDB attempting
-      # to write to stdout simultaneously.
-      # Trying to give fdb a fake stream until after the
-      # player is launched...
-      fake_out = Sprout::OutputBuffer.new
-      fake_err = Sprout::OutputBuffer.new
-
-      fdb_instance = FlashSDK::FDB.new
-      fdb_instance.stdout = fake_out
-      fdb_instance.stderr = fake_err
-      fdb_instance.execute false
-      fdb_instance.run
-      player_thread = launch_player_with input
-
-      # Emit whatever messages have been passed:
-      stdout.puts fake_out.read
-      stdout.flush
-      stderr.puts fake_err.read
-      stdout.flush
-      # Replace the fdb instance streams with
-      # the real ones:
-      fdb_instance.stdout = stdout
-      fdb_instance.stderr = stderr
-
-      # Let the user interact with fdb:
-      fdb_instance.handle_user_input
-
-      fdb_instance.wait
-      player_thread.join if player_thread.alive?
-    end
-
-    def execute_safely
-      begin
-        Thread.abort_on_exception = true
-        yield if block_given?
-      rescue FlashPlayer::PathError => e
-        logger.puts ">> [WARNING] It seems this was the first time FlashPlayer was launched on this system and as a result, the expected folders were not found. Please close the Player and run again - this message should only ever be displayed once."
-      end
-    end
-
     def update_input_if_necessary
       return if input.match(/\.swf$/)
       prerequisites.each do |prereq|
@@ -116,30 +53,6 @@ module FlashPlayer
       end
     end
 
-    def update_mm_config
-      @mm_config.create
-    end
-
-    def update_trust_config_with swf
-      @trust_config.add File.dirname(swf)
-    end
-
-    def clean_path path
-      current_system.clean_path path
-    end
-
-    def current_system
-      @current_system ||= Sprout.current_system
-    end
-
-    def launch_player_with swf
-      player = Sprout::Executable.load(:flashplayer, pkg_name, pkg_version).path
-      current_system.open_flashplayer_with player, clean_path(swf)
-    end
-
-    def tail_flashlog player_thread
-      @reader.tail player_thread
-    end
   end
 end
 

data/lib/flashplayer.rb

@@ -4,6 +4,7 @@ require 'flashplayer/module'
 require 'flashplayer/mm_config'
 require 'flashplayer/trust'
 require 'flashplayer/log_file'
+require 'flashplayer/executable'
 require 'flashplayer/task'
 require 'flashplayer/specification'
 

data/test/unit/fake_flashplayer_system.rb

@@ -0,0 +1,11 @@
+
+class FakeFlashPlayerSystem
+
+  def clean_path path
+    path
+  end
+
+  def open_flashplayer_with player, swf
+  end
+end
+

data/test/unit/flashplayer_executable_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+require 'fake_flashplayer_system'
+
+class FlashPlayerExecutableTest < Test::Unit::TestCase
+  include Sprout::TestHelper
+
+  context "A FlashPlayer Executable" do
+
+    setup do
+      # Force reload of the Specification on each
+      # test method b/c Sprout::TestHelper calls
+      # Executable.clear_entities! but 'require'
+      # only runs once per VM run...
+      load 'flashplayer/specification.rb'
+      @swf          = File.join(fixtures, 'flashplayer', 'AsUnit Runner.swf')
+      @missing_home = File.join(fixtures, 'missing_folder')
+      @config_path  = File.join(@missing_home, 'fp_config', 'mm.cfg')
+
+      Sprout.stdout = $stdout
+      Sprout.stderr = $stderr
+    end
+
+    teardown do
+      remove_file @missing_home
+      ENV['USE_FDB'] = 'false'
+    end
+
+    ## THIS METHOD SHOULD BE COMMENTED OUT....
+=begin
+    should "launch SWF on os x" do
+      # No creation of expected FlashPlayer folders...
+
+      #FlashPlayer.stubs(:home).returns @missing_home
+      #FlashPlayer::MMConfig.any_instance.stubs(:system_home).returns @missing_home
+      #FlashPlayer::MMConfig.any_instance.stubs(:config_path).returns @config_path
+      #FlashPlayer::MMConfig.any_instance.stubs(:user_confirmation?).returns false
+
+      #ENV['USE_FDB'] = 'true'
+
+      as_a_mac_system do
+        player = FlashPlayer::Executable.new
+        player.input = @swf
+        player.fdb = true
+        player.execute
+      end
+    end
+=end
+
+    should "work with input" do
+      player = FlashPlayer::Executable.new
+      player.input = @swf
+      configure player
+      player.execute
+    end
+
+  end
+
+  private
+
+  def configure player
+    player.logger = StringIO.new
+
+    # Comment following lines to really launch the player:
+    sys = FakeFlashPlayerSystem.new
+    player.stubs(:current_system).returns sys
+    sys.expects(:open_flashplayer_with).returns Thread.new{}
+  end
+end
+

data/test/unit/flashplayer_task_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'fake_flashplayer_system'
 
 class TaskTest < Test::Unit::TestCase
   include Sprout::TestHelper
@@ -15,8 +16,8 @@ class TaskTest < Test::Unit::TestCase
       @missing_home = File.join(fixtures, 'missing_folder')
       @config_path  = File.join(@missing_home, 'fp_config', 'mm.cfg')
 
-      Sprout.stdout = $stdout
-      Sprout.stderr = $stderr
+      #Sprout.stdout = $stdout
+      #Sprout.stderr = $stderr
     end
 
     teardown do
@@ -83,18 +84,8 @@ class TaskTest < Test::Unit::TestCase
 
     # Comment following lines to really launch the player:
     sys = FakeFlashPlayerSystem.new
-    t.stubs(:current_system).returns sys
+    FlashPlayer::Executable.any_instance.stubs(:current_system).returns sys
     sys.expects(:open_flashplayer_with).returns Thread.new{}
   end
 end
 
-class FakeFlashPlayerSystem
-
-  def clean_path path
-    path
-  end
-
-  def open_flashplayer_with player, swf
-  end
-end
-

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 23
+  - 25
   - pre
-  version: 1.0.23.pre
+  version: 1.0.25.pre
 platform: ruby
 authors: 
 - Luke Bayes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-01 00:00:00 -08:00
+date: 2011-03-03 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,11 +65,15 @@ email: projectsprouts@googlegroups.com
 executables: 
 - sprout-as3
 - sprout-flex
+- flashplayer
+- flashlog
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
+- bin/flashlog
+- bin/flashplayer
 - bin/sprout-as3
 - bin/sprout-flex
 - ext/CloseFlashPlayerForDumbassOSX.scpt
@@ -78,6 +82,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - lib/flashplayer/errors.rb
+- lib/flashplayer/executable.rb
 - lib/flashplayer/log_file.rb
 - lib/flashplayer/mm_config.rb
 - lib/flashplayer/module.rb
@@ -138,10 +143,12 @@ files:
 - test/unit/asdoc_test.rb
 - test/unit/class_generator_test.rb
 - test/unit/compc_test.rb
+- test/unit/fake_flashplayer_system.rb
 - test/unit/fcsh_socket_test.rb
 - test/unit/fcsh_test.rb
 - test/unit/fdb_test.rb
 - test/unit/flash_helper_test.rb
+- test/unit/flashplayer_executable_test.rb
 - test/unit/flashplayer_log_file_test.rb
 - test/unit/flashplayer_mm_config_test.rb
 - test/unit/flashplayer_module_test.rb
@@ -211,6 +218,22 @@ post_install_message: |+
   
     (type, 'help' for more info when prompted)
   
+  ++++++++++++++++++++++++++++++++
+  You can also launch any SWF file using
+  a debug Flash Player with:
+  
+    flashplayer bin/SomeProject.swf
+  
+  Or run a SWF with FDB like:
+  
+    flashplayer --fdb bin/SomeProject.swf
+  
+  ++++++++++++++++++++++++++++++++
+  You can also tail your system's flashlog
+  while running a SWF or HTML page with:
+  
+    flashlog
+  
   ++++++++++++++++++++++++++++++++
   Issues or Questions?