Merge lp:~xnox/bzr-keywords/more-keywords into lp:bzr-keywords

[Dimitri John Ledkov]

This branch adds support for
Revno - RevNo of the Revision-Id
CurRevno - Current Revno of the tree (eg. bzr cat $file --keywords=cooked --revision=$i will print $i and it doesn't matter when that file was actually last modified)
CurRevid - Same as above but id

I've tried hard to get testsuite coverage for this. But with current setup revno's are not generated / committed && I've tried writing one blackbox style, but then keywords plugin wasn't getting imported at all such that self.run_bzr("cat $file --keywords=coocked") would complain that keywords is not a valid argument =(

One more cool thing. I've added a hook such that on branch_tip_change files which are marked to be filtered get refreshed =) so you no longer need to remove-tree && co . to get new values like for example CurRev* and similar stuff.

Hope we can work on fixing test-suite.

[Removed by request (removed3076179)]

In terms of the additional keywords, I vote +1.
I'd be willing to test it if I knew how to start testing. Keywords is something that I used quite a lot in svn.

[Dimitri John Ledkov (xnox)]

@carneeki

If you want to use this now. You can simply do $ bzr branch lp:~dmitrij.ledkov/bzr-keywords/more-keywords ~/.bazaar/plugins/keywords.

Or if you have keywords plugin you can just change into that and pull this branch and start using this to find corner cases or things that you want or don't work.

The testsuite coverage I'm referring to are the automated unit-test suite such that it can keep track of all the bugs for me =)

[Jelmer Vernooij (jelmer)]

I think Revno and CurRevno are confusing terms - Revno is as much "current" as CurRevno. Perhaps BranchRevno and TreeRevno would be better names?

[John A Meinel (jameinel)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 3/2/2011 1:36 PM, Jelmer Vernooij wrote:
> You have been requested to review the proposed merge of lp:~dmitrij.ledkov/bzr-keywords/more-keywords into lp:bzr-keywords.
>
> For more details, see:
> https://code.launchpad.net/~dmitrij.ledkov/bzr-keywords/more-keywords/+merge/23626
>
> This branch adds support for
> Revno - RevNo of the Revision-Id
> CurRevno - Current Revno of the tree (eg. bzr cat $file --keywords=cooked --revision=$i will print $i and it doesn't matter when that file was actually last modified)
> CurRevid - Same as above but id
>
> I've tried hard to get testsuite coverage for this. But with current setup revno's are not generated / committed && I've tried writing one blackbox style, but then keywords plugin wasn't getting imported at all such that self.run_bzr("cat $file --keywords=coocked") would complain that keywords is not a valid argument =(
>
> One more cool thing. I've added a hook such that on branch_tip_change files which are marked to be filtered get refreshed =) so you no longer need to remove-tree && co . to get new values like for example CurRev* and similar stuff.
>
> Hope we can work on fixing test-suite.
>

Is this still a serious proposal? If you're still looking for feedback,
I'll be happy to actually review it and comment. But I'm going to skip
it for now, assuming that it is just dormant.

John
=:->

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk101P4ACgkQJdeBCYSNAAOe6ACfTuhPSj+7GRyKZm2AcYX8IZwe
6QIAoJGQ72rzrKlzqGY15JXHam2O/Olr
=YNDd
-----END PGP SIGNATURE-----

[Jelmer Vernooij (jelmer)]

review: Abstain (code)

[rminsk (robertminsk)]

I would love to see this merged into the main branch but with different keywords. The current keyword names are confusing

Revno -> Revision-Number (follows from the naming of Revision-Id)
CurRevid -> Tree-Revision-Id (more descriptive of its purpose)
CurRevid -> Tree-Revision-Number (follows from the naming of Tree-Revision-Id)

[Jelmer Vernooij (jelmer)]

> I would love to see this merged into the main branch but with different
> keywords. The current keyword names are confusing
>
> Revno -> Revision-Number (follows from the naming of Revision-Id)
> CurRevid -> Tree-Revision-Id (more descriptive of its purpose)
> CurRevid -> Tree-Revision-Number (follows from the naming of Tree-Revision-Id)
Revision-Id currently returns the tree revision id at the moment, so I think "Revno" should return the tree revision number too. We could then add Branch-Revid and Branch-Revno variables for the branch data.

If you're interested in helping land this, I'd be happy to review updated merge proposals.

Unmerged revisions

23. By Dimitri John Ledkov on 2010-04-18

Spent a lot of time on testsuite can't fix it =(

22. By Dimitri John Ledkov on 2010-04-18

Need to be flexible with getting additional parameters

21. By Dimitri John Ledkov on 2010-04-18

export fixed again

20. By Dimitri John Ledkov on 2010-04-18

Added hook

19. By Dimitri John Ledkov on 2010-04-17

Fixed export

18. By Dimitri John Ledkov on 2010-04-17

Lazy imports

17. By Dimitri John Ledkov on 2010-04-17

Added CurRevno, CurId & Revno

=== modified file '__init__.py'
--- __init__.py	2009-04-06 22:40:14 +0000
+++ __init__.py	2010-04-18 08:51:20 +0000
@@ -61,6 +61,7 @@
  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
+ Revno          the revision number that last changed the file
  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
@@ -68,6 +69,8 @@
  File-Id        the unique id assigned to this file
  Now            the current date and time
  User           the current user (name and email)
+ CurRevno       the current revision number on the branch
+ CurRevid       the current unique id on the branch
  =============  =========================================================
 
 If you want finer control over the formatting of names and email
@@ -107,11 +110,16 @@
 
 
 import re, time
+
+from bzrlib.lazy_import import lazy_import
+lazy_import(globals(), """
 from bzrlib import (
     builtins,
+    branch,
     commands,
     config,
     debug,
+    errors,
     filters,
     option,
     osutils,
@@ -119,6 +127,7 @@
     trace,
     xml8,
     )
+""")
 
 
 def test_suite():
@@ -165,6 +174,8 @@
     lambda c: c.revision().committer)
 keyword_registry.register('Authors',
     lambda c: ", ".join(c.revision().get_apparent_authors()))
+keyword_registry.register('Revno',
+    lambda c: _revision_id_to_revno(c.revision_id()))
 keyword_registry.register('Revision-Id',
     lambda c: c.revision_id())
 keyword_registry.register('Path',
@@ -181,6 +192,10 @@
     lambda c: format_date(time.time(), time.timezone, c.config(), 'Now'))
 keyword_registry.register('User',
     lambda c: c.config().username())
+keyword_registry.register('CurRevno',
+    lambda c: _get_current()[0])
+keyword_registry.register('CurRevid',
+    lambda c: _get_current()[1])
 
 # Keywords for finer control over name & address formatting
 keyword_registry.register('Committer-Name',
@@ -264,7 +279,7 @@
 
 def compress_keywords(s):
     """Replace cooked style keywords with raw style in a string.
-    
+
     :param s: the string
     :return: the string with keywords compressed
     """
@@ -284,7 +299,7 @@
 
 def expand_keywords(s, keyword_dicts, context=None, encoder=None, style=None):
     """Replace raw style keywords with another style in a string.
-    
+
     Note: If the keyword is already in the expanded style, the value is
     not replaced.
 
@@ -385,6 +400,58 @@
 
 filters.register_filter_stack_map('keywords', _keywords_filter_stack_lookup)
 
+_keyword_current = registry.Registry()
+
+def _get_branch(location=u'.', b=None):
+    if 'branch' in _keyword_current.keys():
+        return _keyword_current.get('branch')
+    else:
+        if b is None: b = branch.Branch.open_containing(location)[0]
+        _keyword_current.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 _get_current(location=None, revid=None, b=None):
+    b = _get_branch(location, b)
+    if 'current' in _keyword_current.keys():
+        return _keyword_current.get('current')
+    else:
+        if revid is None: revid = b.last_revision()
+        revno = _revision_id_to_revno(revid)
+        _keyword_current.register('current', (revno, revid))
+        return (revno, revid)
+
+def _refilter_tree(p):
+    t = p.branch.basis_tree()
+    _get_current(b=p.branch, revid=p.new_revid)
+    t.lock_read()
+    for path, entry in t.inventory.iter_entries():
+        stack = t._content_filter_stack(path)
+        for i in stack:
+            if i.reader == _kw_compressor:
+                context = filters.ContentFilterContext(path, t, entry)
+                chunks = t.get_file_lines(t.path2id(path))
+                contents = filters.filtered_output_bytes(chunks, stack, context)
+                content = ''.join(contents)
+                file_object = open(path, 'wb')
+                file_object.writelines(content)
+                file_object.close()
+    t.unlock()
+
+branch.Branch.hooks.install_named_hook("post_change_branch_tip",
+                                       _refilter_tree,
+                                       "Applying keywords")
 
 class cmd_cat(builtins.cmd_cat):
     """
@@ -408,22 +475,27 @@
     # Add a new option to the builtin command and
     # override the inherited run() and help() methods
 
+    takes_args = builtins.cmd_cat.takes_args
     takes_options = builtins.cmd_cat.takes_options + [
              option.RegistryOption('keywords',
                  registry=_keyword_style_registry,
                  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:
             # Implicitly set the filters option
             kwargs['filters'] = True
             style = kwargs['keywords']
             _keyword_style_registry.default_key = style
+            revid = None
+            if 'revision' in kwargs:
+                revid = kwargs['revision'][0].as_revision_id(b)
+            _get_current(filename,revid)
             del kwargs['keywords']
-        return super(cmd_cat, self).run(*args, **kwargs)
-  
+        return super(cmd_cat, self).run(filename, **kwargs)
+
     def help(self):
       """Return help message including text from superclass."""
       from inspect import getdoc
@@ -434,13 +506,14 @@
     # Add a new option to the builtin command and
     # override the inherited run() and help() methods
 
+    takes_args = builtins.cmd_export.takes_args
     takes_options = builtins.cmd_export.takes_options + [
              option.RegistryOption('keywords',
                  registry=_keyword_style_registry,
                  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:
             # Implicitly set the filters option
@@ -448,15 +521,18 @@
             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:
+                revid = kwargs['revision'][0].as_revision_id(b)
+            _get_current(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."""
       from inspect import getdoc
       # NOTE: Reuse of cmd_cat help below is deliberate, not a bug
       return getdoc(super(cmd_export, self)) + '\n\n' + getdoc(cmd_cat)
 
-
 # Register the command wrappers
 commands.register_command(cmd_cat, decorate=False)
 commands.register_command(cmd_export, decorate=False)

=== modified file 'tests/test_keywords_in_trees.py'
--- tests/test_keywords_in_trees.py	2009-08-11 05:14:31 +0000
+++ tests/test_keywords_in_trees.py	2010-04-18 08:51:20 +0000
@@ -34,10 +34,13 @@
 Committer-Name: $Committer-Name$
 Authors:        $Authors$
 Author1-Email:  $Author1-Email$
+Revno:          $Revno$
 Revision-Id:    $Revision-Id$
 Filename:       $Filename$
 Directory:      $Directory$
 File-Id:        $File-Id$
+CurRevno:       $CurRevno$
+CurRevid:       $CurRevid
 """
 #User:         $User$
 #User-Email:   $User-Email$
@@ -46,10 +49,13 @@
 Committer-Name: $Committer-Name: Jane Smith $
 Authors:        $Authors: Sue Smith <[e-mail]> $
 Author1-Email:  $Author1-Email: [e-mail] $
+Revno:          $Revno: 1 $
 Revision-Id:    $Revision-Id: rev1-id $
 Filename:       $Filename: file1 $
 Directory:      $Directory:  $
 File-Id:        $File-Id: file1-id $
+CurRevno:       $CurRevno: 1 $
+CurRevid:       $CurRevid: rev1-id $
 """
 #User:         $User: Dave Smith <[e-mail]>$
 #User-Email:   $User-Email: [e-mail] $