Mass refactoring

Author: glibas

.travis.yml

@@ -1,4 +1,4 @@
 language: java
 script: ./gradlew build
 
-jdk: oraclejdk8
+jdk: oraclejdk7

build.gradle

@@ -1,16 +1,15 @@
 group 'com.assertthat'
 version '0.1'
 
-apply plugin: 'groovy'
+apply plugin: 'java'
 
-sourceCompatibility = 1.8
+sourceCompatibility = 1.7
 
 repositories {
     mavenCentral()
 }
 
 dependencies {
-    testCompile 'org.codehaus.groovy:groovy-test:2.4.3'
     testCompile 'junit:junit:4.12'
     compile group: 'org.seleniumhq.selenium', name: 'selenium-java', version: '2.53.0'
 }

settings.gradle

@@ -1,2 +1,2 @@
-rootProject.name = 'selenium-screenshotter'
+rootProject.name = 'shutterbug'
 

src/main/java/com/assertthat/selenium_screenshotter/core/ElementScreenshot.java

@@ -0,0 +1,19 @@
+package com.assertthat.shutterbug.core;
+
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.WebElement;
+
+/**
+ * Created by Glib_Briia on 17/06/2016.
+ */
+public class ElementSnapshot extends Snapshot {
+
+    ElementSnapshot(WebDriver driver, WebElement element) {
+        this.driver = driver;
+    }
+
+    @Override
+    protected ElementSnapshot self() {
+        return this;
+    }
+}

src/main/java/com/assertthat/shutterbug/core/ElementSnapshot.java

@@ -1,7 +1,7 @@
-package com.assertthat.selenium_screenshotter.core;
+package com.assertthat.shutterbug.core;
 
-import com.assertthat.selenium_screenshotter.utils.image.ImageProcessor;
-import com.assertthat.selenium_screenshotter.utils.web.Coordinates;
+import com.assertthat.shutterbug.utils.image.ImageProcessor;
+import com.assertthat.shutterbug.utils.web.Coordinates;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
 
@@ -10,9 +10,9 @@
 /**
  * Created by Glib_Briia on 17/06/2016.
  */
