git_er_done 0.3.0 → 0.4.0

data/README.md

@@ -1,13 +1,12 @@
-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.
+Git 'Er Done is a ruby tool for automating common git operations. It's similar in concept to git flow (https://github.com/nvie/gitflow) but is designed for small teams. It's branching model is quite a bit simpler but still makes it easy to keep an organized Git repository.
 
 ## 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)
+1. Encourage good habits: Practices like rebasing, feature branches and squashing commits make code repositories easy to follow.
+1. Make 'Right way' easy: Doing proper git workflows require a lot of commands. We should script them to make them easy.
+1. Exploration: I want to understand more how to configure git process flows (much like git-flow) does, but have more configurability (via Ruby)
 
 ## Installation
 
@@ -17,9 +16,63 @@ gem install git_er_done
 
 This makes the `gd` command available on your system.
 
+
+## What you get
+
+### 1. Starting Feature Branches
+
+When you work locally, it's helpful to work in a feature branch. To create a feature branch, you would normally do something like:
+
+```
+git checkout -b features/new_widget
+```
+
+With GitErDone, you can type the following to get the same thing:
+
+```
+$ gd feature new_widget
+````
+
+Really, the only benefit from this is prefixing branches with features/, which provides some context to your branch names. (Later, we might add bugs/ and/or 'remote-features')
+
+### 2. Finishing a feature 
+
+After you are done with your feature, you might want to do a few things:
+
+1. Squash your feature's commits into a single commit
+1. Checkout master
+1. Merge your changes
+1. Delete the branch
+
+That's a lot of commands to remember and type. Instead, you can do:
+
+```
+gd done
+```
+
+This will trigger an [interactive rebase](http://book.git-scm.com/4_interactive_rebasing.html) including all changes made since master. You can choose to squash them (or not). Then it will merge your changes with master, and delete your branch.
+
+Pretty simple.
+
+### 3. Keeping in Sync with the master using rebase
+
+Unless you are working by yourself, its likely you may start a feature and before you can merge and push your changes, somebody is going to push changes. It's going to be a lot easier to reconcile your changes sooner than later. With GitErDone, you can do the following when working in your feature branch.
+
+```
+(features/new_widget)$ gd sync
+```
+
+This will do the following:
+
+1. Checkout master and then pull
+1. Checkout your branch
+1. Rebase your branch from master. See [rebasing](http://book.git-scm.com/4_rebasing.html) for more info.
+
+Syncing frequently will help avoid nasty merges later.
+
 ## Syntax
 
-Things you can do:
+Command reference:
 
 ```
 gd - Lists all available commands.
@@ -29,6 +82,7 @@ gd done new_widget  - Completes a feature branch with the name 'new_widget' (Com
 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)
+gd inception - Determines the original branch(es) your current commit came from.
 ```
 
 ## Goals
@@ -36,7 +90,7 @@ gd sync - Brings your branch up to date with the latest version (Use before fini
 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.
+* Small projects that can work from and merge to master shouldn't need a 'develop' branch. (i.e. git-flow)
 * 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.
@@ -45,11 +99,10 @@ Here's what I want to be able to support
 
 * 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.
+* Interactive Rebasing (i.e. Squashing Commits) - http://book.git-scm.com/4_interactive_rebasing.html
+* Target workflow - http://reinh.com/blog/2009/03/02/a-git-workflow-for-agile-teams.html -
+* 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/features/cli.feature

@@ -27,4 +27,57 @@ Feature: CLI
     And the output should contain "Switched to branch 'features/new_widget"
     And the output should contain "Current branch features/new_widget is up to date"
 
-  
+  Scenario: Inception of a branch
+    Given I am working on a git project
+    And I run `git checkout -b staging`
+    And I commit a new file
+    When I run `gd feature new_widget`
+    And I commit another file
+    And I run `gd inception`
+    Then the output should contain:
+    """
+    Current branch 'features/new_widget' was forked from 'staging'
+    """
+
+  Scenario: Ambiguous inception of a branch
+    Given I am working on a git project
+    And I run `git checkout -b staging`
+    When I run `gd feature new_widget`
+    And I commit a new file
+    And I run `gd inception`
+    Then the output should contain:
+    """
+    Current branch 'features/new_widget' matches the following branches: 'master, staging'
+    """
+
+  Scenario: Completing work branched from a non-master branch
+    Given I am working on a git project
+    And I have been working in the "staging" branch
+    When I run `gd feature new_widget`
+    And I commit a new file
+    And I run `gd done`
+    Then the output should contain:
+    """
+    Switched to branch 'staging'
+    """
+
+  Scenario: Completing work that could have been from multiple branches
+    Given I am working on a git project
+    And I run `git checkout -b staging`
+    When I run `gd feature new_widget`
+    And I commit a new file
+    And I run `gd done` interactively
+    And I type "1"
+    Then the output should contain:
+    """
+    Switched to branch 'master'
+    """
+
+  Scenario: Selecting an invalid branch number.
+    Given I am working on a git project
+    And I run `git checkout -b staging`
+    When I run `gd feature new_widget`
+    And I commit a new file
+    And I run `gd done` interactively
+    And I type "3"
+    Then the program should fail using Thor's erroneous exit codes

data/features/step_definitions/cli_steps.rb

@@ -12,4 +12,45 @@ Given /^I am working on the "(.*)" branch$/ do |branch|
 end
 When /^should display the current version$/ do
   assert_partial_output(Git::Er::Done::VERSION, all_output)
+end
+
+When /^I commit a new file$/ do
+  write_file('first.md', "A commit")
+  run_simple "git add ."
+  run_simple "git commit -m 'Add a file'"
+end
+
+When /^I commit another file$/ do
+  write_file('second.md', "A commit")
+  run_simple "git add ."
+  run_simple "git commit -m 'Add a file'"
+end
+
+When /^I make several commits$/ do
+  write_file('first.md', "A commit")
+  run_simple "git add ."
+  run_simple "git commit -m 'Add a file'"
+
+  write_file('second.md', "A commit")
+  run_simple "git add ."
+  run_simple "git commit -m 'Add a file'"
+
+end
+
+When /^I have been working in the "([^"]*)" branch$/ do |branch_name|
+  steps %Q{
+      And I run `git checkout -b #{branch_name}`
+  }
+  write_file("#{branch_name}.md", "First commit for #{branch_name}")
+  run_simple "git add ."
+  run_simple "git commit -m 'First commit for #{branch_name}'"
+end
+
+Then /^the program should fail using Thor's erroneous exit codes$/ do
+  # This really should be 1, but thor doesn't seem to respect error statuses
+  # See http://stackoverflow.com/questions/17241932/ruby-thor-exit-status-in-case-of-an-error
+  steps %Q{
+      Then the exit status should be 0
+      And the output should contain "Error!"
+  }
 end

