diff --git a/README.md b/README.md index f7b75b2..d548eca 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,12 @@ server sees. ## Using it - **Donation page:** add the shortcode `[streamgoals_donate]` to a page (or `[streamgoals_donate goal="ID"]` to pin one goal). + - `show_progress="no"` hides the progress bar above the form (default `yes`; also accepts `true/false/1/0`). + - `[streamgoals_progress]` (or `[streamgoals_progress goal="ID"]`) shows just the progress bar, e.g. in a sidebar or a stream page. + The bar shows raised / target, the percentage and, for tiered goals, the current tier and its target, using the same + numbers as the overlay (base amounts, or including fees only if the goal counts fees). It refreshes after a donation and + about every 30 seconds while the tab is visible, from the public `GET /wp-json/streamgoals/v1/progress?goal=ID` (totals only). + The first render is server-side HTML, so page caches and Cloudflare are fine. - **Goals:** StreamGoals → Goals. Create as many as you like; each can have its own rules. - **Rules (time and counters):** per goal, e.g. "+60 seconds per $1" (subathon timer), "+1 per $10" (counter), or a bonus event above a minimum amount. Amounts can be measured on the base donation or including fee cover. diff --git a/assets/donate/donate.css b/assets/donate/donate.css index 281b65c..4fb13ae 100644 --- a/assets/donate/donate.css +++ b/assets/donate/donate.css @@ -42,3 +42,14 @@ .sg-donate .sg-presets.sg-actions{padding:0 5px} .sg-donate .sg-notice{margin:.6rem 0 0;font-size:.9em;line-height:1.4;opacity:.85;overflow-wrap:anywhere} + +/* Progress bar (theme-neutral: inherits text colour; fill uses currentColor so it follows the theme). */ +.sg-donate .sg-progress{margin:0 0 .9rem;max-width:100%;box-sizing:border-box} +.sg-donate .sg-progress-bar{position:relative;height:14px;border:1px solid rgba(128,128,128,.6);border-radius:999px;background:rgba(128,128,128,.18);overflow:hidden} +.sg-donate .sg-progress-fill{display:block;height:100%;width:0;background:currentColor;opacity:.75;border-radius:999px;transition:width .6s ease} +.sg-donate .sg-progress-text{display:flex;flex-wrap:wrap;justify-content:space-between;gap:.25rem .75rem;margin-top:.35rem;font-weight:600;line-height:1.4;overflow-wrap:anywhere} +.sg-donate .sg-progress-tier,.sg-donate .sg-progress-done{margin:.25rem 0 0;font-size:.9em;line-height:1.4;overflow-wrap:anywhere} +.sg-donate .sg-progress-done{font-weight:700} +.sg-donate .sg-progress [hidden]{display:none} +.sg-donate.sg-progress-only .sg-progress{margin-bottom:0} +@media (prefers-reduced-motion:reduce){.sg-donate .sg-progress-fill{transition:none}} diff --git a/assets/donate/donate.js b/assets/donate/donate.js index ba81190..d740cac 100644 --- a/assets/donate/donate.js +++ b/assets/donate/donate.js @@ -1,9 +1,12 @@ /* StreamGoals donate form (vanilla JS). Config comes from window.StreamGoalsDonate. */ (function () { 'use strict'; - var C = window.StreamGoalsDonate; - if (!C) { return; } - var T = C.i18n || {}; + var C = window.StreamGoalsDonate; // donate form config (absent on pages with only [streamgoals_progress]) + var PC = window.StreamGoalsProgress; // progress bar config (rest url, labels, poll interval) + if (!C && !PC) { return; } + var T = (C && C.i18n) || {}; + var PT = (PC && PC.i18n) || {}; + var REST = (C && C.restUrl) || (PC && PC.restUrl) || ''; var sdkPromise = null, sdkCurrency = null; function el(tag, attrs, children) { @@ -18,7 +21,7 @@ function api(path, opts) { opts = opts || {}; - return fetch(C.restUrl + path, { + return fetch(REST + path, { method: opts.method || 'GET', headers: { 'Content-Type': 'application/json' }, body: opts.body ? JSON.stringify(opts.body) : undefined, @@ -62,12 +65,60 @@ } function sprintf1(tpl, v) { return String(tpl || '%s').replace('%s', v); } + /* ---- Progress bar: server renders the markup, this keeps it fresh (same code for form and [streamgoals_progress]). ---- */ + function tpl(str, a, b) { + return String(str || '').replace('%1$s', function () { return a; }).replace('%2$s', function () { return b; }); + } + function applyBar(box, p) { + if (!box || !p) { return; } + var pct = Math.max(0, Math.min(100, parseInt(p.percent, 10) || 0)); + var bar = box.querySelector('.sg-progress-bar'); + var of = tpl(PT['of'] || '%1$s / %2$s', p.raised_display, p.target_display); + box.setAttribute('data-goal', String(p.goal_id)); + box.className = 'sg-progress' + (p.reached ? ' sg-progress-reached' : ''); + bar.setAttribute('aria-valuenow', String(pct)); + bar.setAttribute('aria-valuetext', p.reached ? (PT.reached || '') : of + ' (' + pct + '%)'); + bar.setAttribute('aria-label', String(PT.label || '%s').replace('%s', function () { return p.title; })); + bar.firstChild.style.width = pct + '%'; + box.querySelector('.sg-progress-amounts').textContent = of; + box.querySelector('.sg-progress-pct').textContent = pct + '%'; + var tier = box.querySelector('.sg-progress-tier'), done = box.querySelector('.sg-progress-done'); + tier.hidden = !p.tier; + tier.textContent = p.tier ? tpl(PT.tier, p.tier.title, p.tier.target_display) : ''; + done.hidden = !p.reached; + done.textContent = p.reached ? (PT.reached || '') : ''; + } + function refreshGoal(id, bust) { + return api('/progress?goal=' + encodeURIComponent(id) + (bust ? '&t=' + Date.now() : '')).then(function (p) { + Array.prototype.forEach.call(document.querySelectorAll('.sg-progress'), function (b) { + if (b.getAttribute('data-goal') === String(p.goal_id)) { applyBar(b, p); } + }); + }, function () { /* keep showing the last known numbers */ }); + } + function refreshAll(bust) { + var seen = {}; + Array.prototype.forEach.call(document.querySelectorAll('.sg-progress'), function (b) { + var id = b.getAttribute('data-goal'); + if (id && id !== '0' && !seen[id]) { seen[id] = true; refreshGoal(id, bust); } + }); + } + function startPolling() { + if (!REST || !document.querySelector('.sg-progress')) { return; } + var every = Math.max(15000, (PC && PC.pollMs) || 30000); + setInterval(function () { if (document.visibilityState !== 'hidden') { refreshAll(false); } }, every); + document.addEventListener('visibilitychange', function () { if (document.visibilityState === 'visible') { refreshAll(true); } }); + refreshAll(true); // a cached page may hold old numbers + } + // After a successful donation: refresh now, and again shortly (a pending capture can finalize a moment later). + function afterDonation() { refreshAll(true); setTimeout(function () { refreshAll(true); }, 5000); } + function init(root) { var pinned = parseInt(root.getAttribute('data-goal'), 10) || 0; var goals = C.goals.filter(function (g) { return !pinned || g.id === pinned; }); if (!goals.length) { return; } var uid = 'sg' + Math.random().toString(36).slice(2, 8); var state = { goal: goals[0], renderToken: 0, quote: null }; + var barBox = root.querySelector('.sg-progress'); var goalSel = el('select', { id: uid + '-goal' }); goals.forEach(function (g) { goalSel.appendChild(el('option', { value: g.id, text: g.title + ' (' + g.currency + ')' })); }); @@ -227,6 +278,7 @@ onApprove: function (data) { return api('/orders/' + encodeURIComponent(data.orderID) + '/capture', { method: 'POST' }).then(function (r) { say(r.status === 'completed' ? T.thanks : T.processing, 'sg-ok'); + afterDonation(); }); }, onError: function (err) { say((err && err.message) || T.error, 'sg-error'); } @@ -236,11 +288,15 @@ goalSel.addEventListener('change', function () { state.goal = goals.filter(function (g) { return String(g.id) === goalSel.value; })[0] || goals[0]; + if (barBox && state.goal.progress) { applyBar(barBox, state.goal.progress); refreshGoal(state.goal.id, true); } showNext(); buildPresets(); refresh(); renderButtons(); }); showNext(); buildPresets(); refresh(); renderButtons(); } - function boot() { Array.prototype.forEach.call(document.querySelectorAll('.sg-donate'), init); } + function boot() { + if (C) { Array.prototype.forEach.call(document.querySelectorAll('.sg-donate:not(.sg-progress-only)'), init); } + startPolling(); + } if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', boot); } else { boot(); } })(); diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index a53e694..73afda5 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -47,6 +47,8 @@ Rule `config` examples (`max_total_seconds` caps what one rule has added over ti ## Public REST (namespace `streamgoals/v1`) - `POST /orders` (create order; server computes total incl. optional fee cover), `POST /orders/{id}/capture` - `POST /webhook` (PayPal signature verified; deduped by capture id) +- `GET /progress?goal=ID` — public, read-only, rate limited (60/min per visitor). Returns `Overlay\Progress::payload()` only: `goal_id,title,currency,raised_minor,target_minor,percent,raised_display,target_display,reached,tier|null` (`tier` = `{index,count,title,target_minor,target_display}`). No donor data. 404 unless goal status is active/complete. `Cache-Control: public, max-age=10`. + Shortcodes `[streamgoals_donate show_progress="yes|no"]` (default yes) and `[streamgoals_progress goal=""]` server-render `Progress::html()` (role=progressbar); `donate.js` updates it in place (after a donation, every 30 s while the tab is visible, and once on load for cached pages). Numbers come from `Payloads::goal()`, so they match the overlay; reached = closed at target, all tiers reached, or raised >= target. - `GET /overlay/{token}/{widget}` — ETag'd JSON, polled every 2–3 s; widgets: `goal`, `timer`, `counter`, `alerts` ## Fee cover diff --git a/includes/Overlay/Progress.php b/includes/Overlay/Progress.php new file mode 100644 index 0000000..1291000 --- /dev/null +++ b/includes/Overlay/Progress.php @@ -0,0 +1,92 @@ + $goal sg_goals row + * @param array>|null $tiers raw sg_goal_tiers rows + * @return array{goal_id:int,title:string,currency:string,raised_minor:int,target_minor:int,percent:int,raised_display:string,target_display:string,reached:bool,tier:?array} + */ + public static function payload( array $goal, int $raised, ?array $tiers = null ): array { + $g = Payloads::goal( $goal, $raised, $tiers ?: null ); + $tier = null; + $reached = GoalTargetPolicy::isClosedAtTarget( $goal ); + if ( isset( $g['tiers'] ) ) { + $cur = $g['tiers']['current']; + if ( null !== $cur ) { + $tier = array( + 'index' => (int) $g['tiers']['index'], + 'count' => (int) $g['tiers']['count'], + 'title' => (string) $cur['title'], + 'target_minor' => (int) $cur['target_minor'], + 'target_display' => (string) $cur['target_display'], + ); + } + $reached = $reached || ! empty( $g['tiers']['all_reached'] ); + } else { + $reached = $reached || ( $g['target_minor'] > 0 && $g['raised_minor'] >= $g['target_minor'] ); + } + return array( + 'goal_id' => (int) ( $goal['id'] ?? 0 ), + 'title' => $g['title'], + 'currency' => $g['currency'], + 'raised_minor' => $g['raised_minor'], + 'target_minor' => $g['target_minor'], + 'percent' => $reached ? 100 : $g['percent'], + 'raised_display' => $g['raised_display'], + 'target_display' => $g['target_display'], + 'reached' => $reached, + 'tier' => $tier, + ); + } + + /** + * Server-rendered bar (the JS updates this same markup in place). Labels are already translated. + * + * @param array $labels reached, of (%1$s raised, %2$s target), tier (%1$s name, %2$s target), label (%s title) + */ + public static function html( array $p, array $labels ): string { + $e = static fn( string $s ): string => htmlspecialchars( $s, ENT_QUOTES, 'UTF-8' ); + $pct = max( 0, min( 100, (int) $p['percent'] ) ); + $sub = static fn( string $tpl, array $v ): string => (string) preg_replace_callback( '/%(\d)\$s/', static fn( array $m ): string => $v[ (int) $m[1] - 1 ] ?? '', $tpl ); + $of = $sub( $labels['of'] ?? '%1$s / %2$s', array( $p['raised_display'], $p['target_display'] ) ); + $out = '
'; + $out .= '
' + . '
'; + $out .= '
' . $e( $of ) . ' ' . $pct . '%
'; + $out .= '

