asrake 0.8.1 → 0.9.0

data/README.md

@@ -1,7 +1,10 @@
 ASRake
 ======
 
-**Rake library for Actionscript 3 projects**
+**A Rake library for Actionscript 3, Flex, and AIR projects.**
+
+### `gem install asrake`
+
 
 Overview
 --------
@@ -21,6 +24,7 @@ Arguments match those passed to the compiler (mxmlc, compc, adt, etc) with hyphe
 
 Convenience methods are provided for `include_libraries`, `external_library_path`, and `library_path`; you can instead use `statically_link`, `dynamically_link`, and `statically_link_only_referenced_classes` respectively.
 
+
 How to Use
 ----------
 
@@ -40,7 +44,8 @@ The following snippets produce identical tasks.
 ```ruby
 desc "Build swc"
 ASRake::CompcTask.new :build do |build|
-# you can store the compiler arguments, for example, maybe we need to know the output_dir later on
+# You can store the compiler arguments for later
+# For example, maybe we need to know the output_dir later on
 #compc = ASRake::CompcTask.new :build do |build|
    build.target_player = 11.0
    build.output = "bin/bin/my_project.swc"
@@ -104,7 +109,7 @@ ASRake::AdtTask.new :package => :build do |package|
 end
 ```
 
-### Versioning
+### Version
 
 ```
 ASRake::VersionTask(task_name = :version, file_name = "VERSION")
@@ -129,7 +134,7 @@ ASRake::VersionTask.new :v, "./config/version.txt"
 There is a task `version:sync` that is run every time the version changes. This can be useful for things like updating configuration files automatically. To use, add a block to the task:
 
 ```ruby
-#replace :version with whatever you provided to ASRake::VersionTask.new 
+# replace :version with whatever you provided to ASRake::VersionTask.new 
 namespace :version do
    task :sync do
       #update application.xml
@@ -153,4 +158,24 @@ swf = ASRake::MxmlcTask.new :build do |build|
 end
 
 ASRake::CleanTask.new swf
