Update code style

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true

.githooks/pre-commit

@@ -6,7 +6,7 @@ if [ -n "$php_files" ]; then
   echo "Running PHP CodeSniffer on the following files:"
   echo "$php_files"
 
-  echo "$php_files" | xargs vendor/bin/phpcs -d memory_limit=512M --standard=phpcs.xml.dist
+  echo "$php_files" | xargs vendor/bin/phpcs -d memory_limit=512M --standard=phpcs.xml
   if [ $? -ne 0 ]; then
     echo "PHP CodeSniffer failed. Please fix the errors."
     exit 1

.github/workflows/main.yml

@@ -1,13 +1,11 @@
-name: Test
+name: Unit tests & PHPCS
 
 on:
   push:
-    branches:
-      - main
 
 jobs:
   test-and-code-style:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         php: [8.1]
@@ -22,4 +20,4 @@ jobs:
         run: vendor/bin/phpunit --bootstrap __tests__/bootstrap.php __tests__
 
       - name: Run PHPCS
-        run: vendor/bin/phpcs --standard=WordPress --extensions=php --ignore=vendor/ .
+        run: vendor/bin/phpcs --standard=phpcs.xml --extensions=php --ignore=vendor/ .

.gitignore

@@ -2,3 +2,6 @@
 /build
 /js/lib/node_modules
 /node_modules
+.DS_Store
+.vscode
+composer.phar

CONTRIBUTING.md

@@ -33,7 +33,7 @@ Run the command to run tests and create the zip under build directory.
 2. Extend the class from `FacebookWordpressIntegrationBase`
 3. Define class variable `PLUGIN_FILE` to be your plugin PHP file
 4. Define class variable `TRACKING_NAME` for tracking purpose, put this value under 'fb_wp_tracking' as a parameter in the pixel event
-5. Define a public static function `injectPixelCode()` to inject pixel at your page
+5. Define a public static function `inject_pixel_code()` to inject pixel at your page
 6. Add your unit test class under `tests/` folder
 7. Extend the test class from `FacebookWordpressTestBase`
 8. After the classes development, run tests by `$ vendor/bin/phing`

README.md

@@ -34,7 +34,7 @@ https://www.facebook.com/business/help/881403525362441
 2. Extend the class from `FacebookWordpressIntegrationBase`
 3. Define class variable `PLUGIN_FILE` to be your plugin PHP file
 4. Define class variable `TRACKING_NAME` for tracking purpose, put this value under 'fb_wp_tracking' as a parameter in the pixel event
-5. Define a public static function `injectPixelCode()` to inject pixel at your page
+5. Define a public static function `inject_pixel_code()` to inject pixel at your page
 6. Add your unit test class under `tests/` folder
 7. Extend the test class from `FacebookWordpressTestBase`
 8. After the classes development, run tests by `$ vendor/bin/phing`

__tests__/FacebookWordpressTestBase.php

@@ -1,96 +1,174 @@
 <?php
-/*
- * Copyright (C) 2017-present, Meta, Inc.
+/**
+ * Facebook Pixel Plugin FacebookWordpressTestBase class.
+ *
+ * This file contains the main logic for FacebookWordpressTestBase.
+ *
+ * @package FacebookPixelPlugin
+ */
+
+/**
+ * Define FacebookWordpressTestBase class.
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; version 2 of the License.
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * @return void
  */
 
+/*
+* Copyright (C) 2017-present, Meta, Inc.
+*
+* This program is free software; you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation; version 2 of the License.
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*/
+
 namespace FacebookPixelPlugin\Tests;
 
-use \WP_Mock\Tools\TestCase;
+use WP_Mock\Tools\TestCase;
 use FacebookPixelPlugin\Core\AAMSettingsFields;
 use FacebookAds\Object\ServerSide\AdsPixelSettings;
 
