albacore 0.3.6 → 0.6.2.rc1

data/.gitignore

@@ -1,24 +1,5 @@
-*.swp
-*~
-.idea
-
 Gemfile.lock
-
+tmp/
+*.swp
 pkg/
-obj/
-bin/
-build/
-
-_ReSharper.*
-*.csproj.user
-*.resharper.user
-*.resharper
-*.suo
-*.cache
-~$*
-*.tmp
-*.eprj
-*.bkp
-
-/spec/support/Tools/NDepend-v2.12/NDependProLicense.xml
-Gemfile.lock
+.DS_Store

data/.travis.yml

@@ -1,15 +1,13 @@
-language: ruby
-rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - jruby
-script: "bundle exec rake specs:assemblyinfo specs:albacoremodel specs:attrmethods"
-branches:
-  only:
-    - dev
-#env:
-bundler_args: --without=wiki
-notifications:
-  email: false
-gemfile: Gemfile
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby
+script: "bundle exec rake spec"
+branches:
+  only:
+    - clean_slate
+#env:
+notifications:
+  email: false
+
+gemfile: Gemfile

data/Gemfile

@@ -1,13 +1,14 @@
-#ruby=1.9.3
-#ruby-gemset=albacore
-source 'http://rubygems.org'
-gemspec
-gem 'nokogiri'
-gem 'guard'
-gem 'guard-rspec'
-gem 'rake'
-gem 'rspec'
-
-group :wiki do
-  gem 'jekyll'
-end
+#ruby=1.9.3
+#ruby-gemset=albacore_clean_slate
+
+source "http://rubygems.org"
+
+# Windows Rubies (RubyInstaller)
+platforms :mswin, :mingw do
+  gem 'wdm' # for listening to Windows Directory Notifications
+end
+
+# needed to do development and read the version of albacore
+gem 'nokogiri', '~>1.5'
+
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+end
+

data/README.md

