physique 0.2.2

data/lib/physique/tasks/versionizer.rb

@@ -0,0 +1,113 @@
+require 'xsemver'
+require 'albacore/logging'
+
+module Physique
+  module Tasks
+    # Versionizer does versioning ITS OWN WAY!
+    #
+    # Defines ENV vars:
+    #  * BUILD_VERSION
+    #  * NUGET_VERSION
+    #  * FORMAL_VERSION
+    #
+    # Publishes symbol :build_version
+    module Versionizer
+      # adds a new task with the given symbol to the Rake/Albacore application
+      # You can use this like any other albacore method, such as build,
+      # in order to give it parameters or dependencies, but there is no
+      # configuration object that you can configure. Copy-n-paste this
+      # code if you want something of your own.
+      #
+      def self.new(*sym)
+        version = gitflow_version(XSemVer::SemVer.find)
+        version_data = define_versions(version)
+
+        Albacore.subscribe :build_version do |data|
+          ENV['BUILD_VERSION']  = data.build_version
+          ENV['NUGET_VERSION']  = data.nuget_version
+          ENV['FORMAL_VERSION'] = data.formal_version
+          ENV['LONG_VERSION']   = data.long_version
+        end
+
+        Albacore.define_task(*sym) do
+          Albacore.publish :build_version, OpenStruct.new(version_data)
+        end
+
+        Albacore.define_task :version do
+          puts version_data.inspect
+        end
+      end
+
+      def self.define_versions(semver)
+        build = build_number
+
+        {
+          # just a monotonic inc
+          :semver         => semver,
+          :build_number   => build,
+          :current_branch => current_branch,
+
+          # purely M.m.p format
+          :formal_version => "#{semver.format('%M.%m.%p')}",
+
+          # four-numbers version, useful if you're dealing with COM/Windows
+          :long_version   => "#{semver.format('%M.%m.%p')}.#{build}",
+
+          # extensible number w/ git hash
+          :build_version  => "#{semver.format('%M.%m.%p%s')}.#{last_commit[0]}",
+
+          # nuget (not full semver 2.0.0-rc.1 support) see http://nuget.codeplex.com/workitem/1796
+          :nuget_version  => semver.format('%M.%m.%p%s')
+        }
+      end
+
+      # load the commit data
+      # returns: [short-commit :: String]
+      #
+      def self.last_commit
+        begin
+          `git rev-parse --short HEAD`.chomp[0,6]
+        rescue
+          (ENV['BUILD_VCS_NUMBER'] || '000000')[0,6]
+        end
+      end
+
+      # Determine the current branch
+      # returns: branch name
+      #
+      def self.current_branch
+        begin
+          `git rev-parse --abbrev-ref HEAD`.chomp
+        rescue
+          'master'
+        end
+      end
+
+      def self.gitflow_version(version)
+        return unless ENV.include?('BUILD_NUMBER')
+        version.special = gitflow_special
+        version
+      end
+
+      def self.build_number
+        ENV['BUILD_NUMBER'] || '0'
+      end
+
+      def self.gitflow_special
+        prefix = special_prefix
+        return version.special if prefix == 'master'
+
+        "#{prefix}#{build_number}"
+      end
+
+      def self.special_prefix
+        # TODO: There is a better way to do this.
+        branch_name = current_branch
+        return 'release' if branch_name.start_with? 'release/'
+        return 'hotfix' if branch_name.start_with? 'hotfix/'
+        return 'feature' if branch_name.start_with? 'feature/'
+        branch_name
+      end
+    end
+  end
+end

data/lib/physique/tasks_builder.rb

@@ -0,0 +1,58 @@
+require 'physique/dsl'
+require 'physique/tool_locator'
+
+module Physique
+  class TasksBuilder
+    include Albacore::DSL
+    include Albacore::Logging
+    include Physique::ToolLocator
+
+    @subclasses = []
+
+    class << self
+      attr_reader :subclasses
+    end
+
+    def self.inherited(subclass)
+      TasksBuilder.subclasses << subclass
+    end
+
+    attr_reader :solution
+
+    def self.build_tasks_for(solution)
+      TasksBuilder.subclasses.each do |builder_class|
+        builder_class.new.build_tasks_for solution
+      end
+    end
+
+    def build_tasks_for(solution)
+      @solution = solution
+      build_tasks
+    end
+
+    def build_tasks
+      raise 'This method must be implemented in your subclass'
+    end
+
+    def ensure_output_location(path)
+      # Ensure output directory exists
+      FileUtils.mkdir_p path
+    end
+
+    def namespace(name, &block)
+      name = to_string_or_symbol(name)
+      Rake.application.in_namespace(name, &block)
+    end
+
+    def to_string_or_symbol(name)
+      name = name.to_s if name.kind_of?(Symbol)
+      name = name.to_str if name.respond_to?(:to_str)
+      unless name.kind_of?(String) || name.nil?
+        raise ArgumentError, 'Expected a String or Symbol for a namespace name'
+      end
+      name
+    end
+  end
+end
+
+Gem.find_files('physique/task_builders/*.rb').each { |path| require path }