' + . ( $p['tier'] ? $e( $sub( $labels['tier'] ?? '%1$s (%2$s)', array( $p['tier']['title'], $p['tier']['target_display'] ) ) ) : '' ) . '

'; + $out .= '

' . $e( $p['reached'] ? ( $labels['reached'] ?? '' ) : '' ) . '

'; + return $out . '
'; + } +} diff --git a/includes/Rest/DonateController.php b/includes/Rest/DonateController.php index 9d9d51d..c54543e 100644 --- a/includes/Rest/DonateController.php +++ b/includes/Rest/DonateController.php @@ -6,6 +6,7 @@ namespace StreamGoals\Rest; use StreamGoals\Core\GoalTargetPolicy; use StreamGoals\Core\Money; use StreamGoals\Core\Settings; +use StreamGoals\Overlay\Progress; use StreamGoals\PayPal\CaptureFinalizer; use StreamGoals\PayPal\Client; use StreamGoals\PayPal\DonationStore; @@ -27,6 +28,7 @@ final class DonateController { public static function register(): void { add_action( 'rest_api_init', array( self::class, 'routes' ) ); add_shortcode( 'streamgoals_donate', array( self::class, 'shortcode' ) ); + add_shortcode( 'streamgoals_progress', array( self::class, 'progress_shortcode' ) ); } public static function routes(): void { @@ -57,10 +59,35 @@ final class DonateController { 'permission_callback' => '__return_true', ) ); + register_rest_route( + self::NS, + '/progress', + array( + 'methods' => 'GET', + 'callback' => array( self::class, 'progress_route' ), + 'permission_callback' => '__return_true', + 'args' => array( 'goal' => array( 'sanitize_callback' => 'absint' ) ), + ) + ); } /* ---------------------------------------------------------------- REST */ + /** Public, read-only totals for the progress bar. Whitelisted goal figures only; never donor data. */ + public static function progress_route( \WP_REST_Request $req ) { + if ( $limited = self::limit( 'progress', 60, 60 ) ) { + return $limited; + } + $goal = DonationStore::goal( (int) $req->get_param( 'goal' ) ); + if ( ! $goal || ! in_array( (string) $goal['status'], array( 'active', 'complete' ), true ) ) { + return new \WP_Error( 'sg_goal_not_found', __( 'Goal not found.', 'streamgoals-donate' ), array( 'status' => 404 ) ); + } + $res = rest_ensure_response( self::progress_for( $goal ) ); + // Short shared cache lets a CDN collapse bursts; the page JS adds a cache-busting parameter after a donation. + $res->header( 'Cache-Control', 'public, max-age=10, s-maxage=10' ); + return $res; + } + public static function create_order( \WP_REST_Request $req ) { if ( $limited = self::limit( 'order', 10, 300 ) ) { return $limited; @@ -159,8 +186,9 @@ final class DonateController { /* ----------------------------------------------------------- Shortcode */ public static function shortcode( $atts ): string { - $atts = shortcode_atts( array( 'goal' => '' ), (array) $atts, 'streamgoals_donate' ); + $atts = shortcode_atts( array( 'goal' => '', 'show_progress' => 'yes' ), (array) $atts, 'streamgoals_donate' ); $pinned = (int) $atts['goal']; + $showP = Progress::flag( $atts['show_progress'], true ); $s = Settings::all(); if ( '' === (string) $s['paypal_client_id'] ) { return '

