piratepoet/mailpoet/README.md

Table of Contents

1. MailPoet
2. Setup
   1. Requirements
   2. Installation
   3. Frameworks and libraries
3. Workflow Commands
4. Coding and Testing
   1. DI
   2. PHP-Scoper
   3. i18n
   4. Acceptance testing

MailPoet

• For help with product, visit SUPPORT.
• To use the Docker-based development environment, see monorepo README.
• To use plugin code directly, follow instructions below.

Setup

Requirements

• PHP >= 7.4
• NodeJS
• WordPress

Installation

The instructions below assume you already have a working WordPress development environment:

# 1. Clone this repository somewhere outside the WordPress installation:
git clone https://github.com/mailpoet/mailpoet.git

# 2. Go to the plugin directory within cloned the repository:
cd mailpoet/mailpoet

# 3. Symlink the MailPoet plugin to your WordPress installation:
ln -s $(pwd) <wordpress>/wp-content/plugins/mailpoet

# 4. Create the .env file:
cp .env.sample .env

# 5. Install dependencies (PHP and JS):
./do install

# 6. Compile JS and CSS:
./do compile:all

Frameworks and libraries

• Symfony/dependency-injection (docs for 3.4).
• PHP-Scoper for moving dependencies into MP namespace
• Twig and Handlebars are used for templates rendering.
• Monolog is used for logging.
• Robo is used to write and run workflow commands.
• Codeception is used to write unit and acceptance tests.
• Docker, Docker Compose and Selenium to run acceptance tests.
• React is used to create most of UIs.
• Marionette is used to build the newsletters editor.
• SCSS is used to write styles.
• Mocha, Chai and Sinon are used to write Javascript tests.
• ESLint is used to lint JS files.
• Webpack is used to bundle assets.

Workflow Commands

There are two different ./do commands. One is in the free MailPoet directory and runs the commands on the local computer. The second is in the repository root and runs the commands in a Docker container. Running ./do commands in the repository root will run the command in the Docker container.

It is recommended to run the assets commands directly in the free MailPoet directory. That means installing the dependencies locally. Running the js and css compilation commands within the container is possible, but it is slower.

On the other hand, the tests should be run in the container. The container has all the necessary dependencies installed and configured. And there is a database running. See more details in the README.md in the repository root.

$ ./do install             # install PHP and JS dependencies
$ ./do update              # update PHP and JS dependencies

$ ./do compile:css         # compiles SCSS files into CSS.
$ ./do compile:js          # bundles JS files for the browser.
$ ./do compile:all         # compiles CSS and JS files.

$ ./do watch:css           # watch CSS files for changes and compile them.
$ ./do watch:js            # watch JS files for changes and compile them.

$ ./do test:unit [--file=...] [--debug]
  # runs the PHP unit tests.
  # if --file specified then only tests on that file are executed.
  # if --debug then tests are executed in debugging mode.
$ ./do test:integration [--file=...] [--multisite] [--debug]
  # runs the PHP integration tests.
  # if --file specified then only tests on that file are executed.
  # if --multisite then tests are executed in a multisite wordpress setup.
  # if --debug then tests are executed in debugging mode.
$ ./do test:multisite-integration # alias for ./do test:integration --multisite
$ ./do test:debug-unit            # alias for ./do test:unit --debug
$ ./do test:debug-integration     # alias for ./do test:integration --debug
$ ./do test:failed-unit           # run the last failing unit test.
$ ./do test:failed-integration    # run the last failing integration test.
$ ./do test:javascript            # run the JS tests.
$ ./do test:acceptance [--file=...] [--skip-deps]
  # run acceptances tests into a docker environment.
  # if --file given then only tests on that file are executed.
  # if --skip-deps then it skips installation of composer dependencies.
$ ./do test:acceptance-multisite [--file=...] [--skip-deps]
  # download 3rd party plugins for tests
  # if you pass tag it will attempt to download zip for the tag otherwise it downloads the latest release
  # e.g. ./do download:woo-commerce-zip 5.20.0
$ ./do download:woo-commerce-zip [<tag>]
$ ./do download:woo-commerce-subscriptions-zip [<tag>]
  # same as test:acceptance but runs into a multisite wordpress setup.
