PHP_Typography\Fixes\Node_Fixes\Smart_Quotes_Fix

Complexity

Total Complexity

13

Size/Duplication

Total Lines	244
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	6
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	apply()	0	129	5
B	calc_adjacent_length()	0	12	7
A	update_smart_quotes_brackets()	0	25	1

<?php
/**
 *  This file is part of PHP-Typography.
 *
 *  Copyright 2014-2019 Peter Putzer.
 *  Copyright 2009-2011 KINGdesk, LLC.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *  ***
 *
 *  @package mundschenk-at/php-typography
 *  @license http://www.gnu.org/licenses/gpl-2.0.html
 */

namespace PHP_Typography\Fixes\Node_Fixes;

use PHP_Typography\DOM;
use PHP_Typography\RE;
use PHP_Typography\Settings;
use PHP_Typography\Strings;
use PHP_Typography\U;

/**
 * Applies smart quotes (if enabled).
 *
 * @author Peter Putzer <github@mundschenk.at>
 *
 * @since 5.0.0
 */
class Smart_Quotes_Fix extends Abstract_Node_Fix {

	const NUMBERS_BEFORE_PRIME = '\b(?:\d+\/)?\d{1,3}';

	const DOUBLE_PRIME        = '/(' . self::NUMBERS_BEFORE_PRIME . ")(?:''|\")(?=\W|\Z|-\w)/S";
	const SINGLE_PRIME        = '/(' . self::NUMBERS_BEFORE_PRIME . ")'(?=\W|\Z|-\w)/S";
	const SINGLE_DOUBLE_PRIME = '/(' . self::NUMBERS_BEFORE_PRIME . ")'(\s*)(\b(?:\d+\/)?\d+)(?:''|\")(?=\W|\Z)/S";

	const SINGLE_QUOTED_NUMBERS = "/(?<=\W|\A)'([^\"]*\d+)'(?=\W|\Z)/S";
	const DOUBLE_QUOTED_NUMBERS = '/(?<=\W|\A)"([^"]*\d+)"(?=\W|\Z)/S';
	const COMMA_QUOTE           = '/(?<=\s|\A),(?=\S)/S';
	const APOSTROPHE_WORDS      = "/(?<=\w)'(?=\w)/S";
	const APOSTROPHE_DECADES    = "/'(\d\d(s|er)?\b)/S"; // Allow both English '80s and German '80er.
	const SINGLE_QUOTE_OPEN     = "/(?: '(?=\w) )  | (?: (?<=\s|\A)'(?=\S) )/Sx"; // Alternative is for expressions like _'¿hola?'_.
	const SINGLE_QUOTE_CLOSE    = "/(?: (?<=\w)' ) | (?: (?<=\S)'(?=\s|\Z) )/Sx";
	const DOUBLE_QUOTE_OPEN     = '/(?: "(?=\w) )  | (?: (?<=\s|\A)"(?=\S) )/Sx';
	const DOUBLE_QUOTE_CLOSE    = '/(?: (?<=\w)" ) | (?: (?<=\S)"(?=\s|\Z) )/Sx';

	/**
	 * Cached primary quote style.
	 *
	 * @var \PHP_Typography\Settings\Quotes|null
	 */
	protected $cached_primary_quotes;

	/**
	 * Cached secondary quote style.
	 *
	 * @var \PHP_Typography\Settings\Quotes|null
	 */
	protected $cached_secondary_quotes;

	/**
	 * Brackets matching array (depending on quote styles).
	 *
	 * @var array
	 */
	protected $brackets_matches;

	/**
	 * Brackets replacement array (depending on quote styles).
	 *
	 * @var array
	 */
	protected $brackets_replacements;