' . esc_html__( 'Donations are not available right now.', 'streamgoals-donate' ) . '

'; @@ -179,13 +207,15 @@ final class DonateController { 'currency' => strtoupper( (string) $g['currency'] ), 'exp' => Money::exponent( (string) $g['currency'] ), 'actions' => $actions[ (int) $g['id'] ] ?? array(), - ); + ) + ( $showP ? array( 'progress' => self::progress_for( $g ) ) : array() ); } if ( ! $goals ) { $reached = $pinned ? DonationStore::goal( $pinned ) : null; $reached = $pinned ? ( $reached && GoalTargetPolicy::isClosedAtTarget( $reached ) ) : (bool) DonationStore::reached_goals(); if ( $reached ) { - return '

' . esc_html__( 'This goal has been reached - thank you for your support!', 'streamgoals-donate' ) . '

'; + $rg = $pinned ? DonationStore::goal( $pinned ) : ( DonationStore::reached_goals()[0] ?? null ); + $bar = ( $showP && $rg ) ? self::progress_markup( self::progress_for( $rg ) ) : ''; + return $bar . '

' . esc_html__( 'This goal has been reached - thank you for your support!', 'streamgoals-donate' ) . '

'; } return '

' . esc_html__( 'There is no active goal to donate to right now.', 'streamgoals-donate' ) . '

