alpacabuildtool 1.0.0

data/lib/alpacabuildtool/versioning/versioning.rb

@@ -0,0 +1,84 @@
+require 'fileutils'
+require 'yaml'
+require 'pathname'
+require 'alpacabuildtool/versioning/version'
+
+module AlpacaBuildTool
+  ##
+  # Versioning provides methods to load and save version
+  # for solutions
+  module Versioning
+    ##
+    # File name where semantic version is stored
+    FILE_NAME = '.semver'
+
+    ##
+    # Error thrown by versioning if version file not found
+    SemVerFileNotFound = Class.new(StandardError)
+
+    ##
+    # Initializes semantic versioning
+    #
+    # +[dir]+:: directory where to place .semver(current working
+    # directory by default)
+    def self.init(dir = '')
+      hash = { major: 0, minor: 0, patch: 0, special: '', metadata: '' }
+      FileUtils.mkdir_p(dir) unless File.directory?(dir)
+      file = File.join dir, FILE_NAME
+      open(file, 'w') { |io| io.write YAML.dump(hash) }
+      hash[:file] = file
+      Version.new hash
+    end
+
+    ##
+    # Returns Version instance from .semver file found
+    # by reverse search from current working directory/dir
+    # up to root directory
+    #
+    # +[solution_folder]+:: directory from which to start searching
+    #  .semver file(nil by default)
+    # +[dir]+:: base directory for .semver file(current working
+    # directory by default)
+    def self.find(solution_folder = nil, dir = '')
+      solution_folder = Pathname.new(solution_folder) if solution_folder
+      semver = find_file FILE_NAME, dir, solution_folder || Pathname.new('.')
+      fail SemVerFileNotFound if semver.nil?
+      hash = YAML.load_file(semver) || {}
+      hash[:file] = semver
+      Version.new hash
+    end
+
+    ##
+    # Helper method to recursivly find file
+    #
+    # +name+:: file name to find
+    # +dir+:: relative path to file
+    # +cur+:: current folder to start searching from
+    def self.find_file(name, dir, cur)
+      file = File.join(cur.expand_path, dir, name)
+      return file if File.exist?(file)
+      return nil if cur.expand_path.root?
+      find_file(name, dir, cur.parent)
+    end
+
+    ##
+    # Returns Version instance from specific file
+    #
+    # +[file]+:: path to file that contains .semver content
+    def self.parse(file)
+      hash = YAML.load_file(file)
+      hash[:file] = file
+      Version.new hash
+    end
+
+    ##
+    # Save changes done to version
+    #
+    # +version+:: instance of Version class
+    # +file+:: specific file to save to(nil by default)
+    def self.save(version, file = nil)
+      file ||= version.file
+      open(file, 'w') { |io| io.write version.to_yaml }
+    end
+  end
+end

