Class: Redmine::Scm::Adapters::MercurialAdapter
- Inherits:
-
AbstractAdapter
show all
- Defined in:
- lib/redmine/scm/adapters/mercurial_adapter.rb
Defined Under Namespace
Classes: HgCommandAborted, Revision
Constant Summary
- HG_BIN =
Mercurial executable name
Redmine::Configuration['scm_mercurial_command'] || "hg"
- HELPERS_DIR =
File.dirname(__FILE__) + "/mercurial"
- HG_HELPER_EXT =
"#{HELPERS_DIR}/redminehelper.py"
- TEMPLATE_NAME =
"hg-template"
- TEMPLATE_EXTENSION =
"tmpl"
Class Method Summary
(collapse)
Instance Method Summary
(collapse)
-
- (Object) annotate(path, identifier = nil)
-
- (Object) branches
-
- (Object) branchmap
Returns map of => 'nodeid', ….
-
- (Object) cat(path, identifier = nil)
-
- (Object) diff(path, identifier_from, identifier_to = nil)
-
- (Object) each_revision(path = nil, identifier_from = nil, identifier_to = nil, options = {})
Iterates the revisions by using a template file that makes Mercurial
produce a xml output.
-
- (Object) entries(path = nil, identifier = nil)
-
- (Object) info
-
- (MercurialAdapter) initialize(url, root_url = nil, login = nil, password = nil, path_encoding = nil)
constructor
A new instance of MercurialAdapter.
-
- (Object) nodes_in_branch(branch, options = {})
Returns list of nodes in the specified branch.
-
- (Object) revisions(path = nil, identifier_from = nil, identifier_to = nil, options = {})
-
- (Object) tagmap
Returns map of => 'nodeid', ….
-
- (Object) tags
#adapter_name, client_version_above?, client_version_string, #default_branch, #entry, #properties, #root_url, shell_quote, #shell_quote, #supports_annotate?, #supports_cat?, #url, #with_leading_slash, #with_trailling_slash, #without_leading_slash, #without_trailling_slash
Constructor Details
- (MercurialAdapter) initialize(url, root_url = nil, login = nil, password = nil, path_encoding = nil)
A new instance of MercurialAdapter
81
82
83
84
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 81
def initialize(url, root_url=nil, login=nil, password=nil, path_encoding=nil)
super
@path_encoding = path_encoding || 'UTF-8'
end
|
Class Method Details
+ (Object) client_available
46
47
48
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 46
def client_available
!client_version.empty?
end
|
+ (Object) client_command
34
35
36
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 34
def client_command
@@bin ||= HG_BIN
end
|
+ (Object) client_version
42
43
44
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 42
def client_version
@@client_version ||= (hgversion || [])
end
|
+ (Object) hgversion
50
51
52
53
54
55
56
57
58
59
60
61
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 50
def hgversion
theversion = hgversion_from_command_line.dup
if theversion.respond_to?(:force_encoding)
theversion.force_encoding('ASCII-8BIT')
end
if m = theversion.match(%r{\A(.*?)((\d+\.)+\d+)})
m[2].scan(%r{\d+}).collect(&:to_i)
end
end
|
+ (Object) hgversion_from_command_line
63
64
65
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 63
def hgversion_from_command_line
shellout("#{sq_bin} --version") { |io| io.read }.to_s
end
|
+ (Object) sq_bin
38
39
40
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 38
def sq_bin
@@sq_bin ||= shell_quote(HG_BIN)
end
|
+ (Object) template_path
67
68
69
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 67
def template_path
@@template_path ||= template_path_for(client_version)
end
|
+ (Object) template_path_for(version)
71
72
73
74
75
76
77
78
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 71
def template_path_for(version)
if ((version <=> [0,9,5]) > 0) || version.empty?
ver = "1.0"
else
ver = "0.9.5"
end
"#{HELPERS_DIR}/#{TEMPLATE_NAME}-#{ver}.#{TEMPLATE_EXTENSION}"
end
|
Instance Method Details
- (Object) annotate(path, identifier = nil)
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 260
def annotate(path, identifier=nil)
p = CGI.escape(scm_iconv(@path_encoding, 'UTF-8', path))
blame = Annotate.new
hg 'rhannotate', '-ncu', '-r', CGI.escape(hgrev(identifier)), hgtarget(p) do |io|
io.each_line do |line|
line.force_encoding('ASCII-8BIT') if line.respond_to?(:force_encoding)
next unless line =~ %r{^([^:]+)\s(\d+)\s([0-9a-f]+):\s(.*)$}
r = Revision.new(:author => $1.strip, :revision => $2, :scmid => $3,
:identifier => $3)
blame.add_line($4.rstrip, r)
end
end
blame
rescue HgCommandAborted
Annotate.new
end
|
- (Object) branches
105
106
107
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 105
def branches
as_ary(summary['repository']['branch']).map { |e| e['name'] }
end
|
- (Object) branchmap
Returns map of => 'nodeid', …
110
111
112
113
114
115
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 110
def branchmap
alist = as_ary(summary['repository']['branch']).map do |e|
e.values_at('name', 'node')
end
Hash[*alist.flatten]
end
|
- (Object) cat(path, identifier = nil)
250
251
252
253
254
255
256
257
258
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 250
def cat(path, identifier=nil)
p = CGI.escape(scm_iconv(@path_encoding, 'UTF-8', path))
hg 'rhcat', '-r', CGI.escape(hgrev(identifier)), hgtarget(p) do |io|
io.binmode
io.read
end
rescue HgCommandAborted
nil end
|
- (Object) diff(path, identifier_from, identifier_to = nil)
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 228
def diff(path, identifier_from, identifier_to=nil)
hg_args = %w|rhdiff|
if identifier_to
hg_args << '-r' << hgrev(identifier_to) << '-r' << hgrev(identifier_from)
else
hg_args << '-c' << hgrev(identifier_from)
end
unless path.blank?
p = scm_iconv(@path_encoding, 'UTF-8', path)
hg_args << CGI.escape(hgtarget(p))
end
diff = []
hg *hg_args do |io|
io.each_line do |line|
diff << line
end
end
diff
rescue HgCommandAborted
nil end
|
- (Object) each_revision(path = nil, identifier_from = nil, identifier_to = nil, options = {})
Iterates the revisions by using a template file that makes Mercurial
produce a xml output.
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 177
def each_revision(path=nil, identifier_from=nil, identifier_to=nil, options={})
hg_args = ['log', '--debug', '-C', '--style', self.class.template_path]
hg_args << '-r' << "#{hgrev(identifier_from)}:#{hgrev(identifier_to)}"
hg_args << '--limit' << options[:limit] if options[:limit]
hg_args << hgtarget(path) unless path.blank?
log = hg(*hg_args) do |io|
output = io.read
if output.respond_to?(:force_encoding)
output.force_encoding('UTF-8')
end
begin
ActiveSupport::XmlMini.parse("#{output}</log>")['log']
rescue
end
end
as_ary(log['logentry']).each do |le|
cpalist = as_ary(le['paths']['path-copied']).map do |e|
[e['__content__'], e['copyfrom-path']].map do |s|
scm_iconv('UTF-8', @path_encoding, CGI.unescape(s))
end
end
cpmap = Hash[*cpalist.flatten]
paths = as_ary(le['paths']['path']).map do |e|
p = scm_iconv('UTF-8', @path_encoding, CGI.unescape(e['__content__']) )
{:action => e['action'], :path => with_leading_slash(p),
:from_path => (cpmap.member?(p) ? with_leading_slash(cpmap[p]) : nil),
:from_revision => (cpmap.member?(p) ? le['revision'] : nil)}
end.sort { |a, b| a[:path] <=> b[:path] }
yield Revision.new(:revision => le['revision'],
:scmid => le['node'],
:author => (le['author']['__content__'] rescue ''),
:time => Time.parse(le['date']['__content__']),
:message => le['msg']['__content__'],
:paths => paths)
end
self
end
|
- (Object) entries(path = nil, identifier = nil)
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
159
160
161
162
163
164
165
166
167
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 132
def entries(path=nil, identifier=nil)
p1 = scm_iconv(@path_encoding, 'UTF-8', path)
manifest = hg('rhmanifest', '-r', CGI.escape(hgrev(identifier)),
CGI.escape(without_leading_slash(p1.to_s))) do |io|
output = io.read
if output.respond_to?(:force_encoding)
output.force_encoding('UTF-8')
end
begin
ActiveSupport::XmlMini.parse(output)['rhmanifest']['repository']['manifest']
rescue
end
end
path_prefix = path.blank? ? '' : with_trailling_slash(path)
entries = Entries.new
as_ary(manifest['dir']).each do |e|
n = scm_iconv('UTF-8', @path_encoding, CGI.unescape(e['name']))
p = "#{path_prefix}#{n}"
entries << Entry.new(:name => n, :path => p, :kind => 'dir')
end
as_ary(manifest['file']).each do |e|
n = scm_iconv('UTF-8', @path_encoding, CGI.unescape(e['name']))
p = "#{path_prefix}#{n}"
lr = Revision.new(:revision => e['revision'], :scmid => e['node'],
:identifier => e['node'],
:time => Time.at(e['time'].to_i))
entries << Entry.new(:name => n, :path => p, :kind => 'file',
:size => e['size'].to_i, :lastrev => lr)
end
entries
rescue HgCommandAborted
nil end
|
- (Object) info
86
87
88
89
90
91
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 86
def info
tip = summary['repository']['tip']
Info.new(:root_url => CGI.unescape(summary['repository']['root']),
:lastrev => Revision.new(:revision => tip['revision'],
:scmid => tip['node']))
end
|
- (Object) nodes_in_branch(branch, options = {})
Returns list of nodes in the specified branch
220
221
222
223
224
225
226
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 220
def nodes_in_branch(branch, options={})
hg_args = ['rhlog', '--template', '{node|short}\n', '--rhbranch', CGI.escape(branch)]
hg_args << '--from' << CGI.escape(branch)
hg_args << '--to' << '0'
hg_args << '--limit' << options[:limit] if options[:limit]
hg(*hg_args) { |io| io.readlines.map { |e| e.chomp } }
end
|
- (Object) revisions(path = nil, identifier_from = nil, identifier_to = nil, options = {})
169
170
171
172
173
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 169
def revisions(path=nil, identifier_from=nil, identifier_to=nil, options={})
revs = Revisions.new
each_revision(path, identifier_from, identifier_to, options) { |e| revs << e }
revs
end
|
- (Object) tagmap
Returns map of => 'nodeid', …
98
99
100
101
102
103
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 98
def tagmap
alist = as_ary(summary['repository']['tag']).map do |e|
e.values_at('name', 'node')
end
Hash[*alist.flatten]
end
|
93
94
95
|
# File 'lib/redmine/scm/adapters/mercurial_adapter.rb', line 93
def tags
as_ary(summary['repository']['tag']).map { |e| e['name'] }
end
|