SebastianFeldmann\CaptainHook\Hook\Composer\Action\CheckLockFile

Complexity

Total Complexity

9

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

96.3%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	execute()	0	12	2
A	getLockFileHash()	0	11	2
A	getConfigFileHash()	0	15	3
A	loadFile()	0	7	2

<?php
/**
 * This file is part of CaptainHook.
 *
 * (c) Sebastian Feldmann <sf@sebastian.feldmann.info>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace SebastianFeldmann\CaptainHook\Hook\Composer\Action;

use SebastianFeldmann\CaptainHook\Config;
use SebastianFeldmann\CaptainHook\Console\IO;
use SebastianFeldmann\CaptainHook\Hook\Action;
use SebastianFeldmann\Git\Repository;

/**
 * Class CheckLockFile
 *
 * @package CaptainHook
 * @author  Sebastian Feldmann <sf@sebastian-feldmann.info>
 * @link    https://github.com/sebastianfeldmann/captainhook
 * @since   Class available since Release 1.0.1
 */
class CheckLockFile implements Action
{
    /**
     * Composer configuration keys that are relevant for the 'content-hash' creation.
     *
     * @var array
     */
    private $relevantKeys    = [
        'name',
        'version',
        'require',
        'require-dev',
        'conflict',
        'replace',
        'provide',
        'minimum-stability',
        'prefer-stable',
        'repositories',
        'extra',
    ];

    /**
     * Executes the action.
     *
     * @param  \SebastianFeldmann\CaptainHook\Config         $config
     * @param  \SebastianFeldmann\CaptainHook\Console\IO     $io
     * @param  \SebastianFeldmann\Git\Repository             $repository
     * @param  \SebastianFeldmann\CaptainHook\Config\Action  $action
     * @throws \Exception
     */
    public function execute(Config $config, IO $io, Repository $repository, Config\Action $action)
    {
        $path           = $action->getOptions()->get('path', getcwd());
        $lockFileHash   = $this->getLockFileHash($path);
        $configFileHash = $this->getConfigFileHash($path);

        if ($lockFileHash !== $configFileHash) {
            throw new \Exception('composer.lock is out of date');
        }

        $io->write('<info>composer.lock is up to date</info>');
    }

    /**
     * Read the composer.lock file and extract the composer.json hash.
     *
     * @param  string $path
     * @return string
     * @throws \Exception
     */
    private function getLockFileHash(string $path) : string
    {
        $lockFile = json_decode($this->loadFile($path . DIRECTORY_SEPARATOR . 'composer.lock'));
        $hashKey  = 'content-hash';

        if (!isset($lockFile->$hashKey)) {
            throw new \Exception('could not find content hash, please update composer to the latest version');
        }

        return $lockFile->$hashKey;
    }

    /**
     * Read the composer.json file and create a md5 hash on its relevant content.
     * This more or less is composer internal code to generate the content-hash
     *
     * @param  string $path
     * @return string
     */
    private function getConfigFileHash(string $path) : string
    {
        $content         = json_decode($this->loadFile($path . DIRECTORY_SEPARATOR . 'composer.json'), true);
        $relevantContent = [];

        foreach (array_intersect($this->relevantKeys, array_keys($content)) as $key) {
            $relevantContent[$key] = $content[$key];
        }
        if (isset($content['config']['platform'])) {
            $relevantContent['config']['platform'] = $content['config']['platform'];
        }
        ksort($relevantContent);

        return md5(json_encode($relevantContent));
    }

    /**
     * Load a composer file.
     *
     * @param  string $file
     * @return string
     * @throws \Exception
     */
    private function loadFile(string $file) : string
    {
        if (!file_exists($file)) {
            throw new \Exception($file . ' not found');
        }
        return file_get_contents($file);
    }
}