albacore 0.0.7

data/EULA.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Derick Bailey. All Rights Reserved.
+
+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.markdown

@@ -0,0 +1,70 @@
+# Welcome to the Albacore project.
+
+Albacore is intended to be a professional quality suite of Rake tasks to help automate the process of building a .NET based system. All tasks are built using a test-first approach through rspec, and all tests are included in the Albacore gem.
+
+## How To Install Albacore From Gemcutter Gems:
+
+If you would like to install the current, stable release of Albacore, you can do so easily through the Gemcutter gem server. Follow these simple instructions and you will be good to go.
+
+**Step 1:** Setup Gemcutter as a gem source
+
+> gem source -a http://gemcutter.org
+
+(note: you only need to do this once for any given computer that is going to install gems from gemcutter.)
+
+**Step 2:** Install the Albacore gem
+
+> gem install Albacore
+
+## How To Manually Build And Install The Albacore Gem
+
+If you would like to install the latest source code for Albacore, and get all the new features and functionality (possibly in an unstable form), you can manually build and install the Albacore gem. Follow these simple instructions and you will be good to go.
+
+**Step 1:** Clone Albacore
+
+Use your Github account to fork Albacore, or clone it directly from my public clone URL.
+
+> git clone git://github.com/derickbailey/Albacore.git Albacore
+
+**Step 2:** Build the gem
+
+In your local clone of Albacore, use the jeweler rake tasks to build the latest version of the Albacore code into a gem.
+
+> rake jeweler:gemspec
+>
+> rake jeweler:build
+
+this will produce an 'Albacore-#.#.#.gem' file in the 'pkg' folder, where '#.#.#' is the version number. For example 'Albacore-0.0.1.gem'.
+
+**Step 3:** Install the gem
+
+After building the gem, you can install it from your local file system.
+
+> gem install -l pkg\Albacore-#.#.#.gem
+
+where '#.#.#' is the version number of the gem. For example 'Albacore-0.0.1.gem'
+
+## How To Use Albacore
+
+After installing Albacore, you only need to
+
+    require 'albacore'
+
+in your rakefile. This will allow you to use the tasks that Albacore includes. 
+
+    desc "Run a sample build using the MSBuildTask"
+    Albacore::MSBuildTask.new(:msbuild) do |msb|
+        msb.properties :configuration => :Debug
+        msb.targets [:Clean, :Build]
+        msb.solution = "spec/support/TestSolution/TestSolution.sln"
+    end
+
+Beyond the simple example, check out the [Albacore Wiki](http://wiki.github.com/derickbailey/Albacore) for detailed instructions on how to use the built in tasks and their options.
+
+## Contributors
+
+Many thanks for contributions to Albacore are due:
+
+* [Ben Hall](http://github.com/benhall): SSH, SFTP, ZipDirectory, Rename, YAML auto config, and other great additions
+* [Sean Biefeld](http://github.com/seanbiefeld): MSpecTestRunner for NCoverConsole
+* [Kevin Colyar](http://github.com/kevincolyar): Testing and updating of MSBuild to work with Cygwin

data/VERSION

@@ -0,0 +1 @@
+0.0.7

data/lib/albacore.rb

@@ -0,0 +1,9 @@
+$: << File.expand_path(File.dirname(__FILE__))
+$: << File.expand_path(File.join(File.dirname(__FILE__), "albacore"))
+$: << File.expand_path(File.join(File.dirname(__FILE__), "albacore", 'support'))
+$: << File.expand_path(File.join(File.dirname(__FILE__), "rake"))
+
+require 'logging'
+
+Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), 'rake/*.rb')).each {|f| require f }
+Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), 'albacore/*.rb')).each {|f| require f }

data/lib/albacore/assemblyinfo.rb

