Update documentation/clean up configuration format

Resolves #34

Author: acoburn

README.md

@@ -1,6 +1,6 @@
 # static-ldp
 
-A simple way to expose static HTTP assets as a read-only LDP server.
+A simple way to expose static assets as a read-only LDP server.
 
 [![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%205.6-8892BF.svg?style=flat-square)](https://php.net/)
 [![Build Status](https://travis-ci.org/trellis-ldp/static-ldp.svg?branch=master)](https://travis-ci.org/trellis-ldp/static-ldp)
@@ -24,4 +24,53 @@ To install `static-ldp`, follow these steps:
 
 1. clone this repository into a location on a webserver
 2. run `composer install`
-3. copy `config/settings.yml.sample` to `config/settings.yml` and update any values
+3. create a `./config/settings.yml` file like this:
+
+    sourceDirectory: /path/to/data/directory
+
+## Configuration
+
+There are many configuration options available. Only the `sourceDirectory` _must_ be defined.
+Other options include:
+
+    template: default.twig
+
+If you wish to override the HTML template with one of your own design, you can change this
+value to point to a different location. Alternately, you can edit the `default.twig` file
+in the `templates` directory. Though if you plan to customize the template, it is recommended
+that you use a separate file.
+
+    defaultRdfFormat: turtle
+
+For requests without an `Accept` header, this is the RDF format used in responses (for
+`ldp:RDFSource` and `ldp:BasicContainer` resources).
+
+    contentDisposition: false
+
+For `ldp:NonRDFSource` resources, this controls whether to include a `Content-Disposition`
+header in responses.
+
+    validRdfFormats:
+        turtle:
+            mimeType: text/turtle
+            extension: ttl
+        jsonld:
+            mimeType: application/ld+json
+            extension: jsonld
+        ntriples:
+            mimeType: application/n-triples
+            extension: nt
+
+Generally speaking, the RDF formats should not be changed unless there is a need to
+support a serialization that is not included here. The RDF format (e.g. `turtle`,
+`jsonld`) must be an RDF serialization format supported by EasyRdf.
+
+    prefixes:
+        dc: "http://purl.org/dc/terms/"
+        rdf: "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+        ...
+
+The default HTML display template will present IRIs in short (prefixed) form if those
+prefixes are registered. By default a number of common prefixes are included, but
+any prefix may be registered here.
+

config/settings.yml.sample

@@ -1,10 +1,17 @@
 sourceDirectory: /mnt/data/ldp/
 template: default.twig
 defaultRdfFormat: turtle
+contentDisposition: false
 validRdfFormats:
-  - { format: "turtle", mimeType: "text/turtle", extension : "ttl" }
-  - { format: "jsonld", mimeType: "application/ld+json", extension: "jsonld" }
-  - { format: "ntriples", mimeType: "application/n-triples", extension: "nt" }
+  turtle:
+    mimeType: "text/turtle"
+    extension: ttl
+  jsonld:
+    mimeType: "application/ld+json"
+    extension: jsonld
+  ntriples:
+    mimeType: "application/n-triples"
+    extension: nt
 prefixes:
     dc: "http://purl.org/dc/terms/"
     rdf: "http://www.w3.org/1999/02/22-rdf-syntax-ns#"

src/Model/NonRDFSource.php

@@ -35,10 +35,10 @@ public function respond(Application $app, Request $request, array $options = arr
                     $res->headers->set('Digest', "sha1=" . $this->sha1());
                     break;
             }
-            foreach ($this->formats as $type) {
-                $description = $this->path . "." . $type['extension'];
+            foreach ($this->formats as $format => $data) {
+                $description = $this->path . "." . $data['extension'];
                 if (file_exists($description)) {
-                    $link = "<" . $request->getUri().".".$type['extension'].">; rel=\"describedby\"";
+                    $link = "<" . $request->getUri().".".$data['extension'].">; rel=\"describedby\"";
                     $res->headers->set("Link", $link, false);
                 }
             }

src/Model/RDFSource.php

@@ -98,9 +98,9 @@ private function getInputFormat()
     {
         $filenameChunks = explode('.', $this->path);
         $extension = array_pop($filenameChunks);
-        foreach ($this->formats as $type) {
-            if ($type['extension'] == $extension) {
-                return $type['format'];
+        foreach ($this->formats as $format => $data) {
+            if ($data['extension'] == $extension) {
+                return $format;
             }
         }
         return null;

src/Model/Resource.php

@@ -176,9 +176,10 @@ protected function getResponseFormat(Request $request)
         if ($request->headers->has('accept')) {
             $accept = $request->getAcceptableContentTypes();
             foreach ($accept as $item) {
-                $index = array_search($item, array_column($this->formats, 'mimeType'));
-                if ($index !== false) {
-                    return $this->formats[$index]['format'];
+                foreach ($this->formats as $format => $data) {
+                    if ($data['mimeType'] === $item) {
+                        return $format;
+                    }
                 }
                 if (strpos($item, "text/html") !== false) {
                     return "html";
@@ -204,9 +205,10 @@ protected function getResponseMimeType(Request $request)
         if ($request->headers->has('accept')) {
             $accept = $request->getAcceptableContentTypes();
             foreach ($accept as $item) {
-                $index = array_search($item, array_column($this->formats, 'mimeType'));
-                if ($index !== false) {
-                    return $item;
+                foreach ($this->formats as $format => $data) {
+                    if ($data['mimeType'] === $item) {
+                        return $item;
+                    }
                 }
                 if (strpos($item, "text/html") !== false) {
                     return "text/html";

src/TrellisConfiguration.php

@@ -31,26 +31,26 @@ public function getConfigTreeBuilder()
                     ->defaultFalse()
                 ->end()
                 ->arrayNode('validRdfFormats')
+                    ->useAttributeAsKey('format')
                     ->prototype("array")
                         ->children()
-                            ->scalarNode('format')->end()
                             ->scalarNode('mimeType')->end()
                             ->scalarNode('extension')->end()
                         ->end()
                     ->end()
-                    ->defaultValue([[
-                        "format" => "turtle",
-                        "mimeType" => "text/turtle",
-                        "extension" => "ttl"
-                    ], [
-                        "format" => "jsonld",
-                        "mimeType" => "application/ld+json",
-                        "extension" => "jsonld"
-                    ], [
-                        "format" => "ntriples",
-                        "mimeType" => "application/n-triples",
-                        "extension" => "nt"
-                    ]])
+                    ->defaultValue([
+                        "turtle" => [
+                            "mimeType" => "text/turtle",
+                            "extension" => "ttl"
+                        ],
+                        "jsonld" => [
+                            "mimeType" => "application/ld+json",
+                            "extension" => "jsonld"
+                        ],
+                        "ntriples" => [
+                            "mimeType" => "application/n-triples",
+                            "extension" => "nt"
+                        ]])
                 ->end()
                 ->arrayNode('prefixes')
                     ->prototype('scalar')->end()