git_er_done 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,47 @@
+Git 'Er Done is a ruby tool for automating common git operations. It's similiar in concept to git flow (https://github.com/nvie/gitflow) but implements a simpler branching model.
+
+## Reasons for this project
+
+This project exists for a few reasons:
+
+1. I have a terrible memory for command line syntax, so I want something that reduces the number of commands I have to remember to do things right.
+2. I want to understand more how to configure git process flows (much like git-flow) does, but have more configurability (via Ruby)
+3. Gives an interesting test case for my Thor talk at DCRUG and Arlington RUG.
+4. Make doing the 'right' thing easy (i.e. feature branches should be simple. Smaller projects)
+
+## Syntax
+
+Things you can do:
+
+```
+gd - Lists all available commands.
+gd help <command> - Get help for a specific command.
+gd feature new_widget - Creates a new feature branch with the name 'new_widget'.
+gd done new_widget  - Completes a feature branch with the name 'new_widget' (Commit, squash, merge and delete branch).
+gd done - Completes the current feature branch you are on.
+gd squash - Condenses multiple commits for the current branch into a single commit.
+gd sync - Brings your branch up to date with the latest version (Use before finishing a feature)
+```
+
+## Goals
+
+Here's what I want to be able to support
+
+* Creating and closing feature branches should be simple.
+* Small projects that can work from and merge to master shouldn't need a 'develop' branch.
+* Should automatically squashing commits from feature branches into a single commit via rebase
+* Support git-flow's Feature, hotfix, release branches to/from develop if necessary.
+* Provide a nice discoverable CLI for doing this sort of thing.
+
+## Todo
+
+* Improve error messages for incorrectly supplied parameters. (i.e. gd feature)
+* If you gd sync with unstaged changes, it should not switch branches. (It does, which is probably wrong)
+* Figure out how to unit test this.
+* Better error checking (merges failing may cause problems)
+
+## References
+
+http://reinh.com/blog/2009/03/02/a-git-workflow-for-agile-teams.html - Target workflow
+http://grit.rubyforge.org/ - A Ruby wrapper around git: Might be useful for more indepth interaction with git.
+http://stackoverflow.com/questions/5294069/best-way-to-create-an-executable-for-a-gem-using-rake - Minimum work to make a CLI bin file.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/gd

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+require 'git_er_done'
+
+Git::Er::Done::App.start

data/git_er_done.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "git_er_done/version"
+
+Gem::Specification.new do |s|
+  s.name        = "git_er_done"
+  s.version     = Git::Er::Done::VERSION
+  s.authors     = ["peakpg"]
+  s.email       = ["peakpg@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A gem to assist with git workflow.}
+  s.description = %q{A gem to assist with git workflow, similar to git-flow.}
+
+  s.rubyforge_project = "git_er_done"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  [['thor', '~> 0.14.6'], ['rails', '~> 3.0.9'], ['grit', '~>2.4']].each do |gem, version|
+    s.add_dependency(gem, version)
+  end
+end

data/lib/git_er_done.rb

@@ -0,0 +1,2 @@
+require "git_er_done/version"
+require 'git_er_done/app'

data/lib/git_er_done/app.rb

@@ -0,0 +1,80 @@
+require 'thor'
+require 'rails/generators/actions'
+require 'grit'
+
+module Git
+  module Er
+    module Done
+      class App < Thor
+        
+        include Thor::Actions
+        include Rails::Generators::Actions
+        
+        FEATURES_PATH = "features/"
+        
+        desc 'feature [NAME]', 'Start a new feature using a branch.'
+        def feature(name)
+          puts "Creating a new feature called #{feature_branch(name)}."
+          git :checkout => "-b #{feature_branch(name)}"
+        end
+          
+        # Add everything, commit it, merge it back into the main branch.
+        desc 'done (NAME)', 'Completes a feature (commits, squashes then merges into master). Call sync before doing this.'
+        def done(name=nil)
+          unless name
+            name = current_feature            
+          end
+          puts "Completing a feature called #{feature_branch(name)}"
+          git :add=>"."
+          git :commit
+          squash
+          # Should we also sync with master first?
+          git :checkout => 'master'
+          git :merge => feature_branch(name)
+          git :branch => "-d #{feature_branch(name)}"        
+        end
+        
+        desc 'squash', 'Squash all commits from the current branch into a single commit.'
+        def squash
+          # Squash all changes since we branched away from master
+          git :rebase => "-i master"
+        end
+        
+        desc 'sync', 'Update your branch with the latest from master.'
+        def sync
+          return_to_branch = current_branch
+          git :checkout => :master
+          git :pull
+          git :checkout => return_to_branch
+          git :rebase => :master
+        end
+        
+        private
+        
+        # Returns the name of the feature for the current branch
+        # @return [String] Name of feature (not include features/)
+        def current_feature
+          b = current_branch
+          if b.start_with?(FEATURES_PATH)
+            return b[FEATURES_PATH.length, b.length]
+          end
+          return ""
+        end
+        
+        def current_branch
+          repo.head.name
+        end
+        
+        def repo
+          repo ||= Grit::Repo.new('.')
+        end
+        
+        def feature_branch(name)  
+          "#{FEATURES_PATH}#{name}"
+        end
+      end
+    end
+  end
+end
+        
+    

data/lib/git_er_done/version.rb

@@ -0,0 +1,7 @@
+module Git
+  module Er
+    module Done
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: git_er_done
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- peakpg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &2153491080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153491080
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2153490500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153490500
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: &2153490080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153490080
+description: A gem to assist with git workflow, similar to git-flow.
+email:
+- peakpg@gmail.com
+executables:
+- gd
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- bin/gd
+- git_er_done.gemspec
+- lib/git_er_done.rb
+- lib/git_er_done/app.rb
+- lib/git_er_done/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: git_er_done
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A gem to assist with git workflow.
+test_files: []