'; } @@ -231,11 +261,68 @@ final class DonateController { ); wp_add_inline_script( 'streamgoals-donate', 'window.StreamGoalsDonate=' . wp_json_encode( $config, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT ) . ';', 'before' ); - return '
'; + self::enqueue_progress(); + $first = $showP ? $goals[0]['progress'] : null; + return '
' + . ( $first ? self::progress_markup( $first ) : '' ) . '
'; + } + + /** [streamgoals_progress goal=""]: the same bar without the form. Server-rendered; JS refreshes it. */ + public static function progress_shortcode( $atts ): string { + $atts = shortcode_atts( array( 'goal' => '' ), (array) $atts, 'streamgoals_progress' ); + $id = (int) $atts['goal']; + $goal = $id ? DonationStore::goal( $id ) : ( DonationStore::active_goals()[0] ?? ( DonationStore::reached_goals()[0] ?? null ) ); + if ( ! $goal || ! in_array( (string) $goal['status'], array( 'active', 'complete' ), true ) ) { + return ''; + } + self::enqueue_progress(); + return '
' . self::progress_markup( self::progress_for( $goal ) ) . '
'; } /* ------------------------------------------------------------- Helpers */ + /** @return array Progress::payload() for a goal row (same raised basis and tiers as the overlay). */ + private static function progress_for( array $goal ): array { + global $wpdb; + $id = (int) $goal['id']; + $tiers = array(); + try { + $tiers = ( new \StreamGoals\Tiers\TierRepository( $wpdb ) )->forGoal( $id ); + } catch ( \Throwable $e ) { + $tiers = array(); + } + return Progress::payload( $goal, ( new \StreamGoals\Overlay\WpdbDataSource() )->raisedMinor( $goal ), $tiers ?: null ); + } + + private static function progress_i18n(): array { + return array( + 'reached' => __( 'Goal reached', 'streamgoals-donate' ), + /* translators: 1: formatted amount raised, 2: formatted target */ + 'of' => __( '%1$s of %2$s', 'streamgoals-donate' ), + /* translators: 1: current tier name, 2: formatted tier target */ + 'tier' => __( 'Current tier: %1$s (target %2$s)', 'streamgoals-donate' ), + /* translators: %s: goal title */ + 'label' => __( 'Progress towards %s', 'streamgoals-donate' ), + ); + } + + private static function progress_markup( array $p ): string { + return Progress::html( $p, self::progress_i18n() ); + } + + /** Enqueue assets and the (once per page) config the bar's JS needs. */ + private static function enqueue_progress(): void { + static $done = false; + wp_enqueue_style( 'streamgoals-donate', STREAMGOALS_URL . 'assets/donate/donate.css', array(), STREAMGOALS_VERSION ); + wp_enqueue_script( 'streamgoals-donate', STREAMGOALS_URL . 'assets/donate/donate.js', array(), STREAMGOALS_VERSION, true ); + if ( $done ) { + return; + } + $done = true; + $cfg = array( 'restUrl' => esc_url_raw( rest_url( self::NS ) ), 'i18n' => self::progress_i18n(), 'pollMs' => 30000 ); + wp_add_inline_script( 'streamgoals-donate', 'window.StreamGoalsProgress=' . wp_json_encode( $cfg, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT ) . ';', 'before' ); + } + /** * "Next unlock" hint for a tiered goal: the current (first unreached) tier's title and the amount still needed, in minor units. * Null for goals without tiers or with every tier reached. Computed when the page renders. diff --git a/tests/Unit/ProgressTest.php b/tests/Unit/ProgressTest.php new file mode 100644 index 0000000..b43419e --- /dev/null +++ b/tests/Unit/ProgressTest.php @@ -0,0 +1,134 @@ + 7, 'title' => 'New mic', 'target_minor' => 10000, 'currency' => 'USD', 'status' => 'active', 'close_at_target' => 0, 'counts_fees' => 0 ); + } + + /** @dataProvider flags */ + public function test_show_progress_attribute_parsing( $raw, bool $expected ): void { + $this->assertSame( $expected, Progress::flag( $raw, true ) ); + } + + public static function flags(): array { + return array( + array( 'yes', true ), array( 'YES', true ), array( 'true', true ), array( '1', true ), array( 1, true ), array( ' on ', true ), + array( 'no', false ), array( 'No', false ), array( 'false', false ), array( '0', false ), array( 0, false ), array( 'off', false ), + array( '', true ), array( null, true ), array( 'banana', true ), array( array( 'x' ), true ), + ); + } + + public function test_flag_default_is_respected_for_unknown_values(): void { + $this->assertFalse( Progress::flag( 'banana', false ) ); + $this->assertFalse( Progress::flag( null, false ) ); + } + + public function test_percentage_is_clamped_and_target_zero_is_safe(): void { + $this->assertSame( 0, Progress::payload( $this->goal( array( 'target_minor' => 0 ) ), 500 )['percent'] ); + $this->assertSame( 100, Progress::payload( $this->goal(), 999999 )['percent'] ); + $this->assertSame( 0, Progress::payload( $this->goal(), -50 )['percent'] ); + $this->assertSame( 25, Progress::payload( $this->goal(), 2500 )['percent'] ); + } + + public function test_numbers_match_the_overlay_goal_payload(): void { + $p = Progress::payload( $this->goal(), 2500 ); + $o = Payloads::goal( $this->goal(), 2500 ); + foreach ( array( 'raised_minor', 'target_minor', 'percent', 'raised_display', 'target_display', 'currency', 'title' ) as $k ) { + $this->assertSame( $o[ $k ], $p[ $k ], $k ); + } + $this->assertSame( '$25.00', $p['raised_display'] ); + $this->assertSame( '$100.00', $p['target_display'] ); + $this->assertFalse( $p['reached'] ); + $this->assertNull( $p['tier'] ); + } + + public function test_tiered_goal_shows_current_tier_and_matches_overlay(): void { + $tiers = array( + array( 'id' => 1, 'target_minor' => 5000, 'title' => 'Giveaway', 'description' => 'secret', 'reached_at' => '2026-01-01 00:00:00' ), + array( 'id' => 2, 'target_minor' => 20000, 'title' => 'Microphone', 'description' => 'secret', 'reached_at' => null ), + ); + $g = $this->goal( array( 'target_minor' => 20000 ) ); + $p = Progress::payload( $g, 8000, $tiers ); + $o = Payloads::goal( $g, 8000, $tiers ); + $this->assertSame( $o['percent'], $p['percent'] ); + $this->assertSame( 20000, $p['target_minor'] ); + $this->assertSame( array( 'index' => 2, 'count' => 2, 'title' => 'Microphone', 'target_minor' => 20000, 'target_display' => '$200.00' ), $p['tier'] ); + $this->assertFalse( $p['reached'] ); + $this->assertStringNotContainsString( 'secret', json_encode( $p ) ); + } + + public function test_reached_states(): void { + $closed = $this->goal( array( 'status' => 'complete', 'close_at_target' => 1 ) ); + $this->assertTrue( Progress::payload( $closed, 10000 )['reached'] ); + $this->assertTrue( Progress::payload( $closed, 0 )['reached'], 'closed at target wins even if numbers lag' ); + $this->assertTrue( Progress::payload( $this->goal(), 10000 )['reached'], 'raised >= target' ); + $this->assertFalse( Progress::payload( $this->goal( array( 'target_minor' => 0 ) ), 10000 )['reached'], 'no target never counts as reached' ); + $done = array( array( 'id' => 1, 'target_minor' => 5000, 'title' => 'A', 'reached_at' => 'x' ) ); + $p = Progress::payload( $this->goal( array( 'target_minor' => 5000 ) ), 5000, $done ); + $this->assertTrue( $p['reached'] ); + $this->assertNull( $p['tier'] ); + } + + public function test_public_payload_has_exactly_the_whitelisted_non_pii_keys(): void { + $goal = $this->goal() + array( 'paypal_secret' => 'x', 'notes' => 'private' ); + $p = Progress::payload( $goal, 100 ); + $this->assertSame( + array( 'currency', 'goal_id', 'percent', 'raised_display', 'raised_minor', 'reached', 'target_display', 'target_minor', 'tier', 'title' ), + ( static function ( array $a ): array { ksort( $a ); return array_keys( $a ); } )( $p ) + ); + $json = json_encode( $p ); + foreach ( array( 'paypal', 'notes', 'email', 'donor', 'message', 'display_name' ) as $bad ) { + $this->assertStringNotContainsString( $bad, $json ); + } + } + + public function test_html_is_accessible_and_escaped(): void { + $p = Progress::payload( $this->goal( array( 'title' => 'Mic' ) ), 2500 ); + $html = Progress::html( $p, array( 'reached' => 'Goal reached', 'of' => '%1$s of %2$s', 'tier' => 'Tier: %1$s (%2$s)', 'label' => 'Progress: %s' ) ); + $this->assertStringContainsString( 'role="progressbar"', $html ); + $this->assertStringContainsString( 'aria-valuenow="25"', $html ); + $this->assertStringContainsString( 'aria-valuemin="0"', $html ); + $this->assertStringContainsString( 'aria-valuemax="100"', $html ); + $this->assertStringContainsString( 'aria-label="Progress: <b>Mic</b>"', $html ); + $this->assertStringContainsString( '$25.00 of $100.00', $html ); + $this->assertStringContainsString( 'width:25%', $html ); + $this->assertStringNotContainsString( '', $html ); + } + + public function test_html_reached_and_tier_lines(): void { + $labels = array( 'reached' => 'Goal reached', 'of' => '%1$s of %2$s', 'tier' => 'Tier: %1$s (%2$s)', 'label' => 'Progress: %s' ); + $closed = Progress::html( Progress::payload( $this->goal( array( 'status' => 'complete', 'close_at_target' => 1 ) ), 10000 ), $labels ); + $this->assertStringContainsString( 'Goal reached', $closed ); + $this->assertStringContainsString( 'sg-progress-reached', $closed ); + $this->assertStringContainsString( 'aria-valuenow="100"', $closed ); + $tiers = array( array( 'id' => 2, 'target_minor' => 20000, 'title' => 'Mic', 'reached_at' => null ) ); + $t = Progress::html( Progress::payload( $this->goal( array( 'target_minor' => 20000 ) ), 100, $tiers ), $labels ); + $this->assertStringContainsString( 'Tier: Mic ($200.00)', $t ); + } + + public function test_assets_support_reduced_motion_and_polling_rules(): void { + $root = dirname( __DIR__, 2 ) . '/assets/donate/'; + $css = (string) file_get_contents( $root . 'donate.css' ); + $js = (string) file_get_contents( $root . 'donate.js' ); + $this->assertStringContainsString( 'prefers-reduced-motion', $css ); + $this->assertStringContainsString( 'visibilityState', $js ); + $this->assertStringContainsString( '30000', $js ); + $this->assertStringNotContainsString( 'innerHTML', $js ); + } + + public function test_route_and_shortcodes_are_registered(): void { + $php = (string) file_get_contents( dirname( __DIR__, 2 ) . '/includes/Rest/DonateController.php' ); + $this->assertStringContainsString( "'/progress'", $php ); + $this->assertStringContainsString( "add_shortcode( 'streamgoals_progress'", $php ); + $this->assertStringContainsString( "'show_progress' => 'yes'", $php ); + $this->assertMatchesRegularExpression( "/function progress_route.*self::limit\( 'progress'/s", $php ); + } +}