lukebayes-clix_flash_player 0.1.1

data/History.txt

@@ -0,0 +1,5 @@
+== 0.1.0 14/5/2009
+	
+* 1 major improvement
+  * Created and built the solution
+  * Explored different strategies for solving the problem

data/Manifest.txt

@@ -0,0 +1,11 @@
+Manifest.txt
+History.txt
+rakefile.rb
+README.rdoc
+lib/clix_flash_player.rb
+lib/clix_wrapper.rb
+script/console
+script/destroy
+script/generate
+test/clix_flash_player_test.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1,57 @@
+= CLIX Flash Player
+
+== DESCRIPTION:
+
+This is a Command Line interface to the Flash Player for OS X.
+
+This project was created because unlike the modern distributions of the desktop debug Flash Player on Windows and Linux, the OS X distribution does not behave properly when executed by another process.
+
+== FEATURES/PROBLEMS:
+
+We need to be able to execute and focus a specific instance of the Flash Player along with a specific SWF file. The Flash Player execution thread should block until the user selects File >> Quit (or hits CMD+Q), or until the parent application is interrupted (SIGINT) using CTRL+C.
+
+The Flash Player should be focused and still terminate whether or not a runtime exception occurs in the first frame (or any frame) of the loaded SWF file.
+
+Our solution should work each revision of the Flash Player, from 9.0.115 and greater.
+
+== SYNOPSIS:
+
+You can use this application by targeting a specific, downloaded instance of the Flash Player and a SWF file as follows:
+
+    flash_player = "Flash Player.app/Content/MacOS/Flash Player"
+    swf = "bin/SomeProject.swf"
+
+    player = CLIXFlashPlayer.new
+    player.execute(flash_player, swf)
+
+
+== REQUIREMENTS:
+
+Simply executing the Flash Player on OS X does not give us the ability to focus it, or continue to control or kill it when an uncaught runtime exception is encountered.
+
+The CLIXFlashPlayer provides full control over the process that represents the Flash Player.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Pattern Park, Inc.
+
+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.

data/lib/clix_flash_player.rb

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'open4'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+class CLIXFlashPlayerError < StandardError; end
+
+class CLIXFlashPlayer
+  VERSION = '0.1.0'
+  
+  def initialize
+    @activate_pid = nil
+    @player_pid = nil
+    @thread = nil
+  end
+  
+  def execute(player, swf)
+    cleanup
+    validate(player, swf)
+    player = File.expand_path(File.join(player, 'Contents', 'MacOS', 'Flash Player'))
+    swf = File.expand_path(swf)
+    setup_trap
+    @thread = Thread.new {
+      @player_pid = open4.popen4("#{player.split(' ').join('\ ')}")[0]
+      wrapper = File.expand_path(File.dirname(__FILE__) + '/clix_wrapper.rb')
+      command = "ruby #{wrapper} '#{player}' '#{swf}'"
+      @activate_pid = open4.popen4(command)[0]
+      Process.wait(@player_pid)
+    }
+  end
+  
+  def kill
+    system("kill -9 #{@player_pid}")
+  end
+  
+  def join
+    @thread.join
+  end
+  
+  def alive?
+    return @thread.alive?
+  end
+  
+  private
+  
+  def cleanup
+    if(@thread && @thread.alive?)
+      kill
+      @thread.join
+    end
+  end
+  
+  def validate(player, swf)
+    raise CLIXFlashPlayerError.new("Player must not be nil") if(player.nil? || player == '')
+    raise CLIXFlashPlayerError.new("Player cannot be found: '#{player}'") if(!File.exists?(player))
+    raise CLIXFlashPlayerError.new("SWF must not be nil") if(swf.nil? || swf == '')
+    raise CLIXFlashPlayerError.new("SWF cannot be found: '#{swf}'") if(!File.exists?(swf))
+  end
+  
+  def setup_trap
+    # Trap the CTRL+C Interrupt signal
+    # Which prevents nasty exception messages
+    Kernel.trap('INT') do
+      if(@thread.alive?)
+        @thread.kill
+      end
+    end
+  end
+  
+end
+