data/spec/lib/alpacabuildtool/configuration_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+require 'alpacabuildtool/configuration'
+require 'fakefs/spec_helpers'
+require 'ostruct'
+
+describe AlpacaBuildTool::Configuration do
+  include FakeFS::SpecHelpers
+
+  describe '.set' do
+    let(:file) { File.expand_path '~/.alpaca.conf' }
+
+    context 'when global configuration file does not exist' do
+      before(:each) { FileUtils.mkdir_p(File.dirname(file)) }
+      let(:properties) { ['hello.world=hi'] }
+      let(:expected_content) { "---\nhello:\n  world: hi\n" }
+
+      it 'then it creates "~/.alpaca.config" file' do
+        AlpacaBuildTool::Configuration.set properties
+        expect(File.exist? file).to be true
+      end
+
+      it 'and it saves property to file' do
+        AlpacaBuildTool::Configuration.set properties
+        expect(File.read file).to eq expected_content
+      end
+    end
+
+    context 'when global configuration file exist' do
+      let(:content) { "---\nhello:\n  world: hi\n" }
+      before(:each) do
+        FileUtils.mkdir_p(File.dirname(file))
+        File.open(file, 'w+') { |f| f.write content }
+      end
+
+      context 'and requested property update' do
+        let(:properties) { ['hello.world=update'] }
+        let(:updated_content) { "---\nhello:\n  world: update\n" }
+        it 'then it updates property' do
+          AlpacaBuildTool::Configuration.set properties
+          expect(File.read file).to eq updated_content
+        end
+      end
+
+      context 'and adding new property' do
+        let(:properties) { ['hello.my_world=kitty'] }
+        let(:expected_content) { content + "  my_world: kitty\n" }
+        it 'then it saves property to file' do
+          AlpacaBuildTool::Configuration.set properties
+          expect(File.read file).to eq expected_content
+        end
+      end
+    end
+  end
+
+  describe '#set' do
+    let(:file_path) do
+      require 'rbconfig'
+      case RbConfig::CONFIG['host_os']
+      when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+        'd:\solution'
+      else
+        '/home/solution'
+      end
+    end
+    let(:file) { File.join file_path, '.alpaca.conf' }
+    let(:solution) do
+      solution = OpenStruct.new
+      solution.file = File.join(file_path, 'some.sln')
+      solution.dir = file_path
+      solution
+    end
+    subject do
+      data_dir = AlpacaBuildTool::Configuration.const_get(:DATA_DIR)
+      default_config = File.join(data_dir, '.alpaca.conf')
+      FileUtils.mkdir_p File.dirname(default_config)
+      File.open(default_config, 'w+') do |f|
+        f.write "---\nlocal_configuration: '.alpaca.conf'"
+      end
+      c = AlpacaBuildTool::Configuration.new solution
+      c.set properties
+    end
+
+    context 'when local configuration file does not exist' do
+      before(:each) { FileUtils.mkdir_p(File.dirname(file)) }
+      let(:properties) { ['hello.world=hi'] }
+      let(:expected_content) { "---\nhello:\n  world: hi\n" }
+
+      it 'then it creates "solution_directory\.alpaca.conf" file' do
+        subject
+        expect(File.exist? file).to be true
+      end
+
+      it 'and it saves property to file' do
+        subject
+        expect(File.read file).to eq expected_content
+      end
+    end
+
+    context 'when local configuration file exist' do
+      let(:content) { "---\nhello:\n  world: hi\n" }
+      before(:each) do
+        FileUtils.mkdir_p(File.dirname(file))
+        File.open(file, 'w+') { |f| f.write content }
+      end
+
+      context 'and requested property update' do
+        let(:properties) { ['hello.world=update'] }
+        let(:updated_content) { "---\nhello:\n  world: update\n" }
+        it 'then it updates property' do
+          subject
+          expect(File.read file).to eq updated_content
+        end
+      end
+
+      context 'and adding new property' do
+        let(:properties) { ['hello.my_world=kitty'] }
+        let(:expected_content) { content + "  my_world: kitty\n" }
+        it 'then it saves property to file' do
+          subject
+          expect(File.read file).to eq expected_content
+        end
+      end
+    end
+  end
+
+  describe '.new' do
+    context 'when global configuration exist' do
+      context 'and local configuration overrides it' do
+        let(:default_config) do
+          data_dir = AlpacaBuildTool::Configuration.const_get(:DATA_DIR)
+          File.join(data_dir, '.alpaca.conf')
+        end
+        let(:global_config) { File.expand_path '~/.alpaca.conf' }
+        let(:global_content) do
+          "---\nlocal_configuration: '.alpaca.conf'\n"\
+            "Tool:\n  property: old_value\n  target: "\
+            "'\#{solution_name}.new'\n  property2:\n    "\
+            ":windows: '\#{solution_directory}'\n    "\
+            ":linux: '/usr/alpaca'"
+        end
+        let(:solution_dir) do
+          require 'rbconfig'
+          case RbConfig::CONFIG['host_os']
+          when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+            'd:\solution'
+          else
+            '/home/solution'
+          end
+        end
+        let(:local_config) { File.expand_path "#{solution_dir}/.alpaca.conf" }
+        let(:local_content) { "---\nTool:\n  property: new_value" }
+        let(:solution) do
+          solution = OpenStruct.new
+          solution.file = File.join solution_dir, 'alpaca.sln'
+          solution.dir = solution_dir
+          solution
+        end
+        subject { AlpacaBuildTool::Configuration.new solution }
+
+        def create_config(file, content)
+          FileUtils.mkdir_p(File.dirname(file))
+          File.open(file, 'w+') { |f| f.write content }
+        end
+
+        before(:each) do
+          create_config default_config, "---\n"
+          create_config global_config, global_content
+          create_config local_config, local_content
+          gc_var = :@@global_configuration
+          if AlpacaBuildTool::Configuration.class_variable_defined? gc_var
+            AlpacaBuildTool::Configuration.remove_class_variable gc_var
+          end
+          allow(AlpacaBuildTool::Os).to receive(:os).and_return(:windows)
+        end
+
+        it 'merges global with local with higher priority to local' do
+          value = subject.instance_variable_get(:@configuration)
+          expect(value['local_configuration']).to eq '.alpaca.conf'
+          expect(value['Tool']['property']).to eq 'new_value'
+          expect(value['Tool']['target']).to_not be nil
+          expect(value['Tool']['property2']).to_not be nil
+        end
+
+        it 'detokenize OS from configuration' do
+          value = subject.instance_variable_get(:@configuration)
+          expect(value['Tool']['property2']).to_not eq 'usr/alpaca'
+        end
+
+        it 'detokenize solution variable #{solution_name}' do
+          value = subject.instance_variable_get(:@configuration)
+          expect(value['Tool']['target']).to eq 'alpaca.new'
+        end
+
+        it 'detokenize solution variable #{solution_directory}' do
+          value = subject.instance_variable_get(:@configuration)
+          expect(value['Tool']['property2']).to eq solution.dir
+        end
+      end
+    end
+  end
+end

