lukebayes-clix_flash_player 0.1.1 → 0.2.0

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/README.textile

@@ -0,0 +1,113 @@
+h1. CLIX FlashPlayer
+
+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.
+
+h1. The Problem(s)
+
+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.
+
+h1. Attempts
+
+h2. Open command
+
+The first approach was to simply use the OS X <code>open</code> command. The problem with open, is that it expects a single application _or_ file argument, not an application _and_ file. 
+
+When <code>open</code> is sent a second argument, it appears to be the same as if open was called twice - this usually causes two instances of the Flash Player to be launched.
+
+We can't call <code>open</code> with only the SWF file because then it launches an arbitrary Flash Player and not necessarily the specific version that we need.
+
+Finally, <code>open</code> has the additional disadvantage in that when we send SIGINT to the parent process, the child Players are orphaned.
+
+h2. Exec Flash Player.app with the SWF file as an argument
+
+Of course, this doesn't work because Flash Player.app is a directory. Thanks Steve!
+
+h2. Exec Flash Player.app/Contents/MacOS/Flash Player binary with the SWF file as an argument
+
+This approach is the most promising yet in that it blocks the parent thread and returns when the Player is Quit and it kills the Player process when the parent is interrupted.
+
+Unfortunately, this doesn't work for us because the Flash Player is never focused, and actually launches _behind_ all other applications. 
+
+h2. AppleScript Wrapper
+
+We can try writing a terminal application using AppleScript that will launch the Flash Player, activate it, and _then_ open the requisite SWF file, which will presumably avoid breakage on runtime exceptions.
+
+This worked great, except using the _osascript_ application to call the AppleScript, apparently breaks the SIGINT relationship from parent to child. So when the parent is aborted, the child is orphaned.
+
+h2. AppleScript Application
+
+Will the AppleScript behave differently as a full OS X _.app_?
+
+This is awesome because the .app file actually throws a modal "Are you sure?" prompt - _behind_ all other applications. It also doesn't seem to accept command line parameters properly.
+
+h2. Exec Flash Player.app/Contents/MacOS/Flash Player binary with the SWF file as an argument, and use AppleScript to focus the damn thing
+
+At first blush, this appears to work great, then we encounter the uncaught (actually _uncatchable_) runtime exception...
+
+If the SWF file we send the player has an uncaught runtime exception, the dialog appears behind all other applications, our AppleScript process becomes locked, and no longer responds to SIGINT (CTRL+C). The whole mess must instead be sent the SIGSTOP (CTRL+Z) and later killed with SIGKILL (kill -9 [pid]).
+
+h2. Use rb-appscript to Launch Flash Player.app, Focus the app, and Open the SWF
+
+This approach seems to work better than the exec and focus strategy because we are able to focus (activate) the player _before_ sending it a failing SWF file. This at least gives us the error dialog in front of other applications. We get the added benefit in that if we manually dismiss the dialog, our process works normally.
+
+Unfortunately, if we interrupt the parent process (CTRL+C) before dismissing the dialog, our parent process becomes locked and must be killed brutally with SIGKILL.
+
+h1. Solution
+
+The only solution that I've been able to get consistently working, is to fork on the AppleScript features and use exec <code>kill -9 [process]</code> when we interrupt the application.
+
+An example of this process can be seen in the <code>lib</code> and <code>test</code> packages of this project.
+
+h1. Example
+
+You can install the latest version of this project as a gem with:
+
+<pre><code>
+gem sources -a http://gems.github.com (you only have to do this once)
+gem install lukebayes/clix_flash_player
+</code></pre>
+
+You can use the library in your Ruby code like this:
+
+<pre><code>
+require 'rubygems'
+require 'clix_flash_player'
+
+player = CLIXFlashPlayer.new
+player.execute('bin/Flash Player.app', 'bin/MyProject.swf')
+
+# Do something else here...
+
+player.join
+</code></pre>
+
+h1. MIT License
+
+<pre>
+Copyright (c) 2009 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 @@
+0.2.0

data/clix_flash_player.gemspec

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{clix_flash_player}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Luke Bayes"]
+  s.date = %q{2009-05-17}
+  s.description = %q{The Flash Player on OS X does not appropriately allow the command line to control it.}
+  s.email = %q{josh@technicalpickles.com}
+  s.extra_rdoc_files = [
+    "README.rdoc",
+     "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "Manifest.txt",
+     "README.rdoc",
+     "README.textile",
+     "VERSION",
+     "clix_flash_player.gemspec",
+     "lib/clix_flash_player.rb",
+     "lib/clix_wrapper.rb",
+     "rakefile.rb",
+     "script/console",
+     "script/destroy",
+     "script/generate",
+     "test/clix_flash_player_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/technicalpickles/the-perfect-gem}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Command Line Interface wrapper for Flash Player on OS X}
+  s.test_files = [
+    "test/clix_flash_player_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<open4>, [">= 0.9.6"])
+    else
+      s.add_dependency(%q<open4>, [">= 0.9.6"])
+    end
+  else
+    s.add_dependency(%q<open4>, [">= 0.9.6"])
+  end
+end

data/rakefile.rb

@@ -1,26 +1,21 @@
 %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'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "clix_flash_player"
+    gemspec.summary = "Command Line Interface wrapper for Flash Player on OS X"
+    gemspec.email = "josh@technicalpickles.com"
+    gemspec.homepage = "http://github.com/technicalpickles/the-perfect-gem"
+    gemspec.description = "The Flash Player on OS X does not appropriately allow the command line to control it."
+    gemspec.authors = ["Luke Bayes"]
+    gemspec.files.exclude('exploration/**/*')
+    gemspec.add_dependency('open4', '>= 0.9.6')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 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]
+# require 'newgem/tasks' # load /tasks/*.rake
+# Dir['tasks/**/*.rake'].each { |t| load t }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: lukebayes-clix_flash_player
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Luke Bayes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-16 00:00:00 -07:00
+date: 2009-05-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,55 +22,36 @@ dependencies:
       - !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
+description: The Flash Player on OS X does not appropriately allow the command line to control it.
+email: josh@technicalpickles.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- Manifest.txt
-- History.txt
 - README.rdoc
+- README.textile
 files: 
-- Manifest.txt
+- .gitignore
 - History.txt
-- rakefile.rb
+- Manifest.txt
 - README.rdoc
+- README.textile
+- VERSION
+- clix_flash_player.gemspec
 - lib/clix_flash_player.rb
 - lib/clix_wrapper.rb
+- rakefile.rb
 - script/console
 - script/destroy
 - script/generate
 - test/clix_flash_player_test.rb
 - test/test_helper.rb
 has_rdoc: false
-homepage: 
+homepage: http://github.com/technicalpickles/the-perfect-gem
 post_install_message: 
 rdoc_options: 
-- --main
-- README.rdoc
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -87,10 +68,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: clix_flash_player
+rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
-summary: This is a Command Line interface to the Flash Player for OS X
+summary: Command Line Interface wrapper for Flash Player on OS X
 test_files: 
 - test/clix_flash_player_test.rb
+- test/test_helper.rb