h4oflashsdk 1.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    h4oflashsdk (1.0.0)
+      sprout (>= 1.1.18.pre)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    archive-tar-minitar (0.5.2)
+    i18n (0.6.1)
+    metaclass (0.0.1)
+    mocha (0.12.4)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    open4 (1.3.0)
+    rake (0.9.2.2)
+    rubyzip (0.9.4)
+    shoulda (3.1.1)
+      shoulda-context (~> 1.0)
+      shoulda-matchers (~> 1.2)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.3.0)
+      activesupport (>= 3.0.0)
+    sprout (1.1.18.pre)
+      archive-tar-minitar (= 0.5.2)
+      bundler (>= 0.9.19)
+      open4 (>= 0.9.6)
+      rake (>= 0.9.2)
+      rubyzip (= 0.9.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  h4oflashsdk!
+  mocha
+  shoulda

data/POSTINSTALL.rdoc

@@ -0,0 +1,79 @@
+++++++++++++++++++++++++++++++++
+You have successfully installed the Project Sprouts Flash SDK!
+
+To get started with a new ActionScript 3 project:
+
+  # Generate a project named 'SomeProject'
+  sprout-as3 SomeProject
+
+  # Change directory to the newly-created directory:
+  cd SomeProject
+
+  # Install whatever additional gems are required 
+  # by this project Gemfile:
+  bundle install
+
+  # Use Rake to run the default task:
+  rake
+
+++++++++++++++++++++++++++++++++
+Next Steps:
+
+  # Generate a new class, test case and test suite:
+  sprout-class utils.MathUtil
+
+  # Compile and run the test harness:
+  rake test
+
+  # List available rake tasks:
+  rake -T
+
+  # List available generators:
+  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)
+
+++++++++++++++++++++++++++++++++
+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? 
+
+  Troubleshooting at:
+  http://projectsprouts.org/troubleshooting.html
+
+  Email us at:
+  projectsprouts@googlegroups.com
+

data/README.textile

@@ -0,0 +1,79 @@
+
+h1. The Flash SDK Sprout Gem
+
+h3. Installation
+
+# "Install Ruby":http://www.ruby-lang.org/en/downloads/ _(>= v 1.8.7)_
+# "Install RubyGems":http://rubyforge.org/frs/?group_id=126 _(>= v 1.3.6)_
+# Install the Flash SDK prerelease gem:
+
+  <pre><code>gem install flashsdk --pre</code></pre>
+
+h3. Getting Started
+
+Open a terminal and enter the following commands:
+
+Create a new ActionScript 3 project and move into it:
+
+  <pre><code>sprout-as3 SomeProject
+  cd SomeProject</code></pre>
+
+
+Resolve all dependencies, compile and launch the SWF:
+
+  <pre><code>rake</code></pre>
+
+Generate a new class, test case and test suite:
+
+  <pre><code>sprout-class utils.MathUtil</code></pre>
+
+Compile and launch the test harness:
+
+  <pre><code>rake test</code></pre>
+
+Compile a SWC file:
+
+  <pre><code>rake swc</code></pre>
+
+Generate documentation using "AsDoc":http://labs.adobe.com/wiki/index.php/ASDoc:
+
+  <pre><code>rake asdoc</code></pre>
+
+Execute the test harness, emit a JUnit-compatible test results document, and close the Flash Player when complete or after encountering an uncaught exception:
+
+  <pre><code>rake ci</code></pre>
+
+Display all available Rake tasks:
+
+  <pre><code>rake -T</code></pre>
+
+h3. Some Links
+
+* "Web Site":http://projectsprouts.org
+* "See the Documentation":http://projectsprouts.org/rdoc
+* "Meet the Community":http://groups.google.com/group/projectsprouts
+
+h3. MIT License
+
+<pre>
+Copyright (c) 2007-2010 Pattern Park
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+</pre>

data/VERSION

@@ -0,0 +1 @@
+1.0.0

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/bin/sprout-as3

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

