asrake 0.10.0 → 0.11.0

data/README.md

@@ -81,6 +81,22 @@ ASRake::CompcTask.new :build, args do |compc|
 end
 ```
 
+### Include ASDoc in a SWC
+
+If you are compiling with `CompcArgs` or a `CompcTask`, you can set the field `include_asdoc` to have documentation added to your swc
+
+```ruby
+desc "Build swc"
+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.include_asdoc = true
+end
+```
+
 ### Build an AIR
 
 Compile your SWF file as normal, but set the `isAIR` property to true
@@ -142,24 +158,6 @@ namespace :version do
 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
-```
-
 Additional Functionality
 ------------------------
 

data/lib/asrake/asdoc.rb

@@ -6,25 +6,19 @@ require 'nokogiri'
 module ASRake
 class Asdoc
 
-	attr_accessor :output
+	attr_accessor :additional_args
 
+	# we have some special handling of this
 	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 = [
+		[:source_path, :dirs],
+		[:load_config, :dirs],
+		[:library_path, :dirs],
+		[:namespace, :string],
+		#
+		# The output directory for the generated documentation. The default value is "asdoc-output".
+		#
 		[:output, :dir],
 		#
 		# When true, retain the intermediate XML files created by the ASDoc tool. The default value is false. 
@@ -45,11 +39,73 @@ class Asdoc
 		# All errors are written to the validation_errors.log file. 
 		#
 		[:lenient, :bool],
-		[:source_path, :array],
-		[:load_config, :array],
-		[:library_path, :array],
+		#
+		# 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. 
+		#
+		[:templates_path, :dir],
+		#
+		# A list of classes to document. These classes must be in the source path. This is the default option.
+		# This option works the same way as does the -include-classes option for the compc component compiler.
+		#
 		[:doc_classes, :array],
+		# 
+		# A list of classes not documented. You must specify individual class names.
+		# Alternatively, if the ASDoc comment for the class contains the @private tag, is not documented. 
+		#
+		[:exclude_classes, :array],
+		#
+		# A list of URIs to document. The classes must be in the source path.
+		# You must include a URI and the location of the manifest file that defines the contents of this namespace.
+		# This option works the same way as does the -include-namespaces option for the compc component compiler.
+		#
 		[:doc_namespaces, :array],
+		#
+		# Specifies the location of the include examples used by the @includeExample tag. This option specifies the
+		# root directory. The examples must be located under this directory in subdirectories that correspond to the
+		# package name of the class. For example, you specify the examples-path as c:\myExamples. For a class in the
+		# package myComp.myClass, the example must be in the directory c:\myExamples\myComp.myClass.
+		#
+		[:examples_path, :dir],
+		#
+		# The text that appears at the bottom of the HTML pages in the output documentation.
+		#
+		[:footer, :string],
+		#
+		# The text that appears in the browser window in the output documentation.
+		# The default value is "API Documentation".
+		#
+		[:window_title, :string],
+		#
+		# An integer that changes the width of the left frameset of the documentation. You can change this
+		# size to accommodate the length of your package names.
+		# The default value is 210 pixels.
+		#
+		[:left_frameset_width, :string],
+		#
+		# The text that appears at the top of the HTML pages in the output documentation.
+		# The default value is "API Documentation".
+		#
+		[:main_title, :string],
+		#
+		# The descriptions to use when describing a package in the documentation.
+		# You can specify more than one package option.
+		# The following example adds two package descriptions to the output:
+		# asdoc = ASRake::Asdoc.new
+		# asdoc.package << 'com.my.business "Contains business classes and interfaces"'
+		# asdoc.package << 'com.my.commands "Contains command base classes and interfaces"'
+		[:package, :array],
+		#
+		# Specifies an XML file containing the package descriptions. 
+		#
+		[:package_description_file, :dir],
+		#
+		# Disable strict compilation mode. By default, classes that do not define constructors, or contain methods
+		# that do not define return values cause compiler failures. If necessary, set strict to false to override
+		# this default and continue compilation.
+		#
+		[:strict, :bool]
 	]
 
 	@@compiler_args.each do |name, type|
@@ -57,19 +113,25 @@ class Asdoc
 	end
 
 	def initialize
-
 		# set all defaults
 		@@compiler_args.each do |name, type|
-			instance_variable_set("@#{name}", []) if type == :array
+			instance_variable_set("@#{name}", []) if type == :array || type == :dirs
 		end
 
 		@doc_sources = []
 
 		yield self if block_given?
-		
 	end
 
-	def execute
+	def add(args)
+		self.source_path << args.source_path
+		self.library_path << args.library_path
+		self.library_path << args.include_libraries
+		self.library_path << args.external_library_path
+		args.source_path.each { |p| self.doc_classes << ASRake::get_classes(p) } if args.kind_of? ASRake::CompcArguments_Module
+	end
+
+	def execute(&block)
 		command = "#{FlexSDK::asdoc}"
 
 		@@compiler_args.each do |name, type|
@@ -78,12 +140,19 @@ class Asdoc
 			case type
 			when :bool
 				command << " -#{arg}=#{value}" if value
-			when :array
+			when :dirs
 				value.flatten!
-				value = value.map{|s| s.index(' ') != nil ? "'#{s}'" : s} if value.length > 1
+				value.uniq!
+				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
+			when :array
+				value.flatten!
+				value.uniq!
+				command << " -#{arg} #{value.join(' ')}" if !value.empty?
+			when :string
+				command << " -#{arg} #{value}" if value != nil
 			else
 				fail "unknown type #{type}"
 			end
