txgh 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 602ce638efdadb764883e26d1c3636e84bdd5ede
-  data.tar.gz: 11f75ef7992aad2dc8e08a5c63e49f5faf0b140d
+  metadata.gz: fa8e34cc2f842b5e1d9d6998b6ddbf0ce72dfab8
+  data.tar.gz: 8d5dc86a7c315128114d6ff1e25b977ab908ee2a
 SHA512:
-  metadata.gz: 4ffa50d6b1b08c2b754983f4b899ae9f4e25ae224c239efffda00ea3115a94b8873bd1c8a4583cc360036fcc548a7bbd7850d74df3f3299ab17a45325e7f24e3
-  data.tar.gz: 58f00d04c536bb5f66a7cb4762bee31bbbf1a59a226f24d62ddc4deb9c53baf0648a89925b995a44308ce68d525f8c03f5b13d700c2d2273f91321933efc97a8
+  metadata.gz: 759259034ab336dcaeae29ecc692bfa45590a9f7bd11392162bb594a067acaf5bd152f6d248c5b27bd2af153950227a722f4364ac3b93db9aeb3e1258cc21a5b
+  data.tar.gz: 198311603b7035fa0129cfb20e288eb5444842fd319a65d88c6bbcfb2b390829ae0819f935b91d177f145846992f1a0031a94cd78b768d48a18229af7f7e5318

data/lib/txgh/github_api.rb

@@ -33,7 +33,7 @@ module Txgh
       client.create_ref(repo, branch, sha) rescue false
     end
 
-    def commit(repo, branch, content_map, allow_empty = false)
+    def commit(repo, branch, content_map, message, allow_empty = false)
       parent = client.ref(repo, branch)
       base_commit = get_commit(repo, parent[:object][:sha])
 
@@ -46,8 +46,7 @@ module Txgh
 
       tree = client.create_tree(repo, tree_data, tree_options)
       commit = client.create_commit(
-        repo, "Updating translations for #{content_map.keys.join(", ")}",
-        tree[:sha], parent[:object][:sha]
+        repo, message, tree[:sha], parent[:object][:sha]
       )
 
       # don't update the ref if the commit introduced no new changes

data/lib/txgh/github_repo.rb

@@ -71,6 +71,10 @@ module Txgh
       !(webhook_secret || '').empty?
     end
 
+    def commit_message
+      config['commit_message']
+    end
+
     private
 
     def should_process_branch?(candidate)

data/lib/txgh/handlers/github/push_handler.rb

@@ -10,7 +10,7 @@ module Txgh
           logger.info("request github branch: #{branch}")
           logger.info("config github branch: #{repo.github_config_branch}")
 
-          if repo.should_process_ref?(branch)
+          if should_process?
             logger.info('found branch in github request')
 
             tx_resources = tx_resources_for(branch)
