You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@freemarker.apache.org by sg...@apache.org on 2021/02/03 17:00:01 UTC

[freemarker-generator] branch FREEMARKER-172 updated: FREEMARKER-172 [freemarker-generator] Start with refactoring

This is an automated email from the ASF dual-hosted git repository.

sgoeschl pushed a commit to branch FREEMARKER-172
in repository https://gitbox.apache.org/repos/asf/freemarker-generator.git


The following commit(s) were added to refs/heads/FREEMARKER-172 by this push:
     new 32b6b26  FREEMARKER-172 [freemarker-generator] Start with refactoring
32b6b26 is described below

commit 32b6b26cb01b9a6ed7c7a8c1e00861c88138d55f
Author: Siegfried Goeschl <si...@gmail.com>
AuthorDate: Wed Feb 3 17:59:45 2021 +0100

    FREEMARKER-172 [freemarker-generator] Start with refactoring
---
 .../loader/EnvironmentDataSourceLoader.java        |   2 +-
 .../datasource/loader/FileDataSourceLoader.java    |   5 +-
 .../datasource/loader/HttpDataSourceLoader.java    |   4 +-
 .../generator/datasource/DataSourceLoaderTest.java | 134 +++++++++++++++++++++
 4 files changed, 140 insertions(+), 5 deletions(-)

diff --git a/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/datasource/loader/EnvironmentDataSourceLoader.java b/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/datasource/loader/EnvironmentDataSourceLoader.java
index 61403e8..fece4a6 100644
--- a/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/datasource/loader/EnvironmentDataSourceLoader.java
+++ b/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/datasource/loader/EnvironmentDataSourceLoader.java
@@ -47,7 +47,7 @@ public class EnvironmentDataSourceLoader implements DataSourceLoader {
 
     @Override
     public boolean accept(String source) {
-        return isNotEmpty(source) && source.startsWith("env://");
+        return isNotEmpty(source) && source.contains("env://");
     }
 
     @Override
diff --git a/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/datasource/loader/FileDataSourceLoader.java b/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/datasource/loader/FileDataSourceLoader.java
index 211713a..55676a9 100644
--- a/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/datasource/loader/FileDataSourceLoader.java
+++ b/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/datasource/loader/FileDataSourceLoader.java
@@ -28,6 +28,7 @@ import javax.activation.FileDataSource;
 import java.io.File;
 import java.nio.charset.Charset;
 
+import static java.nio.charset.StandardCharsets.UTF_8;
 import static org.apache.freemarker.generator.base.FreeMarkerConstants.DEFAULT_GROUP;
 import static org.apache.freemarker.generator.base.util.StringUtils.isNotEmpty;
 
@@ -37,14 +38,14 @@ public class FileDataSourceLoader implements DataSourceLoader {
 
     @Override
     public boolean accept(String source) {
-        return isNotEmpty(source) && (!source.contains("://") || source.startsWith("file://"));
+        return isNotEmpty(source) && (!source.contains("://") || source.contains("file://"));
     }
 
     @Override
     public DataSource load(String source) {
         final NamedUri namedUri = NamedUriStringParser.parse(source);
         final String group = namedUri.getGroupOrElse(DEFAULT_GROUP);
-        final Charset charset = namedUri.getCharset();
+        final Charset charset = namedUri.getCharsetOrElse(UTF_8);
         final File file = namedUri.getFile();
         final String name = namedUri.getNameOrElse(UriUtils.toStringWithoutFragment(file.toURI()));
         return fromFile(name, group, file, charset);
diff --git a/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/datasource/loader/HttpDataSourceLoader.java b/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/datasource/loader/HttpDataSourceLoader.java
index f931474..687b6ff 100644
--- a/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/datasource/loader/HttpDataSourceLoader.java
+++ b/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/datasource/loader/HttpDataSourceLoader.java
@@ -36,7 +36,7 @@ public class HttpDataSourceLoader implements DataSourceLoader {
 
     @Override
     public boolean accept(String source) {
-        return isNotEmpty(source) && (source.startsWith("http://") || source.startsWith("https://"));
+        return isNotEmpty(source) && (source.contains("http://") || source.contains("https://"));
     }
 
     @Override
@@ -44,7 +44,7 @@ public class HttpDataSourceLoader implements DataSourceLoader {
         final NamedUri namedUri = NamedUriStringParser.parse(source);
         final URI uri = namedUri.getUri();
         final String group = namedUri.getGroupOrElse(DEFAULT_GROUP);
-        final Charset charset = namedUri.getCharset();
+        final Charset charset = namedUri.getCharsetOrElse(null);
         final String mimeType = namedUri.getMimeType();
         final URL url = toUrl(uri);
         final String name = namedUri.getNameOrElse(UriUtils.toStringWithoutFragment(uri));
diff --git a/freemarker-generator-base/src/test/java/org/apache/freemarker/generator/datasource/DataSourceLoaderTest.java b/freemarker-generator-base/src/test/java/org/apache/freemarker/generator/datasource/DataSourceLoaderTest.java
new file mode 100644
index 0000000..0659965
--- /dev/null
+++ b/freemarker-generator-base/src/test/java/org/apache/freemarker/generator/datasource/DataSourceLoaderTest.java
@@ -0,0 +1,134 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.freemarker.generator.datasource;
+
+import org.apache.commons.io.FilenameUtils;
+import org.apache.freemarker.generator.base.datasource.DataSource;
+import org.apache.freemarker.generator.base.datasource.DataSourceLoader;
+import org.apache.freemarker.generator.base.datasource.loader.DefaultDataSourceLoader;
+import org.apache.freemarker.generator.base.datasource.loader.EnvironmentDataSourceLoader;
+import org.apache.freemarker.generator.base.datasource.loader.FileDataSourceLoader;
+import org.apache.freemarker.generator.base.datasource.loader.HttpDataSourceLoader;
+import org.junit.Ignore;
+import org.junit.Test;
+
+import java.io.File;
+import java.util.Arrays;
+
+import static java.lang.String.format;
+import static java.nio.charset.StandardCharsets.UTF_8;
+import static junit.framework.TestCase.assertFalse;
+import static org.apache.freemarker.generator.base.mime.Mimetypes.MIME_APPLICATION_XML;
+import static org.junit.Assert.assertEquals;
+
+public class DataSourceLoaderTest {
+
+    private static final String PWD = FilenameUtils.separatorsToUnix(new File("").getAbsolutePath());
+    private static final String ANY_FILE_NAME = "pom.xml";
+    private static final String ANY_FILE_URI = format("file:///%s/pom.xml", PWD);
+    private static final String ANY_HTTP_URL = "https://jsonplaceholder.typicode.com/posts/2";
+    private static final File ANY_FILE = new File(ANY_FILE_NAME);
+    private static final String ANY_NAMED_URL_STRING = "content:www=https://www.google.com?foo=bar#contenttype=application/json";
+
+    @Test
+    public void shouldLoadDataSourceFromFile() {
+        try (DataSource dataSource = dataSourceLoader().load(ANY_FILE_NAME)) {
+            assertEquals(ANY_FILE_NAME, dataSource.getFileName());
+            assertEquals(UTF_8, dataSource.getCharset());
+            assertEquals(MIME_APPLICATION_XML, dataSource.getContentType());
+            assertEquals(ANY_FILE.toURI(), dataSource.getUri());
+            assertFalse(dataSource.getLines().isEmpty());
+        }
+    }
+
+    @Test
+    public void shouldLoadDataSourceFromFileUri() {
+        try (DataSource dataSource = dataSourceLoader().load(ANY_FILE_URI)) {
+            assertEquals(ANY_FILE_NAME, dataSource.getFileName());
+            assertEquals(UTF_8, dataSource.getCharset());
+            assertEquals(MIME_APPLICATION_XML, dataSource.getContentType());
+            assertEquals(ANY_FILE.toURI(), dataSource.getUri());
+            assertFalse(dataSource.getLines().isEmpty());
+        }
+    }
+
+    @Test
+    @Ignore
+    public void shouldCreateDataSourceFromUrl() {
+        try (DataSource dataSource = dataSourceLoader().load(ANY_HTTP_URL)) {
+            assertEquals("https://jsonplaceholder.typicode.com/posts/2", dataSource.getName());
+            assertEquals("application/json; charset=utf-8", dataSource.getContentType());
+            assertEquals(UTF_8, dataSource.getCharset());
+        }
+    }
+
+    @Test
+    @Ignore
+    public void shouldCreateDataSourceFromNamedURL() {
+        try (DataSource dataSource = dataSourceLoader().load(ANY_NAMED_URL_STRING)) {
+            assertEquals("content", dataSource.getName());
+            assertEquals("www", dataSource.getGroup());
+            assertEquals("text/html; charset=ISO-8859-1", dataSource.getContentType());
+            assertEquals("ISO-8859-1", dataSource.getCharset().toString());
+            assertEquals("https://www.google.com?foo=bar#contenttype=application/json", dataSource.getUri().toString());
+        }
+    }
+
+    @Test
+    public void shouldCreateDataSourceFromEnvironment() {
+        try (DataSource dataSource = dataSourceLoader().load("env:///")) {
+            assertEquals("env", dataSource.getName());
+            assertEquals("default", dataSource.getGroup());
+            assertEquals(UTF_8, dataSource.getCharset());
+            assertEquals("env:///", dataSource.getUri().toString());
+            assertEquals("text/plain", dataSource.getContentType());
+        }
+    }
+
+    @Test
+    public void shouldCreateDataSourceFromNamedEnvironment() {
+        try (DataSource dataSource = dataSourceLoader().load("config=env:///")) {
+            assertEquals("config", dataSource.getName());
+            assertEquals("default", dataSource.getGroup());
+            assertEquals(UTF_8, dataSource.getCharset());
+            assertEquals("env:///", dataSource.getUri().toString());
+            assertEquals("text/plain", dataSource.getContentType());
+        }
+    }
+
+    @Test
+    public void shouldCreateDataSourceFromEnvironmentVariable() {
+        try (DataSource dataSource = dataSourceLoader().load("myenv=env:///HOME")) {
+            assertEquals("myenv", dataSource.getName());
+            assertEquals("default", dataSource.getGroup());
+            assertEquals(UTF_8, dataSource.getCharset());
+            assertEquals("env:///HOME", dataSource.getUri().toString());
+            assertEquals("text/plain", dataSource.getContentType());
+        }
+    }
+
+    private DataSourceLoader dataSourceLoader() {
+        return new DefaultDataSourceLoader(
+                Arrays.asList(
+                        new FileDataSourceLoader(),
+                        new HttpDataSourceLoader(),
+                        new EnvironmentDataSourceLoader()
+                )
+        );
+    }
+
+}