albacore 2.0.16 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 560c9fa28236e37df5b2efdf8085cfe7bcd068fd
-  data.tar.gz: 8fd54f812d717c6a0037d5793f2206619f94bb08
+  metadata.gz: 8459e2ab287d35aab39714362dd1a67c00e3a1b6
+  data.tar.gz: de71fc5144cbb5bdd60994ac7ada639b41c26fe4
 SHA512:
-  metadata.gz: ba75ed679a1dbb9312b2a47f868495c477886bf454589cf93ec678f2f11028f8edb67a6d2191aa6839f61f2592fdb34b55a4b6a552099b98553928d360d4ad91
-  data.tar.gz: 62c2660a8ee8cfb735bc8a078f528a476c7bd937d8b4f4217ced87631637ccf2b19c579d4f05346e4b0f5257673f8f35ff0d29b8f6b9887f4dbbad90bbdccd9e
+  metadata.gz: 027a22bdb053bf94a9df10572e2982613b985b3d9cc69c3bea14337cdff0967af26ca372726da06dadc28017b83bac65750d7da8d1df8d8ec0a16e5475ed62ed
+  data.tar.gz: bcb602717b386994bd383d0599608436fd4bbecf4e3409a98995cab06545891bee8a02de6c8c22344f0fe48be1c5670a210a6196ae5fa5a123e452fe2608686c

data/README.md

@@ -51,7 +51,7 @@ Ruby' first. Albacore works on both Ruby 1.9.3 and 2.x.
 First create `Gemfile` with these contents:
 
     source 'https://rubygems.org'
-    gem 'albacore', '2.0.0'
+    gem 'albacore', '~> 2.0.0'
 
 When setting up your build you need to ensure it is reproducible.  Bundler
 allows you to lock down the few gems that Albacore depend on to their specific
@@ -61,31 +61,46 @@ built and that it works well on your continous integration server.
 Now you can bundle the dependencies, effectively freezing all gem dependencies
 that your build depends on.
 
-    bundle install
-    git add Gemfile
-    git add Gemfile.lock
+    bundle
+    git add Gemfile*
     git commit -m 'Installed Albacore'
 
 Now you are ready to continue reading below for your first Rakefile.
 
 ### Installing Ruby on Windows
 
