albacore 2.0.0.rc.4 → 2.0.0.rc.5

data/README.md

@@ -31,8 +31,14 @@ build will use. Create a new file, named `Gemfile`. This file should look like
 this:
 
     source 'http://rubygems.org'
-    gem 'albacore', '2.0.0.rc.2'
+    gem 'albacore', '2.0.0.rc.5'
 
+When setting up your build you need to ensure it is reproducible.  Bundler
+allows you to lock down all gems that albacore depend on to their specific
+versions, ensuring that your peers can re-run the same rake script you just
+built and that it works well on your continous integration server.
+
+The first step after installing `bundler` is to create a `Gemfile` next to your
 Now, install albacore from this repository by running:
 
     bundle
@@ -90,7 +96,7 @@ task :default => :create_nugets
 
 You can now run:
 
-    rake
+    bundle exec rake
 
 ## Contributing
 
@@ -101,6 +107,49 @@ You can now run:
     a. Make sure TravisCI is OK with it
     b. Describe your PR in English.
 
+## DSL
+
+When you `require 'albacore'` you will get a few methods added and available for
+use within your Rakefile, these are specified in CrossPlatformCmd, and are as
+follows:
+
+ - `#system`
+ - `#sh`
+ - `#shie`
+ - `#system_control`
+ - `#which`
+ - `#normalise_slashes` 
+ - `#chdir (work_dir : ?string) (block : Block<unit, x>) : x` - takes a string work dir to be
+   in and a block of ruby to execute in that work dir and returns the return
+   value of block.
+
+
+## Debugging Albacore scripts
+
+You can call the rakefile as such:
+
+```
+DEBUG=true rake
+```
+
+This changes the behaviour of the logging to output debug verbosity. It also
+changes some tasks to override Rakefile settings for verbosity and prints more
+debug information. I've tried to keep the information structured.
+
+If you're reporting a bug or need crash information to file a bug report, you
+can append the `--trace` flag to the invocation.
+
+```
+DEBUG=true rake --trace
+```
+
+## Tips and Tricks
+
+rake script:
+
+```
+source "https://rubygems.org"
+
 ## Task Types
 
 Task types are the pre-built factories for rake tasks. They often take care of

data/lib/albacore/cross_platform_cmd.rb

@@ -60,6 +60,9 @@ module Albacore
     #  output:   whether to supress the command's output (default false)
     #  out:      output pipe
     #  err:      error pipe
+    #  clr_command:
+    #            whether to include 'mono' in front of the things to run
+    #            if the command is a clr command
     #
     def system *cmd, &block
       raise ArgumentError, "cmd is nil" if cmd.nil? # don't allow nothing to be passed
@@ -69,9 +72,10 @@ module Albacore
           output: true,
           work_dir: FileUtils.pwd,
           out: Albacore.application.output,
-          err: Albacore.application.output_err)
+          err: Albacore.application.output_err,
+          clr_command: false)
 
-      exe, pars, printable, block = prepare_command cmd, &block
+      exe, pars, printable, block = prepare_command cmd, (opts.get('clr_command')), &block
 
       # TODO: figure out how to interleave output and error streams
       out, _, inmem = opts.get(:out), opts.get(:err), StringIO.new
@@ -231,10 +235,10 @@ module Albacore
     
     private
 
-    def prepare_command cmd, &block
+    def prepare_command cmd, clr_command = false, &block
+      cmd = cmd.unshift 'mono' if clr_command && ! ::Albacore.windows?
       pars = cmd[1..-1].flatten
       raise ArgumentError, "arguments 1..-1 must be an array" unless pars.is_a? Array
-
       exe, pars = ::Albacore::Paths.normalise cmd[0], pars 
       printable = %Q{#{exe} #{pars.join(' ')}}
       handler = block_given? ? block : handler_with_message(printable)

data/lib/albacore/nuget_model.rb

@@ -91,6 +91,11 @@ end})
       # gets the framework assemblies for this package
       nuspec_field :framework_assemblies
 
+      # (v2.5 or above) Specifies the minimum version of the NuGet client that
+      # can install this package. This requirement is enforced by both the
+      # NuGet Visual Studio extension and nuget.exe program.
+      nuspec_field :min_client_version
+
       # gets the field symbols that have been set
       attr_reader :set_fields
 

data/lib/albacore/task_types/nugets_pack.rb

@@ -127,6 +127,7 @@ module Albacore
         @target  = 'net40'
         @symbols = false
         @project_dependencies = true
+        @leave_nuspec = false
         fill_required
       end
 
@@ -145,6 +146,12 @@ module Albacore
         @symbols = true
       end
 
+      # leave the nuspec behind, don't delete it after generating it
+      #
+      def leave_nuspec
+        @leave_nuspec = true
+      end
+
       # call this if you want to cancel 'smart' scanning of the *proj
       # file for its dependencies
       def no_project_dependencies
@@ -168,7 +175,8 @@ module Albacore
           :files         => @files,
           :configuration => @configuration,
           :project_dependencies => @project_dependencies,
-          :original_path => FileUtils.pwd
+          :original_path => FileUtils.pwd,
+          :leave_nuspec  => @leave_nuspec
         })
       end
 
@@ -331,6 +339,7 @@ module Albacore
 
       def cleanup_nuspec nuspec
         return if nuspec.nil? or not File.exists? nuspec
+        return if @opts.get :leave_nuspec, false
         File.delete nuspec
       end
 

data/lib/albacore/task_types/nugets_restore.rb

@@ -73,6 +73,7 @@ module Albacore
 
       def initialize
         @include_official = false
+        @list_spec = File.join '**', 'packages.config'
       end
 
       # the output directory passed to nuget when restoring the nugets
@@ -81,8 +82,13 @@ module Albacore
       # nuget source, when other than MSFT source
       attr_accessor :source
 
+      # specifies the list specification to load 'packages.config' files
+      # from.
+      #
+      # e.g. '**/packages.config' on *nix.
+      attr_accessor :list_spec
+
       def packages
-        list_spec = File.join '**', 'packages.config'
         # it seems FileList doesn't care about the curr dir
         in_work_dir do
           FileList[

data/lib/albacore/tasks/versionizer.rb

@@ -1,4 +1,4 @@
-require 'semver'
+require 'xsemver'
 require 'albacore/logging'
 
 module Albacore
@@ -21,9 +21,9 @@ module Albacore
       # code if you want something of your own.
       #
       def self.new *sym
-        ver = SemVer.find
+        ver = XSemVer::SemVer.find
         revision = (ENV['BUILD_NUMBER'] || ver.patch).to_i
-        ver = SemVer.new(ver.major, ver.minor, revision, ver.special)
+        ver = XSemVer::SemVer.new(ver.major, ver.minor, revision, ver.special)
         
         # extensible number w/ git hash
         ENV['BUILD_VERSION'] = ver.format("%M.%m.%p%s") + ".#{commit_data()[0]}"
@@ -32,7 +32,7 @@ module Albacore
         ENV['NUGET_VERSION'] = ver.format("%M.%m.%p%s")
         
         # purely M.m.p format
-        ENV['FORMAL_VERSION'] = "#{ SemVer.new(ver.major, ver.minor, revision).format "%M.%m.%p"}"
+        ENV['FORMAL_VERSION'] = "#{ XSemVer::SemVer.new(ver.major, ver.minor, revision).format "%M.%m.%p"}"
         
         body = proc {
           Albacore.publish :build_version, OpenStruct.new(

data/lib/albacore/version.rb

@@ -1,3 +1,3 @@
 module Albacore
-  VERSION = "2.0.0.rc.4"
+  VERSION = "2.0.0.rc.5"
 end

data/spec/cross_platform_cmd_spec.rb

@@ -15,6 +15,56 @@ describe Albacore::CrossPlatformCmd.method(:which), "what happens when calling #
   end
 end
 
+describe Albacore::CrossPlatformCmd.method(:prepare_command) do
+  it 'should be callable' do
+    subject.should respond_to(:call)
+  end
+  before :all do
+    # noteworthy: escape spaces with backslash!
+    @exe, @pars, @printable, @handler = subject.call %w[echo Hello World Goodbye\ World], true
+  end
+  it "should not return nil for anything" do
+    { exe:       @exe,
+      pars:      @pars,
+      printable: @printable,
+      handler:   @handler
+    }.each do |kv|
+      kv[1].should_not be_nil
+    end
+  end
+  if Albacore.windows? then
+    it 'should not include mono' do
+      @exe.should_not include('mono')
+    end
+
+    it 'should return first param correctly' do
+      @pars[0].should eq('Hello')
+    end
+    it 'should return second param correctly' do
+      @pars[1].should eq('World')
+    end
+    it 'should return third param correctly' do
+      @pars[2].should eq('Goodbye World')
+    end
+  else
+    it 'should include mono' do
+      @exe.should include('mono')
+    end
+    it 'should return first param as "echo"' do
+      @pars[0].should eq('echo')
+    end
+    it 'should return second param as "Hello"' do
+      @pars[1].should eq('Hello')
+    end
+    it 'should return third param as "World"' do
+      @pars[2].should eq('World')
+    end
+    it 'should return fourth param as "Goodbye World"' do
+      @pars[3].should eq('Goodbye World')
+    end
+  end
+end
+
 [:system, :sh, :shie].each do |method|
   describe Albacore::CrossPlatformCmd.method(method), "##{method}" do
     describe 'its positive modes' do

data/spec/tasks/versionizer_spec.rb

@@ -0,0 +1,17 @@
+require 'albacore'
+require 'albacore/tasks/versionizer'
+
+describe 'adding versionizer to a class' do
+  class VersioniserUsage
+    def initialize
+      ::Albacore::Tasks::Versionizer.new :v
+    end
+  end
+
+  it 'can create a new class instance' do
+    begin
+      VersioniserUsage.new
+    rescue SemVerMissingError
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: albacore
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc.4
+  version: 2.0.0.rc.5
   prerelease: 6
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-17 00:00:00.000000000 Z
+date: 2014-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -270,6 +270,7 @@ files:
 - spec/support/returnstatus/returnstatus.exe.config
 - spec/support/returnstatus/returnstatus.pdb
 - spec/support/sh_interceptor.rb
+- spec/tasks/versionizer_spec.rb
 - spec/testdata/.gitignore
 - spec/testdata/DebugProject/.gitignore
 - spec/testdata/DebugProject/Degbu.fsproj
@@ -322,7 +323,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -205228917217279465
+      hash: 3795329884422946093
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -378,6 +379,7 @@ test_files:
 - spec/support/returnstatus/returnstatus.exe.config
 - spec/support/returnstatus/returnstatus.pdb
 - spec/support/sh_interceptor.rb
+- spec/tasks/versionizer_spec.rb
 - spec/testdata/.gitignore
 - spec/testdata/DebugProject/.gitignore
 - spec/testdata/DebugProject/Degbu.fsproj