show: rename "underway" to "work"

Durham and I both like this better than "underway." We can add aliases
and bikeshed on the name during the 4.3 cycle, as this whole extension is
highly experimental.

hgext/show.py

@@ -1,222 +1,222 b''
 # show.py - Extension implementing `hg show`
 #
 # Copyright 2017 Gregory Szorc <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 """unified command to show various repository information (EXPERIMENTAL)
 
 This extension provides the :hg:`show` command, which provides a central
 command for displaying commonly-accessed repository data and views of that
 data.
 """
 
 from __future__ import absolute_import
 
 from mercurial.i18n import _
 from mercurial.node import nullrev
 from mercurial import (
     cmdutil,
     error,
     formatter,
     graphmod,
     pycompat,
     registrar,
     revset,
     revsetlang,
 )
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
 # be specifying the version(s) of Mercurial they are tested with, or
 # leave the attribute unspecified.
 testedwith = 'ships-with-hg-core'
 
 cmdtable = {}
 command = cmdutil.command(cmdtable)
 revsetpredicate = registrar.revsetpredicate()
 
 class showcmdfunc(registrar._funcregistrarbase):
     """Register a function to be invoked for an `hg show <thing>`."""
 
     # Used by _formatdoc().
     _docformat = '%s -- %s'
 
     def _extrasetup(self, name, func, fmtopic=None):
         """Called with decorator arguments to register a show view.
 
         ``name`` is the sub-command name.
 
         ``func`` is the function being decorated.
 
         ``fmtopic`` is the topic in the style that will be rendered for
         this view.
         """
         func._fmtopic = fmtopic
 
 showview = showcmdfunc()
 
 @command('show', [
     # TODO: Switch this template flag to use commands.formatteropts if
     # 'hg show' becomes stable before --template/-T is stable. For now,
     # we are putting it here without the '(EXPERIMENTAL)' flag because it
     # is an important part of the 'hg show' user experience and the entire
     # 'hg show' experience is experimental.
     ('T', 'template', '', ('display with template'), _('TEMPLATE')),
     ], _('VIEW'))
 def show(ui, repo, view=None, template=None):
     """show various repository information
 
     A requested view of repository data is displayed.
 
     If no view is requested, the list of available views is shown and the
     command aborts.
 
     .. note::
 
        There are no backwards compatibility guarantees for the output of this
        command. Output may change in any future Mercurial release.
 
        Consumers wanting stable command output should specify a template via
        ``-T/--template``.
 
     List of available views:
     """
     if ui.plain() and not template:
         hint = _('invoke with -T/--template to control output format')
         raise error.Abort(_('must specify a template in plain mode'), hint=hint)
 
     views = showview._table
 
     if not view:
         ui.pager('show')
         # TODO consider using formatter here so available views can be
         # rendered to custom format.
         ui.write(_('available views:\n'))
         ui.write('\n')
 
         for name, func in sorted(views.items()):
             ui.write(('%s\n') % func.__doc__)
 
         ui.write('\n')
         raise error.Abort(_('no view requested'),
                           hint=_('use "hg show VIEW" to choose a view'))
 
     # TODO use same logic as dispatch to perform prefix matching.
     if view not in views:
         raise error.Abort(_('unknown view: %s') % view,
                           hint=_('run "hg show" to see available views'))
 
     template = template or 'show'
     fmtopic = 'show%s' % views[view]._fmtopic
 
     ui.pager('show')
     with ui.formatter(fmtopic, {'template': template}) as fm:
         return views[view](ui, repo, fm)
 
 @showview('bookmarks', fmtopic='bookmarks')
 def showbookmarks(ui, repo, fm):
     """bookmarks and their associated changeset"""
     marks = repo._bookmarks
     if not len(marks):
         # This is a bit hacky. Ideally, templates would have a way to
         # specify an empty output, but we shouldn't corrupt JSON while
         # waiting for this functionality.
         if not isinstance(fm, formatter.jsonformatter):
             ui.write(_('(no bookmarks set)\n'))
         return
 
     active = repo._activebookmark
     longestname = max(len(b) for b in marks)
     # TODO consider exposing longest shortest(node).
 
     for bm, node in sorted(marks.items()):
         fm.startitem()
         fm.context(ctx=repo[node])
         fm.write('bookmark', '%s', bm)
         fm.write('node', fm.hexfunc(node), fm.hexfunc(node))
         fm.data(active=bm == active,
                 longestbookmarklen=longestname)
 
 @revsetpredicate('_underway([commitage[, headage]])')
 def underwayrevset(repo, subset, x):
     args = revset.getargsdict(x, 'underway', 'commitage headage')
     if 'commitage' not in args:
         args['commitage'] = None
     if 'headage' not in args:
         args['headage'] = None
 
     # We assume callers of this revset add a topographical sort on the
     # result. This means there is no benefit to making the revset lazy
     # since the topographical sort needs to consume all revs.
     #
     # With this in mind, we build up the set manually instead of constructing
     # a complex revset. This enables faster execution.
 
     # Mutable changesets (non-public) are the most important changesets
     # to return. ``not public()`` will also pull in obsolete changesets if
     # there is a non-obsolete changeset with obsolete ancestors. This is
     # why we exclude obsolete changesets from this query.
     rs = 'not public() and not obsolete()'
     rsargs = []
     if args['commitage']:
         rs += ' and date(%s)'
         rsargs.append(revsetlang.getstring(args['commitage'],
                                            _('commitage requires a string')))
 
     mutable = repo.revs(rs, *rsargs)
     relevant = revset.baseset(mutable)
 
     # Add parents of mutable changesets to provide context.
     relevant += repo.revs('parents(%ld)', mutable)
 
     # We also pull in (public) heads if they a) aren't closing a branch
     # b) are recent.
     rs = 'head() and not closed()'
     rsargs = []
     if args['headage']:
         rs += ' and date(%s)'
         rsargs.append(revsetlang.getstring(args['headage'],
                                            _('headage requires a string')))
 
     relevant += repo.revs(rs, *rsargs)
 
     # Add working directory parent.
     wdirrev = repo['.'].rev()
     if wdirrev != nullrev:
         relevant += revset.baseset(set([wdirrev]))
 
     return subset & relevant
 
-@showview('underway', fmtopic='underway')
-def showunderway(ui, repo, fm):
+@showview('work', fmtopic='work')
+def showwork(ui, repo, fm):
     """changesets that aren't finished"""
     # TODO support date-based limiting when calling revset.
     revs = repo.revs('sort(_underway(), topo)')
 
     revdag = graphmod.dagwalker(repo, revs)
     displayer = cmdutil.changeset_templater(ui, repo, None, None,
                                             tmpl=fm._t.load(fm._topic),
                                             mapfile=None, buffered=True)
 
     ui.setconfig('experimental', 'graphshorten', True)
     cmdutil.displaygraph(ui, repo, revdag, displayer, graphmod.asciiedges)
 
 # Adjust the docstring of the show command so it shows all registered views.
 # This is a bit hacky because it runs at the end of module load. When moved
 # into core or when another extension wants to provide a view, we'll need
 # to do this more robustly.
 # TODO make this more robust.
 def _updatedocstring():
     longest = max(map(len, showview._table.keys()))
     entries = []
     for key in sorted(showview._table.keys()):
         entries.append(pycompat.sysstr('    %s   %s' % (
             key.ljust(longest), showview._table[key]._origdoc)))
 
     cmdtable['show'][0].__doc__ = pycompat.sysstr('%s\n\n%s\n    ') % (
         cmdtable['show'][0].__doc__.rstrip(),
         pycompat.sysstr('\n\n').join(entries))
 
 _updatedocstring()

mercurial/templates/map-cmdline.show

@@ -1,3 +1,3 b''
 # TODO add label() once we figure out which namespace the labels belong on.
 showbookmarks = '{if(active, "*", " ")} {pad(bookmark, longestbookmarklen + 4)}{shortest(node, 5)}\n'
-showunderway = '{shortest(node, 5)}{if(branches, " ({branch})")}{if(bookmarks, " ({bookmarks})")} {desc|firstline}'
+showwork = '{shortest(node, 5)}{if(branches, " ({branch})")}{if(bookmarks, " ({bookmarks})")} {desc|firstline}'

tests/test-show-work.t

@@ -1,168 +1,168 b''
   $ cat >> $HGRCPATH << EOF
   > [extensions]
   > show =
   > EOF
 
   $ hg init repo0
   $ cd repo0
 
 Command works on an empty repo
 
-  $ hg show underway
+  $ hg show work
 
 Single draft changeset shown
 
   $ echo 0 > foo
   $ hg -q commit -A -m 'commit 0'
 
-  $ hg show underway
+  $ hg show work
   @  9f171 commit 0
 
 Even when it isn't the wdir
 
   $ hg -q up null
 
-  $ hg show underway
+  $ hg show work
   o  9f171 commit 0
 
 Single changeset is still there when public because it is a head
 
   $ hg phase --public -r 0