@@ -0,0 +1,104 @@
+require 'albacore/support/albacore_helper'
+
+class AssemblyInfo
+	include Failure
+	include YAMLConfig
+	
+	attr_accessor :version, :title, :description, :output_file, :custom_attributes
+	attr_accessor :copyright, :com_visible, :com_guid, :company_name, :product_name
+	attr_accessor :file_version, :trademark, :namespaces
+	
+	def initialize
+		super()
+		@namespaces = []
+	end
+	
+	def write
+		write_assemblyinfo @output_file
+	end
+	
+	def write_assemblyinfo(assemblyinfo_file)
+		valid = check_output_file assemblyinfo_file
+		return if !valid
+		
+		asm_data = build_assembly_info_data
+
+		@logger.info "Generating Assembly Info File At: " + File.expand_path(assemblyinfo_file)
+		File.open(assemblyinfo_file, 'w') do |f|			
+			f.write asm_data
+		end
+	end
+	
+	def check_output_file(file)
+		return true if file
+		fail_with_message 'output_file cannot be nil'
+		return false
+	end
+	
+	def build_assembly_info_data
+		asm_data = build_using_statements + "\n"
+		
+		asm_data << build_attribute("AssemblyTitle", @title) if @title != nil
+		asm_data << build_attribute("AssemblyDescription", @description) if @description != nil
+		asm_data << build_attribute("AssemblyCompany", @company_name) if @company_name != nil
+		asm_data << build_attribute("AssemblyProduct", @product_name) if @product_name != nil
+		
+		asm_data << build_attribute("AssemblyCopyright", @copyright) if @copyright != nil
+		asm_data << build_attribute("AssemblyTrademark", @trademark) if @trademark != nil
+		
+		asm_data << build_attribute("ComVisible", @com_visible) if @com_visible != nil
+		asm_data << build_attribute("Guid", @com_guid) if @com_guid != nil
+		
+		asm_data << build_attribute("AssemblyVersion", @version) if @version != nil
+		asm_data << build_attribute("AssemblyFileVersion", @file_version) if @file_version != nil
+		
+		asm_data << "\n"
+		if @custom_attributes != nil
+			attributes = build_custom_attributes()
+			asm_data << attributes.join
+			asm_data << "\n"
+		end
+		
+		asm_data
+	end
+	
+	def custom_attributes(attributes)
+		@custom_attributes = attributes
+	end
+	
+	def namespaces(namespaces)
+		@namespaces = namespaces
+	end
+	
+	def build_using_statements
+		@namespaces = [] if @namespaces.nil?
+		
+		@namespaces << "System.Reflection"
+		@namespaces << "System.Runtime.InteropServices"
+		
+		namespaces = ''
+		@namespaces.each do |ns|
+			namespaces << "using #{ns};\n"
+		end
+		
+		namespaces
+	end	
+	
+	def build_attribute(attr_name, attr_data)
+		attribute = "[assembly: #{attr_name}("
+		attribute << "#{attr_data.inspect}" if attr_data != nil
+		attribute << ")]\n"
+		
+		@logger.debug "Build Assembly Info Attribute: " + attribute
+		attribute
+	end
+	
+	def build_custom_attributes()
+		attributes = []
+		@custom_attributes.each do |key, value|
+			attributes << build_attribute(key, value)
+		end
+		attributes
+	end
+	
+end

data/lib/albacore/expandtemplates.rb

