Merge branch 'release/0.6.1' into stable

miracle2k · miracle2k · commit 67e8ce5f632e · 2011-10-10T20:23:42.000+02:00
diff --git a/CHANGES b/CHANGES
@@ -1,3 +1,8 @@
+0.6.1 (2011-10-10)
+    - Building in 0.6 was very much broken (thanks Oliver Tonnhofer).
+    - A custom "static_folder" for a Flask app or Blueprint/Module is now
+      supported.
+
 0.6 (2011-10-03)
     - Support webassets 0.6.
     - Fixed use of wrong Flask app in some cases.
diff --git a/docs/conf.py b/docs/conf.py
@@ -21,6 +21,11 @@
 sys.path.append(os.path.abspath('_themes'))
 
 
+# make sure we are documenting the local version with autodoc
+sys.path.insert(0, os.path.abspath('../src'))
+from flaskext import assets as flaskassets
+
+
 # -- General configuration -----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
@@ -48,9 +53,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.0'
+version = ".".join(map(str, flaskassets.__version__))
 # The full version, including alpha/beta/rc tags.
-release = '1.0'
+release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/src/flaskext/assets.py b/src/flaskext/assets.py
@@ -5,7 +5,7 @@
 from webassets.env import BaseEnvironment, ConfigStorage
 
 
-__version__ = (0, 6)
+__version__ = (0, 6, 1)
 
 __all__ = ('Environment', 'Bundle',)
 
@@ -76,6 +76,19 @@ def __delitem__(self, key):
         del self.env._app.config[self._transform_key(key)]
 
 
+
+def get_static_folder(app_or_blueprint):
+    """Return the static folder of the given Flask app
+    instance, or module/blueprint.
+
+    In newer Flask versions this can be customized, in older
+    ones (<=0.6) the folder is fixed.
+    """
+    if hasattr(app_or_blueprint, 'static_folder'):
+        return app_or_blueprint.static_folder
+    return path.join(app_or_blueprint.root_path, 'static')
+
+
 class Environment(BaseEnvironment):
 
     config_storage_class = FlaskConfigStorage
@@ -141,6 +154,21 @@ def absurl(self, fragment):
                 if ctx:
                     ctx.pop()
 
+    # XXX: This is required because in a couple of places, webassets 0.6
+    # still access env.directory, at one point even directly. We need to
+    # fix this for 0.6 compatibility, but it might be preferrable to
+    # introduce another API similar to _normalize_source_path() for things
+    # like the cache directory and output files.
+    def set_directory(self, directory):
+        self.config['directory'] = directory
+    def get_directory(self):
+        if self.config.get('directory') is not None:
+            return self.config['directory']
+        return get_static_folder(self._app)
+    directory = property(get_directory, set_directory, doc=
+    """The base directory to which all paths will be relative to.
+    """)
+
     def _normalize_source_path(self, filename):
         if path.isabs(filename):
             return filename
@@ -149,15 +177,15 @@ def _normalize_source_path(self, filename):
         try:
             if hasattr(self._app, 'blueprints'):
                 blueprint, name = filename.split('/', 1)
-                directory = path.join(self._app.blueprints[blueprint].root_path, 'static')
+                directory = get_static_folder(self._app.blueprints[blueprint])
                 filename = name
             else:
                 # Module support for Flask < 0.7
                 module, name = filename.split('/', 1)
-                directory = path.join(self._app.modules[module].root_path, 'static')
+                directory = get_static_folder(self._app.modules[module])
                 filename = name
         except (ValueError, KeyError):
-            directory = path.join(self._app.root_path, 'static')
+            directory = get_static_folder(self._app)
         return path.abspath(path.join(directory, filename))
 
     def init_app(self, app):
