git-review 0.4.2 → 0.5.0

data/lib/git-review.rb

@@ -17,24 +17,27 @@ class GitReview
     puts '   list [--reverse]          List all open requests.'
     puts '   show <number> [--full]    Show details of a single request.'
     puts '   browse <number>           Open a browser window and review a specified request.'
+    # puts '   checkout <number>         Checkout a specified request\'s changes to your local repository.'
+    puts '   accept <number>           Accept a specified request by merging it into master.'
+    puts '   decline <number>          Decline and close a specified request.'
     puts '   create                    Create a new request.'
-    puts '   merge <number>            Sign off a specified request by merging it into master.'
   end
 
   # List all open requests.
   def list
-    puts "Open Pull Requests for #{@user}/#{@repo}"
+    puts "Open requests for '#{source_repo}/#{source_branch}'"
     option = @args.shift
     open_requests = get_pull_info
     open_requests.reverse! if option == '--reverse'
+    # TODO: Refactor to get rid of unnecessary variables and computation.
     count = 0
+    puts 'ID     Date       Comments   Title'
     open_requests.each do |pull|
       line = []
-      line << format_text(pull['number'], 4)
-      line << format_text(Date.parse(pull['created_at']).strftime("%m/%d"), 5)
-      line << format_text(pull['comments'], 2)
-      line << format_text(pull['title'], 35)
-      line << format_text(pull['head']['label'], 20)
+      line << format_text(pull['number'], 6)
+      line << format_text(Date.parse(pull['created_at']).strftime('%d-%b-%y'), 10)
+      line << format_text(pull['comments'], 10)
+      line << format_text(pull['title'], 94)
       sha = pull['head']['sha']
       if not_merged?(sha)
         puts line.join ' '
@@ -42,7 +45,7 @@ class GitReview
       end
     end
     if count == 0
-      puts ' -- no open pull requests --'
+      puts ' -- No open requests. --'
     end
   end
 
@@ -76,31 +79,14 @@ class GitReview
     Launchy.open(@review['html_url']) if review_exists?
   end
 
-  # Create a new request.
-  def create
-    # Gather information.
-    last_review_id = get_pull_info.collect{|review| review['number']}.sort.last
-    target_repo = "#{@user}/#{@repo}"
-    target_branch = 'master'
-    source_branch = git('branch', false).match(/\*(.*)/)[0][2..-1]
-    title = "Review request: #{github_login} wants to merge changes from '#{source_branch}' into #{target_repo}'s branch '#{target_branch}'."
-    # 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 = 'my body'
-    # Create the actual pull request.
-    Octokit.create_pull_request(target_repo, target_branch, source_branch, title, body)
-    # Switch back to target_branch and check for success.
-    git "co #{target_branch}"
-    update
-    potential_new_review = get_pull_info.find{ |review| review['title'] == title}
-    if potential_new_review['number'] > last_review_id
-      puts 'Review request successfully created.'
-    else
-      puts 'Creating new review request failed.'
-    end
+  # Checkout a specified request's changes to your local repository.
+  # TODO: Implement this.
+  def checkout
+    puts 'Under construction... ;-)'
   end
 
-  # Sign off a specified request by merging it into master.
-  def merge
+  # Accept a specified request by merging it into master.
+  def accept
     return unless review_exists?
     option = @args.shift
     if @review['head']['repository']
@@ -118,7 +104,7 @@ class GitReview
       return false
     end
     s = @review['head']['sha']
-    message = "Merge pull request ##{@review['number']} from #{o}/#{r}\n\n---\n\n"
+    message = "Accepting request ##{@review['number']} from #{o}/#{r}\n\n---\n\n"
     message += @review['body'].gsub("'", '')
     if option == '--log'
       message += "\n\n---\n\nMerge Log:\n"
@@ -129,6 +115,31 @@ class GitReview
     exec(cmd)
   end
 
+  # Decline and close a specified request.
+  def decline
+    return unless review_exists?
+    Octokit.post("issues/close/#{source_repo}/#{@review['number']}")
+    puts "Successfully declined request." unless review_exists?(@review['number'])
+  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
+    # TODO: Create and push to a remote branch if necessary.
+    # Gather information.
+    last_review_id = get_pull_info.collect{|review| review['number']}.sort.last.to_i
+    title = "[Review] Request from '#{github_login}' @ '#{source_repo}/#{source_branch}'"
+    # 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 = "You are requested to review the following changes:"
+    # Create the actual pull request.
+    Octokit.create_pull_request(target_repo, target_branch, source_branch, title, body)
+    # Switch back to target_branch and check for success.
+    git "co #{target_branch}"
+    update
+    potential_new_review = get_pull_info.find{ |review| review['title'] == title}
+    puts 'Review request successfully created.' if potential_new_review['number'] > last_review_id
+  end
+
   # Start a console session (used for debugging).
   def console
     puts 'Entering debug console.'
@@ -165,8 +176,15 @@ class GitReview
   end
 
   # Check existence of specified review and assign @review.
-  def review_exists?
-    review_id = @args.shift.to_i
+  def review_exists?(review_id = nil)
+    # NOTE: If review_id is not set explicitly we might need to update to get the
+    # latest changes from GitHub, as this is called from within another method.
+    update if review_id.nil?
+    review_id ||= @args.shift.to_i
+    if review_id == 0
+      puts "Please specify a valid ID."
+      return false
+    end
     @review = get_pull_info.find{ |review| review['number'] == review_id}
     puts "Review '#{review_id}' does not exist." unless @review
     not @review.nil?
@@ -184,6 +202,28 @@ class GitReview
     info.to_s.gsub("\n", ' ')[0, size].ljust(size)
   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('branch', false).match(/\*(.*)/)[0][2..-1]
+  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.
+    'master'
+  end
+
   def fetch_stale_forks
     pulls = get_pull_info
     repos = {}
@@ -263,7 +303,7 @@ class GitReview
   end
 
   def cache_pull_info
-    response = Octokit.pull_requests("#{@user}/#{@repo}")
+    response = Octokit.pull_requests(source_repo)
     save_data({'review' => response}, REVIEW_CACHE_FILE)
   end
 

metadata

@@ -5,17 +5,17 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
-- Cristian Messel, Dominik Bamberger
+- Dominik Bamberger, Cristian Messel
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-07-13 00:00:00 +02:00
+date: 2011-07-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,7 +62,7 @@ dependencies:
         version: 0.5.1
   type: :runtime
   version_requirements: *id003
-description: git-review facilitates github code reviews.
+description: Manage review workflow for projects hosted on GitHub (using pull requests).
 email: bamberger.dominik@gmail.com
 executables: 
 - git-review
@@ -107,6 +107,6 @@ rubyforge_project:
 rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: facilitates github code reviews
+summary: facilitates GitHub code reviews
 test_files: []