@@ -0,0 +1,64 @@
+require 'albacore/support/albacore_helper'
+require 'yaml'
+
+class ExpandTemplates
+	include YAMLConfig
+	include Logging
+	
+	attr_accessor :expand_files, :data_file
+	
+	def initialize
+		super()
+		@expand_files = []
+	end
+	
+	def expand
+		return if @data_file.nil?
+		return if @expand_files.empty?
+		
+		config = read_config
+		@expand_files.each { |template_file, output_file| 
+			file_config = get_config_for_file config, template_file
+			expand_template template_file, output_file, file_config
+		}
+	end
+	
+private
+
+	def expand_template(template_file, output_file, config)
+		@logger.info "Parsing #{template_file} into #{output_file}"
+				
+		template_data = ''
+		File.open(template_file, "r") {|f| 
+			template_data = f.read 
+		}
+		template_data
+
+		template_data.gsub!(/\#\{(.*?)\}/) {|match|
+			value = config[$1]
+			@logger.debug "Found \"\#{#{$1}}\": Replacing with \"#{value}\"."
+			value
+		}
+		
+		File.open(output_file, "w") {|output|
+	    	output.write(template_data)
+		}
+	end
+	
+	def read_config
+		YAML::load(File.open(@data_file, "r"))
+	end
+	
+	def get_config_for_file(original_config, file)
+		filename = File.basename(file)
+		file_config = original_config[filename]
+		if file_config.nil?
+			@logger.debug "No config data found for #{filename}. Using global data."
+			new_config = original_config
+		else
+			@logger.debug "Found config data for #{filename}."
+			new_config = original_config.merge(file_config)
+		end
+		new_config
+	end
+end

data/lib/albacore/msbuild.rb

@@ -0,0 +1,63 @@
+require 'albacore/support/albacore_helper'
+
+class MSBuild
+	include RunCommand
+	include YAMLConfig
+	
+	attr_accessor :solution, :verbosity
+	
+	def initialize
+		super()
+		@path_to_command = build_path_to_command
+	end
+	
+	def build_path_to_command
+		win_dir = ENV['windir'] || ENV['WINDIR']
+		File.join(win_dir.dup, 'Microsoft.NET', 'Framework', 'v3.5', 'MSBuild.exe')
+	end
+	
+	def targets(targets)
+		@targets=targets
+	end
+	
+	def properties=(properties)
+		@properties = properties
+	end
+	
+	def build
+		build_solution(@solution)
+	end
+	
+	def build_solution(solution)
+		check_solution solution
+		
+		command_parameters = []
+		command_parameters << "\"#{solution}\""
+		command_parameters << "\"/verbosity:#{@verbosity}\"" if @verbosity != nil
+		command_parameters << build_properties if @properties != nil
+		command_parameters << "\"/target:#{build_targets}\"" if @targets != nil
+		
+		result = run_command "MSBuild", command_parameters.join(" ")
+		
+		failure_message = 'MSBuild Failed. See Build Log For Detail'
+		fail_with_message failure_message if !result
+	end
+	
+	def check_solution(file)
+		return if file
+		msg = 'solution cannot be nil'
+		fail_with_message msg
+	end
+	
+	def build_targets
+		@targets.join ";"
+	end
+
+	def build_properties
+		option_text = []
+		@properties.each do |key, value|
+			option_text << "/p:#{key}\=\"#{value}\""
+		end
+		option_text.join(" ")
+	end
+end

data/lib/albacore/mspectestrunner.rb

@@ -0,0 +1,33 @@
+require 'albacore/support/albacore_helper'
+
+class MSpecTestRunner
+	include Logging
+	include YAMLConfig
+	
+	attr_accessor :assemblies, :path_to_command, :html_output
+	
+	def initialize(path_to_command)
+		super()
+		@path_to_command = path_to_command
+		@assemblies=[]
+	end
+	
+	def get_command_line
+		command = []
+		command << @path_to_command
+		command << build_assembly_list unless @assemblies.empty?
+		command << build_html_output unless @html_output.nil?
+		
+		cmdline = command.join(" ")
+		@logger.debug "Build MSpec Test Runner Command Line: " + cmdline
+		cmdline
+	end
+	
+	def build_assembly_list
+		@assemblies.map{|asm| "\"#{asm}\""}.join(" ") 
+	end
+	
+	def build_html_output
+		"--html #{@html_output}"
+	end
+end

data/lib/albacore/ncoverconsole.rb

