git-review 0.9.0 → 1.0.0

data/lib/git-review.rb

@@ -16,8 +16,8 @@ class GitReview
 
   # List all pending requests.
   def list
-    @pending_requests.reverse! if @args.shift == '--reverse'
-    output = @pending_requests.collect do |pending_request|
+    @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'])
@@ -41,15 +41,15 @@ class GitReview
   def show
     return unless request_exists?
     option = @args.shift == '--full' ? '' : '--stat '
-    sha = @pending_request['head']['sha']
-    puts "ID        : #{@pending_request['number']}"
-    puts "Label     : #{@pending_request['head']['label']}"
-    puts "Updated   : #{format_time(@pending_request['updated_at'])}"
-    puts "Comments  : #{@pending_request['comments']}"
+    sha = @current_request['head']['sha']
+    puts "ID        : #{@current_request['number']}"
+    puts "Label     : #{@current_request['head']['label']}"
+    puts "Updated   : #{format_time(@current_request['updated_at'])}"
+    puts "Comments  : #{@current_request['comments']}"
     puts
-    puts @pending_request['title']
+    puts @current_request['title']
     puts
-    puts @pending_request['body']
+    puts @current_request['body']
     puts
     puts git_call("diff --color=always #{option}HEAD...#{sha}")
     puts
@@ -60,7 +60,7 @@ class GitReview
 
   # Open a browser window and review a specified request.
   def browse
-    Launchy.open(@pending_request['html_url']) if request_exists?
+    Launchy.open(@current_request['html_url']) if request_exists?
   end
 
   # Checkout a specified request's changes to your local repository.
@@ -72,17 +72,17 @@ class GitReview
     puts
     puts '  git checkout master'
     puts
-    git_call "checkout #{create_local_branch}#{@pending_request['head']['ref']}"
+    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?
     option = @args.shift
-    unless @pending_request['head']['repository']
+    unless @current_request['head']['repository']
       # Someone deleted the source repo.
-      user = @pending_request['head']['user']['login']
-      url = @pending_request['patch_url']
+      user = @current_request['head']['user']['login']
+      url = @current_request['patch_url']
       puts "Sorry, #{user} deleted the source repository, git-review doesn't support this."
       puts 'You can manually patch your repo by running:'
       puts
@@ -91,11 +91,11 @@ class GitReview
       puts 'Tell the contributor not to do this.'
       return false
     end
-    message = "Accept request ##{@pending_request['number']} and merge changes into \"#{target}\""
-    exec_cmd = "merge #{option} -m '#{message}' #{@pending_request['head']['sha']}"
+    message = "Accept request ##{@current_request['number']} and merge changes into \"#{target}\""
+    exec_cmd = "merge #{option} -m '#{message}' #{@current_request['head']['sha']}"
     puts
     puts 'Request title:'
-    puts "  #{@pending_request['title']}"
+    puts "  #{@current_request['title']}"
     puts
     puts 'Merge command:'
     puts "  git #{exec_cmd}"
@@ -107,15 +107,28 @@ class GitReview
   def approve
     return unless request_exists?
     comment = 'Reviewed and approved.'
-    response = Octokit.add_comment source_repo, @pending_request['number'], comment
-    puts 'Successfully approved request.' if response[:body] == comment
+    response = Octokit.add_comment source_repo, @current_request['number'], comment
+    if response[:message] == 'Issues are disabled for this repo'
+      # Workaround: Add a pull request comment to the last commit's first file's first line.
+      comment += "\n\nNOTE:\n  Issues are disabled on this repository.\n  Comments created through API calls may only be inline.\n  So I chose to just post here. :P"
+      last_commit = repo_call(:get, "pulls/#{@current_request['number']}/commits").last.sha
+      first_file = repo_call(:get, "pulls/#{@current_request['number']}/files").first.filename
+      response = repo_call(:post, "pulls/#{@current_request['number']}/comments",
+        {:body => comment, :commit_id => last_commit, :path => first_file, :position => 1}
+      )
+    end
+    if response[:body] == comment
+      puts 'Successfully approved request.'
+    else
+      puts response[:message]
+    end
   end
 
   # Close a specified request.
   def close
     return unless request_exists?
-    Octokit.close_issue(source_repo, @pending_request['number'])
-    puts 'Successfully closed request.' unless request_exists?(@pending_request['number'])
+    Octokit.close_issue(source_repo, @current_request['number'])
+    puts 'Successfully closed request.' unless request_exists?('open', @current_request['number'])
   end
 
   # Prepare local repository to create a new request.
@@ -161,7 +174,7 @@ 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 = @pending_requests.collect{|req| req['number'] }.sort.last.to_i
+      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:'
@@ -170,7 +183,7 @@ class GitReview
       # Switch back to target_branch and check for success.
       git_call "checkout #{target_branch}"
       update
-      potential_new_request = @pending_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']}."
       end
@@ -179,6 +192,28 @@ class GitReview
     end
   end
 
