asrake 0.8.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Malachi Griffie <malachi@nexussays.com>
+
+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/README.md

@@ -0,0 +1,156 @@
+ASRake
+======
+
+**Rake library for Actionscript 3 projects**
+
+Overview
+--------
+
+Add the path(s) to your Flex SDK for all systems that will need to run the Rake tasks.
+```ruby
+FlexSDK::SDK_PATHS << 'C:\develop\sdk\flex_sdk_4.6.0.23201'
+FlexSDK::SDK_PATHS << "C:/develop/sdk/flex_sdk_4.5.1"
+FlexSDK::SDK_PATHS << "/opt/lib/adobe/flex_4.6"
+```
+
+### Compiler Arguments
+
+Arguments match those passed to the compiler (mxmlc, compc, adt, etc) with hyphens `-` replaced by underscores `_` (e.g., to set the `target-player` compiler argument assign to the `target_player` property)
+
+> Since this is still in development, not all compiler arguments have a property mapped to them. Use `additional_args` to pass whatever text you want into the compiler.
+
+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
+----------
+
+### Build a SWF or SWC
+
+```
+ASRake::MxmlcTask(task_name = :build, compiler_args = nil) |self|
+```
+```
+ASRake::CompcTask(task_name = :build, compiler_args = nil) |self|
+```
+
+You can define the compile arguments elsewhere and pass it to the task, or set them inside the task block, or a combination of both. It is purely preference.
+
+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
+#compc = ASRake::CompcTask.new :build do |build|
+   build.target_player = 11.0
+   build.output = "bin/bin/my_project.swc"
+   build.debug = true
+   build.source_path << "bin/src"
+   build.statically_link_only_referenced_classes << "lib/lib_used_in_project.swc"
+end
+```
+
+```ruby
+args = ASRake::CompcArguments.new
+args.target_player = 11.0
+args.output = "bin/bin/my_project.swc"
+args.debug = true
+args.source_path << "bin/src"
+args.statically_link_only_referenced_classes << "lib/lib_used_in_project.swc"
+
+desc "Build swc"
+ASRake::CompcTask.new :build, args
+```
+
+```ruby
+args = ASRake::CompcArguments.new
+args.target_player = 11.0
+args.output = "bin/bin/my_project.swc"
+args.debug = false
+args.source_path << "bin/src"
+
+desc "Build swc"
+ASRake::CompcTask.new :build, args do |compc|
+   compc.debug = true
+   compc.statically_link_only_referenced_classes << "lib/lib_used_in_project.swc"
+end
+```
+
+### Build an AIR
+
+Compile your SWF file as normal, but set the `isAIR` property to true
+
+```ruby
+desc "Build app"
+ASRake::MxmlcTask.new :build do |build|
+	build.load_config << "mxmlc_config.xml"
+	build.output = "bin/my_app.swf"
+	build.isAIR = true
+end
+```
+
+Provide the package task with the AIR and keystore information. If the key doesn't exist, it will be created.
+
+> Be sure that the swf file is included in the package (eg, it is included here by packaging everything in the bin directory with `-C bin .`)
+
+```ruby
+ASRake::AdtTask.new :package => :build do |package|
+	package.output = "bin/my_app.air"
+	package.keystore = "my_app_cert.p12"
+	package.keystore_name = "my_app"
+	package.storepass = "my_app"
+	package.tsa = "none"
+	package.additional_args = "-C bin ."
+end
+```
+
+### Versioning
+
+```
+ASRake::VersionTask(task_name = :version, file_name = "VERSION")
+```
+
+No additional arguments are needed to create a version task. Once added to your Rakefile, you can run `rake version:help` for information on how versioning works.
+
+If you are fine with the defaults, you can just add:
+
+```ruby
+ASRake::VersionTask.new
+```
+
+Otherwise you can define the task name and filename as you wish
+
+```ruby
+ASRake::VersionTask.new :v, "./config/version.txt"
+```
+
+#### Version Sync
+
+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 
+namespace :version do
+   task :sync do
+      #update application.xml
+   end
+end
+```
+
+### Clean
+
+```
+ASRake::CleanTask.new(*compiler_args)
+```
+
+Provide your compiler arguments to `ASRake::CleanTask` and it will automatically create clean and clobber tasks.
+
+```ruby
+swf = ASRake::MxmlcTask.new :build do |build|
+	build.load_config << "mxmlc_config.xml"
+	build.output = "bin/my_app.swf"
+	build.isAIR = true
+end
+
+ASRake::CleanTask.new swf
+```

data/lib/asrake.rb

@@ -0,0 +1,25 @@
+=begin MIT-LICENSE
+Copyright (c) 2012 Malachi Griffie <malachi@nexussays.com>
+
+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.
+=end
+
+# 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 }

data/lib/asrake/adt_task.rb

