introduce downloadable sprites

.github/workflows/build.yml

@@ -24,16 +24,16 @@ jobs:
           server-password: MAVEN_CENTRAL_TOKEN
 
       - name: Build Project
-        run: mvn -B -ntp clean verify -f emoji
+        run: mvn -B -ntp clean verify
 
       - name: Publish Snapshots
         if: github.ref == 'refs/heads/main'
         run: |
           # Find version
-          ver=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout -f emoji)
+          ver=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
           if [[ $ver == *"SNAPSHOT"* ]]
           then
-              mvn -B -ntp clean deploy -f emoji
+              mvn -B -ntp clean deploy -pl 'emoji, offline'
           fi
         shell: bash
         env:

.github/workflows/release.yml

@@ -37,7 +37,7 @@ jobs:
       - name: Publish Release
         id: deploy
         run: |
-          mvn -B -ntp clean deploy -f emoji -Prelease
+          mvn -B -ntp clean deploy -Prelease -pl 'emoji, offline'
           echo ::set-output name=exit_code::$?
         env:
           MAVEN_USERNAME: ${{ secrets.SONATYPE_USERNAME }}

README.md

@@ -85,7 +85,7 @@ Use the emoji dependency in a Maven project:
 
 ```
 <dependency>
-    <groupId>com.gluonhq</groupId>
+    <groupId>com.gluonhq.emoji</groupId>
     <artifactId>emoji</artifactId>
     <version>${version}</version>
 </dependency>
@@ -97,7 +97,27 @@ Manually build the emoji artifact:
 mvn clean install -f emoji
 ```
 
-### samples
+### Offline
+Emojis are extracted from sprites which are downloaded and stored in local file system to reduce the size of the application.
+In cases where downloading of these sprites is not possible, the offline module can be added as a dependency.
+
+```
+<dependency>
+    <groupId>com.gluonhq.emoji</groupId>
+    <artifactId>offline</artifactId>
+    <version>${version}</version>
+</dependency>
+```
+
+Manually build the offline artifact:
+
+```
+mvn clean install -f offline
+```
+
+### Samples
+
+#### Nodes App
 Simple JavaFX application that displays all emojis.
 This application can be considered as a playground to test emoji and its APIs.
 
@@ -107,21 +127,21 @@ Each emoji is an ImageView and shows the description of the emoji on hover:
 
 ![emoji-sample-hover.png](.github/assets/emoji-sample-hover.png)
 
-Run the sample application:
+Run the sample nodes application:
 
 ```
-mvn javafx:run -f samples
+mvn javafx:run -f samples/nodes
 ```
 
-### emoji-updater
+### Updater
 Utility to manually update Emoji to the latest emoji data, whenever a new version is released.
 Normally, this will be used by the library developers, but in case we are falling behind, you can use it too ;)
 
 To update the emoji list, set the [commit number](https://github.com/gluonhq/emoji/blob/main/emoji-updater/src/main/java/com/gluonhq/emoji/tools/Main.java#L39)
 from [emoji-data](https://github.com/iamcal/emoji-data) and run:
 
 ```
-mvn javafx:run -f emoji-updater
+mvn javafx:run -f updater
 ```
 
 ## Contribution

emoji/pom.xml

@@ -1,22 +1,15 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
     <modelVersion>4.0.0</modelVersion>
-    <groupId>com.gluonhq</groupId>
     <artifactId>emoji</artifactId>
-    <version>1.0.2-SNAPSHOT</version>
-
-    <name>emoji-core</name>
+    <name>Emoji Core</name>
     <description>Emoji support for JavaFX</description>
-    <inceptionYear>2019</inceptionYear>
-    <url>https://github.com/gluonhq/emoji</url>
 
-    <properties>
-        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <maven.compiler.release>11</maven.compiler.release>
-        <javafx.version>20</javafx.version>
-        <javadoc.plugin.version>3.1.0</javadoc.plugin.version>
-        <gpg.plugin.version>1.6</gpg.plugin.version>
-    </properties>
+    <parent>
+        <groupId>com.gluonhq.emoji</groupId>
+        <artifactId>parent</artifactId>
+        <version>1.0.2-SNAPSHOT</version>
+    </parent>
 
     <dependencies>
         <dependency>
@@ -39,140 +32,4 @@
         </dependency>
     </dependencies>
 
-    <build>
-        <plugins>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.8.1</version>
-            </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-surefire-plugin</artifactId>
-                <version>3.0.0-M6</version>
-                <configuration>
-                    <forkCount>0</forkCount>
-                </configuration>
-            </plugin>
-        </plugins>
-    </build>
-
-    <pluginRepositories>
-        <pluginRepository>
-            <id>Snapshots</id>
-            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
-        </pluginRepository>
-    </pluginRepositories>
-
-    <profiles>
-        <profile>
-            <id>release</id>
-            <build>
-                <plugins>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-source-plugin</artifactId>
-                        <version>2.2.1</version>
-                        <executions>
-                            <execution>
-                                <id>attach-sources</id>
-                                <goals>
-                                    <goal>jar-no-fork</goal>
-                                </goals>
-                            </execution>
-                        </executions>
-                    </plugin>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-javadoc-plugin</artifactId>
-                        <version>${javadoc.plugin.version}</version>
-                        <executions>
-                            <execution>
-                                <id>attach-javadocs</id>
-                                <goals>
-                                    <goal>jar</goal>
-                                </goals>
-                            </execution>
-                        </executions>
-                        <configuration>
-                            <doclint>none</doclint>
-                        </configuration>
-                    </plugin>
-                    <plugin>
-                        <groupId>org.apache.maven.plugins</groupId>
-                        <artifactId>maven-gpg-plugin</artifactId>
-                        <version>${gpg.plugin.version}</version>
-                        <executions>
-                            <execution>
-                                <id>sign-artifacts</id>
-                                <phase>verify</phase>
-                                <goals>
-                                    <goal>sign</goal>
-                                </goals>
-                                <configuration>
-                                    <!-- This is necessary for gpg to not try to use the pinentry programs -->
-                                    <!-- Only required for GPG >= 2.2 -->
-                                    <gpgArguments>
-                                      <arg>--pinentry-mode</arg>
-                                      <arg>loopback</arg>
-                                    </gpgArguments>
-                                </configuration>
-                            </execution>
-                        </executions>
-                    </plugin>
-                </plugins>
-            </build>
-        </profile>
-    </profiles>
-
-    <organization>
-        <name>Gluon</name>
-        <url>https://gluonhq.com</url>
-    </organization>
-
-    <issueManagement>
-        <system>GitHub</system>
-        <url>https://github.com/gluonhq/emoji/issues</url>
-    </issueManagement>
-
-    <licenses>
-        <license>
-            <name>GNU GENERAL PUBLIC LICENSE, Version 3</name>
-            <url>http://www.gnu.org/licenses/gpl-3.0.html</url>
-            <distribution>repo</distribution>
-        </license>
-    </licenses>
-
-    <developers>
-        <developer>
-            <name>Abhinay Agarwal</name>
-            <email>abhinay.agarwal@gluonhq.com</email>
-            <organization>Gluon</organization>
-            <organizationUrl>https://www.gluonhq.com</organizationUrl>
-        </developer>
-        <developer>
-            <name>José Pereda</name>
-            <email>jose.pereda@gluonhq.com</email>
-            <organization>Gluon</organization>
-            <organizationUrl>https://www.gluonhq.com</organizationUrl>
-        </developer>
-    </developers>
-
-    <scm>
-        <url>https://github.com/gluonhq/emoji</url>
-        <connection>scm:git:git://github.com/gluonhq/emoji.git</connection>
-        <developerConnection>scm:git:ssh://git@github.com:gluonhq/emoji.git</developerConnection>
-    </scm>
-
-    <distributionManagement>
-        <snapshotRepository>
-            <id>ossrh</id>
-            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
-        </snapshotRepository>
-        <repository>
-            <id>ossrh</id>
-            <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
-        </repository>
-    </distributionManagement>
-
-</project>
+</project>

emoji/src/main/java/com/gluonhq/emoji/DownloadableEmojiSpriteLoader.java

@@ -0,0 +1,104 @@
+package com.gluonhq.emoji;
+
+import javafx.scene.image.Image;
+
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.nio.channels.Channels;
+import java.nio.channels.FileChannel;
+import java.nio.channels.ReadableByteChannel;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.concurrent.CompletableFuture;
+import java.util.logging.Logger;
+
+public class DownloadableEmojiSpriteLoader implements EmojiSpriteLoader {
+
+    private static final Logger LOG = Logger.getLogger(DownloadableEmojiSpriteLoader.class.getName());
+
+    private static final String COMMIT_NUMBER = "063f328d7951cb2e2a6678b06dcbdf8dd599fad7"; // tag 15.0.1
+    private static final String EMOJI_PNG_URL = "https://github.com/iamcal/emoji-data/blob/" + COMMIT_NUMBER + "/sheets-clean/sheet_apple_%s_clean.png?raw=true";
+
+    private static final String LOCAL_PATH = System.getProperty("user.home") + "/.gluon/emoji/" + COMMIT_NUMBER;
+    private static final int[] EMOJI_SIZES = new int[] { 20, 32, 64 };
+    private boolean initialized;
+
+    @Override
+    public boolean isInitialized() {
+        if (!initialized) {
+            for (int size : EMOJI_SIZES) {
+                String fileName = "sheet_apple_" + size + ".png";
+                if (!Files.exists(Paths.get(LOCAL_PATH, fileName))) {
+                    return false;
+                }
+            }
+        }
+        return initialized = true;
+    }
+
+    @Override
+    public CompletableFuture<Boolean> initialize() {
+        return CompletableFuture.supplyAsync(() -> {
+            try {
+                downloadSprites(EMOJI_SIZES);
+                initialized = true;
+                return true;
+            } catch (Exception e) {
+                return false;
+            }
+        });
+    }
+
+    private void downloadSprites(int... sizes) {
+        for (int size : sizes) {
+            String fileName = "sheet_apple_" + size + ".png";
+            Path localPath = Paths.get(LOCAL_PATH, fileName);
+            try {
+                if (!Files.exists(localPath)) {
+                    LOG.fine("Download sprite file for size: " + size);
+                    downloadFile(new URI(String.format(EMOJI_PNG_URL, size)).toURL(), localPath);
+                }
+            } catch (IOException | URISyntaxException e) {
+                LOG.severe("Download sprite failed: " + e);
+                throw new RuntimeException("Unable to load local image file", e);
+            }
+        }
+    }
+
+    public Image loadEmojiSprite(int size) {
+        if (!initialized) {
+            throw new RuntimeException("Sprite Loader hasn't been initialized or completed initialization");
+        }
+        String fileName = "sheet_apple_" + size + ".png";
+        Path localPath = Paths.get(LOCAL_PATH, fileName);
+        try {
+            return new Image(new FileInputStream(localPath.toFile()));
+        } catch (IOException e) {
+            LOG.severe("Loading of local image file failed: " + e);
+            throw new RuntimeException("Unable to load local image file", e);
+        }
+    }
+
+    @Override
+    public InputStream loadCSV() {
+        return DownloadableEmojiSpriteLoader.class.getResourceAsStream("emoji.csv");
+    }
+
+    private void downloadFile(URL url, Path filePath) throws IOException {
+        Path parentDir = filePath.getParent();
+        if (parentDir != null && !Files.exists(parentDir)) {
+            Files.createDirectories(parentDir);
+        }
+        ReadableByteChannel readableByteChannel = Channels.newChannel(url.openStream());
+        try (FileOutputStream fileOutputStream = new FileOutputStream(filePath.toFile());
+             FileChannel fileChannel = fileOutputStream.getChannel()) {
+            fileChannel.transferFrom(readableByteChannel, 0, Long.MAX_VALUE);
+        }
+    }
+}

emoji/src/main/java/com/gluonhq/emoji/EmojiData.java

@@ -67,7 +67,7 @@ public class EmojiData {
 
     static {
         // See emoji-updater module on how to get and update this csv file
-        try (final InputStream emojiStream = EmojiData.class.getResourceAsStream("emoji.csv");
+        try (final InputStream emojiStream = EmojiLoaderFactory.getEmojiImageLoader().loadCSV();
              Scanner scanner = new Scanner(Objects.requireNonNull(emojiStream))) {
             while (scanner.hasNextLine()) {
                 String line = scanner.nextLine();