SMARTSPRITES-90: rename the option to --mark-sprite-images, use space…

…s for formatting, actually use the new option in SmartSpritesTask.

src/main/java/org/carrot2/labs/smartsprites/SmartSpritesParameters.java

@@ -4,7 +4,6 @@
 import java.io.IOException;
 import java.util.List;
 
-
 import org.apache.commons.lang3.StringUtils;
 import org.carrot2.labs.smartsprites.message.MessageLog;
 import org.carrot2.labs.smartsprites.message.Message.MessageLevel;
@@ -103,10 +102,11 @@ public final class SmartSpritesParameters
     private boolean spritePngIe6;
 
     /**
-     * If <code>true</code>, SmartSprites will generate the sprite directive indicating that the image is a sprite image.
+     * If <code>true</code>, SmartSprites will generate the sprite directive indicating
+     * that the image is a sprite image.
      */
-    @Option(name = "--keepingSpriteTrack")
-    private boolean keepingSpriteTrack;
+    @Option(name = "--mark-sprite-images")
+    private boolean markSpriteImages;
 
     /** The default suffix to be added to the generated CSS files. */
     public static final String DEFAULT_CSS_FILE_SUFFIX = "-sprite";
@@ -124,8 +124,8 @@ public final class SmartSpritesParameters
     public static final MessageLevel DEFAULT_LOGGING_LEVEL = MessageLevel.INFO;
 
     /** By default, we don't generate sprite directive in output css */