@@ -0,0 +1,146 @@
+require 'rake/tasklib'
+require 'nokogiri'
+
+module ASRake
+class AdtTask < Rake::TaskLib
+
+	attr_accessor :output
+	#http://help.adobe.com/en_US/air/build/WS5b3ccc516d4fbf351e63e3d118666ade46-7ff1.html
+	attr_accessor :application_descriptor
+
+	#
+	# The path to the keystore file for file-based store types.
+	#
+	attr_accessor :keystore
+	# 
+	# The alias of a key in the keystore. Specifying an alias is not necessary when a keystore only contains
+	# a single certificate. If no alias is specified, ADT uses the first key in the keystore.
+	#
+	attr_accessor :alias
+	attr_accessor :storetype
+	attr_accessor :storepass
+	attr_accessor :keystore_name
+	#
+	# Specifies the URL of an RFC3161-compliant timestamp server to time-stamp the digital signature.
+	# If no URL is specified, a default time-stamp server provided by Geotrust is used. When the signature
+	# of an AIR application is time-stamped, the application can still be installed after the signing
+	# certificate expires, because the timestamp verifies that the certificate was valid at the time of signing.
+	#
+	attr_accessor :tsa
+
+	attr_accessor :additional_args
+
+	attr_reader :output_file
+	attr_reader :output_dir
+	attr_reader :keystore_file
+	attr_reader :keystore_dir
+
+	def initialize(name = :package)
+		self.application_descriptor = "application.xml";
+		self.storetype = "pkcs12"
+
+		yield self if block_given?
+
+		fail "You must define 'output' for #{self}" if self.output == nil
+		fail "You must define 'application_descriptor' for #{self}" if self.application_descriptor == nil || !File.exists?(self.application_descriptor)
+		fail "You must define 'keystore' for #{self}" if self.keystore == nil
+		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
+		app_xml = Nokogiri::XML(File.read(application_descriptor))
+		swf = app_xml.at_css("initialWindow > content").content.to_s
+		#swf = File.join(@output_dir, swf)
+		#puts swf
+
+		# 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
+			command = "#{FlexSDK::adt}"
+			command << " -package"
+			command << " -tsa #{self.tsa}" if self.tsa != nil
+			command << " -storetype #{self.storetype}"
+			command << " -keystore #{self.keystore}"
+			command << " -storepass #{self.storepass}"
+			command << " #{self.output} #{self.application_descriptor}"
+			command << " #{additional_args}" if self.additional_args != nil
+			status = run command, false
+			if status.exitstatus != 0
+				case status.exitstatus
+				when 2
+					fail "Usage error\n" + 
+						 "Check the command line arguments for errors"
+				when 5
+					fail "Unknown error\n" +
+						 "This error indicates a situation that cannot be explained by common error conditions.\n" +
+						 "Possible root causes include incompatibility between ADT and the Java Runtime Environment,\n"
+						 "corrupt ADT or JRE installations, and programming errors within ADT."
+				when 6
+					fail "Could not write to output directory\n" +
+						 "Make sure that the specified (or implied) output directory is accessible and\n" +
+						 "that the containing drive has sufficient disk space."
+				when 7
+					fail "Could not access certificate\n" +
+						 "Make sure that the path to the keystore is specified correctly: #{self.keystore}\n" +
+						 "Make sure that the keystore password is correct: #{self.storepass}"
+						 #"Check that the certificate within the keystore can be accessed."
+				when 8
+					fail "Invalid certificate\n" +
+						 "The certificate file is malformed, modified, expired, or revoked."
+				when 9
+					fail "Could not sign AIR file\n" +
+						 "Verify the signing options passed to ADT."
+				when 10
+					fail "Could not create time stamp\n" +
+						 "ADT could not establish a connection to the timestamp server.\n" + 
+						 "If you connect to the internet through a proxy server, you may need to configure\n" + 
+						 "the JRE proxy settings. There have also been errors reported with Java 7: \n" +
+						 "http://www.flashdevelop.org/community/viewtopic.php?p=41221\n" + 
+						 "You can disable checking a timestamp server by setting 'tsa' to 'none' in your task"
+				when 11
+					fail "Certificate creation error\n" +
+						 "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>"
+				else
+					fail "Operation exited with status #{status.exitstatus}"
+				end
+			end
+			puts "#{c output} (#{File.size(self.output)} bytes)"
+		end
+
+		# if the task name is a hash (ie, has dependencies defined) make sure we pull out the task name from it
+		name, _ = name.first if name.is_a? Hash
+
+		@output_dir = File.dirname(self.output)
+		@output_file = File.basename(self.output)
+
+		@keystore_dir = File.dirname(self.keystore)
+		@keystore_file = File.basename(self.keystore)
+
+		directory self.output_dir
+
+		# setup file dependencies
+		#file output => output_dir
+		#files.each do |to, from|
+		#	file output => [cf(from)]
+		#end
+		
+		#add output file task as a dependency to the named task created
+		#task name => output
+
+		task name => self.output_dir
+
+		file self.keystore do
+			run "#{FlexSDK::adt} -certificate -cn #{self.keystore_name} 1024-RSA #{self.keystore} #{self.storepass}"
+			puts "Certificate created at #{self.keystore} with password '#{self.storepass}'"
+		end
+
+		task name => self.keystore
+
+	end
+
+end
+end

