Add load_paths parameter to SASS/SCSS compilers

Author: Andrey Fedoseev

AUTHORS

@@ -7,3 +7,4 @@ Sergey Fedoseev [https://github.com/sir-sigurd]
 Alexey Kuleshevich [https://github.com/lehins]
 Andrey Dresvyannikov [https://github.com/sepulchered]
 Jasper Schulz [https://github.com/jaheba]
+Tim Olson [https://github.com/timolson]

CHANGES.rst

@@ -13,6 +13,7 @@ Dev
 - Add `Handlebars <http://handlebarsjs.com/>`_ compiler
 - Add support for Django 1.9
 - Add ``plugins`` parameter to Babel compiler
+- Add ``load_paths`` parameter to SASS/SCSS compilers
 
 
 1.0.1

README.rst

@@ -241,10 +241,13 @@ SASS / SCSS
 ``compass_enabled``
   Boolean. Whether to use compass or not. Compass must be installed in your system. Run "sass --compass" and if no error is shown it means that compass is installed.
 
+``load_paths``
+  List of import paths (``--load-path`` command line option).
+
 Example::
 
     STATIC_PRECOMPILER_COMPILERS = (
-        ('static_precompiler.compilers.SCSS', {"executable": "/usr/bin/sass", "sourcemap_enabled": True, "compass_enabled": True}),
+        ('static_precompiler.compilers.SCSS', {"executable": "/usr/bin/sass", "sourcemap_enabled": True, "compass_enabled": True, "load_paths": ["path"]}),
     )
 
 

static_precompiler/compilers/scss.py

@@ -23,12 +23,29 @@ class SCSS(base.BaseCompiler):
     IMPORT_RE = re.compile(r"@import\s+(.+?)\s*;", re.DOTALL)
 
     def __init__(self, executable=settings.SCSS_EXECUTABLE, sourcemap_enabled=False,
-                 compass_enabled=settings.SCSS_USE_COMPASS):
+                 compass_enabled=settings.SCSS_USE_COMPASS, load_paths=None):
         self.executable = executable
         self.is_sourcemap_enabled = sourcemap_enabled
         self.is_compass_enabled = compass_enabled
+        if load_paths is None:
+            self.load_paths = []
+        elif not isinstance(load_paths, (list, tuple)):
+            raise ValueError("load_paths option must be an iterable object (list, tuple)")
+        else:
+            self.load_paths = load_paths
         super(SCSS, self).__init__()
 
+    def get_extra_args(self):
+        args = []
+
+        for path in self.load_paths:
+            args += ["-I", path]
+
+        if self.is_compass_enabled:
+            args.append("--compass")
+
+        return args
+
     def should_compile(self, source_path, from_management=False):
         # Do not compile the files that start with "_" if run from management
         if from_management and os.path.basename(source_path).startswith("_"):
@@ -41,10 +58,7 @@ def compile_file(self, source_path):
         args = [
             self.executable,
             "--sourcemap={}".format("auto" if self.is_sourcemap_enabled else "none"),
-        ]
-
-        if self.is_compass_enabled:
-            args.append("--compass")
+        ] + self.get_extra_args()
 
         args.extend([
             self.get_full_source_path(source_path),
@@ -73,13 +87,11 @@ def compile_source(self, source):
         args = [
             self.executable,
             "-s",
-        ]
+        ] + self.get_extra_args()
+
         if self.executable.endswith("sass"):
             args.append("--scss")
 
-        if self.is_compass_enabled:
-            args.append("--compass")
-
         out, errors = utils.run_command(args, source)
         if errors:
             raise exceptions.StaticCompilationError(errors)
@@ -250,9 +262,6 @@ def compile_source(self, source):
         if self.executable.endswith("scss"):
             args.append("--sass")
 
-        if self.is_compass_enabled:
-            args.append("--compass")
-
         out, errors = utils.run_command(args, source)
         if errors:
             raise exceptions.StaticCompilationError(errors)

static_precompiler/tests/test_scss.py

@@ -233,3 +233,17 @@ def test_compass_import(monkeypatch, tmpdir):
     compiler = compilers.SCSS(compass_enabled=False)
     with pytest.raises(exceptions.StaticCompilationError):
         compiler.compile_file("styles/test-compass-import.scss")
+
+
+def test_get_extra_args():
+
+    assert compilers.SCSS().get_extra_args() == []
+
+    assert compilers.SCSS(compass_enabled=True, load_paths=["foo", "bar"]).get_extra_args() == [
+        "-I", "foo",
+        "-I", "bar",
+        "--compass",
+    ]
+
+    with pytest.raises(ValueError):
+        compilers.SCSS(load_paths="foo")