$ ./do delete:docker      # stop and remove all running docker containers.

$ ./do qa:lint             # PHP code linter.
$ ./do qa:lint-javascript  # JS code linter.
$ ./do qa:phpstan          # PHP code static analysis using PHPStan.
$ ./do qa                  # PHP and JS linters.

$ ./do release:changelog-get  [--version-name=...]     # Prints out changelog and release notes for given version or for newest version.
$ ./do release:changelog-update  [--version-name=...] [--quiet] # Updates changelog in readme.txt for given version or for newest version.

$ ./do container:dump      # Generates DI container cache.

$ ./do generate:data [<generatorName>] [<threads>] # Generates random usage data (Note: requires WooCommerce active) e.g. ./do generate:data past_revenues 4

Coding and Testing

DI

We use Symfony/dependency-injection container. Container configuration can be found in lib/DI/ContainerFactory.php The container is configured and used with minimum sub-dependencies to keep final package size small. You can check the docs to learn more about Symfony Container.

PHP-Scoper

We use PHP-Scoper package to prevent plugin libraries conflicts in PHP. Two plugins may be using different versions of a library. PHP-Scoper prefix dependencies namespaces and they are then moved into vendor-prefixed directory. Dependencies handled by PHP-Scoper are configured in extra configuration files prefixer/composer.json and prefixer/scoper.inc.php. Installation and processing is triggered in post scripts of the main composer.json file.

i18n

We use functions __(), _n(), _x(), and _nx() with domain mailpoet to translate strings. Please follow best practices.

Comments for translators

When the translation string can be ambiguous, add a translators comment for clarification. Don't use _x() or _xn() for clarification.

// translators:
$customErrorMessage = sprintf(
  // translators: %1$s is the link, %2$s is the error message.
  __('Please see %1$s for more information. %2$s.', 'mailpoet'),
  'https://kb.mailpoet.com',
  $errorMessage
);

In PHP code

__('text to translate', 'mailpoet');
_n('single text', 'plural text', $number, 'mailpoet');
_x('text to translate', 'context', 'mailpoet');
_xn('single text', 'plural text', $number, 'context', 'mailpoet');

In JavaScript/TypeScript code

import { __, _n, _x, _xn } from '@wordpress/i18n';

__('text to translate', 'mailpoet');
_n('single text', 'plural text', number, 'mailpoet');
_x('text to translate', 'context', 'mailpoet');
_nx('single text', 'plural text', number, 'context', 'mailpoet');

To replace placeholders in translated strings, use sprintf:

import { sprintf } from '@wordpress/i18n';

sprintf(__('Hello %s', 'mailpoet'), 'John');

To replace React elements use createInterpolateElement:

import { __ } from '@wordpress/i18n';
import { createInterpolateElement } from '@wordpress/element';
import { CustomComponent } from '../custom-component.js';

const translatedString = createInterpolateElement(
  __(
    'This is a <span>string</span> with a <a>link</a> and a self-closing <custom_component/>.',
  ),
  {
    span: <span class="special-text" />,
    a: <a href="https://make.wordpress.org" />,
    custom_component: <CustomComponent />,
  },
);

For more information, see the @wordpress/i18n and the createInterpolateElement guides.

Acceptance testing

To run the whole acceptance testing suite you need the docker daemon to be running and after that use a command: ./do test:acceptance. If you want to run only a single test use the parameter --file:

./do test:acceptance --skip-deps --file tests/acceptance/ReceiveStandardEmailCest.php

The argument --skip-deps is useful locally to speed up the run.

If there are some unexpected errors you can delete all the runtime and start again. To delete all the docker runtime for acceptance tests use the command ./do delete:docker.

When debugging you can add $i->pause(); in to your test which pauses the execution.

We are using Gravity Flow plugin's setup as an example for our acceptance test suite: https://www.stevenhenty.com/learn-acceptance-testing-deeply/

From the article above:

Windows users only: enable hard drive sharing in the Docker settings.

The browser runs in a docker container. You can use a VNC client to watch the test run, follow instructions in official repo: https://github.com/SeleniumHQ/docker-selenium If you’re on a Mac, you can open vnc://localhost:5900 in Safari to watch the tests running in Chrome. If you’re on Windows, you’ll need a VNC client. Password: secret.