Merge pull request #1 from quillstack/feature/storage-interface

radek-ziemniewicz · web-flow · commit a78aa2f9220d · 2021-08-10T20:53:13.000+01:00
Common interface for storage classes
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,9 @@
-composer.phar
+/.DS_Store/
+/.idea/
+/.scannerwork/
+/coverage/
 /vendor/
-
-# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
+composer.phar
+composer.lock
+.phpunit.result.cache
+phpunit.*.xml
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -0,0 +1,4 @@
+buil.d:
+    environment:
+        php:
+            version: '8.0'
diff --git a/.styleci.yml b/.styleci.yml
@@ -0,0 +1,7 @@
+risky: false
+version: 8
+preset: psr12
+finder:
+    exclude:
+        - "vendor"
+    name: "*.php"
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,18 @@
+language: php
+sudo: false
+php:
+    - 8.0
+cache:
+    directories:
+        - $HOME/.composer/cache
+addons:
+    sonarcloud:
+        organization: "quillstack"
+        token:
+            secure: "GuBA5S7wH1vaarsgNTmOqdvNEONJADn3YhH2n8jQxCD2PJ7Gq8buCkZ4zML9L7QhSWTFu47CeXOU25TxkoMMDkr0hwFgW8L4K+w2Mw1UxqBGyEA/1JRLS62x7ynrQzUFBSR5x+gX4rNQM3F2c94d4gQWC5Y+vxEZVQJSTgLAbOis9j2GLhpMQTyOoxMHUnID9bnjYWqqVVwiXtqUVtW3TKlAodIbC9M2HK2Ex9oMWY0PN0VycFE9fP6nrnYqpuPlsukVsm+npcyzEqDpETsnHUiKBsjYnQ0StsHKGAuSTlhxwWVEzUCNWiJV2GZ6yGDnjvvwoNFAsmKUQfx3TGJvULrWQSQxOMyGXlMPqczPmj7WX662k0r73ssg4kWgi3A2pt8zKVbcOiUiVMd7lMjdIy4YiySbiuJWE93lKgFHEZ2iCdRt0sO0CZnHgPgWFzgZjW6NM4JWG9JsUg6CpekXwfdM6umg3DkHKajZtCgvk2kgml6fMIUxL9bbln3SOl7GBzVXSmoho5Zyrmo/YkUajTQXYqJd4McHaq+q4sQo4YvdXQnKnnnzDk6dt6dTgMve4lqXdLaUHMcOMQBWfq1eR/IBZ6RVS+fGlzxACIPBSPB1HmQjzteI2bN20d+pKHcrQuDn/FyIjOMMmrXL5fe/MsS2x4T+g01v0IYum7IvNh8="
+git:
+    depth: false
+install: composer update --no-interaction --no-suggest --no-progress
+script:
+    - phpdbg -qrr vendor/bin/phpunit  --coverage-clover phpunit.coverage.xml --log-junit phpunit.report.xml
+    - sonar-scanner
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,6 @@
+FROM php:8-cli-alpine
+RUN php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
+RUN php -r "if (hash_file('sha384', 'composer-setup.php') === '756890a4488ce9024fc62c56153228907f1545c228516cbf63f885e036d37e9a59d27d63f46af1d4d07ee0f76181c7d3') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
+RUN php composer-setup.php
+RUN php -r "unlink('composer-setup.php');"
+RUN mv composer.phar /usr/local/bin/composer
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 The Quill Stack
+Copyright (c) 2021 Quillstack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -1,2 +1,6 @@
-# storage-interface
-Common interface for Storage classes.
+# Quillstack Storage Interface
+Common configuration files for different repositories.
+
+```shell
+docker exec -w /var/www/html -it quillstack_storage_interface sh
+```
diff --git a/composer.json b/composer.json
@@ -0,0 +1,23 @@
+{
+    "description": "Common interface for Storage classes.",
+    "type": "library",
+    "license": "MIT",
+    "keywords": [
+        "interface",
+        "php8",
+        "storage",
+        "quillstack"
+    ],
+    "homepage": "https://quillstack.org/storage-interface",
+    "authors": [
+        {
+            "name": "Radek Ziemniewicz",
+            "email": "radek@quillstack.org"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "Quillstack\\StorageInterface\\": "src/"
+        }
+    }
+}
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,8 @@
+version: '3'
+services:
+    php:
+        build: .
+        container_name: quillstack_storage_interface
+        tty: true
+        volumes:
+            -   .:/var/www/html
diff --git a/sonar-project.properties b/sonar-project.properties
@@ -0,0 +1,12 @@
+sonar.projectKey=quillstack_storage-interface
+sonar.organization=quillstack
+
+sonar.sources=src
+sonar.tests=tests
+sonar.php.coverage.reportPaths=phpunit.coverage.xml
+sonar.php.tests.reportPath=phpunit.report.xml
+
+sonar.language=php
+sonar.sourceEncoding=UTF-8
+
+sonar.host.url=https://sonarcloud.io
diff --git a/src/StorageInterface.php b/src/StorageInterface.php
@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Quillstack\StorageInterface;
+
+interface StorageInterface
+{
+    /**
+     * Retrieve the contents of a file.
+     *
+     * @param string $path
+     *
+     * @return mixed
+     */
+    public function get(string $path): mixed;
+
+    /**
+     * Checks if the file exists on the storage.
+     *
+     * @param string $path
+     *
+     * @return bool
+     */
+    public function exists(string $path): bool;
+
+    /**
+     * Checks if the file is missing from the storage.
+     *
+     * @param string $path
+     *
+     * @return bool
+     */
+    public function missing(string $path): bool;
+
+    /**
+     * Saves the contents to the file.
+     *
+     * @param string $path
+     * @param mixed $contents
+     *
+     * @return bool
+     */
+    public function save(string $path, mixed $contents): bool;
+
+    /**
+     * Deletes one or more files.
+     *
+     * @param string $path
+     * @param string ...$more
+     *
+     * @return bool
+     */
+    public function delete(string $path, string ...$more): bool;
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +buil.d:
 +    environment:
 +        php:
 +            version: '8.0'