@@ -102,6 +102,20 @@ module Txgh
           @ref ||= payload['ref'].sub(/^refs\//, '')
         end
 
+        def should_process?
+          should_process_branch? && should_process_commit?
+        end
+
+        def should_process_branch?
+          repo.should_process_ref?(branch)
+        end
+
+        def should_process_commit?
+          # return false if 'after' commit sha is all zeroes (indicates branch
+          # has been deleted)
+          !(payload.fetch('after', '') =~ /\A0+\z/)
+        end
+
       end
     end
   end

data/lib/txgh/resource_committer.rb

@@ -1,5 +1,7 @@
 module Txgh
   class ResourceCommitter
+    DEFAULT_COMMIT_MESSAGE = "Updating %{language} translations in %{file_name}"
+
     attr_reader :project, :repo, :logger
 
     def initialize(project, repo, logger = nil)
@@ -13,9 +15,10 @@ module Txgh
 
       unless language == tx_resource.source_lang
         file_name, translations = download(tx_resource, branch, language)
+        message = commit_message_for(language, file_name)
 
         if translations
-          repo.api.commit(repo.name, branch, { file_name => translations })
+          repo.api.commit(repo.name, branch, { file_name => translations }, message)
           fire_event_for(tx_resource, branch, language)
         end
       end
@@ -45,6 +48,16 @@ module Txgh
       downloader.first
     end
 
+    def commit_message_for(language, file_name)
+      commit_message_template % {
+        language: language, file_name: file_name
+      }
+    end
+
+    def commit_message_template
+      repo.commit_message || DEFAULT_COMMIT_MESSAGE
+    end
+
     def prevent_commit_on?(branch)
       project.protected_branches.include?(branch)
     end

data/lib/txgh/version.rb

@@ -1,3 +1,3 @@
 module Txgh
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/lib/txgh.rb

@@ -30,6 +30,8 @@ module Txgh
   autoload :TxResource,            'txgh/tx_resource'
   autoload :Utils,                 'txgh/utils'
 
+  DEFAULT_ENV = 'development'
+
   class << self
     def tx_manager
       Txgh::Config::TxManager
@@ -54,6 +56,10 @@ module Txgh
 
       GithubStatus.new(project, repo, resource).update(options.fetch(:sha))
     end
+
+    def env
+      ENV.fetch('TXGH_ENV', DEFAULT_ENV)
+    end
   end
 
   # default set of tx config providers

data/spec/github_api_spec.rb

@@ -49,12 +49,12 @@ describe GithubApi do
     it 'creates a new commit and updates the branch' do
       expect(client).to(
         receive(:create_commit)
-          .with(repo, "Updating translations for #{path}", :new_tree_sha, :branch_sha)
+          .with(repo, 'message', :new_tree_sha, :branch_sha)
           .and_return(sha: :new_commit_sha)
       )
 
       expect(client).to receive(:update_ref).with(repo, branch, :new_commit_sha, false)
-      api.commit(repo, branch, { path => :new_content }, true)
+      api.commit(repo, branch, { path => :new_content }, 'message', true)
     end
 
     it 'updates multiple files at a time' do
@@ -62,13 +62,13 @@ describe GithubApi do
 
       expect(client).to(
         receive(:create_commit)
-          .with(repo, "Updating translations for #{path}, #{other_path}", :new_tree_sha, :branch_sha)
+          .with(repo, 'message', :new_tree_sha, :branch_sha)
           .and_return(sha: :new_commit_sha)
       )
 
       expect(client).to receive(:update_ref).with(repo, branch, :new_commit_sha, false)
       content_map = { path => :new_content, other_path => :other_content }
-      api.commit(repo, branch, content_map, true)
+      api.commit(repo, branch, content_map, 'message', true)
     end
 
     context 'with an empty commit' do
@@ -81,14 +81,14 @@ describe GithubApi do
 
         expect(client).to(
           receive(:create_commit)
-            .with(repo, "Updating translations for #{path}", :new_tree_sha, :branch_sha)
+            .with(repo, 'message', :new_tree_sha, :branch_sha)
             .and_return(sha: :new_commit_sha)
         )
       end
 
       it 'does not allow empty commits by default' do
         expect(client).to_not receive(:update_ref)
-        api.commit(repo, branch, { path => :new_content })
+        api.commit(repo, branch, { path => :new_content }, 'message')
       end
     end
 
@@ -102,14 +102,14 @@ describe GithubApi do
 
         expect(client).to(
           receive(:create_commit)
-            .with(repo, "Updating translations for #{path}", :new_tree_sha, :branch_sha)
+            .with(repo, 'message', :new_tree_sha, :branch_sha)
             .and_return(sha: :new_commit_sha)
         )
       end
 
       it 'updates the ref as expected' do
         expect(client).to receive(:update_ref).with(repo, branch, :new_commit_sha, false)
-        api.commit(repo, branch, { path => :new_content })
+        api.commit(repo, branch, { path => :new_content }, 'message')
       end
     end
   end

data/spec/handlers/github/push_handler_spec.rb

@@ -35,7 +35,7 @@ describe PushHandler do
       modified: modified_files.map { |f| f['path'] }
     )
 
-    expect(ResourceUpdater).to receive(:new).and_return(updater)
+    allow(ResourceUpdater).to receive(:new).and_return(updater)
   end
 
   it 'correctly uploads modified resources to transifex' do
@@ -73,4 +73,22 @@ describe PushHandler do
       expect(response.body).to eq(true)
     end
   end
+
+  context 'with a deleted branch' do
+    let(:before) { nil }
+    let(:after) { '0' * 40 }
+
+    let(:payload) do
+      GithubPayloadBuilder.push_payload(repo_name, ref, before, after)
+    end
+
+    it "doesn't upload anything" do
+      expect(updater).to_not receive(:update_resource)
+      expect(github_api).to_not receive(:create_ref)
+
+      response = handler.execute
+      expect(response.status).to eq(200)
+      expect(response.body).to eq(true)
+    end
+  end
 end

data/spec/handlers/transifex/hook_handler_spec.rb

@@ -26,6 +26,10 @@ describe HookHandler do
     instance_double(ResourceDownloader)
   end
 
