alpacabuildtool 1.0.0

data/lib/alpacabuildtool/package_types/tool_package.rb

@@ -0,0 +1,53 @@
+require 'fileutils'
+
+module AlpacaBuildTool
+  ##
+  # ProjectPackage provides configuration of normal nuget packages created
+  # from projects
+  class ToolPackage
+    ##
+    # Defines workspace where files should be copied for further packaging
+    # and where *.nuspec, readme and changelog should be created
+    # For now it's ~/.workspace
+    WORKSPACE = File.join(File.expand_path('~'), '.workspace/')
+
+    ##
+    # Creates an instance
+    #
+    # +package_id+:: package id so workspace is not messed up
+    # +project+:: project to be used to create a package
+    # +debug+:: is debug configuration should be used to create a package
+    #
+    # *It clean workspace/package_id folder and copy files from project/bin*
+    def initialize(package_id, project, debug)
+      workspace = File.join(WORKSPACE, package_id)
+      FileUtils.rm_rf(workspace)
+      FileUtils.makedirs(workspace + '/tools')
+      tool_path = File.join(project.dir, 'bin', debug ? 'Debug' : 'Release')
+      FileUtils.copy_entry(tool_path, workspace + '/tools')
+      @nuspec_file = File.join(workspace, "#{package_id}.nuspec")
+      @readme_file = File.join(workspace, 'README.txt')
+      @changelog_file = File.join(workspace, 'CHANGES.txt')
+    end
+
+    ##
+    # Returns array of files: *.nuspec, CHANGELOG.txt, README.txt
+    def files
+      [@nuspec_file, @changelog_file, @readme_file]
+    end
+
+    def options
+      [@nuspec_file]
+    end
+
+    ##
+    # Returns false so Nuspec file creation process will not store readme and
+    # changelog files into <files/> entry
+    #
+    # This is required for tools packages as they are created from folder
+    # and they will miss tool files if <files/> entry will exist in *.nuspec
+    def add_files?
+      false
+    end
+  end
+end

data/lib/alpacabuildtool/tools/git.rb

@@ -0,0 +1,22 @@
+module AlpacaBuildTool
+  ##
+  # Git provides methods to help with git version control tool
+  module Git
+    ##
+    # Returns string with changes in dir
+    #
+    # +dir+:: specific dir where to look for changes
+    # +commit_from+:: commit from which look for changes(nil by default to
+    # look for all changes)
+    def self.changes(dir, commit_from = nil)
+      return `git log -- #{dir}` unless commit_from
+      `git log #{commit_from}..HEAD -- #{dir}`
+    end
+
+    ##
+    # Returns current revision id
+    def self.revision
+      `git rev-parse HEAD`
+    end
+  end
+end

data/lib/alpacabuildtool/tools/msbuild.rb

@@ -0,0 +1,29 @@
+require 'alpacabuildtool/tools/tool'
+
+module AlpacaBuildTool
+  ##
+  # MSBuild provides access to MSBuild.exe tool
+  class MSBuild < Tool
+    ##
+    # Build *.sln file
+    #
+    # +file+:: solution file with absolute path
+    # +debug+:: set to build with debug configuration
+    def build(file, debug = false)
+      config = @configuration['options'].dup
+      config['Property'] ||= {}
+      config['Property']['Configuration'] = debug ? 'Debug' : 'Release'
+      call([config, file])
+    end
+
+    private
+
+    def format_option(name, value, switch)
+      case value
+      when Array then value = value.join(';')
+      when Hash then value = value.map { |k, v| "#{k}=#{v}" }.join(';')
+      end
+      super name, value, switch
+    end
+  end
+end

data/lib/alpacabuildtool/tools/nuget.rb

@@ -0,0 +1,49 @@
+require 'fileutils'
+require 'alpacabuildtool/tools/tool'
+
+module AlpacaBuildTool
+  # tool
+  class Nuget < Tool
+    def restore(solution_file)
+      run_command 'restore', solution_file
+    end
+
+    def install(package,
+                outputdir = nil,
+                prerelease = false,
+                exclude_version = false,
+                source = nil)
+      extra_options = {}
+      extra_options['OutputDirectory'] = outputdir if outputdir
+      extra_options['Prerelease'] = prerelease if prerelease
+      extra_options['ExcludeVersion'] = exclude_version if exclude_version
+      extra_options['Source'] = source if source
+      run_command 'install', package, extra_options
+    end
+
+    def pack(nuspec_or_project, configuration = nil)
+      extra_options = {}
+      extra_options['Prop'] = "Configuration=#{configuration}" if configuration
+      run_command 'pack', nuspec_or_project, extra_options
+    end
+
+    def push(package, source)
+      run_command 'install', package, 'Source' => source
+    end
+
+    private
+
+    def run_command(command, arguments, extra_options = nil)
+      options = @configuration['options'] || {}
+      options.merge!((@configuration['commands'] || {})[command] || {})
+      options.merge! extra_options if extra_options
+      output_dir = options['OutputDirectory']
+      FileUtils.makedirs output_dir if output_dir
+      call([command, arguments, options].flatten)
+    end
+
+    def format_option(name, value, switch)
+      switch ? "-#{name}" : "-#{name} #{encapsulate(value)}"
+    end
+  end
+end

