git-review 0.4.1 → 0.4.2

data/bin/git-review

@@ -5,4 +5,4 @@ $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 
 require 'git-review'
 
-GitReview.start(ARGV)
+GitReview.new(ARGV)

data/lib/git-review.rb

@@ -6,159 +6,182 @@ class GitReview
 
   REVIEW_CACHE_FILE = '.git/review_cache.json'
 
-  def initialize(args)
-    @command = args.shift
-    @user, @repo = repo_info
-    @args = args
-  end
+  ## COMMANDS ##
 
-  def self.start(args)
-    GitReview.new(args).run
+  # Default command to show a quick reference of available commands.
+  def help
+    puts 'Usage: git review <command>'
+    puts 'Manage review workflow for projects hosted on GitHub (using pull requests).'
+    puts ''
+    puts 'Available commands:'
+    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 '   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}"
+    option = @args.shift
+    open_requests = get_pull_info
+    open_requests.reverse! if option == '--reverse'
+    count = 0
+    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)
+      sha = pull['head']['sha']
+      if not_merged?(sha)
+        puts line.join ' '
+        count += 1
+      end
+    end
+    if count == 0
+      puts ' -- no open pull requests --'
+    end
   end
 
-  def run
-    configure
-    if @command && self.respond_to?(@command)
-      update  
-      self.send @command
-    elsif %w(-h --help).include?(@command)
-      usage
+  # Show details of a single request.
+  def show
+    return unless review_exists?
+    option = @args.shift
+    puts "Number   : #{@review['number']}"
+    puts "Label    : #{@review['head']['label']}"
+    puts "Created  : #{@review['created_at']}"
+    puts "Votes    : #{@review['votes']}"
+    puts "Comments : #{@review['comments']}"
+    puts
+    puts "Title    : #{@review['title']}"
+    puts "Body     :"
+    puts
+    puts @review['body']
+    puts
+    puts '------------'
+    puts
+    if option == '--full'
+      exec "git diff --color=always HEAD...#{@review['head']['sha']}"
     else
-      help
+      puts "cmd: git diff HEAD...#{@review['head']['sha']}"
+      puts git("diff --stat --color=always HEAD...#{@review['head']['sha']}")
     end
   end
 
-  ## COMMANDS ##
-
-  def help
-    puts "No command: #{@command}"
-    puts "Try: update, list, show, merge, browse, create"
-    puts "or call with '-h' for usage information"
-  end
-
-  def usage
-    puts <<-USAGE
-Usage: git review list [--reverse]
-   or: git review show <number> [--full]
-   or: git review browse <number>
-   or: git review merge <number>
-   or: git review create
-    USAGE
+  # Open a browser window and review a specified request.
+  def browse
+    Launchy.open(@review['html_url']) if review_exists?
   end
 
-  def merge
-    num = @args.shift
-    option = @args.shift
-    if p = pull_num(num)
-      if p['head']['repository']
-        o = p['head']['repository']['owner']
-        r = p['head']['repository']['name']
-      else # they deleted the source repo
-        o = p['head']['user']['login']
-        purl = p['patch_url']
-        puts "Sorry, #{o} deleted the source repository, git-review doesn't support this."
-        puts "You can manually patch your repo by running:"
-        puts
-        puts "  curl #{purl} | git am"
-        puts
-        puts "Tell the contributor not to do this."
-        return false
-      end
-      s = p['head']['sha']
-
-      message = "Merge pull request ##{num} from #{o}/#{r}\n\n---\n\n"
-      message += p['body'].gsub("'", '')
-      cmd = ''
-      if option == '--log'
-        message += "\n\n---\n\nMerge Log:\n"
-        puts cmd = "git merge --no-ff --log -m '#{message}' #{s}"
-      else
-        puts cmd = "git merge --no-ff -m '#{message}' #{s}"
-      end
-      exec(cmd)
+  # 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 "No such number"
+      puts 'Creating new review request failed.'
     end
   end
 
-  def show
-    num = @args.shift
+  # Sign off a specified request by merging it into master.
+  def merge
+    return unless review_exists?
     option = @args.shift
-    if p = pull_num(num)
-      puts "Number   : #{p['number']}"
-      puts "Label    : #{p['head']['label']}"
-      puts "Created  : #{p['created_at']}"
-      puts "Votes    : #{p['votes']}"
-      puts "Comments : #{p['comments']}"
+    if @review['head']['repository']
+      o = @review['head']['repository']['owner']
+      r = @review['head']['repository']['name']
+    else # they deleted the source repo
+      o = @review['head']['user']['login']
+      purl = @review['patch_url']
+      puts "Sorry, #{o} deleted the source repository, git-review doesn't support this."
+      puts "You can manually patch your repo by running:"
       puts
-      puts "Title    : #{p['title']}"
-      puts "Body     :"
+      puts "  curl #{purl} | git am"
       puts
