asrake 0.9.0 → 0.10.0

data/README.md

@@ -25,8 +25,8 @@ 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
-----------
+How to Tasks
+------------
 
 ### Build a SWF or SWC
 
@@ -47,11 +47,11 @@ ASRake::CompcTask.new :build do |build|
 # 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"
-   build.debug = true
-   build.source_path << "bin/src"
-   build.statically_link_only_referenced_classes << "lib/lib_used_in_project.swc"
+	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
 ```
 
@@ -76,8 +76,8 @@ 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"
+	compc.debug = true
+	compc.statically_link_only_referenced_classes << "lib/lib_used_in_project.swc"
 end
 ```
 
@@ -136,9 +136,9 @@ There is a task `version:sync` that is run every time the version changes. This
 ```ruby
 # replace :version with whatever you provided to ASRake::VersionTask.new 
 namespace :version do
-   task :sync do
-      #update application.xml
-   end
+	task :sync do
+		#update application.xml
+	end
 end
 ```
 
@@ -160,6 +160,9 @@ end
 ASRake::CleanTask.new swf
 ```
 
+Additional Functionality
+------------------------
+
 ### New copy method
 
 ASRake introduces a new copy method `cp_u` on FileUtils and in the global namespace.
@@ -178,4 +181,27 @@ 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"
+```
+
+### Build without a task
+
+You don't need to create a rake task to build a swf or swc. Just call `build()` on an instance of CompcArguments or MxmlcArguments.
+
+> Note that this will not do any dependency checks, so the build will run even if it is unnecessary
+
+```ruby
+args = ASRake::CompcArguments.new
+args.target_player = 11.0
+args.output = "bin/bin/my_project.swc"
+args.source_path << "bin/src"
+args.statically_link_only_referenced_classes << "lib/lib_used_in_project.swc"
+args.build()
+
+ASRake::MxmlcArguments.new do |mxmlc|
+	mxmlc.target_player = 11.0
+	mxmlc.output = "bin/bin/my_project.swf"
+	mxmlc.debug = true
+	mxmlc.source_path << "bin/src"
+	mxmlc.build()
+end
 ```

data/lib/asrake/asdoc.rb

@@ -0,0 +1,106 @@
+require 'rake/tasklib'
+require 'nokogiri'
+
+# http://help.adobe.com/en_US/flex/using/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-7ffa.html
+
+module ASRake
+class Asdoc
+
+	attr_accessor :output
+
+	attr_accessor :doc_sources
+	attr_accessor :doc_classes
+	attr_accessor :doc_namespaces
+	attr_accessor :source_path
+	attr_accessor :library_path
+
+	attr_accessor :load_config
+	#
+	# The path to the ASDoc template directory. The default is the asdoc/templates directory in the ASDoc
+	# installation directory. This directory contains all the HTML, CSS, XSL, and image files used for
+	# generating the output. 
+	#
+	attr_accessor :templates_path
+
+	attr_accessor :additional_args
+
+	@@compiler_args = [
+		[:output, :dir],
+		#
+		# When true, retain the intermediate XML files created by the ASDoc tool. The default value is false. 
+		#
+		[:keep_xml, :bool],
+		#
+		# When true, configures the ASDoc tool to generate the intermediate XML files only, and not perform
+		# the final conversion to HTML. The default value is false. 
+		#
+		[:skip_xsl, :bool],
+		#
+		# Whether all dependencies found by the compiler are documented. If true, the dependencies of
+		# the input classes are not documented. The default value is false.
+		#
+		[:exclude_dependencies, :bool],
+		#
+		# Ignore XHTML errors (such as a missing </p> tag) and produce the ASDoc output.
+		# All errors are written to the validation_errors.log file. 
+		#
+		[:lenient, :bool],
+		[:source_path, :array],
+		[:load_config, :array],
+		[:library_path, :array],
+		[:doc_classes, :array],
+		[:doc_namespaces, :array],
+	]
+
+	@@compiler_args.each do |name, type|
+		attr_accessor name
+	end
+
+	def initialize
+
+		# set all defaults
+		@@compiler_args.each do |name, type|
+			instance_variable_set("@#{name}", []) if type == :array
+		end
+
+		@doc_sources = []
+
+		yield self if block_given?
+		
+	end
+
+	def execute
+		command = "#{FlexSDK::asdoc}"
+
+		@@compiler_args.each do |name, type|
+			arg = name.to_s.gsub('_','-')
+			value = instance_variable_get("@#{name}")
+			case type
+			when :bool
+				command << " -#{arg}=#{value}" if value
+			when :array
+				value.flatten!
+				value = value.map{|s| s.index(' ') != nil ? "'#{s}'" : s} if value.length > 1
+				command << " -#{arg} #{cf value.join(' ')}" if !value.empty?
+			when :dir
+				command << " -#{arg}=#{cf value}" if value != nil
+			else
+				fail "unknown type #{type}"
+			end
+		end
+		
+		# Use doc-sources argument if it has been assigned (duh) or if neither doc-classes or doc-namespaces have
+		# been assigned and source-path has
+		if !self.doc_sources.empty?
+			command << " -doc-sources #{cf doc_sources.join(' ')}"
+		elsif !self.source_path.empty? && self.doc_classes.empty? && self.doc_namespaces.empty?
+			command << " -doc-sources #{cf source_path.join(' ')}" if !self.source_path.empty?
+		end
+
+		command << " #{additional_args}" if self.additional_args != nil
+		
+		run command
+	end
+
+end
+end

