git-review 1.1.3 → 1.1.5

data/lib/git-review.rb

@@ -4,6 +4,9 @@ require 'octokit'
 require 'launchy'
 # Time is used to parse time strings from git back into Time objects.
 require 'time'
+# tempfile is used to create a temporary file containing PR's title and body.
+# This file is going to be edited by the system editor.
+require 'tempfile'
 
 # A custom error to raise, if we know we can't go on.
 class UnprocessableState < StandardError
@@ -16,27 +19,30 @@ class GitReview
 
   # List all pending requests.
   def list
-    @current_requests.reverse! if @args.shift == '--reverse'
-    output = @current_requests.collect do |pending_request|
-      # Find only pending (= unmerged) requests and output summary. GitHub might
-      # still think of them as pending, as it doesn't know about local changes.
-      next if merged?(pending_request['head']['sha'])
-      line = format_text(pending_request['number'], 8)
-      date_string = format_time(pending_request['updated_at'])
+    output = @current_requests.collect do |request|
+      details = @github.pull_request(source_repo, request.number)
+      # Find only pending (= unmerged) requests and output summary.
+      # Explicitly look for local changes (that GitHub does not yet know about).
+      next if merged?(request.head.sha)
+      line = format_text(request.number, 8)
+      date_string = format_time(request.updated_at)
       line << format_text(date_string, 11)
-      line << format_text(pending_request['comments'], 10)
-      line << format_text(pending_request['title'], 91)
+      line << format_text(details.comments + details.review_comments, 10)
+      line << format_text(request.title, 91)
       line
     end
-    if output.compact.empty?
-      puts "No pending requests for '#{source}'"
-      return
+    output.compact!
+    if output.empty?
+      puts "No pending requests for '#{source}'."
+    else
+      puts "Pending requests for '#{source}':"
+      puts 'ID      Updated    Comments  Title'
+      output.reverse! if @args.shift == '--reverse'
+      output.each { |line| puts line }
     end
-    puts "Pending requests for '#{source}'"
-    puts 'ID      Updated    Comments  Title'
-    puts output.compact
   end
 
+
   # Show details for a single request.
   def show
     return unless request_exists?
@@ -58,11 +64,13 @@ class GitReview
     discussion
   end
 
+
   # Open a browser window and review a specified request.
   def browse
     Launchy.open(@current_request['html_url']) if request_exists?
   end
 
+
   # Checkout a specified request's changes to your local repository.
   def checkout
     return unless request_exists?
@@ -75,6 +83,7 @@ class GitReview
     git_call "checkout #{create_local_branch}#{@current_request['head']['ref']}"
   end
 
+
   # Accept a specified request by merging it into master.
   def merge
     return unless request_exists?
@@ -104,6 +113,7 @@ class GitReview
     puts git_call(exec_cmd)
   end
 
+
   # Add an approving comment to the request.
   def approve
     return unless request_exists?
@@ -116,6 +126,7 @@ class GitReview
     end
   end
 
+
   # Close a specified request.
   def close
     return unless request_exists?
@@ -123,6 +134,7 @@ class GitReview
     puts 'Successfully closed request.' unless request_exists?('open', @current_request['number'])
   end
 
+
   # Prepare local repository to create a new request.
   # Sets @local_branch.
   def prepare
@@ -154,6 +166,7 @@ class GitReview
     end
   end
 
+
   # Create a new request.
   # TODO: Support creating requests to other repositories and branches (like the original repo, this has been forked from).
   def create
@@ -168,18 +181,17 @@ class GitReview
       # Push latest commits to the remote branch (and by that, create it if necessary).
       git_call "push --set-upstream origin #{@local_branch}", debug_mode, true
       # Gather information.
-      last_request_id = @current_requests.collect{|req| req['number'] }.sort.last.to_i
-      title = "[Review] Request from '#{git_config['github.login']}' @ '#{source}'"
-      # TODO: Insert commit messages (that are not yet in master) into body (since this will be displayed inside the mail that is sent out).
-      body = 'Please review the following changes:'
+      last_request_id = @current_requests.collect { |req| req['number'] }.sort.last.to_i
+      title, body = create_title_and_body(target_branch)
       # Create the actual pull request.
       @github.create_pull_request target_repo, target_branch, source_branch, title, body
       # Switch back to target_branch and check for success.
       git_call "checkout #{target_branch}"
       update