+/**
+ * FacebookWordpressTestBase class.
+ */
 abstract class FacebookWordpressTestBase extends TestCase {
 
-  public function setUp(): void {
-    \WP_Mock::setUp();
-    $GLOBALS['wp_version'] = '1.0';
-    \Mockery::getConfiguration()->setConstantsMap([
-      'FacebookPixelPlugin\Core\FacebookPixel' => [
-        'FB_INTEGRATION_TRACKING_KEY' => 'fb_integration_tracking',
-      ],
-    ]);
+    /**
+     * Sets up the environment for each test.
+     *
+     * Initializes WP_Mock, sets the global WordPress version,
+     * configures Mockery constants, and sets server variables
+     * to simulate an HTTPS request to 'www.pikachu.com'.
+     *
+     * @return void
+     */
+    public function setUp(): void {
+        \WP_Mock::setUp();
+        $GLOBALS['wp_version'] = '1.0';
+    \Mockery::getConfiguration()->setConstantsMap(
+        array(
+            'FacebookPixelPlugin\Core\FacebookPixel' => array(
+                'FB_INTEGRATION_TRACKING_KEY' => 'fb_integration_tracking',
+            ),
+        )
+    );
 
-    $_SERVER['HTTPS'] = 'on';
-    $_SERVER['HTTP_HOST'] = 'www.pikachu.com';
-    $_SERVER['REQUEST_URI'] = '/index.php';
-  }
+        $_SERVER['HTTPS']       = 'on';
+        $_SERVER['HTTP_HOST']   = 'www.pikachu.com';
+        $_SERVER['REQUEST_URI'] = '/index.php';
+    }
 
-  public function tearDown(): void {
+    /**
+     * Cleans up the environment after each test.
+     *
+     * Asserts that all Mockery expectations have been met, unsets the global
+     * WordPress version, and calls `tearDown` on WP_Mock.
+     *
+     * @return void
+     */
+    public function tearDown(): void {
     $this->addToAssertionCount(
-      \Mockery::getContainer()->mockery_getExpectationCount());
-    unset($GLOBALS['wp_version']);
-    \WP_Mock::tearDown();
-  }
+        \Mockery::getContainer()->mockery_getExpectationCount()
+    );
+        unset( $GLOBALS['wp_version'] );
+        \WP_Mock::tearDown();
+    }
 
-  protected function mockIsInternalUser($is_internal_user) {
-    $this->mocked_fbpixel = \Mockery::mock
-      ('alias:FacebookPixelPlugin\Core\FacebookPluginUtils');
-    $this->mocked_fbpixel->shouldReceive('isInternalUser')
-      ->andReturn($is_internal_user);
-  }
+    /**
+     * Mocks the return value of FacebookPluginUtils::isInternalUser().
+     *
+     * @param bool $is_internal_user Whether the user is an internal user.
+     *
+     * @return void
+     */
+    protected function mockIsInternalUser( $is_internal_user ) {
+        $this->mocked_fbpixel =
+        \Mockery::mock( 'alias:FacebookPixelPlugin\Core\FacebookPluginUtils' );
+        $this->mocked_fbpixel->shouldReceive( 'is_internal_user' )
+        ->andReturn( $is_internal_user );
+    }
 