-    public static final boolean DEFAULT_KEEPING_SPRITE_TRACK = false;
-    
+    public static final boolean DEFAULT_MARK_SPRITE_IMAGES = false;
+
     public enum PngDepth
     {
         AUTO, INDEXED, DIRECT;
@@ -146,7 +146,8 @@ public SmartSpritesParameters()
     public SmartSpritesParameters(String rootDir)
     {
         this(rootDir, null, null, null, MessageLevel.INFO, DEFAULT_CSS_FILE_SUFFIX,
-            DEFAULT_SPRITE_PNG_DEPTH, DEFAULT_SPRITE_PNG_IE6, DEFAULT_CSS_FILE_ENCODING, DEFAULT_KEEPING_SPRITE_TRACK);
+            DEFAULT_SPRITE_PNG_DEPTH, DEFAULT_SPRITE_PNG_IE6, DEFAULT_CSS_FILE_ENCODING,
+            DEFAULT_MARK_SPRITE_IMAGES);
     }
 
     /**
@@ -157,18 +158,17 @@ public SmartSpritesParameters(String rootDir, List<String> cssFiles,
         String cssFileSuffix, PngDepth spritePngDepth, boolean spritePngIe6,
         String cssEncoding)
     {
-        this(rootDir, cssFiles, outputDir, documentRootDir, logLevel,
-                cssFileSuffix, spritePngDepth, spritePngIe6,
-                cssEncoding, DEFAULT_KEEPING_SPRITE_TRACK);
+        this(rootDir, cssFiles, outputDir, documentRootDir, logLevel, cssFileSuffix,
+            spritePngDepth, spritePngIe6, cssEncoding, DEFAULT_MARK_SPRITE_IMAGES);
     }
-    
+
     /**
      * Creates the parameters.
      */
     public SmartSpritesParameters(String rootDir, List<String> cssFiles,
         String outputDir, String documentRootDir, MessageLevel logLevel,
         String cssFileSuffix, PngDepth spritePngDepth, boolean spritePngIe6,
-        String cssEncoding, boolean keepingSpriteTrack)
+        String cssEncoding, boolean markSpriteImages)
     {
         this.rootDir = rootDir;
         this.cssFiles = cssFiles;
@@ -179,7 +179,7 @@ public SmartSpritesParameters(String rootDir, List<String> cssFiles,
         this.cssFileSuffix = getCssFileSuffix(cssFileSuffix);
         this.spritePngDepth = spritePngDepth;
         this.spritePngIe6 = spritePngIe6;
-        this.keepingSpriteTrack = keepingSpriteTrack;
+        this.markSpriteImages = markSpriteImages;
     }
 
     /**
@@ -202,8 +202,7 @@ public boolean validate(MessageLog log)
         // If there is no output dir, we can't have both root dir or css files
         if (!hasOutputDir() && hasRootDir() && hasCssFiles())
         {
-            log
-                .error(MessageType.ROOT_DIR_AND_CSS_FILES_CANNOT_BE_BOTH_SPECIFIED_UNLESS_WITH_OUTPUT_DIR);
+            log.error(MessageType.ROOT_DIR_AND_CSS_FILES_CANNOT_BE_BOTH_SPECIFIED_UNLESS_WITH_OUTPUT_DIR);
             return false;
         }
 
@@ -346,11 +345,12 @@ public boolean isSpritePngIe6()
         return spritePngIe6;
     }
 
-    public boolean isKeepingSpriteTrack() {
-		return keepingSpriteTrack;
-	}
+    public boolean isMarkSpriteImages()
+    {
+        return markSpriteImages;
+    }
 
-	public String getCssFileEncoding()
+    public String getCssFileEncoding()
     {
         return cssFileEncoding;
     }

src/main/java/org/carrot2/labs/smartsprites/SpriteBuilder.java

@@ -288,7 +288,7 @@ private void createProcessedCss(String originalCssFile,
         int originalCssLineNumber = -1;
         int lastReferenceReplacementLine = -1;
 
-        boolean keepingSpriteTrack = parameters.isKeepingSpriteTrack();
+        boolean markSpriteImages = parameters.isMarkSpriteImages();
 
         // Generate UID for sprite file
         try
@@ -327,15 +327,15 @@ private void createProcessedCss(String originalCssFile,
                         + getRelativeToReplacementLocation(
                             spriteReferenceReplacement.spriteImage.resolvedPath,
                             originalCssFile, spriteReferenceReplacement) + "')"
-                            + (important ? " !important" : "") + ";"+ (keepingSpriteTrack ? " /** sprite:sprite */" :"")+"\n");
+                            + (important ? " !important" : "") + ";"+ (markSpriteImages ? " /** sprite:sprite */" :"") + "\n");
 
                     if (spriteReferenceReplacement.spriteImage.hasReducedForIe6)
                     {
                         processedCssWriter.write("  -background-image: url('"
                             + getRelativeToReplacementLocation(
                                 spriteReferenceReplacement.spriteImage.resolvedPathIe6,
                                 originalCssFile, spriteReferenceReplacement) + "')"
-                                + (important ? " !important" : "") + ";"+ (keepingSpriteTrack ? " /** sprite:sprite */" :"")+"\n");
+                                + (important ? " !important" : "") + ";"+ (markSpriteImages ? " /** sprite:sprite */" :"") + "\n");
                     }
 
                     processedCssWriter.write("  background-position: "

src/main/java/org/carrot2/labs/smartsprites/ant/SmartSpritesTask.java

@@ -31,7 +31,7 @@ public class SmartSpritesTask extends Task
     private String cssFileEncoding = SmartSpritesParameters.DEFAULT_CSS_FILE_ENCODING;
     private PngDepth spritePngDepth = SmartSpritesParameters.DEFAULT_SPRITE_PNG_DEPTH;
     private boolean spritePngIe6 = SmartSpritesParameters.DEFAULT_SPRITE_PNG_IE6;
-    private boolean keepingSpriteTrack = SmartSpritesParameters.DEFAULT_KEEPING_SPRITE_TRACK;
+    private boolean markSpriteImages = SmartSpritesParameters.DEFAULT_MARK_SPRITE_IMAGES;
 
     private List<String> cssFiles = Lists.newArrayList();
 
@@ -93,17 +93,17 @@ public void setSpritePngIe6(boolean spritePngIe6)
         this.spritePngIe6 = spritePngIe6;
     }
 
-    public void setKeepingSpriteTrack(boolean keepingSpriteTrack)
+    public void setMarkSpriteImages(boolean markSpriteImages)
     {
-        this.keepingSpriteTrack = keepingSpriteTrack;
+        this.markSpriteImages = markSpriteImages;
     }
 
     @Override
     public void execute() throws BuildException
     {
         final SmartSpritesParameters parameters = new SmartSpritesParameters(rootDir,
             cssFiles, outputDir, documentRootDir, logLevel, cssFileSuffix,
-            spritePngDepth, spritePngIe6, cssFileEncoding);
+            spritePngDepth, spritePngIe6, cssFileEncoding, markSpriteImages);
 
         final FailureDetectorMessageSink failureDetectorMessageSink = new FailureDetectorMessageSink();
         MessageLog log = new MessageLog(new AntLogMessageSink(),