-      potential_new_request = @current_requests.find{ |req| req['title'] == title }
+      potential_new_request = @current_requests.find { |req| req['title'] == title }
       if potential_new_request and potential_new_request['number'] > last_request_id
-        puts "Successfully created new request ##{potential_new_request['number']}."
+        puts "Successfully created new request ##{potential_new_request['number']}" \
+             "(#{File.join("https://github.com", target_repo, "pull", potential_new_request['number'].to_s)})."
       end
       # Return to the user's original branch.
       git_call "checkout #{@original_branch}"
@@ -188,10 +200,11 @@ class GitReview
     end
   end
 
+
   # Deletes obsolete branches (left over from already closed requests).
   def clean
     # Pruning is needed to remove already deleted branches from your local track.
-    git_call "remote prune origin"
+    git_call 'remote prune origin'
     # Determine strategy to clean.
     case @args.size
       when 0
@@ -212,6 +225,7 @@ class GitReview
     end
   end
 
+
   # Start a console session (used for debugging).
   def console
     puts 'Entering debug console.'
@@ -226,13 +240,12 @@ class GitReview
   private
 
   # Setup variables and call actual commands.
-  def initialize(args)
+  def initialize(args = [])
+    @args = args
     command = args.shift
     if command and self.respond_to?(command)
       @user, @repo = repo_info
-      return if @user.nil? or @repo.nil?
-      @args = args
-      return unless configure_github_access
+      return unless @user && @repo && configure_github_access
       update unless command == 'clean'
       self.send command
     else
@@ -245,6 +258,7 @@ class GitReview
     puts 'Execution of git-review command stopped.'
   end
 
+
   # Show a quick reference of available commands.
   def help
     puts 'Usage: git review <command>'
@@ -261,9 +275,10 @@ class GitReview
     puts '  prepare                   Creates a new local branch for a request.'
     puts '  create                    Create a new request.'
     puts '  clean <ID> [--force]      Delete a request\'s remote and local branches.'
-    puts '  clean --all?              Delete all obsolete branches.'
+    puts '  clean --all               Delete all obsolete branches.'
   end
 
+
   # Check existence of specified request and assign @current_request.
   def request_exists?(state = 'open', request_id = nil)
     # NOTE: If request_id is set explicitly we might need to update to get the
@@ -275,7 +290,7 @@ class GitReview
       puts 'Please specify a valid ID.'
       return false
     end
-    @current_request = @current_requests.find{ |req| req['number'] == request_id }
+    @current_request = @current_requests.find { |req| req['number'] == request_id }
     unless @current_request
       # Additional try to get an older request from Github by specifying the number.
       request = @github.pull_request source_repo, request_id
@@ -290,18 +305,20 @@ class GitReview
     end
   end
 
+
   # Get latest changes from GitHub.
   def update(state = 'open')
-    @current_requests = @github.pull_requests source_repo, state
-    repos = @current_requests.collect do |req|
-      repo = req['head']['repository']
-      "#{repo['owner']}/#{repo['name']}" unless repo.nil?
+    @current_requests = @github.pull_requests(source_repo, state)
+    repos = @current_requests.collect do |request|
+      repo = request.head.repository
+      "#{repo.owner}/#{repo.name}" if repo
     end
     repos.uniq.compact.each do |repo|
-      git_call("fetch git@github.com:#{repo}.git +refs/heads/*:refs/pr/#{repo}/*")
+      git_call "fetch git@github.com:#{repo}.git +refs/heads/*:refs/pr/#{repo}/*"
     end
   end
 
+
   # Cleans a single request's obsolete branches.
   def clean_single(force_deletion = false)
     update('closed')
@@ -314,15 +331,16 @@ class GitReview
     delete_branch(branch_name)
   end
 
+
   # Cleans all obsolete branches.
   def clean_all
     update
     # Protect all open requests' branches from deletion.
-    protected_branches = @current_requests.collect{|request| request['head']['ref']}
+    protected_branches = @current_requests.collect { |request| request['head']['ref'] }
     # Select all branches with the correct prefix.
-    review_branches = all_branches.select{|branch| branch.include?('review_')}
+    review_branches = all_branches.select { |branch| branch.include?('review_') }
     # Only use uniq branch names (no matter if local or remote).
-    review_branches.collect{|branch| branch.split('/').last}.uniq.each do |branch_name|
+    review_branches.collect { |branch| branch.split('/').last }.uniq.each do |branch_name|
       # Only clean up obsolete branches.
       unless protected_branches.include?(branch_name) or unmerged_commits?(branch_name, false)
         delete_branch(branch_name)