data/bin/sprout-flex

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'flashsdk'
+
+generator = FlashSDK::FlexProjectGenerator.new
+generator.parse! ARGV
+generator.execute

data/ext/CloseFlashPlayerForDumbassOSX.scpt

@@ -0,0 +1,6 @@
+
+on run argv
+    set flash_player to item 1 of argv as text
+    tell application flash_player to quit
+end run
+

data/ext/OpenFlashPlayerForDumbassOSX.scpt

@@ -0,0 +1,12 @@
+
+on run argv
+    set flash_player to item 1 of argv as text
+    set swf_file to item 2 of argv as text
+    tell application flash_player to activate
+    tell application flash_player to open swf_file
+    repeat
+      if application flash_player is not running then exit repeat
+      delay 0.1
+    end repeat
+end run
+

data/flashsdk.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'bundler'
+require 'flashsdk/module.rb'
+
+Gem::Specification.new do |s|
+  s.name                 = 'h4oflashsdk'
+  s.version              = FlashSDK::VERSION
+  s.author               = "Guenael LABOIS - H4o Studio"
+  s.email                = "glabois@h4o-studio.com"
+  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', 'flashplayer', 'flashlog']
+  s.post_install_message = File.read 'POSTINSTALL.rdoc'
+  s.files                = Dir['**/*']
+  s.files.reject!          { |fn| fn.match /.git|.svn|.DS_Store/ }
+  s.add_dependency('sprout', '>= 1.1.18.pre')
+  s.add_development_dependency('shoulda')
+  s.add_development_dependency('mocha')
+  s.require_paths << 'lib'
+end
+

data/flashsdk.komodoproject

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Komodo Project File - DO NOT EDIT -->
+<project id="5f758bda-07d1-4717-8925-9c89041b60d9" kpf_version="5" name="flashsdk.komodoproject">
+</project>

data/lib/flashplayer/errors.rb

@@ -0,0 +1,12 @@
+
+module FlashPlayer
+
+  ##
+  # Had trouble finding or resolving a path.
+  class PathError < StandardError; end
+
+  ##
+  # There was a problem with an input.
+  class UsageError < StandardError; end
+end
+

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/log_file.rb

@@ -0,0 +1,94 @@
+
+module FlashPlayer
+
+  class LogFile
+
+    attr_accessor :logger
+
+    def initialize
+      @logger = $stdout
+      super
+    end
+
+    def tail thread=nil
+      tail_path flashlog_path, thread
+    end
+
+    private
+
+    def tail_path path, thread=nil
+      logger.puts ">> Tailing '#{path}', press CTRL+C to quit"
+      create_flashlog_at path
+      clear_flashlog_at path
+      read_flashlog_at path, thread
+    end
+
+    def read_flashlog_at path, thread=nil
+      thread ||= fake_thread
+      lines_put = 0
+
+      while thread.alive? do
+        lines_put = read_from_file path, lines_put
+        logger.flush
+        sleep(0.1)
+      end
+
+      logger.puts ""
+      logger.puts ">> Exiting from tailing '#{path}' at user request"
+    end
+
+    def read_from_file path, lines_put
+      File.open(path, 'r') do |file|
+        lines_read = 0
+        file.readlines.each do |line|
+          if(lines_read >= lines_put)
+            logger.puts "[trace] #{line}"
+            logger.flush
+            lines_put += 1
+          end
+          lines_read += 1
+        end
+      end unless !File.exists?(path)
+      lines_put
+    end
+
+    def flashlog_path
+      begin
+        FlashPlayer.flashlog
+      rescue FlashPlayer::PathError
+        "/dev/null"
+      end
+    end
+
+    def clear_flashlog_at path
+      File.open(path, 'w') do |f|
+        f.write('')
+      end
+    end
+
+    def create_flashlog_at path
+      if(!File.exists?(path))
+        FileUtils.makedirs(File.dirname(path))
+        FileUtils.touch(path)
+      end
+    end
+
+    def fake_thread
+      Thread.new do
+        while true
+          sleep(0.2)
+        end
+      end
+    end
+
+  end
+end
+
+desc "Tail the flashlog.txt and block (until CTRL+C)"
+task :flashlog do
+  mm_config = FlashPlayer::MMConfig.new
+  mm_config.create
+  reader = FlashPlayer::LogFile.new
+  reader.tail 
+end
+