-  protected function mockFacebookWordpressOptions($options = array(),
-    $aam_settings = null){
+    /**
+     * Mocks the return value of FacebookWordpressOptions methods.
+     *
+     * This function mocks the return values of the FacebookWordpressOptions
+     * class methods. The $options parameter is an associative array
+     * where the keys are method names and the values are the return values
+     * for those methods. If a key is not provided, the method will return
+     * a default value.
+     *
+     * @param array            $options An associative
+     *                          array of method names and their
+     *                                  return values.
+     * @param AdsPixelSettings $aam_settings The return value for the
+     *                                       get_aam_settings() method.
+     */
+    protected function mockFacebookWordpressOptions(
+        $options = array(),
+        $aam_settings = null
+    ) {
     $this->mocked_options = \Mockery::mock(
-      'alias:FacebookPixelPlugin\Core\FacebookWordpressOptions');
-    if(array_key_exists('agent_string', $options)){
-      $this->mocked_options->shouldReceive('getAgentString')->andReturn($options['agent_string']);
-    }
-    else{
-      $this->mocked_options ->shouldReceive('getAgentString')
-                            ->andReturn('wordpress');
-    }
-    if(array_key_exists('pixel_id', $options)){
-      $this->mocked_options->shouldReceive('getPixelId')->andReturn($options['pixel_id']);
+        'alias:FacebookPixelPlugin\Core\FacebookWordpressOptions'
+    );
+    if ( array_key_exists( 'agent_string', $options ) ) {
+        $this->mocked_options->shouldReceive( 'get_agent_string' )
+        ->andReturn( $options['agent_string'] );
+    } else {
+        $this->mocked_options->shouldReceive( 'get_agent_string' )
+                        ->andReturn( 'WordPress' );
     }
-    else{
-      $this->mocked_options->shouldReceive('getPixelId')->andReturn('1234');
+    if ( array_key_exists( 'pixel_id', $options ) ) {
+        $this->mocked_options->shouldReceive( 'get_pixel_id' )
+        ->andReturn( $options['pixel_id'] );
+    } else {
+        $this->mocked_options->shouldReceive( 'get_pixel_id' )
+        ->andReturn( '1234' );
     }
-    if(array_key_exists('access_token', $options)){
-      $this->mocked_options->shouldReceive('getAccessToken')->andReturn($options['access_token']);
+    if ( array_key_exists( 'access_token', $options ) ) {
+        $this->mocked_options->shouldReceive( 'get_access_token' )
+        ->andReturn( $options['access_token'] );
+    } else {
+        $this->mocked_options->shouldReceive( 'get_access_token' )
+        ->andReturn( 'abcd' );
     }
-    else{
-      $this->mocked_options->shouldReceive('getAccessToken')->andReturn('abcd');
+    if ( array_key_exists( 'is_fbe_installed', $options ) ) {
+        $this->mocked_options->shouldReceive( 'get_is_fbe_installed' )
+        ->andReturn( $options['is_fbe_installed'] );
+    } else {
+        $this->mocked_options->shouldReceive( 'get_is_fbe_installed' )
+        ->andReturn( '0' );
     }
-    if(array_key_exists('is_fbe_installed', $options)){
-      $this->mocked_options->shouldReceive('getIsFbeInstalled')->andReturn($options['is_fbe_installed']);
+    if ( is_null( $aam_settings ) ) {
+        $this->mocked_options->shouldReceive( 'get_aam_settings' )
+        ->andReturn( $this->getDefaultAAMSettings() );
+    } else {
+        $this->mocked_options->shouldReceive( 'get_aam_settings' )
+        ->andReturn( $aam_settings );
     }
-    else{
-      $this->mocked_options->shouldReceive('getIsFbeInstalled')->andReturn('0');
+        $this->mocked_options->shouldReceive( 'get_capi_pii_caching_status' )
+                            ->andReturn( 0 );
     }
-    if($aam_settings == null){
-      $this->mocked_options->shouldReceive('getAAMSettings')->andReturn($this->getDefaultAAMSettings());
-    }
-    else{
-      $this->mocked_options->shouldReceive('getAAMSettings')->andReturn($aam_settings);
-    }
-    $this->mocked_options ->shouldReceive('getCapiPiiCachingStatus')
-                          ->andReturn(0);
-  }
 
-  protected function getDefaultAAMSettings(){
-    $aam_settings = new AdsPixelSettings();
-    $aam_settings->setPixelId('123');
-    $aam_settings->setEnableAutomaticMatching(true);
-    $aam_settings->setEnabledAutomaticMatchingFields(AAMSettingsFields::getAllFields());
-    return $aam_settings;
-  }
+
+    /**
+     * Returns the default AdsPixelSettings object.
+     *
+     * The default AdsPixelSettings object returned by
+     * this method has the pixel ID
+     * set to '123', automatic matching enabled, and all
+     * automatic matching fields
+     * enabled.
+     *
+     * @return AdsPixelSettings The default AdsPixelSettings object.
+     */
+    protected function getDefaultAAMSettings() {
+        $aam_settings = new AdsPixelSettings();
+        $aam_settings->setPixelId( '123' );
+        $aam_settings->setEnableAutomaticMatching( true );
+        $aam_settings->setEnabledAutomaticMatchingFields( AAMSettingsFields::get_all_fields() );
+        return $aam_settings;
+    }
 }

__tests__/FileNameTest.php

@@ -1,4 +1,18 @@
 <?php
+/**
+ * Facebook Pixel Plugin FileNameTest class.
+ *
+ * This file contains the main logic for FileNameTest.
+ *
+ * @package FacebookPixelPlugin
+ */
+
+/**
+ * Define FileNameTest class.
+ *
+ * @return void
+ */
+
 /*
 * Copyright (C) 2017-present, Meta, Inc.
 *
@@ -11,6 +25,7 @@
 * GNU General Public License for more details.
 */
 
+
 namespace FacebookPixelPlugin\Tests;
 
 use FacebookPixelPlugin\Core\FacebookPixel;
@@ -22,8 +37,17 @@
  * up deactivate the plugin.
 **/
 final class FileNameTest extends FacebookWordpressTestBase {
-  public function testEntryPointFileNamePersists() {
-    $exist = \file_exists(dirname(__FILE__).'/../facebook-for-wordpress.php');
-    $this->assertTrue($exist);
-  }
+    /**
+     * Check that the name of entry point file
+     * 'facebook-for-wordpress.php' still
+     * exist. This is to make sure that the name of
+     * entry point file is not changed,
+     * since changing the file name will break how
+     * WordPress find the plugin file
+     * and will end up deactivate the plugin.
+     */
+    public function testEntryPointFileNamePersists() {
+        $exist = \file_exists( __DIR__ . '/../class-facebookforwordpress.php' );
+        $this->assertTrue( $exist );
+    }
 }

__tests__/bootstrap.php

@@ -1,17 +1,24 @@
 <?php
-/*
- * Copyright (C) 2017-present, Meta, Inc.
+/**
+ * Define bootstrap.
+ *
+ * @package FacebookPixelPlugin
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; version 2 of the License.
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * @return void
  */
 
-require_once dirname(__FILE__) . '/../vendor/autoload.php';
+/*
+* Copyright (C) 2017-present, Meta, Inc.
+*
+* This program is free software; you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation; version 2 of the License.
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*/
+
+require_once __DIR__ . '/../vendor/autoload.php';
 
-// Now call the bootstrap method of WP Mock
 WP_Mock::bootstrap();