@@ -99,7 +168,8 @@ class Asdoc
 
 		command << " #{additional_args}" if self.additional_args != nil
 		
-		run command
+		puts if !block_given?
+		run(command, true, &block)
 	end
 
 end

data/lib/asrake/base_compiler_args.rb

@@ -115,7 +115,7 @@ module BaseCompilerArguments_Module
 	end
 
 	def to_s
-		generate_args
+		@output
 	end
 
 	#
@@ -198,8 +198,11 @@ module BaseCompilerArguments_Module
 
 	def build(tips=true)
 		fail "Compiler not defined in #{self}" if compiler == nil
+		puts
 		if tips
+			puts "> #{compiler}#{generate_args}"
 			run "#{compiler}#{generate_args}" do |line|
+				puts ">    #{line}"
 				generate_error_message_tips(line)
 			end
 		else

data/lib/asrake/compc_args.rb

@@ -23,6 +23,11 @@ module CompcArguments_Module
 		return compc
 	end
 
+	def merge_in(args)
+		super
+		self.include_asdoc = args.include_asdoc
+	end
+
 end
 
 class CompcArguments

data/lib/asrake/compc_task.rb

@@ -48,30 +48,29 @@ class CompcTask < BaseCompilerTask
 		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.output = "#{self.output_dir}/.asrake_temp/"
+				asdoc.add(self)
 				asdoc.keep_xml = true
 				asdoc.skip_xsl = true
 				asdoc.lenient = true
-				asdoc.exclude_dependencies = true
-				asdoc.execute
+				asdoc.execute { |line| }
 
 				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|
+						# remove any existing docs (eg, from -include-libraries linking a swc with asdoc)
+						begin
+							zipfile.remove('docs')
+						rescue
+						end
 						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
+				rm_rf asdoc.output, :verbose => false
 			end
 		end
 

data/lib/asrake/host.rb

@@ -16,10 +16,10 @@ end
 def run(command, abort_on_failure = true)
 	command.strip!
 
-	puts "> #{command}"
+	puts "> #{command}" if !block_given?
 	IO.popen("#{command} 2>&1") do |proc|
 		while !proc.closed? && (line = proc.gets)
-			puts ">    #{line}"
+			puts ">    #{line}" if !block_given?
 			yield line if block_given?
 		end
 	end

data/lib/asrake/version_task.rb

@@ -45,8 +45,13 @@ class VersionTask < Rake::TaskLib
 					puts "Incremented version from #{@version} to #{save(@version.bump!(:revision))}"
 				when ''
 					puts "Current version is #{@version}"
+					puts "Version number format is Major.Minor.Revision (aka Major.Minor.Patch)"
+					puts "To increment the version, provide the respective part as an argument."
+					puts "rake #{@version_task}[major]    => #{@version.bump(:major)}"
+					puts "rake #{@version_task}[minor]    => #{@version.bump(:minor)}"
+					puts "rake #{@version_task}[revision] => #{@version.bump(:revision)}"
 				else
-					fail "Invalid version argument '#{args[:part]}', run 'rake #{@help_task}' for help."
+					fail "Invalid version argument '#{args[:part]}', run 'rake #{@version_task}' for help."
 			end
 			@sync_task.execute()
 		end
@@ -60,17 +65,7 @@ class VersionTask < Rake::TaskLib
 
 			#add to this task to perform some operation post-bump
 			@sync_task = task :sync
-			
-			desc "Display help for version task"
-			@help_task = task :help do
-				puts "Version number format is Major.Minor.Revision (aka Major.Minor.Patch)"
-				puts "To display the current version, run without arguments"
-				puts "rake #{@version_task} => #{@version}"
-				puts "To increment the version, provide the respective part as an argument."
-				puts "rake #{@version_task}[major]    => #{@version.bump(:major)}"
-				puts "rake #{@version_task}[minor]    => #{@version.bump(:minor)}"
-				puts "rake #{@version_task}[revision] => #{@version.bump(:revision)}"
-			end
+
 		end
 
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asrake
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-18 00:00:00.000000000 Z
+date: 2012-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -73,7 +73,6 @@ files:
 - lib/asrake/asdoc.rb
 - lib/asrake/base_compiler_args.rb
 - lib/asrake/base_compiler_task.rb
-- lib/asrake/clean_task.rb
 - lib/asrake/compc_args.rb
 - lib/asrake/compc_task.rb
 - lib/asrake/file_utils.rb

data/lib/asrake/clean_task.rb

@@ -1,34 +0,0 @@
-require 'rake/tasklib'
-
-module ASRake
-class CleanTask < Rake::TaskLib
-
-	attr_accessor :clean_list
-	attr_accessor :clobber_list
-
-	def initialize(*args)
-
-		self.clean_list = FileList.new
-		self.clobber_list = FileList.new
-
-		args.each do |configArgs|
-			clean_list.include(File.join(configArgs.output_dir, "*"))
-			clean_list.exclude(configArgs.output)
-
-			clobber_list.include(File.join(configArgs.output_dir, "*"))
-		end
-
-		desc "Remove package results & build artifacts"
-		task :clean do
-			clean_list.each { |f| rm_r f rescue nil }
-		end
-
-		desc "Remove all build & package results"
-		# adding clean as a dependency in case anything is added to the clean task later
-		task :clobber => [:clean] do
-			clobber_list.each { |f| rm_r f rescue nil }
-		end
-	end
-
-end
-end