#3 cleanup lessc-rhino, add first version of LessCompiler, rename Less175 to NativeLess

Author: agabrys

README.md

@@ -24,20 +24,26 @@ You can download the library from [this page](http://lesscss-compiler.projects.g
 or using various [dependency management tools](http://lesscss-compiler.projects.gabrys.biz/LATEST/dependency-info.html).
 
 # Concept
-The idea for the `Less175Compiler` class was based on the [lesscss-java](https://github.com/marceloverdijk/lesscss-java)
+The library contains two compilers:
+* `NativeLessCompiler` a compiler with a shell-type API
+* `LessCompiler` a facade for the `NativeLessCompiler` with a developer-friendly API
+
+The idea for the `NativeLessCompiler` class was based on the [lesscss-java](https://github.com/marceloverdijk/lesscss-java)
 library by [Marcel Overdijk](https://github.com/marceloverdijk).
 
 # Usage
 How to compile a source file:
 ```
-// create compiler & source file
-LessCompiler compiler = new Less175Compiler();
-File source = new File("/less/file.less");
+// create compiler and source file
+LessCompiler compiler = new LessCompiler();
+File source = new File("/source.less");
 
-// compile file with default options
+// compile source file
 String cssCode = compiler.compile(source);
 
-// set custom option: compress CSS code
-Collection<Object> options = new Less175CompilerOptionsBuilder().withCompress(true).create();
-String cssCompressedCode = compiler.compile(source, options);
+// compile source file and save to output file
+compiler.compile(source, new File("/output.css"));
+
+// compile source file and compress CSS code
+String compressedCssCode = compiler.compileAndCompress(source);
 ```

src/main/java/biz/gabrys/lesscss/compiler2/BuildCompilerOptionsException.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 an error occurred during build compiler options.
+ * @since 2.0.0
+ */
+public class BuildCompilerOptionsException extends RuntimeException {
+
+    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 BuildCompilerOptionsException(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 BuildCompilerOptionsException(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 BuildCompilerOptionsException(final Throwable cause) {
+        super(cause);
+    }
+}

src/main/java/biz/gabrys/lesscss/compiler2/ResolveImportException.java renamed to src/main/java/biz/gabrys/lesscss/compiler2/ImportNotFoundException.java

@@ -13,10 +13,10 @@
 package biz.gabrys.lesscss.compiler2;
 
 /**
- * Thrown to indicate that an error occurred while resolving imports.
+ * Thrown to indicate that an @import operation points to non-existent file.
  * @since 2.0.0
  */
-public class ResolveImportException extends CompilerException {
+public class ImportNotFoundException extends CompilerException {
 
     private static final long serialVersionUID = 3800611680823858853L;
 
@@ -28,7 +28,7 @@ public class ResolveImportException extends CompilerException {
      * @param fileName the imported file name.
      * @since 2.0.0
      */
-    public ResolveImportException(final String message, final String fileName) {
+    public ImportNotFoundException(final String message, final String fileName) {
         super(message);
         this.fileName = fileName;
     }
@@ -40,18 +40,18 @@ public ResolveImportException(final String message, final String fileName) {
      * @param fileName the imported file name.
      * @since 2.0.0
      */
-    public ResolveImportException(final String message, final Throwable cause, final String fileName) {
+    public ImportNotFoundException(final String message, final Throwable cause, final String fileName) {
         super(message, cause);
         this.fileName = fileName;
     }
 
     /**
-     * Constructs a new instance with the imported file name and cause.
+     * Constructs a new instance with the cause and imported file name.
      * @param cause the cause.
      * @param fileName the imported file name.
      * @since 2.0.0
      */
-    public ResolveImportException(final Throwable cause, final String fileName) {
+    public ImportNotFoundException(final Throwable cause, final String fileName) {
         super(cause);
         this.fileName = fileName;
     }

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

@@ -13,30 +13,129 @@
 package biz.gabrys.lesscss.compiler2;
 
 import java.io.File;
-import java.util.Collection;
 
 /**
- * Responsible for executing <a href="http://lesscss.org/">Less</a> compiler for sources files.
+ * <p>
+ * <a href="http://lesscss.org/">Less</a> compiler compatible with
+ * <a href="https://github.com/less/less.js/releases/tag/v1.7.5">Less 1.7.5</a>.
+ * </p>
+ * <p>
+ * How to use:
+ * </p>
+ * 
+ * <pre>
+ * // create compiler and source file
+ * LessCompiler compiler = new LessCompiler();
+ * File source = new File("/source.less");
+ * 
+ * // compile source file
+ * String cssCode = compiler.compile(source);
+ * 
+ * // compile source file and save to output file
+ * compiler.compile(source, new File("/output.css"));
+ * 
+ * // compile source file and compress CSS code
+ * String compressedCssCode = compiler.compileAndCompress(source);
+ * </pre>
+ * 
  * @since 2.0.0
  */
-public interface LessCompiler {
+public class LessCompiler {
+
+    private final NativeLessCompiler compiler;
+
+    /**
+     * Constructs a new instance.
+     * @since 2.0.0
+     */
+    public LessCompiler() {
+        this(new NativeLessCompiler());
+    }
+
+    /**
+     * Constructs a new instance.
+     * @param compiler the native compiler used to compile source files.
+     * @since 2.0.0
+     */
+    protected LessCompiler(final NativeLessCompiler compiler) {
+        this.compiler = compiler;
+    }
+
+    /**
+     * Creates a new instance of the {@link NativeLessCompilerOptionsBuilder} used to create configuration options for
+     * the native compiler.
+     * @return the new instance of the {@link NativeLessCompilerOptionsBuilder}.
+     * @since 2.0.0
+     */
+    protected NativeLessCompilerOptionsBuilder createOptionsBuilder() {
+        return new NativeLessCompilerOptionsBuilder();
+    }
+
+    /**
+     * Compiles a Less source file.
+     * @param source the source file.
+     * @return CSS code.
+     * @throws InitializationException if an error occurred during compiler initialization.
+     * @throws ImportNotFoundException if any &#64;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) {
+        final NativeLessCompilerOptionsBuilder builder = createOptionsBuilder();
+        builder.withInputFile(source);
+        return compiler.execute(builder.create());
+    }
+
+    /**
+     * Compiles and compress a Less source file.
+     * @param source the source file.
+     * @return compressed CSS code.
+     * @throws InitializationException if an error occurred during compiler initialization.
+     * @throws ImportNotFoundException if any &#64;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) {
+        final NativeLessCompilerOptionsBuilder builder = createOptionsBuilder();
+        builder.withInputFile(source).withCompress(true);
+        return compiler.execute(builder.create());
+    }
 
     /**
-     * Executes a Less compiler for source file with default options.
+     * Compiles a Less source file and saves result in an output file.
      * @param source the source file.
-     * @return the compiler output (depends on default options it can be e.g. CSS code, Source Map etc).
-     * @throws CompilerException if an error occurred during execution.
+     * @param output the output file.
+     * @throws InitializationException if an error occurred during compiler initialization.
+     * @throws ImportNotFoundException if any &#64;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
      */
-    String execute(File source);
+    public void compile(final File source, final File output) {
+        final NativeLessCompilerOptionsBuilder builder = createOptionsBuilder();
+        builder.withInputFile(source).withOutputFile(output);
+        compiler.execute(builder.create());
+    }
 
     /**
-     * Executes a Less compiler for source file with custom options.
+     * Compiles and compress a Less source file and saves result in an output file.
      * @param source the source file.
-     * @param options the compiler options.
-     * @return the compiler output (depends on options it can be e.g. CSS code, Source Map etc).
-     * @throws CompilerException if an error occurred during execution.
+     * @param output the output file.
+     * @throws InitializationException if an error occurred during compiler initialization.
+     * @throws ImportNotFoundException if any &#64;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
      */
-    String execute(File source, Collection<Object> options);
+    public void compileAndCompress(final File source, final File output) {
+        final NativeLessCompilerOptionsBuilder builder = createOptionsBuilder();
+        builder.withInputFile(source).withOutputFile(output).withCompress(true);
+        compiler.execute(builder.create());
+    }
 }