flashsdk 1.0.1.pre

data/lib/flashplayer/task.legacy.rb

@@ -0,0 +1,293 @@
+
+=begin
+
+  class FlashPlayerTask < Rake::Task
+    # This is the opening prelude to a collection of test results. When the
+    # task encounters this string in the trace output log file, it will begin
+    # collecting trace statements with the expectation that the following
+    # strings will be well-formatted XML data matching what JUnit emits for 
+    # Cruise Control.
+    #
+    # See the lib/asunit3/asunit.framework.XMLResultPrinter for more information.
+    @@test_result_pre_delimiter = '<XMLResultPrinter>'
+
+    # This is the closing string that will indicate the end of test result XML data
+    @@test_result_post_delimiter = '</XMLResultPrinter>'
+
+    @@home = nil
+    @@trust = nil
+
+    def initialize(task_name, app)
+      super(task_name, app)
+      @default_gem_name = 'sprout-flashplayer-tool'
+      @default_gem_version = '10.22.0'
+      @default_result_file = 'AsUnitResults.xml'
+      @inside_test_result = false
+    end
+
+    def self.define_task(args, &block)
+      t = super
+      yield t if block_given?
+      t.define
+    end
+    
+    # Local system path to the Flash Player Trust file
+    def FlashPlayerTask.trust
+      if(@@trust)
+        return @@trust
+      end
+      @@trust = File.join(FlashPlayerTask.home, '#Security', 'FlashPlayerTrust', 'sprout.cfg')
+      return @@trust
+    end
+
+    # Local system path to where the Flash Player stores trace output logs and trust files
+    def FlashPlayerTask.home
+      if(@@home)
+        return @@home
+      end
+
+      FlashPlayerTask.home_paths.each do |path|
+        if(File.exists?(path))
+          return @@home = path
+        end
+      end
+
+      if(@@home.nil?)
+        raise FlashPlayerError.new('FlashPlayer unable to find home folder for your platform')
+      end
+      return @@home
+    end
+
+    # Collection of the potential locations of the Flash Player Home
+    # For each supported Platform, the first existing location
+    # will be used.
+    def FlashPlayerTask.home_paths
+      return [File.join(User.library, 'Preferences', 'Macromedia', 'Flash Player'),
+              File.join(User.library, 'Application Support', 'Macromedia'),
+              File.join(User.home, 'Application Data', 'Macromedia', 'Flash Player'),
+              File.join(User.home, 'AppData', 'Roaming', 'Macromedia', 'Flash Player'),
+              File.join(User.home, '.macromedia', 'Flash_Player')]
+    end
+
+    # The swf parameter can be set explicitly in the block sent to this task as in:
+    #   
+    #   flashplayer :run do |t|
+    #     t.swf = 'bin/SomeProject.swf'
+    #   end
+    #
+    # Or it can be set implicitly as a rake prerequisite as follows:
+    #
+    #   flashplayer :run => 'bin/SomeProject' do |t|
+    #   end
+    #
+    def swf=(swf)
+      @swf = swf
+    end
+
+    def swf
+      @swf ||= nil
+      if(@swf.nil?)
+        prerequisites.each do |req|
+          if(req.index('.swf'))
+            @swf = req.to_s
+            break
+          end
+        end
+      end
+      return @swf
+    end
+
+    def gem_version=(version)
+      @gem_version = version
+    end
+    
+    def gem_version
+      return @gem_version ||= nil
+    end
+    
+    # Full name of the sprout tool gem that this tool task will use. 
+    # This defaults to sprout-flashplayer-tool
+    def gem_name=(name)
+      @gem_name = name
+    end
+
+    def gem_name
+      return @gem_name ||= @default_gem_name
+    end
+    
+    # The File where JUnit test results should be written. This value
+    # defaults to 'AsUnitResults.xml'
+    #
+    def test_result_file=(file)
+      @test_result_file = file
+    end
+
+    def test_result_file
+      @test_result_file ||= @default_result_file
+    end
+    
+    def test_result
+      @test_result ||= ''
+    end
+
+    def define # :nodoc:
+      CLEAN.add(test_result_file)
+    end
+
+    def execute(*args)
+      super
+      raise FlashPlayerError.new("FlashPlayer task #{name} required field swf is nil") unless swf
+      
+      log_file = nil
+
+      # Don't let trust or log file failures break other features...
+      begin
+        config = FlashPlayerConfig.new
+        log_file = config.log_file
+        FlashPlayerTrust.new(File.expand_path(File.dirname(swf)))
+
+        if(File.exists?(log_file))
+          File.open(log_file, 'w') do |f|
+            f.write('')
+          end
+        else
+          FileUtils.makedirs(File.dirname(log_file))
+          FileUtils.touch(log_file)
+        end
+      rescue StandardError => e
+        logger.puts '[WARNING] FlashPlayer encountered an error working with the mm.cfg log and/or editing the Trust file'
+      end
+      
+      @running_process = nil
+      @thread = run(gem_name, gem_version, swf)
+      read_log(@thread, log_file) unless log_file.nil?
+      @thread.join
+    end
+
+    def run(tool, gem_version, swf)
+      path_to_exe = Sprout.get_executable(tool, nil, gem_version)
+      target = User.clean_path(path_to_exe)
+      @player_pid = nil
+      
+      thread_out = $stdout
+      command = "#{target} #{User.clean_path(swf)}"
+
+      usr = User.new()
+      if(usr.is_a?(WinUser) && !usr.is_a?(CygwinUser))
+        return Thread.new {
+            system command
+        }
+      elsif usr.is_a?(OSXUser)
+        require 'clix_flash_player'
+        @clix_player = CLIXFlashPlayer.new
+        @clix_player.execute(target, swf)
+        return @clix_player
+      else
+        return Thread.new {
+          require 'open4'
+          @player_pid, stdin, stdout, stderr = Open4.popen4(command)
+          stdout.read
+        }
+      end
+    end
+    
+    def close
+      usr = User.new
+      if(usr.is_a?(WinUser))
+        Thread.kill(@thread)
+      elsif(usr.is_a?(OSXUser))
+        @clix_player.kill unless @clix_player.nil?
+      else
+        Process.kill("SIGALRM", @player_pid)
+      end
+    end
+    
+    def read_log(thread, log_file)
+      lines_put = 0
+
+      if(log_file.nil?)
+        raise FlashPlayerError.new('[ERROR] Unable to find the trace output log file because the expected location was nil')
+      end
+
+      if(!File.exists?(log_file))
+        raise FlashPlayerError.new('[ERROR] Unable to find the trace output log file in the expected location: ' + log_file)
+      end
+
+      while(thread.alive?)
+        sleep(0.2)
+        lines_read = 0
+
+        File.open(log_file, 'r') do |file|
+          file.readlines.each do |line|
+            lines_read = lines_read + 1
+            if(lines_read > lines_put)
+              if(!parse_test_result(line, thread))
+                logger.puts "[trace] #{line}"
+              end
+              $stdout.flush
+              lines_put = lines_put + 1
+            end
+          end
+        end
+      end
+    end
+
+    # Returns true if inside of a test result
+    def parse_test_result(line, thread)
+      if(@inside_test_result)
+        if(line.index(@@test_result_post_delimiter))
+          @inside_test_result = false
+          write_test_result(test_result)
+          close
+          examine_test_result test_result
+          return true
+        else
+          test_result << line
+        end
+      end
+
+      if(line.index(@@test_result_pre_delimiter))
+        @inside_test_result = true
+      end
+      
+      return @inside_test_result
+    end
+    
+    def write_test_result(result)
+      FileUtils.makedirs(File.dirname(test_result_file))
+      File.open(test_result_file, File::CREAT|File::TRUNC|File::RDWR) do |f|
+        f.puts(result)
+      end
+    end
+
+    def examine_test_result(result)
+      require 'rexml/document'
+      doc = nil
+      begin
+        doc = REXML::Document.new(result)
+      rescue REXML::ParseException => e
+        puts "[WARNING] Invalid test results encountered"
+        return
+      end
+      
+      # Handle JUnit Failures
+      failures = []
+
+      doc.elements.each('/testsuites/testsuite/testsuite/testcase/error') do |element|
+        failures << element.text
+      end
+
+      doc.elements.each("/testsuites/testsuite/testsuite/testcase/failure") do |element|
+        failures << element.text
+      end
+
+      if(failures.size > 0)
+        raise AssertionFailure.new("[ERROR] Test Failures Encountered \n#{failures.join("\n")}")
+      end
+    end
+
+  end
+
+=end
+
+