data/lib/physique/tool_locator.rb

@@ -0,0 +1,42 @@
+require 'map'
+require 'albacore'
+
+module Physique
+  module ToolLocator
+    include Albacore::Logging
+
+    # Allows you to locate a tool on disk given a file specification. For example...
+    #
+    #   locate_tool 'C:/Program Files/Microsoft SQL Server/**/Tools/Binn/SQLCMD.EXE'
+    #
+    # The tool sorts any matching executables in descending order to that the most recent version is returned. To
+    # change this behavior call the method with the reverse option.
+    #
+    #   locate_tool 'C:/path/to/**/tool.exe', reverse: false
+    #
+    # Throws a ToolNotFoundError if no tool could be found.
+    def locate_tool(paths, options = {})
+      # FileList only correctly handles forward-slashes, even on Windows
+      paths = paths.gsub('\\', '/')
+
+      info { "Extracting paths from the following pattern #{paths}" }
+      paths = FileList[paths] unless paths.respond_to?(:each)
+
+      info { "Attempting to locate tool in the following paths #{paths}" }
+      opts = Map.options(options)
+      opts = opts.apply :reverse => true
+      paths = paths.collect { |p| which(p) }.compact.sort
+      paths = paths.reverse if opts[:reverse]
+      tool = paths.first
+
+      raise ToolNotFoundError, "Could not find tool in the following paths: \n #{paths}" if tool.nil?
+      tool
+    end
+
+    def which(exe)
+      Albacore::CrossPlatformCmd.which(exe) ? exe : nil;
+    end
+
+    class ToolNotFoundError < Exception; end
+  end
+end

data/lib/physique/version.rb

@@ -0,0 +1,3 @@
+module Physique
+  VERSION = '0.2.2'
+end

data/physique.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'physique/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'physique'
+  spec.version       = Physique::VERSION
+  spec.authors       = ['Robert Scaduto']
+  spec.email         = ['rscaduto@thirdwave.it']
+  spec.description   = %q{Beautiful builds for .NET projects}
+  spec.summary       = %q{A conventional build framework supporting NUnit, FluentMigrator and Octopus Deploy}
+  spec.homepage      = 'http://github.com/scardetto/physique'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec', '2.14.1'
+  spec.add_dependency 'activesupport', '~> 4.1'
+  spec.add_dependency 'map', '~> 6.5'
+  spec.add_dependency 'albacore', '2.0.0.rc.12'
+end

data/spec/config_spec.rb

@@ -0,0 +1,22 @@
+require 'physique'
+
+describe Physique::FluentMigratorConfig do
+  it 'should find full project path when specifying the name and language' do
+    project_name = 'Test.Database'
+    opts = Physique::FluentMigratorConfig.new.tap { |c|
+      c.project = project_name
+      c.lang = :vb
+    }.opts
+
+    expect(opts.project_file).to eq("src/#{project_name}/#{project_name}.vbproj")
+  end
+
+  it 'should default to the cs programming language' do
+    project_name = 'Test.Database'
+    opts = Physique::FluentMigratorConfig.new.tap { |c|
+      c.project = project_name
+    }.opts
+
+    expect(opts.project_file).to eq("src/#{project_name}/#{project_name}.csproj")
+  end
+end

data/spec/project_spec.rb

@@ -0,0 +1,26 @@
+require 'physique/project'
+
+describe Physique::Project do
+  it 'should echo the path when full project file name is provided' do
+    project_name = 'test.csproj'
+    expect(get_path(project_name)).to eq(project_name)
+  end
+
+  it 'should return the full path when partial project file name is provided' do
+    project_name = 'TestProject.Domain'
+    expect(get_path(project_name)).to eq("src/#{project_name}/#{project_name}.csproj")
+  end
+
+  it 'should handle multiple languages' do
+    project_name = 'TestProject.Domain'
+    language = 'vb'
+    expect(get_path(project_name, language)).to eq("src/#{project_name}/#{project_name}.vbproj")
+
+    language = 'fs'
+    expect(get_path(project_name, language)).to eq("src/#{project_name}/#{project_name}.fsproj")
+  end
+
+  def get_path(name, ext = 'cs')
+    ::Physique::Project.get_path(name, ext)
+  end
+end

data/spec/solution_spec.rb

@@ -0,0 +1,12 @@
+require 'physique'
+
+describe Physique::CompileConfig do
+
+  describe 'By default' do
+    before(:all) { @config = Physique::CompileConfig.new }
+
+    it 'should set the build configuration to Release' do
+      expect(@config.opts.configuration).to eq('Release')
+    end
+  end
+end

data/spec/sqlcmd_spec.rb

@@ -0,0 +1,146 @@
+require 'physique'
+require 'physique/tasks/sqlcmd'
+
+describe Physique::SqlCmd::Config do
+  if ::Rake::Win32.windows?
+    describe 'When initialized with the minimum required values' do
+      before(:all) do
+        @opts = Physique::SqlCmd::Config.new.tap { |c|
+          c.server_name = 'server'
+          c.command = 'command'
+        }.opts
+      end
+
+      it 'should find sqlcmd tool' do
+        expect(@opts[:exe]).to match(/sqlcmd/i)
+      end
+
+      it 'should break on errors' do
+        expect(@opts[:continue_on_errors]).to be_false
+      end
+
+      it 'should set the server name' do
+        expect(@opts[:server_name]).to eq('server')
+      end
+    end
+
+    describe 'When initialized with a command' do
+      before(:all) do
+        @opts = Physique::SqlCmd::Config.new.tap { |c|
+          c.server_name = 'server'
+          c.command = 'command'
+        }.opts
+      end
+
+      it 'should set the command' do
+        expect(@opts[:command]).to eq('command')
+      end
+
+      it 'should set the source to :command' do
+        expect(@opts[:source]).to eq(:command)
+      end
+    end
+
+    describe 'When initialized with a file' do
+      before(:all) do
+        @opts = Physique::SqlCmd::Config.new.tap { |c|
+          c.server_name = 'server'
+          c.file = 'test.sql'
+        }.opts
+      end
+
+      it 'should set the file' do
+        expect(@opts[:file]).to eq('test.sql')
+      end
+
+      it 'should set the source to :file' do
+        expect(@opts[:source]).to eq(:file)
+      end
+    end
+
+    describe 'When initialized with both a file and a command' do
+      before(:all) do
+        @opts = Physique::SqlCmd::Config.new.tap { |c|
+          c.server_name = 'server'
+          c.command = 'command'
+          c.file = 'file'
+        }.opts
+      end
+
+      it 'should give precedence to the command' do
+        expect(@opts[:source]).to eq(:command)
+      end
+    end
+  end
+end
+
+describe Physique::SqlCmd::Cmd do
+  describe 'When configured with a file' do
+    before(:all) do
+      opts = Physique::SqlCmd::Config.new.tap { |c|
+        c.server_name = 'server'
+        c.database_name = 'database'
+        c.file = 'test.sql'
+      }.opts
+
+      @cmd = Physique::SqlCmd::Cmd.new opts
+    end
+
+    it 'should break on errors' do
+      expect(@cmd.parameters).to include('-b')
+    end
+
+    it 'should include the server name' do
+      expect(@cmd.parameters).to include('-S server')
+    end
+
+    it 'should include the database name' do
+      expect(@cmd.parameters).to include('-d database')
+    end
+
+    it 'should include the file name' do
+      expect(@cmd.parameters).to include('-i test.sql')
+    end
+  end
+
+  describe 'When configured with a command' do
+    before(:all) do
+      opts = Physique::SqlCmd::Config.new.tap { |c|
+        c.server_name = 'server'
+        c.command = 'command'
+      }.opts
+
+      @cmd = Physique::SqlCmd::Cmd.new opts
+    end
+
+    it 'should break on errors' do
+      expect(@cmd.parameters).to include('-b')
+    end
+
+    it 'should include the server name' do
+      expect(@cmd.parameters).to include('-S server')
+    end
+
+    it 'should include the command in single quotes' do
+      expect(@cmd.parameters).to include("-Q 'command'")
+    end
+  end
+
+  describe 'When setting variables' do
+    before(:all) do
+      opts = Physique::SqlCmd::Config.new.tap { |c|
+        c.server_name = 'server'
+        c.command = 'command'
+        c.set_variable 'test_variable1', 'test_value1'
+        c.set_variable 'test_variable2', 'test_value2'
+      }.opts
+
+      @cmd = Physique::SqlCmd::Cmd.new opts
+    end
+
+    it 'should add multiple variables to the command line' do
+      expect(@cmd.parameters).to include("-v test_variable1=test_value1")
+      expect(@cmd.parameters).to include("-v test_variable2=test_value2")
+    end
+  end
+end