asrake 0.14.0 → 0.14.1

data/README.md

@@ -2,23 +2,14 @@
 
 **Quickly and easily create build scripts for Actionscript 3, Flex, and AIR projects.**
 
-
 ## Installation
 
 ### `gem install asrake`
 
-Or add this line to your application's Gemfile:
-
-    gem 'asrake'
-
-And then execute:
-
-    $ bundle
-
-
 ## Usage
 
-Add the path(s) to your Flex SDK for all systems that will need to run the Rake tasks.
+Add the path(s) to your Flex SDK for all systems that will need to run the Rake tasks. The value of the environment variable `FLEX_HOME` is added to this list by default if it is defined on your system.
+
 ```ruby
 FlexSDK::SDK_PATHS << 'C:\develop\sdk\flex_sdk_4.6.0.23201'
 FlexSDK::SDK_PATHS << "C:/develop/sdk/flex_sdk 4.5.1"
@@ -36,35 +27,40 @@ Convenience methods are provided for `include_libraries`, `external_library_path
 ### Build a SWF or SWC
 
 ```
-ASRake::Mxmlc(file) |self|
+ASRake::Mxmlc.new(output)
 ```
 ```
-ASRake::Compc(file) |self|
+ASRake::Compc.new(output)
 ```
 
 Assign arguments for your build and optionally run it with a friendlier-named task:
 
 ```ruby
-args = ASRake::Compc.new "bin/bin/my_project.swc"
+args = ASRake::Compc.new "bin/my_project.swc"
 args.target_player = 11.0
 args.debug = true
-args.source_path << "bin/src"
+args.source_path << "src"
 args.statically_link_only_referenced_classes << "lib/lib_used_in_project.swc"
 
 desc "Build swc"
 task :build => args
 ```
 
-You can also define arguments in a block on creation:
+You can chain together complex builds and the dependencies will be properly handled:
 
 ```ruby
+bar = ASRake::Compc.new "lib/other_project/bin/proj.swc"
+bar.target_player = 11.0
+bar.source_path << "lib/other_project/src"
+
+foo = ASRake::Compc.new "bin/my_project.swc"
+foo.target_player = 11.0
+foo.debug = true
+foo.source_path << "src"
+foo.library_path << bar
+
 desc "Build swc"
-ASRake::Compc.new "bin/bin/my_project.swc" do |build|
-	build.target_player = 11.0
-	build.debug = true
-	build.source_path << "bin/src"
-	build.statically_link_only_referenced_classes << "lib/lib_used_in_project.swc"
-end
+task :build => foo
 ```
 
 ### Include ASDoc in a SWC
@@ -73,12 +69,10 @@ If you are compiling with `Compc`, you can set the field `include_asdoc` to have
 
 ```ruby
 desc "Build swc"
-ASRake::Compc.new "bin/bin/my_project.swc" do |build|
-	build.target_player = 11.0
-	build.source_path << "bin/src"
-	build.statically_link_only_referenced_classes << "lib/lib_used_in_project.swc"
-	build.include_asdoc = true
-end
+swc = ASRake::Compc.new "bin/bin/my_project.swc"
+swc.target_player = 11.0
+swc.source_path << "bin/src"
+swc.include_asdoc = true
 ```
 
 ### Build an AIR
@@ -87,25 +81,22 @@ Compile your SWF file as normal, but set the `isAIR` property to true
 
 ```ruby
 desc "Build app"
-ASRake::Mxmlc.new "bin/my_app.swf" do |build|
-	build.load_config << "mxmlc_config.xml"
-	build.isAIR = true
-end
+my_app = ASRake::Mxmlc.new "bin/my_app.swf"
+my_app.load_config << "mxmlc_config.xml"
+my_app.isAIR = true
 ```
 
 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 .`)
+> Be sure that the swf file is included in the package (eg, it is included here by packaging everything in the bin directory: `air.include_files << "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
+air = ASRake::Adt.new "deploy/my_app.air"
+air.keystore = "cert.p12"
+air.keystore_name = "my_app"
+air.storepass = "my_app"
+air.tsa = "none"
+air.include_files << "bin ."
 ```
 
 ### Version
@@ -159,7 +150,7 @@ 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
+# use FileList, Dir.glob(), or other methods to copy groups of files
 cp_u FileList["lib/**/*.swc"], "bin/lib"
 ```
 
@@ -170,17 +161,11 @@ You don't need to create a rake task to build a swf or swc. Just call `execute()
 > Note that this will not do any dependency checks, so the build will run even if it is unnecessary
 
 ```ruby
-args = ASRake::Compc.new "bin/bin/my_project.swc"
+args = ASRake::Compc.new "bin/my_project.swc"
 args.target_player = 11.0
-args.source_path << "bin/src"
+args.source_path << "src"
 args.statically_link_only_referenced_classes << "lib/lib_used_in_project.swc"
 args.execute()
-
-(ASRake::Mxmlc.new "bin/bin/my_project.swf" do |mxmlc|
-	mxmlc.target_player = 11.0
-	mxmlc.debug = true
-	mxmlc.source_path << "bin/src"
-end).execute()
 ```
 
 ## Contributing

data/asrake.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |spec|
 	spec.name        = 'asrake'
-	spec.version     = '0.14.0'
+	spec.version     = '0.14.1'
 	spec.platform	  = Gem::Platform::RUBY
 	
 	spec.authors     = ["Malachi Griffie"]
@@ -9,13 +9,9 @@ Gem::Specification.new do |spec|
 	spec.homepage    = 'https://github.com/nexussays/ASRake'
 	spec.license     = 'MIT'
 
-	spec.summary     = <<DESC
-A cross-platform Rake library to quickly and easily create build scripts for
-Actionscript 3, Flex, and AIR projects.
-DESC
+	spec.summary     = "A Rake library for Actionscript 3, Flex, and AIR projects."
 	spec.description = <<DESC
-A Rake library for Actionscript 3, Flex, and AIR projects.
-See full documentation at https://github.com/nexussays/ASRake/blob/master/README.md
+A Rake-based library for quickly and easily creating build scripts for Actionscript 3, Flex, and AIR projects.
 DESC
 
 	spec.files       = Dir['lib/**/*.rb'] + %w[LICENSE README.md asrake.gemspec Gemfile]

data/lib/asrake/adt.rb

@@ -51,12 +51,12 @@ class Adt < BaseExecutable
 	# define named task first so if desc was called it will be attached to it instead of the file task
 	def execute
 
-		raise "You must define 'output' for #{self}" if self.output == nil
-		raise "You must define 'application_descriptor'" if self.application_descriptor == nil || !File.exists?(self.application_descriptor)
-		raise "You must define 'keystore' for #{self}" if self.keystore == nil
-		raise "You must define 'keystore_name' for #{self}" if self.keystore_name == nil
-		raise "You must define 'storepass' for #{self}" if self.storepass == nil
-		raise "You must define 'include_files' for #{self}\neg: include_files << 'bin .'" if self.include_files.length < 1
+		#raise "You must define 'output' for #{self}" if self.output == nil
+		#raise "You must define 'application_descriptor'" if self.application_descriptor == nil || !File.exists?(self.application_descriptor)
+		#raise "You must define 'keystore' for #{self}" if self.keystore == nil
+		#raise "You must define 'keystore_name' for #{self}" if self.keystore_name == nil
+		#raise "You must define 'storepass' for #{self}" if self.storepass == nil
+		#raise "You must define 'include_files' for #{self}\neg: include_files << 'bin .'" if self.include_files.length < 1
 
 		# TODO: Somehow confirm that the initialWindow content is included in the build
 		#app_xml = Nokogiri::XML(File.read(application_descriptor))

data/lib/asrake/base_compiler.rb

@@ -105,10 +105,10 @@ class BaseCompiler < BaseExecutable
 			end
 		end
 
-		fail "You must define 'target_player' for #{self}" if self.target_player == nil && !is_target_defined
+		raise "You must define 'target_player' for #{self}" if self.target_player == nil && !is_target_defined
 
 		# 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?
+		#raise "You must add at least one path to 'source_path' for #{self}" if source_path.empty? && !configSource?
 
 		#
 		# validation complete, generate build args
@@ -167,6 +167,7 @@ class BaseCompiler < BaseExecutable
 	
 	def task_pre_invoke
 		super
+		# TODO: get dependencies from config files
 		# set dependencies on all .as and .mxml files in the source paths
 		dependencies = FileList.new
 		self.source_path.each do |path|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asrake
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-01 00:00:00.000000000 Z
+date: 2012-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -65,9 +65,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
-description: ! 'A Rake library for Actionscript 3, Flex, and AIR projects.
-
-  See full documentation at https://github.com/nexussays/ASRake/blob/master/README.md
+description: ! 'A Rake-based library for quickly and easily creating build scripts
+  for Actionscript 3, Flex, and AIR projects.
 
 '
 email:
@@ -119,7 +118,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A cross-platform Rake library to quickly and easily create build scripts
-  for Actionscript 3, Flex, and AIR projects.
+summary: A Rake library for Actionscript 3, Flex, and AIR projects.
 test_files: []
 has_rdoc: