videojuicer-player-sdk 0.2

data/README.textile

@@ -0,0 +1,35 @@
+h1. Videojuicer Player SDK
+
+h2. Configuration
+
+You must create a `config.yml` to define the build tasks for the `playersdk` to use, the configuration file uses standard YAML syntaxs.
+
+	---
+	# Flex SDK location
+	flex_sdk: "/Applications/Adobe\ Flex\ Builder\ 3/sdks/3.3.0"
+	
+	# Flex framework version, the bundled RSLs are specific
+	flex_framework_version: "framework_3.3.0.4852"
+	
+	# List of tasks the SDK will complete
+	tasks:
+	  # Copies the Flex framework RSLs into the build folder
+	  "framework": {
+	      type: framework,
+	      framework_rsl: 'framework_3.3.0.4852'
+	  }
+	  # Compiles an Addon for use with the Videojuicer Player 
+	  "player-addon": {
+	      type: addon,
+	      src: vj-player-ui/src, main: DefaultUI.mxml,
+	      sdk: true,
+	      engine: "builds/vj-player-engine",
+	      libs: false,
+	      target: player-addon
+	  }
+	
+h2. TODO
+
+- Tests
+- Expand README
+- License

data/Rakefile

@@ -0,0 +1,69 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+ 
+begin
+  gem 'jeweler', '>= 1.0.1'
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "player-sdk"
+    s.summary = %Q{Videojuicer Player SDK runtime and compiler to create and build Player Addons.}
+    s.email = "sixones@me.com"
+    s.homepage = "http://player.videojuicer.com"
+    s.description = "Videojuicer Player SDK runtime and compiler to create and build Player Addons."
+    s.authors = ["Adam Livesley"]
+    s.files.exclude 'test/dest'
+    s.test_files.exclude 'test/dest'
+    s.add_dependency('open4', '>= 0.9.6')
+    s.add_dependency('rubyzip', '>= 0.9.1')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler --version '>= 1.0.1'"
+  exit(1)
+end
+ 
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+end
+ 
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'playersdk'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+ 
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/test_*.rb']
+    t.verbose = true
+  end
+rescue LoadError
+end
+ 
+task :default => [:test, :features]
+ 
+# console
+ 
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r player-sdk.rb"
+end
+
+begin
+  require 'cucumber/rake/task'
+ 
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "--format progress"
+  end
+rescue LoadError
+  desc 'Cucumber rake task not available'
+  task :features do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 2
+:patch: 0

data/bin/playersdk

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+ 
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+ 
+help = <<HELP
+Videojuicer Player 3.0 SDK 
+ 
+Basic Command Line Usage:
+  playersdk                                                    # . -> ./_site
+  playersdk  <path to write generated site>                    # . -> <path>
+  playersdk  <path to source> <path to write generated site>   # <path> -> <path>
+ 
+  Configuration is read from '<source>/_config.yml' but can be overriden
+  using the following options:
+ 
+HELP
+ 
+require 'optparse'
+require 'playersdk'
+ 
+exec = { }
+options = { }
+
+opts = OptionParser.new do |opts|
+  opts.banner = help
+
+  opts.on("--build-dir [DIR]", "Location of the build targets") do |location|
+    options['build_dir'] = location unless location.nil?
+  end
+  
+  opts.on("--workspace-dir [DIR]", "Location of the workspace directory") do |location|
+    options['workspace_dir'] = location unless location.nil?
+  end
+  
+  opts.on("--verbose", "Use verbose ouput mode") do
+    options['verbose'] = true
+  end
+ 
+  opts.on("--version", "Display current version") do
+    puts "Videojuicer Player SDK " + PlayerSDK.version
+    exit 0
+  end
+end
+ 
+# Read command line options into `options` hash
+opts.parse!
+ 
+# Get source and destintation from command line
+case ARGV.size
+  when 0
+  when 1
+    options['workspace_dir'] = ARGV[0]
+  else
+    puts "Invalid options. Run `playersdk --help` for assistance."
+    exit(1)
+end
+
+config = PlayerSDK.configuration(options)
+
+# Creates a new PlayerSDK compiler instance
+compiler = PlayerSDK::Compiler.new(config)
+
+compiler.process()

data/lib/playersdk/compiler.rb

@@ -0,0 +1,60 @@
+module PlayerSDK    
+   class Compiler
+       attr_accessor :config, :compiler
+       
+       def initialize(config)
+          self.config = config.clone
+          
+          self.compiler = PlayerSDK::Compilers::Flex.new(self.config);
+       end
+       
+       def process
+           tasks = self.config['tasks']
+           
+           puts "Found #{tasks.length} task(s) to process"
+           
+           tasks.each do |key,value|
+              self.run_task(key, value)
+           end
+           
+           puts "\n\n"
+           puts "Completed #{tasks.length} tasks(s)"
+           
+           if self.config['player_src'] != ''
+               #self.compiler.compile_mxmlc(self.config['player_source'], 'src/Main.mxml', true, true, false, 'vj-player.swf', self.config['build_dir'])
+           end
+       end
+       
+       def run_task(key, value)
+          puts "Running task #{key} in #{value['src']}"
+           
+          case value['type']
+              when "player"
+                  self.compiler.compile_mxmlc(value['src'], value['main'], value['sdk'], value['engine'], value['libs'], value['target'], self.config['build_dir'], self.config['deployment_url'])
+              when "engine"
+                  self.compiler.compile_compc(value['src'], value['sdk'], value['engine'], value['libs'], value['target'], self.config['build_dir'], self.config['deployment_url'])
+                  
+                  puts "Optimizing engine swf .."
+                  
+                  self.compiler.optimize_swc(value['target'], self.config['build_dir'])
+              when "addon"
+                  self.compiler.compile_mxmlc(value['src'], value['main'], value['sdk'], value['engine'], value['libs'], value['target'], self.config['build_dir'], self.config['deployment_url'])
+              when "framework"
+                  puts "Moving Flex framework RSLs to #{config['build_dir']}"
+                  
+                  self.compiler.run_command("cp #{config['flex_sdk']}/frameworks/rsls/#{value['framework_rsl']}.swz #{config['build_dir']}/framework.swz")
+                  self.compiler.run_command("cp #{config['flex_sdk']}/frameworks/rsls/#{value['framework_rsl']}.swf #{config['build_dir']}/framework.swf")
+              when "clean"
+                  puts "Cleaning directories ..."
+                  
+                  self.compiler.run_command("rm -rf #{config['build_dir']}/* #{config['tmp_dir']}/*")
+              when ""
+                  puts "Unknown task type, skipping task ..\n"
+                  return
+          end
+          
+          puts "\n"
+          puts "Successfully compiled #{key} to target #{value['target']}.\n"      
+       end
+   end 
+end

data/lib/playersdk/compilers/flex.rb

