git_reflow 0.2.5 → 0.3.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_reflow (0.2.5)
+    git_reflow (0.3.1)
       colorize (= 0.5.8)
       github_api (= 0.7.0)
       gli (= 2.1.0)
@@ -11,28 +11,9 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.2)
-    aruba (0.4.11)
-      childprocess (>= 0.2.3)
-      cucumber (>= 1.1.1)
-      ffi (>= 1.0.11)
-      rspec (>= 2.7.0)
-    builder (3.1.3)
-    childprocess (0.3.5)
-      ffi (~> 1.0, >= 1.0.6)
     colorize (0.5.8)
-    crack (0.3.1)
-    cucumber (1.2.1)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.3)
-      gherkin (~> 2.11.0)
-      json (>= 1.4.6)
-    diff-lcs (1.1.3)
     faraday (0.8.6)
       multipart-post (~> 1.1)
-    ffi (1.1.5)
-    gherkin (2.11.2)
-      json (>= 1.4.6)
     git (1.2.5)
     github_api (0.7.0)
       faraday (~> 0.8.1)
@@ -42,7 +23,7 @@ GEM
       oauth2
     gli (2.1.0)
     hashie (1.2.0)
-    highline (1.6.15)
+    highline (1.6.16)
     httpauth (0.2.0)
     httpclient (2.3.3)
     jeweler (1.8.4)
@@ -53,10 +34,10 @@ GEM
     json (1.7.5)
     jwt (0.1.5)
       multi_json (>= 1.0)
-    multi_json (1.6.1)
+    multi_json (1.7.2)
     multi_xml (0.5.3)
     multipart-post (1.2.0)
-    nokogiri (1.5.6)
+    nokogiri (1.5.9)
     oauth2 (0.9.1)
       faraday (~> 0.8)
       httpauth (~> 0.1)
