Updated tests, docs and examples.. and some minor fixes

owais · owais · commit 48f9e6e8f420 · 2015-09-10T06:30:39.000+05:30
diff --git a/.gitignore b/.gitignore
@@ -60,6 +60,7 @@ target/
 .ropeproject/
 
 examples/**/ve/
+examples/**/venv/
 examples/**/node_modules/
 examples/**/assets/bundles/
 examples/**/assets/webpack-stats.json
@@ -71,3 +72,4 @@ tests/venv3/
 tests/node_modules/
 tests/assets/bundles/
 tests/webpack-stats.json
+tests/webpack-stats-app2.json
diff --git a/README.md b/README.md
@@ -148,22 +148,6 @@ and your webpack config is located at `/home/src/webpack.config.js`, then the va
 
 One of the core principles of django-webpack-loader is to not manage webpack itself in order to give you the flexibility to run webpack the way you want. If you are new to webpack, check one of the [examples](https://github.com/owais/django-webpack-loader/tree/master/examples), read [my detailed blog post](http://owaislone.org/blog/webpack-plus-reactjs-and-django/) or check [webpack docs](http://webpack.github.io/).
 
-#### Multiple webpack projects
-
-It is possible to manage multiple webpack projects by adding extra entries in `WEBPACK_LOADER` as follows:
-
-```python
-WEBPACK_LOADER = {
-    'DEFAULT': {
-        'BUNDLE_DIR_NAME': 'bundles/',
-        'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats.json'),
-    },
-    'APP2': {
-        'BUNDLE_DIR_NAME': 'bundles/',
-        'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats-app2.json'),
-    }
-}
-```
 
 #### Settings
 
@@ -202,29 +186,42 @@ INSTALLED_APPS = (
 </head>
 ```
 
-`render_bundle` third argument (defaults to `'DEFAULT'`) tells which `WEBPACK_LOADER` project contains the bundle. For example, to render bundles from several projects just define your `WEPACK_LOADER` like this,
+<br>
+
+
+#### Multiple webpack projects
+
+Version 2.0 and up of webpack loader also supports multiple webpack configurations. The following configuration defines 2 webpack stats files in settings and uses the `config` argument in the template tags to influence which stats file to load the bundles from.
 
 ```python
 WEBPACK_LOADER = {
-    'APP1': {
-        'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats-app1.json'),
+    'DEFAULT': {
+        'BUNDLE_DIR_NAME': 'bundles/',
+        'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats.json'),
     },
-    'APP2': {
-        'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats-app2.json'),
+    'DASHBOARD': {
+        'BUNDLE_DIR_NAME': 'dashboard_bundles/',
+        'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats-dashboard.json'),
     }
 }
 ```
 
-then use `render_bundle` as follows
-
 ```HTML+Django
 {% load render_bundle from webpack_loader %}
 
 <html>
   <body>
     ....
