v1.1.1

.distignore

@@ -6,6 +6,8 @@
 /vendor
 .distignore
 .editorconfig
+.eslintrc.js
+.env.example
 .gitignore
 .gitattributes
 composer.json

.env.example

@@ -0,0 +1,7 @@
+# WordPress URL (without trailing slash)
+WP_URL=http://localhost:8080
+
+# WordPress admin credentials
+WP_USER=admin
+WP_PASS=password
+WP_EMAIL=admin@wordpress.test

.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+	extends: [
+		'plugin:@wordpress/eslint-plugin/recommended',
+		'plugin:eslint-comments/recommended',
+	],
+	parserOptions: {
+		ecmaVersion: "latest",
+	},
+	rules: {
+		"no-console": "off",
+	},
+};

.github/workflows/cs.yml

@@ -61,7 +61,7 @@ jobs:
       # @link https://github.com/staabm/annotate-pull-request-from-checkstyle/
       - name: Check PHP code style
         id: phpcs
-        run: composer check-cs -- --no-cache --warning-severity=6 --report-full --report-checkstyle=./phpcs-report.xml
+        run: composer check-cs -- --no-cache --report-full --report-checkstyle=./phpcs-report.xml
 
       - name: Show PHPCS results in PR
         if: ${{ always() && steps.phpcs.outcome == 'failure' }}

.github/workflows/playwright.yml