data/lib/flashplayer/task.rb

@@ -0,0 +1,137 @@
+
+module FlashPlayer
+
+  class Task < Rake::Task
+
+    attr_accessor :input
+    attr_accessor :pkg_name
+    attr_accessor :pkg_version
+
+    ##
+    # This is the Rake::Task constructor
+    # signature...
+    def initialize task_name, rake_application
+      super
+      @logger       = $stdout
+      @mm_config    = MMConfig.new
+      @reader       = LogFile.new
+      @trust_config = Trust.new
+      @process      = nil
+      @input        = task_name
+
+      @pkg_name     = FlashPlayer::NAME
+      @pkg_version  = FlashSDK::VERSION
+    end
+
+    def execute *args
+      super
+      #puts ">> invoke with: #{args} and input: #{input}"
+      update_input_if_necessary
+      execute_safely do
+        update_mm_config
+        update_trust_config_with input
+      end
+      player_thread = launch_player_with input
+      tail_flashlog player_thread
+    end
+
+    def logger=(logger)
+      @logger              = logger
+      @mm_config.logger    = logger
+      @reader.logger       = logger
+      @trust_config.logger = logger
+    end
+
+    def logger
+      @logger
+    end
+
+    private
+
+    def execute_safely
+      begin
+        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|
+        if(prereq.match(/\.swf$/))
+          self.input = prereq
+          return
+        end
+      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
+      swf = clean_path swf
+      current_system.open_flashplayer_with player, swf
+    end
+
+    def tail_flashlog player_thread
+      @reader.tail player_thread
+    end
+  end
+end
+
+##
+# Update the native System instances
+# to handle FlashPlayer launching in 
+# order to overcome non-cli limitations.
+#
+module Sprout
+  module System
+    
+    class WinSystem
+      def open_flashplayer_with exe, swf
+        return Thread.new {
+          system command
+        }
+      end
+    end
+
+    class OSXSystem
+      def open_flashplayer_with exe, swf
+        require 'flashplayer/clix_flash_player'
+        @clix_player = CLIXFlashPlayer.new
+        @clix_player.execute(exe, swf)
+        return @clix_player
+      end
+    end
+
+    class UnixSystem
+      def open_flashplayer_with exe, swf
+        return Thread.new {
+          require 'open4'
+          @player_pid, stdin, stdout, stderr = Open4.popen4(command)
+          stdout.read
+        }
+      end
+    end
+  end
+end
+
+def flashplayer *args, &block
+  FlashPlayer::Task.define_task *args, &block
+end
+

