Merge pull request #18 from ajmichels/some-improvements

some refactoring and added unit tests

Author: ajmichels

.travis.yml

@@ -2,7 +2,7 @@ language: php
 php:
   - '5.6'
   - '7.0'
-  - nightly
+  - '7.1'
 install: composer install
 script:
   - composer lint

composer.json

@@ -2,7 +2,7 @@
     "name": "ajmichels/note-script",
     "description": "A utility for note taking.",
     "keywords": ["utility", "notes", "productivity", "markdown"],
-    "version": "0.0.1",
+    "version": "0.1.0",
     "license": "GPL-2.0",
     "type": "project",
     "authors": [

composer.lock

@@ -0,0 +1,131 @@
+<?php
+
+/**
+ * Copyright 2016, AJ Michels
+ *
+ * This file is part of Note-Script.
+ *
+ * This program is free software; you can redistribute it and/or modify it under the terms of the
+ * GNU General Public License as published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with this program; if
+ * not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
+namespace NoteScript;
+
+use ArrayAccess;
+
+/**
+ * Initializes and stores application configuration data.
+ */
+class Config implements ArrayAccess
+{
+
+    const NOTE_DIR = 'noteDir';
+    const LOG_DIR = 'logDir';
+    const ENV_VAR_HOME = 'HOME';
+    const ENV_VAR_NOTE_HOME = 'NOTE_HOME';
+    const DEFAULT_NOTE_DIR = '/notes';
+
+    /**
+     * Collection of configuration key/value pairs
+     * @var array
+     */
+    private $values = [];
+
+    /**
+     * Constructor method
+     */
+    public function __construct(array $values)
+    {
+        $this->values = $values;
+    }
+
+    /**
+     * Factory method for creating new instances of Config.
+     * @return NoteScript\Config A newly created instance of Config
+     */
+    public static function create()
+    {
+        $configValues = [];
+        $configValues[self::NOTE_DIR] = self::getNoteDirectory();
+        $configValues[self::LOG_DIR] = dirname(dirname(__DIR__)) . '/logs';
+        return new Config($configValues);
+    }
+
+    /**
+     * Determine if a specific config value exists
+     * @param  mixed $offset The key for the config value.
+     * @return boolean       True if config value exists.
+     */
+    public function offsetExists($offset)
+    {
+        return isset($this->values[$offset]);
+    }
+
+    /**
+     * Retrieve a configuration value by key.
+     * @param  mixed      $offset The key for the value being fetched.
+     * @return mixed|null         The value or null
+     */
+    public function offsetGet($offset)
+    {
+        return $this->offsetExists($offset) ? $this->values[$offset] : null;
+    }
+
+    /**
+     * Required by the ArrayAccess interface, but in this case will throw an exception as config
+     * values are read only.
+     * @param  mixed $offset They key for the value
+     * @param  mixed $value  The value being set
+     * @throws NoteScript\ConfigException
+     * @return null
+     */
+    public function offsetSet($offset, $value)
+    {
+        throw new ConfigException(ConfigException::MSG_READ_ONLY);
+    }
+
+    /**
+     * Required by the ArrayAccess interface, but in this case will throw an exception as config
+     * values are read only and cannot be removed once set.
+     * @param  mixed $offset The key of the value to be removed
+     * @throws NoteScript\ConfigException
+     * @return null
+     */
+    public function offsetUnset($offset)
+    {
+        throw new ConfigException(ConfigException::MSG_NOT_REMOVABLE);
+    }
+
+    /**
+     * Retrieves the directory for storing notes by reading certain environment variables.
+     * @throws NoteScript\ConfigException
+     * @return string Path to directory
+     */
+    private static function getNoteDirectory()
+    {
+        $noteDir = getenv(self::ENV_VAR_NOTE_HOME);
+
+        if ($noteDir === false || trim($noteDir) === '') {
+            $homeDir = getenv(self::ENV_VAR_HOME);
+
+            if ($homeDir === false || trim($homeDir) === '') {
+                $msg = sprintf(ConfigException::MSG_MISSING_ENV_VAR, self::ENV_VAR_HOME);
+                throw new ConfigException($msg);
+            }
+
+            $noteDir = $homeDir . self::DEFAULT_NOTE_DIR;
+        }
+
+        return $noteDir;
+    }
+
+}

logs/.gitkeep

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * Copyright 2016, AJ Michels
+ *
+ * This file is part of Note-Script.
+ *
+ * This program is free software; you can redistribute it and/or modify it under the terms of the
+ * GNU General Public License as published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with this program; if
+ * not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
+namespace NoteScript;
+
+use RuntimeException;
+
+/**
+ * Exceptions that are thrown when there are problems with the application configuration.
+ */
+class ConfigException extends RuntimeException
+{
+    const MSG_READ_ONLY = 'Config values are read only.';
+    const MSG_NOT_REMOVABLE = 'Config values cannot be removed.';
+    const MSG_MISSING_ENV_VAR = 'There is no $%s environment variable defined.';
+}

src/main/Config.php

@@ -20,6 +20,12 @@
 
 namespace NoteScript;
 
+use ErrorException;
+use Exception;
+
+/**
+ * Used to capture, interpret, and output errors and exceptions.
+ */
 class ErrorHandler
 {
 
@@ -44,4 +50,16 @@ public static function handle($severity, $message, $filename, $lineNum)
         }
     }
 