+  # Deletes obsolete branches (left over from already closed requests).
+  def clean
+    # Determine strategy to clean.
+    case @args.size
+      when 0
+        puts 'Argument missing. Please provide either an ID or the option "--all".'
+      when 1
+        if @args.first == '--all'
+          # git review clean --all
+          clean_all
+        else
+          # git review clean ID
+          clean_single
+        end
+      when 2
+        # git review clean ID --force
+        clean_single(@args.last == '--force')
+      else
+        puts 'Too many arguments.'
+    end
+  end
+
   # Start a console session (used for debugging).
   def console
     puts 'Entering debug console.'
@@ -200,7 +235,7 @@ class GitReview
       return if @user.nil? or @repo.nil?
       @args = args
       return unless configure_github_access
-      update
+      update unless command == 'clean'
       self.send command
     else
       unless command.nil? or command.empty? or %w(help -h --help).include?(command)
@@ -227,32 +262,34 @@ class GitReview
     puts '  close <ID>                Close a specified request.'
     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.'
   end
 
-  # Check existence of specified request and assign @pending_request.
-  def request_exists?(request_id = nil)
+  # 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
     # latest changes from GitHub, as this is called from within another method.
     automated = !request_id.nil?
-    update if automated
+    update(state) if automated
     request_id ||= @args.shift.to_i
     if request_id == 0
       puts 'Please specify a valid ID.'
       return false
     end
-    @pending_request = @pending_requests.find{ |req| req['number'] == request_id }
-    if @pending_request.nil?
+    @current_request = @current_requests.find{ |req| req['number'] == request_id }
+    if @current_request.nil?
       # No output for automated checks.
-      puts "Request '#{request_id}' does not exist." unless automated
+      puts "Request '#{request_id}' could not be found among all '#{state}' requests." unless automated
       return false
     end
     true
   end
 
   # Get latest changes from GitHub.
-  def update
-    @pending_requests = Octokit.pull_requests(source_repo)
-    repos = @pending_requests.collect do |req|
+  def update(state = 'open')
+    @current_requests = Octokit.pull_requests(source_repo, state)
+    repos = @current_requests.collect do |req|
       repo = req['head']['repository']
       "#{repo['owner']}/#{repo['name']}" unless repo.nil?
     end
@@ -261,6 +298,71 @@ class GitReview
     end
   end
 
+  # Cleans a single request's obsolete branches.
+  def clean_single(force_deletion = false)
+    update('closed')
+    return unless request_exists?('closed')
+    # Ensure there are no unmerged commits or '--force' flag has been set.
+    branch_name = @current_request['head']['ref']
+    if unmerged_commits?(branch_name) and not force_deletion
+      return puts "Won't delete branches that contain unmerged commits. Use '--force' to override."
+    end
+    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']}
+    # Select all branches with the correct prefix.
+    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|
+      # Only clean up obsolete branches.
+      unless protected_branches.include?(branch_name) or unmerged_commits?(branch_name, false)
+        delete_branch(branch_name)
+      end
+    end
+  end
+
+  # Delete local and remote branches that match a given name.
+  def delete_branch(branch_name)
+    # Delete local branch if it exists.
+    git_call("branch -D #{branch_name}") if branch_exists?(:local, branch_name)
+    # Delete remote branch if it exists.
+    git_call("push origin :#{branch_name}") 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 = []
+    locations << ['', ''] if branch_exists?(:local, branch_name)
+    locations << ['origin/', 'origin/'] if branch_exists?(:remote, branch_name)
+    locations = locations + [['', 'origin/'], ['origin/', '']] if locations.size == 2
+    if locations.empty?
+      puts 'Nothing to do. All cleaned up already.' if verbose
+      return false
+    end
+    # Compare remote and local branch with remote and local master.
+    responses = locations.collect do |location|
+      git_call "cherry #{location.first}#{target_branch} #{location.last}#{branch_name}"
+    end
+    # Select commits (= non empty and not just an error message).
+    unmerged_commits = responses.select do |response|
+      not (response.empty? or response.include?('fatal: Unknown commit'))
+    end
+    # If the array ain't empty, we got unmerged commits.
+    not unmerged_commits.empty?
+  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
+    prefix = location == :remote ? 'remotes/origin/' : ''
+    all_branches.include?(prefix + branch_name)
+  end
+
   # System call to 'git'.
   def git_call(command, verbose = debug_mode, enforce_success = false)
     if verbose
@@ -278,9 +380,14 @@ class GitReview
     output
   end
 
-  # Show current discussion for @pending_request.
+  # Convenience method that uses Octokit to access a repo through Github's API.
+  def repo_call(method, path, options = {})
+    Octokit.send(method, "/repos/#{Octokit::Repository.new(source_repo)}/#{path}", options, 3)
+  end
+
+  # Show current discussion for @current_request.
   def discussion
-    request = Octokit.pull_request(source_repo, @pending_request['number'])
+    request = Octokit.pull_request(source_repo, @current_request['number'])
     result = request['discussion'].collect do |entry|
       output = "\e[35m#{entry["user"]["login"]}\e[m "
       case entry['type']
@@ -350,6 +457,11 @@ class GitReview
     "#{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}
+  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

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: git-review
 version: !ruby/object:Gem::Version 
-  hash: 59
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 9
   - 0
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors: 
-- Dominik Bamberger, Cristian Messel
+- Dominik Bamberger
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2012-02-09 00:00:00 Z
+date: 2012-02-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: launchy