data/lib/git_er_done/app.rb

@@ -6,51 +6,64 @@ module Git
   module Er
     module Done
       class App < Thor
-        
+
         include Thor::Actions
         include Git::Er::Done::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.'
+
+        desc 'inception', 'Find the branch(es) that the current branch was originally created from.'
+        def inception
+          # Find the first commit that matches one of the heads.
+          matching_branches = inception_branches()
+
+          if matching_branches.size > 1
+            puts "Current branch '#{current_branch.name}' matches the following branches: '#{matching_branches.collect {|b| b.name}.join(", ")}'"
+          else
+            puts "Current branch '#{current_branch.name}' was forked from '#{matching_branches.first.name}'"
+          end
+
+        end
+
+        desc 'done (NAME)', 'Completes a feature (commits, squashes then merges into the inception branch).
+                             Recommend calling sync before doing this.'
         def done(name=nil)
           unless name
-            name = current_feature            
+            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 :checkout => inception_branch_name
           git :merge => feature_branch(name)
-          git :branch => "-d #{feature_branch(name)}"        
+          git :branch => "-d #{feature_branch(name)}"
         end
-        
-        desc 'squash', 'Squash all commits from the current branch into a single commit.'
+
+        desc 'squash', 'Squash all commits from the current branch into a single commit (since inception).'
         def squash
           new_commits = commits_in_feature_branch.size
           if new_commits < 2
             puts "Only '#{new_commits}' new commits in this branch, so no squashing necessary."
             return
           end
