#3 cleanup parsing configuration mechanism

Author: agabrys

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

@@ -0,0 +1,50 @@
+/*
+ * LessCSS Compiler
+ * http://lesscss-compiler.projects.gabrys.biz/
+ *
+ * Copyright (c) 2015 Adam Gabryś
+ *
+ * This file is licensed under the BSD 3-Clause (the "License").
+ * You may not use this file except in compliance with the License.
+ * You may obtain:
+ *  - a copy of the License at project page
+ *  - a template of the License at https://opensource.org/licenses/BSD-3-Clause
+ */
+package biz.gabrys.lesscss.compiler2;
+
+/**
+ * Thrown to indicate that compiler has been configured incorrectly (e.g. missing required options).
+ * @since 2.0.0
+ */
+public class ConfigurationException extends CompilerException {
+
+    private static final long serialVersionUID = -2386288381210804468L;
+
+    /**
+     * Constructs a new instance with the specified detail message.
+     * @param message the detail message.
+     * @since 2.0.0
+     */
+    public ConfigurationException(final String message) {
+        super(message);
+    }
+
+    /**
+     * Constructs a new instance with the specified detail message and cause.
+     * @param message the detail message.
+     * @param cause the cause.
+     * @since 2.0.0
+     */
+    public ConfigurationException(final String message, final Throwable cause) {
+        super(message, cause);
+    }
+
+    /**
+     * Constructs a new instance with the specified cause.
+     * @param cause the cause.
+     * @since 2.0.0
+     */
+    public ConfigurationException(final Throwable cause) {
+        super(cause);
+    }
+}

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

@@ -73,69 +73,106 @@ protected NativeLessCompilerOptionsBuilder createOptionsBuilder() {
 
     /**
      * Compiles a Less source file.
-     * @param source the source file.
+     * @param source the source file (cannot be {@code null} and must exist).
      * @return CSS code.
      * @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.
      * @throws ImportNotFoundException if any @import operation point to non-existent file.
-     * @throws SourceFileNotFoundException if a source (input) file does not exist.
      * @throws SyntaxException if a syntax error occurred during source file compilation.
      * @throws CompilerException if an other error occurred during execution.
      * @since 2.0.0
      */
     public String compile(final File source) {
+        validateSourceFile(source);
         final NativeLessCompilerOptionsBuilder builder = createOptionsBuilder();
         builder.withInputFile(source);
         return compiler.execute(builder.create());
     }
 
     /**
      * Compiles and compress a Less source file.
-     * @param source the source file.
+     * @param source the source file (cannot be {@code null} and must exist).
      * @return compressed CSS code.
      * @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.
      * @throws ImportNotFoundException if any @import operation point to non-existent file.
-     * @throws SourceFileNotFoundException if a source (input) file does not exist.
      * @throws SyntaxException if a syntax error occurred during source file compilation.
      * @throws CompilerException if an other error occurred during execution.
      * @since 2.0.0
      */
     public String compileAndCompress(final File source) {
+        validateSourceFile(source);
         final NativeLessCompilerOptionsBuilder builder = createOptionsBuilder();
         builder.withInputFile(source).withCompress(true);
         return compiler.execute(builder.create());
     }
 
     /**
      * Compiles a Less source file and saves result in an output file.
-     * @param source the source file.
+     * @param source the source file (cannot be {@code null} and must exist).
      * @param output the output file.
      * @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.
      * @throws ImportNotFoundException if any @import operation point to non-existent file.
-     * @throws SourceFileNotFoundException if a source (input) file does not exist.
      * @throws SyntaxException if a syntax error occurred during source file compilation.
      * @throws CompilerException if an other error occurred during execution.
      * @since 2.0.0
      */
     public void compile(final File source, final File output) {
+        validateSourceFile(source);
+        validateOutputFile(output);
         final NativeLessCompilerOptionsBuilder builder = createOptionsBuilder();
         builder.withInputFile(source).withOutputFile(output);
         compiler.execute(builder.create());
     }
 
     /**
      * Compiles and compress a Less source file and saves result in an output file.
-     * @param source the source file.
+     * @param source the source file (cannot be {@code null} and must exist).
      * @param output the output file.
      * @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.
      * @throws ImportNotFoundException if any @import operation point to non-existent file.
-     * @throws SourceFileNotFoundException if a source (input) file does not exist.
      * @throws SyntaxException if a syntax error occurred during source file compilation.
      * @throws CompilerException if an other error occurred during execution.
      * @since 2.0.0
      */
     public void compileAndCompress(final File source, final File output) {
+        validateSourceFile(source);
+        validateOutputFile(output);
         final NativeLessCompilerOptionsBuilder builder = createOptionsBuilder();
         builder.withInputFile(source).withOutputFile(output).withCompress(true);
         compiler.execute(builder.create());
     }
+
+    /**
+     * Validates source file.
+     * @param source the source file.
+     * @throws ConfigurationException if source file is {@code null} or does not exist.
+     * @since 2.0.0
+     */
+    protected void validateSourceFile(final File source) {
+        if (source == null) {
+            throw new ConfigurationException("Source file cannot be null");
+        }
+        if (!source.exists()) {
+            throw new ConfigurationException("Source file does not exist: " + source.getAbsolutePath());
+        }
+    }
+
+    /**
+     * Validates output file.
+     * @param output the output file.
+     * @throws ConfigurationException if output file is {@code null}.
+     * @since 2.0.0
+     */
+    protected void validateOutputFile(final File output) {
+        if (output == null) {
+            throw new ConfigurationException("Output file cannot be null");
+        }
+    }
 }

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

