Class: GitPulls

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

Constant Summary collapse

GIT_PATH = 
lambda { return `git rev-parse --git-dir`.chomp }
PULLS_CACHE_FILE = 
"#{GIT_PATH.call}/pulls_cache.json"

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ GitPulls

Returns a new instance of GitPulls.



11
12
13
14
15
 
# File 'lib/git-pulls.rb', line 11

def initialize(args)
  @command = args.shift
  @user, @repo = repo_info
  @args = args
end

Class Method Details

.start(args) ⇒ Object 



17
18
19
 
# File 'lib/git-pulls.rb', line 17

def self.start(args)
  GitPulls.new(args).run
end

Instance Method Details

#browse ⇒ Object 



141
142
143
144
145
146
147
148
 
# File 'lib/git-pulls.rb', line 141

def browse
  num = @args.shift
  if p = pull_num(num)
    Launchy.open(p['html_url'])
  else
    puts "No such number"
  end
end

#cache_pull_info ⇒ Object 



302
303
304
305
306
 
# File 'lib/git-pulls.rb', line 302

def cache_pull_info
  response_o = Octokit.pull_requests("#{@user}/#{@repo}")
  response_c = Octokit.pull_requests("#{@user}/#{@repo}", 'closed')
  save_data({'open' => response_o, 'closed' => response_c}, PULLS_CACHE_FILE)
end

#checkout ⇒ Object 



183
184
185
186
187
188
189
190
191
 
# File 'lib/git-pulls.rb', line 183

def checkout
  puts "Checking out all open pull requests for #{@user}/#{@repo}"
  pulls = get_open_pull_info
  pulls.each do |pull|
    branch_ref = pull['head']['ref']
    puts "> #{branch_ref} into pull-#{branch_ref}"
    git("branch --track #{@args.join(' ')} pull-#{branch_ref} origin/#{branch_ref}")
  end
end

#clean(info) ⇒ Object 



245
246
247
 
# File 'lib/git-pulls.rb', line 245

def clean(info)
  info.to_s.gsub("\n", ' ')
end

#configure ⇒ Object

PRIVATE REPOSITORIES ACCESS



251
252
253
254
255
256
257
258
 
# File 'lib/git-pulls.rb', line 251

def configure
  Octokit.configure do |config|
    config.        =  if  and not .empty?
    config.web_endpoint = github_endpoint
    config.oauth_token  = github_token if github_token and not github_token.empty?
    config.proxy        = github_proxy if github_proxy and not github_proxy.empty?
  end
end

#fetch_stale_forks ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/git-pulls.rb', line 200

def fetch_stale_forks
  puts "Checking for forks in need of fetching"
  pulls = get_open_pull_info | get_closed_pull_info
  repos = {}
  pulls.each do |pull|
    next if pull['head']['repository'].nil? # Fork has been deleted
    o = pull['head']['repository']['owner']
    r = pull['head']['repository']['name']
    s = pull['head']['sha']
    if !has_sha(s)
      repo = "#{o}/#{r}"
      repos[repo] = true
    end
  end
  if github_credentials_provided?
    endpoint = "[email protected]:"
  else
    endpoint = github_endpoint + "/"
  end
  repos.each do |repo, bool|
    puts "  fetching #{repo}"
    git("fetch #{endpoint}#{repo}.git +refs/heads/*:refs/pr/#{repo}/*")
  end
end

#get_closed_pull_info ⇒ Object 



290
291
292
 
# File 'lib/git-pulls.rb', line 290

def get_closed_pull_info
  get_data(PULLS_CACHE_FILE)['closed']
end

#get_data(file) ⇒ Object 



298
299
300
 
# File 'lib/git-pulls.rb', line 298

def get_data(file)
  data = JSON.parse(File.read(file))
end

#get_open_pull_info ⇒ Object 



294
295
296
 
# File 'lib/git-pulls.rb', line 294