-  $ hg show underway
+  $ hg show work
   o  9f171 commit 0
 
 A draft child will show both it and public parent
 
   $ hg -q up 0
   $ echo 1 > foo
   $ hg commit -m 'commit 1'
 
-  $ hg show underway
+  $ hg show work
   @  181cc commit 1
   o  9f171 commit 0
 
 Multiple draft children will be shown
 
   $ echo 2 > foo
   $ hg commit -m 'commit 2'
 
-  $ hg show underway
+  $ hg show work
   @  128c8 commit 2
   o  181cc commit 1
   o  9f171 commit 0
 
 Bumping first draft changeset to public will hide its parent
 
   $ hg phase --public -r 1
-  $ hg show underway
+  $ hg show work
   @  128c8 commit 2
   o  181cc commit 1
   |
   ~
 
 Multiple DAG heads will be shown
 
   $ hg -q up -r 1
   $ echo 3 > foo
   $ hg commit -m 'commit 3'
   created new head
 
-  $ hg show underway
+  $ hg show work
   @  f0abc commit 3
   | o  128c8 commit 2
   |/
   o  181cc commit 1
   |
   ~
 
 Even when wdir is something else
 
   $ hg -q up null
 
-  $ hg show underway
+  $ hg show work
   o  f0abc commit 3
   | o  128c8 commit 2
   |/
   o  181cc commit 1
   |
   ~
 
 Draft child shows public head (multiple heads)
 
   $ hg -q up 0
   $ echo 4 > foo
   $ hg commit -m 'commit 4'
   created new head
 
-  $ hg show underway
+  $ hg show work
   @  668ca commit 4
   | o  f0abc commit 3
   | | o  128c8 commit 2
   | |/
   | o  181cc commit 1
   |/
   o  9f171 commit 0
 
   $ cd ..
 
 Branch name appears in output
 
   $ hg init branches
   $ cd branches
   $ echo 0 > foo
   $ hg -q commit -A -m 'commit 0'
   $ echo 1 > foo
   $ hg commit -m 'commit 1'
   $ echo 2 > foo
   $ hg commit -m 'commit 2'
   $ hg phase --public -r .
   $ hg -q up -r 1
   $ hg branch mybranch
   marked working directory as branch mybranch
   (branches are permanent and global, did you want a bookmark?)
   $ echo 3 > foo
   $ hg commit -m 'commit 3'
   $ echo 4 > foo
   $ hg commit -m 'commit 4'
 
-  $ hg show underway
+  $ hg show work
   @  f8dd3 (mybranch) commit 4
   o  90cfc (mybranch) commit 3
   | o  128c8 commit 2
   |/
   o  181cc commit 1
   |
   ~
 
   $ cd ..
 
 Bookmark name appears in output
 
   $ hg init bookmarks
   $ cd bookmarks
   $ echo 0 > foo
   $ hg -q commit -A -m 'commit 0'
   $ echo 1 > foo
   $ hg commit -m 'commit 1'
   $ echo 2 > foo
   $ hg commit -m 'commit 2'
   $ hg phase --public -r .
   $ hg bookmark @
   $ hg -q up -r 1
   $ echo 3 > foo
   $ hg commit -m 'commit 3'
   created new head
   $ echo 4 > foo
   $ hg commit -m 'commit 4'
   $ hg bookmark mybook
 
