Refactored Diff::Display classes
[gitorious:yousource.git] / vendor / ruby-git / lib / git / lib.rb
1 require 'tempfile'
2
3 module Git
4   
5   class GitExecuteError < StandardError 
6   end
7   
8   class Lib
9       
10     @git_dir = nil
11     @git_index_file = nil
12     @git_work_dir = nil
13     @path = nil
14         
15     def initialize(base = nil)
16       if base.is_a?(Git::Base)
17         @git_dir = base.repo.path
18         @git_index_file = base.index.path if base.index
19         @git_work_dir = base.dir.path if base.dir
20       elsif base.is_a?(Hash)
21         @git_dir = base[:repository]
22         @git_index_file = base[:index] 
23         @git_work_dir = base[:working_directory]
24       end
25     end
26     
27     def init
28       command('init')
29     end
30     
31     # tries to clone the given repo
32     #
33     # returns {:repository} (if bare)
34     #         {:working_directory} otherwise
35     #
36     # accepts options:
37     #  :remote - name of remote (rather than 'origin')
38     #  :bare   - no working directory
39     # 
40     # TODO - make this work with SSH password or auth_key
41     #
42     def clone(repository, name, opts = {})
43       @path = opts[:path] || '.'
44       opts[:path] ? clone_dir = File.join(@path, name) : clone_dir = name
45       
46       arr_opts = []
47       arr_opts << "--bare" if opts[:bare]
48       arr_opts << "-o #{opts[:remote]}" if opts[:remote]
49       arr_opts << repository
50       arr_opts << clone_dir
51       
52       command('clone', arr_opts)
53       
54       opts[:bare] ? {:repository => clone_dir} : {:working_directory => clone_dir}
55     end
56     
57     
58     ## READ COMMANDS ##
59     
60     
61     def log_commits(opts = {})
62       arr_opts = ['--pretty=oneline']
63       arr_opts << "-#{opts[:count]}" if opts[:count]
64       arr_opts << "--skip=#{opts[:skip]}" if opts[:skip]
65       arr_opts << "--since=\"#{opts[:since]}\"" if opts[:since].is_a? String
66       arr_opts << "#{opts[:between][0].to_s}..#{opts[:between][1].to_s}" if (opts[:between] && opts[:between].size == 2)
67       arr_opts << opts[:object] if opts[:object].is_a? String
68       arr_opts << '-- ' + opts[:path_limiter] if opts[:path_limiter].is_a? String
69       
70       command_lines('log', arr_opts, true).map { |l| l.split.first }
71     end
72     
73     def full_log_commits(opts = {})
74       arr_opts = ['--pretty=raw']
75       arr_opts << "-#{opts[:count]}" if opts[:count]
76       arr_opts << "--skip=#{opts[:skip]}" if opts[:skip]
77       arr_opts << "--since=\"#{opts[:since]}\"" if opts[:since].is_a? String
78       arr_opts << "--all" if opts[:all] == true
79       arr_opts << "#{opts[:between][0].to_s}..#{opts[:between][1].to_s}" if (opts[:between] && opts[:between].size == 2)
80       arr_opts << opts[:object] if opts[:object].is_a? String
81       arr_opts << '-- ' + opts[:path_limiter] if opts[:path_limiter].is_a? String
82       
83       full_log = command_lines('log', arr_opts, true)
84       process_commit_data(full_log)
85     end
86     
87     def revparse(string)
88       if /\w{40}/.match(string)  # passing in a sha - just no-op it
89         return string
90       end
91       command('rev-parse', string)
92     end
93     
94     def namerev(string)
95       command('name-rev', string).split[1]
96     end
97     
98     def object_type(sha)
99       command('cat-file', ['-t', sha])
100     end
101     
102     def object_size(sha)
103       command('cat-file', ['-s', sha]).to_i
104     end
105     
106     # returns useful array of raw commit object data
107     def commit_data(sha)
108       sha = sha.to_s
109       cdata = command_lines('cat-file', ['commit', sha])
110       process_commit_data(cdata, sha)
111     end
112     
113     def process_commit_data(data, sha = nil)
114       in_message = false
115       
116       if sha
117         hsh = {'sha' => sha, 'message' => '', 'parent' => []}
118       else
119         hsh_array = []        
120       end
121     
122       data.each do |line|
123         if in_message && line != ''
124           hsh['message'] += line + "\n"
125         end
126
127         if (line != '') && !in_message
128           data = line.split
129           key = data.shift
130           value = data.join(' ')
131           if key == 'commit'
132             sha = value
133             hsh_array << hsh if hsh
134             hsh = {'sha' => sha, 'message' => '', 'parent' => []}
135           end
136           if key == 'parent'
137             hsh[key] << value
138           else
139             hsh[key] = value
140           end
141         elsif in_message && line == ''
142           in_message = false
143         else
144           in_message = true
145         end
146       end
147       
148       if hsh_array
149         hsh_array << hsh if hsh
150         hsh_array
151       else
152         hsh
153       end
154     end
155     
156     def object_contents(sha)
157       command('cat-file', ['-p', sha])
158     end
159
160     def ls_tree(sha)
161       data = {'blob' => {}, 'tree' => {}}
162       command_lines('ls-tree', sha.to_s).each do |line|
163         (info, filenm) = line.split("\t")
164         (mode, type, sha) = info.split
165         data[type][filenm] = {:mode => mode, :sha => sha}
166       end
167       data
168     end
169
170     def branches_all
171       arr = []
172       command_lines('branch', '-a').each do |b| 
173         current = false
174         current = true if b[0, 2] == '* '
175         arr << [b.gsub('* ', '').strip, current]
176       end
177       arr
178     end
179
180     def branch_current
181       branches_all.select { |b| b[1] }.first[0] rescue nil
182     end
183
184
185     # returns hash
186     # [tree-ish] = [[line_no, match], [line_no, match2]]
187     # [tree-ish] = [[line_no, match], [line_no, match2]]
188     def grep(string, opts = {})
189       opts[:object] = 'HEAD' if !opts[:object]
190
191       grep_opts = ['-n']
192       grep_opts << '-i' if opts[:ignore_case]
193       grep_opts << '-v' if opts[:invert_match]
194       grep_opts << "-e '#{string}'"
195       grep_opts << opts[:object] if opts[:object].is_a?(String)
196       grep_opts << ('-- ' + opts[:path_limiter]) if opts[:path_limiter].is_a? String
197       hsh = {}
198       command_lines('grep', grep_opts).each do |line|
199         if m = /(.*)\:(\d+)\:(.*)/.match(line)        
200           hsh[m[1]] ||= []
201           hsh[m[1]] << [m[2].to_i, m[3]] 
202         end
203       end
204       hsh
205     end
206     
207     def diff_full(obj1 = 'HEAD', obj2 = nil, opts = {})
208       diff_opts = ['-p']
209       diff_opts << obj1
210       diff_opts << obj2 if obj2.is_a?(String)
211       diff_opts << ('-- ' + opts[:path_limiter]) if opts[:path_limiter].is_a? String
212       
213       command('diff', diff_opts)
214     end
215     
216     def diff_stats(obj1 = 'HEAD', obj2 = nil, opts = {})
217       diff_opts = ['--numstat']
218       diff_opts << obj1
219       diff_opts << obj2 if obj2.is_a?(String)
220       diff_opts << ('-- ' + opts[:path_limiter]) if opts[:path_limiter].is_a? String
221       
222       hsh = {:total => {:insertions => 0, :deletions => 0, :lines => 0, :files => 0}, :files => {}}
223       
224       command_lines('diff', diff_opts).each do |file|
225         (insertions, deletions, filename) = file.split("\t")
226         hsh[:total][:insertions] += insertions.to_i
227         hsh[:total][:deletions] += deletions.to_i
228         hsh[:total][:lines] = (hsh[:total][:deletions] + hsh[:total][:insertions])
229         hsh[:total][:files] += 1
230         hsh[:files][filename] = {:insertions => insertions.to_i, :deletions => deletions.to_i}
231       end
232             
233       hsh
234     end
235
236     # compares the index and the working directory
237     def diff_files
238       hsh = {}
239       command_lines('diff-files').each do |line|
240         (info, file) = line.split("\t")
241         (mode_src, mode_dest, sha_src, sha_dest, type) = info.split
242         hsh[file] = {:path => file, :mode_file => mode_src.to_s[1, 7], :mode_index => mode_dest, 
243                       :sha_file => sha_src, :sha_index => sha_dest, :type => type}
244       end
245       hsh
246     end
247     
248     # compares the index and the repository
249     def diff_index(treeish)
250       hsh = {}
251       command_lines('diff-index', treeish).each do |line|
252         (info, file) = line.split("\t")
253         (mode_src, mode_dest, sha_src, sha_dest, type) = info.split
254         hsh[file] = {:path => file, :mode_repo => mode_src.to_s[1, 7], :mode_index => mode_dest, 
255                       :sha_repo => sha_src, :sha_index => sha_dest, :type => type}
256       end
257       hsh
258     end
259             
260     def ls_files
261       hsh = {}
262       command_lines('ls-files', '--stage').each do |line|
263         (info, file) = line.split("\t")
264         (mode, sha, stage) = info.split
265         hsh[file] = {:path => file, :mode_index => mode, :sha_index => sha, :stage => stage}
266       end
267       hsh
268     end
269
270
271     def config_remote(name)
272       hsh = {}
273       command_lines('config', ['--get-regexp', "remote.#{name}"]).each do |line|
274         (key, value) = line.split
275         hsh[key.gsub("remote.#{name}.", '')] = value
276       end
277       hsh
278     end
279
280     def config_get(name)
281       command('config', ['--get', name])
282     end
283     
284     def config_list
285       hsh = {}
286       command_lines('config', ['--list']).each do |line|
287         (key, value) = line.split('=')
288         hsh[key] = value
289       end
290       hsh
291     end
292     
293     ## WRITE COMMANDS ##
294         
295     def config_set(name, value)
296       command('config', [name, "'#{value}'"])
297     end
298           
299     def add(path = '.')
300       path = path.join(' ') if path.is_a?(Array)
301       command('add', path)
302     end
303     
304     def remove(path = '.', opts = {})
305       path = path.join(' ') if path.is_a?(Array)
306
307       arr_opts = ['-f']  # overrides the up-to-date check by default
308       arr_opts << ['-r'] if opts[:recursive]
309       arr_opts << path
310
311       command('rm', arr_opts)
312     end
313
314     def commit(message, opts = {})
315       arr_opts = ["-m '#{message}'"]
316       arr_opts << '-a' if opts[:add_all]
317       command('commit', arr_opts)
318     end
319
320     def reset(commit, opts = {})
321       arr_opts = []
322       arr_opts << '--hard' if opts[:hard]
323       arr_opts << commit.to_s if commit
324       command('reset', arr_opts)
325     end
326
327
328     def branch_new(branch)
329       command('branch', branch)
330     end
331     
332     def branch_delete(branch)
333       command('branch', ['-d', branch])
334     end
335     
336     def checkout(branch, opts = {})
337       arr_opts = []
338       arr_opts << '-f' if opts[:force]
339       arr_opts << branch.to_s
340       
341       command('checkout', arr_opts)
342     end
343     
344     def merge(branch, message = nil)      
345       arr_opts = []
346       arr_opts << ["-m '#{message}'"] if message
347       arr_opts << branch.to_a.join(' ')
348       command('merge', arr_opts)
349     end
350     
351     def remote_add(name, url, opts = {})
352       arr_opts = ['add']
353       arr_opts << '-f' if opts[:with_fetch]
354       arr_opts << name
355       arr_opts << url
356       
357       command('remote', arr_opts)
358     end
359     
360     # this is documented as such, but seems broken for some reason
361     # i'll try to get around it some other way later
362     def remote_remove(name)
363       command('remote', ['rm', name])
364     end
365     
366     def remotes
367       command_lines('remote')
368     end
369
370     def tags
371       command_lines('tag')
372     end
373
374     def tag(tag)
375       command('tag', tag)
376     end
377
378     
379     def fetch(remote)
380       command('fetch', remote.to_s)
381     end
382     
383     def push(remote, branch = 'master')
384       command('push', [remote.to_s, branch.to_s])
385     end
386     
387     def tag_sha(tag_name)
388       command('show-ref',  ['--tags', '-s', tag_name])
389     end  
390     
391     def repack
392       command('repack', ['-a', '-d'])
393     end
394     
395     # reads a tree into the current index file
396     def read_tree(treeish, opts = {})
397       arr_opts = []
398       arr_opts << "--prefix=#{opts[:prefix]}" if opts[:prefix]
399       arr_opts << treeish.to_a.join(' ')
400       command('read-tree', arr_opts)
401     end
402     
403     def write_tree
404       command('write-tree')
405     end
406     
407     def commit_tree(tree, opts = {})
408       opts[:message] = "commit tree #{tree}" if !opts[:message]
409       t = Tempfile.new('commit-message') do |t|
410         t.write(opts[:message])
411       end
412       
413       arr_opts = []
414       arr_opts << tree
415       arr_opts << "-p #{opts[:parent]}" if opts[:parent]
416       opts[:parents].each { |p| arr_opts << "-p #{p.to_s}" } if opts[:parents]
417       arr_opts << "< #{t.path}"
418       command('commit-tree', arr_opts)
419     end
420     
421     def update_ref(branch, commit)
422       command('update-ref', [branch.to_s, commit.to_s])
423     end
424     
425     def checkout_index(opts = {})
426       arr_opts = []
427       arr_opts << "--prefix=#{opts[:prefix]}" if opts[:prefix]
428       arr_opts << "--force" if opts[:force]
429       arr_opts << "--all" if opts[:all]
430       arr_opts << ('-- ' + opts[:path_limiter]) if opts[:path_limiter].is_a? String
431       command('checkout-index', arr_opts)
432     end
433     
434     # creates an archive file
435     #
436     # options
437     #  :format  (zip, tar)
438     #  :prefix
439     #  :remote
440     #  :path
441     def archive(sha, file = nil, opts = {})
442       opts[:format] = 'zip' if !opts[:format]
443       
444       if opts[:format] == 'tgz'
445         opts[:format] = 'tar' 
446         opts[:add_gzip] = true
447       end
448       
449       if !file
450         file = Tempfile.new('archive').path
451       end
452       
453       arr_opts = []
454       arr_opts << "--format=#{opts[:format]}" if opts[:format]
455       arr_opts << "--prefix=#{opts[:prefix]}" if opts[:prefix]
456       arr_opts << "--remote=#{opts[:remote]}" if opts[:remote]
457       arr_opts << sha
458       arr_opts << opts[:path] if opts[:path]
459       arr_opts << '| gzip' if opts[:add_gzip]
460       arr_opts << "> #{file.to_s}"
461       command('archive', arr_opts)
462       return file
463     end
464     
465     private
466     
467     def command_lines(cmd, opts = {}, chdir = true)
468       command(cmd, opts, chdir).split("\n")
469     end
470     
471     def command(cmd, opts = {}, chdir = true)
472       ENV['GIT_DIR'] = @git_dir if (@git_dir != ENV['GIT_DIR'])
473       ENV['GIT_INDEX_FILE'] = @git_index_file if (@git_index_file != ENV['GIT_INDEX_FILE'])
474       ENV['GIT_WORK_TREE'] = @git_work_dir if (@git_work_dir != ENV['GIT_WORK_TREE'])
475       path = @git_work_dir || @git_dir || @path
476
477       opts = opts.to_a.join(' ')
478       git_cmd = "git #{cmd} #{opts}"
479
480       out = nil
481       if chdir && (Dir.getwd != path)
482         Dir.chdir(path) { out = `git #{cmd} #{opts} 2>&1`.chomp } 
483       else
484         out = `git #{cmd} #{opts} 2>&1`.chomp
485       end
486       
487       #puts git_cmd
488       #puts out
489       #puts
490       
491       if $?.exitstatus > 0
492         if $?.exitstatus == 1 && out == ''
493           return ''
494         end
495         raise Git::GitExecuteError.new(git_cmd + ':' + out.to_s) 
496       end
497       out
498     end
499     
500   end
501 end