data/lib/asrake/base_compiler_args.rb

@@ -0,0 +1,191 @@
+require 'asrake/flexsdk'
+require 'nokogiri'
+
+module ASRake
+
+module BaseCompilerArguments_Module
+
+	#
+	# compiler arguments
+	#
+
+	@@args = [
+		:output,
+
+		:source_path,
+		:library_path,
+		:external_library_path,
+		:include_libraries,
+
+		:load_config,
+		:target_player,
+		:swf_version,
+
+		:debug,
+
+		:dump_config
+	]
+	attr_accessor *@@args
+
+	attr_accessor :additional_args
+
+	#
+	# non-compiler arguments
+	#
+	
+	attr_reader :output_file
+	attr_reader :output_dir
+
+	def initialize
+		super
+		@isAIR = false
+		@library_path = []
+		@external_library_path = []
+		@include_libraries = []
+		@source_path = []
+		@debug = false
+		#include default flex-config
+		@load_config = [ FlexSDK::flex_config ]
+	end
+
+	def output
+		@output
+	end
+
+	def output= value
+		@output = value
+		# if the output path ends in a path separator, it is a directory
+		if @output =~ /[\/\\]$/
+			@output_dir = @output
+		else
+			# forward-slashes required for File methods
+			@output = cf @output
+			@output_dir = File.dirname(@output)
+			@output_file = File.basename(@output)
+		end
+	end
+
+	def output_is_dir?
+		output_file == nil
+	end
+
+	# provide a more understandable alias 
+	def statically_link_only_referenced_classes
+		library_path
+	end
+
+	def statically_link
+		include_libraries
+	end
+
+	def dynamically_link
+		external_library_path
+	end
+
+	# use the air configs if true
+	def isAIR
+		@isAIR
+	end
+	def isAIR= value
+		@isAIR = value
+		# if the default config is in the load-config array, replace it with the proper one
+		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
+
+	def merge_in(args)
+		@@args.each do |arg|
+			# TODO: This needs to concat arrays not overwite them
+			self.send("#{arg}=", args.send(arg))
+		end
+	end
+
+	def to_s
+		generate_args
+	end
+
+	#
+	# Verify properties and then return build arguments
+	#
+	def generate_args
+		
+		# set to true if the version is defined in one of the referenced configs
+		isTargetDefined = false
+		if self.target_player == nil
+			# try to find necessary args in any loaded config files
+			unless self.load_config.length == 1 && isDefaultConfig?(self.load_config[0])
+				# load config in reverse so last added has priority
+				self.load_config.reverse.each do |config|
+					flex_config = Nokogiri::XML(File.read(config))
+					
+					isTargetDefined = true if flex_config.at_css('target-player')
+					#configSource? = true if 
+				end
+			end
+		end
+
+		fail "You must define 'target_player' for #{self}" if self.target_player == nil && !isTargetDefined
+
+		# TODO: iterate over all non-default config files provided and look for source-path entries
+		#fail "You must add at least one path to 'source_path' for #{self}" if source_path.empty? && !configSource?
+
+		# TODO: iterate over all non-default config files provided and look for output
+		fail "You must define 'output' for #{self}" if self.output == nil
+
+		#
+		# validation complete, generate build args
+		#
+
+		args = ""
+		# set output as directory if it ends in a trailing slash
+		args << " -output=#{cf output}"
+		args << " -directory=true" if output_is_dir?
+
+		args << " -target-player=#{target_player}" if self.target_player != nil
+		args << " -swf-version=#{swf_version}" if self.swf_version != nil
+
+		args << " +configname=air" if self.isAIR
+
+		args << " -debug=#{debug}"
+		args << " -source-path=#{cf source_path.join(',')}" if !self.source_path.empty?
+
+		# add the -load-config option if it is anything other than the default
+		unless self.load_config.length == 1 && isDefaultConfig?(self.load_config[0])
+			# if the default flex config is still in the load_config array, then append all config files, otherwise have the first one replace
+			op = hasDefaultConfigFile? ? "+=" : "="
+			self.load_config.each do |config|
+				args << " -load-config#{op}#{cf config}" unless isDefaultConfig?(config)
+				op = "+="
+			end
+		end
+
+		args << " -library-path=#{cf library_path.join(',')}" if !self.library_path.empty?
+		args << " -external-library-path=#{cf external_library_path.join(',')}" if !self.external_library_path.empty?
+		args << " -include-libraries=#{cf include_libraries.join(',')}" if !self.include_libraries.empty?
+
+		args << " -dump-config=#{cf dump_config}" if self.dump_config != nil
+		
+		args << " #{additional_args}" if self.additional_args != nil
+		#args << ' -include-file images\core_logo.png ..\nexuslib\code\etc\core_logo.png'
+		
+		return args
+	end
+
+	private
+
+	def hasDefaultConfigFile?
+		self.load_config.each do |path|
+			return true if isDefaultConfig? path
+		end
+		return false
+	end
+
+	def isDefaultConfig?(path)
+		return (path == FlexSDK::flex_config || path == FlexSDK::air_config)
+	end
+
+end
+end