@@ -68,26 +49,12 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.2)
-    webmock (1.8.10)
-      addressable (>= 2.2.7)
-      crack (>= 0.1.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba (~> 0.4.6)
   git_reflow!
   jeweler
   rake
   rdoc
-  rspec
-  webmock

data/README.rdoc

@@ -1,39 +1,282 @@
-git-reflow
-==========
-Tools to help build software that just works.
-
-How it works
--------------
-`$ git reflow setup`
-  Sets up your Github credentials
-
-`$ git reflow start branch-name`
-  Creates new branch
-  Prompts for PT ticket numbers? (Keep the PT stuff as a plugin?)
-
-`$ git reflow review [branch]`
-  Assumes remote 'origin'
-  Performs the following against [branch] or master if branch is not specified:
-    `git fetch origin`
-    - Are we up-to-date with changes from the destination?
-      - Fail with "origin/[branch] has newer changes" if no
-    - Run the test suite
-      - If fails, do not continue
-      - If not configured, fail with "Run test suite then use flag --green"
-    `git push origin current-branch` # Updates remote branch
-    - Do we have pull request?
-      - if no, create it and print "Pull request created at http://pull-url/"
-
-`$ git reflow deliver [branch]`
-    - Do we have lgtm after last commit?
-      - If no, print "Still waiting for review" (Maybe provide a way to skip this with `--lgtm`?)
-    - Prompt "Accepted by:" and get name/email/github username of person who does acceptance
-    - Checkout destination branch
-    - Update destination from origin (`git pull origin [branch]`)
-    - Merge squashed (`git merge --squash branch-name`)
-    - Prepare commit message (Adds Closes #pull-request-number)
-    - Perform the commit
-    - Push to branch
-    - Delete the remote branch
-    - Delete the local branch
-    - Deploy (Maybe with flag `--deploy`)
+= git-reflow
+
+http://www.reenhanced.com/images/reflow.jpg
+
+Reflow is a no bullshit git workflow designed to help you maintain quality and get things done.
+
+== Benefits:
+* Save minutes every day that add up to hours of more productive time.
+* Enforce code reviews across your team.
+* Stop worrying about how to deliver your code and just get work done.
+* Know that your entire team delivers code the same way.
+* Reduce the knowledge needed to deliver great code.
+* Have a commit history that's clean and actually usable.
+* Revert features with ease (if needed).
+* Work with diverse teams with less worry about the code delivery process.
+* Work with diverse teams with less worry about different processes.
+* Stop searching for other git workflows.
+  Reflow covers 90% of your needs without junk you'll never use.
+
+== Features:
+* Automatically create pull requests to master
+* Automatically ensure that your code is reviewed before merging
+* Start with sensible commit messages by default
+* Squash merge feature branches because results are more important than details
+* Automatically clean up obsolete feature branches after a successful merge
+
+== Quickstart
+Create and switch to new branch +nh-branchy-branch+:
+  $ git reflow start nh-branchy-branch
+
+Create a pull request for your branch against +master+:
+  $ git reflow review
+
+If your code is 'LGTM'd, squash merge to +master+ and delete the feature branch:
+  $ git reflow deliver
+
+== How to use
+
+=== Installation
+  $ gem install reflow
+or
+  $ gem install git_reflow
+
+=== Setup
+  git reflow setup
+
+On your first install, you'll need to setup your Github credentials. These are used only to get an oauth token that's stored in your global git config.
+We use the Github credentials so we can create pull requests from the command line.
+
+After installation, run:
+  git reflow setup
+
+It looks like this:
+  $ git reflow setup
+  Please enter your GitHub username: nhance
+  Please enter your GitHub password (we do NOT store this):
+
+  Your GitHub account was successfully setup!
+
+This is safe to run multiple times. We don't care.
+
+=== Starting a feature branch
+  git reflow start
+
+This sets up a feature branch remotely and brings a local copy to your machine. Yeah, you can do this by hand pretty easily, so skip this command if you want. This is just a handy shortcut with no magic.
+
+  $ git reflow start nh-branch-name
+
+[PROTIP]  Use your initials at the beginning of each branch so your team knows
+          who is responsible for each. My initials are 'NH', so all of my branches start with +nh-+
+
+=== Reviewing your work
+  git reflow review
+
+All of our work is reviewed by our team. This helps spread knowledge to multiple parties and keeps the quality of our code consistent.
+
+The +review+ step creates a pull request for the currently checked out feature branch against master. That's all you want to do most of the time.
+We assume you know what you're doing, so if you need something different, do it by hand.
+
+After making commits to your branch, run +review+. Didn't push it up? We don't care, we'll do it for you.
+
+  $ git reflow review
+
+  From github.com:reenhanced/gitreflow
+   * branch            master     -> FETCH_HEAD
+  Counting objects: 5, done.
+  Delta compression using up to 16 threads.
+  Compressing objects: 100% (3/3), done.
+  Writing objects: 100% (3/3), 1.68 KiB, done.
+  Total 3 (delta 1), reused 0 (delta 0)
+  To git@github.com:reenhanced/gitreflow.git
+     c2ec1b1..1103006  nh-readme-update -> nh-readme-update
+
+  Successfully created pull request #35: Bootstrapping the readme. This is so I can show how review works
+  Pull Request URL: https://github.com/reenhanced/gitreflow/pull/35
+  Would you like to open it in your browser? y
+
+[OSX/Ubuntu only]  You can automatically open your default web browser to the pull request.
+                   This lets you edit the pull request with all of the detailed information you'll need before submitting it to your team.
+
+We output the pull request URL so you can distribute it to your team without leaving the terminal. But don't be a jerk, update the title and description before you send your work around.
+
+==== How it works
+Behind the scenes, this is how +review+ works:
+  git fetch origin
+
+Are we up-to-date with changes from master?
+If not, fail with "master has newer changes".
+
+Then,
+  git push origin current-branch # Updates remote branch
+
+Do we have pull request?
+If not, create it and print "Pull request created at http://pull-url/". If so, print the url for the existing request.
+
+=== Checking your branch status
+  git reflow status
+
+Sometimes you start working on a branch and can't get back to it for a while. It happens. Use +status+ to check on the status of your work.
+
+  $ git reflow status
+
+  Here's the status of your review:
+    branches:     reenhanced:nh-readme-update -> reenhanced:master
+    number:       35
+    reviewed by:
+    url:          https://github.com/reenhanced/gitreflow/pull/35
+
+  [notice] No one has reviewed your pull request...
+  Would you like to open it in your browser? n
+
+This gives you details on who's reviewed your pull request. If someone has participated, but not given you a 'LGTM', this will tell you.
++status+ prevents you from having to open a browser to find out where your pull request is at. But in case you want to take a look, we give you the option to open it for you.
+
+=== Delivering approved code
+  git reflow deliver
+
+You kick butt. You've got your code reviewed and now you're ready to merge it down to +master+ and deploy. Reflow +deliver+ will take care of all of the steps for you to make this happen.
+
+Reflow's +deliver+ requires you to have a pull request, so you'll be protected on those mornings when the coffee isn't working yet.
+We built this <b>to get in your way and make you follow the process</b>. If you don't like it, do it by hand. You already know what you're doing.
+
+You'll be presented with a prefilled commit message based on the body of your pull request which includes the text <code>Closes #XX</code> that will automatically close the associated pull request on github when deliver completes.
+
+Make a mistake and deliver too early? It happens. You'll be prompted after you edit your commit message if you want to push your updated +master+ to github. If you answer 'n', then you'll want to do <code>git reset --hard origin/master</code> and checkout your branch again.
+
+This is what it looks like:
+  $ git reflow deliver
+  From github.com:reenhanced/gitreflow
+  * branch            master     -> FETCH_HEAD
+  Merging pull request #36: 'Enforce at least one LGTM before delivery', from 'reenhanced:nh-fail-without-lgtm' into 'reenhanced:master'
+  Switched to branch 'master'
+  From github.com:reenhanced/gitreflow
+   * branch            master     -> FETCH_HEAD
+  Already up-to-date.
+  Switched to branch 'nh-fail-without-lgtm'
+  Switched to branch 'master'
+  Updating c2ec1b1..f90e111
+  Fast-forward
+  Squash commit -- not updating HEAD
+   lib/git_reflow.rb | 71 +++++++++++++++++++++++++++----------------------------
+   1 file changed, 35 insertions(+), 36 deletions(-)
+  [master d1b4dd5] Enforces LGTM before deliver, even with no comments.
+   1 file changed, 35 insertions(+), 36 deletions(-)
+  Merge complete!
+  Would you like to push this branch to your remote repo and cleanup your feature branch? y
+  Counting objects: 7, done.
+  Delta compression using up to 16 threads.
+  Compressing objects: 100% (4/4), done.
+  Writing objects: 100% (4/4), 1.38 KiB, done.
+  Total 4 (delta 2), reused 0 (delta 0)
+  To git@github.com:reenhanced/gitreflow.git
+     c2ec1b1..d1b4dd5  master -> master
+
+  To git@github.com:reenhanced/gitreflow.git
+   - [deleted]         nh-fail-without-lgtm
+
+  Deleted branch nh-fail-without-lgtm (was f90e111).
+  Nice job buddy.
+  
+This is what the default commit message looks like:
+  Enforces LGTM before deliver, even with no comments.
+  Removes the need to review the pull request yourself if you make a
+  comment.
+  
+  Better error message if setup fails.
+  
+  Bug fixes.
+  
+  Closes #36
+  
+  LGTM given by: @codenamev
+  
+  Squashed commit of the following:
+  
+  commit f90e111
+  Author: Nicholas Hance <nhance@reenhanced.com>
+  Date:   Thu Jul 11 15:33:29 2013 -0400
+  ...
+  
+==== How it works
+This is what we do behind the scenes when you do +deliver+
+
+* Does a pull request exist?
+
+  If not, stop here. You need to run +review+.
+
+* Has the review been completed? Did we get a +LGTM+ from everyone who's participated?
+
+  If not, show a list of authors that need to provide a +LGTM+.
+  
+If the review is done, it's time to merge. Here's what happens:
+
+First, update our local +master+ so we don't get conflicts
+  git checkout master
+  git pull origin master
+
+Next, squash merge our feature branch
+  git merge --squash nh-branch-name
+  
+Now, we'll apply a little magic so we have a great commit message by default. Your editor will open and you'll see a nice default for your commit message based on the pull request body.
+
+Once you've saved the commit, prompt the user to see if we should continue
+  Merge complete!
+  Would you like to push this branch to your remote repo and cleanup your feature branch?
+  
+If 'y', then we'll push to +master+ and delete the feature branch
+  git push origin master
+  git push origin :nh-branch-name
+  git branch -D nh-branch-name
+  
+If 'n', then just stop here. The user can reset his local +master+.
+
+And we're done.
+
+
+== Guiding principles:
+* You should already know what you're doing.
+  We assume you know how to use git.
+
+* The +master+ branch is your codebase.
+  You don't need multiple branches for code actually want to use.
+
+* +master+ should remain stable at all times.
+  The entire team depends on it.
+
+* No direct commits to +master+.
+  All work happens in feature branches. From a single commit to hundreds.
+
+* All feature branches are reviewed via pull requests.
+
+* Looks Good To Me. All feature branches require approval.
+  We look for the string 'LGTM' in a comment on the pull request to know it's ready to merge.
+
+* If you make a new commit in your branch, you require another review.
+
+* All participants in a pull request must approve the pull request.
+  If 2 guys comment, you need 2 'LGTM's before the code is ready to merge.
+
+* Once approved, your feature branch is squash merged to master.
+  This makes the history of the master branch extremely clean and easy to follow.
+
+* Git blame becomes your friend. You'll know who to blame and can see the full context of changes.
+  Squash commits to master mean every commit represents the whole feature, not a "typo fix".
+
+
+---
+
+== Contributing
+Pull requests are welcome. Please fork and submit. We use this tool every single day and as long as what you want to add doesn't change our workflow, we are happy to accept your updates. Feel free to add your github username to the list below.
+
+Authors:
+* @codenamev
+* @armyofgnomes
+* @nhance
+
+Built by Reenhanced:
+http://www.reenhanced.com
+
+<B>Looking for a capable team for your project? Get in touch. We're looking to grow.</B>
+
+<em>Licensed using the MIT license. Do whatever you like with this, but don't blame us if it breaks anything. You're a professional, and you're responsible for the tools you use.</em>

data/Rakefile

@@ -1,13 +1,2 @@
 require 'rake'
 require 'bundler/gem_tasks'
-require 'cucumber'
-require 'cucumber/rake/task'
-
-Dir[File.join(File.dirname(__FILE__),'lib/tasks/*.rake')].each { |f| load f }
-
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "features --format pretty -x"
-  t.fork = false
-end
-
-task :default => [:spec, :cucumber]

data/git_reflow.gemspec

@@ -15,18 +15,19 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc         = true
   s.extra_rdoc_files = ['README.rdoc']
   s.bindir           = 'bin'
+
   s.require_paths    << 'lib'
   s.rdoc_options     << '--title' << 'git_reflow' << '--main' << 'README.rdoc' << '-ri'
+
   s.add_development_dependency('rake')
   s.add_development_dependency('rdoc')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('aruba', '~> 0.4.6')
   s.add_development_dependency('jeweler')
-  s.add_development_dependency('webmock')
+
   s.add_dependency('colorize', '0.5.8')
   s.add_dependency('gli', '2.1.0')
   s.add_dependency('highline')
   s.add_dependency('httpclient')
   s.add_dependency('github_api', '0.7.0')
+
   s.post_install_message = "You need to setup your GitHub OAuth token\nPlease run 'git-reflow setup'"
 end

data/lib/git_reflow/version.rb

@@ -1,3 +1,3 @@
 module GitReflow
-  VERSION = "0.2.5"
+  VERSION = "0.3.1"
 end

data/lib/git_reflow.rb

@@ -13,13 +13,19 @@ module GitReflow
   LGTM = /lgtm|looks good to me|:\+1:|:thumbsup:/i
 
   def setup
-    gh_user = ask "Please enter your GitHub username: "
+    gh_user     = ask("Please enter your GitHub username: ")
     gh_password = ask("Please enter your GitHub password (we do NOT store this): ") { |q| q.echo = false }
-    puts "\nYour GitHub account was successfully setup!"
-    github = Github.new :basic_auth => "#{gh_user}:#{gh_password}"
-    authorization = github.oauth.create 'scopes' => ['repo']
-    oauth_token = authorization[:token]
-    set_oauth_token(oauth_token)
+
+    begin
+      github        = Github.new :basic_auth => "#{gh_user}:#{gh_password}"
+      authorization = github.oauth.create 'scopes' => ['repo']
+      oauth_token   = authorization[:token]
+      set_oauth_token(oauth_token)
+    rescue
+      puts "\nInvalid username or password"
+    else
+      puts "\nYour GitHub account was successfully setup!"
+    end
   end
 
   def status(destination_branch)
@@ -67,6 +73,8 @@ module GitReflow
     options['base'] ||= 'master'
     fetch_destination options['base']
 
+    update_destination(current_branch)
+
     begin
       existing_pull_request = find_pull_request( :from => current_branch, :to => options['base'] )
 
@@ -75,9 +83,10 @@ module GitReflow
       else
 
         open_comment_authors = find_authors_of_open_pull_request_comments(existing_pull_request)
+        has_comments         = has_pull_request_comments?(existing_pull_request)
 
         # if there any comment_authors left, then they haven't given a lgtm after the last commit
-        if open_comment_authors.empty? or options['skip-lgtm']
+        if (has_comments and open_comment_authors.empty?) or options['skip-lgtm']
           lgtm_authors   = comment_authors_for_pull_request(existing_pull_request, :with => LGTM)
           commit_message = existing_pull_request[:body] || get_first_commit_message
           puts "Merging pull request ##{existing_pull_request.number}: '#{existing_pull_request.title}', from '#{existing_pull_request.head.label}' into '#{existing_pull_request.base.label}'"
@@ -102,8 +111,10 @@ module GitReflow
           else
             puts "There were problems commiting your feature... please check the errors above and try again."
           end
-        else
+        elsif open_comment_authors.count > 0
           puts "[deliver halted] You still need a LGTM from: #{open_comment_authors.join(', ')}"
+        else
+          puts "[deliver halted] Your code has not been reviewed yet."
         end
       end
 
@@ -188,40 +199,28 @@ module GitReflow
          break
       end
     end
+
     existing_pull_request
   end
 
   def pull_request_comments(pull_request)
-    comments        = github.issues.comments.all remote_user, remote_repo_name, pull_request.number
+    comments        = github.issues.comments.all        remote_user, remote_repo_name, pull_request.number
     review_comments = github.pull_requests.comments.all remote_user, remote_repo_name, pull_request.number
-    comments + review_comments
+
+    review_comments + comments
+  end
+
+  def has_pull_request_comments?(pull_request)
+    pull_request_comments(pull_request).count > 0
   end
 
   def find_authors_of_open_pull_request_comments(pull_request)
     # first we'll gather all the authors that have commented on the pull request
-    all_comments    = pull_request_comments(pull_request)
-    comment_authors = comment_authors_for_pull_request(pull_request)
-    lgtm_authors    = []
-
-    # now we need to check that all the commented authors have given a lgtm after the last commit
-    all_comments.each do |comment|
-      next unless comment_authors.include?(comment.user.login)
-      pull_last_committed_at = get_commited_time(pull_request.head.sha)
-      comment_created_at     = Time.parse(comment.created_at)
-      if comment_created_at > pull_last_committed_at
-        if comment[:body] =~ LGTM
-          lgtm_authors |= [comment.user.login]
-        else
-          comment_authors |= [comment.user.login] unless comment_authors.include?(comment.user.login)
-        end
-      else
-        comment_authors -= [comment.user.login] if comment_authors.include?(comment.user.login)
-      end
-    end
+    pull_last_committed_at = get_commited_time(pull_request.head.sha)
+    comment_authors        = comment_authors_for_pull_request(pull_request)
+    lgtm_authors           = comment_authors_for_pull_request(pull_request, :with => LGTM, :after => pull_last_committed_at)
 
-    comment_authors -= lgtm_authors
-
-    comment_authors || []
+    comment_authors - lgtm_authors
   end
 
   def comment_authors_for_pull_request(pull_request, options = {})
@@ -230,7 +229,9 @@ module GitReflow
 
     all_comments.each do |comment|
       next if options[:after] and Time.parse(comment.created_at) < options[:after]
-      comment_authors |= [comment.user.login] if !comment_authors.include?(comment.user.login) and (options[:with].nil? or comment[:body] =~ options[:with])
+      if (options[:with].nil? or comment[:body] =~ options[:with])
+        comment_authors |= [comment.user.login]
+      end
     end
 
     # remove the current user from the list to check
@@ -254,7 +255,7 @@ module GitReflow
       last_committed_at    = get_commited_time(pull_request.head.sha)
       lgtm_authors         = comment_authors_for_pull_request(pull_request, :with => LGTM, :after => last_committed_at)
 
-      summary_data.merge!("Last comment"  => pull_comments.last.body)
+      summary_data.merge!("Last comment"  => pull_comments.last[:body].inspect)
 
       if lgtm_authors.any?
         reviewed_by.map! { |author| lgtm_authors.include?(author.uncolorize) ? author.colorize(:green) : author }
@@ -262,7 +263,7 @@ module GitReflow
 
       notices << "[notice] You still need a LGTM from: #{open_comment_authors.join(', ')}\n" if open_comment_authors.any?
     else
-      notices << "[notice] No one has reviewed your pull request...\n"
+      notices << "[notice] No one has reviewed your pull request.\n"
     end
 
     summary_data['reviewed by'] = reviewed_by.join(', ')
@@ -273,7 +274,7 @@ module GitReflow
       printf string_format, "#{name}:", summary_data[name]
     end
 
-    puts "\n#{notices}" if notices != ''
+    puts "\n#{notices}" unless notices.empty?
   end
 
   def get_commited_time(commit_sha)