albacore 2.0.0.rc.2 → 2.0.0.rc.3

data/albacore.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.email       = 'henrik@haf.se'
   s.homepage    = 'http://albacorebuild.net'
   s.summary     = 'Dolphin-safe and awesome Mono and .Net Rake-tasks'
+  s.license     = 'MIT'
   s.description = <<-EOF
     Easily build your .Net or Mono project using this collection of Rake tasks.
     Albacore assist you in creating nugets, managing nugets, building your projects,

data/lib/albacore.rb

@@ -1,3 +1,6 @@
 require 'albacore/version'
 require 'albacore/albacore_module'
 require 'albacore/dsl'
+
+module Albacore
+end

data/lib/albacore/albacore_module.rb

@@ -52,6 +52,12 @@ module Albacore
       end
     end
 
+    # Gets whether we're running under Windows.
+    #
+    def windows?
+      ::Rake::Win32.windows?
+    end
+
     Albacore.log_level = Logger::DEBUG if ENV["DEBUG"]
   end
 end

data/lib/albacore/nuget_model.rb

@@ -57,6 +57,9 @@ end})
       # gets or sets the description of this package
       nuspec_field :description
 
+      # gets or sets the summary of this package
+      nuspec_field :summary
+
       # gets or sets the language that this package has been built with
       nuspec_field :language
 
@@ -301,9 +304,12 @@ end})
       # Options:
       #  - symbols
       #  - dotnet_version
+      #   Specifies the version to use for constructing the nuspec's lib folder
       #  - known_projects
       #  - configuration
       #  - project_dependencies
+      #   Specifies whether to follow the project dependencies. See nuget_model_spec.rb
+      #   for examples of usage of this property.
       #  - nuget_dependencies
       def self.from_xxproj proj, *opts
         opts = Map.options(opts || {}).
@@ -373,8 +379,8 @@ end})
           package.files.each do |file|
             file_path = File.expand_path file.src, proj.proj_path_base
             unless File.exists? file_path
+              info "while building nuspec for proj: #{proj.name}, file: #{file_path} => #{file.target} not found, removing from nuspec [nuget model: package]"
               package.remove_file file.src
-              info "while building nuspec for proj: #{proj.name}, file: #{file.src} => #{file.target} not found, removing from nuspec [nuget model: package]"
               trace { "files: #{package.files.map { |f| f.src }.inspect} [nuget model: package]" }
             end
           end

data/lib/albacore/task_types/asmver.rb

@@ -18,6 +18,7 @@ module Albacore
       # the file name to write the assembly info to
       attr_path_accessor :file_path
 
+      # the namespace to output into the version file
       attr_writer :namespace
 
 
@@ -34,11 +35,12 @@ module Albacore
       
       def opts
         raise Error, "#file_path is not set" unless (file_path or out)
+        ns   = @namespace || '' # defaults to empty namespace if not set.
         lang = lang_for file_path
         m = Map.new attributes: @attributes,
-          namespace: @namespace,
+          namespace: ns,
           file_path: @file_path,
-          language: lang
+          language:  lang
         m[:out] = @out if @out
         m
       end
@@ -55,6 +57,7 @@ module Albacore
       end
     end
     class Task
+      include Logging
       def initialize opts
         @opts = opts
       end
@@ -62,8 +65,12 @@ module Albacore
         lang  = @opts.get :language
         ns    = @opts.get :namespace
         attrs = @opts.get :attributes
-        out   = @opts.get(:out) { File.open(@opts.get(:file_path), 'w') }
-        ::Albacore::Asmver::FileGenerator.new(lang, ns, @opts).generate(attrs)
+        out   = @opts.get :out do
+          trace { "asmver being written at '#{@opts.get :file_path}' [asmver-task #execute]" }
+          File.open(@opts.get(:file_path), 'w')
+        end
+        ::Albacore::Asmver::FileGenerator.new(lang, ns, @opts).generate out, attrs
+        trace { "asmver was written at '#{@opts.get :file_path}' [asmver-task #execute]" }
       ensure
         out.close if out
       end

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

@@ -1,8 +1,11 @@
 require 'albacore/task_types/asmver/engine'
+require 'albacore/logging'
 require 'map'
 
 module Albacore::Asmver
   class FileGenerator
+    include ::Albacore::Logging
+
     DEFAULT_USINGS = %w|
 System.Reflection
 System.Runtime.CompilerServices
@@ -13,33 +16,37 @@ System.Runtime.InteropServices|
       raise ArgumentError, 'ns is nil' unless ns
       @engine = engine 
       @ns     = ns
-      @opts   = Map.new(opts)
+      @opts   = Map.new opts
     end
     
-    def generate attrs = {}
+    def generate out, attrs = {}
+      trace { "generating file with attributes: #{attrs} [file_generator #generate]" }
+
       # https://github.com/ahoward/map/blob/master/test/map_test.rb#L374
       attrs = Map.new attrs
-      s = @opts.get(:out) { StringIO.new }
 
       # write the attributes in the namespace
-      @engine.build_namespace @ns, s do
+      @engine.build_namespace @ns, out do
         # after namespace My.Ns.Here
-        s << "\n"
+        out << "\n"
 
         # open all namespaces to use .Net attributes
         @opts.get(:usings) { DEFAULT_USINGS }.each do |ns|
-          s << @engine.build_using_statement(ns)
-          s << "\n"
+          out << @engine.build_using_statement(ns)
+          out << "\n"
         end
 
+        warn { 'no attributes have been given to [file_generator #generate]' } if attrs.empty?
+
         # write all attributes
         attrs.each do |name, data|
-          s << @engine.build_attribute(name, data)
-          s << "\n"
+          trace { "building attribute #{name}: '#{data}' [file_generator #generate]" }
+          out << @engine.build_attribute(name, data)
+          out << "\n"
         end
       end
 
-      s.string
+      nil
     end
   end
 end

data/lib/albacore/task_types/build.rb

@@ -1,192 +1,196 @@
-# -*- 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
+# -*- 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 (ENV['DEBUG'] ?
+                      (ENV['VERBOSE'] ?
+                        'detailed' :
+                        'normal') :
+                      '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