-Install [Chocolatey](http://chocolatey.org) by, in a command prompt, running:
+First install Ruby from http://rubyinstaller.org/downloads/ - e.g. [v2.1.3
+32-bits](http://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.1.3.exe?direct)
+which is the latest version, at time of writing.
 
-    @powershell -NoProfile -ExecutionPolicy unrestricted -Command "iex ((new-object net.webclient).DownloadString('http://chocolatey.org/install.ps1'))" && SET PATH=%PATH%;%systemdrive%\chocolatey\bin
+Second, install Ruby DevKit, or you won't be able to install nokogiri. Download
+it [lower down on the same
+page](http://cdn.rubyinstaller.org/archives/devkits/DevKit-mingw64-32-4.7.2-20130224-1151-sfx.exe),
+open a console:
 
-Then start a new powershell, cygwin or mingw32 shell. You can now install the
-Ruby framework:
-
-    cinst ruby.devkit
+``` bash
+cd \DevKit
+ruby dk.rb init
+ruby dk.rb install
+```
 
-Now, restart your shell or reload its path variable. You now have rake
-installed. Now you can install Albacore, the collection of tasktypes, tasks and
-extension points aimed to make your life as a .Net developer easier:
+Now close that console and open a new console, and run:
 
     gem install bundler
 
-Continue below with your first Rakefile.
+This gives you a working ruby installation. Continue below with your first
+Rakefile.
+
+### Installing Ruby on OS X
+
+``` bash
+brew install rbenv ruby-build
+rbenv install 2.1.3
+gem install bundler
+```
+
+Done. Ensure `brew doctor` is clean enough and that `ruby --version` outputs the
+expected version.
 
 ## Creating Your First Rakefile
 
@@ -126,7 +141,7 @@ nugets_pack :create_nugets => ['build/pkg', :versioning, :build] do |p|
   p.files   = FileList['src/**/*.{csproj,fsproj,nuspec}'].
     exclude(/Tests/)
   p.out     = 'build/pkg'
-  p.exe     = 'buildsupport/NuGet.exe'
+  p.exe     = 'tools/NuGet.exe'
   p.with_metadata do |m|
     m.description = 'A cool nuget'
     m.authors = 'Henrik'
@@ -144,6 +159,10 @@ You can now run:
 
     bundle exec rake
 
+You can continue reading about the available task-types in [the wiki][wiki].
+
+If you're upgrading from v1.0, there's an article [there for you][upgrade-v1.0]
+
 ## Contributing
 
  1. Create a feature branch with your change:
@@ -166,3 +185,5 @@ Document your code with
 writing it: it's much easier to write the documentation together with the code
 than afterwards.
 
+ [wiki]: https://github.com/Albacore/albacore/wiki
+ [upgrade-v1.0]: https://github.com/Albacore/albacore/wiki/Upgrading-from-v1.0

data/albacore.gemspec

@@ -31,6 +31,6 @@ EOF
 
   s.files         = `git ls-files`.split("\n").concat(Dir.glob('./resources/**'))
   s.test_files    = `git ls-files -- spec/*`.split("\n")
-  # s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename f }
+  s.require_paths = %w|bin lib|
 end

data/bin/albacore

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'albacore/cli'
+
+begin
+  Albacore::Cli.new ARGV
+rescue Albacore::Cli::CommandError => e
+  puts e.message
+  puts "run '#{$0} help' for more info"
+  exit 1
+end

data/lib/albacore/albacore_module.rb

@@ -1,65 +1,75 @@
-# -*- encoding: utf-8 -*-
-
-require 'albacore/application'
-require 'albacore/logging'
-
-# The albacore module instance methods.
-module Albacore
-  class << self
-    # Accessor for the Albacore application. Configuration
-    # and similar singleton values will be stored in this
-    # instance. Multiple calls will yield the same instance.
-    def application
-      @application ||= Albacore::Application.new
-    end
-
-    # set the application -- good for testing
-    # the infrastructure of albacore by resetting the
-    # state after each test
-    def set_application app
-      @application = app
-    end
-
-    # Defines a new task with all of what that entails:
-    # will call application.define_task.
-    def define_task *args, &block
-      args = [caller[0][/`.*'/][1..-2]] if args.nil? or args.empty?
-      # delegate to the application singleton
-      application.define_task *args, &block
-    end
-
-    # Set the global albacore logging level.
-    def log_level= level
-      application.logger.level = level
-    end
-
-    # Use to write to STDOUT (by default)
-    def puts *args
-      application.puts *args
-    end
-
-    def events
-      @events ||= {}
-    end
-
-    def subscribe event, &block
-      event = event.to_sym unless event.is_a? Symbol
-      events[event] ||= Set.new
-      events[event].add block
-    end
-
-    def publish event, obj
-      if events.member? event
-        events[event].each { |m| m.call(obj) }
-      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
+# -*- encoding: utf-8 -*-
+
+require 'albacore/application'
+require 'albacore/logging'
+
+# The albacore module instance methods.
+module Albacore
+  class << self
+    # Accessor for the Albacore application. Configuration
+    # and similar singleton values will be stored in this
+    # instance. Multiple calls will yield the same instance.
+    def application
+      @application ||= Albacore::Application.new
+    end
+
+    # Name of default Rakefile, used by Cli
+    def rakefile
+      'Rakefile'
+    end
+
+    # Name of the default Gemfile, used by Cli
+    def gemfile
+      'Gemfile'
+    end
+
+    # set the application -- good for testing
+    # the infrastructure of albacore by resetting the
+    # state after each test
+    def set_application app
+      @application = app
+    end
+
+    # Defines a new task with all of what that entails:
+    # will call application.define_task.
+    def define_task *args, &block
+      args = [caller[0][/`.*'/][1..-2]] if args.nil? or args.empty?
+      # delegate to the application singleton
+      application.define_task *args, &block
+    end
+
+    # Set the global albacore logging level.
+    def log_level= level
+      application.logger.level = level
+    end
+
+    # Use to write to STDOUT (by default)
+    def puts *args
+      application.puts *args
+    end
+
+    def events
+      @events ||= {}
+    end
+
+    def subscribe event, &block
+      event = event.to_sym unless event.is_a? Symbol
+      events[event] ||= Set.new
+      events[event].add block
+    end
+
+    def publish event, obj
+      if events.member? event
+        events[event].each { |m| m.call(obj) }
+      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/cli.rb

@@ -0,0 +1,105 @@
+require 'albacore/version'
+require 'albacore/cross_platform_cmd'
+require 'albacore/cli_dsl'
+
+module Albacore
+  class Cli
+    include Albacore::CliDSL
+
+    def initialize args
+      # Run a semver command. Raise a CommandError if the command does not exist.
+      # Expects an array of commands, such as ARGV.
+      @args = args
+      run_command(@args.shift || :help)
+    end
+
+    private
+
+    def next_param_or_error(error_message)
+      @args.shift || raise(CommandError, error_message)
+    end
+
+    # Gets the help text if the command line is used in the wrong way
+    def help_text
+      <<-HELP
+albacore commands
+-----------------
+
+init[ialze]                        # initialize a new Rakefile with defaults
+help                               # display this help
+
+PLEASE READ https://github.com/Albacore/albacore/wiki/Albacore-binary
+      HELP
+    end
+
+    # Create a new Rakefile file if the file does not exist.
+    command :initialize, :init do
+      files = [Albacore.rakefile, Albacore.gemfile]
+      if files.any? { |file| File.exist? file }
+        puts "One of #{files.inspect} already exists"
+      else
+        File.open Albacore.gemfile, 'w+' do |io|
+          io.puts <<-DATA
+source 'https://rubygems.org'
+gem 'albacore', '~> #{Albacore::VERSION}'
+          DATA
+        end
+        Albacore::CrossPlatformCmd.system 'bundle'
+        File.open Albacore.rakefile, 'w+' do |io|
+          io.puts <<-DATA
+require 'bundler/setup'
+
+require 'albacore'
+require 'albacore/tasks/versionizer'
+require 'albacore/ext/teamcity'
+
+Albacore::Tasks::Versionizer.new :versioning
+
+desc 'Perform fast build (warn: doesn\\'t d/l deps)'
+build :quick_build do |b|
+  b.logging = 'detailed'
+  b.sln     = 'src/MyProj.sln'
+end
+
+desc 'restore all nugets as per the packages.config files'
+nugets_restore :restore do |p|
+  p.out = 'src/packages'
+  p.exe = 'tools/NuGet.exe'
+end
+
+desc 'Perform full build'
+build :build => [:versioning, :restore] do |b|
+  b.sln = 'src/MyProj.sln'
+  # alt: b.file = 'src/MyProj.sln'
+end
+
+directory 'build/pkg'
+
+desc 'package nugets - finds all projects and package them'
+nugets_pack :create_nugets => ['build/pkg', :versioning, :build] do |p|
+  p.files   = FileList['src/**/*.{csproj,fsproj,nuspec}'].
+    exclude(/Tests/)
+  p.out     = 'build/pkg'
+  p.exe     = 'tools/NuGet.exe'
+  p.with_metadata do |m|
+    m.description = 'A cool nuget'
+    m.authors = 'Henrik'
+    m.version = ENV['NUGET_VERSION']
+  end
+  p.with_package do |p|
+    p.add_file 'file/relative/to/proj', 'lib/net40'
+  end
+end
+
+task :default => :create_nugets
+          DATA
+        end
+      end
+    end
+
+    # Output instructions for using the semvar command.
+    command :help do
+      puts help_text
+    end
+  end
+end

data/lib/albacore/cli_dsl.rb

@@ -0,0 +1,43 @@
+module Albacore
+  module CliDSL
+
+    def self.included klass
+      klass.extend ClassMethods
+      klass.send :include, InstanceMethods
+    end
+
+    class CommandError < StandardError
+    end
+
+    module InstanceMethods
+      # Calls an instance method defined via the ::command class method.
+      # Raises CommandError if the command does not exist.
+      def run_command(command)
+        method_name = "#{self.class.command_prefix}#{command}"
+        if self.class.method_defined?(method_name)
+          send method_name
+        else
+          raise CommandError, "invalid command #{command}"
+        end
+      end
+    end
+
+    module ClassMethods
+      # Defines an instance method based on the first command name.
+      # The method executes the code of the given block.
+      # Aliases methods for any subsequent command names.
+      def command(*command_names, &block)
+        method_name = "#{command_prefix}#{command_names.shift}"
+        define_method method_name, &block
+        command_names.each do |c|
+          alias_method "#{command_prefix}#{c}", method_name
+        end
+      end
+
+      # The prefix for any instance method defined by the ::command method.
+      def command_prefix
+        :_run_
+      end
+    end
+  end
+end

data/lib/albacore/version.rb

@@ -1,3 +1,3 @@
 module Albacore
-  VERSION = "2.0.16"
+  VERSION = "2.1.1"
 end

data/spec/cli_spec.rb

@@ -0,0 +1,53 @@
+require 'albacore/cli'
+
+describe Albacore::Cli do
+
+  before :each do
+    # Output to a file that doesn't conflict with the project's Rakefile file.
+    @test_rake = 'Test_Rakefile'
+    @test_gem = 'Test_Gemfile'
+    Albacore.stub(:rakefile).and_return @test_rake
+    Albacore.stub(:gemfile).and_return @test_gem
+
+    # Capture the output that would typically appear in the console.
+    @original_stdout = $stdout
+    @output = StringIO.new
+    $stdout = @output
+  end
+
+  after :each do
+    # Delete the Test_Rakefile if one was created.
+    FileUtils.rm @test_rake
+    FileUtils.rm @test_gem
+
+    # Return output to its original value.
+    $stdout = @original_stdout
+  end
+
+  %w( init initialize ).each do |command|
+    describe command do
+      describe 'when no Rakefile file exists' do
+        it 'creates a new Rakefile and Gemfile' do
+          expect {
+            described_class.new [command]
+          }.to change{ File.exist?(@test_rake) }.from(false).to(true)
+        end
+      end
+      describe 'when a Rakefile file already exists' do
+        before :each do
+          FileUtils.touch @test_rake
+          FileUtils.touch @test_gem
+        end
+        it 'outputs a warning message' do
+          described_class.new [command]
+          @output.string.should match /One of \[.*\] already exists\n/
+        end
+        it "does not overwrite the existing file" do
+          expect {
+            described_class.new [command]
+          }.to_not change{ File.mtime(@test_rake) }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: albacore
 version: !ruby/object:Gem::Version
-  version: 2.0.16
+  version: 2.1.1
 platform: ruby
 authors:
 - Henrik Feldt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-24 00:00:00.000000000 Z
+date: 2014-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -101,7 +101,8 @@ description: |2
       handling the .Net compilers while making it very easy to integrate your ruby-code
       with existing dev-ops tools, such as Puppet, Chef, Capistrano or Vagrant/VirtualBox.
 email: henrik@haf.se
-executables: []
+executables:
+- albacore
 extensions: []
 extra_rdoc_files: []
 files:
@@ -115,6 +116,7 @@ files:
 - README.md
 - Rakefile
 - albacore.gemspec
+- bin/albacore
 - lib/albacore.rb
 - lib/albacore/albacore_module.rb
 - lib/albacore/app_spec.rb
@@ -122,6 +124,8 @@ files:
 - lib/albacore/app_spec/defaults.rb
 - lib/albacore/app_spec/iis_site.rb
 - lib/albacore/application.rb
+- lib/albacore/cli.rb
+- lib/albacore/cli_dsl.rb
 - lib/albacore/cmd_config.rb
 - lib/albacore/config_dsl.rb
 - lib/albacore/cpack_app_spec.rb
@@ -172,6 +176,7 @@ files:
 - spec/asmver_spec.rb
 - spec/asmver_task_spec.rb
 - spec/build_spec.rb
+- spec/cli_spec.rb
 - spec/config_dsl_spec.rb
 - spec/cross_platform_cmd_spec.rb
 - spec/dsl_spec.rb
@@ -368,6 +373,7 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
+- bin
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
@@ -392,6 +398,7 @@ test_files:
 - spec/asmver_spec.rb
 - spec/asmver_task_spec.rb
 - spec/build_spec.rb
+- spec/cli_spec.rb
 - spec/config_dsl_spec.rb
 - spec/cross_platform_cmd_spec.rb
 - spec/dsl_spec.rb