data/spec/lib/alpacabuildtool/entities/xml_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'alpacabuildtool/entities/xml'
+
+describe AlpacaBuildTool::Xml do
+  describe '.to_s' do
+    context 'with simple nuspec like structure' do
+      subject do
+        AlpacaBuildTool::Xml.new '1.0' do
+          node 'root' do
+            node 'files' do
+              node 'file' do
+                attribute('src', 'A.txt')
+              end
+              node 'file' do
+                attribute 'src', 'B.txt'
+                attribute 'help', 'B file'
+              end
+            end
+            node 'metadata'
+          end
+        end
+      end
+
+      let(:xml_content) do
+        "<?xml version=\"1.0\"?>\n" \
+        "<root>\n" \
+        "\t<files>\n" \
+        "\t\t<file src=\"A.txt\"/>\n" \
+        "\t\t<file src=\"B.txt\" help=\"B file\"/>\n" \
+        "\t</files>\n" \
+        "\t<metadata/>\n" \
+        '</root>'
+      end
+      it 'returns well formatted xml' do
+        expect(subject.to_s).to eq xml_content
+      end
+    end
+  end
+end

data/spec/lib/alpacabuildtool/versioning/version_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'alpacabuildtool/versioning/version'
+require 'fakefs/spec_helpers'
+
+describe AlpacaBuildTool::Version do
+  include FakeFS::SpecHelpers
+  def set_version(a, b, c, d, e)
+    open('.semver', 'w') { |io| io.write 'mock file presense' }
+    { file: '.semver', major: a, minor: b, patch: c, special: d, metadata: e }
+  end
+
+  describe '#increase :major' do
+    it 'increase major and reset lover(v1.2.3-rc+03fb4 -> v2.0.0-rc+03fb4)' do
+      v = AlpacaBuildTool::Version.new(set_version 1, 2, 3, 'rc', '03fb4')
+      v.increase :major
+      expect(v.to_s).to eq 'v2.0.0-rc+03fb4'
+    end
+  end
+  describe '#increase :minor' do
+    it 'increase monir and reset lover(v1.2.3-rc+03fb4 -> v1.3.0-rc+03fb4)' do
+      v = AlpacaBuildTool::Version.new(set_version 1, 2, 3, 'rc', '03fb4')
+      v.increase :minor
+      expect(v.to_s).to eq 'v1.3.0-rc+03fb4'
+    end
+  end
+  describe '#increase :patch' do
+    it 'increase patch only(v1.2.3-rc+03fb4 -> v1.2.4-rc+03fb4)' do
+      v = AlpacaBuildTool::Version.new(set_version 1, 2, 3, 'rc', '03fb4')
+      v.increase :patch
+      expect(v.to_s).to eq 'v1.2.4-rc+03fb4'
+    end
+  end
+  describe '#increase :prerelease' do
+    it 'update "alpha" to "beta"(v1.2.3-alpha+03fb4 -> v1.2.3-beta+03fb4)' do
+      v = AlpacaBuildTool::Version.new(set_version 1, 2, 3, 'alpha', '03fb4')
+      v.increase :prerelease
+      expect(v.to_s).to eq 'v1.2.3-beta+03fb4'
+    end
+    it 'update "beta" to "rc"(v1.2.3-beta+03fb4 -> v1.2.3-rc+03fb4)' do
+      v = AlpacaBuildTool::Version.new(set_version 1, 2, 3, 'beta', '03fb4')
+      v.increase :prerelease
+      expect(v.to_s).to eq 'v1.2.3-rc+03fb4'
+    end
+    it 'fail to increase "rc" as it is last pre-release stage' do
+      v = AlpacaBuildTool::Version.new(set_version 1, 2, 3, 'rc', '03fb4')
+      expect { v.increase :prerelease }.to raise_error(
+        AlpacaBuildTool::Version::PreReleaseTagReachedFinalVersion)
+    end
+    it 'fail to increase prerelease tag for release package' do
+      v = AlpacaBuildTool::Version.new(set_version 1, 2, 3, '', '')
+      expect { v.increase :prerelease }
+        .to raise_error(AlpacaBuildTool::Version::NotPreRelease)
+    end
+  end
+  describe '#metadata 334f666' do
+    it 'update metadata to new value' do
+      v = AlpacaBuildTool::Version.new(set_version 1, 2, 3, 'rc', '03fb4')
+      v.metadata = '334f666'
+      expect(v.to_s).to eq 'v1.2.3-rc+334f666'
+    end
+  end
+  describe '#release' do
+    it 'Clean pre-release tag and metadata(v1.2.3-rc+03fb4 -> v1.2.3)' do
+      v = AlpacaBuildTool::Version.new(set_version 1, 2, 3, 'rc', '03fb4')
+      v.release
+      expect(v.to_s).to eq 'v1.2.3'
+    end
+    it 'Fail to release version that is already released' do
+      v = AlpacaBuildTool::Version.new(set_version 1, 2, 3, '', '')
+      expect { v.release }
+        .to raise_error(AlpacaBuildTool::Version::AlreadyRelease)
+    end
+  end
+  describe '#make_prerelease' do
+    it 'Fail to make version pre-release if it is already pre-release' do
+      v = AlpacaBuildTool::Version.new(set_version 1, 2, 3, 'rc', '03fb4')
+      v.increase :major
+      expect(v.to_s).to eq 'v2.0.0-rc+03fb4'
+    end
+    it 'Add pre-release tag' do
+      v = AlpacaBuildTool::Version.new(set_version 1, 2, 3, 'rc', '03fb4')
+      v.increase :major
+      expect(v.to_s).to eq 'v2.0.0-rc+03fb4'
+    end
+  end
+end