@@ -330,6 +348,7 @@ class GitReview
     end
   end
 
+
   # Delete local and remote branches that match a given name.
   def delete_branch(branch_name)
     # Delete local branch if it exists.
@@ -338,6 +357,7 @@ class GitReview
     git_call("push origin :#{branch_name}", true) if branch_exists?(:remote, branch_name)
   end
 
+
   # Returns a boolean stating whether there are unmerged commits on the local or remote branch.
   def unmerged_commits?(branch_name, verbose = true)
     locations = []
@@ -354,7 +374,7 @@ class GitReview
     end
     # Select commits (= non empty, not just an error message and not only duplicate commits staring with '-').
     unmerged_commits = responses.reject do |response|
-      response.empty? or response.include?('fatal: Unknown commit') or response.split("\n").reject{|x| x.index('-') == 0}.empty?
+      response.empty? or response.include?('fatal: Unknown commit') or response.split("\n").reject { |x| x.index('-') == 0 }.empty?
     end
     # If the array ain't empty, we got unmerged commits.
     if unmerged_commits.empty?
@@ -365,6 +385,7 @@ class GitReview
     end
   end
 
+
   # Returns a boolean stating whether a branch exists in a specified location.
   def branch_exists?(location, branch_name)
     return false unless [:remote, :local].include? location
@@ -372,6 +393,7 @@ class GitReview
     all_branches.include?(prefix + branch_name)
   end
 
+
   # System call to 'git'.
   def git_call(command, verbose = debug_mode, enforce_success = false)
     if verbose
@@ -389,6 +411,7 @@ class GitReview
     output
   end
 
+
   # Show current discussion for @current_request.
   def discussion
     request = @github.pull_request source_repo, @current_request['number']
@@ -404,7 +427,7 @@ class GitReview
         when "IssueComment", "CommitComment", "PullRequestReviewComment"
           output << "added a comment"
           output << " to \e[36m#{entry['commit_id'][0..6]}\e[m" if entry['commit_id']
-          output <<  " on #{format_time(entry['created_at'])}"
+          output << " on #{format_time(entry['created_at'])}"
           unless entry['created_at'] == entry['updated_at']
             output << " (updated on #{format_time(entry['updated_at'])})"
           end
@@ -413,75 +436,86 @@ class GitReview
           output << entry['body']
         # Commits:
         when "Commit"
-         output << "authored commit \e[36m#{entry['id'][0..6]}\e[m on #{format_time(entry['authored_date'])}"
-         unless entry['authored_date'] == entry['committed_date']
-           output << " (committed on #{format_time(entry['committed_date'])})"
-         end
-         output << ":\n#{''.rjust(output.length + 1, "-")}\n#{entry["message"]}"
+          output << "authored commit \e[36m#{entry['id'][0..6]}\e[m on #{format_time(entry['authored_date'])}"
+          unless entry['authored_date'] == entry['committed_date']
+            output << " (committed on #{format_time(entry['committed_date'])})"
+          end
+          output << ":\n#{''.rjust(output.length + 1, "-")}\n#{entry["message"]}"
       end
       output << "\n\n\n"
     end
     puts result.compact unless result.empty?
   end
 
+
   # Display helper to make output more configurable.
   def format_text(info, size)
     info.to_s.gsub("\n", ' ')[0, size-1].ljust(size)
   end
 
+
   # Display helper to unify time output.
   def format_time(time_string)
     Time.parse(time_string).strftime('%d-%b-%y')
   end
 
+
   # Returns a string that specifies the source repo.
   def source_repo
     "#{@user}/#{@repo}"
   end
 
+
   # Returns a string that specifies the source branch.
   def source_branch
     git_call('branch').chomp!.match(/\*(.*)/)[0][2..-1]
   end
 
+
   # Returns a string consisting of source repo and branch.
   def source
     "#{source_repo}/#{source_branch}"
   end
 
+
   # Returns a string that specifies the target repo.
   def target_repo
     # TODO: Enable possibility to manually override this and set arbitrary repositories.
     source_repo
   end
 
+
   # Returns a string that specifies the target branch.
   def target_branch
     # TODO: Enable possibility to manually override this and set arbitrary branches.
     ENV['TARGET_BRANCH'] || 'master'
   end
 
+
   # Returns a string consisting of target repo and branch.
   def target
     "#{target_repo}/#{target_branch}"
   end
 
+
   # Returns an Array of all existing branches.
   def all_branches
