You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ro...@apache.org on 2018/03/24 22:51:55 UTC
[sling-whiteboard] branch master updated: Initial commit of a
Markdown-based resource provider
This is an automated email from the ASF dual-hosted git repository.
rombert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git
The following commit(s) were added to refs/heads/master by this push:
new e23e019 Initial commit of a Markdown-based resource provider
e23e019 is described below
commit e23e01939c9f4870b3dcbaaa309f599fb811c852
Author: Robert Munteanu <ro...@apache.org>
AuthorDate: Sun Mar 25 00:49:07 2018 +0200
Initial commit of a Markdown-based resource provider
---
mdresourceprovider/LICENSE | 201 +++++++++++++++++++++
mdresourceprovider/README.md | 6 +
mdresourceprovider/bnd.bnd | 3 +
mdresourceprovider/pom.xml | 95 ++++++++++
.../sling/mdresource/impl/MarkdownResource.java | 152 ++++++++++++++++
.../mdresource/impl/MarkdownResourceProvider.java | 141 +++++++++++++++
.../impl/MarkdownResourceProviderTest.java | 110 +++++++++++
.../impl/RegisterMarkdownResourcePlugin.java | 43 +++++
.../md-test/child-listing/comments/index.md | 3 +
.../test/resources/md-test/child-listing/index.md | 3 +
.../test/resources/md-test/child-listing/news.md | 3 +
.../test/resources/md-test/child-listing/spam.md | 3 +
.../resources/md-test/child-listing/spam/index.md | 3 +
.../src/test/resources/md-test/index.md | 3 +
14 files changed, 769 insertions(+)
diff --git a/mdresourceprovider/LICENSE b/mdresourceprovider/LICENSE
new file mode 100644
index 0000000..261eeb9
--- /dev/null
+++ b/mdresourceprovider/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
diff --git a/mdresourceprovider/README.md b/mdresourceprovider/README.md
new file mode 100644
index 0000000..b73aa49
--- /dev/null
+++ b/mdresourceprovider/README.md
@@ -0,0 +1,6 @@
+# Apache Sling Markdown Resource Provider
+
+This module is part of the [Apache Sling](https://sling.apache.org) project.
+
+It contains a work-in-progress markdown resource provider. The code is only lightly tested and meant as a proof-of-content
+for now, and the only thing worse that the code is the documentation.
diff --git a/mdresourceprovider/bnd.bnd b/mdresourceprovider/bnd.bnd
new file mode 100644
index 0000000..7194627
--- /dev/null
+++ b/mdresourceprovider/bnd.bnd
@@ -0,0 +1,3 @@
+# TODO - optimise ; would use Conditional-Package but it does not include all content
+# of com.vladsch.flexmark.ast, which is split between the two jars
+Private-Package: com.vladsch.flexmark.*;-split-package:=merge-first
diff --git a/mdresourceprovider/pom.xml b/mdresourceprovider/pom.xml
new file mode 100644
index 0000000..2109f48
--- /dev/null
+++ b/mdresourceprovider/pom.xml
@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!-- 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. -->
+<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>
+ <parent>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>sling</artifactId>
+ <version>33</version>
+ </parent>
+
+ <artifactId>org.apache.sling.mdresourceprovider</artifactId>
+ <version>0.0.1-SNAPSHOT</version>
+
+ <name>Apache Sling Markdown Resource Provider</name>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>biz.aQute.bnd</groupId>
+ <artifactId>bnd-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>run-bnd</id>
+ <goals>
+ <goal>bnd-process</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.api</artifactId>
+ <version>2.11.0</version>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.service.component.annotations</artifactId>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.service.metatype.annotations</artifactId>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>com.vladsch.flexmark</groupId>
+ <artifactId>flexmark</artifactId>
+ <version>0.32.18</version>
+ <scope>provided</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.testing.sling-mock</artifactId>
+ <version>2.2.6</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.testing.logging-mock</artifactId>
+ <version>2.0.0</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.testing.hamcrest</artifactId>
+ <version>1.0.2</version>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+ <properties>
+ <sling.java.version>8</sling.java.version>
+ </properties>
+</project>
\ No newline at end of file
diff --git a/mdresourceprovider/src/main/java/org/apache/sling/mdresource/impl/MarkdownResource.java b/mdresourceprovider/src/main/java/org/apache/sling/mdresource/impl/MarkdownResource.java
new file mode 100644
index 0000000..4a6e83e
--- /dev/null
+++ b/mdresourceprovider/src/main/java/org/apache/sling/mdresource/impl/MarkdownResource.java
@@ -0,0 +1,152 @@
+/*
+ * 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.sling.mdresource.impl;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.util.HashMap;
+import java.util.Map;
+
+import org.apache.sling.api.resource.AbstractResource;
+import org.apache.sling.api.resource.ResourceMetadata;
+import org.apache.sling.api.resource.ResourceResolver;
+import org.apache.sling.api.resource.ValueMap;
+import org.apache.sling.api.wrappers.ValueMapDecorator;
+
+import com.vladsch.flexmark.ast.Heading;
+import com.vladsch.flexmark.ast.Node;
+import com.vladsch.flexmark.ast.util.TextCollectingVisitor;
+import com.vladsch.flexmark.html.HtmlRenderer;
+import com.vladsch.flexmark.parser.Parser;
+
+public class MarkdownResource extends AbstractResource {
+
+ private final ResourceResolver resolver;
+ private final String path;
+ private final File backingFile;
+ private ValueMap valueMap;
+ private ResourceMetadata metadata;
+
+ public MarkdownResource(ResourceResolver resourceResolver, String path, File backingFile) {
+ this.resolver = resourceResolver;
+ this.path = path;
+ this.backingFile = backingFile;
+ }
+
+ @Override
+ public String getPath() {
+ return path;
+ }
+
+ @Override
+ public String getResourceType() {
+ return getValueMap().get("sling:resourceType", String.class);
+ }
+
+ @Override
+ public String getResourceSuperType() {
+ return getValueMap().get("sling:resourceSuperType", String.class);
+ }
+
+ @Override
+ public ResourceMetadata getResourceMetadata() {
+ if ( metadata == null ) {
+ metadata = getResourceMetadata0();
+ }
+ return metadata;
+ }
+
+ private ResourceMetadata getResourceMetadata0() {
+ if ( !backingFile.exists() || !backingFile.canRead() ) {
+ return null;
+ }
+
+ ResourceMetadata metadata = new ResourceMetadata();
+ metadata.setModificationTime(backingFile.lastModified());
+ metadata.setResolutionPath(path);
+ return metadata;
+ }
+
+ @Override
+ public ResourceResolver getResourceResolver() {
+ return resolver;
+ }
+
+ @Override
+ public ValueMap getValueMap() {
+ if (valueMap == null) {
+ valueMap = getValueMap0();
+ }
+
+ return valueMap;
+ }
+
+ private ValueMap getValueMap0() {
+ if ( !backingFile.exists() || !backingFile.canRead() ) {
+ return null;
+ }
+
+ Parser parser = Parser.builder().build();
+ HtmlRenderer htmlRenderer = HtmlRenderer.builder().build();
+ TextCollectingVisitor visitor = new TextCollectingVisitor();
+
+ Map<String, Object> props = new HashMap<>();
+ // TODO - do we need the primary type?
+ // TODO - allow reading properties from the file, overriding default for resource type
+ props.put("sling:resourceType", "sling/markdown/file");
+
+ try {
+ try ( BufferedReader r = Files.newBufferedReader(backingFile.toPath())) {
+
+ Node node = parser.parseReader(r);
+ Node maybeTitle = node.getFirstChild();
+ // TODO - what to do if no title is found?
+ if ( maybeTitle instanceof Heading ) {
+ props.put("jcr:title", visitor.collectAndGetText(maybeTitle));
+ node = maybeTitle.getNext();
+ }
+ // TODO parse excluding the title
+ props.put("jcr:description", htmlRenderer.render(node));
+
+ }
+ } catch (IOException e) {
+ // TODO - handle errors someplace else?
+ throw new RuntimeException(e);
+ }
+
+ return new ValueMapDecorator(props);
+ }
+
+ @SuppressWarnings("unchecked")
+ public <T> T adaptTo(Class<T> type) {
+ if ( type == ValueMap.class ) {
+ return (T) getValueMap();
+ }
+
+ return null;
+ }
+
+ @Override
+ public String toString() {
+
+ return getClass().getSimpleName() + ", path: " + path;
+ }
+}
diff --git a/mdresourceprovider/src/main/java/org/apache/sling/mdresource/impl/MarkdownResourceProvider.java b/mdresourceprovider/src/main/java/org/apache/sling/mdresource/impl/MarkdownResourceProvider.java
new file mode 100644
index 0000000..3e30f52
--- /dev/null
+++ b/mdresourceprovider/src/main/java/org/apache/sling/mdresource/impl/MarkdownResourceProvider.java
@@ -0,0 +1,141 @@
+/*
+ * 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.sling.mdresource.impl;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Iterator;
+import java.util.stream.Collectors;
+
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.spi.resource.provider.ResolveContext;
+import org.apache.sling.spi.resource.provider.ResourceContext;
+import org.apache.sling.spi.resource.provider.ResourceProvider;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.ConfigurationPolicy;
+import org.osgi.service.metatype.annotations.AttributeDefinition;
+import org.osgi.service.metatype.annotations.Designate;
+import org.osgi.service.metatype.annotations.ObjectClassDefinition;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Component(
+ service = ResourceProvider.class,
+ configurationPolicy = ConfigurationPolicy.REQUIRE
+)
+@Designate(ocd = MarkdownResourceProvider.Config.class, factory = true)
+public class MarkdownResourceProvider extends ResourceProvider<Object> {
+
+ @ObjectClassDefinition(name = "Apache Sling Markdown Resource Provider")
+ public @interface Config {
+
+ @AttributeDefinition(name="File system root",
+ description="Filesystem directory mapped to the virtual resource tree. Expects a file named 'index.md' in order to provide resources")
+ String provider_file();
+
+ @AttributeDefinition(name = "Provider Root",
+ description = "Location in the virtual resource tree where the " +
+ "file system resources are mapped in. This property must not be an empty string.")
+ String provider_root();
+
+ // Internal Name hint for web console.
+ String webconsole_configurationFactory_nameHint() default "{" + ResourceProvider.PROPERTY_ROOT + "}";
+ }
+
+ private final Logger log = LoggerFactory.getLogger(getClass());
+
+ private String fsPath;
+ private String repoPath;
+
+ protected void activate(Config cfg) {
+
+ fsPath = cfg.provider_file();
+ repoPath = cfg.provider_root();
+ }
+
+ @Override
+ public Resource getResource(ResolveContext<Object> ctx, String path, ResourceContext resourceContext,
+ Resource parent) {
+
+ log.info("getResource(" + path + ")");
+
+ // try .md file first
+ Path filePath = Paths.get(fsPath, path + ".md");
+ File backingFile = filePath.toFile();
+ if ( !backingFile.exists() ) {
+ log.info("File at " + filePath + " does not exist");
+ // try /index.md next
+ filePath = Paths.get(fsPath, path, "index.md");
+ backingFile = filePath.toFile();
+ if ( !backingFile.exists() ) {
+ log.info("File at " + filePath + " does not exist");
+ log.info("Returning null");
+ return null;
+ }
+ }
+
+ log.info("Returning resource");
+ return new MarkdownResource(ctx.getResourceResolver(), path, backingFile);
+ }
+
+ @Override
+ public Iterator<Resource> listChildren(ResolveContext<Object> ctx, Resource parent) {
+ log.info("listChildren(" + parent.getPath() + ")");
+
+ Path root = Paths.get(fsPath, parent.getPath());
+
+ try {
+ return Files.list(root)
+ .map( p -> asResource(p, Paths.get(parent.getPath()), ctx))
+ .filter( r -> r != null )
+ .collect(Collectors.toList())
+ .iterator();
+ } catch (IOException e) {
+ // TODO better place for exception?
+ throw new RuntimeException(e);
+ }
+ }
+
+ private Resource asResource(Path path, Path parent, ResolveContext<Object> ctx) {
+ File backingFile = path.toFile();
+ if ( backingFile.isFile() && backingFile.canRead() && backingFile.getName().endsWith(".md") && !backingFile.getName().equals("index.md")) {
+ return asResource0(path, parent, ctx, backingFile);
+ }
+
+ if ( backingFile.isDirectory() ) {
+ backingFile = new File(backingFile, "index.md");
+ if ( backingFile.exists() && backingFile.canRead() ) {
+ return asResource0(path, parent, ctx, backingFile);
+ }
+ }
+
+ return null;
+ }
+
+ private Resource asResource0(Path path, Path parent, ResolveContext<Object> ctx, File backingFile) {
+ Path fsRelativePath = Paths.get(fsPath).relativize(path);
+ Path parentRelativePath = Paths.get("/").relativize(parent);
+
+ return new MarkdownResource(ctx.getResourceResolver(), "/" + fsRelativePath.toString().replaceAll("\\.md$", ""), backingFile);
+ }
+
+}
diff --git a/mdresourceprovider/src/test/java/org/apache/sling/mdresource/impl/MarkdownResourceProviderTest.java b/mdresourceprovider/src/test/java/org/apache/sling/mdresource/impl/MarkdownResourceProviderTest.java
new file mode 100644
index 0000000..6bbe0da
--- /dev/null
+++ b/mdresourceprovider/src/test/java/org/apache/sling/mdresource/impl/MarkdownResourceProviderTest.java
@@ -0,0 +1,110 @@
+/*
+ * 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.sling.mdresource.impl;
+
+import static org.hamcrest.Matchers.equalTo;
+import static org.hamcrest.Matchers.hasItem;
+import static org.hamcrest.Matchers.hasItems;
+import static org.hamcrest.Matchers.hasSize;
+import static org.hamcrest.Matchers.notNullValue;
+import static org.junit.Assert.assertThat;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ValueMap;
+import org.apache.sling.testing.mock.sling.ResourceResolverType;
+import org.apache.sling.testing.mock.sling.junit.SlingContext;
+import org.apache.sling.testing.mock.sling.junit.SlingContextBuilder;
+import org.junit.Rule;
+import org.junit.Test;
+
+public class MarkdownResourceProviderTest {
+
+ @Rule
+ public SlingContext context =
+ new SlingContextBuilder(ResourceResolverType.JCR_MOCK)
+ .plugin(new RegisterMarkdownResourcePlugin()).build();
+
+ @Test
+ public void loadSingleResourceFromRoot() {
+
+ Resource resource = context.resourceResolver().getResource("/md-test");
+ assertThat("resource", resource, notNullValue());
+ assertThat("resource.getValueMap()", resource.getValueMap(), notNullValue());
+ assertThat("resource.getMetadata()", resource.getResourceMetadata(), notNullValue());
+ assertThat("resource.getMetadata().getPath()", resource.getResourceMetadata().getResolutionPath(), equalTo("/md-test"));
+
+ assertThat("valueMap[jcr:title]", resource.getValueMap().get("jcr:title", String.class), equalTo("Simple markdown file"));
+ assertThat("valueMap[jcr:description]", resource.getValueMap().get("jcr:description", String.class),
+ equalTo("<p>This is an example of a simple markdown file</p>\n"));
+ assertThat("valueMap[sling:resourceType]", resource.getValueMap().get("sling:resourceType", String.class),
+ equalTo("sling/markdown/file"));
+
+ ValueMap adapted = resource.adaptTo(ValueMap.class);
+ assertThat("adapted ValueMap", adapted, notNullValue());
+ // TODO - more valueMap tests
+ }
+
+ @Test
+ public void childResourceIsListed() {
+
+ Resource root = context.resourceResolver().getResource("/");
+ Iterator<Resource> children = context.resourceResolver().listChildren(root);
+ List<String> paths = new ArrayList<>();
+ while ( children.hasNext() ) {
+ paths.add(children.next().getPath());
+ }
+
+ assertThat(paths, hasItem("/md-test"));
+ }
+
+ @Test
+ public void listChildren() {
+
+ Resource resource = context.resourceResolver().getResource("/md-test/child-listing");
+
+ List<Resource> children = new ArrayList<>();
+ resource.getChildren().forEach( children::add );
+
+ assertThat("children", children, hasSize(3));
+ assertThat("children.paths",
+ children.stream().map( r -> r.getPath()).collect(Collectors.toList()),
+ hasItems("/md-test/child-listing/news", "/md-test/child-listing/spam", "/md-test/child-listing/comments"));
+
+ Resource newsResource = children.stream()
+ .filter( r -> r.getPath().equals("/md-test/child-listing/spam") )
+ .findFirst()
+ .get();
+
+ assertThat("newsResource.valueMap[jcr:title]", newsResource.getValueMap().get("jcr:title", String.class), equalTo("Spam (correct)"));
+
+ }
+
+ // TODO - more tests
+ // - file with just a title
+ // - empty file
+ // - missing file
+ // - file with just a description
+ // - listing children ( files and folders )
+ // - listing children ( folders overrides file ( log warning ?)
+}
diff --git a/mdresourceprovider/src/test/java/org/apache/sling/mdresource/impl/RegisterMarkdownResourcePlugin.java b/mdresourceprovider/src/test/java/org/apache/sling/mdresource/impl/RegisterMarkdownResourcePlugin.java
new file mode 100644
index 0000000..7d40d0b
--- /dev/null
+++ b/mdresourceprovider/src/test/java/org/apache/sling/mdresource/impl/RegisterMarkdownResourcePlugin.java
@@ -0,0 +1,43 @@
+/*
+ * 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.sling.mdresource.impl;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.apache.sling.testing.mock.osgi.MapUtil;
+import org.apache.sling.testing.mock.osgi.context.AbstractContextPlugin;
+import org.apache.sling.testing.mock.sling.context.SlingContextImpl;
+
+public class RegisterMarkdownResourcePlugin extends AbstractContextPlugin<SlingContextImpl> {
+ private final Map<String, Object> props;
+
+ public RegisterMarkdownResourcePlugin(Object... props) {
+ this.props = MapUtil.toMap(props);
+ }
+
+ @Override
+ public void beforeSetUp(SlingContextImpl context) throws Exception {
+ Map<String, Object> config = new HashMap<>();
+ config.put("provider.file", "src/test/resources");
+ config.put("provider.root", "/md-test");
+ config.putAll(props);
+ context.registerInjectActivateService(new MarkdownResourceProvider(), config);
+ }
+};
\ No newline at end of file
diff --git a/mdresourceprovider/src/test/resources/md-test/child-listing/comments/index.md b/mdresourceprovider/src/test/resources/md-test/child-listing/comments/index.md
new file mode 100644
index 0000000..3ff77ac
--- /dev/null
+++ b/mdresourceprovider/src/test/resources/md-test/child-listing/comments/index.md
@@ -0,0 +1,3 @@
+#Comments
+
+Comments page
\ No newline at end of file
diff --git a/mdresourceprovider/src/test/resources/md-test/child-listing/index.md b/mdresourceprovider/src/test/resources/md-test/child-listing/index.md
new file mode 100644
index 0000000..0ce7557
--- /dev/null
+++ b/mdresourceprovider/src/test/resources/md-test/child-listing/index.md
@@ -0,0 +1,3 @@
+# Index
+
+Index file
\ No newline at end of file
diff --git a/mdresourceprovider/src/test/resources/md-test/child-listing/news.md b/mdresourceprovider/src/test/resources/md-test/child-listing/news.md
new file mode 100644
index 0000000..002a2ff
--- /dev/null
+++ b/mdresourceprovider/src/test/resources/md-test/child-listing/news.md
@@ -0,0 +1,3 @@
+# News
+
+News file
\ No newline at end of file
diff --git a/mdresourceprovider/src/test/resources/md-test/child-listing/spam.md b/mdresourceprovider/src/test/resources/md-test/child-listing/spam.md
new file mode 100644
index 0000000..1ebcc8d
--- /dev/null
+++ b/mdresourceprovider/src/test/resources/md-test/child-listing/spam.md
@@ -0,0 +1,3 @@
+# Spam (incorrect)
+
+This version should not appear, it's shadowed by the folder
\ No newline at end of file
diff --git a/mdresourceprovider/src/test/resources/md-test/child-listing/spam/index.md b/mdresourceprovider/src/test/resources/md-test/child-listing/spam/index.md
new file mode 100644
index 0000000..65c0d4a
--- /dev/null
+++ b/mdresourceprovider/src/test/resources/md-test/child-listing/spam/index.md
@@ -0,0 +1,3 @@
+# Spam (correct)
+
+This is the version that should be resolved.
\ No newline at end of file
diff --git a/mdresourceprovider/src/test/resources/md-test/index.md b/mdresourceprovider/src/test/resources/md-test/index.md
new file mode 100644
index 0000000..8d58cc2
--- /dev/null
+++ b/mdresourceprovider/src/test/resources/md-test/index.md
@@ -0,0 +1,3 @@
+# Simple markdown file
+
+This is an example of a simple markdown file
\ No newline at end of file
--
To stop receiving notification emails like this one, please contact
rombert@apache.org.