-public class PageScreenshot extends Screenshot<PageScreenshot> {
+public class PageSnapshot extends Snapshot {
 
-    PageScreenshot(WebDriver driver) {
+    PageSnapshot(WebDriver driver) {
         this.driver = driver;
     }
 
@@ -21,9 +21,9 @@ public class PageScreenshot extends Screenshot<PageScreenshot> {
      * and line width 3.
      *
      * @param element WebElement to be highlighted
-     * @return instance of type PageScreenshot
+     * @return instance of type PageSnapshot
      */
-    public PageScreenshot highlight(WebElement element) {
+    public PageSnapshot highlight(WebElement element) {
         highlight(element, Color.red, 3);
         return this;
     }
@@ -35,9 +35,9 @@ public PageScreenshot highlight(WebElement element) {
      * @param element WebElement to be highlighted
      * @param color color of the line
      * @param lineWidth width of the line
-     * @return instance of type PageScreenshot
+     * @return instance of type PageSnapshot
      */
-    public PageScreenshot highlight(WebElement element, Color color, int lineWidth) {
+    public PageSnapshot highlight(WebElement element, Color color, int lineWidth) {
         image = ImageProcessor.highlight(image, new Coordinates(element), color, lineWidth);
         return this;
     }
@@ -50,9 +50,9 @@ public PageScreenshot highlight(WebElement element, Color color, int lineWidth)
      *                and line width 3
      * @param text test to be places above highlighted element with
      *             Color.red, font "Serif", BOLD, size 20
-     * @return instance of type PageScreenshot
+     * @return instance of type PageSnapshot
      */
-    public PageScreenshot highlightWithText(WebElement element, String text) {
+    public PageSnapshot highlightWithText(WebElement element, String text) {
         highlightWithText(element, Color.red, 3, text, Color.red, new Font("Serif", Font.BOLD, 20));
         return this;
     }
@@ -67,9 +67,9 @@ public PageScreenshot highlightWithText(WebElement element, String text) {
      * @param text text to be placed above the highlighted element
      * @param textColor color of the text
      * @param textFont text font
-     * @return instance of type PageScreenshot
+     * @return instance of type PageSnapshot
      */
-    public PageScreenshot highlightWithText(WebElement element, Color elementColor, int lineWidth, String text, Color textColor, Font textFont) {
+    public PageSnapshot highlightWithText(WebElement element, Color elementColor, int lineWidth, String text, Color textColor, Font textFont) {
         highlight(element, elementColor, 0);
         Coordinates coords = new Coordinates(element);
         image = ImageProcessor.addText(image, coords.getX(), coords.getY() - textFont.getSize() / 2, text, textColor, textFont);
@@ -79,9 +79,9 @@ public PageScreenshot highlightWithText(WebElement element, Color elementColor,
     /**
      * Blur the entire page.
      *
-     * @return instance of type PageScreenshot
+     * @return instance of type PageSnapshot
      */
-    public PageScreenshot blur() {
+    public PageSnapshot blur() {
         image = ImageProcessor.blur(image);
         return this;
     }
@@ -90,9 +90,9 @@ public PageScreenshot blur() {
      * Blur provided element within the page only.
      *
      * @param element WebElement to be blurred
-     * @return instance of type PageScreenshot
+     * @return instance of type PageSnapshot
      */
-    public PageScreenshot blur(WebElement element) {
+    public PageSnapshot blur(WebElement element) {
         image = ImageProcessor.blurArea(image, new Coordinates(element));
         return this;
     }
@@ -102,9 +102,9 @@ public PageScreenshot blur(WebElement element) {
      * Original colors remain on the rest of the page.
      *
      * @param element WebElement within the page to be made 'monochrome'
-     * @return instance of type PageScreenshot
+     * @return instance of type PageSnapshot
      */
-    public PageScreenshot monochrome(WebElement element) {
+    public PageSnapshot monochrome(WebElement element) {
         image = ImageProcessor.monochromeArea(image, new Coordinates(element));
         return this;
     }
@@ -113,15 +113,15 @@ public PageScreenshot monochrome(WebElement element) {
      * Blurs all the page except the element provided.
      *
      * @param element WebElement to stay not blurred
-     * @return instance of type PageScreenshot
+     * @return instance of type PageSnapshot
      */
-    public PageScreenshot blurExcept(WebElement element) {
+    public PageSnapshot blurExcept(WebElement element) {
         image = ImageProcessor.blurExceptArea(image, new Coordinates(element));
         return this;
     }
 
     @Override
-    protected PageScreenshot self() {
+    protected PageSnapshot self() {
         return this;
     }
 

src/main/java/com/assertthat/selenium_screenshotter/core/PageScreenshot.java renamed to src/main/java/com/assertthat/shutterbug/core/PageSnapshot.java

@@ -1,27 +1,27 @@
-package com.assertthat.selenium_screenshotter.core;
+package com.assertthat.shutterbug.core;
 
-import com.assertthat.selenium_screenshotter.utils.image.ImageProcessor;
-import com.assertthat.selenium_screenshotter.utils.web.Browser;
-import com.assertthat.selenium_screenshotter.utils.web.ScrollStrategy;
+import com.assertthat.shutterbug.utils.image.ImageProcessor;
+import com.assertthat.shutterbug.utils.web.Browser;
+import com.assertthat.shutterbug.utils.web.ScrollStrategy;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
 
 /**
  * Created by Glib_Briia on 26/06/2016.
  */
-public class ScreenshotFactory {
+public class Shutterbug {
 
     /**
      * Make screenshot of the viewport only.
      * To be used when screenshotting the page
      * and don't need to scroll while making screenshots (FF, IE).
      *
      * @param driver WebDriver instance
-     * @return PageScreenshot instance
+     * @return PageSnapshot instance
      */
-    public static PageScreenshot page(WebDriver driver) {
+    public static PageSnapshot shootPage(WebDriver driver) {
         Browser browser = new Browser(driver);
-        PageScreenshot pageScreenshot = new PageScreenshot(driver);
+        PageSnapshot pageScreenshot = new PageSnapshot(driver);
         pageScreenshot.setImage(browser.takeScreenshot());
         return pageScreenshot;
     }
@@ -33,11 +33,11 @@ public static PageScreenshot page(WebDriver driver) {
      *
      * @param driver WebDriver instance
      * @param scroll ScrollStrategy How you need to scroll
-     * @return PageScreenshot instance
+     * @return PageSnapshot instance
      */
-    public static PageScreenshot page(WebDriver driver, ScrollStrategy scroll) {
+    public static PageSnapshot shootPage(WebDriver driver, ScrollStrategy scroll) {
         Browser browser = new Browser(driver);
-        PageScreenshot pageScreenshot = new PageScreenshot(driver);
+        PageSnapshot pageScreenshot = new PageSnapshot(driver);
         switch (scroll) {
             case HORIZONTALLY:
                 pageScreenshot.setImage(browser.takeScreenshotScrollHorizontally());
@@ -56,11 +56,11 @@ public static PageScreenshot page(WebDriver driver, ScrollStrategy scroll) {
      *
      * @param driver  WebDriver instance
      * @param element WebElement instance to be screenshotted
-     * @return ElementScreenshot instance
+     * @return ElementSnapshot instance
      */
-    public static ElementScreenshot element(WebDriver driver, WebElement element) {
+    public static ElementSnapshot shootElement(WebDriver driver, WebElement element) {
         Browser browser = new Browser(driver);
-        ElementScreenshot elementScreenshot = new ElementScreenshot(driver, element);
+        ElementSnapshot elementScreenshot = new ElementSnapshot(driver, element);
         browser.scrollToElement(element);
         elementScreenshot.setImage(browser.takeScreenshot());
         elementScreenshot.setImage(ImageProcessor.getElement(elementScreenshot.getImage(), browser.getBoundingClientRect(element)));

src/main/java/com/assertthat/selenium_screenshotter/core/ScreenshotFactory.java renamed to src/main/java/com/assertthat/shutterbug/core/Shutterbug.java

@@ -1,30 +1,27 @@
-package com.assertthat.selenium_screenshotter.core;
+package com.assertthat.shutterbug.core;
 
-import com.assertthat.selenium_screenshotter.utils.file.FileUtil;
-import com.assertthat.selenium_screenshotter.utils.image.ImageProcessor;
-import com.assertthat.selenium_screenshotter.utils.web.Browser;
-import com.assertthat.selenium_screenshotter.utils.web.ScrollStrategy;
+import com.assertthat.shutterbug.utils.file.FileUtil;
+import com.assertthat.shutterbug.utils.image.ImageProcessor;
 import org.openqa.selenium.WebDriver;
-import org.openqa.selenium.WebElement;
 
 import java.awt.*;
 import java.awt.image.BufferedImage;
 import java.io.File;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import java.time.LocalDateTime;
-import java.time.format.DateTimeFormatter;
+import java.text.SimpleDateFormat;
+import java.util.Date;
 
 /**
  * Created by Glib_Briia on 17/06/2016.
  */
-public abstract class Screenshot<T extends Screenshot<T>> {
+public abstract class Snapshot<T extends Snapshot> {
 
     private static final String extension = "PNG";
     protected BufferedImage image;
     protected BufferedImage thumbnailImage;
     protected WebDriver driver;
-    private String fileName = LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy_MM_dd_HH_mm_ss_SSS"))
+    private String fileName = new SimpleDateFormat("yyyy_MM_dd_HH_mm_ss_SSS").format(new Date())
             + "." + extension.toLowerCase();
     private Path location = Paths.get("./screenshots/");
     private String title;
@@ -34,7 +31,7 @@ public abstract class Screenshot<T extends Screenshot<T>> {
     /**
      * @param name file name of the resulted image
      *             by default will be timestamp in format: 'yyyy_MM_dd_HH_mm_ss_SSS'.
-     * @return instance of type Screenshot
+     * @return instance of type Snapshot
      */
     public T withName(String name) {
         if (name != null) {
@@ -46,7 +43,7 @@ public T withName(String name) {
     /**
      * @param title title of the resulted image.
      *              Won't be assigned by default.
-     * @return instance of type Screenshot
+     * @return instance of type Snapshot
      */
     public T withTitle(String title) {
         this.title = title;
@@ -61,12 +58,12 @@ public T withTitle(String title) {
      * @param path to save thumbnail image to
      * @param name of the resulting image
      * @param scale to apply
-     * @return instance of type Screenshot
+     * @return instance of type Snapshot
      */
     public T withThumbnail(String path, String name, double scale) {
         File thumbnailFile = new File(path.toString(), name);
         thumbnailFile.mkdirs();
-        thumbnailImage=ImageProcessor.scale(image,0.5);
+        thumbnailImage=ImageProcessor.scale(image,scale);
         FileUtil.writeImage(thumbnailImage, extension, thumbnailFile);
         return self();
     }
@@ -76,7 +73,7 @@ public T withThumbnail(String path, String name, double scale) {
      * Will save different thumbnails depends on when it was called in the chain.
      *
      * @param scale to apply
-     * @return instance of type Screenshot
+     * @return instance of type Snapshot
      */
     public T withThumbnail(double scale) {
         withThumbnail(Paths.get(location.toString(),"./thumbnails").toString(),"thumb_"+fileName,scale);
@@ -86,7 +83,7 @@ public T withThumbnail(double scale) {
     /**
      * Apply gray-and-white filter to the image.
      *
-     * @return instance of type Screenshot
+     * @return instance of type Snapshot
      */
     public T monochrome() {
         this.image = ImageProcessor.convertToGrayAndWhite(this.image);
@@ -134,24 +131,24 @@ public void save(String path) {
      */
     public boolean equals(Object o, double deviation) {
         if (this == o) return true;
-        if (!(o instanceof Screenshot)) return false;
+        if (!(o instanceof Snapshot)) return false;
 
-        Screenshot<?> that = (Screenshot<?>) o;
+        Snapshot that = (Snapshot) o;
 
         return getImage() != null ? ImageProcessor.imagesAreEquals(getImage(), that.getImage(), deviation) : that.getImage() == null;
     }
 
     /**
      * @param o Object to compare with
-     * @return true if the the provided object is of type Screenshot
+     * @return true if the the provided object is of type Snapshot
      * and images are strictly equal.
      */
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
-        if (!(o instanceof Screenshot)) return false;
+        if (!(o instanceof Snapshot)) return false;
 
-        Screenshot<?> that = (Screenshot<?>) o;
+        Snapshot that = (Snapshot) o;
 
         return getImage() != null ? ImageProcessor.imagesAreEquals(getImage(), that.getImage(), 0) : that.getImage() == null;
     }

src/main/java/com/assertthat/selenium_screenshotter/core/Screenshot.java renamed to src/main/java/com/assertthat/shutterbug/core/Snapshot.java

@@ -1,7 +1,7 @@
-package com.assertthat.selenium_screenshotter.utils.file;
+package com.assertthat.shutterbug.utils.file;
 
 
-import com.assertthat.selenium_screenshotter.utils.web.UnableTakeScreenshotException;
+import com.assertthat.shutterbug.utils.web.UnableTakeScreenshotException;
 import org.apache.commons.io.IOUtils;
 
 import javax.imageio.ImageIO;