data/lib/alpacabuildtool/tools/nunit.rb

@@ -0,0 +1,28 @@
+require 'fileutils'
+require 'alpacabuildtool/tools/tool'
+
+module AlpacaBuildTool
+  ##
+  # NUnit provides access to nunit-console.exe tool
+  class NUnit < Tool
+    ##
+    # Runs tests from project
+    #
+    # +project+:: project file with absolute path
+    # +debug+:: set to run test with debug configuration
+    def test(project, debug)
+      options = @configuration['options']
+      options['config'] = 'Debug' if debug
+      FileUtils.makedirs options['work'] if options['work']
+      FileUtils.makedirs File.dirname(options['output']) if options['output']
+      call([options, project])
+    end
+
+    private
+
+    def format_option(name, value, switch)
+      name = (name.to_s.length == 1 ? '-' : '--') + name.to_s
+      switch ? name : "#{name} #{encapsulate(value)}"
+    end
+  end
+end

data/lib/alpacabuildtool/tools/nunit_orange.rb

@@ -0,0 +1,18 @@
+require 'fileutils'
+require 'alpacabuildtool/tools/tool'
+
+module AlpacaBuildTool
+  ##
+  # NUnitOrange provides access to NUnitOrange.exe tool
+  class NUnitOrange < Tool
+    ##
+    # Convert NUnit test results
+    def convert
+      input = @configuration['input']
+      return log.warn 'no nunit test results found' unless File.exist? input
+      FileUtils.makedirs File.dirname(@configuration['output'])
+      output = @configuration['output']
+      call([input, output])
+    end
+  end
+end

data/lib/alpacabuildtool/tools/open_cover.rb

@@ -0,0 +1,29 @@
+require 'fileutils'
+require 'alpacabuildtool/tools/wrapper'
+
+module AlpacaBuildTool
+  ##
+  # OpenCover provides access to OpenCover.exe tool
+  class OpenCover < Wrapper
+    ##
+    # Runs coverage by running inner tool
+    #
+    # accepts &block for inner tool
+    #
+    #    coverage_tool = package_manager.get('OpenCover', test_tool)
+    #    coverage_tool.call do |tool|
+    #      tool.test(project.file, debug)
+    #    end
+    def call(&block)
+      options = @configuration.fetch('options')
+      FileUtils.makedirs File.dirname(options['output']) if options['output']
+      super([options], &block)
+    end
+
+    private
+
+    def format_option(name, value, switch)
+      switch ? "-#{name}" : "-#{name}:#{encapsulate(value)}"
+    end
+  end
+end

data/lib/alpacabuildtool/tools/report_generator.rb

@@ -0,0 +1,25 @@
+require 'fileutils'
+require 'alpacabuildtool/tools/tool'
+
+module AlpacaBuildTool
+  ##
+  # ReportGenerator provides access to ReportGenerator.exe tool
+  class ReportGenerator < Tool
+    ##
+    # Convert OpenCover results
+    def convert
+      options = @configuration['options'] || {}
+      unless File.exist? options['reports']
+        return log.warn 'no coverage results found'
+      end
+      FileUtils.makedirs options['targetdir'] if options['targetdir']
+      call([options])
+    end
+
+    private
+
+    def format_option(name, value, switch)
+      switch ? "-#{name}" : "-#{name}:#{encapsulate(value)}"
+    end
+  end
+end

data/lib/alpacabuildtool/tools/tool.rb

