make cd after workon optional

Provide an environment variable and command line option to control
whether the project plugin changes the working directory during the
post-activate phase.

Addresses #246

Change-Id: If710959339e17a6960ae12f9023088460f546daa

Author: dhellmann

docs/source/command_ref.rst

@@ -238,11 +238,19 @@ List or change working virtual environments
 
 Syntax::
 
-    workon [environment_name]
+    workon [(-c|--cd)|(-n|--no-cd)] [environment_name]
 
 If no ``environment_name`` is given the list of available environments
 is printed to stdout.
 
+If ``-c`` or ``--cd`` is specified the working directory is changed to
+the project directory during the post-activate phase, regardless of
+the value of ``VIRTUALENVWRAPPER_WORKON_CD``.
+
+If ``-n`` or ``--no-cd`` is specified the working directory is **not**
+changed to the project directory during the post-activate phase,
+regardless of the value of ``VIRTUALENVWRAPPER_WORKON_CD``.
+
 ::
 
     $ workon 
@@ -276,6 +284,7 @@ is printed to stdout.
    * :ref:`scripts-postdeactivate`
    * :ref:`scripts-preactivate`
    * :ref:`scripts-postactivate`
+   * :ref:`variable-VIRTUALENVWRAPPER_WORKON_CD`
 
 .. _command-deactivate:
 

docs/source/install.rst

@@ -207,6 +207,20 @@ project working directory. The default is ``.project``.
 
    * :ref:`project-management`
 
+.. _variable-VIRTUALENVWRAPPER_WORKON_CD:
+
+Enable Project Directory Switching
+----------------------------------
+
+The variable ``VIRTUALENVWRAPPER_WORKON_CD`` controls whether the
+working directory is changed during the post activate phase. The
+default is ``1``, to enable changing directories. Set the value to
+``0`` to disable this behavior for all invocations of ``workon``.
+
+.. seealso::
+
+  * :ref:`command-workon`
+
 .. _variable-VIRTUALENVWRAPPER_HOOK_DIR:
 
 Location of Hook Scripts

docs/source/projects.rst

@@ -36,3 +36,4 @@ site, combine the :ref:`templates-bitbucket` and
    * :ref:`extensions-templates`
    * :ref:`variable-PROJECT_HOME`
    * :ref:`variable-VIRTUALENVWRAPPER_PROJECT_FILENAME`
+   * :ref:`variable-VIRTUALENVWRAPPER_WORKON_CD`

tests/test_project_activate.sh

@@ -18,6 +18,13 @@ oneTimeSetUp() {
 
 setUp () {
     echo
+    # In case the user has the value set, we need to force it to the default
+    VIRTUALENVWRAPPER_WORKON_CD=1
+}
+
+tearDown () {
+    # In case a test has changed the value, we need to force it to the default
+    VIRTUALENVWRAPPER_WORKON_CD=1
 }
 
 test_activate () {
@@ -31,6 +38,43 @@ test_activate () {
     deactivate
 }
 
+test_activate_n () {
+    mkproject myproject_n >/dev/null 2>&1
+    assertTrue $?
+    deactivate
+    cd $TMPDIR
+    assertSame "" "$VIRTUAL_ENV"
+    workon -n myproject_n
+    assertSame "myproject_n" "$(basename $VIRTUAL_ENV)"
+    assertSame "$TMPDIR" "$(pwd)"
+    deactivate
+}
+
+test_activate_no_cd () {
+    mkproject myproject_no_cd >/dev/null 2>&1
+    assertTrue $?
+    deactivate
+    cd $TMPDIR
+    assertSame "" "$VIRTUAL_ENV"
+    workon --no-cd myproject_no_cd
+    assertSame "myproject_no_cd" "$(basename $VIRTUAL_ENV)"
+    assertSame "$TMPDIR" "$(pwd)"
+    deactivate
+}
+
+test_activate_workon_cd_disabled () {
+    export VIRTUALENVWRAPPER_WORKON_CD=0
+    mkproject myproject_cd_disabled >/dev/null 2>&1
+    assertTrue $?
+    deactivate
+    cd $TMPDIR
+    assertSame "" "$VIRTUAL_ENV"
+    workon myproject_cd_disabled
+    assertSame "myproject_cd_disabled" "$(basename $VIRTUAL_ENV)"
+    assertSame "$TMPDIR" "$(pwd)"
+    deactivate
+}
+
 test_space_in_path () {
     old_project_home="$PROJECT_HOME"
     PROJECT_HOME="$PROJECT_HOME/with spaces"

virtualenvwrapper.sh

@@ -78,6 +78,13 @@ then
     export VIRTUALENVWRAPPER_PROJECT_FILENAME=".project"
 fi
 
+# Let the user tell us they never want to cd to projects
+# automatically.
+if [ "$VIRTUALENVWRAPPER_WORKON_CD" = "" ]
+then
+    export VIRTUALENVWRAPPER_WORKON_CD=1
+fi
+
 # Remember where we are running from.
 if [ -z "$VIRTUALENVWRAPPER_SCRIPT" ]
 then
@@ -658,10 +665,23 @@ function virtualenvwrapper_workon_help {
     echo ""
     echo "           Show this help message."
     echo ""
+    echo "       workon (-c|--cd) envname"
+    echo ""
+    echo "           After activating the environment, cd to the associated"
+    echo "           project directory if it is set."
+    echo ""
+    echo "       workon (-n|--no-cd) envname"
+    echo ""
+    echo "           After activating the environment, do not cd to the"
+    echo "           associated project directory."
+    echo ""
 }
 
 #:help:workon: list or change working virtualenvs
 function workon {
+    typeset -a in_args
+    typeset -a out_args
+
     in_args=( "$@" )
 
     if [ -n "$ZSH_VERSION" ]
@@ -672,17 +692,31 @@ function workon {
         i=0
         tst="-lt"
     fi
+    typeset cd_after_activate=$VIRTUALENVWRAPPER_WORKON_CD
     while [ $i $tst $# ]
     do
         a="${in_args[$i]}"
         case "$a" in
             -h|--help)
                 virtualenvwrapper_workon_help;
                 return 0;;
+            -n|--no-cd)
+                cd_after_activate=0;;
+            -c|--cd)
+                cd_after_activate=1;;
+            *)
+                if [ ${#out_args} -gt 0 ]
+                then
+                    out_args=( "${out_args[@]-}" "$a" )
+                else
+                    out_args=( "$a" )
+                fi;;
         esac
         i=$(( $i + 1 ))
     done
 
+    set -- "${out_args[@]}"
+
     typeset env_name="$1"
     if [ "$env_name" = "" ]
     then
@@ -745,7 +779,7 @@ function workon {
 
     }'
 
-    virtualenvwrapper_run_hook "post_activate"
+    VIRTUALENVWRAPPER_PROJECT_CD=$cd_after_activate virtualenvwrapper_run_hook "post_activate"
 
     return 0
 }

virtualenvwrapper/project.py

@@ -52,9 +52,9 @@ def post_mkproject_source(args):
 def post_activate_source(args):
     return """
 #
-# Change to the project directory
+# Change to the project directory, as long as we haven't been told not to.
 #
-[ -f "$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME" ] && \
+[ -f "$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME" -a "$VIRTUALENVWRAPPER_PROJECT_CD" = 1 ] && \
     virtualenvwrapper_cd \
         "$(cat \"$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME\")"
 """