data/lib/flashplayer/mm_config.rb

@@ -0,0 +1,96 @@
+
+module FlashPlayer
+
+  class MMConfig
+    FILE_NAME = 'mm.cfg'
+
+    attr_accessor :logger
+
+    def initialize
+      @file_name = FILE_NAME
+      @logger    = $stdout
+    end
+
+    def create
+      create_if_necessary_at config_path
+    end
+
+    private
+
+    def create_if_necessary_at path
+      if(File.exists?(File.dirname(path)))
+        write_config(path, content(flashlog_path)) if(file_blank?(path))
+      end
+    end
+
+    def config_path
+      if(flashplayer_home == osx_fp9_dir)
+        path = File.join(osx_fp9_dir, @file_name)
+      else
+        path = File.join(system_home, @file_name)
+      end
+    end
+
+    def flashplayer_home
+      FlashPlayer.home
+    end
+
+    def flashlog_path
+      FlashPlayer.flashlog
+    end
+
+    def file_blank?(file)
+      !File.exists?(file) || File.read(file).empty?
+    end
+
+    def write_config(location, content)
+      if(user_confirmation?(location))
+        FileUtils.makedirs File.dirname(location)
+
+        File.open(location, 'w') do |f|
+          f.write(content)
+        end
+        logger.puts ">> Created file: " + File.expand_path(location)
+        location
+      else
+        raise FlashPlayer::PathError.new("Unable to create #{location}")
+      end
+    end
+
+    def content(flashlog)
+      return <<EOF
+ErrorReportingEnable=1
+MaxWarnings=0
+TraceOutputEnable=1
+TraceOutputFileName=#{flashlog}
+EOF
+    end
+
+    def user_confirmation?(location)
+      puts <<EOF
+
+Correctly configured mm.cfg file not found at: #{location}
+
+This file is required in order to capture trace output.
+
+Would you like this file created automatically? [Yn]
+
+EOF
+      answer = $stdin.gets.chomp.downcase
+      return (answer == 'y' || answer == '')
+    end
+
+    def osx_fp9_dir
+      File.join(system_library, 'Application Support', 'Macromedia')
+    end
+
+    def system_library
+      Sprout.current_system.library
+    end
+
+    def system_home
+      Sprout.current_system.home
+    end
+  end
+end
+

data/lib/flashplayer/module.rb

@@ -0,0 +1,51 @@
+
+module FlashPlayer
+  NAME    = 'flashplayer'
+  VERSION = '11.1.102'
+
+  class << self
+
+    def home
+      # NOTE: Look up the value every time,
+      # this way we're not storing state globally
+      # and the performance penalty is minimal...
+      home_paths.each do |path|
+        return path if File.exists?(path)
+      end
+      raise FlashPlayer::PathError.new('FlashPlayer unable to find home folder for your System')
+    end
+
+    def trust
+      File.join home, '#Security', 'FlashPlayerTrust', 'sprout.cfg'
+    end
+
+    def flashlog
+      File.join home, 'Logs', 'flashlog.txt'
+    end
+
+    private
+
+    def system_home
+      Sprout.current_system.home
+    end
+
+    def system_library
+      Sprout.current_system.library
+    end
+
+    # Collection of the potential locations of the Flash Player Home
+    # For each supported Platform, the first existing location
+    # will be used.
+    def home_paths
+      [
+        File.join(system_library, 'Preferences', 'Macromedia', 'Flash Player'),
+        File.join(system_library, 'Application Support', 'Macromedia'),
+        File.join(system_home, 'Application Data', 'Macromedia', 'Flash Player'),
+        File.join(system_home, 'AppData', 'Roaming', 'Macromedia', 'Flash Player'),
+        File.join(system_home, '.macromedia', 'Flash_Player')
+      ]
+    end
+
+  end
+end
+