percy-client 0.2.11 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7efbfa1d29e3d37db3b6fc4b1e4672cd84404598
-  data.tar.gz: 4b01197b60bbda28b5d8b63b0cc5eece4d122e27
+  metadata.gz: 0f7070109c5961c00615e57891774502d0f0685e
+  data.tar.gz: 866f8b2a9a708d1fb4e31411af4a28ce11029ec7
 SHA512:
-  metadata.gz: 10426465a40a9af7af1362f100319dfbf067ecebbddd3024936063e2192f48d551fe6a0d5dfdc3823ad9c9234e498bb77b7e6b3b533704f200ed4696320110a5
-  data.tar.gz: 4a07806286f6350d0845e21bad7771203344f8ea03e0b96781224199dbb50c6513825d2c0080e6baaca67d155ca0ecb02d6feab7678b94fac9d6aba8831b18ad
+  metadata.gz: cd466d0a8c561ed6154cff9cce14d32f811ca7df22c1e8fd23b9ca833b9adea79d6e33646752be5357b56f7f4f37e245960cfd40ed5a9fc3bd17f7a87fedaf3d
+  data.tar.gz: 25fbd1da9b863151e3c36e38ad76582b866d76b4c28d2a889c95eec9ceb20f810006cd97888fcbc954fd26765fec4a4df5ade0ab4d2b1ebc043ae46b0d4ae4b2

data/lib/percy/client/builds.rb

@@ -11,8 +11,8 @@ module Percy
           'data' => {
             'type' => 'builds',
             'attributes' => {
+              'branch' => commit_data[:branch],
               'commit-sha' => commit_data[:sha],
-              'commit-branch' => commit_data[:branch],
               'commit-committed-at' => commit_data[:committed_at],
               'commit-author-name' => commit_data[:author_name],
               'commit-author-email' => commit_data[:author_email],

data/lib/percy/client/environment.rb

@@ -14,7 +14,6 @@ module Percy
 
       class Error < Exception; end
       class RepoNotFoundError < Exception; end
-      class BranchNotFoundError < Exception; end
 
       def self.current_ci
         return :travis if ENV['TRAVIS_BUILD_ID']
@@ -23,7 +22,27 @@ module Percy
         return :codeship if ENV['CI_NAME'] && ENV['CI_NAME'] == 'codeship'
       end
 
-      def self.commit_sha
+      # @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('HEAD') if !output
+        return {branch: branch} if !output
+
+        data = {
+          sha: output.match(/COMMIT_SHA:(.*)/)[1],
+          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],
+        }
+      end
+
+      # @private
+      def self._commit_sha
         return ENV['PERCY_COMMIT'] if ENV['PERCY_COMMIT']
 
         case current_ci
@@ -40,19 +59,12 @@ module Percy
         end
       end
 
-      def self.commit
+      # @private
+      def self._raw_commit_output(commit_sha)
         format = GIT_FORMAT_LINES.join('%n')  # "git show" format uses %n for newlines.
-        output = `git show --quiet #{commit_sha} --format="#{format}"`.strip
-        data = {
-          sha: output.match(/COMMIT_SHA:(.*)/)[1],
-          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],
-        }
+        output = `git show --quiet #{commit_sha} --format="#{format}" 2> /dev/null`.strip
+        return if $?.to_i != 0
+        output
       end
 
       # The name of the target branch that the build will be compared against.
@@ -69,15 +81,22 @@ module Percy
         when :codeship
           ENV['CI_BRANCH']
         else
-          # Discover from current git repo branch name.
-          `git rev-parse --abbrev-ref HEAD`.strip
+          _raw_branch_output
         end
         if result == ''
-          raise Percy::Client::Environment::BranchNotFoundError.new('No target branch found.')
+          STDERR.puts '[percy] Warning: not in a git repo, setting PERCY_BRANCH to "master".'
+          result = 'master'
         end
         result
       end
 
+      # @private
+      def self._raw_branch_output
+        # Discover from local git repo branch name.
+        `git rev-parse --abbrev-ref HEAD 2> /dev/null`.strip
+      end
+      class << self; private :_raw_branch_output; end
+
       def self.repo
         return ENV['PERCY_REPO_SLUG'] if ENV['PERCY_REPO_SLUG']
 
@@ -89,13 +108,15 @@ module Percy
         else
           origin_url = _get_origin_url.strip
           if origin_url == ''