@@ -0,0 +1,93 @@
+module PlayerSDK
+    module Compilers
+       class Flex
+           attr_accessor :config
+
+           def initialize(config)
+              self.config = config.clone
+           end
+           
+           def executable(name)
+              excutable = "#{config['flex_sdk']}/bin/#{name}"
+              
+              if false
+                 excutable += ".exe" 
+              end
+              
+              excutable
+           end
+           
+           def run_command(command)
+              if config['verbose']
+                  system command
+              else
+                `#{command}`
+              end
+           end
+           
+           def compile_mxmlc(source_path, main_file, include_sdk, include_engine, include_libs, output_file, output_dir, deployment_url)
+              command ="#{executable('mxmlc')} -compiler.source-path #{source_path} -file-specs #{source_path}/#{main_file} -static-link-runtime-shared-libraries=false"
+          
+               if include_sdk
+                   command += " -runtime-shared-library-path=#{config['flex_sdk']}/frameworks/libs/framework.swc,framework.swz,#{deployment_url}crossdomain.xml,framework.swf"
+               end
+           
+               if include_engine
+                  command += " -runtime-shared-library-path=#{include_engine}.swc,#{deployment_url}#{output_file}" 
+               end
+               
+               if include_libs
+                  command += " -compiler.include-libraries #{include_libs}" 
+               end
+           
+               command += " -use-network -benchmark -compiler.strict --show-actionscript-warnings=true -compiler.optimize -compiler.as3"
+               command += " -output #{output_dir}/#{output_file}.swf"
+           
+               run_command(command)
+           end
+       
+           def compile_compc(source_path, include_sdk, include_engine, include_libs, output_file, output_dir, deployment_url)
+               command = "#{executable('compc')} -source-path #{source_path} -include-sources #{source_path}"
+           
+               if include_sdk
+                   command += " -runtime-shared-library-path=#{config['flex_sdk']}/#{config['flex_framework_swc']},#{deployment_url}/#{config['flex_framework_version']}.swz,#{deployment_url}crossdomain.xml,#{deployment_url}/#{config['flex_framework_version']}.swf"
+               end
+           
+               if include_engine
+                  command += " -runtime-shared-library-path=#{include_engine}.swc,#{deployment_url}#{output_file}.swf" 
+               end
+           
+               if include_libs
+                  command += " -compiler.include-libraries #{include_libs}" 
+               end
+           
+               command += " -use-network -benchmark -compiler.strict --show-actionscript-warnings=true -compiler.optimize -compiler.as3"
+               command += " -output #{output_dir}/#{output_file}.swc"
+           
+               run_command(command)
+           end
+       
+           def optimize_swc(output_file, output_dir)
+            self.unzip("#{output_dir}/#{output_file}.swc", "#{config['temp_dir']}")
+            
+            command = "#{executable('optimizer')} -input #{config['temp_dir']}/library.swf -output #{output_dir}/#{output_file}.swf --keep-as3-metadata='Bindable,Managed,ChangeEvent,NonCommittingChangeEvent,Transient'"
+            
+            run_command(command)
+            
+            command = "#{executable('digest')} --digest.swc-path #{output_dir}/#{output_file}.swc --digest.rsl-file #{output_dir}/#{output_file}.swf"
+            
+            run_command(command)
+           end
+    
+           def unzip(file, destination)
+              Zip::ZipFile.open(file) { |zip_file|
+                  zip_file.each { |f|
+                      f_path = File.join(destination, f.name)
+                      FileUtils.mkdir_p(File.dirname(f_path))
+                      zip_file.extract(f, f_path) unless File.exist?(f_path)
+                  }
+              } 
+           end
+       end 
+   end
+end

data/lib/playersdk/core_ext/hash.rb