+    /**
+     * Takes an exception object and prints it as a string to STDERR
+     * @param  Exception $e The exception to print
+     * @return null
+     */
+    public static function printException(Exception $e)
+    {
+        $stderr = fopen('php://stderr', 'w');
+        fwrite($stderr, (string) $e);
+        fclose($stderr);
+    }
+
 }

src/main/ConfigException.php

@@ -0,0 +1,81 @@
+<?php
+
+/**
+ * Copyright 2016, AJ Michels
+ *
+ * This file is part of Note-Script.
+ *
+ * This program is free software; you can redistribute it and/or modify it under the terms of the
+ * GNU General Public License as published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with this program; if
+ * not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
+namespace NoteScript;
+
+use Exception;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Provides methods for manipulating files.
+ */
+class FileUtil
+{
+
+    const DEFAULT_DIR_MODE = 0700;
+    const DEFAULT_FILE_MODE = 0600;
+    const MSG_FILE_EXISTS = 'File already exists (%s)';
+    const MSG_FILE_CREATED = 'File Created (%s)';
+
+    /**
+     * @var Psr\Log\LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * Constructor
+     * @param Psr\Log\LoggerInterface $logger
+     */
+    public function __construct(LoggerInterface $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    /**
+     * Will write contents to provided file path. If the directory for the file doesn't exist it
+     * will be created. If the file already exists an exception will be thrown.
+     * @param  string $path    The file path to write to.
+     * @param  string $content The content to write to the file.
+     * @throws Exception
+     * @return null
+     */
+    public function writeFile($path, $content)
+    {
+        $directory = dirname($path);
+
+        // Create the directory if it doesn't exist
+        if (!is_dir($directory)) {
+            mkdir($directory, self::DEFAULT_DIR_MODE, true);
+        }
+
+        if (file_exists($path)) {
+            $msg = sprintf(self::MSG_FILE_EXISTS, $path);
+            $this->logger->warning($msg);
+            throw new Exception($msg);
+        }
+
+        $file = fopen($path, 'x');
+        fwrite($file, $content);
+        fclose($file);
+        chmod($path, self::DEFAULT_FILE_MODE);
+        $this->logger->info(sprintf(self::MSG_FILE_CREATED, $path));
+    }
+
+}

src/main/ErrorHandler.php

@@ -21,18 +21,52 @@
 namespace NoteScript;
 
 use Monolog\Logger as Monolog;
+use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\SyslogHandler;
-use Monolog\Handler\RotatingFileHandler;
+use Monolog\Handler\StreamHandler;
 
+/**
+ * Writes and manages application logs.
+ */
 class Logger extends Monolog
 {
 
-    public function __construct($logDir)
+    /**
+     * Constructor
+     * Since this class extends Monolog all this constructor is ding is encapsulating the
+     * initialization of a logger instance that is specific to this application.
+     */
+    public function __construct()
     {
         parent::__construct('note-script');
 
+        // Always log errors to the system log
         $this->pushHandler(new SyslogHandler($this->getName(), 'user', Monolog::ERROR));
-        $this->pushHandler(new RotatingFileHandler($logDir . '/note-script.log', 10, Monolog::DEBUG));
+
+        // Log to STDOUT based on the verbosity flags
+        $stdOutStreamHandler = new StreamHandler('php://stdout', self::getVerbosityFromArgs());
+        $stdOutStreamHandler->setFormatter(new LineFormatter("%level_name%: %message% %context% %extra%\n"));
+        $this->pushHandler($stdOutStreamHandler);
+    }
+
+    /**
+     * Determines what the verbosity of the current execution is based on command line arguments.
+     * @return int
+     */
+    public static function getVerbosityFromArgs()
+    {
+        $args = array_slice($_SERVER['argv'], 1);
+        $verbosity = Monolog::WARNING;
+
+        if (false !== array_search('-vvv', $args)) {
+            $verbosity = Monolog::DEBUG;
+        } elseif (false !== array_search('-vv', $args)) {
+            $verbosity = Monolog::INFO;
+        } elseif (false !== array_search('-v', $args)) {
+            $verbosity = Monolog::NOTICE;
+        }
+
+        return $verbosity;
     }
 
 }