percy-client 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f7070109c5961c00615e57891774502d0f0685e
-  data.tar.gz: 866f8b2a9a708d1fb4e31411af4a28ce11029ec7
+  metadata.gz: 8d2b12edbcf92649f7f63cf396884d852332bb38
+  data.tar.gz: 4ebf745962d67e4bc58fa5b636c9d6b6f211aa49
 SHA512:
-  metadata.gz: cd466d0a8c561ed6154cff9cce14d32f811ca7df22c1e8fd23b9ca833b9adea79d6e33646752be5357b56f7f4f37e245960cfd40ed5a9fc3bd17f7a87fedaf3d
-  data.tar.gz: 25fbd1da9b863151e3c36e38ad76582b866d76b4c28d2a889c95eec9ceb20f810006cd97888fcbc954fd26765fec4a4df5ade0ab4d2b1ebc043ae46b0d4ae4b2
+  metadata.gz: 3c29f557ff8cadba3b55e721b72fe0cd29493e2f4fc9ce6490d1cbff7ce43e5d8bd81002665923c45adb808ba364b6acb670bdb4e37da0f12c8e21fd0a1d244f
+  data.tar.gz: 2a5363ce9f0a34254a6495bb8cb8e219de99057caa1035d885106851ac85cb748847ed32fb4bfce1c5dd38e91e5d2e1312cbf8f26b88d60254f5beab66fb90af

data/lib/percy/client/environment.rb

@@ -25,19 +25,29 @@ module Percy
       # @return [Hash] All commit data from the current commit. Might be empty if commit data could
       # not be found.
       def self.commit
-        output = _raw_commit_output(_commit_sha)
+        output = _raw_commit_output(_commit_sha) if _commit_sha
         output = _raw_commit_output('HEAD') if !output
-        return {branch: branch} if !output
 
+        # Use the specified SHA or, if not given, the parsed SHA at HEAD.
+        commit_sha = _commit_sha || output && output.match(/COMMIT_SHA:(.*)/)[1]
+
+        # If not running in a git repo, allow nils for certain commit attributes.
+        extract_or_nil = lambda { |regex| (output && output.match(regex) || [])[1] }
         data = {
-          sha: output.match(/COMMIT_SHA:(.*)/)[1],
+          # The only required attribute:
           branch: branch,
-          committed_at: output.match(/COMMITTED_DATE:(.*)/)[1],
-          author_name: output.match(/AUTHOR_NAME:(.*)/)[1],
-          author_email: output.match(/AUTHOR_EMAIL:(.*)/)[1],
-          committer_name: output.match(/COMMITTER_NAME:(.*)/)[1],
-          committer_email: output.match(/COMMITTER_EMAIL:(.*)/)[1],
-          message: output.match(/COMMIT_MESSAGE:(.*)/m)[1],
+          # An optional but important attribute:
+          sha: commit_sha,
+
+          # Optional attributes:
+          message: extract_or_nil.call(/COMMIT_MESSAGE:(.*)/m),
+          committed_at: extract_or_nil.call(/COMMITTED_DATE:(.*)/),
+          # These GIT_ environment vars are from the Jenkins Git Plugin, but could be
+          # used generically. This behavior may change in the future.
+          author_name: extract_or_nil.call(/AUTHOR_NAME:(.*)/) || ENV['GIT_AUTHOR_NAME'],
+          author_email: extract_or_nil.call(/AUTHOR_EMAIL:(.*)/)  || ENV['GIT_AUTHOR_EMAIL'],
+          committer_name: extract_or_nil.call(/COMMITTER_NAME:(.*)/) || ENV['GIT_COMMITTER_NAME'],
+          committer_email: extract_or_nil.call(/COMMITTER_EMAIL:(.*)/) || ENV['GIT_COMMITTER_EMAIL'],
         }
       end
 
@@ -47,15 +57,14 @@ module Percy
 
         case current_ci
         when :jenkins
-          ENV['ghprbActualCommit']
+          # Pull Request Builder Plugin OR Git Plugin.
+          ENV['ghprbActualCommit'] || ENV['GIT_COMMIT']
         when :travis
           ENV['TRAVIS_COMMIT']
         when :circle
           ENV['CIRCLE_SHA1']
         when :codeship
           ENV['CI_COMMIT_ID']
-        else
-          'HEAD'
         end
       end
 

data/lib/percy/client/version.rb

@@ -1,5 +1,5 @@
 module Percy
   class Client
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
   end
 end

data/spec/lib/percy/client/environment_spec.rb

@@ -73,8 +73,8 @@ RSpec.describe Percy::Client::Environment do
       end
     end
     describe '#_commit_sha' do
-      it 'reads from the current local repo' do
-        expect(Percy::Client::Environment._commit_sha).to eq('HEAD')
+      it 'returns nil if no environment info can be found' do
+        expect(Percy::Client::Environment._commit_sha).to be_nil
       end
       it 'can be overridden with PERCY_COMMIT' do
         ENV['PERCY_COMMIT'] = 'test-commit'
@@ -277,22 +277,30 @@ RSpec.describe Percy::Client::Environment do
     describe '#commit' do
       it 'returns current local commit data' do
         commit = Percy::Client::Environment.commit
+        expect(commit[:branch]).to_not be_empty
+        expect(commit[:sha]).to_not be_empty
+        expect(commit[:sha].length).to eq(40)
+
         expect(commit[:author_email]).to match(/.+@.+\..+/)
         expect(commit[:author_name]).to_not be_empty
-        expect(commit[:branch]).to_not be_empty
         expect(commit[:committed_at]).to_not be_empty
         expect(commit[:committer_email]).to_not be_empty
         expect(commit[:committer_name]).to_not be_empty
         expect(commit[:message]).to_not be_empty
-        expect(commit[:sha]).to_not be_empty
-        expect(commit[:sha].length).to eq(40)
       end
       it 'returns only branch if commit data cannot be found' do
-        expect(Percy::Client::Environment).to receive(:_raw_commit_output).twice.and_return(nil)
+        expect(Percy::Client::Environment).to receive(:_raw_commit_output).once.and_return(nil)
 
         commit = Percy::Client::Environment.commit
-        expect(commit.length).to eq(1)
         expect(commit[:branch]).to be
+        expect(commit[:sha]).to be_nil
+
+        expect(commit[:author_email]).to be_nil
+        expect(commit[:author_name]).to be_nil
+        expect(commit[:committed_at]).to be_nil
+        expect(commit[:committer_email]).to be_nil
+        expect(commit[:committer_name]).to be_nil
+        expect(commit[:message]).to be_nil
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-21 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Percy::Client
@@ -190,4 +190,3 @@ test_files:
 - spec/lib/percy_spec.rb
 - spec/spec_helper.rb
 - spec/support/vcr_setup.rb
-has_rdoc: