This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-scripting-groovy.git
The following commit(s) were added to refs/heads/master by this push:
new 67c1c4d SLING-8730 Remove all GSP names and references
67c1c4d is described below
commit 67c1c4d7fa70fc6b47cf35aa4eece3eed81fae15
Author: Oliver Lietz <[email protected]>
AuthorDate: Sun Sep 22 13:31:48 2019 +0200
SLING-8730 Remove all GSP names and references
Scripting Groovy is using the GStringTemplateEngine internally and does not
relate to GSP (Groovy Server Pages) in any way
* changing language name from Groovy Server Pages to Groovy GString
* changing name from GSP to GString
* changing extension from gsp to gst
* removing mime type text/x-gsp
---
README.md | 2 +-
pom.xml | 2 +-
...pScriptEngine.java => GStringScriptEngine.java} | 19 +++++++---------
...actory.java => GStringScriptEngineFactory.java} | 25 ++++++++++------------
...> GStringScriptEngineFactoryConfiguration.java} | 14 ++++++------
.../JsonBuilderBindingsValuesProvider.java | 2 +-
.../scripting/groovy/it/GroovyTestSupport.java | 2 +-
.../scripting/groovy/it/tests/AdaptToModelIT.java | 4 ++--
...ryIT.java => GStringScriptEngineFactoryIT.java} | 6 +++---
.../sling/scripting/groovy/it/tests/SimpleIT.java | 4 ++--
.../groovy/page/adaptto/{html.gsp => html.gst} | 0
.../apps/groovy/page/simple/{html.gsp => html.gst} | 0
src/test/resources/content/groovy.json | 2 +-
13 files changed, 37 insertions(+), 45 deletions(-)
diff --git a/README.md b/README.md
index 932d716..4be833e 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,6 @@
This module is part of the [Apache Sling](https://sling.apache.org) project.
-This bundle provides just the Sling Scripting code. It requires the `groovy`,
`groovy-json` and `groovy-templates` bundles to be installed separately.
+This module provides a script engine for [Sling
Scripting](https://sling.apache.org/documentation/bundles/scripting.html) using
Groovy's
[`GStringTemplateEngine`](http://docs.groovy-lang.org/docs/next/html/documentation/template-engines.html#_gstringtemplateengine).
It requires the `groovy`, `groovy-json` and `groovy-templates` bundles to be
installed separately.
See chapter [Template
engines](http://docs.groovy-lang.org/docs/groovy-latest/html/documentation/#_template_engines)
in Groovy's documentation also.
diff --git a/pom.xml b/pom.xml
index 5a03e5e..2e4bd04 100644
--- a/pom.xml
+++ b/pom.xml
@@ -29,7 +29,7 @@
</parent>
<artifactId>org.apache.sling.scripting.groovy</artifactId>
- <version>1.0.5-SNAPSHOT</version>
+ <version>1.1.0-SNAPSHOT</version>
<name>Apache Sling Scripting Groovy</name>
<description>Support for scripting with Groovy</description>
diff --git
a/src/main/java/org/apache/sling/scripting/groovy/internal/GspScriptEngine.java
b/src/main/java/org/apache/sling/scripting/groovy/internal/GStringScriptEngine.java
similarity index 75%
rename from
src/main/java/org/apache/sling/scripting/groovy/internal/GspScriptEngine.java
rename to
src/main/java/org/apache/sling/scripting/groovy/internal/GStringScriptEngine.java
index bb2f94e..0808f6b 100644
---
a/src/main/java/org/apache/sling/scripting/groovy/internal/GspScriptEngine.java
+++
b/src/main/java/org/apache/sling/scripting/groovy/internal/GStringScriptEngine.java
@@ -28,24 +28,21 @@ import groovy.lang.Writable;
import groovy.text.Template;
import org.apache.sling.scripting.api.AbstractSlingScriptEngine;
-/**
- * The actual GSP Script Engine, which simply wraps Groovy's
- */
-public class GspScriptEngine extends AbstractSlingScriptEngine {
+public class GStringScriptEngine extends AbstractSlingScriptEngine {
- private final GspScriptEngineFactory gspScriptEngineFactory;
+ private final GStringScriptEngineFactory scriptEngineFactory;
- public GspScriptEngine(final GspScriptEngineFactory
gspScriptEngineFactory) {
- super(gspScriptEngineFactory);
- this.gspScriptEngineFactory = gspScriptEngineFactory;
+ GStringScriptEngine(final GStringScriptEngineFactory
gStringScriptEngineFactory) {
+ super(gStringScriptEngineFactory);
+ this.scriptEngineFactory = gStringScriptEngineFactory;
}
public Object eval(final Reader reader, final ScriptContext scriptContext)
throws ScriptException {
- Template template;
+ final Template template;
try {
- template =
gspScriptEngineFactory.getTemplateEngine().createTemplate(reader);
+ template =
scriptEngineFactory.getTemplateEngine().createTemplate(reader);
} catch (IOException | ClassNotFoundException e) {
- throw new ScriptException("Unable to compile GSP script: " +
e.getMessage());
+ throw new ScriptException("Unable to compile GString template: " +
e.getMessage());
}
final Bindings bindings =
scriptContext.getBindings(ScriptContext.ENGINE_SCOPE);
diff --git
a/src/main/java/org/apache/sling/scripting/groovy/internal/GspScriptEngineFactory.java
b/src/main/java/org/apache/sling/scripting/groovy/internal/GStringScriptEngineFactory.java
similarity index 85%
rename from
src/main/java/org/apache/sling/scripting/groovy/internal/GspScriptEngineFactory.java
rename to
src/main/java/org/apache/sling/scripting/groovy/internal/GStringScriptEngineFactory.java
index 614d708..fdacffc 100644
---
a/src/main/java/org/apache/sling/scripting/groovy/internal/GspScriptEngineFactory.java
+++
b/src/main/java/org/apache/sling/scripting/groovy/internal/GStringScriptEngineFactory.java
@@ -41,20 +41,17 @@ import org.osgi.service.metatype.annotations.Designate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/**
- * Script engine for Groovy Server Pages.
- */
@Component(
service = ScriptEngineFactory.class,
property = {
- Constants.SERVICE_DESCRIPTION + "=Apache Sling Scripting Groovy GSP
ScriptEngineFactory",
+ Constants.SERVICE_DESCRIPTION + "=Apache Sling Scripting Groovy
GString ScriptEngineFactory",
Constants.SERVICE_VENDOR + "=The Apache Software Foundation"
}
)
@Designate(
- ocd = GspScriptEngineFactoryConfiguration.class
+ ocd = GStringScriptEngineFactoryConfiguration.class
)
-public class GspScriptEngineFactory extends AbstractScriptEngineFactory {
+public class GStringScriptEngineFactory extends AbstractScriptEngineFactory {
@Reference(
policy = ReferencePolicy.DYNAMIC,
@@ -62,7 +59,7 @@ public class GspScriptEngineFactory extends
AbstractScriptEngineFactory {
)
private volatile DynamicClassLoaderManager dynamicClassLoaderManager;
- private GspScriptEngineFactoryConfiguration configuration;
+ private GStringScriptEngineFactoryConfiguration configuration;
private BundleContext bundleContext;
@@ -70,13 +67,13 @@ public class GspScriptEngineFactory extends
AbstractScriptEngineFactory {
private ServiceRegistration<TemplateEngine> serviceRegistration;
- private final Logger logger =
LoggerFactory.getLogger(GspScriptEngineFactory.class);
+ private final Logger logger =
LoggerFactory.getLogger(GStringScriptEngineFactory.class);
- public GspScriptEngineFactory() {
+ public GStringScriptEngineFactory() {
}
@Activate
- private void activate(final GspScriptEngineFactoryConfiguration
configuration, final BundleContext bundleContext) {
+ private void activate(final GStringScriptEngineFactoryConfiguration
configuration, final BundleContext bundleContext) {
logger.debug("activating");
this.configuration = configuration;
this.bundleContext = bundleContext;
@@ -86,7 +83,7 @@ public class GspScriptEngineFactory extends
AbstractScriptEngineFactory {
}
@Modified
- private void modified(final GspScriptEngineFactoryConfiguration
configuration) {
+ private void modified(final GStringScriptEngineFactoryConfiguration
configuration) {
logger.debug("modifying");
this.configuration = configuration;
configure(configuration);
@@ -100,7 +97,7 @@ public class GspScriptEngineFactory extends
AbstractScriptEngineFactory {
bundleContext = null;
}
- private void configure(final GspScriptEngineFactoryConfiguration
configuration) {
+ private void configure(final GStringScriptEngineFactoryConfiguration
configuration) {
setExtensions(configuration.extensions());
setMimeTypes(configuration.mimeTypes());
setNames(configuration.names());
@@ -108,7 +105,7 @@ public class GspScriptEngineFactory extends
AbstractScriptEngineFactory {
@Override
public String getLanguageName() {
- return "Groovy Server Pages";
+ return "Groovy GString";
}
@Override
@@ -118,7 +115,7 @@ public class GspScriptEngineFactory extends
AbstractScriptEngineFactory {
@Override
public ScriptEngine getScriptEngine() {
- return new GspScriptEngine(this);
+ return new GStringScriptEngine(this);
}
private void registerTemplateEngine() {
diff --git
a/src/main/java/org/apache/sling/scripting/groovy/internal/GspScriptEngineFactoryConfiguration.java
b/src/main/java/org/apache/sling/scripting/groovy/internal/GStringScriptEngineFactoryConfiguration.java
similarity index 88%
rename from
src/main/java/org/apache/sling/scripting/groovy/internal/GspScriptEngineFactoryConfiguration.java
rename to
src/main/java/org/apache/sling/scripting/groovy/internal/GStringScriptEngineFactoryConfiguration.java
index 3892887..4098d1d 100644
---
a/src/main/java/org/apache/sling/scripting/groovy/internal/GspScriptEngineFactoryConfiguration.java
+++
b/src/main/java/org/apache/sling/scripting/groovy/internal/GStringScriptEngineFactoryConfiguration.java
@@ -20,10 +20,10 @@ import
org.osgi.service.metatype.annotations.AttributeDefinition;
import org.osgi.service.metatype.annotations.ObjectClassDefinition;
@ObjectClassDefinition(
- name = "Apache Sling Scripting Groovy GSP ScriptEngineFactory",
+ name = "Apache Sling Scripting Groovy GString ScriptEngineFactory",
description = "Script engine factory for Groovy's GString template engine."
)
-@interface GspScriptEngineFactoryConfiguration {
+@interface GStringScriptEngineFactoryConfiguration {
@AttributeDefinition(
name = "service ranking",
@@ -36,24 +36,22 @@ import
org.osgi.service.metatype.annotations.ObjectClassDefinition;
description = "The extensions this script engine is registered for."
)
String[] extensions() default {
- "gsp"
+ "gst"
};
@AttributeDefinition(
name = "mime types",
description = "The MIME (content) types this script engine is
registered for."
)
- String[] mimeTypes() default {
- "text/x-gsp"
- };
+ String[] mimeTypes() default {};
@AttributeDefinition(
name = "names",
description = "The names under which this script engine is registered."
)
String[] names() default {
- "GSP",
- "gsp"
+ "GString",
+ "gstring"
};
}
diff --git
a/src/main/java/org/apache/sling/scripting/groovy/internal/JsonBuilderBindingsValuesProvider.java
b/src/main/java/org/apache/sling/scripting/groovy/internal/JsonBuilderBindingsValuesProvider.java
index 2b10d0b..f824657 100644
---
a/src/main/java/org/apache/sling/scripting/groovy/internal/JsonBuilderBindingsValuesProvider.java
+++
b/src/main/java/org/apache/sling/scripting/groovy/internal/JsonBuilderBindingsValuesProvider.java
@@ -29,7 +29,7 @@ import org.osgi.service.component.annotations.Component;
immediate = true,
service = BindingsValuesProvider.class,
property = {
- "javax.script.name=gsp",
+ "javax.script.name=gstring",
"service.description=Groovy JsonBuilder BindingsValuesProvider",
"service.vendor=The Apache Software Foundation"
diff --git
a/src/test/java/org/apache/sling/scripting/groovy/it/GroovyTestSupport.java
b/src/test/java/org/apache/sling/scripting/groovy/it/GroovyTestSupport.java
index f612f40..0788681 100644
--- a/src/test/java/org/apache/sling/scripting/groovy/it/GroovyTestSupport.java
+++ b/src/test/java/org/apache/sling/scripting/groovy/it/GroovyTestSupport.java
@@ -63,7 +63,7 @@ public class GroovyTestSupport extends TestSupport {
protected HttpService httpService;
@Inject
- @Filter(value = "(names=gsp)")
+ @Filter(value = "(names=GString)")
protected ScriptEngineFactory scriptEngineFactory;
@Inject
diff --git
a/src/test/java/org/apache/sling/scripting/groovy/it/tests/AdaptToModelIT.java
b/src/test/java/org/apache/sling/scripting/groovy/it/tests/AdaptToModelIT.java
index 742bd23..aced412 100644
---
a/src/test/java/org/apache/sling/scripting/groovy/it/tests/AdaptToModelIT.java
+++
b/src/test/java/org/apache/sling/scripting/groovy/it/tests/AdaptToModelIT.java
@@ -48,7 +48,7 @@ public class AdaptToModelIT extends GroovyTestSupport {
private Document document;
@Inject
- @Filter(value = "(path=/apps/groovy/page/adaptto/html.gsp)")
+ @Filter(value = "(path=/apps/groovy/page/adaptto/html.gst)")
private ResourcePresence resourcePresence;
@Configuration
@@ -56,7 +56,7 @@ public class AdaptToModelIT extends GroovyTestSupport {
return new Option[]{
baseConfiguration(),
factoryConfiguration("org.apache.sling.resource.presence.internal.ResourcePresenter")
- .put("path", "/apps/groovy/page/adaptto/html.gsp")
+ .put("path", "/apps/groovy/page/adaptto/html.gst")
.asOption(),
};
}
diff --git
a/src/test/java/org/apache/sling/scripting/groovy/it/tests/GspScriptEngineFactoryIT.java
b/src/test/java/org/apache/sling/scripting/groovy/it/tests/GStringScriptEngineFactoryIT.java
similarity index 93%
rename from
src/test/java/org/apache/sling/scripting/groovy/it/tests/GspScriptEngineFactoryIT.java
rename to
src/test/java/org/apache/sling/scripting/groovy/it/tests/GStringScriptEngineFactoryIT.java
index 3cebdd0..d242c3f 100644
---
a/src/test/java/org/apache/sling/scripting/groovy/it/tests/GspScriptEngineFactoryIT.java
+++
b/src/test/java/org/apache/sling/scripting/groovy/it/tests/GStringScriptEngineFactoryIT.java
@@ -35,7 +35,7 @@ import static org.junit.Assert.assertThat;
@RunWith(PaxExam.class)
@ExamReactorStrategy(PerClass.class)
-public class GspScriptEngineFactoryIT extends GroovyTestSupport {
+public class GStringScriptEngineFactoryIT extends GroovyTestSupport {
@Configuration
public Option[] configuration() {
@@ -56,7 +56,7 @@ public class GspScriptEngineFactoryIT extends
GroovyTestSupport {
@Test
public void testScriptEngineFactoryLanguageName() {
- assertThat(scriptEngineFactory.getLanguageName(), is("Groovy Server
Pages"));
+ assertThat(scriptEngineFactory.getLanguageName(), is("Groovy
GString"));
}
@Test
@@ -66,7 +66,7 @@ public class GspScriptEngineFactoryIT extends
GroovyTestSupport {
@Test
public void testScriptEngineFactoryNames() {
- assertThat(scriptEngineFactory.getNames(), hasItem("gsp"));
+ assertThat(scriptEngineFactory.getNames(), hasItem("GString"));
}
}
diff --git
a/src/test/java/org/apache/sling/scripting/groovy/it/tests/SimpleIT.java
b/src/test/java/org/apache/sling/scripting/groovy/it/tests/SimpleIT.java
index 9f7a6e8..fe71538 100644
--- a/src/test/java/org/apache/sling/scripting/groovy/it/tests/SimpleIT.java
+++ b/src/test/java/org/apache/sling/scripting/groovy/it/tests/SimpleIT.java
@@ -48,7 +48,7 @@ public class SimpleIT extends GroovyTestSupport {
private Document document;
@Inject
- @Filter(value = "(path=/apps/groovy/page/simple/html.gsp)")
+ @Filter(value = "(path=/apps/groovy/page/simple/html.gst)")
private ResourcePresence resourcePresence;
@Configuration
@@ -56,7 +56,7 @@ public class SimpleIT extends GroovyTestSupport {
return new Option[]{
baseConfiguration(),
factoryConfiguration("org.apache.sling.resource.presence.internal.ResourcePresenter")
- .put("path", "/apps/groovy/page/simple/html.gsp")
+ .put("path", "/apps/groovy/page/simple/html.gst")
.asOption(),
};
}
diff --git a/src/test/resources/apps/groovy/page/adaptto/html.gsp
b/src/test/resources/apps/groovy/page/adaptto/html.gst
similarity index 100%
rename from src/test/resources/apps/groovy/page/adaptto/html.gsp
rename to src/test/resources/apps/groovy/page/adaptto/html.gst
diff --git a/src/test/resources/apps/groovy/page/simple/html.gsp
b/src/test/resources/apps/groovy/page/simple/html.gst
similarity index 100%
rename from src/test/resources/apps/groovy/page/simple/html.gsp
rename to src/test/resources/apps/groovy/page/simple/html.gst
diff --git a/src/test/resources/content/groovy.json
b/src/test/resources/content/groovy.json
index 6af671e..8e84ed4 100644
--- a/src/test/resources/content/groovy.json
+++ b/src/test/resources/content/groovy.json
@@ -2,7 +2,7 @@
"jcr:primaryType": "nt:unstructured",
"sling:resourceType": "groovy/page/main",
"sling:resourceSuperType": "groovy/page",
- "title": "Apache Sling Scripting Groovy",
+ "title": "Apache Sling Scripting Groovy GString",
"simple": {
"jcr:primaryType": "nt:unstructured",
"sling:resourceType": "groovy/page/simple",
