Merge lp:~robertminsk/bzr-keywords/more-keywords-updated into lp:bzr-keywords

[rminsk]

An updated version of more-keywords since the other branch has not been updated in over a year. This version has been updated to work with revision 18 of the trunk. It adds the following keywords:

Revision-Number - revision number that last changed the file.
Branch-Revision-Id - current unique id of the revision on the branch
Branch-Revision-Number - current revision number on the branch

Revid - an alias for Revision-Id
Revno - an alias for Revision-Number
Branch-Revid - an alias for Branch-Revision-Id
Branch-Revno - an alias for Branch-Revision-Number

All the real credit for this goes to user dmitrij.ledkov

[Jelmer Vernooij (jelmer)]

This looks reasonable, except for the post_change_branch_tip hook:
 * It adds a significant overhead to all operations that change the branch (push, pull, commit, ...)
 * It assumes the tree uses inventories
 * It writes directly to the working tree without locking files

I'm also not sure that it's actually necessary to have this hook.

[lp:~robertminsk/bzr-keywords/more-keywords-updated]

22. By Robert Minsk <email address hidden> on 2011-08-22

Removed the post_change_branch_tip hook on advice from Jelmer

[rminsk (robertminsk)]

> This looks reasonable, except for the post_change_branch_tip hook:
> * It adds a significant overhead to all operations that change the branch
> (push, pull, commit, ...)
> * It assumes the tree uses inventories
> * It writes directly to the working tree without locking files
>
> I'm also not sure that it's actually necessary to have this hook.

Removed post_change_branch_tip

[Jelmer Vernooij (jelmer)]

> > This looks reasonable, except for the post_change_branch_tip hook:
> > * It adds a significant overhead to all operations that change the branch
> > (push, pull, commit, ...)
> > * It assumes the tree uses inventories
> > * It writes directly to the working tree without locking files
> >
> > I'm also not sure that it's actually necessary to have this hook.
>
> Removed post_change_branch_tip
Thanks.

It would be nice to have tests for this, though at this point I can live with just finally merging the MP and adding tests later.

Please don't use "except:". It eats exceptions, can make it hard to kill bzr, and hides bugs.

The code seems to assume that the branch that it works on lives in ".". This is often not the case - the current branch might be on some remote location, or a completely different local path. The current working directory should not matter. It really should just obtain the branch from the tree object.

[rminsk (robertminsk)]

Being new to the API I'm not quite sure how to get from, I guess, the working tree to the branch I am interested in. Can you tell be what method in the API I should be looking at?

[Jelmer Vernooij (jelmer)]

Whoops, sorry, I missed your reply on this.

The tree should generally (if it's a working tree) have a "branch" attribute you can use. If that doesn't exist then your best bet is probably to use the same values for the branch revision id and branch revision number as the tree.

[Jelmer Vernooij (jelmer)]

Marking this as needs fixing so it doesn't show up in the review queue.

review: Needs Fixing

Unmerged revisions

22. By Robert Minsk <email address hidden> on 2011-08-22

Removed the post_change_branch_tip hook on advice from Jelmer

21. By Robert Minsk <email address hidden> on 2011-08-20

Added aliases Revid, Revno, Branch-Revid, Branch-Revno

20. By Robert Minsk <email address hidden> on 2011-08-19

Added support for --revision command line option.

19. By Robert Minsk <email address hidden> on 2011-08-19

Porting of more-keywords to the latest branch

=== modified file '__init__.py'
--- __init__.py	2011-03-02 12:31:59 +0000
+++ __init__.py	2011-08-22 01:14:32 +0000
@@ -54,20 +54,27 @@
 
 The currently supported keywords are given below.
 
- =============  =========================================================
- Keyword        Description
- =============  =========================================================
- Date           the date and time the file was last modified
- Committer      the committer (name and email) of the last change
- Authors        the authors (names and emails) of the last change
- Revision-Id    the unique id of the revision that last changed the file
- Path           the relative path of the file in the tree
- Filename       just the name part of the relative path
- Directory      just the directory part of the relative path
- File-Id        the unique id assigned to this file
- Now            the current date and time
- User           the current user (name and email)
- =============  =========================================================
+ ======================  =====================================================
+ Keyword                 Description
+ ======================  =====================================================
+ Date                    date and time the file was last modified
+ Committer               committer (name and email) of the last change
+ Authors                 authors (names and emails) of the last change
+ Revision-Id             unique id of the revision that last changed the file
+ Revid                   alias for Revision-Id
+ Revision-Number         revision number that last changed the file
+ Revno                   alias for Revision-Number
+ Path                    relative path of the file in the tree
+ Filename                just the name part of the relative path
+ Directory               just the directory part of the relative path
+ File-Id                 unique id assigned to this file
+ Now                     current date and time
+ User                    current user (name and email)
+ Branch-Revision-Id      current unique id of the revision on the branch
+ Branch-Revid            alias for Branch-Revision-Id
+ Branch-Revision-Number  current revision number on the branch
+ Branch-Revno            alias for Branch-Revision-Number
+ ======================  =====================================================
 
 If you want finer control over the formatting of names and email
 addresses, you can use the following keywords.
@@ -179,18 +186,25 @@
              converter=lambda s: s,
              help='Keyword expansion style.')]
 
