Merge branch 'develop' into trunk

Author: jeffpaul

.github/workflows/lint.yml

@@ -0,0 +1,47 @@
+name: Linting
+
+on:
+  push:
+    branches:
+      - develop
+      - trunk
+  pull_request:
+    branches:
+      - develop
+
+jobs:
+  eslint:
+    name: eslint
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: install node v12
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12
+    - name: npm install
+      run: npm install
+    - name: eslint
+      uses: icrawl/action-eslint@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        custom-glob: assets
+  phpcs:
+    name: phpcs
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Set PHP version
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '7.3'
+        coverage: none
+        tools: composer:v1
+    - name: composer install
+      run: composer install
+    - name: PHPCS check
+      uses: chekalsky/phpcs-action@v1
+      with:
+        phpcs_bin_path: './vendor/bin/phpcs .'

.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: Test
+
+on:
+  schedule:
+    - cron:  '0 0 * * *'
+  push:
+    branches:
+      - develop
+      - trunk
+  pull_request:
+    branches:
+      - develop
+
+jobs:
+  phpunit:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - uses: getong/mariadb-action@v1.1
+
+    - name: Set PHP version
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '7.3'
+        coverage: none
+        tools: composer:v1
+
+    - name: Install dependencies
+      run: composer install
+
+    - name: PHPUnit
+      run: './vendor/bin/phpunit'

.gitignore

@@ -24,3 +24,5 @@ Session.vim
 # Windows
 Thumbs.db
 Desktop.ini
+
+*.cache

CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file, per [the Ke
 
 ## [Unreleased] - TBD
 
+## [1.0.3] - 2021-03-09
+### Added
+- Custom callback and `avc_refresh_callback` filter to be used when an ad slot is ready for refresh (props [@darylldoyle](https://github.com/darylldoyle) via [#34](https://github.com/10up/Ad-Refresh-Control/pull/34)).
+- Linting and testing GitHub Actions (props [@jeffpaul](https://github.com/jeffpaul), [@dinhtungdu](https://github.com/dinhtungdu) via [#24](https://github.com/10up/Ad-Refresh-Control/pull/24)).
+
+### Changed
+- Bump WordPress version "tested up to" 5.7 (props [@darylldoyle](https://github.com/darylldoyle) via [#32](https://github.com/10up/Ad-Refresh-Control/issues/32)).
+
+### Fixed
+- Issue within `viewabilityHandler()` where it was calling `initializeSlotData()` and passing the individual slot instead of the expected event (props [@darylldoyle](https://github.com/darylldoyle) via [#34](https://github.com/10up/Ad-Refresh-Control/pull/34)).
+
+### Security
+- Bump `ini` from 1.3.5 to 1.3.8 (props [@dependabot](https://github.com/apps/dependabot) via [#33](https://github.com/10up/Ad-Refresh-Control/pull/33)).
+
 ## [1.0.2] - 2020-11-17
 ### Added
 - Support for additional exclusion rules - line item ID, ad unit size, and ad slot ID (props [@elliott-stocks](https://github.com/elliott-stocks), [@davidrgreen](https://github.com/davidrgreen) via [#22](https://github.com/10up/Ad-Refresh-Control/pull/22)).
@@ -36,6 +50,7 @@ All notable changes to this project will be documented in this file, per [the Ke
 - Initial public release! 🎉
 
 [Unreleased]: https://github.com/10up/Ad-Refresh-Control/compare/trunk...develop
+[1.0.3]: https://github.com/10up/Ad-Refresh-Control/compare/1.0.2...1.0.3
 [1.0.2]: https://github.com/10up/Ad-Refresh-Control/compare/1.0.1...1.0.2
 [1.0.1]: https://github.com/10up/Ad-Refresh-Control/compare/v1.0.0...1.0.1
 [1.0.0]: https://github.com/10up/Ad-Refresh-Control/releases/tag/v1.0.0

CONTRIBUTING.md

@@ -37,9 +37,8 @@ The `develop` branch is the development branch which means it contains the next
 1. Merge: Make a non-fast-forward merge from your release branch to `develop` (or merge the pull request), then do the same for `develop` into `trunk` (`git checkout trunk && git merge --no-ff develop`).  `trunk` contains the stable development version.
 1. Test: While still on the `trunk` branch, test for functionality locally.
 1. Push: Push your `trunk` branch to GitHub (e.g. `git push origin trunk`).
-1. Release: Create a [new release](/releases/new), naming the tag and the release with the new version number, and targeting the `trunk` branch.  Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the milestone (e.g. `https://github.com/10up/ad-refresh-control/milestone/#?closed=1`).
-1. SVN: Wait for the [GitHub Action](/actions) to finish deploying to the WordPress.org repository.  If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
+1. Release: Create a [new release](https://github.com/10up/Ad-Refresh-Control/releases/new), naming the tag and the release with the new version number, and targeting the `trunk` branch.  Paste the changelog from `CHANGELOG.md` into the body of the release and include a link to the closed issues on the milestone (e.g. `https://github.com/10up/ad-refresh-control/milestone/#?closed=1`).
+1. SVN: Wait for the [GitHub Action](https://github.com/10up/Ad-Refresh-Control/actions) to finish deploying to the WordPress.org repository.  If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
 1. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/ad-refresh-control/. This may take a few minutes.
-1. Close milestone: Edit the [X.Y.Z milestone](/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close the milestone.
-1. Punt incomplete items: If any open issues or PRs which were milestoned for `X.Y.Z` do not make it into the release, update their milestone to `X.Y.Z+1`, `X.Y+1.0`, `X+1.0.0` or `Future Release`.
-1. Version bump (again): In the `develop` branch (`cd ../ && git checkout develop`) bump the version number in `ad-refresh-control.php`, `package.json`, and `readme.txt` to `X.Y.(Z+1)-dev`.  It's okay if the next release might be a different version number; that change can be handled right before release in the first step, as might also be the case with `@since` annotations.
+1. Close milestone: Edit the [milestone](https://github.com/10up/Ad-Refresh-Control/milestone/#) with release date (in the `Due date (optional)` field) and link to GitHub release (in the `Description` field), then close the milestone.
+1. Punt incomplete items: If any open issues or PRs which were milestoned for `X.Y.Z` do not make it into the release, update their milestone to `X.Y.Z+1`, `X.Y+1.0`, `X+1.0.0` or `Future Release`.

CREDITS.md

@@ -10,7 +10,7 @@ The following individuals are responsible for curating the list of issues, respo
 
 Thank you to all the people who have already contributed to this repository via bug reports, code, design, ideas, project management, translation, testing, etc.
 
-[10up (@10up)](https://github.com/10up), [Gary Thayer (@gthayer)](https://github.com/gthayer), [David Green (@davidrgreen)](https://github.com/davidrgreen), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Jackie Kjome (@JackieKjome)](https://github.com/JackieKjome), [GitHub Dependabot (@dependabot)](https://github.com/apps/dependabotg), [Elliott Stocks (@elliott-stocks)](https://github.com/elliott-stocks), [Barry Ceelen (@barryceelen)](https://github.com/barryceelen).
+[10up (@10up)](https://github.com/10up), [Gary Thayer (@gthayer)](https://github.com/gthayer), [David Green (@davidrgreen)](https://github.com/davidrgreen), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Jackie Kjome (@JackieKjome)](https://github.com/JackieKjome), [GitHub Dependabot (@dependabot)](https://github.com/apps/dependabotg), [Elliott Stocks (@elliott-stocks)](https://github.com/elliott-stocks), [Barry Ceelen (@barryceelen)](https://github.com/barryceelen), [Daryll Doyle (@darylldoyle)](https://github.com/darylldoyle), [Tung Du (@dinhtungdu)](https://github.com/dinhtungdu).
 
 ## Libraries
 

README.md

@@ -2,7 +2,7 @@
 
 > Enable Active View refresh for Google Ad Manager ads without needing to modify any code.
 
-[![Support Level](https://img.shields.io/badge/support-active-green.svg)](#support-level) [![Release Version](https://img.shields.io/github/release/10up/ad-refresh-control.svg)](https://github.com/10up/ad-refresh-control/releases/latest) ![WordPress tested up to version](https://img.shields.io/badge/WordPress-v5.5.1%20tested-success.svg) [![GPLv2 License](https://img.shields.io/github/license/10up/ad-refresh-control.svg)](https://github.com/10up/ad-refresh-control/blob/develop/LICENSE.md)
+[![Support Level](https://img.shields.io/badge/support-active-green.svg)](#support-level) [![Release Version](https://img.shields.io/github/release/10up/ad-refresh-control.svg)](https://github.com/10up/ad-refresh-control/releases/latest) ![WordPress tested up to version](https://img.shields.io/badge/WordPress-v5.7%20tested-success.svg) [![GPLv2 License](https://img.shields.io/github/license/10up/ad-refresh-control.svg)](https://github.com/10up/ad-refresh-control/blob/develop/LICENSE.md)
 
 ## Background & Purpose
 

ad-refresh-control.php

@@ -3,7 +3,7 @@
  * Plugin Name:       Ad Refresh Control
  * Plugin URI:        https://github.com/10up/Ad-Refresh-Control
  * Description:       Enable Active View refresh for Google Ad Manager ads without needing to modify any code.
- * Version:           1.0.2
+ * Version:           1.0.3
  * Requires at least: 4.9
  * Requires PHP:      7.0
  * Author:            10up
@@ -17,7 +17,7 @@
  */
 
 // Useful global constants.
-define( 'AD_REFRESH_CONTROL_VERSION', '1.0.2' );
+define( 'AD_REFRESH_CONTROL_VERSION', '1.0.3' );
 define( 'AD_REFRESH_CONTROL_URL', plugin_dir_url( __FILE__ ) );
 define( 'AD_REFRESH_CONTROL_PATH', plugin_dir_path( __FILE__ ) );
 define( 'AD_REFRESH_CONTROL_INC', AD_REFRESH_CONTROL_PATH . 'includes/' );

assets/js/frontend/components/gpt-active-view-refresh.js

@@ -6,6 +6,7 @@ const sizesToExclude = window.AdRefreshControl.sizesToExclude || []; // Do not t
 const slotIdsToExclude = window.AdRefreshControl.slotIdsToExclude || []; // Do not trigger active view refresh for the given slot IDs.
 const refreshInterval      = ( window.AdRefreshControl.refreshInterval || 30 ) * 1000;
 const maximumRefreshes = window.AdRefreshControl.maximumRefreshes || 10;
+const refreshCallback = window.AdRefreshControl.refreshCallback || false;
 let browserFocus = true;
 const adsData = [];
 
@@ -36,7 +37,11 @@ const checkForAdsReadyToRefresh = () => {
 	}
 
 	if ( 0 < slotsToRefresh.length ) {
-		googletag.pubads().refresh( slotsToRefresh );
+		if ( refreshCallback && 'function' === typeof window[refreshCallback] ) {
+			window[refreshCallback]( slotsToRefresh );
+		} else {
+			googletag.pubads().refresh( slotsToRefresh );
+		}
 	}
 
 	setTimeout( checkForAdsReadyToRefresh, 500 );
@@ -73,7 +78,7 @@ const viewabilityHandler = ( event ) => {
 
 	const slotID = event.slot.getSlotElementId();
 	if ( 'undefined' === typeof adsData[ slotID ] ) {
-		initializeSlotData( event.slot );
+		initializeSlotData( event );
 	}
 
 	adsData[ slotID ].viewability = inViewPercentage;

composer.json

@@ -27,7 +27,7 @@
   },
   "require-dev": {
     "phpunit/phpunit": "^8.2",
-    "10up/wp_mock": "dev-master",
+    "10up/wp_mock": "0.4.2",
     "10up/phpcs-composer": "dev-master"
   },
   "scripts": {