git_commands 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00a6f3b64ac568ed9a8a00e28c157015f70a5892
+  data.tar.gz: deeb00dac84552dd33e4f8bfde79aaae31d8ee90
+SHA512:
+  metadata.gz: dd423813e1be43a52b56011ef9c49540b759342e04fca35981967b618166c8613a1ac4eff440b69bebaabcaa0bee6ce1edd15850220e704d239b206a47cef16a
+  data.tar.gz: 44a626d66746877bb03092572b74541858607a81f698d46e69887747660f6f181a48f4b36e43c16a62fcac1dc0dec6a3a55f9dafb66e2774f5d9b8590a3d00f5

data/.gitignore

@@ -0,0 +1,5 @@
+/.vagrant/
+/.bundle/
+.branches
+Gemfile.lock
+*.gem

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.8
+  - 2.2.1
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Michele Costa
+
+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,79 @@
+## Table of Contents
+* [Workflow](#workflow)
+* [Scope](#scope)
+* [Installation](#installation)
+* [Usage](#usage)
+  * [setup](#setup)
+  * [rebase](#rebase)
+  * [purge](#purge)
+  * [aggregate](#aggregate)
+
+## Workflow
+This script will facilitate adopting a subset of the branch-featuring workflow characterised by:
+* each **feature** will have **its own branch**
+* **feature** branches **derive** directly **form master**
+* **integration** of master to feature branch happens **via rebasing**
+* rebasing interactively is used on feature branch to **squash commits** to get a **single one per feature** branch
+* **pushing with force** on local branches is not an issue
+* **release** branches are created **aggregating multiple branches** into a new one
+
+## Scope
+The scope of this is helping out in the following cases:
+* you have multiple feature branches waiting for release due to some reason (i.e. long QA time...), and need to keep them aligned with master
+* you need to quickly aggregate branches for a release
+
+## Installation
+I assume you have GIT installed ;)  
+You will probably use this gem standalone, since i see no use in including it into another project.  
+Just clone the Github repository, move to the gem directory and start using rake tasks.
+
+## Usage
+Here are the main Rake tasks:
+
+### setup
+The core of the library is automating multiple branches fetching, this action happens in two concurrent ways:  
+* from the command line, by splitting a comma separated list
+* by reading a file where names are listed on each line
+In case **no branches** are fetched the **script halts**.
+
+Is also assumed you're pointing to a project directory somewhere, so the script could move in and execute the GIT commands for you.
+
+To call this task with arguments call it like that:
+```ruby
+rake git_commands:setup repo=git_repository base_dir=repo_path branches_file=file_listing_branches branches=list,of,branches,separated,by,comma
+```
+Here are the arguments list:
+* **repo**: the repository name you want to automate git commant to
+* **base_dir**: the base path to your GIT repo, excluding its name (specified eralier). It defaults to HOME/Sites
+* **branches_file**: the path to the file, if any, listing the branches names. It defaults to the **.branches** file inside of your repo path (you need to add it to the .gitignore then)
+* **branches**: a list of branches separated by comma (optional), if specified it has precedence over the branches_file
+
+### rebase
+This is probably the most useful command in case you have several branch to rebase with _origin/master_ frequently.
+Consider after the rebase the branch is pushed to origin with force, so be aware in case more than one programmer access the same branch from different computers.  
+A confirmation is asked to continue.  
+
+As the other tasks, it depends on the setup one, so it accepts the same arguments:
+```ruby
+# loads branches from the repo .branches file, repo si located at HOME/Sites/my_repo
+rake git_commands:rebase repo=my_repo
+```
+
+### purge
+This command remove the specified branches locally and remotely.  
+A confirmation is asked before each removal.  
+It uses the same arguments as setup:
+```ruby
+# purge old branches specified at the command line, repo is located at HOME/Sites/my_repo
+rake git_commands:purge repo=my_repo branches=old_branch,older_branch,oldest_branch
+```
+
+### aggregate
+It should be useful to aggregate your branches into a single one in case you want to create a release branch.  
+It uses the following naming convention: rb_yyyy_mm_dd  
+A confirmation is asked to continue.  
+It uses the same arguments as setup:
+```ruby
+# aggregate branches listed in the /tmp/to_release file, repo si located at HOME/Sites/my_repo
+rake git_commands:aggregate repo=my_repo branches_file=/tmp/to_release
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+import 'lib/tasks/git_commands.rake'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.test_files = FileList['spec/*_spec.rb']
+end
+
+task :default => :spec

data/Vagrantfile

@@ -0,0 +1,80 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure(2) do |config|
+  # The most common configuration options are documented and commented below.
+  # For a complete reference, please see the online documentation at
+  # https://docs.vagrantup.com.
+
+  # Every Vagrant development environment requires a box. You can search for
+  # boxes at https://atlas.hashicorp.com/search.
+  config.vm.box = "ubuntu/trusty64"
+
+  # Disable automatic box update checking. If you disable this, then
+  # boxes will only be checked for updates when the user runs
+  # `vagrant box outdated`. This is not recommended.
+  config.vm.box_check_update = false
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine. In the example below,
+  # accessing "localhost:8080" will access port 80 on the guest machine.
+  # config.vm.network "forwarded_port", guest: 80, host: 8080
+
+  # Create a private network, which allows host-only access to the machine
+  # using a specific IP.
+  config.vm.network "private_network", ip: "192.168.33.22"
+
+  # Create a public network, which generally matched to bridged network.
+  # Bridged networks make the machine appear as another physical device on
+  # your network.
+  # config.vm.network "public_network"
+
+  # Share an additional folder to the guest VM. The first argument is
+  # the path on the host to the actual folder. The second argument is
+  # the path on the guest to mount the folder. And the optional third
+  # argument is a set of non-required options.
+  # config.vm.synced_folder "../data", "/vagrant_data"
+
+  # Provider-specific configuration so you can fine-tune various
+  # backing providers for Vagrant. These expose provider-specific options.
+  # Example for VirtualBox:
+  #
+  config.vm.provider "virtualbox" do |vb|
+    # Display the VirtualBox GUI when booting the machine
+    #vb.gui = true
+ 
+    # Customize the amount of memory on the VM:
+    vb.memory = "6144"
+    vb.cpus = 3
+  end
+  #
+  # View the documentation for the provider you are using for more
+  # information on available options.
+
+  # Define a Vagrant Push strategy for pushing to Atlas. Other push strategies
+  # such as FTP and Heroku are also available. See the documentation at
+  # https://docs.vagrantup.com/v2/push/atlas.html for more information.
+  # config.push.define "atlas" do |push|
+  #   push.app = "YOUR_ATLAS_USERNAME/YOUR_APPLICATION_NAME"
+  # end
+
+  # Enable provisioning with a shell script. Additional provisioners such as
+  # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the
+  # documentation for more information about their specific syntax and use.
+  # config.vm.provision "shell", inline: <<-SHELL
+  #   sudo apt-get update
+  #   sudo apt-get install -y apache2
+  # SHELL 
+  $script = [
+    "sudo apt-add-repository ppa:brightbox/ruby-ng",
+    "sudo apt-get update",
+    "sudo apt-get -y -q install build-essential libssl-dev git",
+    "sudo apt-get -y -q install ruby2.2 ruby2.2-dev",
+    "sudo gem install bundler"]
+
+  config.vm.provision "shell", inline: $script.join(" && ")
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "git_utils"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/git_commands.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git_commands/version'
+
+Gem::Specification.new do |s|
+  s.name = "git_commands"
+  s.version = GitCommands::VERSION
+  s.authors = ["costajob"]
+  s.email = ["costajob@gmail.com"]
+  s.summary = "Utility library to rebase and aggregate your project branches"
+  s.homepage = "https://github.com/costajob/git_commands.git"
+  s.license = "MIT"
+  s.required_ruby_version = ">= 1.9.2"
+
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|s|features)/}) }
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.11"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "minitest", "~> 5.0"
+  s.add_development_dependency "rr", "~> 1.2"
+end

data/lib/git_commands.rb

@@ -0,0 +1 @@
+require 'git_commands/command'

data/lib/git_commands/colorize.rb

@@ -0,0 +1,22 @@
+module GitCommands
+  module Colorize
+    CODES = {
+      :red => 31,
+      :green => 32,
+      :yellow => 33,
+      :blue => 34,
+      :magenta => 35,
+      :cyan => 36,
+      :grey => 37
+    }
+
+  end
+end
+
+String.instance_eval do
+  GitCommands::Colorize::CODES.each do |message, code|
+    define_method(message) do
+      "\e[#{code}m#{self}\e[0m"
+    end
+  end
+end

data/lib/git_commands/command.rb

@@ -0,0 +1,135 @@
+require 'pathname'
+require 'fileutils'
+require 'net/http'
+require 'git_commands/prompt'
+
+module GitCommands
+  class Command
+    include Prompt
+
+    class GitError < StandardError; end
+    class NoBranchesError < StandardError; end
+
+    GITHUB_HOST = 'github.com'
+    BASE_DIR = File.join(ENV['HOME'], 'Sites')
+    UNFINISHED_REBASE_FILES = %w(rebase-merge rebase-apply)
+
+    def self.check_connection
+      !!Net::HTTP.new(GITHUB_HOST).head('/')
+    rescue Errno::ENETUNREACH => e
+      raise e, 'There is no connection!'
+    end
+
+    def initialize(options = {})
+      self.class.check_connection
+      @repo = options[:repo] || error('Please specify a valid repository name!', ArgumentError)
+      @base_dir = options[:base_dir]  || BASE_DIR
+      @branches_file = options[:branches_file] || repo_path.join('.branches')
+      @branches = options[:branches].to_s.split(',')
+      fetch_branches
+      check_branches
+    end
+
+    def purge
+      enter_repo do
+        @branches.each do |branch|
+          error('Trying ro remove master!', GitError) if branch == 'master'
+          warning("Removing branch: #{branch}")
+          confirm('Remove local branch') do
+            `git branch -D #{branch}`
+          end
+          confirm('Remove remote branch') do
+            `git push origin :#{branch}`
+          end
+        end
+      end
+    end
+
+    def rebase
+      confirm('Proceed rebasing these branches') do
+        enter_repo do
+          @branches.each do |branch|
+            warning("Rebasing branch: #{branch}")
+            `git checkout #{branch}`
+            `git pull origin #{branch}`
+            rebase_with_master
+            `git push origin #{branch} -f`
+            `git checkout master`
+            `git branch -D #{branch}`
+            success 'Rebased successfully!'
+          end
+        end
+      end
+    end
+
+    def aggregate
+      temp = "temp_#{aggregate_name}"
+      confirm("Aggregate branches into #{aggregate_name}") do
+        enter_repo do
+          `git branch #{aggregate_name}`
+          @branches.each do |branch|
+            warning("Merging branch: #{branch}")
+            `git checkout -b #{temp} origin/#{branch} --no-track`
+            rebase_with_master
+            `git rebase #{aggregate_name}`
+            `git checkout #{aggregate_name}`
+            `git merge #{temp}`
+            `git branch -d #{temp}`
+          end      
+        end
+        success 'Aggregate branch created'
+      end
+    end
+
+    private 
+
+    def repo_path
+      @repo_path ||= Pathname::new(File.join(@base_dir, @repo))
+    end
+
+    def fetch_branches
+      return unless @branches.empty? && File.exist?(@branches_file)
+      warning('Loading branches file')
+      @branches = File.foreach(@branches_file).map(&:strip)
+    end
+
+    def check_branches
+      error('No branches have been loaded!', NoBranchesError) if @branches.empty?
+      print_branches
+    end
+
+    def print_branches
+      size = @branches.to_a.size
+      plural = size > 1 ? 'es' : ''
+      success "Successfully loaded #{size} branch#{plural}:"
+      puts @branches.each_with_index.map { |branch, i| "#{(i+1).to_s.rjust(2, '0')}. #{branch}" } + ['']
+    end
+
+    def pull_master
+      `git checkout master`
+      `git pull`
+    end
+
+    def rebase_with_master
+      `git rebase origin/master`
+      error('Halting unfinished rebase!', GitError) { `git rebase --abort` } if unfinished_rebase?
+    end
+
+    def enter_repo
+      Dir.chdir repo_path do
+        pull_master
+        yield
+      end
+    end
+
+    def unfinished_rebase?
+      UNFINISHED_REBASE_FILES.any? do |name| 
+        File.exists?(repo_path.join('.git', name))
+      end
+    end
+
+    def aggregate_name
+      @aggregate_name ||= Time.new.strftime("rb_%Y-%m-%d")
+    end
+  end
+end

data/lib/git_commands/prompt.rb

@@ -0,0 +1,47 @@
+require 'git_commands/colorize'
+
+module GitCommands
+  module Prompt
+    VALID_ANSWERS = %w[Y y N n]
+
+    class AbortError < StandardError; end
+
+    def warning(message, char = '*')
+      spacer = (char * (message.size + 4)).grey
+      puts "\n", spacer, "#{char} #{message.to_s.yellow} #{char}", spacer, "\n"
+    end
+
+    def error(message, error = StandardError)
+      puts message.to_s.red
+      yield if block_given?
+      fail error, message
+    end
+
+    def success(message)
+      puts message.to_s.green
+    end
+
+    def confirm(message)
+      res = begin
+        ask "#{message} (Y/N)?"
+      end until VALID_ANSWERS.include?(res)
+      case res
+      when /y/i
+        yield
+      else
+        error('Aborted operation!', AbortError)
+      end
+    end
+
+    private 
+    
+    def ask(message)
+      print message.cyan
+      input
+    end
+
+    def input
+      STDIN.gets.chomp
+    end
+  end
+end

data/lib/git_commands/version.rb

@@ -0,0 +1,3 @@
+module GitCommands
+  VERSION = "2.1.0"
+end

data/lib/tasks/git_commands.rake

@@ -0,0 +1,29 @@
+require 'git_commands/command'
+
+namespace :git_commands do
+  desc <<END
+Setup the command instance:
+  > rake git_utils:setup repo=git_repository base_dir=repo_path branches_file=file_listing_branches branches=list,of,branches,separated,by,comma
+END
+  task :setup do
+    @command = GitCommands::Command::new(:repo => ENV['repo'], 
+                                      :base_dir => ENV['base_dir'], 
+                                      :branches_file => ENV['branches_file'], 
+                                      :branches => ENV['branches'])
+  end
+  
+  desc 'Purge specified branches locally and from origin'
+  task :purge => :setup do
+    @command.purge
+  end
+  
+  desc 'Rebase specified branches with master'
+  task :rebase => :setup do
+    @command.rebase
+  end
+  
+  desc 'Aggregate specified branches into a single one'
+  task :aggregate => :setup do
+    @command.aggregate
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: git_commands
+version: !ruby/object:Gem::Version
+  version: 2.1.0
+platform: ruby
+authors:
+- costajob
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 
+email:
+- costajob@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Vagrantfile
+- bin/console
+- bin/setup
+- git_commands.gemspec
+- lib/git_commands.rb
+- lib/git_commands/colorize.rb
+- lib/git_commands/command.rb
+- lib/git_commands/prompt.rb
+- lib/git_commands/version.rb
+- lib/tasks/git_commands.rake
+homepage: https://github.com/costajob/git_commands.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Utility library to rebase and aggregate your project branches
+test_files: []