@@ -0,0 +1,148 @@
+# Albacore Clean Slate
+
+[![Build Status](https://secure.travis-ci.org/Albacore/albacore.png?branch=clean_slate)](http://travis-ci.org/Albacore/albacore)
+
+This branch is the next official version. It is currently being used for
+numerous builds for us and is free of known bugs. It works on RMI 1.9.3 and
+jRuby.
+
+## getting started
+
+In a command prompt, run:
+
+    @powershell -NoProfile -ExecutionPolicy unrestricted -Command "iex ((new-object net.webclient).DownloadString('http://chocolatey.org/install.ps1'))" && SET PATH=%PATH%;%systemdrive%\chocolatey\bin
+
+Then start a new powershell, cygwin or mingw32 shell. You can now install the
+Ruby framework:
+
+    cinst ruby.devkit
+
+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:
+
+    gem install bundler
+
+Bundler is a tool that fetches gems for you. Now, specify what ruby gems your
+build will use. Create a new file, named `Gemfile`. This file should look like
+this:
+
+    source 'http://rubygems.org'
+    gem "albacore", :git => "git://github.com/Albacore/albacore.git", :branch => 'clean_slate'
+
+Now, install albacore from this repository by running:
+
+    bundle
+
+In order to build your project, you need to create a `Rakefile`, with contents
+like these:
+
+    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 "Perform full build"
+    build :build => [:versioning, :restore] do |b|
+      b.sln = 'src/MyProj.sln'
+    end
+
+    directory 'build/pkg'
+
+    nugets_restore :restore do |p|
+      p.out = 'src/packages'
+      p.exe = 'buildsupport/NuGet.exe'
+    end
+
+    desc "package nugets"
+    nugets_pack :create_nugets => ['build/pkg', :versioning, :build] do |p|
+      p.files   = FileList['src/**/*.{csproj,fsproj,nuspec}'].
+        exclude('src/Fsharp.Actor/*.nuspec').
+        exclude(/Tests/).
+        exclude(/Spec/).
+        exclude(/sample/).
+        exclude(/packages/)
+      p.out     = 'build/pkg'
+      p.exe     = 'buildsupport/NuGet.exe'
+      p.version = ENV['NUGET_VERSION']
+    end
+ 
+You can now run:
+
+    rake
+
+## hack guidelines
+
+Use pair-of-three: `Cmd`, `Config` and `Task`. Add Rakefile-methods in `dsl.rb`.
+You can `include CmdConfig` in your `Config` to get access to parameters, and do
+`include CrossPlatformCmd` in your `Cmd` to get correct cross-platform, logging
+and invocation of system and shell statements.
+
+Read the READMEs in the `lib/ext` and `lib/tasks` folders. Write unit-tests for
+your functionality. Try to make the execution of the command that you have
+prepared be a single line of code that does something like: `sh make_command`
+thereby delegating to `CrossPlatformCmd`. To ignore exit codes, call `shie`
+instead.
+
+Use and document `attr_accessor` in `Config` with [TomDoc](http://tomdoc.org/),
+so that docs can be automatically generated. Have sane defaults. If an option is
+true/false, have a sane default and provide a method that sets the opposite.
+Document the default. Document required properties to set. Don't set properties
+by providing single-parameter methods, because it's confusing with regards to
+reading those same properties.
+
+'Execute' the configuration as much as possible when configuring it through the
+DSL block, but don't do side-effects other than fail bad config. Remember that
+multiple interactions with the `Config` object is desired. Do side-effects when
+the task is run.
+
+How to write commands:
+
+    require 'map'
+
+    # ...
+
+    def initialize executable, *args
+      opts = Map.options(args)
+      @executable = executable  
+    end
+
+In general: look at the written code and do something similar =).
+
+Provide further blocks/lambdas/procs, passed from the `Config` to the `Task` or
+even `Cmd` if you need to decide values when the task is run. This makes it
+easier to compose tasks.
+
+I use a vague concept of 'core albacore' for tasktypes (nugets_restore,
+nugets_pack, build) and 'extensions' for things that depend on published
+symbols, and 'tasks' for things that can be instantiated (added to the Rake
+Tasks collection) in the Rakefile. Your extension probably is a 'task' or
+'extension'.
+
+Use ideomatic ruby. If you have more than 3 levels of indentation in a method,
+you're probably not being ideomatic. Can you use a higher-level language
+construct or the null-object pattern or some functional programming concept that
+makes the code easier to read, reason about and maintain? Don't mutate unless
+you have to - code that doesn't mutate much can be gotten by using the builder
+pattern (`Config` is the builder most of the time); then, a lot of the logic of
+how to construct the command-line/expression to run, can be done in the
+constructor (`Cmd#initialize`), rather than when executing it.
+
+## Links
+
+ * http://guides.rubygems.org/make-your-own-gem/
+ * http://postmodern.github.com/2012/05/22/rubygems-tasks.html
+ * https://github.com/guard/guard-rspec
+ * http://barkingiguana.com/2011/12/13/how-i-structure-rubygems/
+ * http://rakeroutes.com/blog/lets-write-a-gem-part-one/
+ * https://github.com/sj26/ruby-1.9.3-p0/blob/master/lib/rake/application.rb
+ * https://github.com/sj26/ruby-1.9.3-p0/blob/master/lib/rake/rake_module.rb

data/Rakefile

@@ -1,25 +1,9 @@
-require 'bundler/setup'
-Bundler::GemHelper.install_tasks
-
-task :default => :'specs:all'
-
-namespace :specs do
-  require 'rspec/core/rake_task'
-
-  desc "Run all specs"
-  RSpec::Core::RakeTask.new(:all)
-
-  # generate tasks for each *_spec.rb file in the root spec folder
-  exceptNCov = []
-  FileList['spec/*_spec.rb'].each do |fname|
-    spec = $1 if /spec\/(.+)_spec\.rb/ =~ fname
-    exceptNCov << spec unless /ncover|ndepend/ =~ spec
-    desc "Run the #{spec} spec"
-    RSpec::Core::RakeTask.new spec do |t|
-      t.pattern = "spec/#{spec}*_spec.rb"
-    end
-  end
-
-  desc "Run specs:all except :ncover, :ndepend"
-  task :except_ncover => exceptNCov
-end
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |c|
+  c.rspec_opts = ['--color', '--format=doc']
+end
+
+task :default => :build

data/albacore.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 
 $:.push File.expand_path("../lib", __FILE__)
-require 'version'
+require 'albacore/version'
 
 Gem::Specification.new do |s|
   s.name        = 'albacore'
@@ -11,13 +11,28 @@ 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.description = 'Easily build your .Net or Mono project using this collection of Rake tasks.'
-
-  s.add_dependency 'rubyzip', '< 1.0.0'
+  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,
+    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.
+EOF
 
   s.rubyforge_project = 'albacore'
 
+  s.add_dependency 'rake', '>10' # this gem builds on rake
+  s.add_dependency 'map', '~>6.5' # https://github.com/ahoward/map for options handling
+  s.add_dependency 'nokogiri', '~> 1.5' # used to manipulate and read *proj files
+  s.add_dependency 'facter', '~> 1.7' # used to gather system data
+  s.add_dependency 'semver2', '~> 3.3'
+  s.add_dependency 'ProcessPilot', '~> 2.0'
+  s.add_dependency 'highline', '~> 1.6'
+	
+  s.add_development_dependency 'rubygems-tasks', '~>0.2'
+  s.add_development_dependency 'rspec', '>= 2.13'
+
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  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']
 end

data/lib/albacore.rb

@@ -1,9 +1,3 @@
-albacore_root = File.expand_path(File.dirname(__FILE__))
-$: << albacore_root
-$: << File.join(albacore_root, "albacore")
-$: << File.join(albacore_root, "albacore", 'support')
-$: << File.join(albacore_root, "albacore", 'config')
-
-IS_IRONRUBY = (defined?(RUBY_ENGINE) && RUBY_ENGINE == "ironruby")
-
-Dir.glob(File.join(albacore_root, 'albacore/*.rb')).each {|f| require f }
+require 'albacore/version'
+require 'albacore/albacore_module'
+require 'albacore/dsl'

data/lib/albacore/albacore_module.rb

@@ -0,0 +1,53 @@
+require 'albacore/application'
+
+# 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
+      # 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
+  end
+end

data/lib/albacore/application.rb

@@ -0,0 +1,32 @@
+require 'rake'
+module Albacore
+  class Application
+
+    # the logger instance for this application
+    attr_reader :logger
+
+    # the output IO for this application, defaults to
+    # STDOUT
+    attr_reader :output
+    
+    # initialize a new albacore application with a given log IO object
+    def initialize log = STDOUT, output = STDOUT
+      raise ArgumentError, "log must not be nil" if log.nil?
+      raise ArgumentError, "output must not be nil" if output.nil?
+      @logger = Logger.new log
+      @logger.level = Logger::INFO
+      @logger.formatter = proc do |severity, datetime, progname, msg|
+        "#{severity[0]} #{datetime.to_datetime.iso8601(6)}: #{msg}\n"
+      end
+      @output = output
+    end
+
+    def define_task *args, &block
+      Rake::Task.define_task *args, &block
+    end
+
+    def puts *args
+      @output.puts *args 
+    end
+  end
+end

data/lib/albacore/asmver.rb

@@ -0,0 +1,67 @@
+# -*- encoding: utf-8 -*-
+
+require 'set'
+require 'albacore/logging'
+require 'albacore/cross_platform_cmd'
+require 'albacore/errors/unfilled_property_error'
+require 'albacore/asmver/cs'
+require 'albacore/asmver/vb'
+require 'albacore/asmver/cpp'
+require 'albacore/asmver/fs'
+
+module Albacore
+  module AsmVer
+    class Cmd
+      include Logging
+      def initialize project
+        trace "intializing cmd with #{project.inspect}"
+        @parameters = Set.new
+      end
+      def execute
+      end
+    end
+    class Config
+      # :prefix sets the filename prefix (excluding extension) to generate
+      attr_accessor :version, :files, :prefix
+      
+      def initialize
+        @files_config = proc { |project_root|  }
+      end
+      
+      # lets the Rakefile configure the path to the Assembly Info
+      def out_file &config_block
+        @files_config = config_block
+      end
+      
+      Project = Struct.new(:file_path, :dir_path, :lang_ext, :version, :asminfo_path)
+    
+      # return all project meta-datas
+      def projects
+        raise ArgumentError, "config.files must respond to #each/1" unless @files.respond_to? :each
+        raise UnfilledPropertyError, "version", "must be set: ver.version = '2.4.5'" unless @version
+        @files.collect { |f|
+          proj = Project.new(f, File.dirname(f), guess_lang_ext(f), @version)
+          proj.asminfo_path = @files_config.call proj.dir_path, proj
+          proj
+        }
+      end
+      
+      private
+      def guess_lang_ext path
+        case File.extname path
+          when ".fsproj" then ".fs"
+          when ".csproj" then ".cs"
+          when ".vbproj" then ".vb"
+        end
+      end
+    end
+    class Task
+      def initialize cmd
+        @cmd = cmd
+      end
+      def execute
+        @cmd.execute
+      end
+    end
+  end
+end