-    @branches ||= git_call('branch -a').split("\n").collect{|s|s.strip}
+    @branches ||= git_call('branch -a').split("\n").collect { |s| s.strip }
   end
 
+
   # Returns a boolean stating whether a specified commit has already been merged.
   def merged?(sha)
     not git_call("rev-list #{sha} ^HEAD 2>&1").split("\n").size > 0
   end
 
+
   # Uses Octokit to access GitHub.
   def configure_github_access
     if git_config['github.login'] and git_config['github.password']
       @github = Octokit::Client.new(
-        :login => git_config['github.login'],
-        :password => git_config['github.password']
+          :login => git_config['github.login'],
+          :password => git_config['github.password']
       )
       true
       @github.login
@@ -495,16 +529,18 @@ class GitReview
     end
   end
 
+
   def debug_mode
     git_config['review.mode'] == 'debug'
   end
 
+
   # Collect git config information in a Hash for easy access.
   # Checks '~/.gitconfig' for credentials.
   def git_config
     unless @git_config
       # Read @git_config from local git config.
-      @git_config = {}
+      @git_config = { }
       config_list = git_call('config --list', false)
       config_list.split("\n").each do |line|
         key, value = line.split('=')
@@ -514,6 +550,7 @@ class GitReview
     @git_config
   end
 
+
   # Returns an array consisting of information on the user and the project.
   def repo_info
     # Extract user and project name from GitHub URL.
@@ -524,7 +561,7 @@ class GitReview
     end
     user, project = github_user_and_project(url)
     # If there are no results yet, look for 'insteadof' substitutions in URL and try again.
-    unless (user and project)
+    unless user && project
       short, base = github_insteadof_matching(config_hash, url)
       if short and base
         url = url.sub(short, base)
@@ -534,9 +571,10 @@ class GitReview
     [user, project]
   end
 
+
   # Looks for 'insteadof' substitutions in URL.
   def github_insteadof_matching(config_hash, url)
-    first = config_hash.collect { |key,value|
+    first = config_hash.collect { |key, value|
       [value, /url\.(.*github\.com.*)\.insteadof/.match(key)]
     }.find { |value, match|
       url.index(value) and match != nil
@@ -544,15 +582,52 @@ class GitReview
     first ? [first[0], first[1][1]] : [nil, nil]
   end
 
+
   # Extract user and project name from GitHub URL.
   def github_user_and_project(github_url)
     matches = /github\.com.(.*?)\/(.*)/.match(github_url)
     matches ? [matches[1], matches[2].sub(/\.git\z/, '')] : [nil, nil]
   end
 
+
   # Returns a boolean stating whether the last issued system call was successful.
   def last_command_successful?
     $?.exitstatus == 0
   end
 
+  # Returns an array where the 1st item is the title and the 2nd one is the body
+  def create_title_and_body(target_branch)
+    commits = git_call("log --format='%H' HEAD...#{target_branch}").lines.count
+    puts "commits: #{commits}"
+    if commits == 1
+      # we can create a really specific title and body
+      title = git_call("log --format='%s' HEAD...#{target_branch}").chomp
+      body  = git_call("log --format='%b' HEAD...#{target_branch}").chomp
+    else
+      title = "[Review] Request from '#{git_config['github.login']}' @ '#{source}'"
+      body  = "Please review the following changes:\n"
+      body += git_call("log --oneline HEAD...#{target_branch}").lines.map{|l| "  * #{l.chomp}"}.join("\n")
+    end
+
+    tmpfile = Tempfile.new('git-review')
+    tmpfile.write(title + "\n\n" + body)
+    tmpfile.flush
+    editor = ENV['TERM_EDITOR'] || ENV['EDITOR']
+    warn "Please set $EDITOR or $TERM_EDITOR in your .bash_profile." unless editor
+
+    system("#{editor || 'open'} #{tmpfile.path}")
+
+    tmpfile.rewind
+    lines = tmpfile.read.lines.to_a
+    puts lines.inspect
+    title = lines.shift.chomp
+    lines.shift if lines[0].chomp.empty?
+
+    body = lines.join
+
+    tmpfile.unlink
+
+    [title, body]
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-review
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-30 00:00:00.000000000 Z
+date: 2013-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: launchy
@@ -32,17 +32,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Manage review workflow for projects hosted on GitHub (using pull requests).
 email: bamberger.dominik@gmail.com
 executables:
@@ -89,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: facilitates GitHub code reviews