Merge pull request #135 from joshjo/master

joaopslins · web-flow · commit fffb88952ceb · 2021-08-23T20:19:55.000-03:00
Appending extensions in the url files
diff --git a/README.md b/README.md
@@ -1,4 +1,6 @@
-# django-webpack-loader
+# django-webpack-loader for gzip
+
+Different from the original repository, it appends an extension in the creation of the tags (as .gzip). The append is also dynamic, and can be done for css or js
 
 [![Build Status](https://circleci.com/gh/django-webpack/django-webpack-loader/tree/master.svg?style=svg)](https://circleci.com/gh/django-webpack/django-webpack-loader/tree/master)
 [![Coverage Status](https://coveralls.io/repos/github/django-webpack/django-webpack-loader/badge.svg?branch=master)](https://coveralls.io/github/django-webpack/django-webpack-loader?branch=master)
@@ -297,6 +299,7 @@ WEBPACK_LOADER = {
 
     <!-- add some extra attributes to the tag -->
     {% render_bundle 'main' 'js' 'DEFAULT' attrs='async charset="UTF-8"'%}
+    {% render_bundle 'main' 'js' 'DEFAULT' attrs='async charset="UTF-8"' suffix=".gz" %}
   </body>
 </head>
 ```
diff --git a/tests/app/templates/append_extensions.html b/tests/app/templates/append_extensions.html
@@ -0,0 +1,13 @@
+{% load render_bundle from webpack_loader %}
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>Example</title>
+    {% render_bundle 'main' 'css' %}
+  </head>
+
+  <body>
+    {% render_bundle 'main' 'js' suffix='.gz' %}
+  </body>
+</html>
diff --git a/tests/app/tests/test_webpack.py b/tests/app/tests/test_webpack.py
@@ -156,6 +156,14 @@ def test_preload(self):
         self.assertIn('<link href="/static/django_webpack_loader_bundles/main.css" rel="stylesheet" />', result.rendered_content)
         self.assertIn('<script src="/static/django_webpack_loader_bundles/main.js" ></script>', result.rendered_content)
 
+    def test_append_extensions(self):
+        self.compile_bundles('webpack.config.gzipTest.js')
+        view = TemplateView.as_view(template_name='append_extensions.html')
+        request = self.factory.get('/')
+        result = view(request)
+
+        self.assertIn('<script src="/static/django_webpack_loader_bundles/main.js.gz" ></script>', result.rendered_content)
+
     def test_jinja2(self):
         self.compile_bundles('webpack.config.simple.js')
         self.compile_bundles('webpack.config.app2.js')
diff --git a/tests/package.json b/tests/package.json
@@ -14,7 +14,8 @@
     "mini-css-extract-plugin": "^0.9.0",
     "react": "^16.0.0",
     "webpack": "^4.0.0",
-    "webpack-bundle-tracker": "1.1.0",
+    "compression-webpack-plugin": "^6.1.1",
+    "webpack-bundle-tracker": "1.2.0",
     "webpack-cli": "^3.3.10",
     "webpack-dev-server": "^3.0.0"
   }
diff --git a/tests/webpack.config.gzipTest.js b/tests/webpack.config.gzipTest.js
@@ -2,18 +2,20 @@ var path = require("path");
 var webpack = require('webpack');
 var BundleTracker = require('webpack-bundle-tracker');
 var MiniCssExtractPlugin = require('mini-css-extract-plugin');
+var CompressionPlugin = require('compression-webpack-plugin');
 
 
 module.exports = {
   context: __dirname,
   entry: './assets/js/index',
   output: {
       path: path.resolve('./assets/django_webpack_loader_bundles/'),
-      filename: "[name].js.gz"
+      filename: "[name].js"
   },
 
   plugins: [
     new MiniCssExtractPlugin(),
+    new CompressionPlugin(),
     new BundleTracker({path: __dirname, filename: './webpack-stats.json'}),
   ],
 
diff --git a/webpack_loader/templatetags/webpack_loader.py b/webpack_loader/templatetags/webpack_loader.py
@@ -8,8 +8,11 @@
 
 
 @register.simple_tag
-def render_bundle(bundle_name, extension=None, config='DEFAULT', attrs='', is_preload=False):
-    tags = utils.get_as_tags(bundle_name, extension=extension, config=config, attrs=attrs, is_preload=is_preload)
+def render_bundle(bundle_name, extension=None, config='DEFAULT', suffix='', attrs='', is_preload=False):
+    tags = utils.get_as_tags(
+        bundle_name, extension=extension, config=config,
+        suffix=suffix, attrs=attrs, is_preload=is_preload
+    )
     return mark_safe('\n'.join(tags))
 
 
diff --git a/webpack_loader/utils.py b/webpack_loader/utils.py
@@ -47,7 +47,7 @@ def get_files(bundle_name, extension=None, config='DEFAULT'):
     return list(_get_bundle(bundle_name, extension, config))
 
 
-def get_as_tags(bundle_name, extension=None, config='DEFAULT', attrs='', is_preload=False):
+def get_as_tags(bundle_name, extension=None, config='DEFAULT', suffix='', attrs='', is_preload=False):
     '''
     Get a list of formatted <script> & <link> tags for the assets in the
     named bundle.
@@ -65,15 +65,15 @@ def get_as_tags(bundle_name, extension=None, config='DEFAULT', attrs='', is_prel
             if is_preload:
                 tags.append((
                     '<link rel="preload" as="script" href="{0}" {1}/>'
-                ).format(chunk['url'], attrs))
+                ).format(''.join([chunk['url'], suffix]), attrs))
             else:
                 tags.append((
                     '<script src="{0}" {1}></script>'
-                ).format(chunk['url'], attrs))
+                ).format(''.join([chunk['url'], suffix]), attrs))
         elif chunk['name'].endswith(('.css', '.css.gz')):
             tags.append((
                 '<link href="{0}" rel={2} {1}/>'
-            ).format(chunk['url'], attrs, '"stylesheet"' if not is_preload else '"preload" as="style"'))
+            ).format(''.join([chunk['url'], suffix]), attrs, '"stylesheet"' if not is_preload else '"preload" as="style"'))
     return tags
 
 