-      puts p['body']
-      puts
-      puts '------------'
-      puts
-      if option == '--full'
-        exec "git diff --color=always HEAD...#{p['head']['sha']}"
-      else
-        puts "cmd: git diff HEAD...#{p['head']['sha']}"
-        puts git("diff --stat --color=always HEAD...#{p['head']['sha']}")
-      end
+      puts "Tell the contributor not to do this."
+      return false
+    end
+    s = @review['head']['sha']
+    message = "Merge pull request ##{@review['number']} from #{o}/#{r}\n\n---\n\n"
+    message += @review['body'].gsub("'", '')
+    if option == '--log'
+      message += "\n\n---\n\nMerge Log:\n"
+      puts cmd = "git merge --no-ff --log -m '#{message}' #{s}"
     else
-      puts "No such number"
+      puts cmd = "git merge --no-ff -m '#{message}' #{s}"
     end
+    exec(cmd)
   end
 
-  def browse
-    num = @args.shift
-    if p = pull_num(num)
-      Launchy.open(p['html_url'])
-    else
-      puts "No such number"
-    end
+  # Start a console session (used for debugging).
+  def console
+    puts 'Entering debug console.'
+    require 'ruby-debug'
+    Debugger.start
+    debugger
+    puts 'Leaving debug console.'
   end
 
-  def list
-    option = @args.shift
-    puts "Open Pull Requests for #{@user}/#{@repo}"
-    pulls = get_pull_info
-    pulls.reverse! if option == '--reverse'
-    count = 0
-    pulls.each do |pull|
-      line = []
-      line << l(pull['number'], 4)
-      line << l(Date.parse(pull['created_at']).strftime("%m/%d"), 5)
-      line << l(pull['comments'], 2)
-      line << l(pull['title'], 35)
-      line << l(pull['head']['label'], 20)
-      sha = pull['head']['sha']
-      if not_merged?(sha)
-        puts line.join ' '
-        count += 1
+
+  private
+
+  # Setup variables and call actual commands.
+  def initialize(args)
+    command = args.shift
+    @user, @repo = repo_info
+    @args = args
+    configure
+    if command && self.respond_to?(command)
+      update
+      self.send command
+    else
+      unless command.blank? or %w(-h --help).include?(command)
+        puts "git-review: '#{command}' is not a valid command.\n\n"
       end
-    end
-    if count == 0
-      puts ' -- no open pull requests --'
+      help
     end
   end
 
+  # Get latest changes from GitHub.
   def update
     cache_pull_info
     fetch_stale_forks
   end
 
-  def create
-    repo = "#{@user}/#{@repo}"
-    to_branch = 'master'
-    from_branch = get_from_branch_title
-    title = 'my title'
-    body = 'my body'
-    
-    Octokit.create_pull_request(repo, to_branch, from_branch, title, body)
+  # Check existence of specified review and assign @review.
+  def review_exists?
+    review_id = @args.shift.to_i
+    @review = get_pull_info.find{ |review| review['number'] == review_id}
+    puts "Review '#{review_id}' does not exist." unless @review
+    not @review.nil?
   end
-  
-  def get_from_branch_title
-    git('branch', false).match(/\*(.*)/)[0][2..-1]
+
+  # System call to 'git'.
+  def git(command, chomp=true)
+    s = `git #{command}`
+    s.chomp! if chomp
+    s
+  end
+
+  # Display helper to make output more beautiful.
+  def format_text(info, size)
+    info.to_s.gsub("\n", ' ')[0, size].ljust(size)
   end
 
   def fetch_stale_forks
@@ -195,20 +218,6 @@ Usage: git review list [--reverse]
     commits.split("\n").size > 0
   end
 
-  # DISPLAY HELPER FUNCTIONS #
-
-  def l(info, size)
-    clean(info)[0, size].ljust(size)
-  end
-
-  def r(info, size)
-    clean(info)[0, size].rjust(size)
-  end
-
-  def clean(info)
-    info.to_s.gsub("\n", ' ')
-  end
-
   # PRIVATE REPOSITORIES ACCESS
 
   def configure
@@ -250,7 +259,7 @@ Usage: git review list [--reverse]
   end
 
   def get_data(file)
-    data = JSON.parse(File.read(file))
+    JSON.parse(File.read(file))
   end
 
   def cache_pull_info
@@ -264,11 +273,6 @@ Usage: git review list [--reverse]
     end
   end
 
-  def pull_num(num)
-    data = get_pull_info
-    data.select { |p| p['number'].to_s == num.to_s }.first
-  end
-
   def github_insteadof_matching(c, u)
     first = c.collect {|k,v| [v, /url\.(.*github\.com.*)\.insteadof/.match(k)]}.
               find {|v,m| u.index(v) and m != nil}
@@ -307,9 +311,4 @@ Usage: git review list [--reverse]
     [user, proj]
   end
 
-  def git(command, chomp=true)
-    s = `git #{command}`
-    s.chomp! if chomp
-    s
-  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: git-review
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Cristian Messel, Dominik Bamberger
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-12 00:00:00 +02:00
+date: 2011-07-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency