Merge pull request #514 from imasahiro/issue512

Make Icon component aspect ratio customizable

Author: kazuki-ma

line-bot-model/src/main/java/com/linecorp/bot/model/message/flex/component/Icon.java

@@ -17,10 +17,11 @@
 package com.linecorp.bot.model.message.flex.component;
 
 import java.net.URI;
+import java.text.DecimalFormat;
+import java.util.function.Supplier;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
-import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
@@ -32,6 +33,7 @@
 
 import lombok.AllArgsConstructor;
 import lombok.Builder;
+import lombok.Getter;
 import lombok.Value;
 
 @JsonTypeName("icon")
@@ -41,20 +43,21 @@
 @AllArgsConstructor(onConstructor = @__(@Deprecated)) // TODO: Remove next release. Use builder() instead.
 @JsonDeserialize(builder = Icon.IconBuilder.class)
 public class Icon implements FlexComponent {
+    @AllArgsConstructor
+    @Getter
     public enum IconAspectRatio {
-        @JsonProperty("1:1")
-        R1TO1,
-        @JsonProperty("2:1")
-        R2TO1,
-        @JsonProperty("3:1")
-        R3TO1,
+        R1TO1("1:1"),
+        R2TO1("2:1"),
+        R3TO1("3:1");
+
+        private final String ratio;
     }
 
     URI url;
 
     FlexFontSize size;
 
-    IconAspectRatio aspectRatio;
+    String aspectRatio;
 
     FlexMarginSize margin;
 
@@ -70,6 +73,8 @@ public enum IconAspectRatio {
 
     @JsonPOJOBuilder(withPrefix = "")
     public static class IconBuilder {
+        private static final Supplier<DecimalFormat> RATIO_FORMAT = () -> new DecimalFormat("0.#####");
+
         public IconBuilder offsetTop(FlexOffsetSize offset) {
             offsetTop = offset.getPropertyValue();
             return this;
@@ -109,5 +114,21 @@ public IconBuilder offsetEnd(String offset) {
             offsetEnd = offset;
             return this;
         }
+
+        public IconBuilder aspectRatio(IconAspectRatio aspectRatio) {
+            this.aspectRatio = aspectRatio.getRatio();
+            return this;
+        }
+
+        public IconBuilder aspectRatio(String aspectRatio) {
+            this.aspectRatio = aspectRatio;
+            return this;
+        }
+
+        public IconBuilder aspectRatio(double width, double height) {
+            final DecimalFormat fmt = RATIO_FORMAT.get();
+            aspectRatio = fmt.format(width) + ':' + fmt.format(height);
+            return this;
+        }
     }
 }

line-bot-model/src/main/java/com/linecorp/bot/model/message/flex/component/Image.java

@@ -18,6 +18,7 @@
 
 import java.net.URI;
 import java.text.DecimalFormat;
+import java.util.function.Supplier;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
@@ -128,7 +129,7 @@ public enum ImageAspectMode {
 
     @JsonPOJOBuilder(withPrefix = "")
     public static class ImageBuilder {
-        private static final DecimalFormat RATIO_FORMAT = new DecimalFormat("0.#####");
+        private static final Supplier<DecimalFormat> RATIO_FORMAT = () -> new DecimalFormat("0.#####");
 
         /**
          * Specify aspect ratio by keyword.
@@ -150,7 +151,8 @@ public ImageBuilder aspectRatio(String aspectRatio) {
          * Specify custom aspect ratio. The width and height are rounded up to 5 decimal places.
          */
         public ImageBuilder aspectRatio(double width, double height) {
-            this.aspectRatio = RATIO_FORMAT.format(width) + ":" + RATIO_FORMAT.format(height);
+            final DecimalFormat fmt = RATIO_FORMAT.get();
+            aspectRatio = fmt.format(width) + ':' + fmt.format(height);
             return this;
         }
 

line-bot-model/src/test/java/com/linecorp/bot/model/message/flex/component/ImageAspectRatioFormatTest.java renamed to line-bot-model/src/test/java/com/linecorp/bot/model/message/flex/component/AspectRatioFormatTest.java

@@ -27,14 +27,15 @@
 import org.junit.runners.Parameterized;
 import org.junit.runners.Parameterized.Parameters;
 
+import com.linecorp.bot.model.message.flex.component.Icon.IconBuilder;
 import com.linecorp.bot.model.message.flex.component.Image.ImageBuilder;
 
 import lombok.AllArgsConstructor;
 import lombok.Value;
 
 @Value
 @RunWith(Parameterized.class)
-public class ImageAspectRatioFormatTest {
+public class AspectRatioFormatTest {
 
     @Value
     @AllArgsConstructor
@@ -44,7 +45,7 @@ public static class Fixture {
         String result;
     }
 
-    private static List<Fixture> VALUES = Arrays.asList(
+    private static final List<Fixture> VALUES = Arrays.asList(
             new Fixture(1, 1, "1:1"),
             new Fixture(1.01, 1.01, "1.01:1.01"),
             new Fixture(100000, 100000, "100000:100000"),
@@ -66,4 +67,13 @@ public void test() {
                         .build();
         assertThat(image.getAspectRatio()).isEqualTo(fixture.getResult());
     }
+
+    @Test
+    public void icon() {
+        final Icon image =
+                new IconBuilder()
+                        .aspectRatio(fixture.getWidth(), fixture.getHeight())
+                        .build();
+        assertThat(image.getAspectRatio()).isEqualTo(fixture.getResult());
+    }
 }