Write README and start documentation

Author: tgalopin

.travis.yml

@@ -5,9 +5,9 @@ sudo: false
 matrix:
     include:
         - php: 7.1
-          env: SYMFONY_VERSION="4.1.*" COMPOSER_FLAGS="--prefer-lowest"
+          env: SYMFONY_VERSION="4.2.*" COMPOSER_FLAGS="--prefer-lowest"
         - php: 7.2
-          env: SYMFONY_VERSION="4.1.*" CS_FIXER=1
+          env: SYMFONY_VERSION="4.2.*" CS_FIXER=1
         - php: 7.3
           env: SYMFONY_VERSION="4.2.*"
     fast_finish: true

README.md

@@ -1 +1,40 @@
 # flysystem-bundle
+
+[![Build Status](https://travis-ci.org/tgalopin/flysystem-bundle.svg?branch=master)](https://travis-ci.org/tgalopin/flysystem-bundle)
+
+[![SymfonyInsight](https://insight.symfony.com/projects/525fdfa3-d482-4218-b4b9-3c2efc305fac/big.svg)](https://insight.symfony.com/projects/525fdfa3-d482-4218-b4b9-3c2efc305fac)
+
+This repository is a light Symfony bundle integrating the [Flysystem](https://flysystem.thephpleague.com)
+library into Symfony applications. It mainly aims at injecting Flysystem instance(s) efficiently into your 
+Dependency Injection container. 
+
+## Installation
+
+flysystem-bundle requires PHP 7.1+ and Symfony 4.2+.
+
+You can install the bundle using Symfony Flex:
+
+```
+composer require tgalopin/flysystem-bundle
+```
+
+## Documentation
+
+1. [Getting started](https://github.com/tgalopin/flysystem-bundle/blob/master/docs/1-getting-started.md)
+2. [Caching](https://github.com/tgalopin/flysystem-bundle/blob/master/docs/2-caching.md)
+3. [Using the mount manager](https://github.com/tgalopin/flysystem-bundle/blob/master/docs/3-using-mount-manager.md)
+4. [Configuration reference](https://github.com/tgalopin/flysystem-bundle/blob/master/docs/4-configuration-reference.md)
+
+## Security Issues
+
+If you discover a security vulnerability within the bundle, please follow
+[our disclosure procedure](https://github.com/tgalopin/flysystem-bundle/blob/master/docs/A-security-disclosure-procedure.md).
+
+## Backward Compatibility promise
+
+This library follows the same Backward Compatibility promise as the Symfony framework:
+[https://symfony.com/doc/current/contributing/code/bc.html](https://symfony.com/doc/current/contributing/code/bc.html)
+
+> *Note*: many classes in this library are either marked `@final` or `@internal`.
+> `@internal` classes are excluded from any Backward Compatiblity promise (you should not use them in your code)
+> whereas `@final` classes can be used but should not be extended (use composition instead).

docs/1-getting-started.md

@@ -0,0 +1,112 @@
+# Getting started
+
+- [Installation](#installation)
+- [Basic usage](#basic-usage)
+- [Defining multiple filesystems](#defining-multiple-filesystems)
+
+## Installation
+
+flysystem-bundle requires PHP 7.1+ and Symfony 4.2+.
+
+You can install the bundle using Symfony Flex:
+
+```
+composer require tgalopin/flysystem-bundle
+```
+
+## Basic usage
+
+The default configuration file created by Symfony Flex provides enough configuration to
+use Flysystem in your application as soon as you install the bundle:
+
+```yaml
+# config/packages/flysystem.yaml
+
+flysystem:
+    default_filesystem: 'app'
+    filesystems:
+        app:
+            adapter: 'flysystem.adapter.local'
+```
+
+This configuration creates a single filesystem service, configured using the local adapter in the `storge` directory, 
+and provides this service for autowiring using the `League\Flysystem\FilesystemInterface` interface. 
+This autowiring will target the default filesystem defined in the bundle configuration.
+ 
+This means that if you are using autowiring, you can typehint `League\Flysystem\FilesystemInterface` in any
+of your services to get the default filesystem:
+
+```php
+use League\Flysystem\FilesystemInterface;
+
+class MyService
+{
+    private $filesystem;
+    
+    public function __construct(FilesystemInterface $filesystem)
+    {
+        $this->filesystem = $filesystem;
+    }
+    
+    // ...
+}
+```
+
+The same goes for controllers:
+
+```php
+use League\Flysystem\FilesystemInterface;
+
+class MyController
+{
+    public function index(FilesystemInterface $filesystem)
+    {
+        // ...
+    }
+}
+```
+
+If you are not using autowiring, you can inject the `flysystem` service into your services
+manually to get the default filesystem.
+
+## Defining multiple filesystems
+
+Using a single filesystem is good way to get up and running quickly, but it is often useful to
+create multiple instances of Flysystem in order to manage different filesystems.
+
+This bundle provides this ability using `named aliases`: by leveraging the variable name in addition to
+the interface name, autowiring is able to inject the proper filesystem you want in your services.
+
+This means that if you are using autowiring, you can create multiple filesystems in the configuration of the
+bundle and typehint `League\Flysystem\FilesystemInterface` with a variable having the same name as your filesystem 
+name to get this specific filesystem:
+
+```yaml
+# config/packages/flysystem.yaml
+
+flysystem:
+    default_filesystem: 'app'
+    filesystems:
+        app:
+            adapter: 'flysystem.adapter.local'
+
+        # Defines an additional filesystem named "myFilesystem"
+        myFilesystem:
+            adapter: 'flysystem.adapter.local'
+```
+
+```php
+use League\Flysystem\FilesystemInterface;
+
+class MyController
+{
+    public function index(FilesystemInterface $fs, FilesystemInterface $myFilesystem)
+    {
+        // $fs is referencing the default filesystem ("app") because the variable name is not a filesystem name
+        // $myFilesystem is referencing the "myFilesystem" filesystem
+    }
+}
+```
+
+If you are not using autowiring, you can inject the `flysystem.filesystem.<filesystem-name>` service into 
+your services manually to get a specific filesystem (for instance here: `flysystem.filesystem.myFilesystem`).

docs/2-caching.md

@@ -0,0 +1 @@
+# Caching

docs/3-using-mount-manager.md

@@ -0,0 +1 @@
+# Using the mount manager

docs/4-configuration-reference.md

@@ -0,0 +1 @@
+# Configuration reference

docs/A-security-disclosure-procedure.md

@@ -0,0 +1,16 @@
+# Security issue disclosure procedure
+
+If you think that you have found a security issue in flysystem-bundle, don't use the bug tracker and
+don't publish it publicly. Instead, all security issues must be sent to galopintitouan [at] gmail.com.
+
+For each report, the core maintainers of flysystem-bundle will first try to confirm the vulnerability.
+When it is confirmed, we will work on a solution following these steps:
+
+1. Send an acknowledgement to the reporter;
+2. Work on a patch in a dedicated private repository;
+3. Get a CVE identifier from [mitre.org](https://cveform.mitre.org/);
+4. Send the patch to the reporter for review;
+5. Apply the patch to all maintained versions of flysystem-bundle;
+6. Package new versions for all affected versions;
+7. Update the [public security advisories database](https://github.com/FriendsOfPHP/security-advisories)
+   maintained by the FriendsOfPHP organization.

src/DependencyInjection/FlysystemExtension.php

@@ -80,6 +80,7 @@ public function load(array $configs, ContainerBuilder $container)
 
             if ($config['default_filesystem'] === $fsName) {
                 $container->setAlias(FilesystemInterface::class, 'flysystem.filesystem.'.$fsName)->setPublic(false);
+                $container->setAlias('flysystem', 'flysystem.filesystem.'.$fsName)->setPublic(false);
             }
         }
     }