Merge pull request #10 from leonhelmus/master

Added Template settings and made everything 7.1 compliant.

Author: ksangers

composer.json

@@ -11,7 +11,7 @@
     ],
     "version": "1.7.0",
     "require": {
-        "php": "^5.4 || ^7.1",
+        "php": "^7.1",
         "composer-plugin-api": "^1.0"
     },
     "require-dev": {

files/file.template.settings.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ExportableFileTemplateSettings">
+    <default_templates>
+      <template name="M2-Acl-XML.xml" reformat="false" live-template-enabled="true" />
+      <template name="M2-Class.php" reformat="false" live-template-enabled="true" />
+      <template name="M2-Class-Block.php" reformat="false" live-template-enabled="true" />
+      <template name="M2-Class-Helper.php" reformat="false" live-template-enabled="true" />
+      <template name="M2-Class-Observer.php" reformat="false" live-template-enabled="true" />
+      <template name="M2-Class-ViewModel.php" reformat="false" live-template-enabled="true" />
+      <template name="M2-Config-XML.xml" reformat="false" live-template-enabled="true" />
+      <template name="M2-Db-schema-XML.xml" reformat="false" live-template-enabled="true" />
+      <template name="M2-DI.xml" reformat="false" live-template-enabled="true" />
+      <template name="M2-Extension-Attributes-XML.xml" reformat="false" live-template-enabled="true" />
+      <template name="M2-Layout-XML.xml" reformat="false" live-template-enabled="true" />
+      <template name="M2-Module-XML.xml" reformat="false" live-template-enabled="true" />
+      <template name="M2-Registration.php" reformat="false" live-template-enabled="true" />
+      <template name="M2-Sales-XML.xml" reformat="false" live-template-enabled="true" />
+      <template name="M2-System-include-XML.xml" reformat="false" live-template-enabled="true" />
+      <template name="M2-System-XML.xml" reformat="false" live-template-enabled="true" />
+    </default_templates>
+    <includes_templates>
+      <template name="M2-PHP-File-Header.php" reformat="true" live-template-enabled="true" />
+      <template name="M2-Settings.php" reformat="true" live-template-enabled="true" />
+      <template name="M2-XML-File-Header.xml" reformat="true" live-template-enabled="true" />
+    </includes_templates>
+  </component>
+</project>

files/fileTemplates/M2 Acl XML.xml renamed to files/fileTemplates/M2-Acl-XML.xml

@@ -0,0 +1,5 @@
+#parse("M2 Settings")
+/**
+ * Copyright © $Company. All rights reserved.
+ * $Website
+ */

files/fileTemplates/M2 Class - Block.php renamed to files/fileTemplates/M2-Class-Block.php

@@ -1,2 +1,3 @@
 #set( $Company = "MediaCT" )
 #set( $Vendor = "MediaCT" )
+#set( $Website = "https://www.mediact.nl")

files/fileTemplates/M2 Class - Helper.php renamed to files/fileTemplates/M2-Class-Helper.php

@@ -0,0 +1,7 @@
+#parse("M2 Settings")
+<!--
+/**
+ * Copyright © $Company. All rights reserved.
+ * $Website
+ */
+-->

files/fileTemplates/M2 Class - Observer.php renamed to files/fileTemplates/M2-Class-Observer.php

@@ -3,6 +3,7 @@
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl
  */
+
 namespace Mediact\CodingStandard\PhpStorm;
 
 use Composer\Composer;
@@ -14,22 +15,22 @@ class Environment implements EnvironmentInterface
      * @var FilesystemInterface
      */
     private $ideConfigFilesystem;
-
+    /**
+     * @var FilesystemInterface
+     */
+    private $ideDefaultFilesystem;
     /**
      * @var FilesystemInterface
      */
     private $defaultsFilesystem;
-
     /**
      * @var FilesystemInterface
      */
     private $projectFilesystem;
-
     /**
      * @var IOInterface
      */
     private $inputOutput;
-
     /**
      * @var Composer
      */
@@ -39,23 +40,26 @@ class Environment implements EnvironmentInterface
      * Constructor.
      *
      * @param FilesystemInterface $ideConfigFilesystem
+     * @param FilesystemInterface $ideDefaultFileSystem
      * @param FilesystemInterface $defaultsFilesystem
      * @param FilesystemInterface $projectFilesystem
      * @param IOInterface         $inputOutput
      * @param Composer            $composer
      */
     public function __construct(
         FilesystemInterface $ideConfigFilesystem,
+        FilesystemInterface $ideDefaultFileSystem,
         FilesystemInterface $defaultsFilesystem,
         FilesystemInterface $projectFilesystem,
         IOInterface $inputOutput,
         Composer $composer
     ) {
-        $this->ideConfigFilesystem = $ideConfigFilesystem;
-        $this->defaultsFilesystem  = $defaultsFilesystem;
-        $this->projectFilesystem   = $projectFilesystem;
-        $this->inputOutput         = $inputOutput;
-        $this->composer            = $composer;
+        $this->ideConfigFilesystem  = $ideConfigFilesystem;
+        $this->ideDefaultFilesystem = $ideDefaultFileSystem;
+        $this->defaultsFilesystem   = $defaultsFilesystem;
+        $this->projectFilesystem    = $projectFilesystem;
+        $this->inputOutput          = $inputOutput;
+        $this->composer             = $composer;
     }
 
     /**
@@ -68,6 +72,16 @@ public function getIdeConfigFilesystem(): FilesystemInterface
         return $this->ideConfigFilesystem;
     }
 
+    /**
+     * Get a filesystem for the IDE configuration.
+     *
+     * @return FilesystemInterface
+     */
+    public function getIdeDefaultConfigFilesystem(): FilesystemInterface
+    {
+        return $this->ideDefaultFilesystem;
+    }
+
     /**
      * Get a filesystem for the default configuration.
      *

files/fileTemplates/M2 Class - ViewModel.php renamed to files/fileTemplates/M2-Class-ViewModel.php

@@ -1,8 +1,9 @@
-<?php
+<?php declare(strict_types=1);
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl
  */
+
 namespace Mediact\CodingStandard\PhpStorm;
 
 use Composer\Composer;
@@ -17,6 +18,13 @@ interface EnvironmentInterface
      */
     public function getIdeConfigFilesystem(): FilesystemInterface;
 
+    /**
+     * Get a filesystem for the IDE Default configuration.
+     *
+     * @return FilesystemInterface
+     */
+    public function getIdeDefaultConfigFilesystem(): FilesystemInterface;
+
     /**
      * Get a filesystem for the default configuration.
      *

files/fileTemplates/M2 Class.php renamed to files/fileTemplates/M2-Class.php

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl
@@ -16,7 +16,7 @@ class Filesystem implements FilesystemInterface
     /**
      * @var string
      */
-    private $root;
+    private $root = '';
 
     /**
      * Constructor.
@@ -25,7 +25,9 @@ class Filesystem implements FilesystemInterface
      */
     public function __construct($root)
     {
-        $this->root = rtrim($root, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+        if (! empty($root)) {
+            $this->root = rtrim($root, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+        }
     }
 
     /**
@@ -35,7 +37,7 @@ public function __construct($root)
      *
      * @return bool
      */
-    public function has($path)
+    public function has(string $path): bool
     {
         return file_exists($this->getPath($path));
     }
@@ -46,10 +48,9 @@ public function has($path)
      * @param string $path
      *
      * @return string
-     *
      * @throws RuntimeException When the path is not readable.
      */
-    public function read($path)
+    public function read(string $path): string
     {
         $path = $this->getPath($path);
         if (!is_readable($path) || !is_file($path)) {
@@ -66,10 +67,9 @@ public function read($path)
      * @param string $contents
      *
      * @return bool
-     *
      * @throws RuntimeException When the path is not writable.
      */
-    public function put($path, $contents)
+    public function put(string $path, string $contents): bool
     {
         $directory = dirname($path);
         $this->createDir($directory);
@@ -82,7 +82,7 @@ public function put($path, $contents)
             throw new RuntimeException($path . ' is not writable');
         }
 
-        return file_put_contents($path, $contents);
+        return (bool) file_put_contents($path, $contents);
     }
 
     /**
@@ -91,10 +91,9 @@ public function put($path, $contents)
      * @param string $path
      *
      * @return bool
-     *
      * @throws RuntimeException When the directory can not be created.
      */
-    public function createDir($path)
+    public function createDir(string $path): bool
     {
         $directory = $this->getPath($path);
         if (!is_dir($directory)) {
@@ -120,10 +119,9 @@ public function createDir($path)
      * @param string $path
      *
      * @return array
-     *
      * @throws RuntimeException When the path is not a directory.
      */
-    public function listFiles($path = '')
+    public function listFiles(string $path = ''): array
     {
         $directory = $this->getPath($path);
         if (!is_dir($directory)) {
@@ -165,7 +163,7 @@ public function listFiles($path = '')
      *
      * @return string
      */
-    private function getPath($path)
+    private function getPath(string $path): string
     {
         return $this->root .
             ltrim(
@@ -177,4 +175,14 @@ private function getPath($path)
                 DIRECTORY_SEPARATOR
             );
     }
+
+    /**
+     * Get root
+     *
+     * @return string
+     */
+    public function getRoot(): string
+    {
+        return $this->root;
+    }
 }

files/fileTemplates/M2 Config XML.xml renamed to files/fileTemplates/M2-Config-XML.xml

@@ -15,7 +15,7 @@ interface FilesystemInterface
      *
      * @return bool
      */
-    public function has($path);
+    public function has(string $path): bool;
 
     /**
      * Read a path.
@@ -24,7 +24,7 @@ public function has($path);
      *
      * @return string
      */
-    public function read($path);
+    public function read(string $path): string;
 
     /**
      * Write contents to a path.
@@ -34,7 +34,7 @@ public function read($path);
      *
      * @return bool
      */
-    public function put($path, $contents);
+    public function put(string $path, string $contents): bool;
 
     /**
      * Create a directory if it does not exist.
@@ -43,7 +43,7 @@ public function put($path, $contents);
      *
      * @return bool
      */
-    public function createDir($path);
+    public function createDir(string $path): bool;
 
     /**
      * List contents of a directory.
@@ -52,5 +52,12 @@ public function createDir($path);
      *
      * @return array
      */
-    public function listFiles($path = '');
+    public function listFiles(string $path = ''): array;
+
+    /**
+     * Get the root that has been set.
+     *
+     * @return string
+     */
+    public function getRoot(): string;
 }

files/fileTemplates/M2 DI.xml renamed to files/fileTemplates/M2-DI.xml

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl
@@ -21,7 +21,7 @@ class CodeStylePatcher implements ConfigPatcherInterface
      */
     public function patch(
         EnvironmentInterface $environment
-    ) {
+    ): void {
         $this->copyFile(
             $environment->getDefaultsFilesystem(),
             $environment->getIdeConfigFilesystem(),

files/fileTemplates/M2 Db schema XML.xml renamed to files/fileTemplates/M2-Db-schema-XML.xml

@@ -1,4 +1,4 @@
-<?php
+<?php declare(strict_types=1);
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl
@@ -30,7 +30,9 @@ public function __construct(array $patchers = null)
             : [
                 new CodeStylePatcher(),
                 new FileTemplatesPatcher($xmlAccessor),
-                new InspectionsPatcher($xmlAccessor)
+                new InspectionsPatcher($xmlAccessor),
+                new TemplateSettingsPatcher($xmlAccessor),
+                new LiveTemplatesPatcher()
             ];
     }
 
@@ -43,7 +45,7 @@ public function __construct(array $patchers = null)
      */
     public function patch(
         EnvironmentInterface $environment
-    ) {
+    ): void {
         foreach ($this->patchers as $patcher) {
             $patcher->patch($environment);
         }