data/lib/flashplayer/trust.rb

@@ -0,0 +1,45 @@
+
+module FlashPlayer
+
+  class Trust
+
+    attr_accessor :logger
+
+    def initialize
+      @logger = $stdout
+    end
+
+    def add path
+      file = trust_file
+      create(file) unless File.exists?(file)
+      update_if_necessary file, path
+    end
+
+    private
+
+    def create file
+      dir = File.dirname file
+      FileUtils.makedirs(dir) unless File.exists?(dir)
+      FileUtils.touch file
+    end
+
+    def update_if_necessary file, path
+      path = File.expand_path path
+      if(!has_path?(file, path))
+        File.open(file, 'a') do |f|
+          f.puts path
+        end
+        logger.puts ">> Added #{path} to Flash Player Trust file at: #{file}"
+      end
+    end
+
+    def has_path? file, path
+      !File.read(file).index(path).nil?
+    end
+
+    def trust_file
+      FlashPlayer.trust
+    end
+  end
+end
+

data/lib/flashplayer.rb

@@ -0,0 +1,8 @@
+require 'flashplayer/errors'
+require 'flashplayer/module'
+require 'flashplayer/mm_config'
+require 'flashplayer/trust'
+require 'flashplayer/log_file'
+require 'flashplayer/task'
+require 'flashplayer/specification'
+

data/lib/flashsdk/generators/class_generator.rb