	/**
	 * Apply the fix to a given textnode.
	 *
	 * @param \DOMText $textnode Required.
	 * @param Settings $settings Required.
	 * @param bool     $is_title Optional. Default false.
	 */
	public function apply( \DOMText $textnode, Settings $settings, $is_title = false ) {
		if ( empty( $settings[ Settings::SMART_QUOTES ] ) ) {
			return;
		}

		// Need to get context of adjacent characters outside adjacent inline tags or HTML comment
		// if we have adjacent characters add them to the text.
		$previous_character = DOM::get_prev_chr( $textnode );
		$next_character     = DOM::get_next_chr( $textnode );
		$node_data          = "{$previous_character}{$textnode->data}{$next_character}";
		$f                  = Strings::functions( $node_data );

		// Various special characters and regular expressions.
		$double = $settings->primary_quote_style();
		$single = $settings->secondary_quote_style();

		// Mark quotes to ensure proper removal of replaced adjacent characters.
		$double_open  = RE::ESCAPE_MARKER . $double->open() . RE::ESCAPE_MARKER;
		$double_close = RE::ESCAPE_MARKER . $double->close() . RE::ESCAPE_MARKER;
		$single_open  = RE::ESCAPE_MARKER . $single->open() . RE::ESCAPE_MARKER;
		$single_close = RE::ESCAPE_MARKER . $single->close() . RE::ESCAPE_MARKER;

		if ( $double != $this->cached_primary_quotes || $single != $this->cached_secondary_quotes ) { // phpcs:ignore WordPress.PHP.StrictComparisons.LooseComparison -- object value comparison.
			$this->update_smart_quotes_brackets( $double_open, $double_close, $single_open, $single_close );
			$this->cached_primary_quotes   = $double;
			$this->cached_secondary_quotes = $single;
		}

		// Handle excpetions first.
		if ( ! empty( $settings[ Settings::SMART_QUOTES_EXCEPTIONS ] ) ) {
			$node_data = \str_replace( $settings[ Settings::SMART_QUOTES_EXCEPTIONS ]['patterns'], $settings[ Settings::SMART_QUOTES_EXCEPTIONS ]['replacements'], $node_data );
		}

		// Before primes, handle quoted numbers (and quotes ending in numbers).
		$node_data = \preg_replace(
			[
				self::SINGLE_QUOTED_NUMBERS . $f['u'],
				self::DOUBLE_QUOTED_NUMBERS . $f['u'],
			],
			[
				"{$single_open}\$1{$single_close}",
				"{$double_open}\$1{$double_close}",
			],
			$node_data
		);

		// Guillemets.
		$node_data = \str_replace( [ '<<', '>>' ], [ U::GUILLEMET_OPEN, U::GUILLEMET_CLOSE ],  $node_data );

		// Primes.
		$node_data = \preg_replace(
			[
				self::SINGLE_DOUBLE_PRIME . $f['u'],
				self::DOUBLE_PRIME . $f['u'], // should not interfere with regular quote matching.
				self::SINGLE_PRIME . $f['u'],
			],
			[
				'$1' . U::SINGLE_PRIME . '$2$3' . U::DOUBLE_PRIME, // @codeCoverageIgnoreStart
				'$1' . U::DOUBLE_PRIME,
				'$1' . U::SINGLE_PRIME, // @codeCoverageIgnoreEnd
			],
			$node_data
		);

		// Backticks & comma quotes.
		$node_data = \str_replace(
			[ '``', '`', "''", ',,' ],
			[ $double_open, $single_open, $double_close, U::DOUBLE_LOW_9_QUOTE ],
			$node_data
		);
		$node_data = \preg_replace( self::COMMA_QUOTE . $f['u'], U::SINGLE_LOW_9_QUOTE, $node_data ); // like _,¿hola?'_.

		// Apostrophes.
		$node_data = \preg_replace(
			[ self::APOSTROPHE_WORDS . $f['u'], self::APOSTROPHE_DECADES . $f['u'] ],
			[ U::APOSTROPHE, U::APOSTROPHE . '$1' ],
			$node_data
		);

		// Quotes.
		$node_data = \str_replace( $this->brackets_matches, $this->brackets_replacements, $node_data );
		$node_data = \preg_replace(
			[
				self::SINGLE_QUOTE_OPEN . $f['u'],
				self::SINGLE_QUOTE_CLOSE . $f['u'],
				self::DOUBLE_QUOTE_OPEN . $f['u'],
				self::DOUBLE_QUOTE_CLOSE . $f['u'],
			],
			[
				$single_open,
				$single_close,
				$double_open,
				$double_close,
			],
			$node_data
		);

		// Quote catch-alls - assume left over quotes are closing - as this is often the most complicated position, thus most likely to be missed.
		$node_data = \str_replace( [ "'", '"' ], [ $single_close, $double_close ], $node_data );

		// Add a thin non-breaking space between secondary and primary quotes.
		$node_data = \str_replace(
			[ "{$double_open}{$single_open}", "{$single_close}{$double_close}" ],
			[ $double_open . U::NO_BREAK_NARROW_SPACE . $single_open, $single_close . U::NO_BREAK_NARROW_SPACE . $double_close ],
			$node_data
		);

		// Check if adjacent characters where replaced with multi-byte replacements.
		$quotes          = [
			$double_open,
			$double_close,
			$single_open,
			$single_close,
			U::GUILLEMET_OPEN, // @codeCoverageIgnoreStart
			U::GUILLEMET_CLOSE,
			U::DOUBLE_PRIME,
			U::SINGLE_PRIME,
			U::APOSTROPHE,
			U::DOUBLE_LOW_9_QUOTE,
			U::SINGLE_LOW_9_QUOTE, // @codeCoverageIgnoreEnd
		];
		$previous_length = self::calc_adjacent_length( $f['strlen']( $previous_character ), $previous_character, $node_data, $quotes, $f['substr'], $f['strlen'], false );
		$next_length     = self::calc_adjacent_length( $f['strlen']( $next_character ), $next_character, $node_data, $quotes, $f['substr'], $f['strlen'], true );

		// If we have adjacent characters, remove them from the text.
		$node_data = self::remove_adjacent_characters( $node_data, $f['strlen'], $f['substr'], $previous_length, $next_length );

		// Remove the escape markers and restore the text to the actual node.
		$textnode->data = \str_replace( RE::ESCAPE_MARKER, '', $node_data );
	}

