Minor refactoring, some docu, adjusted composer

Classes/TechDivision/DocViewer/Controller/ModuleController.php

@@ -4,12 +4,10 @@
 /*
  * This file is part of the TechDivision.DocViewer package.
  */
-use TechDivision\DocViewer\Exceptions\PackageNotAccessableException;
+use TechDivision\DocViewer\Exceptions\PackageNotAccessibleException;
 use TechDivision\DocViewer\Exceptions\ParsingNotAllowedException;
 use TechDivision\DocViewer\File\Parser;
 use TechDivision\DocViewer\File\Tree;
-
-use TechDivision\DocViewer\Util;
 use TYPO3\Flow\Annotations as Flow;
 use TYPO3\Neos\Controller\Module\AbstractModuleController;
 
@@ -92,21 +90,22 @@ public function listAction() {
 
 		}
 
+		$this->view->assign('projectVersion', $this->packageManager->getPackage('TechDivision.DocViewer')->getInstalledVersion());
 		$this->view->assign('packageGroups', $packageGroups);
 	}
 
 	/**
 	 * Shows documentation of given package
 	 * @param string $package
 	 * @param string $filePath
-	 * @throws PackageNotAccessableException
+	 * @throws PackageNotAccessibleException
 	 * @return void
 	 */
 	public function showAction($package, $filePath = null) {
 		$baseUri = $this->controllerContext->getRequest()->getHttpRequest()->getBaseUri();
 
 		if (!$this->accessManager->isPackageAccessable($package)) {
-			throw new PackageNotAccessableException("You are not allowed to access the package " . $package);
+			throw new PackageNotAccessibleException("You are not allowed to access the package " . $package);
 		}
 		$package = $this->packageManager->getPackage($package);
 		$this->view->assign('packageKey', $package->getPackageKey());
@@ -134,5 +133,6 @@ public function showAction($package, $filePath = null) {
 				$this->addFlashMessage($e->getMessage());
 			}
 		}
+		$this->view->assign('projectVersion', $this->packageManager->getPackage('TechDivision.DocViewer')->getInstalledVersion());
 	}
 }

Classes/TechDivision/DocViewer/Controller/ResourceController.php

@@ -5,13 +5,15 @@
  * This file is part of the TechDivision.DocViewer package.
  */
 use TechDivision\DocViewer\Exceptions\FileNotInsideDocumentationException;
-use TechDivision\DocViewer\Exceptions\PackageNotAccessableException;
+use TechDivision\DocViewer\Exceptions\PackageNotAccessibleException;
 use TechDivision\DocViewer\File\Parser;
 use TechDivision\DocViewer\Util;
 use TYPO3\Flow\Annotations as Flow;
 
 /**
- * Rudimentary service for resources
+ * Rudimentary service for resources. Flow does not allow serving static files which are not in the resource folder.
+ * This controller serves only static files which are inside the documentation folder of the installed packages which
+ * are not hidden by configuration.
  *
  * @Flow\Scope("singleton")
  */
@@ -31,14 +33,17 @@ class ResourceController extends \TYPO3\Flow\Mvc\Controller\ActionController
 	protected $packageManager;
 
 	/**
+	 * Serves static files
+	 *
 	 * @param string $package
 	 * @param string $filePath
 	 * @return mixed
 	 */
 	public function rawAction($package, $filePath) {
 
+		// check if given package is valid
 		if (!$this->accessManager->isPackageAccessable($package)) {
-			throw new PackageNotAccessableException("You are not allowed to access the package " . $package);
+			throw new PackageNotAccessibleException("You are not allowed to access the package " . $package);
 		}
 
 		$docDir = Util::getDocumentPath($this->packageManager->getPackage($package));

Classes/TechDivision/DocViewer/Exceptions/FileNotInsideDocumentationException.php

@@ -2,7 +2,7 @@
 namespace TechDivision\DocViewer\Exceptions;
 
 /**
- * Parsing is not allowed exception
+ * File is not inside documentation exception
  */
 class FileNotInsideDocumentationException extends \TYPO3\Flow\Exception
 {

Classes/TechDivision/DocViewer/Exceptions/PackageNotAccessableException.php

@@ -2,8 +2,8 @@
 namespace TechDivision\DocViewer\Exceptions;
 
 /**
- * Parsing is not allowed exception
+ * Package is not accessible exception
  */
-class PackageNotAccessableException extends \TYPO3\Flow\Exception
+class PackageNotAccessibleException extends \TYPO3\Flow\Exception
 {
 }

Classes/TechDivision/DocViewer/File/Tree.php

@@ -65,6 +65,7 @@ public function findFileNodeByPath($path, $node = null) {
 				}
 			}
 		}
+		return null;
 	}
 
 	/**

Resources/Private/Layouts/Default.html

@@ -21,6 +21,6 @@ <h1>{f:translate(id: 'module.label')}</h1>
     </div>
 
     <div class="footer">
-        DocViewer by <a href="https://www.techdivision.com/">TechDivision</a>. For support open an issue on <a href="https://github.com/techdivision/DocViewer"><i class="icon-github"></i> Github</a>
+        DocViewer {projectVersion} by <a href="https://www.techdivision.com/">TechDivision</a>. For support open an issue on <a href="https://github.com/techdivision/DocViewer"><i class="icon-github"></i> Github</a>
     </div>
 </div>

composer.json

@@ -1,11 +1,19 @@
 {
     "description": "This neos package enables you to read the docs of the installed packages",
+    "name": "techdivision/docviewer",
+    "keywords": ["neos", "backend", "module", "documentation"],
     "type": "neos-package",
+    "authors": [
+        {
+            "name": "Matthias Witte",
+            "email": "[email protected]"
+        }
+    ],
+    "license": "GPL-3.0+",
     "require": {
         "neos/neos": "2.3.*",
         "erusev/parsedown": "*"
     },
-    "name": "techdivision/docviewer",
     "autoload": {
         "psr-0": {
             "TechDivision\\DocViewer": "Classes/"
@@ -15,6 +23,5 @@
         "neos": {
             "package-key": "TechDivision.DocViewer"
         }
-    },
-    "license": "GPL-3.0+"
+    }
 }

gulpfile.js

@@ -15,4 +15,9 @@ if(!process.env.DOCKER_CONTAINER_NAME) {
     gutil.log("You have to provide the env var " + gutil.colors.red("DOCKER_CONTAINER_NAME"));
     gutil.log("Example: " + gutil.colors.green("DOCKER_CONTAINER_NAME=my_container_name gulp deploy:docker"));
     process.exit()
-}
+}
+
+gulp.task('release', ['cms:build'], function() {
+    return gulp.src('dist/Resources/Public/Styles/*', { dot: true, followSymlinks: false })
+        .pipe(gulp.dest('./Resources/Public/Styles/'));
+});