@@ -0,0 +1,63 @@
+class Hash
+
+  # Returns a new hash just like this one, but with all the string keys expressed as symbols.
+  # Also applies to hashes within self.
+  # Based on an implementation within Rails 2.x, thanks Rails!
+  def deep_symbolize
+    target = dup    
+    target.inject({}) do |memo, (key, value)|
+      value = value.deep_symbolize if value.is_a?(Hash)
+      memo[(key.to_sym rescue key) || key] = value
+      memo
+    end
+  end
+  
+  # Subtracts one hash from another by removing keys from the actor and recursing on any hash values.
+  # Returns a new Hash without affecting the actors.
+  # Example 1:
+  # {:foo=>"bar"} - {:foo=>"bar"} == {}
+  # Example 2 of deep nesting:
+  # {:foo=>{:bar=>"baz", :car=>"naz"}, :bar=>"baz"} - {:foo=>{:car=>"naz"}} == {:foo=>{:bar=>"baz"}, :bar=>"baz"}
+  def -(arg)
+    target = dup; actor = arg.dup
+    actor.each do |key, value|
+      if value.is_a?(Hash)
+        target[key] = target[key] - value
+      else
+        target.delete(key)
+      end
+    end
+    return target
+  end
+  
+  # Returns a new hash just like this one, but with all STRING keys and values evaluated
+  # and rendered as liquid templates using the provided payload hash.
+  def deep_liquify(payload={})
+    target = dup
+    target.inject({}) do |memo, (key, value)|
+      value = value.deep_liquify(payload) if value.is_a?(Hash)
+      value = value.liquify(payload) if value.is_a?(String)
+      key = key.liquify(payload) if key.is_a?(String)
+      memo[(key.to_sym rescue key) || key] = value
+      memo
+    end
+  end
+    
+  # Merges self with another hash, recursively.
+  # 
+  # This code was lovingly stolen from some random gem:
+  # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+  # 
+  # Thanks to whoever made it.
+  def deep_merge(hash)
+    target = dup    
+    hash.keys.each do |key|
+      if hash[key].is_a? Hash and self[key].is_a? Hash
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end      
+      target[key] = hash[key]
+    end    
+    target
+  end
+end

data/lib/playersdk.rb

@@ -0,0 +1,59 @@
+$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+ 
+# rubygems
+require 'rubygems'
+ 
+# core
+require 'fileutils'
+require 'yaml'
+require 'zip/zip'
+ 
+# internal requires
+require 'playersdk/core_ext/hash.rb'
+require 'playersdk/compiler.rb'
+require 'playersdk/compilers/flex.rb'
+ 
+module PlayerSDK
+  # Default options. Overriden by values in config.yml or command-line opts.
+  # (Strings rather symbols used for compatability with YAML)
+  DEFAULTS = {
+      'build_dir' => 'builds',
+      'temp_dir' => 'tmp',
+      'workspace_dir' => '.',
+      'flex_sdk' => '',
+      'flex_framework_swc' => 'frameworks/libs/framework.swc',
+      'flex_framework_version' => '',
+      'tasks' => '',
+      'verbose' => false
+  }
+ 
+  # Generate a Player SDK configuration Hash by merging the default options
+  # with anything in config.yml, and adding the given options on top
+  # +override+ is a Hash of config directives
+  #
+  # Returns Hash
+  def self.configuration(override)
+    # _config.yml may override default source location, but until
+    # then, we need to know where to look for _config.yml
+    workspace_dir = override['workspace_dir'] || PlayerSDK::DEFAULTS['workspace_dir']
+ 
+    # Get configuration from <source>/config.yml
+    config = {}
+    config_file = File.join(workspace_dir, 'config.yml')
+    begin
+      config = YAML.load_file(config_file)
+      puts "Configuration from #{config_file}"
+    rescue => err
+      puts "WARNING: Could not read configuration. Using defaults (and options)."
+      puts "\t" + err
+    end
+ 
+    # Merge DEFAULTS < config.yml < override
+    PlayerSDK::DEFAULTS.deep_merge(config).deep_merge(override)
+  end
+  
+  def self.version
+    yml = YAML.load(File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION.yml])))
+    "#{yml[:major]}.#{yml[:minor]}.#{yml[:patch]}"
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: videojuicer-player-sdk
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Adam Livesley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-12 00:00:00 -07:00
+default_executable: playersdk
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
+- !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: 
+description: Videojuicer Player SDK runtime and compiler to create and build Player Addons.
+email: sixones@me.com
+executables: 
+- playersdk
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- README.textile
+- Rakefile
+- VERSION.yml
+- bin/playersdk
+- lib/playersdk.rb
+- lib/playersdk/core_ext/hash.rb
+- lib/playersdk/compiler.rb
+- lib/playersdk/compilers/flex.rb
+has_rdoc: true
+homepage: http://developer.videojuicer.com
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Videojuicer Player SDK runtime and compiler.
+test_files: []
+