Merge pull request #9 from keboola/odin-php7

new version

.gitignore

@@ -1,3 +1,4 @@
 .idea
 composer.lock
 vendor
+/build/logs

.travis.yml

@@ -1,7 +1,5 @@
 language: php
 php:
-  - 5.6
-  - 7.0
   - 7.1
   - 7.2
 env:

README.md

@@ -1,6 +1,6 @@
 # Temp Library [![Build Status](https://travis-ci.org/keboola/php-temp.svg?branch=master)](https://travis-ci.org/keboola/php-temp) [![Maintainability](https://api.codeclimate.com/v1/badges/1f0a96227c7e6483467d/maintainability)](https://codeclimate.com/github/keboola/php-temp/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/1f0a96227c7e6483467d/test_coverage)](https://codeclimate.com/github/keboola/php-temp/test_coverage)
 
-This library provides an isolated temporary directory for an application. The library has methods
+This library provides an isolated temporary folder for an application. The library has methods
 for generating randomly named folders and files.  
 
 ## Usage
@@ -14,6 +14,16 @@ echo 'Files are stored in: ' . $temp->getTmpFolder();
 $temp->remove();
 ```
 
+Available methods:
+
+- `getTmpFolder` -- Get the name of the temporary folder.
+- `createFile` -- Create a named file in the temporary folder.
+- `createTmpFile` -- Create a random file in the temporary folder.
+
 ## Migration from version 1.0
-The temp folder is no longer deleted automatically in the destructor. It needs to 
-be removed explicitly by calling the `remove()` method.
+- The temp folder is no longer deleted automatically in the destructor. It needs to 
+  be removed explicitly by calling the `remove()` method.
+- The public `setId` method was removed. This function was rarely used and is no longer available.
+- The public `initRunFolder` method was removed. The folder is now initialized when used and there is 
+no need to call `initRunFolder` any more.
+- The protected `getTmpPath` method is now private. 

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "keboola/php-temp",
-    "description": "Temp library handles application temporary folder",
+    "description": "Temp library handles application temporary files",
     "license": "MIT",
     "keywords": [
         "filesystem",
@@ -13,15 +13,42 @@
         }
     ],
     "require": {
-        "symfony/filesystem": ">=2.8",
-        "php": ">=5.6"
+        "symfony/filesystem": ">2.8",
+        "php": ">=7.1"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.7"
+        "phpunit/phpunit": "^7.4",
+        "jakub-onderka/php-parallel-lint": "^1.0",
+        "phpstan/phpstan-shim": "^0.10.5",
+        "keboola/coding-standard": "^6.0"
     },
     "autoload": {
-        "psr-0": {
-            "Keboola\\Temp": "src/"
+        "psr-4": {
+            "Keboola\\Temp\\": "src/"
         }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Keboola\\Temp\\Tests\\": "tests/"
+        }
+    },
+    "scripts": {
+        "tests": "phpunit",
+        "phpstan": "phpstan analyse ./src ./tests --level=max --no-progress -c phpstan.neon",
+        "phpcs": "phpcs -n --ignore=vendor --extensions=php .",
+        "phplint": "parallel-lint -j 10 --exclude vendor .",
+        "build": [
+            "@phplint",
+            "@phpcs",
+            "@phpstan",
+            "@tests"
+        ],
+        "ci": [
+            "@composer validate --no-check-publish --no-check-all",
+            "@build"
+        ]
+    },
+    "config": {
+        "sort-packages": true
     }
 }

phpcs.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<ruleset name="Project">
+    <rule ref="vendor/keboola/coding-standard/src/ruleset.xml"/>
+</ruleset>

phpstan.neon

@@ -0,0 +1,2 @@
+parameters:
+    ignoreErrors:

phpunit.xml

@@ -7,10 +7,9 @@
          convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
-         syntaxCheck="false"
          bootstrap="vendor/autoload.php">
 
-	<testsuite name="API Test Suite">
+	<testsuite name="Library Test Suite">
 		<directory>tests</directory>
 	</testsuite>
 

src/Temp.php

@@ -0,0 +1,118 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Keboola\Temp;
+
+use Symfony\Component\Filesystem\Filesystem;
+
+class Temp
+{
+    /**
+     * @var String
+     */
+    private $prefix;
+
+    /**
+     * @var Filesystem
+     */
+    private $fileSystem;
+
+    /**
+     * @var string
+     */
+    private $id;
+
+    /**
+     * @var string
+     */
+    private $tmpFolder;
+
+    public function __construct(string $prefix = '')
+    {
+        $this->prefix = $prefix;
+        $this->id = uniqid("run-", true);
+        $this->fileSystem = new Filesystem();
+    }
+
+    private function initRunFolder(): void
+    {
+        clearstatcache();
+        $path = $this->getTmpPath();
+        if (!file_exists($path) && !is_dir($path)) {
+            $this->fileSystem->mkdir($path, 0777);
+        }
+        $this->tmpFolder = $path;
+    }
+
+    /**
+     * Get path to the temporary folder.
+     *
+     * @return string
+     */
+    private function getTmpPath(): string
+    {
+        $tmpDir = sys_get_temp_dir();
+        if (!empty($this->prefix)) {
+            $tmpDir .= "/" . $this->prefix;
+        }
+        $tmpDir .= "/" . $this->id;
+        return $tmpDir;
+    }
+
+    /**
+     * Returns path to the temporary folder.
+     *
+     * @return string
+     */
+    public function getTmpFolder(): string
+    {
+        if (!$this->tmpFolder) {
+            $this->initRunFolder();
+        }
+        return $this->tmpFolder;
+    }
+
+    /**
+     * Create a randomly named temporary file.
+     *
+     * @param string $suffix filename suffix
+     * @throws \Exception
+     * @return \SplFileInfo
+     */
+    public function createTmpFile(string $suffix = ''): \SplFileInfo
+    {
+        $file = uniqid();
+        if ($suffix) {
+            $file .= '-' . $suffix;
+        }
+        return $this->createFile($file);
+    }
+
+    /**
+     * Creates a named temporary file.
+     *
+     * @param string $fileName
+     * @return \SplFileInfo
+     * @throws \Exception
+     */
+    public function createFile(string $fileName): \SplFileInfo
+    {
+        $fileInfo = new \SplFileInfo($this->getTmpFolder() . '/' . $fileName);
+        $pathName = $fileInfo->getPathname();
+        if (!file_exists(dirname($pathName))) {
+            $this->fileSystem->mkdir(dirname($pathName), 0777);
+        }
+        $this->fileSystem->touch($pathName);
+        $this->fileSystem->chmod($pathName, 0600);
+        return $fileInfo;
+    }
+
+    /**
+     * Delete the whole temporary folder including all files.
+     */
+    public function remove(): void
+    {
+        $this->fileSystem->remove($this->getTmpFolder());
+    }
+}