@@ -0,0 +1,84 @@
+require 'mkmf'
+require 'alpacabuildtool/log/log'
+require 'English'
+
+module AlpacaBuildTool
+  ##
+  # Tool provides basic functionality for console tools
+  class Tool
+    include Log
+
+    ##
+    # Creates an instance
+    # It check if configuration contains 'exe' which is executable
+    # If no then tries to find executable in PATH environment variable
+    # If not found then get exe from block passed
+    #
+    # +configuration+:: hash with tool configuration
+    # accepts &block with tool extended initialization if exe not found
+    #
+    #    Tool.new config do
+    #      exe_pattern = File.join(DOWNLOAD_DIR, '**', config['exe'])
+    #      install(config['id'], DOWNLOAD_DIR, true)
+    #      Dir.glob(exe_pattern).first # return executable
+    #    end
+    def initialize(configuration)
+      @configuration = configuration.dup
+      @exe = @configuration['exe'] || ''
+      @exe = find_executable @exe unless File.executable? @exe
+      @exe = yield unless @exe || !block_given?
+      @exe = encapsulate(@exe) if @exe.to_s.include? ' '
+    end
+
+    ##
+    # Execute tool in console with arguments
+    #
+    # +args+:: tool arguments
+    #
+    #    tool.call(['file.cs', {c: true, type: 'test'}])
+    #    # >> tool.exe file.cs /c /type:test
+    def call(args)
+      cmd = ([@exe] + format_arguments(args)).join ' '
+      log.info ">> #{cmd}\n"
+      execute cmd
+    end
+
+    private
+
+    def format_arguments(arguments)
+      arguments.map do |argument|
+        case argument
+        when String then encapsulate argument
+        when Hash then flatten argument
+        else argument.to_s
+        end
+      end
+    end
+
+    def encapsulate(object)
+      case object.to_s
+      when /^".* .*"$/ then object.to_s
+      when /^.* .*$/ then "\"#{object}\""
+      else object.to_s
+      end
+    end
+
+    def flatten(argument)
+      argument.map do |key, value|
+        switch = value.nil? || value == true || value == false
+        format_option key, value, switch
+      end
+    end
+
+    def format_option(name, value, switch)
+      switch ? "/#{name}" : "/#{name}:#{encapsulate(value)}"
+    end
+
+    def execute(cmd)
+      result = system cmd
+      fail "unknown command \"#{cmd}\"" if result.nil?
+      fail "call #{cmd}\nfailed: #{$CHILD_STATUS}" if result == false
+      result
+    end
+  end
+end

data/lib/alpacabuildtool/tools/wrapper.rb

@@ -0,0 +1,66 @@
+require 'alpacabuildtool/tools/tool'
+
+module AlpacaBuildTool
+  ##
+  # Wrapper represents console tools that execute other console tools inside
+  # their own process (like OpenCover, Ssh...)
+  class Wrapper < Tool
+    ##
+    # Creates an instance
+    # Overrides Tool initialization by adding tool that should be executed later
+    #
+    # +configuration+:: wrapper tool configuration
+    # +tool+:: tool to be used inside wrapper tool
+    def initialize(configuration, tool)
+      super(configuration)
+      @tool = tool.dup
+      wrap_tool
+    end
+
+    ##
+    # Execute wrapper tool with arguments
+    #
+    # +args+:: wrapper tool arguments
+    # requires &block to be executed against inner tool
+    #
+    #   wrapper.call([debug: true]) do |tool|
+    #      tool.call(['file.cs', {c: true, type: 'test'}])
+    #   end
+    #   # >> wrapper.exe /target:'tool.exe' /targetargs:'file.cs /c /type:test'
+    #   # /debug
+    def call(args)
+      yield @tool
+      @target = encapsulate(@tool.exe)
+      @target_args = encapsulate(@tool.arguments)
+      super(args)
+    end
+
+    private
+
+    def wrap_tool
+      @tool.instance_eval do
+        def call(args)
+          @arguments = format_arguments(args).join ' '
+        end
+        self.class.__send__(:attr_reader, 'exe')
+        self.class.__send__(:attr_reader, 'arguments')
+      end
+    end
+
+    def format_arguments(arguments)
+      super arguments.map { |arg| detokenize_tool arg }
+    end
+
+    def detokenize_tool(object)
+      if object.is_a? String
+        return object.gsub('#{EXE}', @target).gsub('#{ARGS}', @target_args)
+      end
+      if object.is_a? Hash
+        object.keys.each do |key|
+          object[key] = detokenize_tool(object[key])
+        end
+      end
+      object
+    end
+  end
+end

data/lib/alpacabuildtool/versioning/version.rb

