Merge pull request #1 from adeptofvoltron/master

First PR

Author: pradzikowski

.gitignore

@@ -0,0 +1,14 @@
+composer.phar
+/vendor/
+
+tmp/
+*.tmp
+*.bak
+*~.nib
+
+local.properties
+.settings/
+.loadpath
+.recommenders
+
+phpunit.xml

.travis.yml

@@ -0,0 +1,16 @@
+language: php
+sudo: false
+php:
+  - '7.1'
+  - '7.0'
+  - nightly
+
+before_script:
+  - composer self-update
+  - composer install --prefer-dist --no-interaction
+
+script:
+  - ./vendor/bin/phpunit
+  - ./vendor/bin/phpcs --standard=PSR2 ./src/ ./test/
+notifications:
+  email: false

Api/ConfigBuilderInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PCF\MagentoMigration\Api;
+
+interface ConfigBuilderInterface
+{
+
+    /**
+     * @return string
+     */
+    public function createConfigPath();
+}

Api/PathLocatorInterface.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PCF\MagentoMigration\Api;
+
+interface PathLocatorInterface
+{
+    const VENDOR_DIR_NAME = 'vendor';
+    const MIGRATION_DIR_NAME = 'Migrations';
+
+    /**
+     * @return string
+     */
+    public function getPhinxBinaryPath();
+
+    /**
+     * @return string
+     */
+    public function getVendorPath();
+
+    /**
+     * @return array
+     */
+    public function getAllMigrationDirs();
+}

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing to Project
+Hi! :smiley_cat:    
+Firstly, thanks for reading this doc.
+Everyone who programs in PHP and loves cats (and not only cats) can be a contributing member.
+This file contains only guidelines, not actual rules. Use your best judgment, and feel free to suggest changes to this document in a pull request.   
+**Our only requirement is that all your code MUST follow psr standards and enable strict_types (php>=7).**
+
+## Pull requests
+* Fork project and apply your changes
+* Create Pull Request to our repository
+* Include funny gif with cat in PR comm
+* Describe your changes in few sentences
+* Pat your cat and make him purrr :smirk_cat: 
+
+## Writing test
+Cats love getting new tests, so we love them to!! Remember improving code coverage makes your cat happy.
+
+## Writing documentation
+Remember to add phpdoc to your code. We respect [phpDocumentator guides](https://www.phpdoc.org/docs/latest/glossary.html)

Command/Phinx.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PCF\MagentoMigration\Command;
+
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Console\Input\{InputArgument, InputOption};
+use Symfony\Component\Console\Output\OutputInterface;
+use PCF\MagentoMigration\Command\Phinx\CommandBuilder;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Process\Process;
+
+class Phinx extends Command
+{
+    const COMAND_CODE = 'pcf:migration';
+
+    /** @var CommandBuilder */
+    private $commandBuilder;
+
+    /** @var Process */
+    private $process;
+
+    /** @var LoggerInterface */
+    private $logger;
+
+    /**
+     * Phinx constructor.
+     * @param CommandBuilder $commandBuilder
+     * @param Process $process
+     * @param LoggerInterface $logger
+     */
+    public function __construct(CommandBuilder $commandBuilder, Process $process, LoggerInterface $logger)
+    {
+        parent::__construct();
+        $this->commandBuilder = $commandBuilder;
+        $this->process = $process;
+        $this->logger = $logger;
+    }
+
+
+    protected function configure()
+    {
+        $this->addArgument('input', InputArgument::IS_ARRAY, 'Input command, same use as Phinx');
+        $this->setName(self::COMAND_CODE)->setDescription('Migration using phinx command');
+    }
+
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     *
+     * @return integer
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $command = implode(' ', $input->getArgument('input'));
+        try {
+            $execCommand = $this->commandBuilder->getExecCommand($command);
+        } catch (\LogicException $e) {
+            return $output->writeln($e->getMessage());
+        }
+
+        $this->process->setCommandLine($execCommand);
+        $this->process->setTty(true);
+        try {
+            $this->process->run(function ($type, $buffer) use ($output) {
+                $output->write($buffer);
+            });
+        } catch (\RuntimeException $e) {
+            $this->logger->error($e, ['command' => $command]);
+            $output->writeln("Error occured, for more info check logs");
+        } catch (\LogicException $e) {
+            $this->logger->error($e, ['command' => $command]);
+            $output->writeln($e->getMessage());
+        }
+
+        return 0;
+    }
+}

Command/Phinx/CommandBuilder.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PCF\MagentoMigration\Command\Phinx;
+
+use mikehaertl\shellcommand\Command;
+use PCF\MagentoMigration\Api\PathLocatorInterface;
+use PCF\MagentoMigration\Api\ConfigBuilderInterface;
+
+class CommandBuilder
+{
+
+    /** @var PathLocatorInterface */
+    protected $pathLocator;
+
+    /** @var ConfigBuilderInterface */
+    protected $configBuilder;
+
+    /** @var Command */
+    protected $command;
+
+    /**
+     * Phinx constructor.
+     * @param PathLocatorInterface $pathLocator
+     * @param ConfigBuilderInterface $configBuilder
+     * @param Command $command
+     */
+    public function __construct(
+        PathLocatorInterface $pathLocator,
+        ConfigBuilderInterface $configBuilder,
+        Command $command
+    ) {
+        $this->pathLocator = $pathLocator;
+        $this->configBuilder = $configBuilder;
+        $this->command = $command;
+    }
+
+
+    /**
+     * @param string $method optional
+     * @return string
+     */
+    public function getExecCommand($method = '') :string
+    {
+        $this->command->useExec = true;
+        $this->command->setCommand($this->pathLocator->getPhinxBinaryPath());
+        $this->command->addArg('--configuration=', $this->configBuilder->createConfigPath());
+        if (!empty($method)) {
+            $this->command->addArg($method);
+        }
+
+        return $this->command->getExecCommand();
+    }
+}

Command/Phinx/ConfigBuilder.php

@@ -0,0 +1,117 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PCF\MagentoMigration\Command\Phinx;
+
+use Magento\Framework\App\DeploymentConfig;
+use Magento\Framework\Config\ConfigOptionsListConstants;
+use Magento\Framework\Exception\LocalizedException;
+use PCF\MagentoMigration\Api\ConfigBuilderInterface;
+use PCF\MagentoMigration\Api\PathLocatorInterface;
+use Symfony\Component\Yaml\Dumper;
+
+class ConfigBuilder implements ConfigBuilderInterface
+{
+    /** @var DeploymentConfig */
+    protected $deploymentConfig;
+
+    /** @var PathLocatorInterface */
+    protected $pathLocator;
+
+    /** @var Dumper */
+    protected $yamlDumper;
+
+    protected $defaultDb = 'default';
+
+    /**
+     * @param DeploymentConfig $deploymentConfig
+     * @param PathLocatorInterface $pathLocator
+     * @param Dumper $yamlDumper
+     */
+    public function __construct(
+        DeploymentConfig $deploymentConfig,
+        PathLocatorInterface $pathLocator,
+        Dumper $yamlDumper
+    ) {
+        $this->deploymentConfig = $deploymentConfig;
+        $this->pathLocator = $pathLocator;
+        $this->yamlDumper = $yamlDumper;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function createConfigPath() :string
+    {
+        $yml = $this->yamlDumper->dump($this->getConfigArray(), 5);
+        $tmpFileName = tempnam(sys_get_temp_dir(), md5($yml));
+        file_put_contents($tmpFileName, $yml);
+
+        return $tmpFileName;
+    }
+
+    /**
+     * @param string $defaultDb
+     */
+    protected function setDefaultDb(string $defaultDb)
+    {
+        $this->defaultDb = $defaultDb;
+    }
+
+    /**
+     * @return array
+     */
+    protected function getConfigArray(): array
+    {
+        return [
+            'paths' => [ 'migrations' => $this->pathLocator->getAllMigrationDirs()],
+            'environments' => $this->getEnvironments()
+        ];
+    }
+
+    /**
+     * @throws LocalizedException
+     * todo: make port and charset configurable
+     */
+    protected function getDbConfig()
+    {
+         $magentoConfig = $this->deploymentConfig->getConfigData(ConfigOptionsListConstants::CONFIG_PATH_DB);
+
+        if (empty($magentoConfig['connection'])) {
+            throw new LocalizedException(__('no db connection given'));
+        }
+
+        $connections = [];
+        foreach ($magentoConfig['connection'] as $envName => $config) {
+            $connections[$envName] = [
+                'adapter' => 'mysql',
+                'host' => $config['host'],
+                'name' => $config['dbname'],
+                'user' => $config['username'],
+                'pass' => $config['password'],
+                'port' => 3306,
+                'charset' => 'utf8'
+            ];
+        }
+
+        if (empty($magentoConfig['connection']['default'])) {
+            $this->setDefaultDb(key($magentoConfig['connection']));
+        }
+
+        return $connections;
+    }
+
+    /**
+     * @return array
+     */
+    protected function getEnvironments() : array
+    {
+        $return = [
+              'default_migration_table' => 'phinxlog',
+              'default_database' => $this->defaultDb,
+        ];
+
+        return array_merge($return, $this->getDbConfig());
+    }
+}