data/lib/clix_wrapper.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/ruby
+require 'rubygems'
+require 'appscript'
+
+# player9 = "/Users/lbayes/Projects/CLIXFlashPlayer/exploration/fixtures/9.0.151/Flash Player.app/Contents/MacOS/Flash Player"
+# player10 = "/Users/lbayes/Projects/CLIXFlashPlayer/exploration/fixtures/10.0.22.87/Flash Player.app/Contents/MacOS/Flash Player"
+
+# player = player10
+
+# good_swf = '/Users/lbayes/Projects/CLIXFlashPlayer/exploration/fixtures/SomeProject.swf'
+# bad_swf = '/Users/lbayes/Projects/CLIXFlashPlayer/exploration/fixtures/InstantRuntimeException.swf'
+
+# swf = good_swf
+
+player = ARGV[0]
+swf = ARGV[1]
+
+puts "argv 0: #{player}"
+puts "argv 1: #{swf}"
+
+if(player.nil?)
+  raise "CLIXWrapper requires 'player' argument like:\nruby clix_wrapper [player] [swf]"
+end
+
+if(swf.nil?)
+  raise "CLIXWrapper requires 'swf' argument like:\nruby clix_wrapper [player] [swf]"
+end
+
+# player = File.expand_path(player).split(' ').join('\ ')
+# swf = File.expand_path(swf).split(' ').join('\ ')
+
+
+# Give the player focus:
+Appscript.app(player).activate
+puts "activate succeeded"
+# Open the SWF:
+Appscript.app(player).open(MacTypes::Alias.path(swf))
+puts "open succeeded"
+

data/rakefile.rb

@@ -0,0 +1,26 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/clix_flash_player'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('clix_flash_player', CLIXFlashPlayer::VERSION) do |p|
+  p.developer('Luke Bayes', 'lbayes@patternpark.com')
+  p.rubyforge_name      = p.name
+  p.extra_deps          = [
+    ['open4','>= 0.9.6'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  p.test_globs = ['test/*_test.rb']
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/clix_flash_player.rb'}"
+puts "Loading clix_flash_player gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/clix_flash_player_test.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class CLIXFlashPlayerTest <  Test::Unit::TestCase
+
+  def setup
+    @fixtures = File.join(File.dirname(__FILE__) + '/../', 'exploration', 'fixtures')
+    @flash_player10 = File.join(@fixtures, '10.0.22.87', 'Flash Player.app')
+    @flash_player9 = File.join(@fixtures, '9.0.151', 'Flash Player.app')
+    
+    @good_swf = File.join(@fixtures, 'SomeProject.swf')
+    @bad_swf = File.join(@fixtures, 'InstantRuntimeException.swf')
+  end
+  
+  def teardown
+    super
+  end
+
+  def test_nil_player
+    player = CLIXFlashPlayer.new
+    assert_raise CLIXFlashPlayerError do
+      player.execute(nil, @good_swf)
+    end
+  end
+  
+  def test_bad_player_target
+    player = CLIXFlashPlayer.new
+    assert_raise CLIXFlashPlayerError do
+      player.execute('foo', @good_swf)
+    end
+  end
+  
+  def test_nil_swf
+    player = CLIXFlashPlayer.new
+    assert_raise CLIXFlashPlayerError do
+      player.execute(@flash_player9, nil)
+    end
+  end
+
+  def test_bad_swf_target
+    player = CLIXFlashPlayer.new
+    assert_raise CLIXFlashPlayerError do
+      player.execute(@flash_player9, 'foo')
+    end
+  end
+    
+  def test_second_execute
+    player = CLIXFlashPlayer.new
+    player.execute(@flash_player9, @good_swf)
+    sleep(4.0)
+    player.execute(@flash_player10, @good_swf)
+    sleep(4.0)
+    player.kill
+    player.join
+  end
+
+  def test_good_swf
+    player = CLIXFlashPlayer.new
+    player.execute(@flash_player9, @good_swf)
+    sleep(4.0)
+    player.kill
+    player.join
+  end
+
+  def test_bad_swf
+    player = CLIXFlashPlayer.new
+    player.execute(@flash_player9, @bad_swf)
+    sleep(4.0)
+    player.kill
+    player.join
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+$:.push(File.dirname(__FILE__) + '/../lib')
+$:.push(File.dirname(__FILE__))
+
+require 'clix_flash_player'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: lukebayes-clix_flash_player
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Luke Bayes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: This is a Command Line interface to the Flash Player for OS X.  This project was created because unlike the modern distributions of the desktop debug Flash Player on Windows and Linux, the OS X distribution does not behave properly when executed by another process.
+email: 
+- lbayes@patternpark.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- History.txt
+- README.rdoc
+files: 
+- Manifest.txt
+- History.txt
+- rakefile.rb
+- README.rdoc
+- lib/clix_flash_player.rb
+- lib/clix_wrapper.rb
+- script/console
+- script/destroy
+- script/generate
+- test/clix_flash_player_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: clix_flash_player
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: This is a Command Line interface to the Flash Player for OS X
+test_files: 
+- test/clix_flash_player_test.rb