+```
+
+### New copy method
+
+ASRake introduces a new copy method `cp_u` on FileUtils and in the global namespace.
+
+This copies all files from the source that do not exist or are older at the destination
+
+```ruby
+# copy a single file to a destination folder
+cp_u "path/to/file.xml", "/dest/"
+
+# copy a single file to a differently named file
+cp_u "path/to/file.xml", "/dest/dest.xml"
+
+# copy an array of files
+cp_u %w{application.xml my_app.swf config.json}, "/dest"
+
+# use FileList, Dir.glob(), or othr methods to copy groups of files
+cp_u FileList["lib/**/*.swc"], "bin/lib"
 ```

data/lib/asrake/adt_task.rb

@@ -5,7 +5,7 @@ module ASRake
 class AdtTask < Rake::TaskLib
 
 	attr_accessor :output
-	#http://help.adobe.com/en_US/air/build/WS5b3ccc516d4fbf351e63e3d118666ade46-7ff1.html
+	# http://help.adobe.com/en_US/air/build/WS5b3ccc516d4fbf351e63e3d118666ade46-7ff1.html
 	attr_accessor :application_descriptor
 
 	#
@@ -47,7 +47,7 @@ class AdtTask < Rake::TaskLib
 		fail "You must define 'keystore_name' for #{self}" if self.keystore_name == nil
 		fail "You must define 'storepass' for #{self}" if self.storepass == nil
 
-		#TODO: Somehow confirm that the initialWindow content is included in the build
+		# TODO: Somehow confirm that the initialWindow content is included in the build
 		app_xml = Nokogiri::XML(File.read(application_descriptor))
 		swf = app_xml.at_css("initialWindow > content").content.to_s
 		#swf = File.join(@output_dir, swf)
@@ -101,9 +101,9 @@ class AdtTask < Rake::TaskLib
 						 "Verify the command line arguments used for creating signatures."
 				when 12
 					fail "Invalid input\n" +
-						 "Verify file paths and other arguments passed to ADT on the command line.\n" +
-						 "Be sure the initial content in #{self.application_descriptor} is included in the build:\n" +
-						 "<initialWindow>\n   <content>#{swf}</content>\n</initialWindow>"
+						 "Verify file paths and other arguments passed to ADT on the command line."#\n" +
+						 #"Be sure the initial content in #{self.application_descriptor} is included in the build:\n" +
+						 #"<initialWindow>\n   <content>#{swf}</content>\n</initialWindow>"
 				else
 					fail "Operation exited with status #{status.exitstatus}"
 				end

data/lib/asrake/base_compiler_args.rb

@@ -36,8 +36,7 @@ module BaseCompilerArguments_Module
 	attr_reader :output_file
 	attr_reader :output_dir
 
-	def initialize
-		super
+	def initialize(args=nil)
 		@isAIR = false
 		@library_path = []
 		@external_library_path = []
@@ -46,6 +45,15 @@ module BaseCompilerArguments_Module
 		@debug = false
 		#include default flex-config
 		@load_config = [ FlexSDK::flex_config ]
+
+		self.merge_in args if args != nil
+
+		yield self if block_given?
+	end
+
+	# compiler needs to be defined in subclass
+	def compiler
+		fail "'compiler' must be defined in subclass"
 	end
 
 	def output
@@ -88,13 +96,16 @@ module BaseCompilerArguments_Module
 	end
 	def isAIR= value
 		@isAIR = value
-		# if the default config is in the load-config array, replace it with the proper one
+		# if the default config is in the load-config array, replace it with the proper one based on context
 		if @isAIR
 			self.load_config.map! {|val| val == FlexSDK::flex_config ? FlexSDK::air_config : val}
 		else
 			self.load_config.map! {|val| val == FlexSDK::air_config ? FlexSDK::flex_config : val}
 		end
 	end
+	# alias them as well
+	alias_method :isAir, :isAIR
+	alias_method :isAir=, :isAIR=
 
 	def merge_in(args)
 		@@args.each do |arg|
@@ -112,6 +123,17 @@ module BaseCompilerArguments_Module
 	#
 	def generate_args
 		
+		#
+		# allow all the array arguments to be set as single strings
+		#
+
+		# TODO: have this be part of the attribute accessor
+		self.source_path = [self.source_path] if self.source_path.is_a? String
+		self.load_config = [self.load_config] if self.load_config.is_a? String
+		self.library_path = [self.library_path] if self.library_path.is_a? String
+		self.external_library_path = [self.external_library_path] if self.external_library_path.is_a? String
+		self.include_libraries = [self.include_libraries] if self.include_libraries.is_a? String
+
 		# set to true if the version is defined in one of the referenced configs
 		isTargetDefined = false
 		if self.target_player == nil
@@ -174,6 +196,17 @@ module BaseCompilerArguments_Module
 		return args
 	end
 
+	def build(tips=true)
+		fail "Compiler not defined in #{self}" if compiler == nil
+		if tips
+			run "#{compiler}#{generate_args}" do |line|
+				generate_error_message_tips(line)
+			end
+		else
+			run "#{compiler}#{generate_args}"
+		end
+	end
+
 	private
 
 	def hasDefaultConfigFile?
@@ -187,5 +220,44 @@ module BaseCompilerArguments_Module
 		return (path == FlexSDK::flex_config || path == FlexSDK::air_config)
 	end
 
+	# Try to include helpful information about specific errors
+	def generate_error_message_tips(line)
+		advice = []
+		if((target_player == nil || Float(target_player) < 11) && line.include?("Error: Access of undefined property JSON"))
+			advice << "Be sure you are compiling with 'target_player' set to 11.0 or higher"
+			advice << "to have access to the native JSON parser. It is currently set to #{target_player}"
+		elsif line.include?("Error: The definition of base class Object was not found")
+			advice << "If you have removed the default flex-config by setting 'load_config' to"
+			advice << "an empty or alternate value (i.e., not appended to it) you must be sure to"
+			advice << "still reference the necessary core Flash files, especially playerglobal.swc"
+		end
+
+		if !advice.empty?
+			puts "*********************************"
+			puts "ASRake Note: " + advice.join("\n")
+			puts "*********************************"
+		end
+	end
+
 end
-end
+end
+
+##fill config with the default flex_config options
+#if use_default_flex_config
+#	#initialize with default values from flex-config
+#	flex_config = Nokogiri::XML(File.read(FlexSDK::flex_config))
+#
+#	target_player = flex_config.css('target-player').children.to_s
+#	swf_version = flex_config.css('swf-version').children.to_s
+#	
+#	flex_config.css('compiler external-library-path path-element').each { |ext|
+#		puts ext.children
+#	}
+#end
+
+#http://fpdownload.macromedia.com/get/flashplayer/updaters/11/playerglobal11_2.swc
+#frameworks\libs\player
+
+#-dump-config compiler_config.xml
+#-link-report compiler_linkreport.xml
+#-size-report compiler_sizereport.xml

data/lib/asrake/base_compiler_task.rb

@@ -1,5 +1,4 @@
 require 'rake/tasklib'
-
 require 'asrake/base_compiler_args'
 
 module ASRake
@@ -7,11 +6,7 @@ class BaseCompilerTask < Rake::TaskLib
 	include BaseCompilerArguments_Module
 
 	def initialize(name, args)
-		super()
-
-		self.merge_in args if args != nil
-
-		yield self if block_given?
+		super(args)
 
 		@name = name
 		
@@ -23,52 +18,5 @@ class BaseCompilerTask < Rake::TaskLib
 
 	end
 
-	protected
-
-	def build
-		fail "build must be defined in subclass"
-	end
-
-	private
-
-	# Try to include helpful information about specific errors
-	def generate_error_message_tips(line)
-		advice = []
-		if((target_player == nil || Float(target_player) < 11) && line.include?("Error: Access of undefined property JSON"))
-			advice << "Be sure you are compiling with 'target_player' set to 11.0 or higher"
-			advice << "to have access to the native JSON parser. It is currently set to #{target_player}"
-		elsif line.include?("Error: The definition of base class Object was not found")
-			advice << "If you have removed the default flex-config by setting 'load_config' to"
-			advice << "an empty or alternate value (i.e., not appended to it) you must be sure to"
-			advice << "still reference the necessary core Flash files, especially playerglobal.swc"
-		end
-
-		if !advice.empty?
-			puts "*********************************"
-			puts "ASRake Note: " + advice.join("\n")
-			puts "*********************************"
-		end
-	end
-
-end
 end
-
-##fill config with the default flex_config options
-#if use_default_flex_config
-#	#initialize with default values from flex-config
-#	flex_config = Nokogiri::XML(File.read(FlexSDK::flex_config))
-#
-#	target_player = flex_config.css('target-player').children.to_s
-#	swf_version = flex_config.css('swf-version').children.to_s
-#	
-#	flex_config.css('compiler external-library-path path-element').each { |ext|
-#		puts ext.children
-#	}
-#end
-
-#http://fpdownload.macromedia.com/get/flashplayer/updaters/11/playerglobal11_2.swc
-#frameworks\libs\player
-
-#-dump-config compiler_config.xml
-#-link-report compiler_linkreport.xml
-#-size-report compiler_sizereport.xml
+end

data/lib/asrake/compc_args.rb

@@ -6,6 +6,10 @@ module ASRake
 module CompcArguments_Module
 	include BaseCompilerArguments_Module
 
+	def compiler
+		FlexSDK::compc
+	end
+
 	def generate_args
 		compc = super
 		

data/lib/asrake/compc_task.rb

@@ -20,9 +20,12 @@ class CompcTask < BaseCompilerTask
 			self.build
 		end
 
+		# allow setting source_path with '=' instead of '<<'
+		self.source_path = [self.source_path] if self.source_path.is_a? String
+
 		# set dependencies on all .as and .mxml files in the source paths
 		dependencies = FileList.new
-		source_path.each do |path|
+		self.source_path.each do |path|
 			path = cf path
 			dependencies.include(File.join(path, "*.as"))
 			dependencies.include(File.join(path, "*.mxml"))
@@ -40,13 +43,5 @@ class CompcTask < BaseCompilerTask
 
 	end
 
-	protected
-
-	def build
-		run "#{FlexSDK::compc}#{generate_args}" do |line|
-			generate_error_message_tips(line)
-		end
-	end
-
 end
 end

data/lib/asrake/file_utils.rb

@@ -0,0 +1,81 @@
+require 'fileutils'
+
+module ASRake
+module FileUtilsExt
+
+	#
+	# Copies files recursivly only if they don't exist at the destination or the destination
+	# files are older.
+	# 
+	# There are two possible ways to copy, multiple files, or a single file
+	#
+	# 1. Copying multiple files
+	#    Examples:
+	#    * `cp_u FileList["/path/*.ext"], "/dest"`
+	#    * `cp_u %w{src1 /path/src2}, "/dest"`
+	#    * `cp_u /path/to/src/, "/dest"`
+	#    An error will be thrown if the destination already exists and is not a directory.
+	# 2. Copying a single file
+	#    For example, copying file "src"
+	#    1. If destination is, or is infered to be, a directory, the src file is copied to 
+	#       an identically named file at the destination directory
+	#       `cp_u /path/src, /path/dest/`
+	#       `cp_u /path/src, /path/dest` <- dest is an existing directory
+	#    2. If destination is, or is infered to be, a file, the src file is copied and renamed
+	#       to the destination file
+	#       `cp_u /path/src, /path/dest` <- dest does not exist or is a file
+	#
+	def cp_u(src, dest, options = {})
+		if tmp = Array.try_convert(src)
+			tmp.each do |s|
+				copy_files(s, File.join(dest, File.basename(s)), options)
+			end
+		else
+			copy_files(src, dest, options)
+		end
+		#puts "Files copied. #{src} => #{dest}"
+	end
+
+	private
+
+	def copy_files(src, dest, options)
+		if File.directory?(src)
+			#recurse the "src" dir tree, appending the path to dest
+			Dir.foreach(src) do |src_file|
+				if src_file != ".." && src_file != "."
+					#puts src_file + "|" + File.join(src, src_file) + "|" + File.join(dest, src_file)
+					copy_files(File.join(src, src_file), File.join(dest, src_file), options)
+				end
+			end
+		else
+			# If the destination is an existing directory, or ends in a path separator, then
+			# append the source file name to it
+			dest = File.join(dest, File.basename(src)) if File.directory?(dest) || dest =~ /[\\\/]$/
+
+			if !File.exist?(dest) || (File.mtime(dest) < File.mtime(src))
+				puts "cp -u #{[src,dest].flatten.join ' '}" if options[:verbose]
+				return if options[:noop]
+				begin
+					dir = File.dirname(dest)
+					mkdir_p(dir, :verbose => false) if !File.exist?(dir)
+				rescue
+					fail "Error copying #{src} to #{dest}. Cannot create directory. #{$!}"
+				end
+				begin
+					FileUtils::copy_file src, dest
+				rescue
+					fail "Error copying #{src} to #{dest}. #{$!}"
+				end
+			end
+		end
+	end
+end
+end
+
+module FileUtils
+	include ASRake::FileUtilsExt
+	module_function :cp_u
+	module_function :copy_files
+end
+
+self.extend ASRake::FileUtilsExt

data/lib/asrake/flexsdk.rb

@@ -1,81 +1,78 @@
 require 'asrake/host'
 
 class FlexSDK
-	SDK_PATHS = []
+
+SDK_PATHS = []
+
+class << self
+
+	@@initialized = false
+
+	# dynamically create getters for the executables and config files
+	@@executables = %w[adt adl asdoc mxmlc compc]
+	@@configs = %w[flex-config air-config]
 	
-	class << self
+	def root
+		init()
+		return @root
+	end
 
-		@@initialized = false
-		
-		@@executables = %w[adt adl asdoc mxmlc compc]
-		@@configs = %w[flex-config air-config]
-		
-		def root
+	[].concat(@@configs).concat(@@executables).each do |name|
+		name = name.gsub('-','_')
+		define_method name do
 			init()
-			return @root
+			instance_variable_get "@#{name}"
 		end
+	end
 
-		@@configs.each do |name|
-			method = name.gsub('-','_')
-			define_method method do
-				init()
-				instance_variable_get "@#{method}"
-			end
-		end
+	private
 
-		@@executables.each do |name|
-			define_method name do
-				init()
-				instance_variable_get "@#{name}"
-			end
+	def init()
+		if @@initialized
+			return
 		end
+		@@initialized = true
+		@@root = nil
+		missing = {}
+		# Find where the flex sdk is installed
+		SDK_PATHS.each do |path|
+			#remove /bin/ fom the end of the path if it exists
+			path.sub!(/[\/\\]bin[\/\\]?$/,'')
+			if File.exists?(path)
+				missing[SDK_PATHS] = []
 
-		private
+				@@configs.each do |name|
+					config = c File.join(path, 'frameworks', "#{name}.xml")
+					missing[SDK_PATHS] << config if !File.exists?(config)
+					instance_variable_set "@#{name.gsub('-','_')}", config
+				end
 
-		def init()
-			if !@@initialized
-				@@root = nil
+				@@executables.each do |name|
+					exec = c File.join(path, 'bin', name)
+					missing[SDK_PATHS] << exec if !File.exists?(exec)
+					instance_variable_set "@#{name}", exec
+				end
 				
-				# Find where the flex sdk is installed
-				SDK_PATHS.each do |path|
-					#remove /bin/ fom the end of the path if it exists
-					path.sub!(/[\/\\]bin[\/\\]?$/,'')
-					if File.exists?(path)
-						allValid = true
-
-						@@configs.each do |name|
-							config = c File.join(path, 'frameworks', "#{name}.xml")
-							allValid = false if !File.exists?(config)
-							instance_variable_set "@#{name.gsub('-','_')}", config
-						end
-
-						@@executables.each do |name|
-							exec = c File.join(path, 'bin', name)
-							allValid = false if !File.exists?(exec)
-							instance_variable_set "@#{name}", exec
-						end
-						
-						if allValid
-							@@root = path
-							break
-						end
-					end
+				if missing[SDK_PATHS].empty?
+					@@root = path
+					break
 				end
+			end
+		end
 
-				if @@root == nil
-					str = ""
-					if !SDK_PATHS.empty?
-						str << "Could not find a valid Flex SDK at any of the paths in FlexSDK::SDK_PATHS\n=> "
-						str << SDK_PATHS.join("\n=> ")
-						str << "\n"
-					end
-					str << "Append a valid SDK path in your rakefile, e.g.:\nFlexSDK::SDK_PATHS << 'C:\\develop\\sdk\\flex_sdk_4.6.0.23201'"
-					str << "\nFor more information, see: http://adobe.com/go/flex_sdk/"
-					fail str
-				end
+		if @@root == nil
+			str = ""
+			if !SDK_PATHS.empty?
+				str << "Could not find a valid Flex SDK at any of the paths in FlexSDK::SDK_PATHS\n=> "
+				# TODO: output which paths are invalid and which are missing a particular binary from missing[] above
+				str << SDK_PATHS.join("\n=> ")
+				str << "\n"
 			end
-			@@initialized = true
+			str << "Append a valid SDK path in your rakefile, e.g.:\nFlexSDK::SDK_PATHS << 'C:\\develop\\sdk\\flex_sdk_4.6.0.23201'"
+			str << "\nFor more information, see: http://adobe.com/go/flex_sdk/"
+			fail str
 		end
 	end
+end
 
 end

data/lib/asrake/mxmlc_args.rb

@@ -5,6 +5,10 @@ module ASRake
 
 module MxmlcArguments_Module
 	include BaseCompilerArguments_Module
+
+	def compiler
+		FlexSDK::mxmlc
+	end
 end
 
 class MxmlcArguments

data/lib/asrake/mxmlc_task.rb

@@ -25,13 +25,5 @@ class MxmlcTask < BaseCompilerTask
 
 	end
 
-	protected
-
-	def build
-		run "#{FlexSDK::mxmlc}#{generate_args}" do |line|
-			generate_error_message_tips(line)
-		end
-	end
-
 end
 end

data/lib/asrake.rb

@@ -22,4 +22,6 @@ THE SOFTWARE.
 
 # require all the task files so users can create them just by requiring asrake
 Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), "asrake/*_task.rb")).each {|f| require f }
-Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), "asrake/*_args.rb")).each {|f| require f }
+Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), "asrake/*_args.rb")).each {|f| require f }
+
+require 'asrake/file_utils'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asrake
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-05 00:00:00.000000000 Z
+date: 2012-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -75,7 +75,7 @@ files:
 - lib/asrake/clean_task.rb
 - lib/asrake/compc_args.rb
 - lib/asrake/compc_task.rb
-- lib/asrake/copy_task.rb
+- lib/asrake/file_utils.rb
 - lib/asrake/flexsdk.rb
 - lib/asrake/host.rb
 - lib/asrake/mxmlc_args.rb
@@ -111,5 +111,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A Rake library for Actionscript projects
+summary: A Rake library for Actionscript 3, Flex, and AIR projects
 test_files: []

data/lib/asrake/copy_task.rb

@@ -1,87 +0,0 @@
-require 'rake/tasklib'
-
-module ASRake
-class CopyTask < Rake::TaskLib
-
-	attr_accessor :copy_list
-
-	def initialize(name = :copy)
-		self.copy_list = Hash.new
-
-		yield self if block_given?
-
-		#define named task first so if desc was called it will be attached to it instead of the file task
-		Rake::Task.define_task name do
-			# use longest source path to space the output. yup, seriously that OCD
-			len = self.copy_list.keys.group_by(&:size).max.last[0].length
-			self.copy_list.each do |from, to|
-				copy_files from, to
-				puts "Files copied. %#{len}s => %s" % [from, to]
-			end
-		end
-	end
-
-	def copy(from_path, to_path=nil)
-		if from_path == nil
-			fail puts "Cannot copy files. No source provided."
-		end
-
-		# special case getting a hash as an argument
-		if from_path.is_a? Hash
-			from_path.each {|from, to| copy from, to}
-			return
-		end
-
-		if to_path == nil
-			fail puts "Cannot copy files from #{from_path}. No destination provided."
-		end
-
-		self.copy_list[from_path] = to_path
-	end
-	alias_method :add, :copy
-
-	private
-
-	def copy_files(from_path, to_path, times=0)
-		from = FileList[from_path]
-		unless from.length == 0
-			from.each do |from|
-				if File.directory?(from)
-					#recurse the "from" dir tree, appending the path to to_path
-					Dir.foreach(from) do |fr|
-						if fr != ".." && fr != "."
-							#puts fr + "|" + File.join(from, fr) + "|" + File.join(to_path, fr)
-							copy_files(File.join(from, fr), File.join(to_path, fr), times+1)
-						end
-					end
-				else
-					# if this is the first iteration, we haven't gotten to join the "to" path in the directory loop above, so
-					# append it to the file here if either the to or from path are a directory
-					if times == 0 && (File.directory?(to_path) || File.directory?(from_path) || from_path =~ /\*/)
-						to = File.join(to_path, File.basename(from)) 
-					else
-						to = to_path
-					end
-
-					if !File.exists?(to) || (File.mtime(to.to_s) < File.mtime(from.to_s))
-						begin
-							dir = File.dirname(to)
-							mkdir_p(dir, :verbose => false) if !File.exist?(dir)
-						rescue
-							fail "Error copying #{from} to #{to}. Cannot create directory. #{$!}"
-						end
-						begin
-							cp_r from, to#, :verbose => false
-						rescue
-							fail "Error copying #{from} to #{to}. #{$!}"
-						end
-					end
-				end
-			end
-		else
-			puts "Error copying to #{to_path}. No files exist at source #{from_path}."
-		end
-	end
-
-end
-end