-    def run(self, *args, **kwargs):
+    def run(self, filename, **kwargs):
         """Process special options and delegate to superclass."""
         if 'keywords' in kwargs:
             from bzrlib.plugins.keywords.keywords import (
                 _keyword_style_registry,
+                _current_branch_id,
+                _get_branch
                 )
             # Implicitly set the filters option
             kwargs['filters'] = True
             style = kwargs['keywords']
             _keyword_style_registry.default_key = style
             del kwargs['keywords']
-        return super(cmd_cat, self).run(*args, **kwargs)
+            revid = None
+            if 'revision' in kwargs:
+                b = _get_branch(filename)
+                revid = kwargs['revision'][0].as_revision_id(b)
+            _current_branch_id(filename, revid)
+        return super(cmd_cat, self).run(filename, **kwargs)
 
     def help(self):
       """Return help message including text from superclass."""
@@ -209,18 +223,25 @@
                  converter=lambda s: s,
                  help='Keyword expansion style.')]
 
-    def run(self, *args, **kwargs):
+    def run(self, dest, branch_or_subdir=None, **kwargs):
         """Process special options and delegate to superclass."""
         if 'keywords' in kwargs:
             from bzrlib.plugins.keywords.keywords import (
                 _keyword_style_registry,
+                _current_branch_id,
+                _get_branch
                 )
             # Implicitly set the filters option
             kwargs['filters'] = True
             style = kwargs['keywords']
             _keyword_style_registry.default_key = style
             del kwargs['keywords']
-        return super(cmd_export, self).run(*args, **kwargs)
+            revid = None
+            if 'revision' in kwargs:
+                b = _get_branch(branch_or_subdir)
+                revid = kwargs['revision'][0].as_revision_id(b)
+            _current_branch_id(branch_or_subdir, revid)
+        return super(cmd_export, self).run(dest, branch_or_subdir, **kwargs)
 
     def help(self):
       """Return help message including text from superclass."""

=== modified file 'keywords.py'
--- keywords.py	2011-03-02 12:31:59 +0000
+++ keywords.py	2011-08-22 01:14:32 +0000
@@ -16,7 +16,10 @@
 
 import re, time
 from bzrlib import (
+    branch,
     debug,
+    errors,
+    filters,
     osutils,
     registry,
     trace,
@@ -51,6 +54,12 @@
     lambda c: ", ".join(c.revision().get_apparent_authors()))
 keyword_registry.register('Revision-Id',
     lambda c: c.revision_id())
+keyword_registry.register('Revid',
+    lambda c: c.revision_id())
+keyword_registry.register('Revision-Number',
+    lambda c: _revision_id_to_revno(c.revision_id()))
+keyword_registry.register('Revno',
+    lambda c: _revision_id_to_revno(c.revision_id()))
 keyword_registry.register('Path',
     lambda c: c.relpath())
 keyword_registry.register('Directory',
@@ -59,6 +68,14 @@
     lambda c: osutils.split(c.relpath())[1])
 keyword_registry.register('File-Id',
     lambda c: c.file_id())
+keyword_registry.register('Branch-Revision-Id',
+    lambda c: _current_branch_id())
+keyword_registry.register('Branch-Revid',
+    lambda c: _current_branch_id())
+keyword_registry.register('Branch-Revision-Number',
+    lambda c: _revision_id_to_revno(_current_branch_id()))
+keyword_registry.register('Branch-Revno',
+    lambda c: _revision_id_to_revno(_current_branch_id()))
 
 # Environment-related keywords
 keyword_registry.register('Now',
@@ -262,3 +279,36 @@
 def _xml_escape_kw_expander(chunks, context=None):
     """Filter that replaces keywords with a form suitable for use in XML."""
     return _kw_expander(chunks, context, encoder=_xml_escape)
+
+_keyword_branch = registry.Registry()
+
+def _get_branch(location=u'.', b=None):
+    if 'branch' in _keyword_branch.keys():
+        return _keyword_branch.get('branch')
+    else:
+        if b is None:
+            b = branch.Branch.open_containing(location)[0]
+        _keyword_branch.register('branch', b)
+        return b
+
+def _revision_id_to_revno(revid):
+    b = _get_branch()
+    try:
+        revno = b.revision_id_to_revno(revid)
+        return str(revno)
+    except:
+        # We need to load and use the full revno map after all
+        result = b.get_revision_id_to_revno_map().get(revid)
+        if result is None:
+            return result
+        return ".".join(result)
+
+def _current_branch_id(location=None, revid=None, b=None):
+    if 'current' in _keyword_branch.keys():
+        return _keyword_branch.get('current')
+    else:
+      if revid is None:
+          b = _get_branch(location, b)
+          revid = b.last_revision()
+      _keyword_branch.register('current', revid)
+      return revid