Merge pull request #191 from agross/master

Improved the Ruby Gem to make it usable from a Rakefile

Author: andreasohlund

GitVersionExe/GemAssets/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+!bin/

GitVersionExe/GemAssets/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--tag ~@draft

GitVersionExe/GemAssets/Gemfile

@@ -0,0 +1,24 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'guard-bundler', require: false
+  gem 'guard-rspec', require: false
+
+  case RbConfig::CONFIG['target_os']
+  when /windows|bccwin|cygwin|djgpp|mingw|mswin|wince/i
+    gem 'ruby_gntp', require: false
+    gem 'wdm', require: false
+  when /linux/i
+    gem 'rb-inotify', require: false
+  when /mac|darwin/i
+    gem 'rb-fsevent', require: false
+    gem 'growl', require: false
+  end
+end
+
+group :development, :ci do
+  gem 'rspec', '~> 3.0.0', require: false
+  gem 'rspec-its', require: false
+end

GitVersionExe/GemAssets/Guardfile

@@ -0,0 +1,24 @@
+case RbConfig::CONFIG['target_os']
+when /windows|bccwin|cygwin|djgpp|mingw|mswin|wince/i
+  notification :gntp, :host => 'localhost'
+when /linux/i
+  notification :notifysend
+when /mac|darwin/i
+  notification :growl
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec',
+  :all_on_start => true,
+  :all_after_pass => true,
+  :notification => true,
+  :cmd => 'bundle exec rspec' do
+    watch('.rspec')              { 'spec' }
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})    { |m| "spec/lib/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb') { 'spec' }
+end

GitVersionExe/GemAssets/gitversion renamed to GitVersionExe/GemAssets/bin/gitversion

@@ -1,2 +1,4 @@
+#! ruby
+
 result = system(File.dirname(__FILE__) + "/GitVersion.exe " + ARGV.join(' '))
-exit 1 unless result
+exit 1 unless result

GitVersionExe/GemAssets/gitversion.gemspec

@@ -3,17 +3,18 @@ Gem::Specification.new do |spec|
   spec.name        = 'gitversion'
   spec.licenses    = ['MIT']
   spec.version     = '0.20.0'
-  spec.files = Dir['bin/**/*']
-  spec.bindir = 'bin'
-  spec.executables << 'gitversion'
-
   spec.summary     = 'Derives SemVer information from a repository following GitFlow or GitHubFlow.'
-  spec.description = <<-EOF 
+  spec.description = <<-EOF
 Derives SemVer information from a repository following GitFlow or GitHubFlow.
 EOF
-  
+
   spec.authors           = ['NServiceBus','Simon Cropp']
   spec.email             = '[email protected]'
   spec.homepage          = 'http://github.com/Particular/GitVersion'
   spec.rubyforge_project = 'GitVersion'
-end
+
+  spec.files         = Dir['bin/**/*', 'lib/**/*', '*.gemspec']
+  spec.executables   = spec.files.grep(%r{^bin/.+(?<!\.exe|\.pdb)$}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+end

GitVersionExe/GemAssets/lib/git_version.rb

@@ -0,0 +1,12 @@
+require 'git_version/parser'
+
+module GitVersion
+  def git_version(args = nil)
+    parsers.fetch(args) { |a| parsers[a] = Parser.new(a) }
+  end
+
+  private
+  def parsers
+    @parsers ||= {}
+  end
+end

GitVersionExe/GemAssets/lib/git_version/parser.rb

@@ -0,0 +1,76 @@
+require 'json'
+require 'open3'
+
+module GitVersion
+  class Parser
+    attr_reader :args
+    attr_accessor :gitversion_exe
+
+    def initialize(args = [])
+      @args = args
+    end
+
+    def method_missing(symbol, *args)
+      keys = [symbol.to_s, pascal_case(symbol.to_s)]
+
+      found_key = keys.find { |key| json.has_key?(key) }
+      return json[found_key] if found_key
+
+      super
+    end
+
+    def json
+      @json ||= run_gitversion
+    end
+
+    def gitversion_exe
+      @gitversion_exe ||= File.expand_path(File.join(File.dirname(__FILE__), '../../bin/GitVersion.exe'))
+    end
+
+    def inspect
+      unless @json
+
+        return <<EOF
+#{to_s}
+Will invoke #{cmd_string} when first used.
+EOF
+
+      else
+
+        return <<EOF
+#{to_s}
+Invoked #{cmd_string} and parsed its output:
+#{json.inspect}
+EOF
+
+      end
+    end
+
+    private
+    def run_gitversion
+      stdout_and_stderr, status = Open3.capture2e(*cmd)
+
+      raise StandardError.new("Failed running #{cmd_string}, #{status}. We received the following output:\n#{stdout_and_stderr}") unless status.success?
+
+      JSON.parse(stdout_and_stderr)
+    end
+
+    def cmd
+      cmd = [gitversion_exe]
+      cmd << args
+      cmd.flatten.reject(&:nil?)
+    end
+
+    def cmd_string
+      cmd.join(' ')
+    end
+
+    def pascal_case(str)
+      str
+      .to_s
+      .split('_')
+      .inject([]) { |buffer, e| buffer.push(e.capitalize) }
+      .join
+    end
+  end
+end

GitVersionExe/GemAssets/spec/lib/git_version/parser_spec.rb

@@ -0,0 +1,102 @@
+require 'git_version'
+
+describe GitVersion::Parser do
+  describe 'defaults' do
+    its(:gitversion_exe) { should match(%r|/bin/GitVersion.exe$|) }
+    its(:args) { should be_empty }
+  end
+
+  describe 'GitVersion.exe invocation' do
+    before {
+      allow(Open3).to receive(:capture2e).and_return(gitversion_exe_return)
+    }
+
+    let(:gitversion_exe_return) { ['{ "Sha": 1234 }', OpenStruct.new(success?: true)] }
+
+    describe 'cached results' do
+      context 'accessing multiple properties' do
+        it 'should run GitVersion.exe only once' do
+          subject.sha
+          subject.sha
+
+          expect(Open3).to have_received(:capture2e).once
+        end
+      end
+    end
+
+    describe 'arguments' do
+      subject { described_class.new(args) }
+
+      let(:args) { %w(some additional args) }
+
+      it 'should pass args to the executable' do
+        subject.sha
+
+        expect(Open3).to have_received(:capture2e).with(*([subject.gitversion_exe] + args))
+      end
+    end
+
+    context 'GitVersion.exe fails' do
+      let(:gitversion_exe_return) { ['some error output', OpenStruct.new(success?: false)] }
+
+      it 'should fail' do
+        expect { subject.it_does_not_matter }.to raise_error(StandardError, /Failed running.*some error output/m)
+      end
+    end
+  end
+
+  describe 'after the executable has been built' do
+    before {
+      subject.gitversion_exe = File.expand_path('../../GemBuild/bin/GitVersion.exe')
+    }
+
+    its(:json) { should_not be_nil }
+    its(:sha) { should match(/[0-9 a-f]{40}/) }
+  end
+
+  describe 'accessing properties' do
+    before {
+      allow(subject).to receive(:json).and_return(json)
+    }
+
+    let(:json) { { 'InformationalVersion' => 'blah' } }
+
+    it 'should translate snake case to pascal case' do
+      expect(subject.informational_version).to eq('blah')
+    end
+
+    it 'should support pascal case' do
+      pascal = subject.InformationalVersion
+      snake = subject.informational_version
+
+      expect(pascal).to eq(snake)
+    end
+
+    context 'with nil value' do
+      let(:json) { { 'is_nil' => nil } }
+
+      it 'should yield nil' do
+        expect(subject.is_nil).to be_nil
+      end
+    end
+  end
+
+  describe '#inspect' do
+    context 'no properties accessed yet' do
+      it 'should write what will happen' do
+        expect(subject.inspect).to match(/.+GitVersion.+\nWill invoke .+GitVersion.exe when first used./)
+      end
+    end
+
+    context 'properties accessed' do
+      before {
+        allow(Open3).to receive(:capture2e).and_return(['{ "Sha": 1234 }', OpenStruct.new(success?: true)])
+      }
+
+      it 'should write what happened' do
+        subject.sha
+        expect(subject.inspect).to match(/.+GitVersion.+\nInvoked .+GitVersion.exe and parsed its output:\n.+/)
+      end
+    end
+  end
+end

GitVersionExe/GemAssets/spec/lib/git_version_spec.rb

@@ -0,0 +1,35 @@
+require 'git_version'
+
+describe GitVersion do
+  include described_class
+
+  it 'should create a ' + GitVersion::Parser.to_s do
+    expect(git_version).to be_an_instance_of(GitVersion::Parser)
+  end
+
+  it 'should create a singleton ' + GitVersion::Parser.to_s do
+    expect(git_version).to equal(git_version)
+  end
+
+  describe 'passing arguments' do
+    it 'should yield the same instance per argument' do
+      expect(git_version('foo')).to equal(git_version('foo'))
+    end
+
+    it 'should yield different instances for different arguments' do
+      expect(git_version('foo')).not_to equal_no_diff(git_version('bar'))
+    end
+
+    def equal_no_diff(expected)
+      expected = equal(expected)
+
+      # Turn off diffing for this matcher as it calls GitVersion::Parser#to_ary which will fail because GitVersion.exe
+      # cannot be found.
+      def expected.diffable?
+        false
+      end
+
+      expected
+    end
+  end
+end