@@ -67,10 +67,12 @@
  */
 public class NativeLessCompiler {
 
-    private static final Pattern IMPORT_DOES_NOT_EXIST_PATTERN = Pattern.compile("^FileError:\\s+'(.+)'\\s+wasn't\\s+found\\s+(?s).*");
-    private static final int IMPORT_ERROR_FILE_NAME_GROUP_INDEX = 1;
-    private static final Pattern SOURCE_DOES_NOT_EXIST_PATTERN = Pattern.compile("Couldn't open source file: (.*)");
-    private static final int SOURCE_ERROR_FILE_PATH_GROUP_INDEX = 1;
+    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).*");
+    private static final int IMPORT_EXCEPTION_FILE_NAME_GROUP_INDEX = 1;
+    private static final Pattern READ_FILE_EXCEPTION_PATTERN = Pattern.compile("^Couldn't open source file: (.*)");
+    private static final int READ_FILE_EXCEPTION_FILE_PATH_GROUP_INDEX = 1;
 
     private static final String CHARSET = "UTF-8";
 
@@ -93,8 +95,9 @@ public NativeLessCompiler() {
      * @param options the compiler options.
      * @return the compiler output (depends on options it can be e.g. CSS code, Source Map etc).
      * @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.
      * @throws ImportNotFoundException if any @import operation point to non-existent file.
-     * @throws SourceFileNotFoundException if a source (input) file does not exist.
      * @throws SyntaxException if a syntax error occurred during source file compilation.
      * @throws CompilerException if an other error occurred during execution.
      * @since 2.0.0
@@ -168,13 +171,17 @@ private static CompilerException parseException(final JavaScriptException except
         final Scriptable value = (Scriptable) exception.getValue();
         if (value != null && ScriptableObject.hasProperty(value, "message")) {
             final String message = ScriptableObject.getProperty(value, "message").toString();
-            Matcher matcher = IMPORT_DOES_NOT_EXIST_PATTERN.matcher(message);
+            Matcher matcher = IMPORT_EXCEPTION_PATTERN.matcher(message);
             if (matcher.find()) {
-                return new ImportNotFoundException(message, exception, matcher.group(IMPORT_ERROR_FILE_NAME_GROUP_INDEX));
+                return new ImportNotFoundException(message, exception, matcher.group(IMPORT_EXCEPTION_FILE_NAME_GROUP_INDEX));
             }
-            matcher = SOURCE_DOES_NOT_EXIST_PATTERN.matcher(message);
+            matcher = CONFIGURATION_EXCEPTION_PATTERN.matcher(message);
             if (matcher.find()) {
-                return new SourceFileNotFoundException(message, matcher.group(SOURCE_ERROR_FILE_PATH_GROUP_INDEX));
+                return new ConfigurationException(matcher.group(CONFIGURATION_EXCEPTION_MESSAGE_GROUP_INDEX));
+            }
+            matcher = READ_FILE_EXCEPTION_PATTERN.matcher(message);
+            if (matcher.find()) {
+                return new ReadFileException(message, matcher.group(READ_FILE_EXCEPTION_FILE_PATH_GROUP_INDEX));
             }
             return new SyntaxException(message, exception);
         }

src/main/java/biz/gabrys/lesscss/compiler2/SourceFileNotFoundException.java renamed to src/main/java/biz/gabrys/lesscss/compiler2/ReadFileException.java

@@ -13,52 +13,52 @@
 package biz.gabrys.lesscss.compiler2;
 
 /**
- * Thrown to indicate that a source file does not exist.
+ * Thrown to indicate that a compiler cannot read file content.
  * @since 2.0.0
  */
-public class SourceFileNotFoundException extends CompilerException {
+public class ReadFileException extends CompilerException {
 
     private static final long serialVersionUID = 3711806897577477826L;
 
     private final String filePath;
 
     /**
-     * Constructs a new instance with the specified detail message and source file path.
+     * Constructs a new instance with the specified detail message and file path.
      * @param message the detail message.
-     * @param filePath the source file path.
+     * @param filePath the file path.
      * @since 2.0.0
      */
-    public SourceFileNotFoundException(final String message, final String filePath) {
+    public ReadFileException(final String message, final String filePath) {
         super(message);
         this.filePath = filePath;
     }
 
     /**
-     * Constructs a new instance with the specified detail message, cause and source file path.
+     * Constructs a new instance with the specified detail message, cause and file path.
      * @param message the detail message.
      * @param cause the cause.
-     * @param filePath the source file path.
+     * @param filePath the file path.
      * @since 2.0.0
      */
-    public SourceFileNotFoundException(final String message, final Throwable cause, final String filePath) {
+    public ReadFileException(final String message, final Throwable cause, final String filePath) {
         super(message, cause);
         this.filePath = filePath;
     }
 
     /**
-     * Constructs a new instance with the cause and source file path.
+     * Constructs a new instance with the cause and file path.
      * @param cause the cause.
-     * @param filePath the source file path.
+     * @param filePath the file path.
      * @since 2.0.0
      */
-    public SourceFileNotFoundException(final Throwable cause, final String filePath) {
+    public ReadFileException(final Throwable cause, final String filePath) {
         super(cause);
         this.filePath = filePath;
     }
 
     /**
-     * Returns a source file path.
-     * @return the source file path.
+     * Returns a file path.
+     * @return the file path.
      * @since 2.0.0
      */
     public String getFilePath() {

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

@@ -252,34 +252,30 @@ less.Parser = function Parser(env) {
                 callback(e, root, importedPreviously, fullPath);
             };
 
-            if (less.Parser.importer) {
-                less.Parser.importer(path, currentFileInfo, fileParsedFunc, env);
-            } else {
-                less.Parser.fileLoader(path, currentFileInfo, function(e, contents, fullPath, newFileInfo) {
-                    if (e) {
-                        fileParsedFunc(e);
-                        return;
-                    }
+            less.Parser.fileLoader(path, currentFileInfo, function(e, contents, fullPath, newFileInfo) {
+                if (e) {
+                    fileParsedFunc(e);
+                    return;
+                }
 
-                    var newEnv = new tree.parseEnv(env);
+                var newEnv = new tree.parseEnv(env);
 
-                    newEnv.currentFileInfo = newFileInfo;
-                    newEnv.processImports = false;
-                    newEnv.contents[fullPath] = contents;
+                newEnv.currentFileInfo = newFileInfo;
+                newEnv.processImports = false;
+                newEnv.contents[fullPath] = contents;
 
-                    if (currentFileInfo.reference || importOptions.reference) {
-                        newFileInfo.reference = true;
-                    }
+                if (currentFileInfo.reference || importOptions.reference) {
+                    newFileInfo.reference = true;
+                }
 
-                    if (importOptions.inline) {
-                        fileParsedFunc(null, contents, fullPath);
-                    } else {
-                        new(less.Parser)(newEnv).parse(contents, function(e, root) {
-                            fileParsedFunc(e, root, fullPath);
-                        });
-                    }
-                }, env);
-            }
+                if (importOptions.inline) {
+                    fileParsedFunc(null, contents, fullPath);
+                } else {
+                    new(less.Parser)(newEnv).parse(contents, function(e, root) {
+                        fileParsedFunc(e, root, fullPath);
+                    });
+                }
+            }, env);
         }
     };