Class: GitPulls

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

Constant Summary collapse

GIT_REMOTE = 
ENV['GIT_REMOTE'] || 'origin'
GIT_PATH = 
lambda { return `git rev-parse --git-dir`.chomp }
PULLS_CACHE_FILE = 
"#{GIT_PATH.call}/pulls_cache.yml"

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ GitPulls

Returns a new instance of GitPulls.



14
15
16
17
18
 
# File 'lib/git-pulls.rb', line 14

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

Class Method Details

.start(args) ⇒ Object 



20
21
22
 
# File 'lib/git-pulls.rb', line 20

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

Instance Method Details

#browse ⇒ Object 



160
161
162
163
164
165
166
167
 
# File 'lib/git-pulls.rb', line 160

def browse
  num = @args.shift
  if pull = pull_num(num)
    Launchy.open(pull[:_links].to_hash[:html].to_hash[:href])
  else
    puts "No such number"
  end
end

#cache_pull_info ⇒ Object 



345
346
347
348
349
 
# File 'lib/git-pulls.rb', line 345

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

#checkout ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/git-pulls.rb', line 205

def checkout
  puts "Checking out all open pull requests for #{@user}/#{@repo}"
  pulls = get_open_pull_info
  pulls.each do |pull|
    head        = pull[:head].to_hash
    branch_ref  = head[:ref]

    puts "> #{branch_ref} into pull-#{branch_ref}"
    git("branch --track #{@args.join(' ')} pull-#{branch_ref} #{GIT_REMOTE}/#{branch_ref}")
  end
end

#clean(info) ⇒ Object 



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

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

#configure ⇒ Object

PRIVATE REPOSITORIES ACCESS



282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/git-pulls.rb', line 282

def configure
  Octokit.configure do |config|

    config.        =  if  and not .empty?
    config.web_endpoint = github_endpoint
    config.access_token = github_token if github_token and not github_token.empty?
    config.proxy        = github_proxy if github_proxy and not github_proxy.empty?
    config.api_endpoint = github_api_endpoint if (github_api_endpoint and \
                                              not github_api_endpoint.empty?)
  end
end

#enterprise_user_and_proj(u) ⇒ Object 



384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/git-pulls.rb', line 384

def enterprise_user_and_proj(u)
  # if git, u is probably something like: [email protected]:SomeGroup/some_repo.git
  m = /.*?:(.*)\/(.*)/.match(u) if u =~ /^git/

  # if http(s), u is probably something like: https://github.hq.corp.lan/SomeGroup/some_repo.git
  m = /https?:\/\/.*?\/(.*)\/(.*)/.match(u) if u =~ /^http/
  if m
    return m[1], m[2].sub(/\.git\Z/, "")
  end
  return nil, nil
end

#fetch_stale_forks ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/git-pulls.rb', line 224

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|
    head = pull[:head].to_hash

    unless repo = head[:repo] && head[:repo].to_hash
      next # Fork has been deleted
    end

    owner     = repo[:owner].to_hash
    repo_name = repo[:name]
    sha       = head[:sha]

    unless has_sha?(sha)
      repo        = "#{owner[:login]}/#{repo_name}"
      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 



333
334
335
 
# File 'lib/git-pulls.rb', line 333

def get_closed_pull_info
  get_data(PULLS_CACHE_FILE)['closed'].map(&:to_hash)
end

#get_data(file) ⇒ Object 



341
342
343
 
# File 'lib/git-pulls.rb', line 341

def get_data(file)
  ::Psych.load_file(file)
end

#get_open_pull_info ⇒ Object 



337
338
339
 
# File 'lib/git-pulls.rb', line 337

def get_open_pull_info
  get_data(PULLS_CACHE_FILE)['open'].map(&:to_hash)
end

#git(command) ⇒ Object 



416
417
418
 
# File 'lib/git-pulls.rb', line 416

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

#github_api_endpoint ⇒ Object 



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

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

end

#github_credentials_provided? ⇒ Boolean

API/DATA HELPER FUNCTIONS #

Returns:

  • (Boolean) 


326
327
328
329
330
331
 
# File 'lib/git-pulls.rb', line 326

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

#github_endpoint ⇒ Object 



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

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 



363
364
365
366
367
368
369
370
371
 
# File 'lib/git-pulls.rb', line 363

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 



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

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

#github_proxy ⇒ Object 



320
321
322
 
# File 'lib/git-pulls.rb', line 320

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

#github_token ⇒ Object 



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

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

#github_user_and_proj(u) ⇒ Object 



373
374
375
376
377
378
379
380
381
382
 
# File 'lib/git-pulls.rb', line 373

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

  # that works with default github but not enterprise
  return enterprise_user_and_proj(u)
end

#has_sha?(sha) ⇒ Boolean

Returns:

  • (Boolean) 


256
257
258
259
 
# File 'lib/git-pulls.rb', line 256

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

#help ⇒ Object

COMMANDS ##



