Approvals.php

<?php

class Approvals {
	private static $reporter = null;
	
	public static function approveString($received) {
		self::approve(new TextWriter($received, 'txt'), new PHPUnitNamer(), self::getReporter('txt'));
	}
	
	public static function getReporter($extensionWithoutDot) {
		if (is_null(self::$reporter)) {
		switch($extensionWithoutDot) {
			case 'html':
			case 'pdf':
				return new OpenReceivedFileReporter();
				break;
			default:
				return new PHPUnitReporter();
			}
		}
		return self::$reporter;
	}
	
	public static function useReporter(Reporter $reporter) {
		self::$reporter = $reporter;
	}
	
	public static function approve(Writer $writer, $namer, Reporter $reporter) {
		$extension = $writer->getExtensionWithoutDot();
		$approvedFilename = $namer->getApprovedFile($extension);
		$receivedFilename = $writer->write($namer->getReceivedFile($extension));
		if (!file_exists($approvedFilename)) {
			$approvedContents = null;
		} else {
			$approvedContents = file_get_contents($approvedFilename);
		}
		$receivedContents = file_get_contents($receivedFilename);
		if ($approvedContents === $receivedContents) {
			unlink($receivedFilename);
		} else {
			$hint = "\n------ To Approve, use the following command ------\n";
			$hint .= 'mv -v "' . addslashes($receivedFilename) . '" "' . addslashes($approvedFilename) . "\"\n";
			$hint .= "\n\n";
			$reporter->reportFailure($approvedFilename, $receivedFilename); 
			throw new RuntimeException('Approval File Mismatch: ' . $receivedFilename . ' does not match ' . $approvedFilename . $hint);
		}
	}
	
	/**
	 * @todo Refactor - Too much duplication with approve().  
	 */
	public static function approvePartial(Writer $writer, $namer, Reporter $reporter) {
		$extension = $writer->getExtensionWithoutDot();
		$approvedFilename = $namer->getApprovedFile($extension);
		$receivedFilename = $writer->write($namer->getReceivedFile($extension));
		if (!file_exists($approvedFilename)) {
			$approvedContents = null;
		} else {
			$approvedContents = file_get_contents($approvedFilename);
		}
		$receivedContents = file_get_contents($receivedFilename);
		if (strstr($receivedContents, $approvedContents)) {
			unlink($receivedFilename);
		} else {
			$hint = "\n------ To Approve, use the following command ------\n";
			$hint .= 'mv -v "' . addslashes($receivedFilename) . '" "' . addslashes($approvedFilename) . "\"\n";
			$hint .= "\n\n";
			$reporter->reportFailure($approvedFilename, $receivedFilename); 
			throw new RuntimeException('Approval File Mismatch: ' . $receivedFilename . ' does not contain ' . $approvedFilename . $hint);
		}
	}
	
	public static function approveTransformedList(array $list, $callbackObject, $methodName) {
		$string = '';
		foreach($list as $item) {
			$string .= $item . ' -> ' . $callbackObject->$methodName($item) . "\n";
		}
		self::approveString($string);
	}
	
	public static function approveList(array $list) {
		$string = '';
		foreach($list as $key => $item) {
			$string .= '[' . $key . '] -> ' . $item . "\n";
		}
		self::approveString($string);
	}
	
	public static function approveHtml($html) {
		self::approve(new TextWriter($html, 'html'), new PHPUnitNamer(), self::getReporter('html'));
	}
	
	public static function approvePartialHtml($html) {
		self::approvePartial(new TextWriter($html, 'html'), new PHPUnitNamer(), self::getReporter('html'));
	}
	
}