	/**
	 * Calculates the adjacent character length.
	 *
	 * @param  int      $current_length     The current length of the adjacent character(s).
	 * @param  string   $adjacent_character The adjacent character.
	 * @param  string   $haystack           The complete string.
	 * @param  string[] $needles            The replacement(s) to look for.
	 * @param  callable $substr             A `substr`-like function.
	 * @param  callable $strlen             A 'strlen'-like function.
	 * @param  bool     $reverse            Optional. Default false.
	 *
	 * @return int
	 */
	private static function calc_adjacent_length( $current_length, $adjacent_character, $haystack, array $needles, callable $substr, callable $strlen, $reverse = false ) {
		if ( $current_length > 0 && $adjacent_character !== $substr( $haystack, $reverse ? -$current_length : 0, $current_length ) ) {
			foreach ( $needles as $needle ) {
				$len = $strlen( $needle );

				if ( $needle === $substr( $haystack, ( $reverse ? -$len : 0 ), $len ) ) {
					return $len;
				}
			}
		}

		return $current_length;
	}

	/**
	 * Update smartQuotesBrackets component after quote style change.
	 *
	 * @param  string $primary_open    Primary quote style open.
	 * @param  string $primary_close   Primary quote style close.
	 * @param  string $secondary_open  Secondary quote style open.
	 * @param  string $secondary_close Secondary quote style close.
	 */
	private function update_smart_quotes_brackets( $primary_open, $primary_close, $secondary_open, $secondary_close ) {
		$brackets = [
			// Single quotes.
			"['"  => '[' . $secondary_open,
			"{'"  => '{' . $secondary_open,
			"('"  => '(' . $secondary_open,
			"']"  => $secondary_close . ']',
			"'}"  => $secondary_close . '}',
			"')"  => $secondary_close . ')',

			// Double quotes.
			'["'  => '[' . $primary_open,
			'{"'  => '{' . $primary_open,
			'("'  => '(' . $primary_open,
			'"]'  => $primary_close . ']',
			'"}'  => $primary_close . '}',
			'")'  => $primary_close . ')',

			// Quotes & quotes.
			"\"'" => $primary_open . $secondary_open,
			"'\"" => $secondary_close . $primary_close,
		];

		$this->brackets_matches      = \array_keys( $brackets );
		$this->brackets_replacements = \array_values( $brackets );
	}
}