44
45
46
47
48
 
# File 'lib/git-pulls.rb', line 44

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 #



268
269
270
 
# File 'lib/git-pulls.rb', line 268

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

#list ⇒ Object 



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/git-pulls.rb', line 169

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
  
  if (state == 'closed')
     pulls.sort! { |a, b| b[:closed_at] <=> a[:closed_at] }
  end
  
  pulls.reverse! if option == '--reverse'

  pulls.each do |pull|
    pull = pull.to_hash
    head = pull[:head].to_hash

    line = []
    line << l(pull[:number], 4)
    line << l(Date.parse(pull[:created_at].to_s).strftime("%m/%d"), 5)
    line << l(pull[:title], 35)
    line << l(head[:label], 50)

    puts line.join ' '
  end
  if pulls.count == 0
    puts ' -- no ' + state + ' pull requests --'
  end
end

#merge ⇒ Object 



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
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/git-pulls.rb', line 65

def merge
  num = @args.shift
  option = @args.shift
  if pull = pull_num(num)
    head = pull[:head].to_hash
    user = pull[:user].to_hash

    if repo = head[:repo] && head[:repo].to_hash
      owner     = repo[:owner].to_hash
      repo_name = repo[:name]

      sha = head[:sha]

      message = "Merge pull request ##{num} from #{owner[:login]}/#{repo_name}\n\n---\n\n"
      message += pull[:body] ? pull[:body].gsub("'", '') : ""
      cmd = ''
      if option == '--log'
        message += "\n\n---\n\nMerge Log:\n"
        puts cmd = "git merge --no-ff --log -m '#{message}' #{sha}"
      elsif option == '--no-commit'
        message += "\n\n---\n\nMerge with --no-commit option:\n"
        puts cmd = "git merge --no-commit -m '#{message}' #{sha}"
      else
        puts cmd = "git merge --no-ff -m '#{message}' #{sha}"
      end
      exec(cmd)

    else # they deleted the source repo
      owner     = head[:user].to_hash[:login]
      patch_url = "#{pull[:_links].to_hash[:html].to_hash[:href]}.patch"

      puts "Sorry, #{owner} deleted the source repository, git-pulls doesn't support this."
      puts "You can manually patch your repo by running:"
      puts
      puts "  curl #{patch_url} | git am"
      puts
      puts "Tell the contributor not to do this."
      return false
    end
  else
    puts "No such number"
  end
end

#not_a_github_repository ⇒ Object 



50
51
52
 
# File 'lib/git-pulls.rb', line 50

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) 


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

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

#pull_num(num) ⇒ Object 



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

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 



272
273
274
 
# File 'lib/git-pulls.rb', line 272

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

#repo_info ⇒ Object 



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/git-pulls.rb', line 396

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.#{GIT_REMOTE}.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 



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

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 



351
352
353
354
355
 
# File 'lib/git-pulls.rb', line 351

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

#show ⇒ Object 



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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/git-pulls.rb', line 109

def show
  num = @args.shift
  optiona = @args.shift
  optionb = @args.shift

  if pull = pull_num(num)
    head = pull[:head].to_hash
    repo = head[:repo].to_hash
    user = pull[:user].to_hash

    comments = []
    if optiona == '--comments' || optionb == '--comments'
      i_comments = Octokit.issue_comments("#{@user}/#{@repo}", num).map(&:to_hash)
      p_comments = Octokit.pull_request_comments("#{@user}/#{@repo}", num).map(&:to_hash)
      c_comments = Octokit.commit_comments(repo[:full_name], head[:sha])
      comments = (i_comments | p_comments | c_comments).sort_by {|i| i[:created_at]}
    end
    puts "Number   : #{pull[:number]}"
    puts "Label    : #{head[:label]}"
    puts "Creator  : #{user[:login]}"
    puts "Created  : #{pull[:created_at]}"
    puts
    puts "Title    : #{pull[:title]}"
    puts
    puts pull[:body]
    puts
    puts '------------'
    puts
    comments.each do |comment|
      user = comment[:user]

      puts "Comment  : #{user[:login]}"
      puts "Created  : #{comment[:created_at]}"
      puts "File     : #{comment[:path]}:L#{comment[:line] || comment[:position] || comment[:original_position]}" unless comment[:path].nil?
      puts
      puts comment[:body]
      puts
      puts '------------'
      puts
    end
    if optiona == '--full' || optionb == '--full'
      exec "git diff --color=always HEAD...#{head[:sha]}"
    else
      puts "cmd: git diff HEAD...#{head[:sha]}"
      puts git("diff --stat --color=always HEAD...#{head[:sha]}")
    end
  else
    puts "No such number"
  end
end

#update ⇒ Object 



217
218
219
220
221
222
 
# File 'lib/git-pulls.rb', line 217

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

#usage ⇒ Object 



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/git-pulls.rb', line 54

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> [--no-commit] [--log]
 or: git pulls checkout [--force]
  USAGE
end