add VIRTUALENVWRAPPER_PROJECT_FILENAME; resolves issue 120

Author: dhellmann

docs/en/history.rst

@@ -13,6 +13,10 @@ dev
   - Shortcut initialization if it has run before.
   - Set hook log file permissions to be group-writable. (:bbissue:`62`
     reported by :bbuser:`hedgeddown`)
+  - Add ``VIRTUALENVWRAPPER_PROJECT_FILENAME`` variable so the
+    ``.project`` file used to link a virtualenv to a project can be
+    renamed to avoid conflicts with other tools. (:bbissue:`120`
+    reported by :bbuser:`arthuralvim`)
 
 2.10.1
 

docs/en/install.rst

@@ -154,6 +154,19 @@ The variable ``PROJECT_HOME`` tells virtualenvwrapper where to place
 your project working directories.  The variable must be set and the
 directory created before :ref:`command-mkproject` is used.
 
+.. seealso::
+
+   * :ref:`project-management`
+
+.. _variable-VIRTUALENVWRAPPER_PROJECT_FILENAME:
+
+Project Linkage Filename
+------------------------
+
+The variable ``VIRTUALENVWRAPPER_PROJECT_FILENAME`` tells
+virtualenvwrapper how to name the file linking a virtualenv to a
+project working directory. The default is ``.project``.
+
 .. seealso::
 
    * :ref:`project-management`

docs/en/projects.rst

@@ -34,3 +34,5 @@ site, combine the :ref:`templates-bitbucket` and
 .. seealso::
 
    * :ref:`extensions-templates`
+   * :ref:`variable-PROJECT_HOME`
+   * :ref:`variable-VIRTUALENVWRAPPER_PROJECT_FILENAME`

tests/test_project_mk.sh

@@ -81,4 +81,12 @@ test_same_workon_and_project_home () {
     PROJECT_HOME="$old_project_home"
 }
 
+test_alternate_linkage_filename () {
+    export VIRTUALENVWRAPPER_PROJECT_FILENAME=".not-project"
+    mkproject myproject6 >/dev/null 2>&1
+    assertSame "myproject6" $(basename "$VIRTUAL_ENV")
+    assertSame "$PROJECT_HOME/myproject6" "$(cat $VIRTUAL_ENV/.not-project)"
+    export VIRTUALENVWRAPPER_PROJECT_FILENAME=".project"
+}
+
 . "$test_dir/shunit2"

virtualenvwrapper.sh

@@ -65,6 +65,13 @@ then
 	VIRTUALENVWRAPPER_ENV_BIN_DIR="Scripts"
 fi
 
+# Let the user override the name of the file that holds the project
+# directory name.
+if [ "$VIRTUALENVWRAPPER_PROJECT_FILENAME" = "" ]
+then
+    export VIRTUALENVWRAPPER_PROJECT_FILENAME=".project"
+fi
+
 function virtualenvwrapper_derive_workon_home {
     typeset workon_home_dir="$WORKON_HOME"
 
@@ -806,7 +813,7 @@ function setvirtualenvproject {
         prj="$(pwd)"
     fi
     echo "Setting project for $(basename $venv) to $prj"
-    echo "$prj" > "$venv/.project"
+    echo "$prj" > "$venv/$VIRTUALENVWRAPPER_PROJECT_FILENAME"
 }
 
 # Show help for mkproject
@@ -911,9 +918,9 @@ function mkproject {
 function cdproject {
     virtualenvwrapper_verify_workon_home || return 1
     virtualenvwrapper_verify_active_environment || return 1
-    if [ -f "$VIRTUAL_ENV/.project" ]
+    if [ -f "$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME" ]
     then
-        project_dir=$(cat "$VIRTUAL_ENV/.project")
+        project_dir=$(cat "$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME")
         if [ ! -z "$project_dir" ]
         then
             cd "$project_dir"
@@ -922,7 +929,7 @@ function cdproject {
             return 1
         fi
     else
-        echo "No project set in $VIRTUAL_ENV/.project" 1>&2
+        echo "No project set in $VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME" 1>&2
         return 1
     fi
     return 0

virtualenvwrapper/project.py

@@ -56,5 +56,5 @@ def post_activate_source(args):
 #
 # Change to the project directory
 #
-[ -f "$VIRTUAL_ENV/.project" ] && cd "$(cat \"$VIRTUAL_ENV/.project\")"
+[ -f "$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME" ] && cd "$(cat \"$VIRTUAL_ENV/$VIRTUALENVWRAPPER_PROJECT_FILENAME\")"
 """