-    {% render_bundle 'main' 'js' 'APP1'%}
-    {% render_bundle 'main' 'js' 'APP2'%}
+    {% render_bundle 'main' 'js' 'DEFAULT' %}
+    {% render_bundle 'main' 'js' 'DASHBOARD' %}
+
+    <!-- or render all files from a bundle -->
+    {% render_bundle 'main' config='DASHBOARD' %}
+
+    <!-- the following tags do the same thing -->
+    {% render_bundle 'main' 'css' 'DASHBOARD' %}
+    {% render_bundle 'main' extension='css' config='DASHBOARD' %}
+    {% render_bundle 'main' config='DASHBOARD' extension='css' %}
   </body>
 </head>
 ```
diff --git a/examples/code-splitting/app/settings.py b/examples/code-splitting/app/settings.py
@@ -108,6 +108,8 @@
 )
 
 WEBPACK_LOADER = {
-    'BUNDLE_DIR_NAME': 'bundles/',
-    'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats.json'),
+    'DEFAULT': {
+        'BUNDLE_DIR_NAME': 'bundles/',
+        'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats.json')
+    }
 }
diff --git a/examples/code-splitting/webpack-stats.json b/examples/code-splitting/webpack-stats.json
diff --git a/examples/hot-reload/app/settings.py b/examples/hot-reload/app/settings.py
@@ -108,6 +108,8 @@
 )
 
 WEBPACK_LOADER = {
-    'BUNDLE_DIR_NAME': 'bundles/',
-    'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats.json'),
+    'DEFAULT': {
+        'BUNDLE_DIR_NAME': 'bundles/',
+        'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats.json')
+    }
 }
diff --git a/examples/hot-reload/webpack-stats.json b/examples/hot-reload/webpack-stats.json
diff --git a/examples/simple/app/settings.py b/examples/simple/app/settings.py
@@ -108,6 +108,8 @@
 )
 
 WEBPACK_LOADER = {
-    'BUNDLE_DIR_NAME': 'bundles/',
-    'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats.json'),
+    'DEFAULT': {
+        'BUNDLE_DIR_NAME': 'bundles/',
+        'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats.json')
+    }
 }
diff --git a/examples/simple/webpack-stats.json b/examples/simple/webpack-stats.json
diff --git a/tests/app/tests/test_webpack.py b/tests/app/tests/test_webpack.py
@@ -11,7 +11,8 @@
 from django_jinja.builtins import DEFAULT_EXTENSIONS
 from django.views.generic.base import TemplateView
 
-from webpack_loader.utils import get_config, get_assets, get_bundle, WebpackException
+from webpack_loader.utils import get_assets, get_config, get_bundle, WebpackException
+from webpack_loader.errors import BAD_CONFIG_ERROR
 
 
 BUNDLE_PATH = os.path.join(settings.BASE_DIR, 'assets/bundles/')
@@ -42,12 +43,7 @@ def test_config_check(self):
                                 'STATS_FILE': 'webpack-stats.json',
                            }):
             errors = webpack_cfg_check(None)
-            expected_errors = [Error(
-                'Error while parsing WEBPACK_LOADER configuration',
-                hint='Is WEBPACK_LOADER config compliant with the new format?',
-                obj='django.conf.settings.WEBPACK_LOADER',
-                id='django-webpack-loader.E001',
-            )]
+            expected_errors = [BAD_CONFIG_ERROR]
             self.assertEqual(errors, expected_errors)
 
         with self.settings(WEBPACK_LOADER={
@@ -102,7 +98,7 @@ def test_templatetags(self):
         self.assertIn('<link type="text/css" href="/static/bundles/styles.css" rel="stylesheet"/>', result.rendered_content)
         self.assertIn('<script type="text/javascript" src="/static/bundles/main.js"></script>', result.rendered_content)
 
-        self.assertIn('<link type="text/css" href="/static/bundles/styles-app2.css" rel="stylesheet">', result.rendered_content)
+        self.assertIn('<link type="text/css" href="/static/bundles/styles-app2.css" rel="stylesheet"/>', result.rendered_content)
         self.assertIn('<script type="text/javascript" src="/static/bundles/app2.js"></script>', result.rendered_content)
         self.assertIn('<img src="/static/my-image.png"/>', result.rendered_content)
 
@@ -151,7 +147,7 @@ def test_reporting_errors(self):
         #TODO:
         self.compile_bundles('webpack.config.error.js')
         try:
-            get_bundle('main', DEFAULT_CONFIG)
+            get_bundle('main', get_config(DEFAULT_CONFIG))
         except WebpackException as e:
             self.assertIn("Cannot resolve module 'the-library-that-did-not-exist'", str(e))
 
diff --git a/tests/webpack-stats-app2.json b/tests/webpack-stats-app2.json
diff --git a/webpack_loader/apps.py b/webpack_loader/apps.py
@@ -1,9 +1,10 @@
 from django.apps import AppConfig
 
+from .errors import BAD_CONFIG_ERROR
+
 
 def webpack_cfg_check(app_configs, **kwargs):
     from django.conf import settings
-    from django.core.checks import Error
 
     check_failed = False
     user_config = getattr(settings, 'WEBPACK_LOADER', {})
@@ -14,14 +15,7 @@ def webpack_cfg_check(app_configs, **kwargs):
 
     errors = []
     if check_failed:
-        errors.append(
-            Error(
-                'Error while parsing WEBPACK_LOADER configuration',
-                hint='Is WEBPACK_LOADER config compliant with the new format?',
-                obj='django.conf.settings.WEBPACK_LOADER',
-                id='django-webpack-loader.E001',
-            )
-        )
+        errors.append(BAD_CONFIG_ERROR)
     return errors
 
 
@@ -30,6 +24,5 @@ class WebpackLoaderConfig(AppConfig):
     verbose_name = "Webpack Loader"
 
     def ready(self):
-        from . import signals
         from django.core.checks import register, Tags
         register(Tags.compatibility)(webpack_cfg_check)
diff --git a/webpack_loader/errors.py b/webpack_loader/errors.py
@@ -0,0 +1,9 @@
+from django.core.checks import Error
+
+
+BAD_CONFIG_ERROR = Error(
+    'Error while parsing WEBPACK_LOADER configuration',
+    hint='Is WEBPACK_LOADER config valid?',
+    obj='django.conf.settings.WEBPACK_LOADER',
+    id='django-webpack-loader.E001',
+)
diff --git a/webpack_loader/templatetags/webpack_loader.py b/webpack_loader/templatetags/webpack_loader.py
@@ -25,15 +25,15 @@ def render_as_tags(bundle):
 
 
 @register.simple_tag
-def render_bundle(bundle_name, extension=None, config="DEFAULT"):
-    bundle = get_bundle(bundle_name, config)
+def render_bundle(bundle_name, extension=None, config='DEFAULT'):
+    bundle = get_bundle(bundle_name, get_config(config))
     if extension:
         bundle = filter_by_extension(bundle, extension)
     return render_as_tags(bundle)
 
 
 @register.simple_tag
-def webpack_static(asset_name, config="DEFAULT"):
+def webpack_static(asset_name, config='DEFAULT'):
     return "{}{}".format(
         get_assets(get_config(config)).get('publicPath', getattr(settings, 'STATIC_URL')),
         asset_name
diff --git a/webpack_loader/utils.py b/webpack_loader/utils.py
@@ -6,24 +6,25 @@
 from django.contrib.staticfiles.storage import staticfiles_storage
 
 
-__all__ = ('get_bundle',)
+__all__ = ('get_assets', 'get_config', 'get_bundle',)
+
 
 DEFAULT_CONFIG = {
-    'BUNDLE_DIR_NAME': 'webpack_bundles/',
-    'STATS_FILE': 'webpack-stats.json',
-    # FIXME: Explore usage of fsnotify
-    'POLL_INTERVAL': 0.1,
-    'IGNORE': ['.+\.hot-update.js', '.+\.map']
+    'DEFAULT': {
+        'BUNDLE_DIR_NAME': 'webpack_bundles/',
+        'STATS_FILE': 'webpack-stats.json',
+        # FIXME: Explore usage of fsnotify
+        'POLL_INTERVAL': 0.1,
+        'IGNORE': ['.+\.hot-update.js', '.+\.map']
+    }
 }
 
-config = {
-    'DEFAULT': DEFAULT_CONFIG
-}
 
-user_config = getattr(settings, 'WEBPACK_LOADER', config)
+user_config = getattr(settings, 'WEBPACK_LOADER', DEFAULT_CONFIG)
+
 user_config = {
-    project: dict(DEFAULT_CONFIG, **cfg)
-    for project, cfg in user_config.items()
+    name: dict(DEFAULT_CONFIG['DEFAULT'], **cfg)
+    for name, cfg in user_config.items()
 }
 
 for entry in user_config.values():
@@ -42,23 +43,22 @@ def get_assets(config):
     try:
         return json.loads(open(config['STATS_FILE']).read())
     except IOError:
-        raise IOError('Error reading {}. Are you sure webpack has generated '
-                      'the file and the path is correct?'.format(config['STATS_FILE']))
+        raise IOError(
+            'Error reading {}. Are you sure webpack has generated the file '
+            'and the path is correct?'.format(config['STATS_FILE']))
 
 
 def filter_files(files, config):
-    ignores = config['ignores']
     for F in files:
         filename = F['name']
-        ignore = any(regex.match(filename) for regex in ignores)
+        ignore = any(regex.match(filename) for regex in config['ignores'])
         if not ignore:
             relpath = '{}{}'.format(config['BUNDLE_DIR_NAME'], filename)
             F['url'] = staticfiles_storage.url(relpath)
             yield F
 
 
-def get_bundle(bundle_name, config_name):
-    config = get_config(config_name)
+def get_bundle(bundle_name, config):
     assets = get_assets(config)
 
     if settings.DEBUG:

Original file line number	Diff line number	Diff line change
`@@ -108,6 +108,8 @@`
`108`	`108`	`)`
`109`	`109`
`110`	`110`	`WEBPACK_LOADER = {`
`111`		`- 'BUNDLE_DIR_NAME': 'bundles/',`
`112`		`- 'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats.json'),`
	`111`	`+ 'DEFAULT': {`
	`112`	`+ 'BUNDLE_DIR_NAME': 'bundles/',`
	`113`	`+ 'STATS_FILE': os.path.join(BASE_DIR, 'webpack-stats.json')`
	`114`	`+ }`
`113`	`115`	`}`