diff --git a/tests/helpers.py b/tests/helpers.py
@@ -1,32 +1,37 @@
-from flask.app import Flask, Blueprint, Module
+from nose import SkipTest
+from nose.tools import assert_raises
+from flask.app import Flask
+try:
+    from flask import __version__ as FLASK_VERSION
+except ImportError:
+    FLASK_VERSION = '0.6'
 from webassets.test import TempEnvironmentHelper as BaseTempEnvironmentHelper
 from flaskext.assets import Environment
 
+try:
+    from flask import Blueprint
+    Module = None
+except ImportError:
+    # Blueprints only available starting with 0.7,
+    # fall back to old Modules otherwise.
+    Blueprint = None
+    from flask import Module
 
-__all__ = ('TempEnvironmentHelper',)
 
+__all__ = ('TempEnvironmentHelper', 'Module', 'Blueprint')
 
-class TempEnvironmentHelper(BaseTempEnvironmentHelper):
-
-    def setdp(self):
-        # webassets now requires the files we pass in to exist,
-        # so we can' just do tests with arbitrary filenames.
-        self.app = Flask(__name__, static_path='/app_static')
-        import test_module
-        if not Blueprint:
-            self.module = Module(test_module.__name__, name='module',
-                                 static_path='/mod_static')
-            self.app.register_module(self.module)
-        else:
-            self.blueprint = Blueprint('module', test_module.__name__,
-                                       static_url_path='/mod_static',
-                                       static_folder='static')
-            self.app.register_blueprint(self.blueprint)
-        self.env = Environment(self.app)
 
+class TempEnvironmentHelper(BaseTempEnvironmentHelper):
 
     def _create_environment(self):
+        if FLASK_VERSION < '0.7':
+            # Older Flask versions do not support the
+            # static_folder argument, which we need to use
+            # a temporary folder for static files, without
+            # having to do sys.path hacking.
+            raise SkipTest()
+
         if not hasattr(self, 'app'):
-            self.app = Flask(__name__)
+            self.app = Flask(__name__, static_folder=self.tempdir)
         self.env = Environment(self.app)
         return self.env
diff --git a/tests/test_integration.py b/tests/test_integration.py
@@ -2,16 +2,10 @@
 from nose.tools import assert_raises
 
 from flask import Flask
-try:
-    from flask import Blueprint
-except ImportError:
-    # Blueprints only available starting with 0.7,
-    # fall back to old Modules otherwise.
-    Blueprint = None
-    from flask import Module
 from flaskext.assets import Environment, Bundle
 from webassets.bundle import get_all_bundle_files
-    
+from helpers import TempEnvironmentHelper, Module, Blueprint
+
 
 class TestUrlAndDirectory(object):
     """By default, the 'url' and 'directory' settings of webassets are
@@ -61,6 +55,10 @@ def test_directory_auto(self):
         # module name, you can always use this hack:
         assert get_all_bundle_files(Bundle('./module/bar'), self.env) == [root + '/static/module/bar']
 
+        # Custom static folder
+        self.app.static_folder = '/'
+        assert get_all_bundle_files(Bundle('foo'), self.env) == ['/foo']
+
     def test_directory_custom(self):
         """A custom root directory is configured."""
         self.env.directory = '/tmp'
@@ -127,3 +125,25 @@ def test(self):
             root = self.app.root_path
             assert get_all_bundle_files(Bundle('foo'), self.env) == [root + '/static/foo']
 
+
+class TestBuild(TempEnvironmentHelper):
+    """[Regression]
+
+    Make sure actually building a bundle works also.
+    """
+
+    default_files = {
+        'foo': 'function bla  () { /* comment */ var a; }    ',
+    }
+
+    def test_build(self):
+        self.mkbundle('foo', filters='rjsmin', output='out').build()
+        assert self.get('out') == 'function bla(){var a;}'
+
+    def test_with_cache_default_directory(self):
+        """[Regression] The cache directory is created in the Flask
+        main static folder.
+        """
+        self.env.cache = True
+        self.mkbundle('foo', filters='rjsmin', output='out').build()
+        assert self.get('out') == 'function bla(){var a;}'
