albacore 1.0.0 → 2.0.0.rc.1

data/lib/albacore/task_types/asmver/fs.rb

@@ -0,0 +1,37 @@
+require 'albacore/task_types/asmver/engine'
+
+module Albacore::Asmver
+  class Fs < Engine
+    def initialize
+      @using       = "open"
+      @start_token = "[<"
+      @end_token   = ">]"
+      @assignment  = "="
+      @statement_terminator  = ""
+    end
+    
+    def build_attribute_re(attr_name)
+      /^\[\<assembly: #{attr_name}(.+)/
+    end
+
+    # namespaces
+
+    def namespace_start ns
+      "namespace #{ns}"
+    end
+
+    def namespace_end
+      "()\n"
+    end 
+
+    # comments
+
+    def comment_multiline_start
+      '(*'
+    end
+
+    def comment_multiline_end
+      '*)'
+    end
+  end
+end

data/lib/albacore/task_types/asmver/vb.rb

@@ -0,0 +1,27 @@
+require 'albacore/task_types/asmver/engine'
+
+module Albacore::Asmver
+  class Vb < Engine
+    def initialize
+      @using       = "Imports"
+      @start_token = "<"
+      @end_token   = ">"
+      @assignment  = ":="
+      @statement_terminator  = ""
+    end
+    
+    def build_attribute_re(attr_name)
+      /^\<assembly: #{attr_name}(.+)/i  
+    end
+
+    # override
+    def comment_singleline_token
+      '\''
+    end
+
+    # override
+    def build_multiline_comment string_data
+      string_data.split(NL).map { |s| "' " + s }.join("\n")
+    end
+  end
+end

data/lib/albacore/task_types/build.rb

@@ -0,0 +1,192 @@
+# -*- encoding: utf-8 -*-
+
+require 'rake'
+require 'albacore/paths'
+require 'albacore/cmd_config'
+require 'albacore/cross_platform_cmd'
+require 'albacore/logging'
+require 'albacore/facts'
+
+module Albacore
+  module Build
+    class Cmd
+      include CrossPlatformCmd
+      def initialize work_dir, executable, parameters
+        @work_dir = work_dir
+        @executable = executable
+        @parameters = (parameters === Array) ? parameters : parameters.to_a
+      end
+      def execute
+        system @executable, @parameters, :work_dir => @work_dir
+      end
+    end
+
+    # The configuration class for xbuild and msbuild. MSDN docs at: http://msdn.microsoft.com/en-us/library/vstudio/ms164311.aspx
+    class Config
+      include CmdConfig
+      self.extend ConfigDSL
+      include Logging
+
+      # TODO: move towards #opts() for all task types rather than
+      # reading these public properties.
+
+      # this is the target of the compilation with MsBuild/XBuild
+      attr_reader :target
+
+      # any properties you want to set
+      attr_accessor :properties
+
+      def initialize
+        @parameters = Set.new
+
+        w = lambda { |e| CrossPlatformCmd.which(e) ? e : nil }
+
+        @exe = w.call( "msbuild" ) ||
+               w.call( "xbuild" )  ||
+               heuristic_executable
+
+        debug { "build using '#{@exe}'" }
+        set_logging 'minimal'
+      end
+
+      # this is the solution file to build (or the project files themselves)
+      attr_path_accessor :sln, :file do |val|
+        @parameters.add val
+      end
+
+      # Call for each target that you want to add, or pass an array or
+      # strings. Only unique targets will be passed to MsBuild.
+      #
+      # From MSDN:
+      #
+      # "Build the specified targets in the project. Specify each target separately, or use a semicolon or comma to separate multiple targets, as the following example shows:
+      # /target:Resources;Compile
+      # If you specify any targets by using this switch, they are run instead of any targets in the DefaultTargets attribute in the project file. For more information, see Target Build Order (http://msdn.microsoft.com/en-us/library/vstudio/ee216359.aspx) and How to: Specify Which Target to Build First (http://msdn.microsoft.com/en-us/library/vstudio/ms171463.aspx).
+      # A target is a group of tasks. For more information, see MSBuild Targets (http://msdn.microsoft.com/en-us/library/vstudio/ms171462.aspx)."
+      #
+      # t  :: the array or string target to add to the list of tarets to build
+      attr_path_accessor :target do |t|
+        update_array_prop "target", method(:make_target), :targets, t
+      end
+
+      # Allows you to add properties to MsBuild; example:
+      #
+      # b.prop 'WarningLevel', 2
+      # b.prop 'BuildVersion', '3.5.0'
+      #
+      # From MSDN:
+      #
+      # "Set or override the specified project-level properties, where name is the property name and value is the property value. Specify each property separately, or use a semicolon or comma to separate multiple properties, as the following example shows:
+      # /property:WarningLevel=2;OutputDir=bin\Debug"
+      #
+      # The properties will be automatically converted to the correct syntax
+      def prop k, v
+        @properties ||= Hash.new
+        @parameters.delete "/property:#{make_props}" if @properties.any?
+        @properties[k] = v
+        @parameters.add "/property:#{make_props}"
+      end
+
+      # Specifies the amount of information to display in the build log. 
+      # Each logger displays events based on the verbosity level that you set for that logger.
+      # You can specify the following verbosity levels: q[uiet], m[inimal], 
+      # n[ormal], d[etailed], and diag[nostic]. 
+      attr_path_accessor :logging do |mode|
+        set_logging mode
+      end
+
+      # Specifies the number of parallel worker processes to build with
+      # Defaults to the number of logical cores
+      attr_path_accessor :cores do |num|
+        @parameters.add "/maxcpucount:#{num}"
+      end
+
+      # Pass the parameters that you specify to the console logger, which displays build information in the console window. You can specify the following parameters:
+      # * PerformanceSummary. Show the time that’s spent in tasks, targets, and projects.
+      # * Summary. Show the error and warning summary at the end.
+      # * NoSummary. Don't show the error and warning summary at the end.
+      # * ErrorsOnly. Show only errors.
+      # * WarningsOnly. Show only warnings.
+      # * NoItemAndPropertyList. Don't show the list of items and properties that would appear at the start of each project build if the verbosity level is set to diagnostic.
+      # * ShowCommandLine. Show TaskCommandLineEvent messages.
+      # * ShowTimestamp. Show the timestamp as a prefix to any message.
+      # * ShowEventId. Show the event ID for each started event, finished event, and message.
+      # * ForceNoAlign. Don't align the text to the size of the console buffer.
+      # * DisableConsoleColor. Use the default console colors for all logging messages.
+      # * DisableMPLogging. Disable the multiprocessor logging style of output when running in non-multiprocessor mode.
+      # * EnableMPLogging. Enable the multiprocessor logging style even when running in non-multiprocessor mode. This logging style is on by default.
+      # * Verbosity. Override the /verbosity setting for this logger.
+      def clp param
+        update_array_prop "consoleloggerparameters", method(:make_clp), :clp, param
+      end
+
+      # Set logging verbosity to quiet
+      def be_quiet
+        logging = "quiet"
+      end
+
+      # Don't display the startup banner or the copyright message.
+      def nologo
+        @parameters.add "/nologo"
+      end
+
+      private
+      def set_logging mode
+        modes = %w{quiet minimal normal detailed diagnostic}.collect{ |m| "/verbosity:#{m}" }
+        @parameters.subtract modes
+        @parameters.add "/verbosity:#{mode}"
+      end
+
+      def update_array_prop prop_name, callable_prop_val, field_sym, value
+        field = :"@#{field_sym}"
+        # @targets ||= []
+        instance_variable_set field, [] unless instance_variable_defined? field
+        # parameters.delete "/target:#{make_target}" if @targets.any?
+        @parameters.delete "/#{prop_name}:#{callable_prop_val.call}" if 
+          instance_variable_get(field).any?
+        if value.respond_to? 'each'
+          value.each { |v| instance_variable_get(field) << v }
+        else
+          instance_variable_get(field) << value
+        end
+        instance_variable_get(field).uniq!
+        # @parameters.add "/target:#{make_target}"
+        @parameters.add "/#{prop_name}:#{callable_prop_val.call}"
+      end
+
+      def make_target
+        @targets.join(';')
+      end
+
+      def make_props
+        @properties.collect { |k, v|
+          "#{k}=#{v}"
+        }.join(';')
+      end
+
+      def make_clp
+        @clp.join(';')
+      end
+
+      def heuristic_executable
+        if ::Rake::Win32.windows?
+          trace 'build tasktype finding msbuild.exe'
+          %w{v4.0.30319 v4.0 v3.5 v2.0}.collect { |fw_ver|
+            msb = File.join ENV['WINDIR'], 'Microsoft.NET', 'Framework', fw_ver, 'msbuild.exe'
+            CrossPlatformCmd.which(msb) ? msb : nil
+          }.first
+        else
+          nil
+        end
+      end
+    end
+    class Task
+      def initialize command_line
+        @command_line = command_line
+      end
+      def execute
+        @command_line.execute
+      end
+    end
+  end
+end

data/lib/albacore/task_types/nugets_authentication.rb

@@ -0,0 +1,9 @@
+module Albacore
+  module NugetsAuthentication
+    # if the nuget feed you're accessing is authenticated, set this username
+    attr_accessor :username
+
+    # if the nuget feed you're accessing is authenticated, set this password
+    attr_accessor :password
+  end
+end

data/lib/albacore/task_types/nugets_pack.rb

@@ -0,0 +1,378 @@
+require 'rake'
+require 'nokogiri'
+require 'fileutils'        
+require 'albacore'
+require 'albacore/paths'
+require 'albacore/cmd_config'
+require 'albacore/config_dsl'
+require 'albacore/cross_platform_cmd'
+require 'albacore/project'
+require 'albacore/logging'
+require 'albacore/nuget_model'
+
+module Albacore
+  module NugetsPack
+    # the nuget command
+    class Cmd
+      include CrossPlatformCmd
+
+      # executable => the nuget executable
+      def initialize executable, *args
+        opts = Map.options args
+        raise ArgumentError, 'out is nil' if opts.getopt(:out).nil?
+
+        @work_dir   = opts.getopt :work_dir, default: nil
+        @executable = executable
+        @parameters = [%W{Pack -OutputDirectory #{opts.get(:out)}}].flatten
+        @opts = opts
+
+        mono_command
+      end
+
+      # run nuget on the nuspec to create a new package
+      # returns: a tuple-array of the package and the symbol package
+      #   of which the symbol package is nil if it was not generated
+      def execute nuspec_file, nuspec_symbols_file = nil
+        debug "NugetsPack::Cmd#execute, opts: #{@opts} [nugets pack: cmd]"
+        original_pars = @parameters.dup
+
+        pars = original_pars.dup
+        pars << nuspec_file
+        pkg = get_nuget_path_of do
+          system @executable, pars, :work_dir => @work_dir
+        end
+
+        debug "package at '#{pkg}'"
+
+        # if the symbols flag is set and there's a symbols file specified
+        # then run NuGet.exe to generate the .symbols.nupkg file
+        if nuspec_symbols_file
+          pars = original_pars.dup 
+          pars << '-Symbols' 
+          pars << nuspec_symbols_file 
+          spkg = with_subterfuge pkg do
+            get_nuget_path_of do
+              system @executable, pars, :work_dir => @work_dir
+            end
+          end
+
+          debug "symbol package at '#{spkg}'"
+
+          [pkg, spkg]
+        else
+          info "symbols not configured for generation, use Config#gen_symbols to do so [nugets pack: cmd]"
+          [pkg, nil]
+        end
+      end
+
+      private
+
+      # regexpes the package path from the output
+      def get_nuget_path_of
+        out = yield
+        out.match /Successfully created package '([:\s\w\\\/\d\.]+\.symbols\.nupkg)'./i if out.respond_to? :match
+        trace "Got symbols return value: '#{out}', matched: '#{$1}'" if $1
+        return $1 if $1
+
+        out.match /Successfully created package '([:\s\w\\\/\d\.]+\.nupkg)'./i if out.respond_to? :match
+        trace "Got NOT-symbols return value: '#{out}', matched: '#{$1}'"
+        $1
+      end
+
+      # hide the original like a ninja while NuGet whimpers in a corner
+      def with_subterfuge pkg
+        FileUtils.mv pkg, "#{pkg}.tmp" if pkg && File.exists?(pkg)
+        res = yield
+        FileUtils.mv "#{pkg}.tmp", pkg if pkg && File.exists?("#{pkg}.tmp")
+        res
+      end
+    end
+    
+    # This tasktype allows you to quickly package project files to nuget
+    # packages.
+    #
+    # Point files to the project files, that should be in MsBuild XML.
+    #
+    # Examples
+    #
+    #  nugets_pack :pack => ['build/pkg', :versioning] do |p|
+    #    p.files   = FileList['src/**/*.csproj']
+    #    p.out     = 'build/pkg'
+    #    p.exe     = 'buildsupport/NuGet.exe'
+    #    p.version = ENV['NUGET_VERSION']
+    #    p.gen_symbols
+    #  end
+    class Config
+      include CmdConfig
+      self.extend ConfigDSL
+
+      # the output directory to place the newfangled nugets in
+      attr_path :out
+
+      # the .net target (e.g. net40, mono2.0)
+      attr_writer :target
+
+      # sets the files to search
+      attr_writer :files
+
+      # sets the MsBuild configuration that is used to produce the output into
+      # <OutputPath>...</OutputPath>
+      attr_writer :configuration
+
+      def initialize
+        @package = Albacore::NugetModel::Package.new
+        @target  = 'net40'
+        @symbols = false
+        fill_required
+      end
+
+      def with_metadata &block
+        yield @package.metadata
+      end
+
+      # configure the package with a block
+      def with_package &block
+        yield @package
+      end
+
+      # generate symbols for the nugets: just call this method to
+      # enable generation
+      def gen_symbols
+        @symbols = true
+      end
+
+      # gets the options specified for the task, used from the task
+      def opts
+        files = @files.respond_to?(:each) ? @files : [@files]
+
+        [:authors, :description, :version].each do |required|
+          warn "metadata##{required} is missing from nugets_pack [nugets pack: config]" if @package.metadata.send(required) == 'MISSING' 
+        end
+        
+        Map.new({
+          :out           => @out,
+          :exe           => @exe,
+          :symbols       => @symbols,
+          :package       => @package,
+          :target        => @target,
+          :files         => @files,
+          :configuration => @configuration,
+          :original_path => FileUtils.pwd
+        })
+      end
+
+      private
+
+      def fill_required
+        # see http://docs.nuget.org/docs/reference/nuspec-reference
+        with_metadata do |m|
+          m.authors = m.description = m.version = 'MISSING'
+        end
+      end
+    end
+
+    # a task that handles the generation of nugets from projects or nuspecs.
+    class ProjectTask
+      include Logging
+
+      def initialize opts, &before_execute
+        raise ArgumentError, 'opts is not a map' unless opts.is_a? Map
+        raise ArgumentError, 'no files given' unless opts.get(:files).length > 0
+        @opts           = opts.apply :out => '.'
+        @files          = opts.get :files
+        @before_execute = before_execute
+      end
+
+      def execute
+        knowns = compute_knowns
+        @files.each do |p|
+          proj, n, ns = generate_nuspec p, knowns
+          execute_inner! proj, n, ns
+        end
+      end
+
+      def path_to relative_file_path, cwd
+        File.expand_path( File.join(@opts.get(:original_path), relative_file_path), cwd )
+      end
+
+      # generate all nuspecs
+      def generate_nuspecs
+        nuspecs = {}
+        knowns = compute_knowns
+        @files.each do |p|
+          proj, n, ns = generate_nuspec p, knowns
+          nuspecs[proj.name] = OpenStruct.new({:proj => proj, :nuspec => n, :nuspec_symbols => ns })
+        end
+        nuspecs
+      end
+
+      private
+
+      def compute_knowns
+        Set.new(@files.map { |f| Albacore::Project.new f }.map { |p| p.name })
+      end
+
+      def generate_nuspec p, knowns
+        proj = Albacore::Project.new p
+        nuspec, nuspec_symbols = create_nuspec proj, knowns
+        [proj, nuspec, nuspec_symbols]
+      end
+
+      # execute, for each project file
+      def execute_inner! proj, nuspec, nuspec_symbols
+        nuspec_path = write_nuspec! proj, nuspec, false
+        nuspec_symbols_path = write_nuspec! proj, nuspec_symbols, true if nuspec_symbols
+
+        create_nuget! proj.proj_path_base, nuspec_path, nuspec_symbols_path
+      rescue => e
+        err (e.inspect)
+        raise $!
+      ensure
+        trace do
+          %{
+ PROJECT #{proj.name} nuspec:
+
+#{nuspec.to_xml}
+
+ PROJECT #{proj.name} symbol nuspec:
+
+#{if nuspec_symbols then nuspec_symbols.to_xml else 'NO SYMBOLS' end}}
+        end
+
+        # now remove them all
+        [nuspec_path, nuspec_symbols_path].each{|n| cleanup_nuspec n}
+      end
+
+      ## Creating
+
+      def create_nuspec proj, knowns
+        version = @opts.get(:package).metadata.version
+
+        trace "creating NON-SYMBOL package for #{proj.name} [nugets pack: task]"
+        nuspec = Albacore::NugetModel::Package.from_xxproj proj, 
+          symbols:        false,
+          verify_files:   true,
+          known_projects: knowns,
+          version:        version,
+          configuration:  (@opts.get(:configuration))
+
+        # take data from package as configured in Rakefile, choosing what is in
+        # Rakefile over what is in projfile.
+        nuspec = nuspec.merge_with @opts.get(:package)
+        trace { "nuspec: #{nuspec.to_s} [nugets pack: task]" }
+
+        if @opts.get(:symbols)
+          trace { "creating SYMBOL package for #{proj.name} [nugets pack: task]" }
+          nuspec_symbols = Albacore::NugetModel::Package.from_xxproj proj,
+            symbols:        true,
+            verify_files:   true,
+            known_projects: knowns,
+            version:        version,
+            configuration:  (@opts.get(:configuration))
+
+          nuspec_symbols = nuspec_symbols.merge_with @opts.get(:package)
+          trace { "nuspec symbols: #{nuspec_symbols.to_s} [nugets pack: task]" }
+
+          [nuspec, nuspec_symbols]
+        else
+          trace { "skipping SYMBOL package for #{proj.name} [nugets pack: task]" }
+          [nuspec, nil]
+        end
+      end
+
+      def write_nuspec! proj, nuspec, symbols
+        nuspec_path = File.join(proj.proj_path_base, nuspec.metadata.id + "#{ symbols ? '.symbols' : '' }.nuspec")
+
+        File.write(nuspec_path, nuspec.to_xml)
+
+        nuspec_path
+      end
+
+      def create_nuget! cwd, nuspec, nuspec_symbols = nil
+        # create the command
+        exe = path_to(@opts.get(:exe), cwd)
+        out = path_to(@opts.get(:out), cwd)
+        nuspec = path_to nuspec, cwd
+        nuspec_symbols = path_to nuspec_symbols, cwd if nuspec_symbols
+        cmd = Albacore::NugetsPack::Cmd.new exe,
+                work_dir: cwd,
+                out:      out
+
+        # run any concerns that modify the command
+        @before_execute.call cmd if @before_execute
+
+        debug { "generating nuspec at #{nuspec}, and symbols (possibly) at '#{nuspec_symbols}' [nugets pack: task]" }
+
+        # run the command for the file
+        pkg, spkg = cmd.execute nuspec, nuspec_symbols
+
+        publish_artifact nuspec, pkg
+        publish_artifact nuspec_symbols, spkg if spkg && nuspec_symbols
+      end
+
+      ## Cleaning up after generation
+
+      def cleanup_nuspec nuspec
+        return if nuspec.nil? or not File.exists? nuspec
+        File.delete nuspec
+      end
+
+      def publish_artifact nuspec, nuget
+        Albacore.publish :artifact, OpenStruct.new(
+          :nuspec   => nuspec,
+          :nupkg    => nuget,
+          :location => nuget
+        ) 
+      end
+
+      def self.accept? f
+        File.extname(f).downcase != '.nuspec'
+      end
+    end
+    
+    # generate a nuget from a nuspec
+    class NuspecTask
+      include Logging
+
+      def initialize command_line, config, nuspec
+        @config = config
+        @nuspec = nuspec
+        # is a NuspecPack::Cmd
+        @command_line = command_line
+      end
+
+      def read_version_from_nuspec
+        begin
+          nuspec_file = File.open(@nuspec)
+          xml = Nokogiri::XML(nuspec_file)
+          nuspec_file.close
+          nodes = xml.xpath('.//metadata/version')
+          raise "No <version/> found" if nodes.empty?
+          nodes.first.text()
+        rescue => error
+          err "Error reading package version from file: #{error}"
+          raise
+        end
+      end
+      
+      def execute
+        version = read_version_from_nuspec
+        filename = File.basename(@nuspec, File.extname(@nuspec))
+
+        @command_line.execute @nuspec
+
+        path = File.join(@config.opts.get(:out), "#{filename}.#{version}.nupkg")
+
+        Albacore.publish :artifact, OpenStruct.new(
+          :nuspec   => @nuspec,
+          :nupkg    => path,
+          :location => path
+        )
+      end
+
+      def self.accept? file
+        File.extname(file).downcase == '.nuspec'
+      end
+    end
+  end
+end