Add require.nodejs module

Author: ronnix

docs/api/nodejs.rst

@@ -5,3 +5,5 @@
 
 .. automodule:: fabtools.nodejs
     :members:
+
+    .. seealso:: :ref:`require_nodejs_module`

docs/api/require/index.rst

@@ -8,6 +8,7 @@ fabtools.require
    files
    mysql
    nginx
+   nodejs
    openvz
    postfix
    postgres

docs/api/require/nodejs.rst

@@ -0,0 +1,9 @@
+.. _require_nodejs_module:
+
+:mod:`fabtools.require.nodejs`
+------------------------------
+
+.. automodule:: fabtools.require.nodejs
+    :members:
+
+    .. seealso:: :ref:`nodejs_module`

fabtools/nodejs.py

@@ -5,12 +5,20 @@
 This module provides tools for installing `Node.js`_ and managing
 packages using `npm`_.
 
+.. note: the ``simplejson`` module is required on Python 2.5
+
 .. _Node.js: http://nodejs.org/
 .. _npm: http://npmjs.org/
 
 """
-from fabric.api import run, sudo, cd
-from fabtools import require
+from __future__ import with_statement
+
+try:
+    import json
+except ImportError:
+    import simplejson as json
+
+from fabric.api import run, sudo, cd, settings, hide
 
 
 DEFAULT_VERSION = '0.8.11'
@@ -30,6 +38,7 @@ def install_from_source(version=DEFAULT_VERSION):
     .. note:: This function may not work for old versions of Node.js.
 
     """
+    from fabtools import require
     require.deb.packages([
         'build-essential',
         'python',
@@ -48,6 +57,20 @@ def install_from_source(version=DEFAULT_VERSION):
     run('rm -rf %(filename)s %(foldername)s' % locals())
 
 
+def version():
+    """
+    Get the version of Node.js currently installed.
+
+    Returns ``None`` if it is not installed.
+    """
+    with settings(hide('running', 'stdout'), warn_only=True):
+        res = run('/usr/local/bin/node --version')
+    if res.failed:
+        return None
+    else:
+        return res[1:]
+
+
 def install_package(package, version=None, local=False):
     """
     Install a Node.js package.
@@ -94,6 +117,31 @@ def install_dependencies():
     run('npm install')
 
 
+def package_version(package, local=False):
+    """
+    Get the installed version of a Node.js package.
+
+    Returns ``None``is the package is not installed. If *local* is
+    ``True``, returns the version of the locally installed package.
+    """
+    options = ['--json true', '--silent']
+    if local:
+        options.append('-l')
+    else:
+        options.append('-g')
+    options = ' '.join(options)
+
+    with hide('running', 'stdout'):
+        res = run('npm list %s' % options)
+
+    dependencies = json.loads(res)['dependencies']
+    pkg_data = dependencies.get(package)
+    if pkg_data:
+        return pkg_data['version']
+    else:
+        return None
+
+
 def update_package(package, local=False):
     """
     Update a Node.js package.

fabtools/require/__init__.py

@@ -4,6 +4,7 @@
 import fabtools.require.postfix
 import fabtools.require.postgres
 import fabtools.require.mysql
+import fabtools.require.nodejs
 import fabtools.require.openvz
 import fabtools.require.python
 import fabtools.require.redis

fabtools/require/nodejs.py

@@ -0,0 +1,62 @@
+"""
+Node.js
+=======
+
+This module provides tools for installing `Node.js`_ and managing
+packages using `npm`_.
+
+.. note: the ``simplejson`` module is required on Python 2.5
+
+.. _Node.js: http://nodejs.org/
+.. _npm: http://npmjs.org/
+
+"""
+
+from fabtools import nodejs
+
+
+def installed_from_source(version=nodejs.DEFAULT_VERSION):
+    """
+    Require Node.js to be installed from source.
+
+    ::
+
+        from fabtools import require
+
+        require.nodejs.installed_from_source()
+
+    """
+    if nodejs.version() != version:
+        nodejs.install_from_source(version)
+
+
+def package(pkg_name, version=None, local=False):
+    """
+    Require a Node.js package.
+
+    If the package is not installed, and no *version* is specified, the
+    latest available version will be installed.
+
+    If a *version* is specified, and a different version of the package
+    is already installed, it will be updated to the specified version.
+
+    If `local` is ``True``, the package will be installed locally.
+
+    ::
+
+        from fabtools import require
+
+        # Install package system-wide
+        require.nodejs.package('foo')
+
+        # Install package locally
+        require.nodejs.package('bar', local=True)
+
+    """
+    pkg_version = nodejs.package_version(pkg_name, local=local)
+    if version:
+        if pkg_version != version:
+            nodejs.install_package(pkg_name, version, local=local)
+    else:
+        if pkg_version is None:
+            nodejs.install_package(pkg_name, local=local)

tox.ini

@@ -11,6 +11,7 @@ commands = {envbindir}/unit2 discover []
 deps =
     unittest2
     mock
+    simplejson
 
 [testenv:py26]
 commands = {envbindir}/unit2 discover []