@@ -0,0 +1,43 @@
+module FlashSDK
+  class ClassGenerator < Sprout::Generator::Base
+    include FlashHelper
+
+    ##
+    # The path where source files should be created.
+    add_param :src, String, { :default => 'src' }
+
+    def manifest
+      directory class_directory do
+        template "#{class_name}.as", 'ActionScript3Class.as'
+      end
+
+      generator :test_class, :input => "#{fully_qualified_class_name}Test"
+      generator :suite_class
+    end
+
+  end
+
+end
+
+##
+# 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.
+module FlashSDK
+  class TestClassGenerator < Sprout::Generator::Base
+    def manifest
+    end
+  end
+end
+
+##
+# 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.
+module FlashSDK
+  class SuiteClassGenerator < Sprout::Generator::Base
+    def manifest
+    end
+  end
+end
+

data/lib/flashsdk/generators/flash_helper.rb

@@ -0,0 +1,48 @@
+
+module FlashSDK
+
+  module FlashHelper
+
+    def class_directory
+      parts = input_in_parts
+      if parts.size > 1
+        parts.pop
+        return File.join src, *parts
+      end
+      return src
+    end
+
+    def package_name
+      parts = input_in_parts
+      if parts.size > 1
+        parts.pop
+        return "#{parts.join('.')} "
+      end
+      return ""
+    end
+
+    def class_name
+      parts = input_in_parts
+      parts.pop.camel_case
+    end
+
+    def input_in_parts
+      provided_input = input
+      if provided_input.include?('/')
+        provided_input.gsub! /^#{src}\//, ''
+        provided_input = provided_input.split('/').join('.')
+      end
+
+      provided_input.gsub!(/\.as$/, '')
+      provided_input.gsub!(/\.mxml$/, '')
+      provided_input.gsub!(/\.xml$/, '')
+
+      provided_input.split('.')
+    end
+
+    def fully_qualified_class_name
+      input
+    end
+  end
+end
+

data/lib/flashsdk/generators/project_generator.rb

@@ -0,0 +1,53 @@
+module FlashSDK
+  class ProjectGenerator < ClassGenerator
+
+    ##
+    # The path where assets will be created.
+    add_param :assets, String, { :default => 'assets' }
+
+    ##
+    # The path where skins will be created.
+    add_param :skins, String, { :default => 'skins' }
+
+    ##
+    # The path where test cases should be created.
+    add_param :test, String, { :default => 'test' }
+
+    ##
+    # The path where libraries should be added.
+    add_param :lib, String, { :default => 'lib' }
+
+    ##
+    # The path where binaries should be created.
+    add_param :bin, String, { :default => 'bin' }
+
+    def manifest
+      directory input do
+        template 'rakefile.rb'
+        template 'Gemfile'
+
+        directory src do
+          template "#{input}.as", 'ActionScript3MainClass.as'
+        end
+
+        directory assets do
+          directory skins do
+            file 'DefaultProjectImage.png'
+          end
+        end
+
+        # Create empty directories:
+        directory lib
+        directory bin
+      end
+    end
+
+    protected
+
+      def debug_swf_name
+        "#{class_name}-debug.swf"
+      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/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem "flashsdk", ">= 1.0.0.pre"
+gem "asunit4", ">= 4.2.pre"
+gem "flashplayer", ">= 10.1.2.pre"
+

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

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require
+
+library :asunit4
+
+desc "Compile the debug swf"
+mxmlc "<%= bin %>/<%= debug_swf_name %>" => :asunit4 do |t|
+  t.input = "<%= src %>/<%= class_name %>.as"
+  t.debug = true
+end
+
+desc "Compile and run the debug swf"
+flashplayer :debug => "<%= bin %>/<%= debug_swf_name %>"
+
+task :default => :debug
+

data/lib/flashsdk/module.rb

@@ -0,0 +1,9 @@
+
+module FlashSDK
+  # Do this craptastic, otherwise we get a carriage return
+  # after our version, and that poops on our archive folder
+  # after downloading...
+  version_file = File.join(File.dirname(__FILE__), '..', '..', 'VERSION')
+  VERSION = File.read(version_file).gsub("\n", '')
+end
+