Merge lp:~danfairs/djangorecipe/extra-settings into lp:~jvloothuis/djangorecipe/trunk

[Dan Fairs]

[Dan Fairs (danfairs)]

Hi,

This branch adds support for an extra-settings option, which allows extra settings to be inserted into the generated settings.py option. I needed this to be able to specify GeoDjango-related libraries (as shown in the updated README), but I thought it might be more generally useful.

Thanks,
Dan

Unmerged revisions

64. By Dan Fairs <email address hidden> on 2009-04-17

Updated documentation for the extra-settings option.

63. By Dan Fairs <email address hidden> on 2009-04-17

Rename extra_settings to extra-settings.

This naming is consistent with the current options naming
convention.

62. By Dan Fairs <email address hidden> on 2009-04-17

Added support for extra_settings.

This allows you to place an extra_settings section in your buildout, which
will be placed at the end of the generated settings.py file

=== modified file 'README.txt'
--- README.txt	2009-03-19 21:29:26 +0000
+++ README.txt	2009-04-17 08:56:24 +0000
@@ -56,6 +56,9 @@
   production setup from your development setup. It defaults to
   `development`.
 
+extra-settings
+  Extra settings that will be added to the generated settings.py file.
+
 download-cache
   Set this to a folder somewhere on you system to speed up
   installation. The recipe will use this folder as a cache for a
@@ -78,7 +81,7 @@
   An extra script is generated in the bin folder when this is set to
   `true`. This can be used with mod_wsgi to deploy the project. The
   name of the script is `control-script.wsgi`.
-
+  
 wsgilog
   In case the WSGI server you're using does not allow printing to stdout,
   you can set this variable to a filesystem path - all stdout/stderr data
@@ -136,6 +139,9 @@
   test = 
     someapp
     anotherapp
+  extra-settings =
+    GDAL_LIBRARY_PATH = '/opt/lib/libgdal.dylib'
+    GEOS_LIBRARY_PATH = '/opt/lib/libgeos_c.dylib'
 
 Example using .pth files
 ========================

=== modified file 'src/djangorecipe/recipe.py'
--- src/djangorecipe/recipe.py	2009-04-13 15:21:37 +0000
+++ src/djangorecipe/recipe.py	2009-04-17 08:48:38 +0000
@@ -73,7 +73,7 @@
     os.path.join(os.path.dirname(__file__), "templates"),
 )
 
-
+%(extra-settings)s
 '''
 
 production_settings = '''
@@ -205,6 +205,9 @@
         options.setdefault('fcgi', 'false')
         options.setdefault('wsgilog', '')
 
+        # Support for extra settings
+        options.setdefault('extra-settings', '')
+
         # only try to download stuff if we aren't asked to install from cache
         self.install_from_cache = self.buildout['buildout'].get(
             'install-from-cache', '').strip() == 'true'
@@ -361,6 +364,12 @@
         template_vars = {'secret': self.generate_secret()}
         template_vars.update(self.options)
 
+        # Make sure extra settings are formatted so that there's no whitespace
+        # at the start or end of each line
+        extra_settings = '\n'.join(
+            [line.strip() for line in self.options['extra-settings'].split('\n')])
+        template_vars['extra-settings'] = extra_settings
+
         self.create_file(
             os.path.join(project_dir, 'development.py'),
             development_settings, template_vars)

=== modified file 'src/djangorecipe/tests.py'
--- src/djangorecipe/tests.py	2009-04-13 15:21:37 +0000
+++ src/djangorecipe/tests.py	2009-04-17 08:48:38 +0000
@@ -1,6 +1,7 @@
 import unittest
 import tempfile
 import os
+import re
 import sys
 import shutil
 
@@ -352,6 +353,25 @@
         manage = os.path.join(self.bin_dir, 'django')
         self.assert_("djangorecipe.manage.main('project.spameggs')"
                      in open(manage).read())
+                     
+    def test_extra_settings(self):
+        # The extra-settings option can be used to specify extra settings
+        # at the bottom of the standard settings file.
+        self.recipe.options['extra-settings'] = """
+            PARROT = 'dead'
+            NAILS = 4
+        """
+        project_dir = os.path.join(self.buildout_dir, 'project')
+        self.recipe.create_project(project_dir)
+        settings = os.path.join(project_dir, 'settings.py')
+        result = open(settings).read()
+        # Note that the string should be at the start of the line, regardless
+        # of whitespace in the file        
+        flags = re.MULTILINE
+        match = re.search("^PARROT = 'dead'$", result, flags)
+        self.failIf(match is None)
+        match = re.search("^NAILS = 4$", result, flags)
+        self.failIf(match is None)
 
     @mock.patch('urllib', 'urlretrieve')
     def test_get_release(self, mock):