This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3731

templatefilters: rename commonprefix to commondir
ClosedPublic

Authored by martinvonz on Jun 13 2018, 6:06 PM.

Details

Reviewers
joerg.sonnenberger
Group Reviewers
hg-reviewers
Commits
rHGfabfbbf4dee2: templatefilters: rename commonprefix to commondir
Summary

Two reasons:

  • It makes it clearer that it's not a generic common string prefix (e.g. commonprefix(["bar", "baz"]) is not "ba", but "")
  • If we ever want a filter for generic common string prefix, then the name is now available for that.

"commondir" does not describe the prefix-ness, however. I'm happy to
rename it "commondirprefix" or "commonprefixdir" if others prefer.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

martinvonz created this revision.Jun 13 2018, 6:06 PM
Closed by commit rHGfabfbbf4dee2: templatefilters: rename commonprefix to commondir (authored by martinvonz). · Explain WhyJun 14 2018, 7:19 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 9056

mercurial/templatefilters.py

@templatefilter('basename', intype=bytes) @templatefilter('basename', intype=bytes)
def basename(path): def basename(path):
"""Any text. Treats the text as a path, and returns the last """Any text. Treats the text as a path, and returns the last
component of the path after splitting by the path separator. component of the path after splitting by the path separator.
For example, "foo/bar/baz" becomes "baz" and "foo/bar//" becomes "". For example, "foo/bar/baz" becomes "baz" and "foo/bar//" becomes "".
""" """
return os.path.basename(path) return os.path.basename(path)
@templatefilter('commonprefix') @templatefilter('commondir')
def commonprefix(filelist): def commondir(filelist):
"""List of text. Treats each list item as file name with / """List of text. Treats each list item as file name with /
as path separator and returns the longest common directory as path separator and returns the longest common directory
prefix shared by all list items. prefix shared by all list items.
Returns the empty string if no common prefix exists. Returns the empty string if no common prefix exists.
The list items are not normalized, i.e. "foo/../bar" is handled as The list items are not normalized, i.e. "foo/../bar" is handled as
file "bar" in the directory "foo/..". Leading slashes are ignored. file "bar" in the directory "foo/..". Leading slashes are ignored.

tests/test-template-filters.t

$ hg debugtemplate '{""|splitlines|commonprefix}\n' $ hg debugtemplate '{""|splitlines|commondir}\n'
$ hg debugtemplate '{"foo/bar\nfoo/baz\nfoo/foobar\n"|splitlines|commonprefix}\n' $ hg debugtemplate '{"foo/bar\nfoo/baz\nfoo/foobar\n"|splitlines|commondir}\n'
foo foo
$ hg debugtemplate '{"foo/bar\nfoo/bar\n"|splitlines|commonprefix}\n' $ hg debugtemplate '{"foo/bar\nfoo/bar\n"|splitlines|commondir}\n'
foo foo
$ hg debugtemplate '{"/foo/bar\n/foo/bar\n"|splitlines|commonprefix}\n' $ hg debugtemplate '{"/foo/bar\n/foo/bar\n"|splitlines|commondir}\n'
foo foo
$ hg debugtemplate '{"/foo\n/foo\n"|splitlines|commonprefix}\n' $ hg debugtemplate '{"/foo\n/foo\n"|splitlines|commondir}\n'
$ hg debugtemplate '{"foo/bar\nbar/baz"|splitlines|commonprefix}\n' $ hg debugtemplate '{"foo/bar\nbar/baz"|splitlines|commondir}\n'
$ hg debugtemplate '{"foo/bar\nbar/baz\nbar/foo\n"|splitlines|commonprefix}\n' $ hg debugtemplate '{"foo/bar\nbar/baz\nbar/foo\n"|splitlines|commondir}\n'
$ hg debugtemplate '{"foo/../bar\nfoo/bar"|splitlines|commonprefix}\n' $ hg debugtemplate '{"foo/../bar\nfoo/bar"|splitlines|commondir}\n'
foo foo
$ hg debugtemplate '{"foo\n/foo"|splitlines|commonprefix}\n' $ hg debugtemplate '{"foo\n/foo"|splitlines|commondir}\n'
$ hg init $ hg init
$ hg log -r null -T '{rev|commonprefix}' $ hg log -r null -T '{rev|commondir}'
hg: parse error: argument is not a list of text hg: parse error: argument is not a list of text
(template filter 'commonprefix' is not compatible with keyword 'rev') (template filter 'commondir' is not compatible with keyword 'rev')
[255] [255]