+  let(:file_name) do
+    "translations/#{language}/sample.yml"
+  end
+
   before(:each) do
     allow(ResourceDownloader).to receive(:new).and_return(downloader)
     allow(downloader).to(receive(:first)).and_return([
@@ -40,9 +44,9 @@ describe HookHandler do
   it 'downloads translations and pushes them to the correct branch (head)' do
     expect(github_api).to(
       receive(:commit).with(
-        repo_name, "heads/#{branch}", {
-          "translations/#{language}/sample.yml" => translations
-        }
+        repo_name, "heads/#{branch}",
+        { "translations/#{language}/sample.yml" => translations },
+        "Updating #{language} translations in #{file_name}"
       )
     )
 
@@ -87,9 +91,9 @@ describe HookHandler do
 
       expect(github_api).to(
         receive(:commit).with(
-          repo_name, ref, {
-            "translations/#{language}/sample.yml" => translations
-          }
+          repo_name, ref,
+          { "translations/#{language}/sample.yml" => translations },
+          "Updating #{language} translations in #{file_name}"
         )
       )
 
@@ -105,9 +109,9 @@ describe HookHandler do
     it 'downloads translations and pushes them to the tag' do
       expect(github_api).to(
         receive(:commit).with(
-          repo_name, "tags/my_tag", {
-            "translations/#{language}/sample.yml" => translations
-          }
+          repo_name, "tags/my_tag",
+          { "translations/#{language}/sample.yml" => translations },
+          "Updating #{language} translations in #{file_name}"
         )
       )
 

data/spec/helpers/standard_txgh_setup.rb

@@ -19,6 +19,7 @@ module StandardTxghSetup
   let(:translations) { 'translation file contents' }
   let(:diff_point) { nil }
   let(:organization) { 'myorg' }
+  let(:commit_message_template) { nil }  # i.e. use the default
 
   let(:project_config) do
     {
@@ -43,7 +44,8 @@ module StandardTxghSetup
       'tag' => tag,
       'name' => repo_name,
       'webhook_secret' => 'abc123',
-      'diff_point' => diff_point
+      'diff_point' => diff_point,
+      'commit_message' => commit_message_template
     }
   end
 

data/spec/resource_committer_spec.rb

@@ -14,6 +14,10 @@ describe ResourceCommitter do
     ResourceCommitter.new(transifex_project, github_repo, logger)
   end
 
+  let(:commit_message) do
+    "Updating #{language} translations in #{file_name}"
+  end
+
   before(:each) do
     allow(github_api).to receive(:get_ref).and_return(
       object: { sha: 'abc123shashasha' }
@@ -28,7 +32,7 @@ describe ResourceCommitter do
 
         expect(github_api).to(
           receive(:commit).with(
-            repo_name, branch, { file_name => :translations }
+            repo_name, branch, { file_name => :translations }, commit_message
           )
         )
       end
@@ -52,6 +56,15 @@ describe ResourceCommitter do
         expect(options[:resource].original_resource_slug).to eq(resource_slug)
         expect(options[:language]).to eq(language)
       end
+
+      context 'with a custom commit message' do
+        let(:commit_message_template) { "foo %{language}" }
+        let(:commit_message) { "foo #{language}" }
+
+        it 'uses the custom commit message' do
+          committer.commit_resource(resource, branch, language)
+        end
+      end
     end
 
     it "doesn't commit anything if the language is the source language" do

data/spec/txgh_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Txgh do
+  def with_env(env)
+    # ENV can't be duped, so use select instead to make a copy
+    old_env = ENV.select { true }
+    env.each_pair { |k, v| ENV[k] = v }
+    yield
+  ensure
+    # reset back to old vars
+    env.each_pair { |k, _| ENV[k] = old_env[k] }
+  end
+
+  describe '#env' do
+    it 'defaults to development' do
+      expect(Txgh.env).to eq('development')
+    end
+
+    it 'pulls the env out of ENV if set' do
+      with_env('TXGH_ENV' => 'production') do
+        expect(Txgh.env).to eq('production')
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: txgh
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Matthew Jackowski
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abroad
@@ -274,6 +274,7 @@ files:
 - spec/transifex_request_auth_spec.rb
 - spec/tx_branch_resource_spec.rb
 - spec/tx_resource_spec.rb
+- spec/txgh_spec.rb
 - spec/utils_spec.rb
 - txgh.gemspec
 homepage: https://github.com/lumoslabs/txgh