Use devicePixelRatio for element operations

glibas · glibas · commit dfe23ac32251 · 2018-07-09T23:03:17.000+01:00
diff --git a/src/main/java/com/assertthat/selenium_shutterbug/core/ElementSnapshot.java b/src/main/java/com/assertthat/selenium_shutterbug/core/ElementSnapshot.java
@@ -19,8 +19,9 @@
  */
 public class ElementSnapshot extends Snapshot {
 
-    ElementSnapshot(WebDriver driver) {
+    ElementSnapshot(WebDriver driver, Double devicePixelRatio) {
         this.driver = driver;
+        this.devicePixelRatio = devicePixelRatio;
     }
 
     protected void setImage(BufferedImage image, Coordinates coords) {
diff --git a/src/main/java/com/assertthat/selenium_shutterbug/core/PageSnapshot.java b/src/main/java/com/assertthat/selenium_shutterbug/core/PageSnapshot.java
@@ -19,8 +19,9 @@
  */
 public class PageSnapshot extends Snapshot {
 
-    PageSnapshot(WebDriver driver) {
+    PageSnapshot(WebDriver driver, Double devicePixelRatio) {
         this.driver = driver;
+        this.devicePixelRatio = devicePixelRatio;
     }
 
     /**
@@ -50,7 +51,7 @@ public PageSnapshot highlight(WebElement element) {
      */
     public PageSnapshot highlight(WebElement element, Color color, int lineWidth) {
         try {
-            image = ImageProcessor.highlight(image, new Coordinates(element), color, lineWidth);
+            image = ImageProcessor.highlight(image, new Coordinates(element, devicePixelRatio), color, lineWidth);
         } catch (RasterFormatException rfe) {
             throw new ElementOutsideViewportException(ELEMENT_OUT_OF_VIEWPORT_EX_MESSAGE, rfe);
         }
@@ -91,7 +92,7 @@ public PageSnapshot highlightWithText(WebElement element, String text) {
     public PageSnapshot highlightWithText(WebElement element, Color elementColor, int lineWidth, String text, Color textColor, Font textFont) {
        try {
            highlight(element, elementColor, 0);
-           Coordinates coords = new Coordinates(element);
+           Coordinates coords = new Coordinates(element, devicePixelRatio);
            image = ImageProcessor.addText(image, coords.getX(), coords.getY() - textFont.getSize() / 2, text, textColor, textFont);
        } catch (RasterFormatException rfe) {
            throw new ElementOutsideViewportException(ELEMENT_OUT_OF_VIEWPORT_EX_MESSAGE, rfe);
@@ -117,7 +118,7 @@ public PageSnapshot blur() {
      */
     public PageSnapshot blur(WebElement element) {
         try {
-            image = ImageProcessor.blurArea(image, new Coordinates(element));
+            image = ImageProcessor.blurArea(image, new Coordinates(element, devicePixelRatio));
         }catch(RasterFormatException rfe) {
             throw new ElementOutsideViewportException(ELEMENT_OUT_OF_VIEWPORT_EX_MESSAGE, rfe);
         }
@@ -133,7 +134,7 @@ public PageSnapshot blur(WebElement element) {
      */
     public PageSnapshot monochrome(WebElement element) {
         try {
-            image = ImageProcessor.monochromeArea(image, new Coordinates(element));
+            image = ImageProcessor.monochromeArea(image, new Coordinates(element,devicePixelRatio));
         } catch (RasterFormatException rfe) {
             throw new ElementOutsideViewportException(ELEMENT_OUT_OF_VIEWPORT_EX_MESSAGE, rfe);
         }
@@ -148,7 +149,7 @@ public PageSnapshot monochrome(WebElement element) {
      */
     public PageSnapshot blurExcept(WebElement element) {
         try{
-            image = ImageProcessor.blurExceptArea(image, new Coordinates(element));
+            image = ImageProcessor.blurExceptArea(image, new Coordinates(element,devicePixelRatio));
         }catch(RasterFormatException rfe){
             throw new ElementOutsideViewportException(ELEMENT_OUT_OF_VIEWPORT_EX_MESSAGE,rfe);
         }
@@ -165,7 +166,7 @@ public PageSnapshot blurExcept(WebElement element) {
      */
     public PageSnapshot cropAround(WebElement element, int offsetX, int offsetY) {
         try{
-            image = ImageProcessor.cropAround(image, new Coordinates(element), offsetX, offsetY);
+            image = ImageProcessor.cropAround(image, new Coordinates(element,devicePixelRatio), offsetX, offsetY);
         }catch(RasterFormatException rfe){
             throw new ElementOutsideViewportException(ELEMENT_OUT_OF_VIEWPORT_EX_MESSAGE,rfe);
         }
diff --git a/src/main/java/com/assertthat/selenium_shutterbug/core/Shutterbug.java b/src/main/java/com/assertthat/selenium_shutterbug/core/Shutterbug.java
@@ -40,7 +40,7 @@ public static PageSnapshot shootPage(WebDriver driver) {
      */
     public static PageSnapshot shootPage(WebDriver driver, boolean useDevicePixelRatio) {
         Browser browser = new Browser(driver, useDevicePixelRatio);
-        PageSnapshot pageScreenshot = new PageSnapshot(driver);
+        PageSnapshot pageScreenshot = new PageSnapshot(driver,browser.getDevicePixelRatio());
         pageScreenshot.setImage(browser.takeScreenshot());
         return pageScreenshot;
     }
@@ -86,7 +86,7 @@ public static PageSnapshot shootPage(WebDriver driver, ScrollStrategy scroll, in
     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);
+        PageSnapshot pageScreenshot = new PageSnapshot(driver, browser.getDevicePixelRatio());
         switch (scroll) {
             case HORIZONTALLY:
                 pageScreenshot.setImage(browser.takeScreenshotScrollHorizontally());
@@ -120,8 +120,8 @@ public static ElementSnapshot shootElement(WebDriver driver, WebElement element)
      * @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 browser = new Browser(driver, useDevicePixelRatio);
+        ElementSnapshot elementSnapshot = new ElementSnapshot(driver, browser.getDevicePixelRatio());
         browser.scrollToElement(element);
         elementSnapshot.setImage(browser.takeScreenshot(),browser.getBoundingClientRect(element));
         return elementSnapshot;
diff --git a/src/main/java/com/assertthat/selenium_shutterbug/core/Snapshot.java b/src/main/java/com/assertthat/selenium_shutterbug/core/Snapshot.java
@@ -28,6 +28,7 @@ public abstract class Snapshot<T extends Snapshot> {
     protected BufferedImage image;
     protected BufferedImage thumbnailImage;
     protected WebDriver driver;
+    protected Double devicePixelRatio = 1D;
     private String fileName = new SimpleDateFormat("yyyy_MM_dd_HH_mm_ss_SSS").format(new Date())
             + "." + EXTENSION.toLowerCase();
     private Path location = Paths.get("./screenshots/");
diff --git a/src/main/java/com/assertthat/selenium_shutterbug/utils/image/ImageProcessor.java b/src/main/java/com/assertthat/selenium_shutterbug/utils/image/ImageProcessor.java
@@ -46,7 +46,6 @@ public static BufferedImage addText(BufferedImage sourceImage, int x, int y, Str
         Graphics2D g = sourceImage.createGraphics();
         g.setPaint(color);
         g.setFont(font);
-        FontMetrics fm = g.getFontMetrics();
         g.drawString(text, x, y);
         g.dispose();
         return sourceImage;
diff --git a/src/main/java/com/assertthat/selenium_shutterbug/utils/web/Browser.java b/src/main/java/com/assertthat/selenium_shutterbug/utils/web/Browser.java
@@ -51,6 +51,10 @@ public Browser(WebDriver driver, boolean useDevicePixelRatio) {
         }
     }
 
+    public Double getDevicePixelRatio() {
+        return devicePixelRatio;
+    }
+
     public static void wait(int milis) {
         try {
             Thread.sleep(milis);
@@ -178,7 +182,7 @@ public Coordinates getBoundingClientRect(WebElement element) {
         ArrayList<String> list = (ArrayList<String>) executeJsScript(RELATIVE_COORDS_JS, element);
         Point start = new Point(Integer.parseInt(list.get(0)), Integer.parseInt(list.get(1)));
         Dimension size = new Dimension(Integer.parseInt(list.get(2)), Integer.parseInt(list.get(3)));
-        return new Coordinates(start, size);
+        return new Coordinates(start, size, devicePixelRatio);
     }
 
     public void scrollToElement(WebElement element) {
diff --git a/src/main/java/com/assertthat/selenium_shutterbug/utils/web/Coordinates.java b/src/main/java/com/assertthat/selenium_shutterbug/utils/web/Coordinates.java
@@ -19,20 +19,20 @@ public class Coordinates {
     private int x;
     private int y;
 
-    public Coordinates(WebElement element) {
+    public Coordinates(WebElement element, Double devicePixelRatio) {
         Point point = element.getLocation();
         Dimension size = element.getSize();
-        this.width = size.getWidth();
-        this.height = size.getHeight();
-        this.x = point.getX();
-        this.y = point.getY();
+        this.width = (int)(size.getWidth()*devicePixelRatio);
+        this.height = (int)(size.getHeight()*devicePixelRatio);
+        this.x = (int)(point.getX()*devicePixelRatio);
+        this.y = (int)(point.getY()*devicePixelRatio);
     }
 
-    public Coordinates(Point point, Dimension size) {
-        this.width = size.getWidth();
-        this.height = size.getHeight();
-        this.x = point.getX();
-        this.y = point.getY();
+    public Coordinates(Point point, Dimension size, Double devicePixelRatio) {
+        this.width = (int)(size.getWidth()*devicePixelRatio);
+        this.height = (int)(size.getHeight()*devicePixelRatio);
+        this.x = (int)(point.getX()*devicePixelRatio);
+        this.y = (int)(point.getY()*devicePixelRatio);
     }
 
 
diff --git a/src/test/java/com/assertthat/selenium_shutterbug/utils/image/ImageProcessorTest.java b/src/test/java/com/assertthat/selenium_shutterbug/utils/image/ImageProcessorTest.java
@@ -79,7 +79,7 @@ public void testImagesAreEqualsWithDeviation() throws IOException {
     public void testHighlight() throws IOException {
         Point point = new Point(9,33);
         Dimension size = new Dimension(141,17);
-        Coordinates coords = new Coordinates(point, size);
+        Coordinates coords = new Coordinates(point, size, 1D);
         BufferedImage clearImage = ImageIO.read(Thread.currentThread().getContextClassLoader().getResourceAsStream("clearImage.png"));
         BufferedImage highlightedExpectedImage = ImageIO.read(Thread.currentThread().getContextClassLoader().getResourceAsStream("highlightedImage.png"));
         BufferedImage highlightedActualImage = ImageProcessor.highlight(clearImage, coords, Color.red, 3);

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,9 @@`
`19`	`19`	`*/`
`20`	`20`	`public class ElementSnapshot extends Snapshot {`
`21`	`21`
`22`		`- ElementSnapshot(WebDriver driver) {`
	`22`	`+ ElementSnapshot(WebDriver driver, Double devicePixelRatio) {`
`23`	`23`	`this.driver = driver;`
	`24`	`+ this.devicePixelRatio = devicePixelRatio;`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`protected void setImage(BufferedImage image, Coordinates coords) {`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,10 @@ public Browser(WebDriver driver, boolean useDevicePixelRatio) {`
`51`	`51`	`}`
`52`	`52`	`}`
`53`	`53`
	`54`	`+ public Double getDevicePixelRatio() {`
	`55`	`+ return devicePixelRatio;`
	`56`	`+ }`
	`57`	`+`
`54`	`58`	`public static void wait(int milis) {`
`55`	`59`	`try {`
`56`	`60`	`Thread.sleep(milis);`
`@@ -178,7 +182,7 @@ public Coordinates getBoundingClientRect(WebElement element) {`
`178`	`182`	`ArrayList<String> list = (ArrayList<String>) executeJsScript(RELATIVE_COORDS_JS, element);`
`179`	`183`	`Point start = new Point(Integer.parseInt(list.get(0)), Integer.parseInt(list.get(1)));`
`180`	`184`	`Dimension size = new Dimension(Integer.parseInt(list.get(2)), Integer.parseInt(list.get(3)));`
`181`		`- return new Coordinates(start, size);`
	`185`	`+ return new Coordinates(start, size, devicePixelRatio);`
`182`	`186`	`}`
`183`	`187`
`184`	`188`	`public void scrollToElement(WebElement element) {`