@automattic/newspack-blocks 1.0.0-hotfix-cap-count-user-posts-dedup.1

package/src/blocks/donate/utils.ts

@@ -0,0 +1,108 @@
+import { __, _x, sprintf } from '@wordpress/i18n';
+import type { DonationFrequencySlug } from './types';
+
+const hexToRGB = ( hex: string ): number[] => {
+	const parts = hex
+		.replace( /^#?([a-f\d])([a-f\d])([a-f\d])$/i, ( m, r, g, b ) => '#' + r + r + g + g + b + b )
+		.substring( 1 )
+		.match( /.{2}/g );
+	if ( parts === null ) {
+		return [ 0, 0, 0 ];
+	}
+	return parts.map( x => parseInt( x, 16 ) );
+};
+
+export const getColorForContrast = ( color?: string ): string => {
+	const blackColor = '#000000';
+	const whiteColor = '#ffffff';
+	if ( color === undefined ) {
+		return blackColor;
+	}
+
+	const backgroundColorRGB = hexToRGB( color );
+	const blackRGB = hexToRGB( blackColor );
+
+	const l1 =
+		0.2126 * Math.pow( backgroundColorRGB[ 0 ] / 255, 2.2 ) +
+		0.7152 * Math.pow( backgroundColorRGB[ 1 ] / 255, 2.2 ) +
+		0.0722 * Math.pow( backgroundColorRGB[ 2 ] / 255, 2.2 );
+	const l2 =
+		0.2126 * Math.pow( blackRGB[ 0 ] / 255, 2.2 ) + 0.7152 * Math.pow( blackRGB[ 1 ] / 255, 2.2 ) + 0.0722 * Math.pow( blackRGB[ 2 ] / 255, 2.2 );
+
+	const contrastRatio = l1 > l2 ? ( l1 + 0.05 ) / ( l2 + 0.05 ) : ( l2 + 0.05 ) / ( l1 + 0.05 );
+
+	return contrastRatio > 5 ? blackColor : whiteColor;
+};
+
+export const getMigratedAmount = (
+	frequency: DonationFrequencySlug,
+	amounts: [ number, number, number ],
+	untieredAmount: number
+): [ number, number, number, number ] => {
+	const multiplier = frequency === 'month' ? 1 : 12;
+	return [ amounts[ 0 ] * multiplier, amounts[ 1 ] * multiplier, amounts[ 2 ] * multiplier, untieredAmount * multiplier ];
+};
+
+export const getFrequencyLabel = ( frequencySlug: DonationFrequencySlug, hideOnceLabel = false ) => {
+	// eslint-disable-next-line no-nested-ternary
+	return frequencySlug === 'once'
+		? hideOnceLabel
+			? ''
+			: __( 'once', 'newspack-blocks' )
+		: ' ' +
+				sprintf(
+					// Translators: %s is the frequency (e.g. per month, per year).
+					_x( 'per %s', 'per `Frequency`', 'newspack-blocks' ),
+					frequencySlug
+				);
+};
+
+export const getFormattedAmount = ( amount: number, withCurrency = false ) => {
+	type NumberFormatOptions = {
+		minimumFractionDigits: number;
+		style?: string;
+		currency?: string;
+	};
+	const options = < NumberFormatOptions >{
+		minimumFractionDigits: 0 === amount % 1 ? 0 : 2,
+	};
+	if ( withCurrency ) {
+		options.style = 'currency';
+		options.currency = window.newspack_blocks_data?.currency || 'USD';
+	}
+	const formatter = new Intl.NumberFormat( navigator?.language || 'en-US', options as object );
+
+	return formatter.format( amount );
+};
+
+export const getFrequencyLabelWithAmount = ( amount: number, frequencySlug: DonationFrequencySlug, hideOnceLabel = false ) => {
+	const template = window.newspack_blocks_data?.tier_amounts_template;
+
+	if ( ! template ) {
+		try {
+			const frequencyString =
+				frequencySlug === 'once'
+					? frequencySlug
+					: sprintf(
+							// Translators: %s is the %s is the frequency.
+							__( 'per %s', 'newspack-blocks' ),
+							frequencySlug
+					  );
+
+			const formattedPrice =
+				'<span class="price-amount">' +
+				getFormattedAmount( amount, true ) +
+				'</span> <span class="tier-frequency">' +
+				frequencyString +
+				'</span>';
+
+			return formattedPrice.replace( '.00', '' );
+		} catch ( e ) {
+			return '<span class="price-amount">' + amount + '</span>';
+		}
+	}
+
+	const frequency = getFrequencyLabel( frequencySlug, hideOnceLabel );
+
+	return template.replace( 'AMOUNT_PLACEHOLDER', getFormattedAmount( amount ) ).replace( 'FREQUENCY_PLACEHOLDER', frequency );
+};

package/src/blocks/donate/view.php

@@ -0,0 +1,29 @@
+<?php // phpcs:ignore Squiz.Commenting.FileComment.Missing
+/**
+ * Server-side rendering of the `newspack-blocks/donate` block.
+ *
+ * @package WordPress
+ */
+
+require_once NEWSPACK_BLOCKS__PLUGIN_DIR . 'src/blocks/donate/frontend/class-newspack-blocks-donate-renderer.php';
+
+/**
+ * Registers the `newspack-blocks/donate` block on server.
+ */
+function newspack_blocks_register_donate() {
+	$block_json = json_decode(
+		file_get_contents( __DIR__ . '/block.json' ), // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
+		true
+	);
+
+	register_block_type(
+		'newspack-blocks/' . $block_json['name'],
+		[
+			'api_version'     => $block_json['apiVersion'],
+			'attributes'      => $block_json['attributes'],
+			'render_callback' => 'Newspack_Blocks_Donate_Renderer::render',
+			'supports'        => $block_json['supports'],
+		]
+	);
+}
+add_action( 'init', 'newspack_blocks_register_donate' );

package/src/blocks/donate/view.ts

@@ -0,0 +1,44 @@
+/**
+ * Style dependencies
+ */
+import { isString } from 'lodash';
+import './styles/view.scss';
+
+type FormValues = { [ key: string ]: string };
+
+const CLASS_NAME_BASE = 'wpbnbd';
+const selectedClassNameBase = `${ CLASS_NAME_BASE }--selected`;
+
+const donateBlocks = Array.from( document.querySelectorAll( `.${ CLASS_NAME_BASE }` ) );
+
+export const updateBlockClassName = ( element: Element, formValues: FormValues ) => {
+	const amountKey = `donation_value_${ formValues.donation_frequency }`;
+	if ( amountKey ) {
+		Array.from( element.classList ).forEach( className => {
+			if ( className.startsWith( selectedClassNameBase ) ) {
+				element.classList.remove( className );
+			}
+		} );
+		element.classList.add( `${ selectedClassNameBase }-${ formValues[ amountKey ] }` );
+	}
+};
+
+export const getFormData: ( form: HTMLFormElement ) => FormValues = form => {
+	const formData = new FormData( form );
+	const formValues: FormValues = {};
+	formData.forEach( ( value, key ) => {
+		if ( isString( key ) && isString( value ) ) {
+			formValues[ key ] = value;
+		}
+	} );
+	return formValues;
+};
+
+donateBlocks.forEach( element => {
+	const form = element.querySelector( 'form' );
+	if ( ! form ) {
+		return;
+	}
+	updateBlockClassName( element, getFormData( form ) );
+	form.addEventListener( 'change', () => updateBlockClassName( element, getFormData( form ) ) );
+} );

package/src/blocks/homepage-articles/block.json

@@ -0,0 +1,260 @@
+{
+	"$schema": "https://schemas.wp.org/trunk/block.json",
+	"apiVersion": 3,
+	"name": "homepage-articles",
+	"category": "newspack",
+	"attributes": {
+		"className": {
+			"type": "string",
+			"default": ""
+		},
+		"showExcerpt": {
+			"type": "boolean",
+			"default": true
+		},
+		"showFullContent": {
+			"type": "boolean",
+			"default": false
+		},
+		"excerptLength": {
+			"type": "number",
+			"default": 55
+		},
+		"showReadMore": {
+			"type": "boolean",
+			"default": false
+		},
+		"infiniteScroll": {
+			"type": "boolean",
+			"default": false
+		},
+		"readMoreLabel": {
+			"type": "string",
+			"default": "Keep reading"
+		},
+		"showDate": {
+			"type": "boolean",
+			"default": true
+		},
+		"showImage": {
+			"type": "boolean",
+			"default": true
+		},
+		"showCaption": {
+			"type": "boolean",
+			"default": false
+		},
+		"showCredit": {
+			"type": "boolean",
+			"default": false
+		},
+		"disableImageLazyLoad": {
+			"type": "boolean",
+			"default": false
+		},
+		"fetchPriority": {
+			"type": "string",
+			"default": ""
+		},
+		"imageShape": {
+			"type": "string",
+			"default": "landscape"
+		},
+		"minHeight": {
+			"type": "integer",
+			"default": 0
+		},
+		"moreButton": {
+			"type": "boolean",
+			"default": false
+		},
+		"moreButtonText": {
+			"type": "string",
+			"default": ""
+		},
+		"showAuthor": {
+			"type": "boolean",
+			"default": true
+		},
+		"showAvatar": {
+			"type": "boolean",
+			"default": true
+		},
+		"showCategory": {
+			"type": "boolean",
+			"default": false
+		},
+		"postLayout": {
+			"type": "string",
+			"default": "list"
+		},
+		"columns": {
+			"type": "integer",
+			"default": 3
+		},
+		"colGap": {
+			"type": "integer",
+			"default": 3
+		},
+		"postsToShow": {
+			"type": "integer",
+			"default": 3
+		},
+		"mediaPosition": {
+			"type": "string",
+			"default": "top"
+		},
+		"authors": {
+			"type": "array",
+			"default": [],
+			"items": {
+				"type": "integer"
+			}
+		},
+		"categories": {
+			"type": "array",
+			"default": [],
+			"items": {
+				"type": "integer"
+			}
+		},
+		"categoryJoinType": {
+			"type": "string",
+			"default": "or",
+			"enum": [
+				"or",
+				"all"
+			]
+		},
+		"includeSubcategories": {
+			"type": "boolean",
+			"default": true
+		},
+		"tags": {
+			"type": "array",
+			"default": [],
+			"items": {
+				"type": "integer"
+			}
+		},
+		"customTaxonomies": {
+			"type": "array",
+			"default": [],
+			"items": {
+				"type": "object",
+				"properties": {
+					"slug": {
+						"type": "string"
+					},
+					"terms": {
+						"type": "array",
+						"items": {
+							"type": "integer"
+						}
+					}
+				}
+			}
+		},
+		"tagExclusions": {
+			"type": "array",
+			"default": [],
+			"items": {
+				"type": "integer"
+			}
+		},
+		"categoryExclusions": {
+			"type": "array",
+			"default": [],
+			"items": {
+				"type": "integer"
+			}
+		},
+		"customTaxonomyExclusions": {
+			"type": "array",
+			"default": [],
+			"items": {
+				"type": "object",
+				"properties": {
+					"slug": {
+						"type": "string"
+					},
+					"terms": {
+						"type": "array",
+						"items": {
+							"type": "integer"
+						}
+					}
+				}
+			}
+		},
+		"specificPosts": {
+			"type": "array",
+			"default": [],
+			"items": {
+				"type": "integer"
+			}
+		},
+		"typeScale": {
+			"type": "integer",
+			"default": 4
+		},
+		"imageScale": {
+			"type": "integer",
+			"default": 3
+		},
+		"mobileStack": {
+			"type": "boolean",
+			"default": false
+		},
+		"sectionHeader": {
+			"type": "string",
+			"default": ""
+		},
+		"specificMode": {
+			"type": "boolean",
+			"default": false
+		},
+		"textColor": {
+			"type": "string",
+			"default": ""
+		},
+		"customTextColor": {
+			"type": "string",
+			"default": ""
+		},
+		"singleMode": {
+			"type": "boolean",
+			"default": false
+		},
+		"showSubtitle": {
+			"type": "boolean",
+			"default": false
+		},
+		"postType": {
+			"type": "array",
+			"default": [
+				"post"
+			],
+			"items": {
+				"type": "string"
+			}
+		},
+		"textAlign": {
+			"type": "string",
+			"default": ""
+		},
+		"includedPostStatuses": {
+			"type": "array",
+			"default": [
+				"publish"
+			],
+			"items": {
+				"type": "string"
+			}
+		},
+		"deduplicate": {
+			"type": "boolean",
+			"default": true
+		}
+	}
+}

package/src/blocks/homepage-articles/class-wp-rest-newspack-articles-controller.php

@@ -0,0 +1,231 @@
+<?php
+/**
+ * WP_REST_Newspack_Articles_Controller file.
+ *
+ * @package WordPress
+ */
+
+// phpcs:disable WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedClassFound
+/**
+ * Class WP_REST_Newspack_Articles_Controller.
+ */
+class WP_REST_Newspack_Articles_Controller extends WP_REST_Controller {
+// phpcs:enable WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedClassFound
+
+	/**
+	 * Attribute schema.
+	 *
+	 * @var array
+	 */
+	public $attribute_schema;
+
+	/**
+	 * Constructs the controller.
+	 *
+	 * @access public
+	 */
+	public function __construct() {
+		$this->namespace = 'newspack-blocks/v1';
+	}
+
+	/**
+	 * Registers the necessary REST API routes.
+	 *
+	 * @access public
+	 */
+	public function register_routes() {
+		// Endpoint to get articles on the front-end.
+		register_rest_route(
+			$this->namespace,
+			'/articles',
+			[
+				[
+					'methods'             => WP_REST_Server::READABLE,
+					'callback'            => [ $this, 'get_items' ],
+					'args'                => $this->get_attribute_schema(),
+					'permission_callback' => '__return_true',
+				],
+			]
+		);
+
+		// Endpoint to get articles in the editor, in regular/query mode.
+		register_rest_route(
+			$this->namespace,
+			'/newspack-blocks-posts',
+			[
+				'methods'             => \WP_REST_Server::READABLE,
+				'callback'            => [ 'Newspack_Blocks_API', 'posts_endpoint' ],
+				'args'                => array_merge(
+					$this->get_attribute_schema(),
+					[
+						'exclude' => [ // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_exclude
+							'type'    => 'array',
+							'items'   => array(
+								'type' => 'integer',
+							),
+							'default' => array(),
+						],
+						'include' => [
+							'type'    => 'array',
+							'items'   => array(
+								'type' => 'integer',
+							),
+							'default' => array(),
+						],
+					]
+				),
+				'permission_callback' => function() {
+					return current_user_can( 'edit_posts' );
+				},
+			]
+		);
+
+		// Endpoint to get articles in the editor, in specific posts mode.
+		register_rest_route(
+			$this->namespace,
+			'/newspack-blocks-specific-posts',
+			[
+				'methods'             => \WP_REST_Server::READABLE,
+				'callback'            => [ 'Newspack_Blocks_API', 'specific_posts_endpoint' ],
+				'args'                => [
+					'search'      => [
+						'sanitize_callback' => 'sanitize_text_field',
+					],
+					'postsToShow' => [
+						'sanitize_callback' => 'absint',
+					],
+					'postType'    => [
+						'type'    => 'array',
+						'items'   => array(
+							'type' => 'string',
+						),
+						'default' => array(),
+					],
+				],
+				'permission_callback' => function() {
+					return current_user_can( 'edit_posts' );
+				},
+			]
+		);
+	}
+
+	/**
+	 * Returns a list of rendered posts.
+	 *
+	 * @param WP_REST_Request $request Request object.
+	 * @return WP_REST_Response
+	 */
+	public function get_items( $request ) {
+		$page        = (int) $request->get_param( 'page' ) ?? 1;
+		$exclude_ids = $request->get_param( 'exclude_ids' ) ?? [];
+		$next_page   = $page + 1;
+		$attributes  = wp_parse_args(
+			$request->get_params() ?? [],
+			wp_list_pluck( $this->get_attribute_schema(), 'default' )
+		);
+
+		$deduplicate = $request->get_param( 'deduplicate' ) ?? 1;
+		if ( ! $deduplicate ) {
+			$exclude_ids = [];
+		}
+
+		$article_query_args = Newspack_Blocks::build_articles_query( $attributes, apply_filters( 'newspack_blocks_block_name', 'newspack-blocks/homepage-articles' ) );
+
+		// If using exclude_ids, don't worry about pagination. Just get the next postsToShow number of results without the excluded posts. Otherwise, use standard WP pagination.
+		$query = ! empty( $exclude_ids ) ?
+			array_merge(
+				$article_query_args,
+				[
+					'post__not_in' => $exclude_ids, // phpcs:ignore WordPressVIPMinimum.Performance.WPQueryParams.PostNotIn_post__not_in
+				]
+			) :
+			array_merge(
+				$article_query_args,
+				[
+					'paged' => $page,
+				]
+			);
+
+		// Run Query.
+		$article_query = new WP_Query( $query );
+
+		// Defaults.
+		$items    = [];
+		$ids      = [];
+		$next_url = '';
+
+		Newspack_Blocks::filter_excerpt( $attributes );
+
+		// The Loop.
+		while ( $article_query->have_posts() ) {
+			$article_query->the_post();
+			$html = Newspack_Blocks::template_inc(
+				__DIR__ . '/templates/article.php',
+				[
+					'attributes' => $attributes,
+				]
+			);
+
+			$items[]['html'] = $html;
+			$ids[]           = get_the_ID();
+		}
+
+		Newspack_Blocks::remove_excerpt_filter();
+
+		// Provide next URL if there are more pages.
+		$show_next_button = ! empty( $exclude_ids ) ? $article_query->max_num_pages > 1 : $article_query->max_num_pages > $next_page;
+		if ( $show_next_button ) {
+			$next_url = add_query_arg(
+				array_merge(
+					array_map(
+						function( $attribute ) {
+							return false === $attribute ? '0' : $attribute;
+						},
+						$attributes
+					),
+					[
+						'exclude_ids' => false,
+						'page'        => $next_page,
+					]
+				),
+				rest_url( '/newspack-blocks/v1/articles' )
+			);
+		}
+
+		return rest_ensure_response(
+			[
+				'items' => $items,
+				'ids'   => $ids,
+				'next'  => $next_url,
+			]
+		);
+	}
+
+	/**
+	 * Sets up and returns attribute schema.
+	 *
+	 * @return array
+	 */
+	public function get_attribute_schema() {
+		if ( empty( $this->attribute_schema ) ) {
+			$block_json = json_decode(
+				file_get_contents( __DIR__ . '/block.json' ), // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
+				true
+			);
+
+			$this->attribute_schema = array_merge(
+				$block_json['attributes'],
+				[
+					'exclude_ids' => [
+						'type'    => 'array',
+						'default' => [],
+						'items'   => [
+							'type' => 'integer',
+						],
+					],
+				]
+			);
+		}
+		return $this->attribute_schema;
+	}
+}