def get_open_pull_info
  get_data(PULLS_CACHE_FILE)['open']
end

#git(command) ⇒ Object 



359
360
361
 
# File 'lib/git-pulls.rb', line 359

def git(command)
  `git #{command}`.chomp
end

#github_credentials_provided? ⇒ Boolean

API/DATA HELPER FUNCTIONS #

Returns:

  • (Boolean) 


283
284
285
286
287
288
 
# File 'lib/git-pulls.rb', line 283

def github_credentials_provided?
  if github_token.empty? && .empty?
    return false
  end
  true
end

#github_endpoint ⇒ Object 



268
269
270
271
272
273
274
275
 
# File 'lib/git-pulls.rb', line 268

def github_endpoint
  host = git("config --get-all github.host")
  if host.size > 0
    host
  else
    'https://github.com'
  end
end

#github_insteadof_matching(c, u) ⇒ Object 



320
321
322
323
324
325
326
327
328
 
# File 'lib/git-pulls.rb', line 320

def github_insteadof_matching(c, u)
  first = c.collect {|k,v| [v, /url\.(.*github\.com.*)\.insteadof/.match(k)]}.
            find {|v,m| v and u.index(v) and m != nil}

  if first
    return first[0], first[1][1]
  end
  return nil, nil
end

#github_login ⇒ Object 



260
261
262
 
# File 'lib/git-pulls.rb', line 260

def 
  git("config --get-all github.user")
end

#github_proxy ⇒ Object 



277
278
279
 
# File 'lib/git-pulls.rb', line 277

def github_proxy
  git("config --get-all http.proxy")
end

#github_token ⇒ Object 



264
265
266
 
# File 'lib/git-pulls.rb', line 264

def github_token
  git("config --get-all github.token")
end

#github_user_and_proj(u) ⇒ Object 



330
331
332
333
334
335
336
337
 
# File 'lib/git-pulls.rb', line 330

def github_user_and_proj(u)
  # Trouble getting optional ".git" at end to work, so put that logic below
  m = /github\.com.(.*?)\/(.*)/.match(u)
  if m
    return m[1], m[2].sub(/\.git\Z/, "")
  end
  return nil, nil
end

#has_sha(sha) ⇒ Object 



225
226
227
228
 
# File 'lib/git-pulls.rb', line 225

def has_sha(sha)
  git("show #{sha} 2>&1")
  $?.exitstatus == 0
end

#help ⇒ Object

COMMANDS ##



41
42
43
44
45
 
# File 'lib/git-pulls.rb', line 41

def help
  puts "No command: #{@command}"
  puts "Try: update, list, show, merge, checkout, browse"
  puts "or call with '-h' for usage information"
end

#l(info, size) ⇒ Object

DISPLAY HELPER FUNCTIONS #



237
238
239
 
# File 'lib/git-pulls.rb', line 237

def l(info, size)
  clean(info)[0, size].ljust(size)
end

#list ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/git-pulls.rb', line 150

def list
  state = @args.shift

  if not ['open', 'closed'].include?(state)
    state = 'open'
    option = state
  else
    option = @args.shift
  end

  puts state.capitalize + " Pull Requests for #{@user}/#{@repo}"
  pulls = state == 'open' ? get_open_pull_info : get_closed_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'], 50)
    sha = pull['head']['sha']
    if not_merged?(sha)
      puts line.join ' '
      count += 1
    end
  end
  if count == 0
    puts ' -- no ' + state + ' pull requests --'
  end
end

#merge ⇒ Object 



62
63
64
65
66
67
68
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
95
 
# File 'lib/git-pulls.rb', line 62

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-pulls 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)
  else
    puts "No such number"
  end
end

#not_a_github_repository ⇒ Object 



47
48
49
 
# File 'lib/git-pulls.rb', line 47

def not_a_github_repository
  puts "No user informations found. Make sure you're in a Github's repository."
end

#not_merged?(sha) ⇒ Boolean