-          # Squash all changes since we branched away from master
-          git :rebase => "-i master"
+          # Squash all changes since we branched away from inception branch
+          git :rebase => "-i #{inception_branch_name}"
         end
-        
+
         desc 'info', "Report information about the current feature branch you are in."
         def info
           commits = commits_in_feature_branch
           puts "There are #{commits.size} new commits for #{current_branch_name}"
         end
-        
+
         desc 'sync', 'Update your branch with the latest from master.'
         def sync
           return_to_branch = current_branch_name
@@ -65,13 +78,55 @@ module Git
         def version
           puts "Git-Er-Done #{Git::Er::Done::VERSION}"
         end
+
         private
-        
+
+        def inception_branch_name
+          return @inception_branch.name if @inception_branch
+          branches = inception_branches
+          @inception_branch = if branches.size > 1
+            say 'There is more than one possible inception branch for your current feature.', :green
+            branches.each_with_index do |branch, i|
+              say "#{i + 1}. #{branch.name}", :yellow
+            end
+            index = ask "Which would you like merge it into?:", :green
+            unless index.to_i.between?(1, branches.size)
+              say "Error! Invalid branch selected.", :red
+              exit
+            end
+            branches[index.to_i - 1]
+          else
+            branches.first
+          end
+          @inception_branch.name
+        end
+
+        # Returns a list of branches that the current commit could have been originated from.
+        # @return [Array<Grit::Head>]
+        def inception_branches
+          commit = current_branch.commit
+
+          # Look through the parent history of this branch
+          while true
+            matching_branches = long_running_branches.select { |branch| commit.id == branch.commit.id }
+            return matching_branches unless matching_branches.empty?
+            commit = commit.parents.first
+          end
+          []
+        end
+
+        # Returns all branches that are 'long lived', i.e. not a feature.
+        #
+        # @return [Array<Grit::Head>]
+        def long_running_branches
+          repo.heads.select { |head| !head.name.include?('features') }
+        end
+
         # Returns a list of all commits for the current branch since it was forked from master.
         def commits_in_feature_branch
-          repo.commits_between(master_branch.name, current_branch.name)
+          repo.commits_between(inception_branch_name, current_branch.name)
         end
-        
+
         # Returns the name of the feature for the current branch
         # @return [String] Name of feature (not include features/)
         def current_feature
@@ -81,27 +136,27 @@ module Git
           end
           return ""
         end
-        
+
         def current_branch
           repo.head
         end
-        
+
         def current_branch_name
           current_branch.name
         end
-        
+
         def repo
           repo ||= Grit::Repo.new('.')
         end
-        
+
         def master_branch
           repo.heads.each do |head|
             return head if head.name == "master"
           end
           raise "No branch named 'master' found."
         end
-        
-        def feature_branch(name)  
+
+        def feature_branch(name)
           "#{FEATURES_PATH}#{name}"
         end
       end

data/lib/git_er_done/version.rb

@@ -1,7 +1,7 @@
 module Git
   module Er
     module Done
-      VERSION = "0.3.0"
+      VERSION = "0.4.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_er_done
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-13 00:00:00.000000000Z
+date: 2013-09-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70179246615980 !ruby/object:Gem::Requirement
+  requirement: &70323278285920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *70179246615980
+  version_requirements: *70323278285920
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &70179246615400 !ruby/object:Gem::Requirement
+  requirement: &70323278285460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: '2.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70179246615400
+  version_requirements: *70323278285460
 description: A gem to assist with git workflow, similar to git-flow.
 email:
 - peakpg@gmail.com
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: git_er_done
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A gem to assist with git workflow.