data/spec/lib/alpacabuildtool/versioning/versioning_spec.rb

@@ -0,0 +1,194 @@
+require 'spec_helper'
+require 'alpacabuildtool/versioning/versioning'
+require 'fakefs/spec_helpers'
+
+describe AlpacaBuildTool::Versioning do
+  include FakeFS::SpecHelpers
+  describe '::init' do
+    let(:content) do
+      "---\n:major: 0\n:minor: 0\n:patch: 0\n:special: ''\n:metadata: ''\n"
+    end
+
+    context 'When base directory not passed' do
+      let(:file) { '.semver' }
+      subject { AlpacaBuildTool::Versioning.init }
+      before(:each) { subject }
+
+      it 'Creates new .semver file in current directory' do
+        expect(File.exist?(file)).to be true
+      end
+
+      it 'Stores versioning information to .semver file' do
+        expect(File.read(file)).to eq content
+      end
+
+      it 'Returns instance of Version class' do
+        expect(subject).to be_an_instance_of(AlpacaBuildTool::Version)
+      end
+
+      it 'with 0 major version' do
+        expect(subject.major).to eq 0
+      end
+
+      it 'with 0 minor version' do
+        expect(subject.minor).to eq 0
+      end
+
+      it 'with 0 patch version' do
+        expect(subject.patch).to eq 0
+      end
+
+      it 'with empty special' do
+        expect(subject.special).to eq ''
+      end
+
+      it 'with empty metadata' do
+        expect(subject.metadata).to eq ''
+      end
+    end
+
+    context 'When base directory passed' do
+      let(:file) { 'funny_dir/.semver' }
+      subject { AlpacaBuildTool::Versioning.init 'funny_dir' }
+      before(:each) { subject }
+
+      it 'Creates new .semver file in specific directory' do
+        expect(File.exist?(file)).to be true
+      end
+
+      it 'Stores versioning information to .semver file' do
+        expect(File.read(file)).to eq content
+      end
+
+      it 'Returns instance of Version class' do
+        expect(subject).to be_an_instance_of(AlpacaBuildTool::Version)
+      end
+
+      it 'with 0 major version' do
+        expect(subject.major).to eq 0
+      end
+
+      it 'with 0 minor version' do
+        expect(subject.minor).to eq 0
+      end
+
+      it 'with 0 patch version' do
+        expect(subject.patch).to eq 0
+      end
+
+      it 'with empty special' do
+        expect(subject.special).to eq ''
+      end
+
+      it 'with empty metadata' do
+        expect(subject.metadata).to eq ''
+      end
+    end
+  end
+
+  describe '::find' do
+    let(:file) { '.semver' }
+    let(:content) do
+      "---\n:major: 1\n:minor: 2\n:patch: 3\n:special: 'rc'\n:metadata: 'e4'\n"
+    end
+
+    context 'When base directory not passed' do
+      subject { AlpacaBuildTool::Versioning.find }
+      before(:each) do
+        open(file, 'w') { |io| io.write content }
+        subject
+      end
+
+      it 'Then returns Version instance' do
+        expect(subject).to be_an_instance_of(AlpacaBuildTool::Version)
+      end
+    end
+
+    context 'When base directory is passed' do
+      let(:dir) { 'funny' }
+      subject { AlpacaBuildTool::Versioning.find nil, dir }
+      before(:each) do
+        FileUtils.mkdir_p(dir)
+        open(File.join(dir, file), 'w') { |io| io.write content }
+        subject
+      end
+
+      it 'Then returns Version instance' do
+        expect(subject).to be_an_instance_of(AlpacaBuildTool::Version)
+      end
+    end
+
+    context 'When file does not found' do
+      let(:dir) { 'funny' }
+      subject { AlpacaBuildTool::Versioning.find nil, dir }
+      before(:each) do
+        open(file, 'w') { |io| io.write content }
+      end
+
+      it 'Then fails with SemVerFileNotFound' do
+        expect { subject }
+          .to raise_error AlpacaBuildTool::Versioning::SemVerFileNotFound
+      end
+    end
+
+    context 'When file is corrupted' do
+      let(:corrupted_content) do
+        "---\n:major: 1\n:patch: 3\n:special: 'rc'\n:metadata: 'e4'\n"
+      end
+      subject { AlpacaBuildTool::Versioning.find }
+      before(:each) do
+        open(file, 'w') { |io| io.write corrupted_content }
+      end
+
+      it 'Then fails with InvalidSemVerFile' do
+        expect { subject }.to raise_error AlpacaBuildTool::Version::InvalidFile
+      end
+    end
+
+    context 'When solution folder passed' do
+      let(:sln) do
+        cur = File.dirname(File.expand_path(__FILE__))
+        File.join(cur, '../test_data/sln1')
+      end
+      subject { AlpacaBuildTool::Versioning.find sln }
+      before(:each) do
+        FileUtils.mkdir_p(sln)
+        open(File.join(sln, file), 'w') { |io| io.write content }
+      end
+
+      it 'Then returns Version instance' do
+        expect(subject).to be_an_instance_of(AlpacaBuildTool::Version)
+      end
+    end
+  end
+
+  describe '::save' do
+    let(:version) do
+      AlpacaBuildTool::Version.new(file: '.semver',
+                                   major: 1, minor: 2, patch: 3,
+                                   special: 'rc', metadata: '4e')
+    end
+    let(:content) do
+      "---\n:major: 1\n:minor: 2\n:patch: 3\n:special: rc\n:metadata: 4e\n"
+    end
+    before(:each) do
+      open('.semver', 'w') { |io| io.write 'bad text' }
+      AlpacaBuildTool::Versioning.save version
+    end
+    it 'Then write into file used to initialize version' do
+      expect(File.exist?('.semver')).to be true
+    end
+
+    it 'And save semantic version data into file used for initialization' do
+      expect(File.read(version.file)).to eq content
+    end
+
+    context 'When file name passed as argument' do
+      it 'Then write into specified file' do
+        open('.semver', 'w') { |io| io.write 'bad text' }
+        AlpacaBuildTool::Versioning.save version, 'new.semver'
+        expect(File.exist?('new.semver')).to be true
+      end
+    end
+  end
+end