Class: GitReview

Inherits:
Object
  • Object
show all
Defined in:
lib/git-review.rb

Instance Method Summary collapse

Instance Method Details

#browse ⇒ Object

Open a browser window and review a specified request.



53
54
55
 
# File 'lib/git-review.rb', line 53

def browse
  Launchy.open(@pending_request['html_url']) if request_exists?
end

#checkout ⇒ Object

Checkout a specified request’s changes to your local repository.



58
59
60
61
62
63
64
65
66
 
# File 'lib/git-review.rb', line 58

def checkout
  return unless request_exists?
  puts 'Checking out changes to your local repository.'
  puts 'To get back to your original state, just run:'
  puts
  puts '  git checkout master'
  puts
  git_call "checkout origin/#{@pending_request['head']['ref']}"
end

#close ⇒ Object

Close a specified request.



97
98
99
100
101
 
# File 'lib/git-review.rb', line 97

def close
  return unless request_exists?
  Octokit.post("issues/close/#{source_repo}/#{@pending_request['number']}")
  puts 'Successfully closed request.' unless request_exists?(@pending_request['number'])
end

#console ⇒ Object

Start a console session (used for debugging).



122
123
124
125
126
127
128
 
# File 'lib/git-review.rb', line 122

def console
  puts 'Entering debug console.'
  require 'ruby-debug'
  Debugger.start
  debugger
  puts 'Leaving debug console.'
end

#create ⇒ Object

Create a new request. TODO: Support creating requests to other repositories and branches (like the original repo, this has been forked from).



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/git-review.rb', line 105

def create
  prepare
  # Gather information.
  last_request_id = @pending_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:'
  # 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_call "checkout #{target_branch}"
  update
  potential_new_request = @pending_requests.find{ |req| req['title'] == title }
  puts 'Successfully created new request.' if potential_new_request['number'] > last_request_id
end

#list ⇒ Object

List all pending requests.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/git-review.rb', line 13

def list
  @pending_requests.reverse! if @args.shift == '--reverse'
  output = @pending_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 = Date.parse(pending_request['updated_at']).strftime('%d-%b-%y')
    line += format_text(date_string, 11)
    line += format_text(pending_request['comments'], 10)
    line += format_text(pending_request['title'], 91)
    line
  end
  if output.compact.empty?
    puts "No pending requests for '#{source}'"
    return
  end
  puts "Pending requests for '#{source}'"
  puts 'ID      Updated    Comments  Title'
  puts output.compact
end

#merge ⇒ Object

Accept a specified request by merging it into master.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/git-review.rb', line 69

def merge
  return unless request_exists?
  option = @args.shift
  unless @pending_request['head']['repository']
    # Someone deleted the source repo.
    user = @pending_request['head']['user']['login']
    url = @pending_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
    puts "  curl #{url} | git am"
    puts
    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']}"
  puts
  puts 'Request title:'
  puts "  #{@pending_request['title']}"
  puts
  puts 'Merge command:'
  puts "  git #{exec_cmd}"
  puts
  puts git_call(exec_cmd)
end

#show ⇒ Object

Show details of a single request.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/git-review.rb', line 36

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  : #{Time.parse(@pending_request['updated_at']).strftime('%d-%b-%y')}"
  puts "Comments : #{@pending_request['comments']}"
  puts
  puts @pending_request['title']
  puts
  puts @pending_request['body']
  puts
  puts git_call("diff --color=always #{option}HEAD...#{sha}")
end