@@ -0,0 +1,64 @@
+require 'albacore/support/albacore_helper'
+
+class NCoverConsole
+	include RunCommand
+	include YAMLConfig
+	
+	attr_accessor :output, :testrunner, :working_directory, :cover_assemblies
+	attr_accessor :ignore_assemblies, :coverage
+	
+	def initialize
+		super()
+		@output = {}
+		@testrunner_args = []
+		@cover_assemblies = []
+		@ignore_assemblies = []
+		@coverage = []
+	end
+	
+	def working_directory=(working_dir)
+		@working_directory = "//working-directory " + working_dir
+	end
+	
+	def run
+		check_testrunner
+		return false if @failed
+		
+		command_parameters = []
+		command_parameters << build_output_options(@output) unless @output.nil?
+		command_parameters << @working_directory unless @working_directory.nil?
+		command_parameters << build_assembly_list("assemblies", @cover_assemblies) unless @cover_assemblies.empty?
+		command_parameters << build_assembly_list("exclude-assemblies", @ignore_assemblies) unless @ignore_assemblies.empty?
+		command_parameters << build_coverage_list(@coverage) unless @coverage.empty?
+		command_parameters << @testrunner.get_command_line
+		
+		result = run_command "NCover.Console", command_parameters.join(" ")
+		
+		failure_msg = 'Code Coverage Analysis Failed. See Build Log For Detail.'
+		fail_with_message failure_msg if !result
+	end
+	
+	def check_testrunner
+		return if (!@testrunner.nil?)
+		msg = 'testrunner cannot be nil.'
+		@logger.info msg
+		fail
+	end
+	
+	def build_output_options(output)
+		options = []
+		output.each do |key, value|
+			options << "//#{key} #{value}"
+		end
+		options.join(" ")
+	end
+	
+	def build_assembly_list(param_name, list)
+		assembly_list = list.map{|asm| "\"#{asm}\""}.join(';')
+		"//#{param_name} #{assembly_list}"
+	end
+	
+	def build_coverage_list(coverage)
+		"//coverage-type \"#{coverage.join(', ')}\""
+	end
+end

data/lib/albacore/ncoverreport.rb

@@ -0,0 +1,61 @@
+Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), 'ncoverreports/*.rb')).each {|f| require f }
+require 'albacore/support/albacore_helper'
+
+class NCoverReport
+	include RunCommand
+	include YAMLConfig
+	
+	attr_accessor :coverage_files, :reports, :required_coverage, :filters
+	
+	def initialize
+		super()
+		@coverage_files = []
+		@reports = []
+		@required_coverage = []
+		@filters = []
+	end
+	
+	def run
+		check_command
+		return if @failed
+		
+		command_parameters = []
+		command_parameters << build_coverage_files unless @coverage_files.empty?
+		command_parameters << build_reports unless @reports.empty?
+		command_parameters << build_required_coverage unless @required_coverage.empty?
+		command_parameters << build_filters unless @filters.empty?
+		
+		result = run_command "NCover.Reporting", command_parameters.join(" ")
+		
+		failure_msg = 'Code Coverage Reporting Failed. See Build Log For Detail.'
+		fail_with_message failure_msg if !result
+	end
+	
+	def check_command
+		return if @path_to_command
+		fail_with_message 'NCoverReport.path_to_command cannot be nil.'
+	end
+	
+	def build_filters
+		@filters.map{|f| "//cf #{f.get_filter_options}"}.join(" ")
+	end
+	
+	def build_coverage_files
+		@coverage_files.map{|f| "\"#{f}\""}.join(" ")
+	end
+	
+	def build_reports
+		@reports.map{|r|
+			report = "//or #{r.report_type}"
+			report << ":#{r.report_format}" unless r.report_format.nil?
+			report << ":\"#{r.output_path}\"" unless r.output_path.nil?
+			report
+		}.join(" ")
+	end
+
+	def build_required_coverage
+		@required_coverage.map{|c|
+			coverage = "//mc #{c.get_coverage_options}"
+		}.join(" ")
+	end
+end