Add retina support. Fixes #17

Author: inha-briia

src/main/java/com/assertthat/selenium_shutterbug/core/Shutterbug.java

@@ -18,23 +18,36 @@ public class Shutterbug {
     private static final int DEFAULT_SCROLL_TIMEOUT = 100;
 
     /**
-     * Make screenshot of the viewport only.
-     * To be used when screenshotting the page
-     * and don't need to scroll while making screenshots (FF, IE).
+     * Make screen shot of the viewport only.
+     * To be used when screen shooting the page
+     * and don't need to scroll while making screen shots (FF, IE).
      *
      * @param driver WebDriver instance
      * @return PageSnapshot instance
      */
     public static PageSnapshot shootPage(WebDriver driver) {
-        Browser browser = new Browser(driver);
+        return shootPage(driver,false);
+    }
+
+    /**
+     * Make screen shot of the viewport only.
+     * To be used when screen shooting the page
+     * and don't need to scroll while making screen shots (FF, IE).
+     *
+     * @param driver WebDriver instance
+     * @param useDevicePixelRatio whether or not take into account device pixel ratio
+     * @return PageSnapshot instance
+     */
+    public static PageSnapshot shootPage(WebDriver driver, boolean useDevicePixelRatio) {
+        Browser browser = new Browser(driver, useDevicePixelRatio);
         PageSnapshot pageScreenshot = new PageSnapshot(driver);
         pageScreenshot.setImage(browser.takeScreenshot());
         return pageScreenshot;
     }
 
     /**
-     * To be used when screenshotting the page
-     * and need to scroll while making screenshots, either vertically or
+     * To be used when screen shooting the page
+     * and need to scroll while making screen shots, either vertically or
      * horizontally or both directions (Chrome).
      *
      * @param driver WebDriver instance
@@ -46,17 +59,32 @@ public static PageSnapshot shootPage(WebDriver driver, ScrollStrategy scroll) {
     }
 
     /**
-     * To be used when screenshotting the page
-     * and need to scroll while making screenshots, either vertically or
+     * To be used when screen shooting the page
+     * and need to scroll while making screen shots, either vertically or
      * horizontally or both directions (Chrome).
      *
      * @param driver WebDriver instance
      * @param scroll ScrollStrategy How you need to scroll
-     * @param  scrollTimeout Timeout to wait after scrolling and before taking screenshot
+     * @param  scrollTimeout Timeout to wait after scrolling and before taking screen shot
      * @return PageSnapshot instance
      */
     public static PageSnapshot shootPage(WebDriver driver, ScrollStrategy scroll, int scrollTimeout) {
-        Browser browser = new Browser(driver);
+        return shootPage(driver,scroll,scrollTimeout,false);
+    }
+
+    /**
+     * To be used when screen shooting the page
+     * and need to scroll while making screen shots, either vertically or
+     * horizontally or both directions (Chrome).
+     *
+     * @param driver WebDriver instance
+     * @param scroll ScrollStrategy How you need to scroll
+     * @param  scrollTimeout Timeout to wait after scrolling and before taking screen shot
+     * @param useDevicePixelRatio whether or not take into account device pixel ratio
+     * @return PageSnapshot instance
+     */
+    public static PageSnapshot shootPage(WebDriver driver, ScrollStrategy scroll, int scrollTimeout, boolean useDevicePixelRatio) {
+        Browser browser = new Browser(driver, useDevicePixelRatio);
         browser.setScrollTimeout(scrollTimeout);
         PageSnapshot pageScreenshot = new PageSnapshot(driver);
         switch (scroll) {
@@ -80,7 +108,19 @@ public static PageSnapshot shootPage(WebDriver driver, ScrollStrategy scroll, in
      * @return ElementSnapshot instance
      */
     public static ElementSnapshot shootElement(WebDriver driver, WebElement element) {
-        Browser browser = new Browser(driver);
+        return shootElement(driver,element,false);
+    }
+
+    /**
+     * To be used when need to screenshot particular element.
+     *
+     * @param driver  WebDriver instance
+     * @param element WebElement instance to be screen shot
+     * @param useDevicePixelRatio whether or not take into account device pixel ratio
+     * @return ElementSnapshot instance
+     */
+    public static ElementSnapshot shootElement(WebDriver driver, WebElement element, boolean useDevicePixelRatio) {
+        Browser browser = new Browser(driver,useDevicePixelRatio);
         ElementSnapshot elementSnapshot = new ElementSnapshot(driver);
         browser.scrollToElement(element);
         elementSnapshot.setImage(browser.takeScreenshot(),browser.getBoundingClientRect(element));

src/main/java/com/assertthat/selenium_shutterbug/utils/web/Browser.java

@@ -17,6 +17,8 @@
 import java.io.IOException;
 import java.util.ArrayList;
 
+import static java.lang.Math.toIntExact;
+
 /**
  * Created by Glib_Briia on 17/06/2016.
  */
@@ -31,6 +33,7 @@ public class Browser {
     public static final String SCROLL_INTO_VIEW_JS = "js/scroll-element-into-view.js";
     public static final String CURRENT_SCROLL_Y_JS = "js/get-current-scrollY.js";
     public static final String CURRENT_SCROLL_X_JS = "js/get-current-scrollX.js";
+    public static final String DEVICE_PIXEL_RATIO = "js/get-device-pixel-ratio.js";
 
     private WebDriver driver;
     private int docHeight = -1;
@@ -40,9 +43,11 @@ public class Browser {
     private int currentScrollX;
     private int currentScrollY;
     private int scrollTimeout;
+    private Long devicePixelRatio;
 
-    public Browser(WebDriver driver) {
+    public Browser(WebDriver driver, boolean useDevicePixelRatio) {
         this.driver = driver;
+        devicePixelRatio = useDevicePixelRatio?((Long)executeJsScript(DEVICE_PIXEL_RATIO)):1;
     }
 
     public static void wait(int milis) {
@@ -138,27 +143,27 @@ public WebDriver getUnderlyingDriver() {
     }
 
     public int getCurrentScrollX() {
-        return ((Long) executeJsScript(Browser.CURRENT_SCROLL_X_JS)).intValue();
+        return (int)(((Long) executeJsScript(Browser.CURRENT_SCROLL_X_JS))*devicePixelRatio);
     }
 
     public int getCurrentScrollY() {
-        return ((Long) executeJsScript(Browser.CURRENT_SCROLL_Y_JS)).intValue();
+        return (int)(((Long) executeJsScript(Browser.CURRENT_SCROLL_Y_JS))*devicePixelRatio);
     }
 
     public int getDocWidth() {
-        return docWidth != -1 ? docWidth : ((Long) executeJsScript(MAX_DOC_WIDTH_JS)).intValue();
+        return docWidth != -1 ? docWidth : (int)(((Long) executeJsScript(MAX_DOC_WIDTH_JS))*devicePixelRatio);
     }
 
     public int getDocHeight() {
-        return docHeight != -1 ? docHeight : ((Long) executeJsScript(MAX_DOC_HEIGHT_JS)).intValue();
+        return docHeight != -1 ? docHeight : (int)(((Long) executeJsScript(MAX_DOC_HEIGHT_JS))*devicePixelRatio);
     }
 
     public int getViewportWidth() {
-        return viewportWidth != -1 ? viewportWidth : ((Long) executeJsScript(VIEWPORT_WIDTH_JS)).intValue();
+        return viewportWidth != -1 ? viewportWidth : (int)(((Long) executeJsScript(VIEWPORT_WIDTH_JS))*devicePixelRatio);
     }
 
     public int getViewportHeight() {
-        return viewportHeight != -1 ? viewportHeight : ((Long) executeJsScript(VIEWPORT_HEIGHT_JS)).intValue();
+        return viewportHeight != -1 ? viewportHeight : (int)(((Long) executeJsScript(VIEWPORT_HEIGHT_JS)).intValue()*devicePixelRatio);
     }
 
     public Coordinates getBoundingClientRect(WebElement element) {
@@ -174,7 +179,7 @@ public void scrollToElement(WebElement element) {
     }
 
     public void scrollTo(int x, int y) {
-        executeJsScript(SCROLL_TO_JS, x, y);
+        executeJsScript(SCROLL_TO_JS, x/devicePixelRatio, y/devicePixelRatio);
     }
 
     public Object executeJsScript(String filePath, Object... arg) {

src/main/resources/js/get-device-pixel-ratio.js

@@ -0,0 +1 @@
+return window.devicePixelRatio;