data/lib/asrake/base_compiler_args.rb

@@ -256,6 +256,7 @@ end
 #end
 
 #http://fpdownload.macromedia.com/get/flashplayer/updaters/11/playerglobal11_2.swc
+#https://github.com/nexussays/playerglobal/raw/master/player/11.2/playerglobal.swc
 #frameworks\libs\player
 
 #-dump-config compiler_config.xml

data/lib/asrake/compc_args.rb

@@ -6,6 +6,8 @@ module ASRake
 module CompcArguments_Module
 	include BaseCompilerArguments_Module
 
+	attr_accessor :include_asdoc
+	
 	def compiler
 		FlexSDK::compc
 	end
@@ -15,24 +17,12 @@ module CompcArguments_Module
 		
 		#compc << " -include-sources=#{cf source_path.join(',')}" if !source_path.empty?
 		self.source_path.each do |path|
-			compc << " -include-classes #{get_classes(path).join(' ')}"
+			compc << " -include-classes #{ASRake::get_classes(path).join(' ')}"
 		end
 
 		return compc
 	end
 
-	def get_classes(path)
-		arr = []
-		Dir.chdir(path) do
-			FileList["**/*.as"].pathmap('%X').each do |file|
-				name = file.gsub(/^\.[\/\\]/, "").gsub(/[\/\\]/, ".")
-				yield name if block_given?
-				arr << name
-			end
-		end
-		return arr
-	end
-
 end
 
 class CompcArguments

data/lib/asrake/compc_task.rb

@@ -3,6 +3,7 @@ require 'rake/tasklib'
 require 'asrake/host'
 require 'asrake/base_compiler_task'
 require 'asrake/compc_args'
+require 'asrake/asdoc'
 
 module ASRake
 class CompcTask < BaseCompilerTask
@@ -13,10 +14,13 @@ class CompcTask < BaseCompilerTask
 		super
 
 		# create directory task for output
-		directory self.output_dir
-
+		if !output_is_dir?
+			directory self.output_dir
+			file self.output => self.output_dir
+		end
+		
 		# create file task for output
-		file self.output => self.output_dir do
+		file self.output do
 			self.build
 		end
 
@@ -41,6 +45,36 @@ class CompcTask < BaseCompilerTask
 			puts result
 		end
 
+		if @include_asdoc
+			file self.output do
+				asdoc = ASRake::Asdoc.new
+				asdoc.output = "#{self.output_dir}/.asrake/"
+				asdoc.source_path = self.source_path
+				asdoc.library_path = self.library_path
+				asdoc.load_config = self.load_config
+				self.source_path.each do |path|
+					asdoc.doc_classes << ASRake::get_classes(path)
+				end
+				asdoc.keep_xml = true
+				asdoc.skip_xsl = true
+				asdoc.lenient = true
+				asdoc.exclude_dependencies = true
+				asdoc.execute
+
+				if output_is_dir?
+					cp_r File.join(asdoc.output, 'tempdita'), File.join(self.output_dir, 'docs')
+				else
+					Zip::ZipFile.open(self.output) do |zipfile|
+						FileList[File.join(asdoc.output, 'tempdita', '*')].each do |file|
+							zipfile.add(File.join('docs', File.basename(file)), file)
+						end
+					end
+				end
+
+				rm_rf asdoc.output
+			end
+		end
+
 	end
 
 end

data/lib/asrake.rb

@@ -24,4 +24,22 @@ THE SOFTWARE.
 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 }
 
-require 'asrake/file_utils'
+require 'asrake/file_utils'
+
+module ASRake
+class << self
+
+def get_classes(path)
+	arr = []
+	Dir.chdir(path) do
+		FileList["**/*.as"].pathmap('%X').each do |file|
+			name = file.gsub(/^\.[\/\\]/, "").gsub(/[\/\\]/, ".")
+			yield name if block_given?
+			arr << name
+		end
+	end
+	return arr
+end
+
+end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asrake
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-05 00:00:00.000000000 Z
+date: 2012-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -70,6 +70,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/asrake/adt_task.rb
+- lib/asrake/asdoc.rb
 - lib/asrake/base_compiler_args.rb
 - lib/asrake/base_compiler_task.rb
 - lib/asrake/clean_task.rb