feat: content rule exclusion logic and tests

Author: dkoo

includes/content-gate/class-content-restriction-control.php

@@ -121,9 +121,10 @@ public static function get_post_gates( $post_id = null ) {
 			}
 
 			foreach ( $content_rules as $content_rule ) {
+				$is_exclusion = isset( $content_rule['exclusion'] ) && $content_rule['exclusion'];
 				if ( $content_rule['slug'] === 'post_types' ) {
 					$post_type = get_post_type( $post_id );
-					if ( ! in_array( $post_type, $content_rule['value'], true ) ) {
+					if ( $is_exclusion ? in_array( $post_type, $content_rule['value'], true ) : ! in_array( $post_type, $content_rule['value'], true ) ) {
 						continue 2;
 					}
 				} else {
@@ -132,10 +133,10 @@ public static function get_post_gates( $post_id = null ) {
 						continue 2;
 					}
 					$terms = wp_get_post_terms( $post_id, $content_rule['slug'], [ 'fields' => 'ids' ] );
-					if ( ! $terms || is_wp_error( $terms ) ) {
+					if ( ( ! $is_exclusion && ! $terms ) || is_wp_error( $terms ) ) {
 						continue 2;
 					}
-					if ( empty( array_intersect( $terms, $content_rule['value'] ) ) ) {
+					if ( $is_exclusion ? ! empty( array_intersect( $terms, $content_rule['value'] ) ) : empty( array_intersect( $terms, $content_rule['value'] ) ) ) {
 						continue 2;
 					}
 				}

includes/wizards/audience/class-audience-content-gates.php

@@ -242,8 +242,9 @@ public function register_api_endpoints() {
 								'items' => [
 									'type'       => 'object',
 									'properties' => [
-										'slug'  => [ 'type' => 'string' ],
-										'value' => [ 'type' => 'mixed' ],
+										'slug'      => [ 'type' => 'string' ],
+										'value'     => [ 'type' => 'mixed' ],
+										'exclusion' => [ 'type' => 'boolean' ],
 									],
 								],
 							],
@@ -388,12 +389,18 @@ public function sanitize_content_rule( $content_rule ) {
 			}
 		}
 
-		$value = array_values( array_filter( array_map( 'sanitize_text_field', $content_rule['value'] ) ) );
+		$value     = array_values( array_filter( array_map( 'sanitize_text_field', $content_rule['value'] ) ) );
+		$exclusion = isset( $content_rule['exclusion'] ) ? boolval( $content_rule['exclusion'] ) : false;
 
-		return [
+		$sanitized_rule = [
 			'slug'  => $slug,
 			'value' => $value,
 		];
+		if ( $exclusion ) {
+			$sanitized_rule['exclusion'] = $exclusion;
+		}
+
+		return $sanitized_rule;
 	}
 
 	/**

src/wizards/audience/views/content-gates/content-rule-control.tsx

@@ -14,34 +14,38 @@ import { CheckboxControl } from '@wordpress/components';
 import ContentRuleControlTaxonomy from './content-rule-control-taxonomy';
 import { FormTokenField } from '../../../../../packages/components/src';
 
-const noop = () => {};
-
-export default function ContentRuleControl( { slug, value, onChange }: GateContentRuleControlProps ) {
+export default function ContentRuleControl( { slug, value, exclusion, onChange, onChangeExclusion }: GateContentRuleControlProps ) {
 	const rule = window.newspackAudienceContentGates.available_content_rules[ slug ];
 
 	if ( ! rule || ! Array.isArray( value ) ) {
 		return null;
 	}
 
-	if ( rule.options && rule.options.length > 0 ) {
-		return (
-			<div className="newspack-content-gates__content-rule-control">
+	return (
+		<div className="newspack-content-gates__content-rule-control">
+			{ rule.options && rule.options.length > 0 ? (
 				<FormTokenField
 					label={ rule.name }
 					value={ rule.options.filter( o => value.includes( o.value ) ).map( o => o.label ) }
 					onChange={ ( items: string[] ) => onChange( rule.options?.filter( o => items.includes( o.label ) ).map( o => o.value ) ?? [] ) }
 					suggestions={ rule.options.map( o => o.label ) }
 					__experimentalExpandOnFocus={ true }
 				/>
-				<CheckboxControl
-					label={ __( 'Exclusion rule', 'newspack-plugin' ) }
-					help={ __( 'Apply this rule to everything EXCEPT the items matching the above.', 'newspack-plugin' ) }
-					checked={ false }
-					onChange={ noop }
+			) : (
+				<ContentRuleControlTaxonomy
+					slug={ slug }
+					value={ value }
+					exclusion={ exclusion }
+					onChange={ onChange }
+					onChangeExclusion={ onChangeExclusion }
 				/>
-			</div>
-		);
-	}
-
-	return <ContentRuleControlTaxonomy slug={ slug } value={ value } onChange={ onChange } />;
+			) }
+			<CheckboxControl
+				label={ __( 'Exclusion rule', 'newspack-plugin' ) }
+				help={ __( 'Apply this rule to everything EXCEPT the items matching the above.', 'newspack-plugin' ) }
+				checked={ exclusion ?? false }
+				onChange={ e => onChangeExclusion( e ) }
+			/>
+		</div>
+	);
 }

src/wizards/audience/views/content-gates/content-rules.tsx

@@ -51,6 +51,13 @@ export default function ContentRules( { rules, onChange }: ContentRulesProps ) {
 		[ onChange, rules ]
 	);
 
+	const handleChangeExclusion = useCallback(
+		( slug: string ) => ( e: boolean ) => {
+			onChange( rules.map( r => ( r.slug === slug ? { ...r, exclusion: e } : r ) ) );
+		},
+		[ onChange, rules ]
+	);
+
 	return (
 		<ActionCard
 			title={ __( 'Content Rules', 'newspack-plugin' ) }
@@ -66,7 +73,14 @@ export default function ContentRules( { rules, onChange }: ContentRulesProps ) {
 		>
 			<Grid columns={ Math.min( 3, rules.length ) } gutter={ 32 }>
 				{ rules.map( ( rule: GateContentRule ) => (
-					<ContentRuleControl key={ rule.slug } slug={ rule.slug } value={ rule.value } onChange={ handleChange( rule.slug ) } />
+					<ContentRuleControl
+						key={ rule.slug }
+						slug={ rule.slug }
+						value={ rule.value }
+						exclusion={ rule.exclusion }
+						onChange={ handleChange( rule.slug ) }
+						onChangeExclusion={ handleChangeExclusion( rule.slug ) }
+					/>
 				) ) }
 			</Grid>
 		</ActionCard>

src/wizards/audience/views/content-gates/types/index.d.ts

@@ -50,12 +50,15 @@ type GateAccessRuleControlProps = {
 type GateContentRule = {
 	slug: string;
 	value: string[];
+	exclusion?: boolean;
 };
 
 type GateContentRuleControlProps = {
 	slug: string;
 	value: GateContentRuleValue;
+	exclusion?: boolean;
 	onChange: (value: GateContentRuleValue) => void;
+	onChangeExclusion: (value: boolean) => void;
 };
 
 type GateStatus = 'publish' | 'draft' | 'pending' | 'future' | 'private' | 'trash';
@@ -70,5 +73,4 @@ type Gate = {
 	priority: number;
 	status: GateStatus;
 	isExpanded?: boolean;
-	collapse?: boolean;
 };

tests/unit-tests/content-gate/content-gates.php

@@ -220,5 +220,24 @@ public function test_content_rules() {
 
 		$gates = Content_Restriction_Control::get_post_gates( $post2 );
 		$this->assertCount( 0, $gates, 'No gates for the post in category 2' );
+
+		// Make the content rule an exclusion rule.
+		Content_Gate::update_post_content_rules(
+			$this->gate_ids[2],
+			[
+				[
+					'slug'      => 'category',
+					'value'     => [ $cat1 ],
+					'exclusion' => true,
+				],
+			]
+		);
+
+		$gates = Content_Restriction_Control::get_post_gates( $post1 );
+		$this->assertCount( 0, $gates, 'No gates for the post in category 1' );
+
+		$gates = Content_Restriction_Control::get_post_gates( $post2 );
+		$this->assertCount( 1, $gates, 'One gate for the post in category 2' );
+		$this->assertEquals( $this->gate_ids[2], $gates[0]['id'], 'Gate with publish status and matching rules configuration is included' );
 	}
 }