livebuzz-gitx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0616b6dbae3062ab6f77cd11e45b9d093347109e
+  data.tar.gz: 363feec0115bce1bc18baa4998c8be06e0556bcd
+SHA512:
+  metadata.gz: 7d08cf9017d8b2a87190849657421a81bd86b423f31e492da77381456c17fc949e10c79715334ccbb54e2dabd11ca18960794135c633bad0650e7f7001294d8f
+  data.tar.gz: fcbbf1f9a923aa23e21c8b1c0691116fd3b39edd77e6d4636a8d79e2efaa9c8315900b70c3689f529c419b9cb9564ab04e300986739dd37c5e24dd68298d2ecc

data/.gitignore

@@ -0,0 +1,31 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## GIT
+*.orig
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## bundler
+Gemfile.lock
+
+## RSpec temp files
+spec/tmp
+
+## RubyMine
+/.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+livebuzz-gitx

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - '2.1.2'
+before_install:
+  - git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
+  - git fetch

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in your gemspec file
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec', failed_mode: :keep do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan Sonnek
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# livebuzz-gitx
+
+[![Build Status](https://travis-ci.org/livebuzz/livebuzz-gitx.png?branch=master)](https://travis-ci.org/livebuzz/livebuzz-gitx)
+[![Code Coverage](https://coveralls.io/repos/livebuzz/livebuzz-gitx/badge.png)](https://coveralls.io/r/livebuzz/livebuzz-gitx)
+[![Code Climate](https://codeclimate.com/github/livebuzz/livebuzz-gitx.png)](https://codeclimate.com/github/livebuzz/livebuzz-gitx)
+
+Useful Git eXtensions for Development workflow at LiveBuzz.
+
+Forked from [TheGarage-GitX](https://github.com/thegarage/thegarage-gitx), which is inspired by the [socialcast-git-extensions gem](https://github.com/socialcast/socialcast-git-extensions)
+
+# Git Extensions for Workflow
+
+### Options
+* `--trace` or `-v` = verbose output for debugging commands
+* `--pretend` or `-p` = dry run commands and do not actually invoke operations
+
+## git start <new_branch_name (optional)>
+
+update local repository with latest upstream changes and create a new feature branch
+
+## git update
+
+update the local feature branch with latest remote changes plus upstream released changes.
+
+## git integrate <aggregate_branch_name (optional, default: staging)>
+
+integrate the current feature branch into an aggregate branch (ex: prototype, staging)
+
+## git review
+
+create a pull request on github for peer review of the current branch.  This command is re-runnable
+in order to re-assign pull requests.
+
+options:
+* `--assign` or `-a` = assign pull request to github user
+* `--open` or `-o` = open pull request in default web browser.
+* `--bump` or `-b` = bump an existing pull request by posting a comment to re-review new changes
+* `--approve` = approve/signoff on pull request (with optional feedback)
+* `--reject` = reject pull request (with details)
+
+NOTE: the `--bump` option will also update the pull request commit status to mark the branch as 'pending peer review'.
+This setting is cleared when a reviewer approves or rejects the pull request.
+
+## git release
+
+release the current feature branch to master.  This operation will perform the following:
+
+* pull in latest code from remote branch
+* merge in latest code from master branch
+* prompt user to confirm they actually want to perform the release
+* merge current branch into master
+* (optional) cleanup merged branches from remote server
+
+options:
+* `--cleanup` = automatically cleanup merged branches after release complete
+
+# Extra Utility Git Extensions
+
+## git cleanup
+
+delete released branches after they have been merged into master.
+
+## git nuke <aggregate_branch_name>
+
+reset an aggregate branch (ex: prototype, staging) back to a known good state.
+
+## git buildtag
+
+create a build tag for the current Travis-CI build and push it back to origin
+
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2015 LiveBuzz Ltd. (c) 2013 The Garage, Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/bin/git-buildtag

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'livebuzz/gitx/cli/buildtag_command'
+args = ARGV.dup.unshift('buildtag')
+LiveBuzz::Gitx::Cli::BuildtagCommand.start(args)

data/bin/git-cleanup

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'livebuzz/gitx/cli/cleanup_command'
+args = ARGV.dup.unshift('cleanup')
+LiveBuzz::Gitx::Cli::CleanupCommand.start(args)
+

data/bin/git-integrate

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'livebuzz/gitx/cli/integrate_command'
+args = ARGV.dup.unshift('integrate')
+LiveBuzz::Gitx::Cli::IntegrateCommand.start(args)

data/bin/git-nuke

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'livebuzz/gitx/cli/nuke_command'
+args = ARGV.dup.unshift('nuke')
+LiveBuzz::Gitx::Cli::NukeCommand.start(args)

data/bin/git-release

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'livebuzz/gitx/cli/release_command'
+args = ARGV.dup.unshift('release')
+LiveBuzz::Gitx::Cli::ReleaseCommand.start(args)

data/bin/git-review

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'livebuzz/gitx/cli/review_command'
+args = ARGV.dup.unshift('review')
+LiveBuzz::Gitx::Cli::ReviewCommand.start(args)

data/bin/git-reviewrequest

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+puts 'WARNING: git reviewrequest has been deprecated.  use `git review` instead'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'livebuzz/gitx/cli/review_command'
+args = ARGV.dup.unshift('review')
+LiveBuzz::Gitx::Cli::ReviewCommand.start(args)

data/bin/git-share

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'livebuzz/gitx/cli/share_command'
+args = ARGV.dup.unshift('share')
+LiveBuzz::Gitx::Cli::ShareCommand.start(args)

data/bin/git-start

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'livebuzz/gitx/cli/start_command'
+args = ARGV.dup.unshift('start')
+LiveBuzz::Gitx::Cli::StartCommand.start(args)

data/bin/git-track

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'livebuzz/gitx/cli/track_command'
+args = ARGV.dup.unshift('track')
+LiveBuzz::Gitx::Cli::TrackCommand.start(args)

data/bin/git-update

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'livebuzz/gitx/cli/update_command'
+args = ARGV.dup.unshift('update')
+LiveBuzz::Gitx::Cli::UpdateCommand.start(args)

data/lib/livebuzz/gitx/cli/base_command.rb

@@ -0,0 +1,58 @@
+require 'thor'
+require 'pathname'
+require 'rugged'
+require 'livebuzz/gitx'
+
+module LiveBuzz
+  module Gitx
+    module Cli
+      class BaseCommand < Thor
+        include Thor::Actions
+
+        class MergeError < Thor::Error; end
+
+        add_runtime_options!
+
+        method_option :trace, :type => :boolean, :aliases => '-v'
+        def initialize(*args)
+          super(*args)
+        end
+
+        private
+
+        def repo
+          @repo ||= begin
+            path = Dir.pwd
+            Rugged::Repository.discover(path)
+          end
+        end
+
+        def checkout_branch(branch_name)
+          run_cmd "git checkout #{branch_name}"
+        end
+
+        # lookup the current branch of the repo
+        def current_branch
+          repo.branches.find(&:head?)
+        end
+
+        def assert_aggregate_branch!(target_branch)
+          fail "Invalid aggregate branch: #{target_branch} must be one of supported aggregate branches #{config.aggregate_branches}" unless config.aggregate_branch?(target_branch)
+        end
+
+        def assert_not_protected_branch!(branch, action)
+          raise "Cannot #{action} reserved branch" if config.reserved_branch?(branch) || config.aggregate_branch?(branch)
+        end
+
+        # helper to invoke other CLI commands
+        def execute_command(command_class, method, args = [])
+          command_class.new.send(method, *args)
+        end
+
+        def config
+          @configuration ||= LiveBuzz::Gitx::Configuration.new(repo.workdir)
+        end
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/cli/buildtag_command.rb

@@ -0,0 +1,41 @@
+require 'thor'
+require 'livebuzz/gitx'
+require 'livebuzz/gitx/cli/base_command'
+
+module LiveBuzz
+  module Gitx
+    module Cli
+      class BuildtagCommand < BaseCommand
+
+        desc 'buildtag', 'create a tag for the current build and push it back to origin (supports Travis CI and Codeship)'
+        def buildtag
+          fail "Unknown branch. Environment variables TRAVIS_BRANCH or CI_BRANCH are required" unless branch_name
+          fail "Branch must be one of the supported taggable branches: #{config.taggable_branches}" unless config.taggable_branch?(branch_name)
+
+          label = "buildtag generated by build #{build_number}"
+          create_build_tag(branch_name, label)
+        end
+
+        private
+
+        # pull the current branch name from environment variables
+        # supports Travis CI or Codeship variables
+        # see https://www.codeship.io/documentation/continuous-integration/set-environment-variables/
+        def branch_name
+          ENV['TRAVIS_BRANCH'] || ENV['CI_BRANCH']
+        end
+
+        def build_number
+          ENV['TRAVIS_BUILD_NUMBER'] || ENV['CI_BUILD_NUMBER']
+        end
+
+        def create_build_tag(branch, label)
+          timestamp = Time.now.utc.strftime '%Y-%m-%d-%H-%M-%S'
+          git_tag = "build-#{branch}-#{timestamp}"
+          run_cmd "git tag #{git_tag} -a -m '#{label}'"
+          run_cmd "git push origin #{git_tag}"
+        end
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/cli/cleanup_command.rb

@@ -0,0 +1,47 @@
+require 'thor'
+require 'livebuzz/gitx'
+require 'livebuzz/gitx/cli/base_command'
+
+module LiveBuzz
+  module Gitx
+    module Cli
+      class CleanupCommand < BaseCommand
+        desc 'cleanup', 'Cleanup branches that have been merged into master from the repo'
+        def cleanup
+          checkout_branch LiveBuzz::Gitx::BASE_BRANCH
+          run_cmd "git pull"
+          run_cmd 'git remote prune origin'
+
+          say "Deleting local and remote branches that have been merged into "
+          say LiveBuzz::Gitx::BASE_BRANCH, :green
+          merged_branches(remote: true).each do |branch|
+            run_cmd "git push origin --delete #{branch}"
+          end
+          merged_branches(remote: false).each do |branch|
+            run_cmd "git branch -d #{branch}"
+          end
+        end
+
+        private
+
+        # @return list of branches that have been merged
+        def merged_branches(options = {})
+          args = []
+          args << '-r' if options[:remote]
+          args << "--merged"
+          output = run_cmd("git branch #{args.join(' ')}").split("\n")
+          branches = output.map do |branch|
+            branch = branch.gsub(/\*/, '').strip.split(' ').first
+            branch = branch.split('/').last if options[:remote]
+            branch
+          end
+          branches.uniq!
+          branches -= config.reserved_branches
+          branches.reject! { |b| config.aggregate_branch?(b) }
+
+          branches
+        end
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/cli/integrate_command.rb

@@ -0,0 +1,95 @@
+require 'thor'
+require 'livebuzz/gitx'
+require 'livebuzz/gitx/cli/base_command'
+require 'livebuzz/gitx/cli/update_command'
+require 'livebuzz/gitx/github'
+
+module LiveBuzz
+  module Gitx
+    module Cli
+      class IntegrateCommand < BaseCommand
+        include LiveBuzz::Gitx::Github
+        desc 'integrate', 'integrate the current branch into one of the aggregate development branches (default = staging)'
+        method_option :resume, :type => :string, :aliases => '-r', :desc => 'resume merging of feature-branch'
+        def integrate(integration_branch = 'staging')
+          assert_aggregate_branch!(integration_branch)
+
+          branch = feature_branch_name
+          print_message(branch, integration_branch)
+
+          begin
+            execute_command(UpdateCommand, :update)
+          rescue
+            fail MergeError, "Merge Conflict Occurred. Please Merge Conflict Occurred. Please fix merge conflict and rerun the integrate command"
+          end
+
+          integrate_branch(branch, integration_branch) unless options[:resume]
+          checkout_branch branch
+
+          create_integrate_comment(branch) unless config.reserved_branch?(branch)
+        end
+
+        private
+
+        def print_message(branch, integration_branch)
+          message = options[:resume] ? 'Resuming integration of' : 'Integrating'
+          say "#{message} "
+          say "#{branch} ", :green
+          say "into "
+          say integration_branch, :green
+        end
+
+        def integrate_branch(branch, integration_branch)
+          fetch_remote_branch(integration_branch)
+          begin
+            run_cmd "git merge #{branch}"
+          rescue
+            fail MergeError, "Merge Conflict Occurred. Please fix merge conflict and rerun command with --resume #{branch} flag"
+          end
+          run_cmd "git push origin HEAD"
+        end
+
+        def feature_branch_name
+          @feature_branch ||= begin
+            feature_branch = options[:resume] || current_branch.name
+            until local_branch_exists?(feature_branch)
+              feature_branch = ask("#{feature_branch} does not exist. Please select one of the available local branches: #{local_branches}")
+            end
+            feature_branch
+          end
+        end
+
+        # nuke local branch and pull fresh version from remote repo
+        def fetch_remote_branch(target_branch)
+          create_remote_branch(target_branch) unless remote_branch_exists?(target_branch)
+          run_cmd "git fetch origin"
+          run_cmd "git branch -D #{target_branch}", :allow_failure => true
+          checkout_branch target_branch
+        end
+
+        def local_branch_exists?(branch)
+          local_branches.include?(branch)
+        end
+
+        def local_branches
+          @local_branches ||= repo.branches.each_name(:local)
+        end
+
+        def remote_branch_exists?(target_branch)
+          repo.branches.each_name(:remote).include?("origin/#{target_branch}")
+        end
+
+        def create_remote_branch(target_branch)
+          repo.create_branch(target_branch, LiveBuzz::Gitx::BASE_BRANCH)
+          run_cmd "git push origin #{target_branch}:#{target_branch}"
+        end
+
+        def create_integrate_comment(branch)
+          pull_request = find_or_create_pull_request(branch)
+          comment = '[gitx] integrated into staging :twisted_rightwards_arrows:'
+          github_client.add_comment(github_slug, pull_request.number, comment)
+        end
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/cli/nuke_command.rb

@@ -0,0 +1,64 @@
+require 'thor'
+require 'livebuzz/gitx'
+require 'livebuzz/gitx/cli/base_command'
+
+module LiveBuzz
+  module Gitx
+    module Cli
+      class NukeCommand < BaseCommand
+        desc 'nuke', 'nuke the specified aggregate branch and reset it to a known good state'
+        method_option :destination, :type => :string, :aliases => '-d', :desc => 'destination branch to reset to'
+        def nuke(bad_branch)
+          good_branch = options[:destination] || ask("What branch do you want to reset #{bad_branch} to? (default: #{bad_branch})")
+          good_branch = bad_branch if good_branch.length == 0
+
+          last_known_good_tag = current_build_tag(good_branch)
+          return unless yes?("Reset #{bad_branch} to #{last_known_good_tag}? (y/n)", :green)
+          assert_aggregate_branch!(bad_branch)
+          return if migrations_need_to_be_reverted?(bad_branch, last_known_good_tag)
+
+          say "Resetting "
+          say "#{bad_branch} ", :green
+          say "branch to "
+          say last_known_good_tag, :green
+
+          checkout_branch LiveBuzz::Gitx::BASE_BRANCH
+          run_cmd "git branch -D #{bad_branch}", :allow_failure => true
+          run_cmd "git push origin --delete #{bad_branch}", :allow_failure => true
+          run_cmd "git checkout -b #{bad_branch} #{last_known_good_tag}"
+          run_cmd "git push origin #{bad_branch}"
+          run_cmd "git branch --set-upstream-to origin/#{bad_branch}"
+          checkout_branch LiveBuzz::Gitx::BASE_BRANCH
+        end
+
+        private
+
+        def migrations_need_to_be_reverted?(bad_branch, last_known_good_tag)
+          return false unless File.exist?('db/migrate')
+          outdated_migrations = run_cmd("git diff #{last_known_good_tag}...#{bad_branch} --name-only db/migrate").split
+          return false if outdated_migrations.empty?
+
+          say "#{bad_branch} contains migrations that may need to be reverted.  Ensure any reversable migrations are reverted on affected databases before nuking.", :red
+          say 'Example commands to revert outdated migrations:'
+          outdated_migrations.reverse.each do |migration|
+            version = File.basename(migration).split('_').first
+            say "rake db:migrate:down VERSION=#{version}"
+          end
+          !yes?("Are you sure you want to nuke #{bad_branch}? (y/n) ", :green)
+        end
+
+        def current_build_tag(branch)
+          last_build_tag = build_tags_for_branch(branch).last
+          raise "No known good tag found for branch: #{branch}.  Verify tag exists via `git tag -l 'build-#{branch}-*'`" unless last_build_tag
+          last_build_tag
+        end
+
+        def build_tags_for_branch(branch)
+          run_cmd "git fetch --tags"
+          build_tags = run_cmd("git tag -l 'build-#{branch}-*'").split
+          build_tags.sort
+        end
+      end
+    end
+  end
+end

data/lib/livebuzz/gitx/cli/release_command.rb

@@ -0,0 +1,41 @@
+require 'thor'
+require 'livebuzz/gitx'
+require 'livebuzz/gitx/cli/base_command'
+require 'livebuzz/gitx/cli/update_command'
+require 'livebuzz/gitx/cli/integrate_command'
+require 'livebuzz/gitx/cli/cleanup_command'
+require 'livebuzz/gitx/github'
+
+module LiveBuzz
+  module Gitx
+    module Cli
+      class ReleaseCommand < BaseCommand
+        include LiveBuzz::Gitx::Github
+
+        desc 'release', 'release the current branch to production'
+        method_option :cleanup, :type => :boolean, :desc => 'cleanup merged branches after release'
+        def release
+          return unless yes?("Release #{current_branch.name} to production? (y/n)", :green)
+
+          branch = current_branch.name
+          assert_not_protected_branch!(branch, 'release')
+          execute_command(UpdateCommand, :update)
+
+          find_or_create_pull_request(branch)
+          status = branch_status(branch)
+          if status != 'success'
+            return unless yes?("Branch status is currently: #{status}.  Proceed with release? (y/n)", :red)
+          end
+
+          checkout_branch LiveBuzz::Gitx::BASE_BRANCH
+          run_cmd "git pull origin #{LiveBuzz::Gitx::BASE_BRANCH}"
+          run_cmd "git merge --no-ff #{branch}"
+          run_cmd "git push origin HEAD"
+
+          execute_command(IntegrateCommand, :integrate, 'staging')
+          execute_command(CleanupCommand, :cleanup) if options[:cleanup]
+        end
+      end
+    end
+  end
+end