Adding inspection capability

Author: agross

GitVersionExe/GemAssets/lib/git_version.rb

@@ -23,22 +23,47 @@ def json
   end
 
   def gitversion_exe
-    @gitversion_exe ||= File.join(File.dirname(__FILE__), '../bin/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
-    cmd = [gitversion_exe]
-    cmd << args
-    cmd = cmd.flatten.reject(&:nil?)
-
     stdout_and_stderr, status = Open3.capture2e(*cmd)
 
-    raise StandardError.new("Failed running #{cmd.join(' ')}, #{status}. We received the following output:\n#{stdout_and_stderr}") unless status.success?
+    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

GitVersionExe/GemAssets/spec/lib/git_version_spec.rb

@@ -2,7 +2,7 @@
 
 describe GitVersion do
   describe 'defaults' do
-    its(:gitversion_exe) { should match(%r|\.\./bin/GitVersion.exe$|) }
+    its(:gitversion_exe) { should match(%r|/bin/GitVersion.exe$|) }
     its(:args) { should be_empty }
   end
 
@@ -80,4 +80,23 @@
       end
     end
   end
+
+  describe '#inspect' do
+    context 'no properties accessed yet' do
+      it 'writes 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 'writes what happened' do
+        subject.sha
+        expect(subject.inspect).to match(/.+GitVersion.+\nInvoked .+GitVersion.exe and parsed its output:\n.+/)
+      end
+    end
+  end
 end