@@ -0,0 +1,130 @@
+name: Progress Planner Playwright Tests
+
+env:
+  WORDPRESS_URL: http://localhost:8080
+  WORDPRESS_ADMIN_USER: admin
+  WORDPRESS_ADMIN_PASSWORD: password
+  WORDPRESS_ADMIN_EMAIL: admin@example.com
+  WORDPRESS_TABLE_PREFIX: wp_
+  WORDPRESS_DB_USER: wpuser
+  WORDPRESS_DB_PASSWORD: wppass
+  WORDPRESS_DB_NAME: wordpress
+  WORDPRESS_DB_PORT: 3307 # So it can run locally (hopefully).
+  PRPL_TEST_TOKEN: 0220a2de67fc29094281088395939f58
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+
+jobs:
+  e2e-tests:
+    runs-on: ubuntu-latest
+
+    services:
+      mysql:
+        image: mariadb:10.6
+        env:
+          MYSQL_ROOT_PASSWORD: root
+          MYSQL_DATABASE: ${{ env.WORDPRESS_DB_NAME }}
+          MYSQL_USER: ${{ env.WORDPRESS_DB_USER }}
+          MYSQL_PASSWORD: ${{ env.WORDPRESS_DB_PASSWORD }}
+        ports:
+          - 3307:3306 # GitHub Actions doesn't support environment variables in the ports section.
+      wordpress:
+        image: wordpress:latest
+        env:
+          WORDPRESS_DB_HOST: mysql
+          WORDPRESS_DB_USER: ${{ env.WORDPRESS_DB_USER }}
+          WORDPRESS_DB_PASSWORD: ${{ env.WORDPRESS_DB_PASSWORD }}
+          WORDPRESS_DB_NAME: ${{ env.WORDPRESS_DB_NAME }}
+          WORDPRESS_DB_PORT: ${{ env.WORDPRESS_DB_PORT }}
+          WORDPRESS_TABLE_PREFIX: ${{ env.WORDPRESS_TABLE_PREFIX }}
+          WORDPRESS_DEBUG: 1
+          WORDPRESS_URL: ${{ env.WORDPRESS_URL }}
+          WORDPRESS_ADMIN_USER: ${{ env.WORDPRESS_ADMIN_USER }}
+          WORDPRESS_ADMIN_PASSWORD: ${{ env.WORDPRESS_ADMIN_PASSWORD }}
+          WORDPRESS_ADMIN_EMAIL: ${{ env.WORDPRESS_ADMIN_EMAIL }}
+          PRPL_TEST_TOKEN: ${{ env.PRPL_TEST_TOKEN }}
+        ports:
+          - 8080:80
+        options: >-
+          --health-cmd="curl --silent --fail http://localhost:8080/wp-login.php || exit 0"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=5
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install Node.js & Playwright
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: npm install -D @playwright/test
+      - run: npx playwright install --with-deps
+
+      - name: Complete WordPress installation
+        run: |
+          echo "Installing WordPress at: $WORDPRESS_URL"
+          curl --silent -X POST "$WORDPRESS_URL/wp-admin/install.php?step=2" \
+          -d "weblog_title=My%20WordPress%20Site" \
+          -d "user_name=$WORDPRESS_ADMIN_USER" \
+          -d "admin_password=$WORDPRESS_ADMIN_PASSWORD" \
+          -d "admin_password2=$WORDPRESS_ADMIN_PASSWORD" \
+          -d "admin_email=$WORDPRESS_ADMIN_EMAIL" \
+          -d "public=1"r
+
+      # - name: Install necessary dependencies in WordPress container
+      #   run: |
+      #     docker exec $(docker ps -qf "name=wordpress") apt-get update
+      #     docker exec $(docker ps -qf "name=wordpress") apt-get install -y \
+      #       php php-cli php-mysql php-curl php-xml php-mbstring php-zip curl \
+      #       libnss3 libxss1 libasound2 libatk-bridge2.0-0 libgtk-3-0 libgbm-dev libwoff1
+
+      - name: Install and activate plugin
+        run: |
+          # Install WP-CLI
+          docker exec $(docker ps -qf "name=wordpress") curl -O https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli.phar
+          docker exec $(docker ps -qf "name=wordpress") chmod +x wp-cli.phar
+          docker exec $(docker ps -qf "name=wordpress") mv wp-cli.phar /usr/local/bin/wp
+
+          # Create the plugins directory in the WordPress container
+          docker exec $(docker ps -qf "name=wordpress") mkdir -p /var/www/html/wp-content/plugins
+
+          # Copy plugin files to WordPress plugins directory
+          docker cp . $(docker ps -qf "name=wordpress"):/var/www/html/wp-content/plugins/progress-planner
+
+          # Activate the plugin using WP-CLI
+          docker exec $(docker ps -qf "name=wordpress") wp plugin activate progress-planner --allow-root
+
+          # Enable debug mode
+          docker exec $(docker ps -qf "name=wordpress") wp option update prpl_debug true --allow-root
+
+          # Insert test token
+          docker exec $(docker ps -qf "name=wordpress") wp option update progress_planner_test_token $PRPL_TEST_TOKEN --allow-root
+
+      # - name: Wait for WordPress to be ready
+      #   run: |
+      #     echo "Waiting for WordPress to be ready..."
+      #     sleep 30  # Adjust if necessary based on the container startup time
+
+      - name: Run Playwright Tests
+        run: npx playwright test tests/e2e/
+
+      - name: Upload Playwright Report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: playwright-report
+          path: playwright-report/
+
+      - name: Upload Playwright screenshots as artifacts
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: playwright-screenshots
+          path: |
+            onboarding-failed.png  # Specify the path of the screenshot you want to upload

.gitignore

@@ -3,3 +3,12 @@
 .phpunit.result.cache
 node_modules
 .DS_Store
+
+# Playwright
+test-results/
+playwright-report/
+playwright/.cache/
+auth.json
+
+# Environment variables
+.env

CHANGELOG.md

@@ -1,17 +1,60 @@
-= 1.0.5 =
+= 1.1.1 =
+
+Bugs we fixed:
+
+* Fixed unnecessary display of the upgrade popover.
+* Fixed saving license key from 'Subscribe to weekly' emails popover.
+* Reduced number of database queries when checking for user activity scores.
+* Fixed database queries when getting activities by type.
+
+Enhancements:
+
+* Simplified the Dashboard widget.
+* Styling improvements.
+* Improved some translation strings.
+* Improved suggestions for writing new posts.
+* UI improvements in the plugin settings page.
+* TODO tasks can now award 1 point per week, counting toward the monthly badges.
 
 Under the hood:
 
