#3 fix sourceMap mechanism in less.js files, start mapping Source Map parameters, remove SystemOperatingChecker (use own separator)

Author: agabrys

src/main/java/biz/gabrys/lesscss/compiler2/NativeLessCompiler.java

@@ -67,6 +67,12 @@
  */
 public class NativeLessCompiler {
 
+    /**
+     * Separator used to extract paths from {@code --include-path"} option.
+     * @since 2.0.0
+     */
+    public static final String INCLUDE_PATHS_SEPARATOR = "gabrys-lesscss-compiler-path-separator";
+
     private static final Pattern CONFIGURATION_EXCEPTION_PATTERN = Pattern.compile("^Configuration problem: (.*)");
     private static final int CONFIGURATION_EXCEPTION_MESSAGE_GROUP_INDEX = 1;
     private static final Pattern IMPORT_EXCEPTION_PATTERN = Pattern.compile("^FileError:\\s+'(.+)'\\s+wasn't\\s+found\\s+(?s).*");
@@ -91,9 +97,24 @@ public NativeLessCompiler() {
     }
 
     /**
-     * Executes the compiler with options.
+     * Executes the compiler. You can use standard
+     * <a href="http://lesscss.org/usage/index.html#command-line-usage-options">Less options</a> with some exceptions:
+     * <ul>
+     * <li>use {@link #INCLUDE_PATHS_SEPARATOR} to separate paths in {@code --include-path"} option instead of ';'
+     * character on Windows and ':' character on Unix/Linux machines</li>
+     * <li>does not support options:
+     * <ul>
+     * <li>allow imports from insecure HTTPS hosts ({@code --insecure})</li>
+     * <li>lint ({@code -l} or {@code --lint})</li>
+     * <li>makefile ({@code -M} or {@code --depends})</li>
+     * <li>no color ({@code --no-color})</li>
+     * <li>plugins ({@code --plugin})</li>
+     * <li>version ({@code -v} or {@code --version})</li>
+     * </ul>
+     * </li>
+     * </ul>
      * @param options the compiler options.
-     * @return the compiler output (depends on options it can be e.g. CSS code, Source Map etc).
+     * @return the compiler output (depends on options it can be e.g. CSS code, logs).
      * @throws InitializationException if an error occurred during compiler initialization.
      * @throws ConfigurationException if the compiler is configured incorrectly.
      * @throws ReadFileException if the compiler cannot read file content.

src/main/java/biz/gabrys/lesscss/compiler2/NativeLessCompilerOptionsBuilder.java

@@ -22,18 +22,12 @@
 import biz.gabrys.lesscss.compiler2.util.StringUtils;
 
 /**
- * Options that control the <a href="http://lesscss.org/">Less</a> compilation process.
+ * Responsible for creating options that control the {@link NativeLessCompiler} compilation process.
  * @since 2.0.0
  * @see <a href="http://lesscss.org/usage/index.html#command-line-usage-options">Less options</a>
  */
 public class NativeLessCompilerOptionsBuilder {
 
-    /**
-     * The operating system software checker responsible for verifing system distriubution.
-     * @since 2.0.0
-     */
-    protected OperatingSystemChecker systemChecker;
-
     private File input;
     private File output;
     private boolean silent;
@@ -43,6 +37,9 @@ public class NativeLessCompilerOptionsBuilder {
     private boolean javaScriptEnabled = true;
     private List<String> includePaths = Collections.emptyList();
     private LineNumbersValue lineNumbers = LineNumbersValue.DISABLED;
+    private boolean sourceMapDefault;
+    private File sourceMapFile;
+    private boolean sourceMapInline;
     private String rootPath;
     private boolean relativeUrls;
     private boolean strictMath;
@@ -53,22 +50,7 @@ public class NativeLessCompilerOptionsBuilder {
      * @since 2.0.0
      */
     public NativeLessCompilerOptionsBuilder() {
-        systemChecker = new OperatingSystemChecker() {
-
-            @Override
-            public boolean isWindows() {
-                return System.getProperty("os.name").startsWith("Windows");
-            }
-        };
-    }
-
-    /**
-     * Constructs a new instance.
-     * @param systemChecker the operating system software checker.
-     * @since 2.0.0
-     */
-    public NativeLessCompilerOptionsBuilder(final OperatingSystemChecker systemChecker) {
-        this.systemChecker = systemChecker;
+        // do nothing
     }
 
     /**
@@ -252,10 +234,9 @@ protected String getJavaScriptEnabledCompilerOption() {
     }
 
     /**
-     * Sets available include paths (default: empty collection). Separated by ':' or ';' on Windows. If the file in an
-     * &#64;import rule does not exist at that exact location, less will look for it at the location(s) passed to this
-     * option. You might use this for instance to specify a path to a library which you want to be referenced simply and
-     * relatively in the less files.
+     * Sets available include paths (default: empty collection). If the file in an &#64;import rule does not exist at
+     * that exact location, less will look for it at the location(s) passed to this option. You might use this for
+     * instance to specify a path to a library which you want to be referenced simply and relatively in the less files.
      * @param includePaths the available include paths.
      * @return {@code this} builder.
      * @since 2.0.0
@@ -284,7 +265,7 @@ protected String getIncludePathsCompilerOption() {
             if (StringUtils.isNotBlank(path)) {
                 final boolean separatorRequired = paths.length() != 0;
                 if (separatorRequired) {
-                    paths.append(systemChecker.isWindows() ? ';' : ':');
+                    paths.append(NativeLessCompiler.INCLUDE_PATHS_SEPARATOR);
                 }
                 paths.append(path.trim());
             }
@@ -318,6 +299,110 @@ protected String getLineNumbersCompilerOption() {
         }
     }
 
+    /**
+     * Sets whether a compiler should generate a Source Map file with a default name equal to
+     * {@link #withOutputFile(File) output file name} plus {@code .map} suffix. It does not matter whether you call this
+     * method before or after the {@link #withOutputFile(File)} method.
+     * <p>
+     * This method clears bulider's data set by the {@link #withSourceMapFile(File)} and the
+     * {@link #withSourceMapInline(boolean)} methods.
+     * </p>
+     * @param enabled {@code true} whether the compiler should generate the Source Map file, otherwise {@code false}.
+     * @return {@code this} builder.
+     * @since 2.0.0
+     * @see #withOutputFile(File)
+     * @see #withSourceMapFile(File)
+     * @see #withSourceMapInline(boolean)
+     */
+    public NativeLessCompilerOptionsBuilder withSourceMapDefault(final boolean enabled) {
+        sourceMapDefault = enabled;
+        sourceMapFile = null;
+        sourceMapInline = false;
+        return this;
+    }
+
+    /**
+     * Returns a command line option which enables/disables generating a Source Map file with default name.
+     * @return the command line option (never {@code null}).
+     * @since 2.0.0
+     * @see #withSourceMapDefault(boolean)
+     */
+    protected String getSourceMapDefaultCompilerOption() {
+        if (sourceMapDefault) {
+            return "--source-map";
+        } else {
+            return "";
+        }
+    }
+
+    /**
+     * Sets whether a compiler should generate a Source Map file.
+     * <p>
+     * This method clears bulider's data set by the {@link #withSourceMapDefault(boolean)} and the
+     * {@link #withSourceMapInline(boolean)} methods.
+     * </p>
+     * @param sourceMap the Source Map file.
+     * @return {@code this} builder.
+     * @since 2.0.0
+     * @see #withSourceMapDefault(boolean)
+     * @see #withSourceMapInline(boolean)
+     */
+    public NativeLessCompilerOptionsBuilder withSourceMapFile(final File sourceMap) {
+        sourceMapDefault = false;
+        sourceMapFile = sourceMap;
+        sourceMapInline = false;
+        return this;
+    }
+
+    /**
+     * Returns a command line option which enables/disables generating a Source Map file.
+     * @return the command line option (never {@code null}).
+     * @since 2.0.0
+     * @see #withSourceMapFile(File)
+     */
+    protected String getSourceMapFileCompilerOption() {
+        if (sourceMapFile != null) {
+            return "--source-map=" + sourceMapFile.getAbsolutePath();
+        } else {
+            return "";
+        }
+    }
+
+    /**
+     * Sets whether a compiler should generate a Source Map and put it to CSS code. This is not recommended for
+     * production, but for development it allows the compiler to produce a single output file which in browsers that
+     * support it, use the compiled CSS but show you the non-compiled Less source.
+     * <p>
+     * This method clears bulider's data set by the {@link #withSourceMapDefault(boolean)} and the
+     * {@link #withSourceMapFile(File)} methods.
+     * </p>
+     * @param inline {@code true} whether the compiler should generate a Source Map, otherwise {@code false}.
+     * @return {@code this} builder.
+     * @since 2.0.0
+     * @see #withSourceMapDefault(boolean)
+     * @see #withSourceMapFile(File)
+     */
+    public NativeLessCompilerOptionsBuilder withSourceMapInline(final boolean inline) {
+        sourceMapDefault = false;
+        sourceMapFile = null;
+        sourceMapInline = inline;
+        return this;
+    }
+
+    /**
+     * Returns a command line options which enables/disables generating a Source Map which will be put to CSS code.
+     * @return the command line options (never {@code null}).
+     * @since 2.0.0
+     * @see #withSourceMapInline(boolean)
+     */
+    protected String[] getSourceMapInlineCompilerOptions() {
+        if (sourceMapInline) {
+            return new String[] { "--source-map", "--source-map-map-inline" };
+        } else {
+            return new String[0];
+        }
+    }
+
     ///////
     // TODO source maps
     ///////
@@ -522,6 +607,11 @@ public Collection<Object> create() {
         options.add(getJavaScriptEnabledCompilerOption());
         options.add(getIncludePathsCompilerOption());
         options.add(getLineNumbersCompilerOption());
+
+        options.add(getSourceMapDefaultCompilerOption());
+        options.add(getSourceMapFileCompilerOption());
+        options.add(getSourceMapInlineCompilerOptions());
+
         options.add(getRootPathCompilerOption());
         options.add(getRelativeUrlsCompilerOption());
         options.add(getStrictMathCompilerOption());
@@ -539,20 +629,6 @@ public Collection<Object> create() {
         return options.create();
     }
 
-    /**
-     * Responsible for checking operating system family.
-     * @since 2.0.0
-     */
-    public interface OperatingSystemChecker {
-
-        /**
-         * Tests whether operating system is <a href="http://www.microsoft.com/">Windows</a>.
-         * @return {@code true} whether operating system is Windows, otherwise {@code false}.
-         * @since 2.0.0
-         */
-        boolean isWindows();
-    }
-
     /**
      * Available values for {@link NativeLessCompilerOptionsBuilder#withLineNumbers(LineNumbersValue) line numbers}
      * option.

src/main/java/biz/gabrys/lesscss/compiler2/util/ListWithoutEmptyValuesBuilder.java

@@ -32,6 +32,21 @@ public ListWithoutEmptyValuesBuilder() {
         // do nothing
     }
 
+    /**
+     * Appends all values which are not blank.
+     * @param values the appended values.
+     * @return {@code this} builder.
+     * @since 2.0.0
+     */
+    public ListWithoutEmptyValuesBuilder add(final String[] values) {
+        if (values != null) {
+            for (final String value : values) {
+                add(value);
+            }
+        }
+        return this;
+    }
+
     /**
      * Appends a value only if it is not blank.
      * @param value the appended value.

src/main/javascript/biz/gabrys/lesscss/compiler2/less-rhino-1.7.5.js

@@ -3049,7 +3049,7 @@ less.Parser.serializeVars = function(vars) {
 
             if (useBase64) {
                 try {
-                    returner = require('./encoder').encodeBase64(returner); // TODO browser implementation
+                    returner = less.encoder.encodeBase64(returner);
                 } catch (e) {
                     useBase64 = false;
                 }
@@ -7948,7 +7948,7 @@ less.Parser.serializeVars = function(vars) {
             if (this._writeSourceMap) {
                 this._writeSourceMap(sourceMapContent);
             } else {
-                sourceMapURL = "data:application/json;base64," + require('./encoder.js').encodeBase64(sourceMapContent);
+                sourceMapURL = "data:application/json;base64," + less.encoder.encodeBase64(sourceMapContent);
             }
 
             if (sourceMapURL) {