-  $ hg show underway
+  $ hg show work
   @  cac82 (mybook) commit 4
   o  f0abc commit 3
   | o  128c8 (@) commit 2
   |/
   o  181cc commit 1
   |
   ~
 
   $ cd ..

tests/test-show.t

@@ -1,130 +1,130 b''
   $ cat >> $HGRCPATH << EOF
   > [extensions]
   > show =
   > EOF
 
 No arguments shows available views
 
   $ hg init empty
   $ cd empty
   $ hg show
   available views:
   
   bookmarks -- bookmarks and their associated changeset
-  underway -- changesets that aren't finished
+  work -- changesets that aren't finished
   
   abort: no view requested
   (use "hg show VIEW" to choose a view)
   [255]
 
 `hg help show` prints available views
 
   $ hg help show
   hg show VIEW
   
   show various repository information
   
       A requested view of repository data is displayed.
   
       If no view is requested, the list of available views is shown and the
       command aborts.
   
       Note:
          There are no backwards compatibility guarantees for the output of this
          command. Output may change in any future Mercurial release.
   
          Consumers wanting stable command output should specify a template via
          "-T/--template".
   
       List of available views:
   
       bookmarks   bookmarks and their associated changeset
   
-      underway    changesets that aren't finished
+      work        changesets that aren't finished
   
   (use 'hg help -e show' to show help for the show extension)
   
   options:
   
    -T --template TEMPLATE display with template
   
   (some details hidden, use --verbose to show complete help)
 
 Unknown view prints error
 
   $ hg show badview
   abort: unknown view: badview
   (run "hg show" to see available views)
   [255]
 
 HGPLAIN results in abort
 
   $ HGPLAIN=1 hg show bookmarks
   abort: must specify a template in plain mode
   (invoke with -T/--template to control output format)
   [255]
 
 But not if a template is specified
 
   $ HGPLAIN=1 hg show bookmarks -T '{bookmark}\n'
   (no bookmarks set)
 
   $ cd ..
 
 bookmarks view with no bookmarks prints empty message
 
   $ hg init books
   $ cd books
   $ touch f0
   $ hg -q commit -A -m initial
 
   $ hg show bookmarks
   (no bookmarks set)
 
 bookmarks view shows bookmarks in an aligned table
 
   $ echo book1 > f0
   $ hg commit -m 'commit for book1'
   $ echo book2 > f0
   $ hg commit -m 'commit for book2'
 
   $ hg bookmark -r 1 book1
   $ hg bookmark a-longer-bookmark
 
   $ hg show bookmarks
   * a-longer-bookmark    7b570
     book1                b757f
 
 A custom bookmarks template works
 
   $ hg show bookmarks -T '{node} {bookmark} {active}\n'
   7b5709ab64cbc34da9b4367b64afff47f2c4ee83 a-longer-bookmark True
   b757f780b8ffd71267c6ccb32e0882d9d32a8cc0 book1 False
 
 bookmarks JSON works
 
   $ hg show bookmarks -T json
   [
    {
     "active": true,
     "bookmark": "a-longer-bookmark",
     "longestbookmarklen": 17,
     "node": "7b5709ab64cbc34da9b4367b64afff47f2c4ee83"
    },
    {
     "active": false,
     "bookmark": "book1",
     "longestbookmarklen": 17,
     "node": "b757f780b8ffd71267c6ccb32e0882d9d32a8cc0"
    }
   ]
 
 JSON works with no bookmarks
 
   $ hg book -d a-longer-bookmark
   $ hg book -d book1
   $ hg show bookmarks -T json
   [
   ]
 
   $ cd ..