-* Improved suggested tasks completion conditions.
-* Improved checks for suggested 'review post' tasks.
+* Completely refactored the TODOs system.
+* Refactored the suggested-tasks system.
+* Refactored our AJAX calls.
+* Performance & caching improvements.
+* Refactored popovers implementation.
+* Added implementation to migrate plugin data on updates.
+* Improved debugging suite.
+* Added new hooks for integration with 3rd-party plugins.
+* Added a data collector system for tasks providers.
+* Refactored the way tasks are saved in the database for consistency.
+* Improved `one_time` and `repetitive` task type abstractions.
+* Refactored the celebrations system.
 
-We've added the following Recommendations from Ravi:
+= 1.1.0 =
+
+In this release, we've added more recommendations from Ravi on how to improve your site. We've also made these recommendations more visible on your WordPress
+settings pages, by showing on settings pages exactly which things we think you should change. Also, if you're just now starting to use Progress Planner,
+we've made the onboarding experience a lot more fun: we show you immediately which of Ravi's recommended tasks you've already completed and we give
+you points for those!
+
+Added these recommendations from Ravi:
+
+* Properly set your [permalink structure](https://progressplanner.com/recommendations/change-default-permalink-structure/).
+* Fix it if your site is [set to not be shown in search engines](https://progressplanner.com/recommendations/blog-indexing-settings/).
+* Rename and change the slug of your [Uncategorized category](https://progressplanner.com/recommendations/rename-uncategorized-category/).
+* Remove [inactive plugins](https://progressplanner.com/recommendations/remove-inactive-plugins/).
+* [Upgrade your PHP version](https://progressplanner.com/recommendations/update-php-version/) if needed.
+* [Fully disable comments](https://progressplanner.com/recommendations/disable-comments/) if they're not needed on your site.
+
+Bugs we fixed:
+
+* If you had `WP_DEBUG` set to false, the plugin would still tell you to disable `WP_DEBUG_DISPLAY`. We think Ravi was a bit overzealous in his recommendation, so we've fixed that.
+
+Under the hood:
 
-* [Setting the permalink structure](TBD).
-* [Update PHP version](TBD).
-* [Disable comments on your site](TBD).
-* [Remove inactive plugins](TBD).
-* [Search engine visibility](TBD).
+* We've added our set of debug tools straight into the plugin. If you define `PRPL_DEBUG` as `true` in your `wp-config.php` file, you'll get a PRPL Debug admin bar menu item.
+* Improved suggested tasks completion conditions so they don't trigger at the wrong moment.
 
 = 1.0.4 =
 

README.md

@@ -3,6 +3,13 @@
 [![PHPStan](https://github.com/ProgressPlanner/progress-planner/actions/workflows/phpstan.yml/badge.svg)](https://github.com/ProgressPlanner/progress-planner/actions/workflows/phpstan.yml)
 [![Lint](https://github.com/ProgressPlanner/progress-planner/actions/workflows/lint.yml/badge.svg)](https://github.com/ProgressPlanner/progress-planner/actions/workflows/lint.yml)
 
+[![WordPress Plugin Version](https://img.shields.io/wordpress/plugin/v/progress-planner.svg)](https://wordpress.org/plugins/progress-planner/)
+![WordPress Plugin: Tested WP Version](https://img.shields.io/wordpress/plugin/tested/progress-planner.svg)
+[![WordPress Plugin Active Installs](https://img.shields.io/wordpress/plugin/installs/progress-planner.svg)](https://wordpress.org/plugins/progress-planner/advanced/)
+[![WordPress Plugin Downloads](https://img.shields.io/wordpress/plugin/dt/progress-planner.svg)](https://wordpress.org/plugins/progress-planner/advanced/)
+[![WordPress Plugin Rating](https://img.shields.io/wordpress/plugin/stars/progress-planner.svg)](https://wordpress.org/support/plugin/progress-planner/reviews/)
+[![GitHub](https://img.shields.io/github/license/ProgressPlanner/progress-planner.svg)](https://github.com/ProgressPlanner/progress-planner/blob/main/LICENSE)
+
 [![Try Progress Planner on the WordPress playground](https://img.shields.io/badge/Try%20Progress%20Planner%20on%20the%20WordPress%20Playground-%23117AC9.svg?style=for-the-badge&logo=WordPress&logoColor=ddd)](https://playground.wordpress.net/#{"landingPage":"/wp-admin/admin.php?page=progress-planner","features":{"networking":true},"login":true,"plugins":["https://github-proxy.com/proxy/?repo=ProgressPlanner/progress-planner"],"steps":[{"step":"defineWpConfigConsts","consts":{"IS_PLAYGROUND_PREVIEW":true}}]})
 
 # Progress Planner

assets/css/admin.css

@@ -79,7 +79,8 @@
 }
 
 .prpl-wrap h2 + p {
-	margin-top: 0.5em;
+	margin-top: 0.75rem;
+	margin-bottom: 0.75rem;
 }
 
 .prpl-wrap h1,
@@ -144,6 +145,11 @@
 	display: none !important;
 }
 
+.prpl-disabled {
+	opacity: 0.5;
+	pointer-events: none;
+}
+
 /*------------------------------------*\
 	Info buttons.
 \*------------------------------------*/
@@ -285,7 +291,8 @@ button.prpl-info-icon {
 .prpl-wrap button.prpl-button-primary,
 .prpl-wrap button.prpl-button-secondary,
 .prpl-wrap a.prpl-button-primary,
-.prpl-wrap a.prpl-button-secondary {
+.prpl-wrap a.prpl-button-secondary,
+#progress_planner_dashboard_widget_score a.prpl-button-primary { /* To be used in WP Dashboard widget */
 	display: block;
 	margin: 1rem 0;
 	padding: 0.75rem 1.25rem;
@@ -460,63 +467,3 @@ button.prpl-info-icon {
 	}
 }
 
-
-/*------------------------------------*\
-	Tooltip.
-\*------------------------------------*/
-.tooltip-actions {
-	justify-content: flex-end;
-	gap: 0.5em;
-	display: flex;
-	position: relative;
-}
-
-.prpl-tooltip {
-	position: absolute;
-	bottom: 0;
-	left: 100%;
-	transform: translate(-100%, calc(100% + 10px));
-
-	padding: 0.75rem 1.5rem 0.75rem 0.75rem;
-	width: 150px;
-	background: var(--prpl-background-green);
-	border-radius: var(--prpl-border-radius);
-	z-index: 2; /* above the gauges */
-	visibility: hidden; /* hidden by default */
-
-	font-size: 1rem;
-	font-weight: 400;
-	color: var(--prpl-color-text);
-
-	&[data-tooltip-visible] {
-		visibility: visible;
-	}
-
-	.close,
-	.prpl-tooltip-close {
-		position: absolute;
-		top: 0.75rem;
-		right: 0;
-		padding: 0.1rem;
-		line-height: 0;
-		margin: 0;
-		background: none;
-		border: none;
-		cursor: pointer;
-	}
-
-	/* Arrow */
-	&::after {
-		content: "";
-		position: absolute;
-		top: 0;
-		right: 0;
-		transform: translate(-10px, -10px) rotate(90deg);
-
-		width: 0;
-		height: 0;
-		border-style: solid;
-		border-width: 7.5px 10px 7.5px 0;
-		border-color: transparent var(--prpl-background-green) transparent transparent;
-	}
-}

assets/css/dashboard-widgets/score.css

@@ -1,3 +1,10 @@
+/* stylelint-disable max-line-length */
+
+/**
+ * Admin widget.
+ *
+ * Dependencies: progress-planner/web-components/prpl-suggested-task, progress-planner/web-components/prpl-badge
+ */
 #progress_planner_dashboard_widget_score {
 
 	.prpl-dashboard-widget {
@@ -42,7 +49,12 @@
 		border-top: 1px solid #c3c4c7; /* same color as the one WP-Core uses */
 		font-size: var(--prpl-font-size-base);
 		display: flex;
-		gap: 0.5rem;
+		gap: 1rem;
 		align-items: center;
+
+		.prpl-button-primary {
+			display: inline-block;
+			margin: 0.5rem 0 0 0;
+		}
 	}
 }