Returns:

  • (Boolean) 


230
231
232
233
 
# File 'lib/git-pulls.rb', line 230

def not_merged?(sha)
  commits = git("rev-list #{sha} ^HEAD 2>&1")
  commits.split("\n").size > 0
end

#pull_num(num) ⇒ Object 



314
315
316
317
318
 
# File 'lib/git-pulls.rb', line 314

def pull_num(num)
  pull = get_open_pull_info.select { |p| p['number'].to_s == num.to_s }.first
  pull ||= get_closed_pull_info.select { |p| p['number'].to_s == num.to_s }.first
  pull
end

#r(info, size) ⇒ Object 



241
242
243
 
# File 'lib/git-pulls.rb', line 241

def r(info, size)
  clean(info)[0, size].rjust(size)
end

#repo_info ⇒ Object 



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/git-pulls.rb', line 339

def repo_info
  c = {}
  config = git('config --list')
  config.split("\n").each do |line|
    k, v = line.split('=')
    c[k] = v
  end
  u = c['remote.origin.url']

  user, proj = github_user_and_proj(u)
  if !(user and proj)
    short, base = github_insteadof_matching(c, u)
    if short and base
      u = u.sub(short, base)
      user, proj = github_user_and_proj(u)
    end
  end
  [user, proj]
end

#run ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/git-pulls.rb', line 21

def run
  configure
  if not @user
    not_a_github_repository
  elsif @command && self.respond_to?(@command)
    # If the cache file doesn't exist, make sure we run update
    # before any other command. git-pulls will otherwise crash
    # with an exception.
    update unless File.exists?(PULLS_CACHE_FILE) || @command == 'update'

    self.send @command
  elsif %w(-h --help).include?(@command)
    usage
  else
    help
  end
end

#save_data(data, file) ⇒ Object 



308
309
310
311
312
 
# File 'lib/git-pulls.rb', line 308

def save_data(data, file)
  File.open(file, "w+") do |f|
    f.puts data.to_json
  end
end

#show ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/git-pulls.rb', line 97

def show
  num = @args.shift
  optiona = @args.shift
  optionb = @args.shift
  if p = pull_num(num)
    comments = []
    if optiona == '--comments' || optionb == '--comments'
      i_comments = Octokit.issue_comments("#{@user}/#{@repo}", num)
      p_comments = Octokit.pull_request_comments("#{@user}/#{@repo}", num)
      c_comments = Octokit.commit_comments(p['head']['repo']['full_name'], p['head']['sha'])
      comments = (i_comments | p_comments | c_comments).sort_by {|i| i['created_at']}
    end
    puts "Number   : #{p['number']}"
    puts "Label    : #{p['head']['label']}"
    puts "Creator  : #{p['user']['login']}"
    puts "Created  : #{p['created_at']}"
    puts
    puts "Title    : #{p['title']}"
    puts
    puts p['body']
    puts
    puts '------------'
    puts
    comments.each do |c|
      puts "Comment  : #{c['user']['login']}"
      puts "Created  : #{c['created_at']}"
      puts "File     : #{c['path']}:L#{c['line'] || c['position'] || c['original_position']}" unless c['path'].nil?
      puts
      puts c['body']
      puts
      puts '------------'
      puts
    end
    if optiona == '--full' || optionb == '--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
  else
    puts "No such number"
  end
end

#update ⇒ Object 



193
194
195
196
197
198
 
# File 'lib/git-pulls.rb', line 193

def update
  puts "Updating #{@user}/#{@repo}"
  cache_pull_info
  fetch_stale_forks
  list
end

#usage ⇒ Object 



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/git-pulls.rb', line 51

def usage
  puts <<-USAGE
Usage: git pulls update
 or: git pulls list [state] [--reverse]
 or: git pulls show <number> [--comments] [--full]
 or: git pulls browse <number>
 or: git pulls merge <number>
 or: git pulls checkout [--force]
  USAGE
end