@@ -0,0 +1,163 @@
+require 'yaml'
+
+module AlpacaBuildTool
+  # Version contains semantic version and methods
+  # for updating it
+  class Version
+    attr_reader :major, :minor, :patch, :special, :metadata, :file
+    attr_writer :metadata
+
+    ##
+    # PreRelease acceptable tags
+    PRE_RELEASE = %w(alpha beta rc)
+
+    errors = %w(InvalidFile WrongDimension AlreadyPreRelease AlreadyRelease
+                FileNotFound MajorVersionNotInt MinorVersionNotInt
+                PatchVersionNotInt SpecialNotRecognized NotPreRelease
+                PreReleaseTagReachedFinalVersion)
+    errors.each { |error| const_set(error, Class.new(StandardError)) }
+
+    ##
+    # Creates new instance
+    #
+    # +hash+:: Hash with version data:
+    # :file - file with path to .semver file
+    # :major - major version
+    # :minor - minor version
+    # :patch - patch version
+    # :special - special version
+    # :metadata - metadata
+    def initialize(hash)
+      @file = hash.fetch(:file) { fail InvalidFile }
+      @major = hash.fetch(:major) { fail InvalidFile }
+      @minor = hash.fetch(:minor) { fail InvalidFile }
+      @patch = hash.fetch(:patch) { fail InvalidFile }
+      @special = hash.fetch(:special) { fail InvalidFile }
+      @metadata = hash.fetch(:metadata) { fail InvalidFile }
+      validate
+    end
+
+    ##
+    # Formatting version to string
+    #
+    # +format+:: format of version representation
+    # %M - Major
+    # %m - Minor
+    # %p - Patch
+    # %s - Special (adds '-')
+    # %d - Metadata (adds '+')
+    #
+    #   v.inspect
+    #     # =>  #<AlpacaBuildTool::Version:0x000000031aca90
+    #     #       @file="d:/Learning/Ruby/alpaca/.semver",
+    #     #       @major=1,
+    #     #       @minor=2,
+    #     #       @patch=3,
+    #     #       @special="rc",
+    #     #       @metadata="03fb4">
+    #   v.format 'v%M.%m.%p%s%d'
+    #     # => "v1.2.3-rc+03fb4"
+    def to_s(format = 'v%M.%m.%p%s%d')
+      result = format.gsub '%M', @major.to_s
+      result.gsub! '%m', @minor.to_s
+      result.gsub! '%p', @patch.to_s
+      result.gsub!('%s', prerelease? ? "-#{@special}" : '')
+      result.gsub!('%d', metadata? ? "+#{@metadata}" : '')
+      result
+    end
+
+    ##
+    # Returns yaml representation that can be stored to .semver file
+    def to_yaml
+      YAML.dump(major: @major, minor: @minor, patch: @patch,
+                special: @special, metadata: @metadata)
+    end
+
+    ##
+    # Returns true if #special isn't empty. Otherwise, false.
+    def prerelease?
+      !@special.nil? && !@special.empty?
+    end
+
+    ##
+    # Returns true if #metadata isn't empty. Otherwise, false.
+    def metadata?
+      !@metadata.nil? && !@metadata.empty?
+    end
+
+    ##
+    # Increase version following semantic version rules
+    #
+    # +dimension+:: one of the dimensions:
+    #   :major       # increase major and reset lower versions
+    #   :minor       # increase minor and reset lower versions
+    #   :patch       # increase patch and reset lower versions
+    #   :prerelease  # increase prerelease tag
+    def increase(dimension)
+      case dimension
+      when :major then increase_major
+      when :minor then increase_minor
+      when :patch then increase_patch
+      when :prerelease then increase_prerelease
+      else fail WrongDimension
+      end
+    end
+
+    ##
+    # Set version to prerelease by adding 'alpha' to special
+    def make_prerelease
+      fail AlreadyPreRelease if prerelease?
+      @special = PRE_RELEASE.first
+    end
+
+    ##
+    # Clear special and metadata so version become higher and not prerelease
+    def release
+      fail AlreadyRelease unless prerelease?
+      @special = ''
+      @metadata = ''
+    end
+
+    private
+
+    def validate
+      fail FileNotFound unless File.exist?(@file)
+      fail MajorVersionNotInt unless @major.is_a?(Integer)
+      fail MinorVersionNotInt unless @minor.is_a?(Integer)
+      fail PatchVersionNotInt unless @patch.is_a?(Integer)
+      fail SpecialNotRecognized unless valid_special?
+    end
+
+    def valid_special?
+      !prerelease? || PRE_RELEASE.include?(@special)
+    end
+
+    def increase_major
+      @major += 1
+      @minor = 0
+      @patch = 0
+    end
+
+    def increase_minor
+      @minor += 1
+      @patch = 0
+    end
+
+    def increase_patch
+      @patch += 1
+    end
+
+    def increase_prerelease
+      fail NotPreRelease unless prerelease?
+      tmp = ''
+      PRE_RELEASE.each do |version|
+        if @special == tmp
+          @special = version
+          return 0
+        end
+        tmp = version
+      end
+      fail PreReleaseTagReachedFinalVersion
+    end
+  end
+end