-            raise Percy::Client::Environment::RepoNotFoundError.new('No local git repository found.')
+            raise Percy::Client::Environment::RepoNotFoundError.new(
+              'No local git repository found. ' +
+              'You can manually set PERCY_REPO_SLUG to fix this.')
           end
           match = origin_url.match(Regexp.new('[:/]([^/]+\/[^/]+?)(\.git)?\Z'))
           if !match
             raise Percy::Client::Environment::RepoNotFoundError.new(
               "Could not determine repository name from URL: #{origin_url.inspect}\n" +
-              "You can manually set PERCY_REPO to fix this.")
+              "You can manually set PERCY_REPO_SLUG to fix this.")
           end
           match[1]
         end

data/lib/percy/client/version.rb

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

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

@@ -60,6 +60,10 @@ RSpec.describe Percy::Client::Environment do
       end
     end
     describe '#branch' do
+      it 'returns master if not in a git repo' do
+        expect(Percy::Client::Environment).to receive(:_raw_branch_output).and_return('')
+        expect(Percy::Client::Environment.branch).to eq('master')
+      end
       it 'reads from the current local repo' do
         expect(Percy::Client::Environment.branch).to_not be_empty
       end
@@ -68,13 +72,13 @@ RSpec.describe Percy::Client::Environment do
         expect(Percy::Client::Environment.branch).to eq('test-branch')
       end
     end
-    describe '#commit_sha' do
+    describe '#_commit_sha' do
       it 'reads from the current local repo' do
-        expect(Percy::Client::Environment.commit_sha).to eq('HEAD')
+        expect(Percy::Client::Environment._commit_sha).to eq('HEAD')
       end
       it 'can be overridden with PERCY_COMMIT' do
         ENV['PERCY_COMMIT'] = 'test-commit'
-        expect(Percy::Client::Environment.commit_sha).to eq('test-commit')
+        expect(Percy::Client::Environment._commit_sha).to eq('test-commit')
       end
     end
     describe '#pull_request_number' do
@@ -147,9 +151,9 @@ RSpec.describe Percy::Client::Environment do
         expect(Percy::Client::Environment.branch).to eq('jenkins-target-branch')
       end
     end
-    describe '#commit_sha' do
+    describe '#_commit_sha' do
       it 'reads from the CI environment' do
-        expect(Percy::Client::Environment.commit_sha).to eq('jenkins-actual-commit')
+        expect(Percy::Client::Environment._commit_sha).to eq('jenkins-actual-commit')
       end
     end
     describe '#pull_request_number' do
@@ -182,9 +186,9 @@ RSpec.describe Percy::Client::Environment do
         expect(Percy::Client::Environment.branch).to eq('travis-branch')
       end
     end
-    describe '#commit_sha' do
+    describe '#_commit_sha' do
       it 'reads from the CI environment' do
-        expect(Percy::Client::Environment.commit_sha).to eq('travis-commit-sha')
+        expect(Percy::Client::Environment._commit_sha).to eq('travis-commit-sha')
       end
     end
     describe '#pull_request_number' do
@@ -218,9 +222,9 @@ RSpec.describe Percy::Client::Environment do
         expect(Percy::Client::Environment.branch).to eq('circle-branch')
       end
     end
-    describe '#commit_sha' do
+    describe '#_commit_sha' do
       it 'reads from the CI environment' do
-        expect(Percy::Client::Environment.commit_sha).to eq('circle-commit-sha')
+        expect(Percy::Client::Environment._commit_sha).to eq('circle-commit-sha')
       end
     end
 
@@ -253,9 +257,9 @@ RSpec.describe Percy::Client::Environment do
         expect(Percy::Client::Environment.branch).to eq('codeship-branch')
       end
     end
-    describe '#commit_sha' do
+    describe '#_commit_sha' do
       it 'reads from the CI environment' do
-        expect(Percy::Client::Environment.commit_sha).to eq('codeship-commit-sha')
+        expect(Percy::Client::Environment._commit_sha).to eq('codeship-commit-sha')
       end
     end
     describe '#pull_request_number' do
@@ -283,6 +287,13 @@ RSpec.describe Percy::Client::Environment do
         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)
+
+        commit = Percy::Client::Environment.commit
+        expect(commit.length).to eq(1)
+        expect(commit[:branch]).to be
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-client
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.3.0
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-24 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -190,3 +190,4 @@ test_files:
 - spec/lib/percy_spec.rb
 - spec/spec_helper.rb
 - spec/support/vcr_setup.rb
+has_rdoc: